Merge pull request #673 from lukaszstolarczuk/qemu-ci

Minor cleanup in QEMU CI

Author: lukaszstolarczuk

.github/workflows/qemu.yml

@@ -3,9 +3,6 @@ name: Qemu
 
 on: workflow_call
 
-env:
-  CI_BRANCH: "${{ github.head_ref || github.ref_name }}"
-
 permissions:
   contents: read
 
@@ -15,38 +12,43 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-    - name: Checkout
+    - name: Checkout UMF
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       with:
         fetch-depth: 0
+        path: umf
 
     - name: Enable KVM
       run: |
         echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
         sudo udevadm control --reload-rules
         sudo udevadm trigger --name-match=kvm
-    - name: Install qemu
-      run: |
-        sudo apt update && sudo apt install -y qemu-system genisoimage qemu-utils
-    - name: Install libvirt and script dependencies
+
+    - name: Install dependencies
       run: |
-        sudo apt-get install -y libvirt-clients libvirt-daemon-system libvirt-daemon virtinst bridge-utils
-        pip install -r scripts/qemu/requirements.txt
-        sudo usermod -a -G kvm,libvirt $USER
+        sudo apt-get update
+        sudo apt-get install -y qemu-system genisoimage qemu-utils \
+          libvirt-clients libvirt-daemon-system libvirt-daemon virtinst bridge-utils
+        pip install -r umf/scripts/qemu/requirements.txt
+
+    - name: Add user to kvm group
+      run: sudo usermod -a -G kvm,libvirt $USER
+
     - name: Run ssh-keygen
       run: ssh-keygen -b 4096 -N '' -f ~/.ssh/id_rsa
+
     - name: Generate iso with user info
       run: |
         pub_key=$(cat ~/.ssh/id_rsa.pub)
 
         cat > user-data << EOF
         #cloud-config
 
-        # Add a 'cxltest' user to the system with a password
+        # Add a 'testuser' user to the system with a password
         users:
           - default
-          - name: cxltest
-            gecos: CXL Test User
+          - name: testuser
+            gecos: Test User
             primary_group: wheel
             groups: users
             sudo: ALL=(ALL) NOPASSWD:ALL
@@ -59,54 +61,47 @@ jobs:
         chpasswd:
           list: |
             root:password
-            cxltest:password
+            testuser:password
           expire: False
         EOF
 
         cat > meta-data << EOF
-        instance-id: cxl-test
-        local-hostname: cxl-test
+        instance-id: qemu-test
+        local-hostname: qemu-test
         EOF
 
         sudo -Sk genisoimage -output ubuntu-cloud-init.iso -volid cidata -joliet -rock ./user-data ./meta-data
+
     - name: Download ubuntu image
       run: wget https://cloud-images.ubuntu.com/releases/lunar/release/ubuntu-23.04-server-cloudimg-amd64.img
+
     - name: Resize image
       run: qemu-img resize ./ubuntu-23.04-server-cloudimg-amd64.img +4G
-    - name: Build
-      run: |
-        scripts/qemu/start_qemu.sh scripts/qemu/configs/default.xml
 
-        if [ ${{ github.event_name }} = 'pull_request' ]; then
-            CI_REPO="${{ github.event.pull_request.head.repo.full_name }}"
-        else
-            CI_REPO="$GITHUB_REPOSITORY"
-        fi
+    - name: Build UMF in QEMU
+      run: |
+        umf/scripts/qemu/start_qemu.sh default.xml
 
-        scp -P 2222 ${{github.workspace}}/scripts/qemu/run-build.sh [email protected]:/home/cxltest
-        scp -P 2222 ${{github.workspace}}/scripts/qemu/run-tests.sh cxltest@127.0.0.1:/home/cxltest
-        ssh cxltest@127.0.0.1 -p 2222 -t "bash /home/cxltest/run-build.sh https://github.com/$CI_REPO ${{env.CI_BRANCH}}"
+        # Copy UMF repository's content into the home dir in QEMU
+        rsync -az -e "ssh -p 2222" ${{github.workspace}}/umf/ testuser@127.0.0.1:/home/testuser/
+        ssh testuser@127.0.0.1 -p 2222 -t "sudo chown -R testuser:users /home/testuser"
 
