ci: minimal testing workflow

Signed-off-by: Ihor Solodrai <ihor.solodrai@pm.me>

Author: theihor

.github/scripts/setup.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# Assume sudo in this script
+
+# Install dependencies
+apt update && apt install -y make file gawk libfuse2t64
+
+# Download bpftrace release
+BIN_DIR=/usr/local/bin
+mkdir -p $BIN_DIR
+curl -L -o bpftrace https://github.com/bpftrace/bpftrace/releases/download/v0.21.2/bpftrace
+chmod +x bpftrace
+mv bpftrace $BIN_DIR
+bpftrace --version
+
+# mount tracefs to avoid warnings from bpftrace
+grep -q tracefs /proc/mounts || mount -t tracefs tracefs /sys/kernel/tracing

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: USDT CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install prerequisites
+      run: sudo .github/scripts/setup.sh
+
+    - name: Build (static)
+      run: make SHARED=0 -C tests -j$(nproc) build
+
+    - name: Build (shared)
+      run: make SHARED=1 -C tests -j$(nproc) build
+
+    - name: Test (static)
+      run: make V=1 SHARED=0 -C tests test
+
+    - name: Test (shared)
+      run: make V=1 SHARED=1 -C tests test
+

tests/Makefile

@@ -38,13 +38,13 @@ endif
 NONTESTS = tester common
 
 TESTS := $(filter-out $(NONTESTS), 								\
-		$(shell ls *.{c,cpp} 2>/dev/null | grep -v '^lib' | 				\
-			${AWK} '{split($$0, p, /[^A-Za-z_]+/); print p[1]}' | 			\
+		$(shell ls *.c *.cpp 2>/dev/null | grep -v '^lib' | 				\
+			${AWK} '{split($$0, p, /[^A-Za-z_]+/); print p[1]}' |			\
 			sort | uniq 								\
 		)										\
 )
 LIBS := $(filter-out $(NONTESTS), 								\
-		$(shell ls lib*.{c,cpp} 2>/dev/null | 						\
+		$(shell ls lib*.c lib*.cpp 2>/dev/null | 					\
 			${AWK} '{split($$0, p, /[^A-Za-z_]+/); print substr(p[1], 4)}' |	\
 			sort | uniq 								\
 		)										\
@@ -63,6 +63,7 @@ clean:
 
 .PHONY: list
 list:
+	$(call msg,TESTS,$@)
 	$(Q)$(foreach test,$(TESTS), $(info $(test)))
 
 .PHONY: build

tests/prepare-bt-script.awk

@@ -39,7 +39,7 @@
 
 	# Emit corresponding bpftrace probe spec:
 	# U:./test:group:name { printf("%s: some %s fmt %d spec %d\n", probe, str(arg0), (int)arg1, arg2 - 10); }
-	printf("U:%s:%s:%s { printf(\"%s%s:%s: %s\\n\"%s); }\n",
+	printf("usdt:%s:%s:%s { printf(\"%s%s:%s: %s\\n\"%s); }\n",
 	       path, group, name,
 	       probe[1] == "lib" ? "lib:" : "", group, name,
 	       fmt, args == "" ? "" : ", " args);

tests/run_test.sh

@@ -7,8 +7,6 @@ if [ "${V:-0}" -eq 1 ]; then
 	set -x
 fi
 
-TIMEOUT=10
-
 awk=${AWK:-awk}
 readelf=${READELF:-readelf}
 bpftrace=${BPFTRACE:-bpftrace}
@@ -64,41 +62,12 @@ fi
 $TEST_BIN -B > $TEST_BTOUT_SPEC
 
 if [ -s "$TEST_BTSCRIPT" ]; then
-	# start attaching bpftrace
-	setsid sudo $bpftrace -B none "$TEST_BTSCRIPT" >"$TEST_BTOUT_RAW" 2>&1 &
-	bt_pid=$!
-	bt_pgid="$(ps -opgid= "$bt_pid" | tr -d ' ')"
-
-	# wait for bpftrace to finish attachment
-	bt_start=$(date +%s)
-	while true; do
-		bt_elapsed=$(( $(date +%s) - bt_start ))
-		if grep -q "STARTED!" "$TEST_BTOUT_RAW"; then
-			break
-		elif [ "$bt_elapsed" -ge "$TIMEOUT" ]; then
-			sudo kill -KILL -$bt_pgid 2>/dev/null
-			echo "BPFTRACE STARTUP TIMEOUT!"
-			echo "BPFTRACE SCRIPT:"
-			cat "$TEST_BTSCRIPT"
-			echo "BPFTRACE OUTPUT:"
-			cat "$TEST_BTOUT_RAW"
-			exit 1
-		elif ! kill -s 0 "$bt_pid"; then
-			echo "BPFTRACE STARTUP FAILURE!"
-			echo "BPFTRACE SCRIPT:"
-			cat "$TEST_BTSCRIPT"
-			echo "BPFTRACE OUTPUT:"
-			cat "$TEST_BTOUT_RAW"
-			exit 1
-		else
-			sleep 0.2
-		fi
-	done
 
-	# get test output while bpftrace is attached
-	$TEST_BIN &>"$TEST_OUT"
+	# export LD_LIBRARY_PATH=$OUTPUT/shared
+	sudo $bpftrace -B none -o $TEST_BTOUT_RAW -c $TEST_BIN $TEST_BTSCRIPT > $TEST_OUT
 
-	sudo kill -INT -$bt_pgid 2>/dev/null
+	# it appears bpftrace might print some empty lines when running this way, clean them up
+	gawk -i inplace 'NF' $TEST_OUT
 
 	$awk '/STARTED!/ {flag=1; next} /DONE!/ {flag=0} flag' $TEST_BTOUT_RAW > $TEST_BTOUT
 	if ! $awk -f check-match.awk $TEST_BTOUT_SPEC $TEST_BTOUT; then