]> git.saurik.com Git - apt.git/blobdiff - test/integration/framework
tests: store msgmsg message for display in fail as well
[apt.git] / test / integration / framework
index b443f2a7b48432d03901fe37f7e1d991f8513b38..6cba26c8dcd10685920e6bfb4d481114661b0d22 100644 (file)
@@ -2,6 +2,20 @@
 
 EXIT_CODE=0
 
+while [ -n "$1" ]; do
+       if [ "$1" = "-q" ]; then
+               export MSGLEVEL=2
+       elif [ "$1" = "-v" ]; then
+               export MSGLEVEL=4
+       elif [ "$1" = '--color=no' ]; then
+               export MSGCOLOR='NO'
+       else
+               echo >&2 "WARNING: Unknown parameter »$1« will be ignored"
+       fi
+       shift
+done
+export MSGLEVEL="${MSGLEVEL:-3}"
+
 # we all like colorful messages
 if [ "$MSGCOLOR" != 'NO' ] && [ "$MSGCOLOR" != 'ALWAYS' ]; then
        if [ ! -t 1 ]; then # but check that we output to a terminal
@@ -51,20 +65,53 @@ msgndebug() { msgprintf "${CDEBUG}D: %s" '%s' "${CNORMAL}" "$@"; }
 msgtest() { msgprintf "${CINFO}%s" "${CCMD}%s${CINFO}" "…${CNORMAL} " "$@"; }
 msgpass() { printf "${CPASS}PASS${CNORMAL}\n"; }
 msgskip() {
+       if [ -n "$MSGTEST_MSG" ]; then
+               if [ -n "$MSGTEST_MSGMSG" ]; then
+                       echo "$MSGTEST_MSGMSG"
+               fi
+               if [ -n "$MSGTEST_GRP" ] && [ "$MSGTEST_GRP" != 'NEXT' ] && [ "$MSGTEST_GRP" != "$MSGTEST_MSG" ]; then
+                       echo "Part of the test group: $MSGTEST_GRP"
+               fi
+               echo -n "$MSGTEST_MSG"
+               unset MSGTEST_MSG
+       fi
        if [ $# -gt 0 ]; then printf "${CWARNING}SKIP: $*${CNORMAL}\n" >&2;
        else printf "${CWARNING}SKIP${CNORMAL}\n" >&2; fi
 }
 msgfail() {
-       if [ $# -gt 0 ]; then printf "${CFAIL}FAIL: $*${CNORMAL}\n" >&2;
+       if [ -n "$MSGTEST_MSG" ]; then
+               if [ -n "$MSGTEST_MSGMSG" ]; then
+                       echo "$MSGTEST_MSGMSG"
+               fi
+               if [ -n "$MSGTEST_GRP" ] && [ "$MSGTEST_GRP" != 'NEXT' ] && [ "$MSGTEST_GRP" != "$MSGTEST_MSG" ]; then
+                       echo "Part of the test group: $MSGTEST_GRP"
+               fi
+               echo -n "$MSGTEST_MSG"
+               unset MSGTEST_MSG
+       fi
+       if [ $# -gt 0 ] && [ -n "$1" ]; then printf "${CFAIL}FAIL: $*${CNORMAL}\n" >&2;
        else printf "${CFAIL}FAIL${CNORMAL}\n" >&2; fi
        if [ -n "$APT_DEBUG_TESTS" ]; then
                $SHELL
        fi
        EXIT_CODE=$((EXIT_CODE+1));
 }
+MSGGROUP_LEVEL=0
+msggroup() {
+       if [ -n "$1" ]; then
+               if [ $MSGGROUP_LEVEL = 0 ]; then
+                       MSGTEST_GRP='NEXT'
+               fi
+               MSGGROUP_LEVEL=$((MSGGROUP_LEVEL+1));
+       else
+               MSGGROUP_LEVEL=$((MSGGROUP_LEVEL-1));
+               if [ $MSGGROUP_LEVEL = 0 ]; then
+                       unset MSGTEST_GRP
+               fi
+       fi
+}
 
 # enable / disable Debugging
-MSGLEVEL=${MSGLEVEL:-3}
 if [ $MSGLEVEL -le 0 ]; then
        msgdie() { true; }
 fi
@@ -73,9 +120,16 @@ if [ $MSGLEVEL -le 1 ]; then
        msgnwarn() { true; }
 fi
 if [ $MSGLEVEL -le 2 ]; then
-       msgmsg() { true; }
+       msgmsg() {
+               MSGTEST_MSGMSG="$(msgprintf "${CMSG}%s" '%s' "${CNORMAL}" "$@")"
+       }
        msgnmsg() { true; }
-       msgtest() { true; }
+       msgtest() {
+               MSGTEST_MSG="$(msgprintf "${CINFO}%s" "${CCMD}%s${CINFO}" "…${CNORMAL} " "$@")"
+               if [ "$MSGTEST_GRP" = 'NEXT' ]; then
+                       MSGTEST_GRP="$MSGTEST_MSG"
+               fi
+       }
        msgpass() { printf " ${CPASS}P${CNORMAL}"; }
 fi
 if [ $MSGLEVEL -le 3 ]; then
@@ -191,7 +245,7 @@ setupenvironment() {
        fi
        TMPWORKINGDIRECTORY=$(mktemp -d)
        addtrap "cd /; rm -rf $TMPWORKINGDIRECTORY;"
-       msgninfo "Preparing environment for ${CCMD}$(basename $0)${CINFO} in ${TMPWORKINGDIRECTORY}… "
+       msgninfo "Preparing environment for $(basename $0) in ${TMPWORKINGDIRECTORY}…"
 
        mkdir -m 700 "${TMPWORKINGDIRECTORY}/downloaded"
        if [ "$(id -u)" = '0' ]; then
@@ -320,7 +374,6 @@ EOF
        export LC_ALL=C.UTF-8
        unset LANGUAGE APT_CONFIG
        unset GREP_OPTIONS DEB_BUILD_PROFILES
-
        msgdone "info"
 }
 
@@ -474,7 +527,7 @@ Dir::Bin::xz \"/does/not/exist\";" > "$CONFFILE"
                COMPRESSOR_CMD='xz --format=lzma'
        else
                msgtest 'Test for availability of compressor' "${COMPRESSOR}"
-               msgfail
+               msgfail "${COMPRESSOR} not available"
        fi
 }
 
@@ -794,6 +847,7 @@ insertsource() {
        local ARCH="$3"
        local VERSION="$4"
        local DEPENDENCIES="$5"
+        local BINARY="${6:-$NAME}"
        local ARCHS=""
        local SPATH="aptarchive/dists/${RELEASE}/main/source"
        mkdir -p $SPATH
@@ -801,7 +855,7 @@ insertsource() {
        local DSCFILE="${NAME}_${VERSION}.dsc"
        local TARFILE="${NAME}_${VERSION}.tar.gz"
        echo "Package: $NAME
-Binary: $NAME
+Binary: $BINARY
 Version: $VERSION
 Maintainer: Joe Sixpack <joe@example.org>
 Architecture: $ARCH" >> $FILE
@@ -809,6 +863,9 @@ Architecture: $ARCH" >> $FILE
        echo "Files:
  $(echo -n "$DSCFILE" | md5sum | cut -d' ' -f 1) $(echo -n "$DSCFILE" | wc -c) $DSCFILE
  $(echo -n "$TARFILE" | md5sum | cut -d' ' -f 1) $(echo -n "$TARFILE" | wc -c) $TARFILE
+Checksums-Sha256:
+ $(echo -n "$DSCFILE" | sha256sum | cut -d' ' -f 1) $(echo -n "$DSCFILE" | wc -c) $DSCFILE
+ $(echo -n "$TARFILE" | sha256sum | cut -d' ' -f 1) $(echo -n "$TARFILE" | wc -c) $TARFILE
 " >> $FILE
 }
 
@@ -1070,8 +1127,9 @@ webserverconfig() {
        if downloadfile "$URI" "$STATUS" > "$DOWNLOG"; then
                msgpass
        else
-               cat "$DOWNLOG" "$STATUS" || true
-               msgfail
+               local OUTPUT="${TMPWORKINGDIRECTORY}/rootdir/tmp/webserverconfig.output"
+               cat "$DOWNLOG" "$STATUS" >"$OUTPUT" 2>&1 || true
+               msgfailoutput '' "$OUTPUT"
        fi
        $NOCHECK || testwebserverlaststatuscode '200'
 }
@@ -1194,31 +1252,55 @@ checkdiff() {
        fi
 }
 
+testoutputequal() {
+       local OUTPUT="${TMPWORKINGDIRECTORY}/rootdir/tmp/testoutputequal.output"
+       local COMPAREFILE="$1"
+       shift
+       if "$@" 2>&1 | checkdiff $COMPAREFILE - >"$OUTPUT" 2>&1; then
+               msgpass
+       else
+               echo "=== content of file we compared with (${COMPAREFILE}) ===" >>"${OUTPUT}"
+               cat "$COMPAREFILE" >>"${OUTPUT}"
+               msgfailoutput '' "$OUTPUT" "$@"
+       fi
+}
+
 testfileequal() {
+       msggroup "$0"
+       local MSG='Test for correctness of file'
+       if [ "$1" = '--nomsg' ]; then
+               MSG=''
+               shift
+       fi
        local FILE="$1"
        shift
-       msgtest "Test for correctness of file" "$FILE"
+       if [ -n "$MSG" ]; then
+               msgtest "$MSG" "$FILE"
+       fi
+       local OUTPUT="${TMPWORKINGDIRECTORY}/rootdir/tmp/testfileequal.output"
        if [ -z "$*" ]; then
-               echo -n "" | checkdiff - $FILE && msgpass || msgfail
+               testoutputequal "$FILE" echo -n ''
        else
-               echo "$*" | checkdiff - $FILE && msgpass || msgfail
+               testoutputequal "$FILE" echo "$*"
        fi
+       msggroup
 }
 
 testempty() {
+       msggroup "$0"
        msgtest "Test for no output of" "$*"
        local COMPAREFILE="${TMPWORKINGDIRECTORY}/rootdir/tmp/testempty.comparefile"
        if "$@" >$COMPAREFILE 2>&1 && test ! -s $COMPAREFILE; then
                msgpass
        else
-               echo
-               cat $COMPAREFILE
-               msgfail
+               msgfailoutput '' "$COMPAREFILE" "$@"
        fi
        aptautotest 'testempty' "$@"
+       msggroup
 }
 
 testequal() {
+       msggroup "$0"
        local MSG='Test of equality of'
        if [ "$1" = '--nomsg' ]; then
                MSG=''
@@ -1232,11 +1314,13 @@ testequal() {
        if [ -n "$MSG" ]; then
                msgtest "$MSG" "$*"
        fi
-       "$@" 2>&1 | checkdiff $COMPAREFILE - && msgpass || msgfail
+       testoutputequal "$COMPAREFILE" "$@"
        aptautotest 'testequal' "$@"
+       msggroup
 }
 
 testequalor2() {
+       msggroup "$0"
        local COMPAREFILE1="${TMPWORKINGDIRECTORY}/rootdir/tmp/testequalor2.comparefile1"
        local COMPAREFILE2="${TMPWORKINGDIRECTORY}/rootdir/tmp/testequalor2.comparefile2"
        local COMPAREAGAINST="${TMPWORKINGDIRECTORY}/rootdir/tmp/testequalor2.compareagainst"
@@ -1250,16 +1334,19 @@ testequalor2() {
        then
                msgpass
        else
-               echo -n "\n${CINFO}Diff against OR 1${CNORMAL}"
-               checkdiff $COMPAREFILE1 $COMPAREAGAINST || true
-               echo -n "${CINFO}Diff against OR 2${CNORMAL}"
-               checkdiff $COMPAREFILE2 $COMPAREAGAINST || true
-               msgfail
+               local OUTPUT="${TMPWORKINGDIRECTORY}/rootdir/tmp/testequal.output"
+               echo -n "\n${CINFO}Diff against OR 1${CNORMAL}" >"$OUTPUT" 2>&1
+               checkdiff "$COMPAREFILE1" "$COMPAREAGAINST" >"$OUTPUT" 2>&1 || true
+               echo -n "${CINFO}Diff against OR 2${CNORMAL}" >"$OUTPUT" 2>&1
+               checkdiff "$COMPAREFILE2" "$COMPAREAGAINST" >"$OUTPUT" 2>&1 || true
+               msgfailoutput '' "$OUTPUT"
        fi
        aptautotest 'testequalor2' "$@"
+       msggroup
 }
 
 testshowvirtual() {
+       msggroup "$0"
        local VIRTUAL="N: Can't select versions from package '$1' as it is purely virtual"
        local PACKAGE="$1"
        shift
@@ -1274,46 +1361,58 @@ N: Can't select versions from package '$1' as it is purely virtual"
 N: No packages found"
        local COMPAREFILE="${TMPWORKINGDIRECTORY}/rootdir/tmp/testshowvirtual.comparefile"
        local ARCH="$(getarchitecture 'native')"
-       echo "$VIRTUAL" | sed -e "s/:$ARCH//" -e 's/:all//' > $COMPAREFILE
-       aptcache show -q=0 $PACKAGE 2>&1 | checkdiff $COMPAREFILE - && msgpass || msgfail
+       echo "$VIRTUAL" | sed -e "s/:$ARCH//" -e 's/:all//' >"$COMPAREFILE"
+       local OUTPUT="${TMPWORKINGDIRECTORY}/rootdir/tmp/testshowvirtual.output"
+       testoutputequal "$COMPAREFILE" aptcache show -q=0 "$PACKAGE"
+       msggroup
 }
 
 testnopackage() {
+       msggroup "$0"
        msgtest "Test for non-existent packages" "apt-cache show $*"
        local SHOWPKG="$(aptcache show "$@" 2>&1 | grep '^Package: ')"
        if [ -n "$SHOWPKG" ]; then
-               echo >&2
-               echo >&2 "$SHOWPKG"
-               msgfail
+               local OUTPUT="${TMPWORKINGDIRECTORY}/rootdir/tmp/testnopackage.output"
+               echo "$SHOWPKG" >"$OUTPUT"
+               msgfailoutput '' "$OUTPUT"
        else
                msgpass
        fi
+       msggroup
 }
 
 testdpkgstatus() {
+       msggroup "$0"
        local STATE="$1"
        local NR="$2"
        shift 2
        msgtest "Test that $NR package(s) are in state $STATE with" "dpkg -l $*"
        local PKGS="$(dpkg -l "$@" 2>/dev/null | grep "^${STATE}" | wc -l)"
        if [ "$PKGS" != $NR ]; then
-               echo >&2 $PKGS
-               dpkg -l "$@" | grep '^[a-z]' >&2 || true
-               msgfail
+               local OUTPUT="${TMPWORKINGDIRECTORY}/rootdir/tmp/testnopackage.output"
+               echo "$PKGS" >"$OUTPUT"
+               dpkg -l "$@" | grep '^[a-z]' >"$OUTPUT" >&2 || true
+               msgfailoutput '' "$OUTPUT"
        else
                msgpass
        fi
+       msggroup
 }
 
 testdpkginstalled() {
+       msggroup "$0"
        testdpkgstatus 'ii' "$#" "$@"
+       msggroup
 }
 
 testdpkgnotinstalled() {
+       msggroup "$0"
        testdpkgstatus 'ii' '0' "$@"
+       msggroup
 }
 
 testmarkedauto() {
+       msggroup "$0"
        local COMPAREFILE="${TMPWORKINGDIRECTORY}/rootdir/tmp/testmarkedauto.comparefile"
        if [ -n "$1" ]; then
                msgtest 'Test for correctly marked as auto-installed' "$*"
@@ -1322,9 +1421,11 @@ testmarkedauto() {
                msgtest 'Test for correctly marked as auto-installed' 'no package'
                echo -n > $COMPAREFILE
        fi
-       aptmark showauto 2>&1 | checkdiff $COMPAREFILE - && msgpass || msgfail
+       testoutputequal "$COMPAREFILE" aptmark showauto
+       msggroup
 }
 testmarkedmanual() {
+       msggroup "$0"
        local COMPAREFILE="${TMPWORKINGDIRECTORY}/rootdir/tmp/testmarkedmanual.comparefile"
        if [ -n "$1" ]; then
                msgtest 'Test for correctly marked as manually installed' "$*"
@@ -1333,20 +1434,33 @@ testmarkedmanual() {
                msgtest 'Test for correctly marked as manually installed' 'no package'
                echo -n > $COMPAREFILE
        fi
-       aptmark showmanual 2>&1 | checkdiff $COMPAREFILE - && msgpass || msgfail
+       testoutputequal "$COMPAREFILE" aptmark showmanual
+       msggroup
 }
 
 msgfailoutput() {
+       if [ -n "$MSGTEST_MSG" ]; then
+               echo
+               if [ -n "$MSGTEST_MSGMSG" ]; then
+                       echo "$MSGTEST_MSGMSG"
+               fi
+               if [ -n "$MSGTEST_GRP" ] && [ "$MSGTEST_GRP" != 'NEXT' ] && [ "$MSGTEST_GRP" != "$MSGTEST_MSG" ]; then
+                       echo "${CFAIL}Part of the test group: $MSGTEST_GRP"
+               fi
+               echo -n "$MSGTEST_MSG"
+               unset MSGTEST_MSG
+       fi
        local MSG="$1"
        local OUTPUT="$2"
        shift 2
-       echo >&2
        if [ "$1" = 'grep' ]; then
+               echo >&2
                while [ -n "$2" ]; do shift; done
                echo "#### Complete file: $1 ####"
                cat >&2 "$1" || true
                echo '#### grep output ####'
        elif [ "$1" = 'test' ]; then
+               echo >&2
                # doesn't support ! or non-file flags
                msgfailoutputstatfile() {
                        local FILEFLAGS='^-[bcdefgGhkLOprsStuwx]$'
@@ -1367,6 +1481,7 @@ msgfailoutput() {
 }
 
 testsuccess() {
+       msggroup "$0"
        if [ "$1" = '--nomsg' ]; then
                shift
        else
@@ -1399,8 +1514,10 @@ testsuccess() {
                msgfailoutput "exitcode $EXITCODE" "$OUTPUT" "$@"
        fi
        aptautotest 'testsuccess' "$@"
+       msggroup
 }
 testwarning() {
+       msggroup "$0"
        if [ "$1" = '--nomsg' ]; then
                shift
        else
@@ -1423,13 +1540,13 @@ testwarning() {
                fi
        else
                local EXITCODE=$?
-               echo >&2
-               cat >&2 $OUTPUT
-               msgfail "exitcode $EXITCODE"
+               msgfailoutput "exitcode $EXITCODE" "$OUTPUT" "$@"
        fi
        aptautotest 'testwarning' "$@"
+       msggroup
 }
 testfailure() {
+       msggroup "$0"
        if [ "$1" = '--nomsg' ]; then
                shift
        else
@@ -1465,59 +1582,70 @@ testfailure() {
                fi
        fi
        aptautotest 'testfailure' "$@"
+       msggroup
 }
 
 testsuccessequal() {
+       msggroup "$0"
        local CMP="$1"
        shift
        testsuccess "$@"
        testfileequal "${TMPWORKINGDIRECTORY}/rootdir/tmp/testsuccess.output" "$CMP"
+       msggroup
 }
 testwarningequal() {
+       msggroup "$0"
        local CMP="$1"
        shift
        testwarning "$@"
        testfileequal "${TMPWORKINGDIRECTORY}/rootdir/tmp/testwarning.output" "$CMP"
+       msggroup
 }
 testfailureequal() {
+       msggroup "$0"
        local CMP="$1"
        shift
        testfailure "$@"
        testfileequal "${TMPWORKINGDIRECTORY}/rootdir/tmp/testfailure.output" "$CMP"
+       msggroup
 }
 
 testfailuremsg() {
+       msggroup "$0"
        local CMP="$1"
        shift
        testfailure "$@"
        msgtest 'Check that the output of the previous failed command has expected' 'failures and warnings'
-       grep '^\(W\|E\):' "${TMPWORKINGDIRECTORY}/rootdir/tmp/testfailure.output" > "${TMPWORKINGDIRECTORY}/rootdir/tmp/testfailureequal.output" 2>&1 || true
-       if echo "$CMP" | checkdiff - "${TMPWORKINGDIRECTORY}/rootdir/tmp/testfailureequal.output"; then
-               msgpass
-       else
-               echo '### Complete output ###'
-               cat "${TMPWORKINGDIRECTORY}/rootdir/tmp/testfailure.output"
-               msgfail
-       fi
+       local COMPAREFILE="${TMPWORKINGDIRECTORY}/rootdir/tmp/testfailuremsg.comparefile"
+       grep '^\(W\|E\):' "${TMPWORKINGDIRECTORY}/rootdir/tmp/testfailure.output" > "$COMPAREFILE" 2>&1 || true
+       testoutputequal "$COMPAREFILE" echo "$CMP"
+       msggroup
 }
 
 testfilestats() {
+       msggroup "$0"
        msgtest "Test that file $1 has $2 $3" "$4"
        if [ "$4" "$3" "$(stat --format "$2" "$1")" ]; then
                msgpass
        else
-               echo >&2
-               ls -ld >&2 "$1" || true
-               echo -n >&2 "stat(1) reports for $2: "
-               stat --format "$2" "$1" || true
-               msgfail
+               local OUTPUT="${TMPWORKINGDIRECTORY}/rootdir/tmp/testfilestats.output"
+               {
+                       ls -ld "$1" || true
+                       echo -n "stat(1) reports for $2: "
+                       stat --format "$2" "$1" || true
+               } >"$OUTPUT" 2>&1
+               msgfailoutput '' "$OUTPUT"
        fi
+       msggroup
 }
 testaccessrights() {
+       msggroup "$0"
        testfilestats "$1" '%a' '=' "$2"
+       msggroup
 }
 
 testwebserverlaststatuscode() {
+       msggroup "$0"
        local DOWNLOG='rootdir/tmp/webserverstatus-testfile.log'
        local STATUS='downloaded/webserverstatus-statusfile.log'
        rm -f "$DOWNLOG" "$STATUS"
@@ -1525,16 +1653,19 @@ testwebserverlaststatuscode() {
        if downloadfile "http://localhost:8080/_config/find/aptwebserver::last-status-code" "$STATUS" > "$DOWNLOG" && [ "$(cat "$STATUS")" = "$1" ]; then
                msgpass
        else
-               echo >&2
-               if [ -n "$2" ]; then
-                       shift
-                       echo >&2 '#### Additionally provided output files contain:'
-                       cat >&2 "$@"
-               fi
-               echo >&2 '#### Download log of the status code:'
-               cat >&2 "$DOWNLOG"
-               msgfail "Status was $(cat "$STATUS")"
+               local OUTPUT="${TMPWORKINGDIRECTORY}/rootdir/tmp/testwebserverlaststatuscode.output"
+               {
+                       if [ -n "$2" ]; then
+                               shift
+                               echo >&2 '#### Additionally provided output files contain:'
+                               cat >&2 "$@"
+                       fi
+                       echo >&2 '#### Download log of the status code:'
+                       cat >&2 "$DOWNLOG"
+               } >"$OUTPUT" 2>&1
+               msgfailoutput "Status was $(cat "$STATUS")" "$OUTPUT"
        fi
+       msggroup
 }
 
 pause() {
@@ -1554,7 +1685,7 @@ listcurrentlistsdirectory() {
        } | sort
 }
 
-### convinience hacks ###
+### convenience hacks ###
 mkdir() {
        # creating some directories by hand is a tedious task, so make it look simple
        if [ "$*" = '-p rootdir/var/lib/apt/lists' ] || [ "$*" = "${TMPWORKINGDIRECTORY}/rootdir/var/lib/apt/lists" ] ||