CI: Add valgrind check

A little test refactoring to add another kind of test - memory checking.
Not added to an existing E2E_RUN() because valgrind would interfere with
strace logging syscalls.

Signed-off-by: Alexey Gladkov <legion@kernel.org>

.github/workflows/ci.yml

@@ -93,20 +93,21 @@ jobs:
       CHECK_KEYWORDS: ${{ matrix.check }}
       SANDBOX: priviliged
       TTY: /dev/tty60
+      HAVE_VGA: 1
     steps:
     - name: "Check out repository"
       uses: actions/checkout@v4
       with:
         fetch-depth: 0
     - run: sudo apt-get update  -y -qq
-    - run: sudo apt-get install -y -qq autoconf automake autopoint libtool libtool-bin libpam0g-dev bison flex gettext kbd strace
+    - run: sudo apt-get install -y -qq autoconf automake autopoint libtool libtool-bin libpam0g-dev bison flex gettext kbd strace valgrind
     - run: sudo apt-get install -y -qq gcc clang musl musl-dev musl-tools
     - name: "Configure"
       run: |
         tests/configure.sh --datadir="$PWD/tests/data" ${{ matrix.configure }}
     - name: "Build"
       run: |
-        make V=1
+        make V=1 CFLAGS+="-g -O0"
     - name: "Check"
       run: |
         sudo -E tests/check.sh

tests/Makefile.am

@@ -16,21 +16,8 @@ ATPACKAGE = $(abs_builddir)/atpackage
 TESTSUITE = $(abs_builddir)/testsuite
 
 EXTRA_DIST = \
-	data                   \
-	e2e-clrunimap.at       \
-	e2e-dumpkeys.at        \
-	e2e-getunimap.at       \
-	e2e-kbdinfo.at         \
-	e2e-kbd_mode.at        \
-	e2e-loadkeys.at        \
-	e2e-loadunimap.at      \
-	e2e-psfxtable.at       \
-	e2e-setfont.at         \
-	e2e-setvtrgb.at        \
-	e2e.at                 \
-	libkbdfile.at          \
-	libkeymap.at           \
-	testsuite.at           \
+	data             \
+	$(wildcard *.at) \
 	$(NULL)
 
 CLEANFILES = \

tests/ci/qemu-install-dependencies.sh

@@ -39,5 +39,5 @@ message "system info"
 
 apt_get_install \
 	autoconf automake autopoint libtool libtool-bin pkg-config \
-	make bison flex gettext kbd strace libpam0g-dev \
+	make bison flex gettext kbd strace valgrind libpam0g-dev \
 	gcc

tests/ci/qemu-run-build-and-tests.sh

@@ -27,7 +27,7 @@ cd "/tmp/kbd"
 tests/configure.sh --datadir="$PWD/tests/data" ||
 	fail_with_artifacts
 
-make -j$nproc V=1
+make -j$nproc V=1 CFLAGS+="-g -O0"
 
 export CHECK_KEYWORDS="unittest e2e"
 export SANDBOX="priviliged"

tests/e2e-memcheck-clrunimap.at

