Add QEMU to Coverage

Signed-off-by: Lukasz Dorau <[email protected]>

Author: ldorau

.github/workflows/coverage.yml

@@ -93,6 +93,12 @@ jobs:
           name: exports-coverage-multinuma-os-ubuntu-22.04
           path: coverage
 
+      - name: Download files exports-coverage-qemu-all
+        uses: actions/download-artifact@v4
+        with:
+          name: exports-coverage-qemu-all
+          path: coverage
+
       - name: Compute coverage
         working-directory: ${{env.COVERAGE_DIR}}
         run: |

.github/workflows/pr_push.yml

@@ -111,5 +111,5 @@ jobs:
     needs: [Build]
     uses: ./.github/workflows/multi_numa.yml
   Coverage:
-    needs: [Build, DevDax, GPU, MultiNuma]
+    needs: [Build, DevDax, GPU, MultiNuma, Qemu]
     uses: ./.github/workflows/coverage.yml

.github/workflows/qemu.yml

@@ -6,6 +6,9 @@ on: workflow_call
 permissions:
   contents: read
 
+env:
+  UMF_DIR: "/home/runner/work/unified-memory-framework/unified-memory-framework"
+
 jobs:
   qemu-build:
     name: Qemu
@@ -44,10 +47,10 @@ jobs:
         cat > user-data << EOF
         #cloud-config
 
-        # Add a 'testuser' user to the system with a password
+        # Add a 'runner' user to the system with a password
         users:
           - default
-          - name: testuser
+          - name: runner
             gecos: Test User
             primary_group: wheel
             groups: users
@@ -61,7 +64,7 @@ jobs:
         chpasswd:
           list: |
             root:password
-            testuser:password
+            runner:password
           expire: False
         EOF
 
@@ -82,12 +85,18 @@ jobs:
       run: |
         umf/scripts/qemu/start_qemu.sh default.xml
 
-        # Copy UMF repository's content into the home dir in QEMU
-        rsync -az -e "ssh -p 2222" ${{github.workspace}}/umf/ [email protected]:/home/testuser/
-        ssh [email protected] -p 2222 -t "sudo chown -R testuser:users /home/testuser"
+        ssh [email protected] -p 2222 -t "sudo chown -R runner:users /home/runner"
+
+        # Coverage (lcov) has to be run in the same directory on all runners:
+        # /home/runner/work/unified-memory-framework/unified-memory-framework/build
+        # so we have to create the same path here.
+        ssh [email protected] -p 2222 -t "mkdir -p ${{env.UMF_DIR}}"
+
+        # Copy UMF repository's content into QEMU.
+        rsync -az -e "ssh -p 2222" ${{github.workspace}}/umf/ [email protected]:${{env.UMF_DIR}}/
 
-        ssh testuser@127.0.0.1 -p 2222 -t "bash /home/testuser/scripts/qemu/run-build.sh"
-        ssh testuser@127.0.0.1 -p 2222 -t "sudo shutdown -h now"
+        ssh runner@127.0.0.1 -p 2222 -t "bash ${{env.UMF_DIR}}/scripts/qemu/run-build.sh COVERAGE"
+        ssh runner@127.0.0.1 -p 2222 -t "sudo shutdown -h now"
 
     - name: Run tests in QEMU
       run: |
@@ -102,6 +111,13 @@ jobs:
           echo "\n ### Testing ${config_name} ###"
           umf/scripts/qemu/start_qemu.sh ${config_name}
 
-          ssh [email protected] -p 2222 -t "bash /home/testuser/scripts/qemu/run-tests.sh"
-          ssh [email protected] -p 2222 -t "sudo shutdown -h now"
+          ssh [email protected] -p 2222 -t "bash ${{env.UMF_DIR}}/scripts/qemu/run-tests.sh COVERAGE ${config_name}"
+          scp -r -P 2222 [email protected]:/home/runner/coverage ./
+          ssh [email protected] -p 2222 -t "sudo shutdown -h now"
         done
+        ls -al ./coverage
+
+    - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
+      with:
+        name: exports-coverage-qemu-all
+        path: coverage

scripts/qemu/run-build.sh

@@ -5,9 +5,16 @@
 
 set -e
 
+[ "$1" = "COVERAGE" ] && COVERAGE=ON || COVERAGE=OFF
+
+# This is ${UMF_DIR}/scripts/qemu/run-build.sh file, so
+UMF_DIR=$(dirname $0)/../..
+cd $UMF_DIR
+pwd
+
 echo password | sudo -Sk apt-get update
 echo password | sudo -Sk apt-get install -y git cmake gcc g++ pkg-config \
-    numactl libnuma-dev hwloc libhwloc-dev libjemalloc-dev libtbb-dev valgrind
+    numactl libnuma-dev hwloc libhwloc-dev libjemalloc-dev libtbb-dev valgrind lcov
 
 mkdir build
 cd build
@@ -21,6 +28,7 @@ cmake .. \
     -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON \
     -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON \
     -DUMF_BUILD_EXAMPLES=ON \
+    -DUMF_USE_COVERAGE=${COVERAGE} \
     -DUMF_TESTS_FAIL_ON_SKIP=ON
 
 make -j $(nproc)

scripts/qemu/run-tests.sh

@@ -5,6 +5,18 @@
 
 set -e
 
+COVERAGE=$1
+XML_CONFIG_FILE=$2
+
+CONFIG_NAME=$(echo $XML_CONFIG_FILE | cut -d. -f1) # remove the '.xml' extension
+COVERAGE_DIR=${HOME}/coverage
+mkdir -p $COVERAGE_DIR
+
+# This is ${UMF_DIR}/scripts/qemu/run-build.sh file, so
+UMF_DIR=$(dirname $0)/../..
+cd $UMF_DIR
+pwd
+
 # Drop caches, restores free memory on NUMA nodes
 echo password | sudo sync;
 echo password | sudo sh -c "/usr/bin/echo 3 > /proc/sys/vm/drop_caches"
@@ -20,6 +32,15 @@ ctest --verbose
 numactl -N 0 ctest --output-on-failure
 numactl -N 1 ctest --output-on-failure
 
+if [ "$COVERAGE" = "COVERAGE" ]; then
+	COVERAGE_FILE_NAME=exports-coverage-qemu-$CONFIG_NAME
+	echo "COVERAGE_FILE_NAME: $COVERAGE_FILE_NAME"
+	../scripts/coverage/coverage_capture.sh $COVERAGE_FILE_NAME
+	mkdir -p $COVERAGE_DIR
+	mv ./$COVERAGE_FILE_NAME $COVERAGE_DIR
+	ls -al $COVERAGE_DIR
+fi
+
 # run tests under valgrind
 echo "Running tests under valgrind memcheck ..."
 ../test/test_valgrind.sh .. . memcheck