#!/usr/bin/env bash
##
-# @file ssat-api.sh
-# @author MyungJoo Ham <myungjoo.ham@gmail.com>
-# @date Jun 22 2018
-# @license Apache-2.0
-# @brief This is API set for SSAT (Shell Script Automated Tester)
-#
+## @file ssat-api.sh
+## @author MyungJoo Ham <myungjoo.ham@gmail.com>
+## @date Jun 22 2018
+## @brief This is API set for SSAT (Shell Script Automated Tester)
+##
if [[ "$nocolor" != "1" ]]
then
ResultLog=""
-function writef {
+# Platform dependent variables
+KernelName=$(uname -s)
+if [[ "${KernelName}" == "Darwin" ]]; then
+ StatCmd_GetSize="stat -f %z"
+ SO_EXT="dylib"
+else
+ StatCmd_GetSize="stat --printf=%s"
+ SO_EXT="so"
+fi
+
+## @fn writef()
+## @private
+## @param $1 the string to be printed.
+## @brief Prepare report result
+function writef() {
if [[ "${SILENT}" == "0" ]]
then
printf "$1\n"
ResultLog="$ResultLog$1\n"
}
-##
-# @brief Report results of a test group (a "runTest.sh" in a testee directory)
-#
-function report {
- if (( ${_fail} == 0 ))
+## @fn report()
+## @brief Report results of a test group (a "runTest.sh" in a testee directory)
+function report() {
+ if (( ${_fail} == 0 && ${_criticalFail} == 0 ))
then
writef "${Green}==================================================${NC}"
writef "${LightGreen}[PASSED]${NC} Test Group $_group ${Green}Passed${NC}"
writef "${Red}[FAILED]${NC} Test Group $_group has ${Red}failed cases ($_fail)${NC}"
else
writef "${Green}==================================================${NC}"
- writef "${LightGreen}[PASSED]${NC} Test Group $_group has ${Red}failed cases ($_fail), but they are not critical.${NC}"
+ writef "${LightGreen}[PASSED]${NC} Test Group $_group has ${Red}failed cases ($_fail), but they are ignorable cases and not critical.${NC}"
fi
fi
# do nothing
echo ""
else
- writef "${_cases},${_pass},${_fail}"
+ _ignore=$((_fail-_criticalFail))
+ _fail=${_criticalFail}
+ if [[ "${COUNTNEGATIVE}" -eq "1" ]]
+ then
+ writef "${_cases},${_pass},${_fail},${_ignore},${_neg}"
+ else
+ writef "${_cases},${_pass},${_fail},${_ignore}"
+ fi
echo "${ResultLog}" > ${_filename}
- printf "${_filename}\n"
+ printf "\n${_filename}\n"
fi
if (( ${_criticalFail} > 0 ))
fi
}
-function testInit {
+## @fn testInit()
+## @brief Initialize runTest.sh shell test case
+function testInit() {
_pass=0
_fail=0
_criticalFail=0
_cases=0
+ _neg=0
_filename=$(mktemp)
_group=`basename "$1"`
if [[ "${#_group}" -eq "0" ]]
writef " Test Group ${Green}$_group${NC} Starts."
}
-##
-# @brief Write Test Log
-# @param $1 1 = success / 0 = fail
-# @param $2 test case ID (short string)
-# @param $3 test case description
-# @param $4 set 1 if this is not critical (don't care if it's pass or fail)_
-function testResult {
+## @fn testResult()
+## @brief Write Test Log
+## @param $1 1 = success / 0 = fail ($5 is not 1)
+## @param $2 test case ID (short string)
+## @param $3 test case description
+## @param $4 set 1 if this is not critical (don't care if it's pass or fail)_
+## @param $5 set 1 if $1==0 is success and $1!=0 is fail.
+function testResult() {
+ if [[ ${PROGRESSLOGLEVEL} -gt 1 ]]
+ then
+ echo "Case ${2}(${3}) report ${1}" >&2
+ fi
+
_cases=$((_cases+1))
- if [[ "${1}" == "1" ]]
+ _good=0
+ if [[ "${5}" -eq "1" ]]; then
+ if [[ "${1}" -eq "0" ]]; then
+ _good=1
+ fi
+ else
+ if [[ "${1}" -eq "1" ]]; then
+ _good=1
+ fi
+ fi
+
+ if [[ "${COUNTNEGATIVE}" -eq "1" ]]
+ then
+ if [[ "${2}\n" =~ "${COUNTNEGATIVEPOSTFIX}\n" ]]
+ then
+ _neg=$((_neg+1))
+ fi
+ fi
+
+ if [[ "${_good}" -eq "1" ]]
then
writef "${LightGreen}[PASSED]${NC} ${Green}$2${NC}:$3${NC}"
_pass=$((_pass+1))
_fail=$((_fail+1))
if [[ "${4}" == "1" ]]
then
- writef "${Purple}[FAILED][Ignorable] $2${NC}:${Purple}$3${NC}"
+ writef "${Purple}[IGNORED] $2${NC}:${Purple}$3${NC}"
else
writef "${Red}[FAILED][Critical] $2${NC}:${Purple}$3${NC}"
_criticalFail=$((_criticalFail+1))
fi
}
-##
-# @brief Call Test Case (a shell script), expected exit = 0
-# @param $1 Full path to the executable (e.g., ~/script/a1.sh)
-# @param $2 Full string of the arguments to $1 (e.g., "-q -n --dryrun")
-# @param $3 test case ID
-# @param $4 test case description
-# @param $5 set 1 if this is not critical (don't care if it's pass or fail)_
-function callTestSuccess {
+## @fn callTestSuccess()
+## @brief Call Test Case (a shell script), expected exit = 0
+## @param $1 Full path to the executable (e.g., ~/script/a1.sh)
+## @param $2 Full string of the arguments to $1 (e.g., "-q -n --dryrun")
+## @param $3 test case ID
+## @param $4 test case description
+## @param $5 set 1 if this is not critical (don't care if it's pass or fail)_
+function callTestSuccess() {
callutput=$(. $1 $2)
retcode=$?
if (( ${retcode} == 0 ))
fi
}
-##
-# @brief Call Test Case (a shell script), expected exit != 0
-# @param $1 Full path to the executable (e.g., ~/script/a1.sh)
-# @param $2 Full string of the arguments to $1 (e.g., "-q -n --dryrun")
-# @param $3 test case ID
-# @param $4 test case description
-# @param $5 set 1 if this is not critical (don't care if it's pass or fail)_
-function callTestFail {
+## @fn callTestFail()
+## @brief Call Test Case (a shell script), expected exit != 0
+## @param $1 Full path to the executable (e.g., ~/script/a1.sh)
+## @param $2 Full string of the arguments to $1 (e.g., "-q -n --dryrun")
+## @param $3 test case ID
+## @param $4 test case description
+## @param $5 set 1 if this is not critical (don't care if it's pass or fail)_
+function callTestFail() {
callutput=$(. $1 $2)
retcode=$?
if (( ${retcode} != 0 ))
fi
}
-##
-# @brief Call Test Case (a shell script), expected exit == $5
-# @param $1 Full path to the executable (e.g., ~/script/a1.sh)
-# @param $2 Full string of the arguments to $1 (e.g., "-q -n --dryrun")
-# @param $3 test case ID
-# @param $4 test case description
-# @param $5 Expected exit code.
-# @param $6 set 1 if this is not critical (don't care if it's pass or fail)_
-function callTestExitEq {
+## @fn callTestExitEq()
+## @brief Call Test Case (a shell script), expected exit == $5
+## @param $1 Full path to the executable (e.g., ~/script/a1.sh)
+## @param $2 Full string of the arguments to $1 (e.g., "-q -n --dryrun")
+## @param $3 test case ID
+## @param $4 test case description
+## @param $5 Expected exit code.
+## @param $6 set 1 if this is not critical (don't care if it's pass or fail)_
+function callTestExitEq() {
callutput=$(. $1 $2)
retcode=$?
if (( ${retcode} == $5 ))
fi
}
-##
-# @brief Compare two result files expected to be equal
-# @param $1 Path to result 1 (golden)
-# @param $2 Path to result 2 (test run)
-# @param $3 test case ID
-# @param $4 test case description
-# @param $5 0 if the size is expected to be equal as well. 1 if golden (result 1) might be smaller (will ignore rest of result 2). 2 if the opposite of 1. If $5 > 2, it denotes the max size of compared bytes. (compare the first $5 bytes only)
-# @param $6 set 1 if this is not critical (don't care if it's pass or fail)_
-function callCompareTest {
+## @fn callCompareTest()
+## @brief Compare two result files expected to be equal
+## @param $1 Path to result 1 (golden)
+## @param $2 Path to result 2 (test run)
+## @param $3 test case ID
+## @param $4 test case description
+## @param $5 0 if the size is expected to be equal as well. 1 if golden (result 1) might be smaller (will ignore rest of result 2). 2 if the opposite of 1. If $5 > 2, it denotes the max size of compared bytes. (compare the first $5 bytes only)
+## @param $6 set 1 if this is not critical (don't care if it's pass or fail)_
+function callCompareTest() {
# Try cmp.
- command -v cmp
output=0
- if (( $? == 0 ))
+ if [[ ! -f "$1" || ! -f "$2" ]]; then
+ testResult $output "$3" "$4" $6
+ return
+ fi
+ command -v cmp
+ # If cmp is symlink, then it could be from busybox and it does not support "-n" option
+ if [[ $? == 0 && ! -L $(which cmp) ]]
then
# use cmp
- echo NYI
if (( $5 == 0 )); then
# Size should be same as well.
cmp $1 $2
output=$?
elif (( $5 == 1 )); then
# Compare up to the size of golden
- cmp -n `stat --printf="%s" $1` $1 $2
+ cmp -n `${StatCmd_GetSize} $1` $1 $2
output=$?
elif (( $5 == 2 )); then
# Compare up to the size of test-run
- cmp -n `stat --printf="%s" $2` $1 $2
+ cmp -n `${StatCmd_GetSize} $2` $1 $2
output=$?
else
# Compare up to $5 bytes.
- cmp -n `stat --printf="%s" $5` $1 $2
+ cmp -n `${StatCmd_GetSize} $5` $1 $2
output=$?
fi
if (( ${output} == 0 )); then
fi
testResult $output "$3" "$4" $6
else
- # use internal logic (slower!)
- echo NYI
- testResult 0 "$3" "Cannot test. cmp not found." $6
+ # use internal logic (slower!)
+ bufsize=`${StatCmd_GetSize} $1`
+ if (( $5 == 2 )); then
+ bufsize=`${StatCmd_GetSize} $2`
+ else
+ bufsize=$5
+ fi
+ diff <(dd bs=1 count=$bufsize if=$1 &>/dev/null) <(dd bs=1 count=$bufsize if=$2 &>/dev/null)
+ output=$?
+ if (( ${output} == 0 )); then
+ output=1
+ else
+ output=0
+ fi
+ testResult $output "$3" "$4" $6
fi
}
-########################################################
-## EXTENSION. GStreamer
-## @todo How to separate such "plugins"?
-########################################################
+## @fn gstTest()
+## @brief Execute gst-launch with given arguments
+## @todo Separate this function to "gstreamer extension plugin"
+## @param $1 gst-launch-1.0 Arguments
+## @param $2 test case ID
+## @param $3 set 1 if this is not critical (don't care if it's pass or fail)
+## @param $4 set 1 if this passes if gstLaunch fails.
+## @param $5 set 1 to enable PERFORMANCE test.
+## @param $6 set a positive value (seconds) to enable timeout mode.
+function gstTest() {
+ if [[ "$VALGRIND" -eq "1" ]]; then
+ calloutputprefix="valgrind --track-origins=yes ${VALGRIND_SUPPRESSION}"
+ fi
+
+ TIMEOUT_AVAIL=1
+ if [[ "${6}" -gt "0" ]]; then
+ if ! command -v timeout &> /dev/null
+ then
+ if command -v perl &> /dev/null
+ then
+ timeout() { perl -e 'alarm shift; exec @ARGV' "$@"; }
+ else
+ TIMEOUT_AVAIL=0
+ fi
+ fi
+ fi
+
+ if [[ "${6}" -gt "0" && $TIMEOUT_AVAIL -eq 1 ]]; then
+ if [[ "${SILENT}" -eq "1" ]]; then
+ calloutput=$(eval timeout ${6} $calloutputprefix gst-launch-1.0 -f -q $1 &> /dev/null)
+ else
+ calloutput=$(eval timeout ${6} $calloutputprefix gst-launch-1.0 -f -q $1)
+ fi
+ else
+ if [[ "${SILENT}" -eq "1" ]]; then
+ calloutput=$(eval $calloutputprefix gst-launch-1.0 -f -q $1 &> /dev/null)
+ else
+ calloutput=$(eval $calloutputprefix gst-launch-1.0 -f -q $1)
+ fi
+ fi
-##
-# @brief Execute gst-launch with given arguments
-# @param $1 gst-launch-1.0 Arguments
-# @param $2 test case ID
-# @param $3 set 1 if this is not critical (don't care if it's pass or fail)
-# @param $4 set 1 if this passes if gstLaunch fails.
-# @param $5 set 1 to enable PERFORMANCE test.
-function gstTest {
- calloutput=$(gst-launch-1.0 -q $1)
retcode=$?
desired=0
if [[ "${4}" -eq "1" ]]; then
fi
}
-##
-# @brief Convert all *.bmp to *.png
-#
-# @todo macronice "bmp2png" searching.
-function convertBMP2PNG {
+
+## @fn gstTestBackground()
+## @brief Execute gst-launch in background with given arguments.
+## @param $1 gst-launch-1.0 Arguments, with pipeline description at the end. The pipeline should have async=false for sink elements (skip preroll!).
+## @param $2 test case ID
+## @param $3 set 1 if this is not critical (don't care if it's pass or fail)
+## @param $4 set 1 if this passes if launching the pipeline fails. (pass if timeout expires)
+## @param $5 set timeout for launching the pipeline in seconds (not the pipeline EOS). default = 10.
+## @return $pid The PID of the background gstreamer pipeline.
+function gstTestBackground() {
+ local marker=$(mktemp)
+ local timeout=10
+ local launchSuccess
+ local launchFail
+ local pipeline
+
+ if [ "$4" == "1" ]; then
+ launchSuccess=0
+ launchFail=1
+ else
+ launchSuccess=1
+ launchFail=0
+ fi
+ if [ "$5" == "" ]; then
+ # no changes in timeout. do nothing
+ sleep 0
+ else
+ if [ $5 -gt 0 ]; then
+ timeout=$5
+ else
+ # ignore if it's < 1. do nothing
+ sleep 0
+ fi
+ fi
+
+ pipeline="$1 videotestsrc num-buffers=1 ! video/x-raw,width=4,height=4,format=RGB ! filesink location=${marker}"
+ gst-launch-1.0 $pipeline &
+ pid=$!
+
+ for i in $(seq 1 ${timeout})
+ do
+ if [ -f "$marker" ]; then
+ markersize=$(stat -c%s ${marker})
+ if [ $markersize -ge 48 ]; then
+ testResult ${launchSuccess} $2 "gst-launch in background of case $2" $3
+ rm ${marker}
+ return $pid
+ fi
+ fi
+ sleep 1
+ done
+ rm ${marker}
+ testResult ${launchFail} $2 "gst-launch in background of case $2" $3
+ return ${pid}
+}
+
+## @fn convertBMP2PNG()
+## @brief Convert all *.bmp to *.png in the current directory
+## @todo macronice "bmp2png" searching.
+## @todo Separate this function to "gstreamer extension plugin"
+function convertBMP2PNG() {
tool="bmp2png"
if [ -x bmp2png ]; then
tool="bmp2png"