-        ssh [email protected] -p 2222 -t "sudo shutdown -h now"
+        ssh [email protected] -p 2222 -t "bash /home/testuser/scripts/qemu/run-build.sh"
+        ssh [email protected] -p 2222 -t "sudo shutdown -h now"
 
-    - name: Run tests
+    - name: Run tests in QEMU
       run: |
-        for config_file in scripts/qemu/configs/*.xml; do
-          config_name=$(basename $config_file .xml)
+        for config_file in umf/scripts/qemu/configs/*.xml; do
+          config_name=$(basename $config_file)
 
-          echo testing $config_name
           while ps -aux | grep qemu-system-x86_64 | grep -q -v grep; do
             echo "Waiting for QEMU to shut down..."
             sleep 5
           done
-          scripts/qemu/start_qemu.sh $config_file
-          
-          if [ ${{ github.event_name }} = 'pull_request' ]; then
-            CI_REPO="${{ github.event.pull_request.head.repo.full_name }}"
-          else
-            CI_REPO="$GITHUB_REPOSITORY"
-          fi
-
-          ssh [email protected] -p 2222 -t "bash /home/cxltest/run-tests.sh"
-          ssh [email protected] -p 2222 -t "sudo shutdown -h now"
+
+          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"
         done

scripts/qemu/qemu_config.py renamed to scripts/qemu/parse_config.py

@@ -1,3 +1,10 @@
+"""
+ Copyright (C) 2023-2024 Intel Corporation
+
+ Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
+ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+"""
+
 import re
 import subprocess  # nosec
 import sys
@@ -6,10 +13,13 @@
 import psutil
 import shutil
 
-# If you want to manually run this script please install deps by: pip install -r requirements.txt
-# To get virsh please install libvirt-clients
+# This script parses the topology xml file and returns QEMU arguments.
+#
+# Before running this script:
+# - install python deps for this script: pip install -r requirements.txt
+# - install 'libvirt-clients' package (for virsh)
 #
-# Enable verbose mode by using environment variable ENABLE_VERBOSE=1
+# Enable verbose mode by setting environment variable: ENABLE_VERBOSE=1
 
 TopologyCfg = collections.namedtuple(
     "TopologyCfg", ["name", "hmat", "cpu_model", "cpu_options", "mem_options"]
@@ -20,7 +30,7 @@
 
 def enable_verbose():
     """
-    Parse command line arguments
+    Check if env var ENABLE_VERBOSE is set and enable verbose mode
     """
     global verbose_mode
     verbose_mode = os.getenv("ENABLE_VERBOSE", False)
@@ -43,9 +53,13 @@ def parse_topology_xml(tpg_file_name: str) -> TopologyCfg:
         result.check_returncode()
         libvirt_args = result.stdout.decode("utf-8").strip()
 
+        if verbose_mode != False:
+            print(f"\nFull libvirt_args: {libvirt_args}\n")
+
+        hmat_search = re.search(r"hmat=(\w+)", libvirt_args)
         tpg_cfg = {
             "name": re.search(r"guest=(\w+)", libvirt_args).group(1),
-            "hmat": "hmat=on" in libvirt_args,
+            "hmat": hmat_search.group(0) if hmat_search else "hmat=off",
             "cpu_model": re.search(r"cpu (\S+)", libvirt_args).group(1),
             "cpu_options": re.search("(?=-smp)(.*)threads=[0-9]+", libvirt_args).group(
                 0
@@ -67,7 +81,7 @@ def parse_topology_xml(tpg_file_name: str) -> TopologyCfg:
     except subprocess.CalledProcessError:
         sys.exit(f"\n XML file: {tpg_file_name} error in virsh parsing")
     except Exception:
-        sys.exit(f"\n Provided file is missing or missing virsh.")
+        sys.exit(f"\n Provided file ({tpg_file_name}) is missing or missing virsh.")
     return tpg
 
 
@@ -76,13 +90,16 @@ def get_qemu_args(tpg_file_name: str) -> str:
     Get QEMU arguments from topology xml file
     """
     tpg = parse_topology_xml(tpg_file_name)
-    qemu_args = f"-name {tpg.name} {calculate_memory(tpg)} -cpu {tpg.cpu_model} {tpg.cpu_options} {tpg.mem_options}"
+    qemu_args = (
+        f"-machine q35,usb=off,{tpg.hmat} -name {tpg.name} "
+        f"{calculate_memory(tpg)} -cpu {tpg.cpu_model} {tpg.cpu_options} {tpg.mem_options}"
+    )
     return qemu_args
 
 
 def calculate_memory(tpg: TopologyCfg) -> str:
     """
-    Memory used by QEMU
+    Total memory required by given QEMU config
     """
     if tpg.mem_options:
         mem_needed = 0
@@ -105,4 +122,6 @@ def calculate_memory(tpg: TopologyCfg) -> str:
         tpg_file_name = sys.argv[1]
     else:
         sys.exit(f"\n Usage: {sys.argv[0]} <tpg_file_name>")
+
+    # Print QEMU arguments as a result of this script
     print(get_qemu_args(tpg_file_name))

scripts/qemu/run-build.sh

@@ -5,15 +5,9 @@
 
 set -e
 
-repo=$1
-branch=$2
-
-echo password | sudo -Sk apt update
-echo password | sudo -Sk apt install -y git cmake gcc g++ numactl libnuma-dev libhwloc-dev libjemalloc-dev libtbb-dev pkg-config valgrind hwloc
-
-git clone $repo umf
-cd umf
-git checkout $branch
+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
 
 mkdir build
 cd build

scripts/qemu/run-tests.sh

@@ -13,7 +13,7 @@ echo password | sudo bash -c "echo 0 > /proc/sys/kernel/yama/ptrace_scope"
 
 numactl -H
 
-cd umf/build
+cd build
 ctest --verbose
 
 # run tests bound to a numa node
@@ -23,4 +23,3 @@ numactl -N 1 ctest --output-on-failure
 # run tests under valgrind
 echo "Running tests under valgrind memcheck ..."
 ../test/test_valgrind.sh .. . memcheck
-

scripts/qemu/start_qemu.sh

@@ -3,28 +3,25 @@
 # Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-set -x
 set -e
 
-config_file=$1
+# The config file name (should be located in ./configs/ sub-dir)
+config_name=$1
 
-python3 scripts/qemu/qemu_config.py $config_file
+# Parse the config file to get topology info and fix escaped single quotes
+parsed_config=$(python3 "$(dirname $0)/parse_config.py" "$(dirname $0)/configs/${config_name}" | sed s/''\''/'/g)
 
-if grep -q '<interconnects>' "$config_file"; then
-    hmat="on"
-else
-    hmat="off"
-fi
+set -x
 
 sudo qemu-system-x86_64 \
     -drive file=./ubuntu-23.04-server-cloudimg-amd64.img,format=qcow2,index=0,media=disk,id=hd \
     -cdrom ./ubuntu-cloud-init.iso \
-    -machine q35,usb=off,hmat=$hmat \
     -enable-kvm \
     -net nic -net user,hostfwd=tcp::2222-:22 \
-    $(python3 scripts/qemu/qemu_config.py $config_file | sed s/''\''/'/g) \
+    ${parsed_config} \
     -daemonize -display none
 
+# Enable ssh connection to the VM
 until ssh-keyscan -p 2222 -H 127.0.0.1 >> ~/.ssh/known_hosts 2>/dev/null; do
     echo "Waiting for SSH..."
     sleep 1