@@ -0,0 +1,5 @@
+AT_SETUP([clrunimap])
+AT_KEYWORDS([e2e clrunimap memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+E2E_MEMCHECK(["$abs_top_builddir/src/clrunimap"])
+AT_CLEANUP

tests/e2e-memcheck-dumpkeys.at

@@ -0,0 +1,9 @@
+AT_SETUP([dumpkeys (path/ruwin_cplk-UTF-8.map)])
+AT_KEYWORDS([e2e dumpkeys memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+export LANG=en_US.UTF-8
+kbd_mode -u -f
+"$abs_top_builddir/src/loadkeys" -c -s "$abs_srcdir/data/keymaps/VoidSymbol.map"
+"$abs_top_builddir/src/loadkeys" "$abs_srcdir/data/keymaps/i386/qwerty/ruwin_cplk-UTF-8.map"
+E2E_MEMCHECK(["$abs_top_builddir/src/dumpkeys"])
+AT_CLEANUP

tests/e2e-memcheck-getunimap.at

@@ -0,0 +1,14 @@
+AT_SETUP([getunimap (empty unimap)])
+AT_KEYWORDS([e2e getunimap memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+clrunimap || "$abs_top_builddir/src/clrunimap"
+E2E_MEMCHECK(["$abs_top_builddir/src/getunimap"])
+AT_CLEANUP
+
+AT_SETUP([getunimap (cp866)])
+AT_KEYWORDS([e2e getunimap memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+clrunimap || "$abs_top_builddir/src/clrunimap"
+loadunimap "$abs_srcdir/data/unimaps/cp866.uni"
+E2E_MEMCHECK(["$abs_top_builddir/src/getunimap"])
+AT_CLEANUP

tests/e2e-memcheck-loadkeys.at

@@ -0,0 +1,7 @@
+AT_SETUP([loadkeys (path/ruwin_cplk-UTF-8.map)])
+AT_KEYWORDS([e2e loadkeys memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+kbd_mode -u -f
+"loadkeys" -c -s "$abs_srcdir/data/keymaps/VoidSymbol.map"
+E2E_MEMCHECK(["$abs_top_builddir/src/loadkeys" "$abs_srcdir/data/keymaps/i386/qwerty/ruwin_cplk-UTF-8.map"])
+AT_CLEANUP

tests/e2e-memcheck-loadunimap.at

@@ -0,0 +1,6 @@
+AT_SETUP([loadunimap (cp866)])
+AT_KEYWORDS([e2e loadunimap memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+clrunimap || "$abs_top_builddir/src/clrunimap"
+E2E_MEMCHECK(["$abs_top_builddir/src/loadunimap" cp866])
+AT_CLEANUP

tests/e2e-memcheck-setfont.at

@@ -0,0 +1,6 @@
+AT_SETUP([setfont (path/UniCyrExt_8x16.psf)])
+AT_KEYWORDS([e2e setfont memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+AT_SKIP_IF([ test -z "$HAVE_VGA" ])
+E2E_CHECK(["$abs_top_builddir/src/setfont" -v "$abs_srcdir/data/consolefonts/UniCyrExt_8x16.psf"])
+AT_CLEANUP

tests/e2e-memcheck-setvtrgb.at

@@ -0,0 +1,17 @@
+AT_SETUP([setvtrgb (vga)])
+AT_KEYWORDS([e2e setvtrgb memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+E2E_MEMCHECK(["$abs_top_builddir/src/setvtrgb" vga])
+AT_CLEANUP
+
+AT_SETUP([setvtrgb (vtrgb.ubuntu)])
+AT_KEYWORDS([e2e setvtrgb memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+E2E_MEMCHECK(["$abs_top_builddir/src/setvtrgb" "$abs_srcdir/data/setvtrgb/vtrgb.ubuntu"])
+AT_CLEANUP
+
+AT_SETUP([setvtrgb (vtrgb.ubuntu.hex)])
+AT_KEYWORDS([e2e setvtrgb memcheck])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+E2E_MEMCHECK(["$abs_top_builddir/src/setvtrgb" "$abs_srcdir/data/setvtrgb/vtrgb.ubuntu.hex"])
+AT_CLEANUP

tests/e2e-strace.sh

@@ -0,0 +1,13 @@
+#!/bin/sh -efu
+
+cwd="$(readlink -ev "${0%/*}")"
+
+rc=0
+strace -o syscalls.raw -s 1073741823 -e abbrev=none -e trace=/open.*,/ioctl \
+	-- "$@" \
+	1>stdout \
+	2>stderr || rc=$?
+
+"$cwd/syscall-filter.sed" < syscalls.raw > syscalls ||:
+
+exit $rc

tests/e2e-getunimap.at → tests/e2e-syscalls-getunimap.at

@@ -1,16 +1,24 @@
 AT_SETUP([getunimap (empty unimap)])
 AT_KEYWORDS([e2e getunimap])
 AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
-clrunimap
+clrunimap || "$abs_top_builddir/src/clrunimap"
 E2E_CHECK(["$abs_top_builddir/src/getunimap"])
 E2E_COMPARE_SYSCALLS([cat $abs_srcdir/data/e2e/getunimap-test01.calls])
 AT_CLEANUP
 
 AT_SETUP([getunimap (cp866)])
 AT_KEYWORDS([e2e getunimap])
 AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
-clrunimap
+clrunimap || "$abs_top_builddir/src/clrunimap"
 loadunimap "$abs_srcdir/data/unimaps/cp866.uni"
 E2E_CHECK(["$abs_top_builddir/src/getunimap"])
 E2E_COMPARE_SYSCALLS([cat $abs_srcdir/data/e2e/getunimap-test02.calls], [clrunimap], [clrunimap])
 AT_CLEANUP
+
+AT_SETUP([getunimap (cp866)])
+AT_KEYWORDS([e2e getunimap])
+AT_SKIP_IF([ test "$SANDBOX" != "priviliged" ])
+clrunimap || "$abs_top_builddir/src/clrunimap"
+loadunimap "$abs_srcdir/data/unimaps/cp866.uni"
+E2E_MEMCHECK(["$abs_top_builddir/src/getunimap"])
+AT_CLEANUP

tests/e2e-valgrind.sh

@@ -0,0 +1,29 @@
+#!/bin/sh -efu
+
+tool="$1"
+shift
+
+case "$tool" in
+	memcheck)
+		valgrind_args="--leak-check=full --leak-resolution=high --show-leak-kinds=all --track-origins=yes"
+		;;
+	*)
+		echo >&1 "$0: unknown valgrind tool: $tool"
+		exit 1
+		;;
+esac
+
+rc=0
+valgrind --tool="$tool" $valgrind_args --error-exitcode=1 -- "$@" \
+	1>stdout.valgrind \
+	2>stderr.valgrind || rc=$?
+
+if [ $rc -eq 0 ]; then
+	rm -f -- stdout.valgrind stderr.valgrind
+	exit 0
+fi
+
+mv -f -- stdout.valgrind stdout
+mv -f -- stderr.valgrind stderr
+
+exit $rc

tests/e2e.at

@@ -1,19 +1,19 @@
 m4_define([E2E_RUN_PIPE],[[
-rc=0;
-$1 | libtool --mode=execute -- \
-strace -o syscalls.raw -s 1073741823 -e abbrev=none -e trace=/open.*,/ioctl -- $2 1>stdout 2>stderr || rc=$?;
-"$abs_srcdir/syscall-filter.sed" < syscalls.raw > syscalls ||:;
-exit $rc;
+$1 | libtool --mode=execute -- "$abs_srcdir"/e2e-strace.sh $2 || exit $?;
 ]])
 
 m4_define([E2E_RUN],[[
-rc=0;
-libtool --mode=execute -- \
-strace -o syscalls.raw -s 1073741823 -e abbrev=none -e trace=/open.*,/ioctl -- $1 1>stdout 2>stderr || rc=$?;
-"$abs_srcdir/syscall-filter.sed" < syscalls.raw > syscalls ||:
-exit $rc;
+libtool --mode=execute -- "$abs_srcdir"/e2e-strace.sh $1 || exit $?
 ]])
 
+m4_define([E2E_RUN_MEMCHECK],[[
+libtool --mode=execute -- "$abs_srcdir"/e2e-valgrind.sh memcheck $1 || exit $?
+]])
+
+m4_define([E2E_MEMCHECK],[
+AT_CHECK([E2E_RUN_MEMCHECK([$1])], [0], [], [], [$2], [$3])
+])
+
 m4_define([E2E_CHECK_PIPE],[
 AT_CHECK([E2E_RUN_PIPE([$1], [$2])], [0], [], [], [$3], [$4])
 ])
@@ -38,13 +38,27 @@ m4_define([E2E_COMPARE_STDERR],   [E2E_COMPARE_CONTENT([$1], [stderr])])
 
 AT_BANNER([e2e tests])
 
-m4_include([e2e-clrunimap.at])
-m4_include([e2e-getunimap.at])
-m4_include([e2e-kbd_mode.at])
-m4_include([e2e-kbdinfo.at])
-m4_include([e2e-loadkeys.at])
-m4_include([e2e-dumpkeys.at])
-m4_include([e2e-loadunimap.at])
-m4_include([e2e-psfxtable.at])
-m4_include([e2e-setfont.at])
-m4_include([e2e-setvtrgb.at])
+m4_include([e2e-syscalls-clrunimap.at])
+m4_include([e2e-syscalls-getunimap.at])
+m4_include([e2e-syscalls-kbd_mode.at])
+m4_include([e2e-syscalls-kbdinfo.at])
+m4_include([e2e-syscalls-loadkeys.at])
+m4_include([e2e-syscalls-loadunimap.at])
+m4_include([e2e-syscalls-setfont.at])
+m4_include([e2e-syscalls-setvtrgb.at])
+
+AT_BANNER([e2e misc])
+
+m4_include([e2e-misc-psfxtable.at])
+m4_include([e2e-misc-dumpkeys.at])
+
+AT_BANNER([e2e memcheck])
+
+m4_include([e2e-memcheck-clrunimap.at])
+m4_include([e2e-memcheck-clrunimap.at])
+m4_include([e2e-memcheck-getunimap.at])
+m4_include([e2e-memcheck-loadunimap.at])
+m4_include([e2e-memcheck-loadkeys.at])
+m4_include([e2e-memcheck-dumpkeys.at])
+m4_include([e2e-memcheck-setfont.at])
+m4_include([e2e-memcheck-setvtrgb.at])