Add a template for unit-tests
[kconfig-hardened-check.git] / .github / workflows / main.yml
index 2ccf6f2ae543181bc4c4e566e4d041cdead1ebd4..eb1a8dda2ccb9f904f4f45b0902bf588e475aa5c 100644 (file)
@@ -12,16 +12,16 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
-      max-parallel: 4
+      max-parallel: 3
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
-        # github runner with python 3.5 currently fails to install this package
+        # Current ubuntu-latest (Ubuntu 22.04) provides the following versions of Python:
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
 
     steps:
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -37,18 +37,18 @@ jobs:
       run: |
         echo ">>>>> check all configs <<<<<"
         CONFIG_DIR=`find /opt/hostedtoolcache/Python/ -name config_files`
-        CONFIGS=`find $CONFIG_DIR -type f | grep "\.config"`
+        KCONFIGS=`find $CONFIG_DIR -type f | grep "\.config"`
         COUNT=0
-        for C in $CONFIGS
+        for C in $KCONFIGS
         do
                 COUNT=$(expr $COUNT + 1)
                 echo -e "\n>>>>> checking config number $COUNT <<<<<"
-                kconfig-hardened-check -c $C
+                kconfig-hardened-check -c $C -l /proc/cmdline
         done
         echo -e "\n>>>>> checking $COUNT configs is done <<<<<"
 
     - name: Get source code for collecting coverage
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Collect coverage for the basic functionality
       run: |
@@ -76,23 +76,25 @@ jobs:
         coverage run -a --branch bin/kconfig-hardened-check -p ARM -m verbose
         coverage run -a --branch bin/kconfig-hardened-check -p ARM -m json
 
-        echo ">>>>> use local cmdline as an example <<<<<"
-        cat /proc/cmdline
-
         echo ">>>>> check the example kconfig files and cmdline <<<<<"
+        cat /proc/cmdline
+        echo "l1tf=off mds=full randomize_kstack_offset=on iommu.passthrough=0" > ./cmdline_example
+        cat ./cmdline_example
         CONFIG_DIR=`find . -name config_files`
-        CONFIGS=`find $CONFIG_DIR -type f | grep "\.config"`
+        KCONFIGS=`find $CONFIG_DIR -type f | grep "\.config"`
         COUNT=0
-        for C in $CONFIGS
+        for C in $KCONFIGS
         do
                 COUNT=$(expr $COUNT + 1)
                 echo -e "\n>>>>> checking config number $COUNT <<<<<"
                 coverage run -a --branch bin/kconfig-hardened-check -c $C
+                coverage run -a --branch bin/kconfig-hardened-check -c $C -m verbose > /dev/null
                 coverage run -a --branch bin/kconfig-hardened-check -c $C -l /proc/cmdline
-                coverage run -a --branch bin/kconfig-hardened-check -c $C -l /proc/cmdline -m verbose > /dev/null
-                coverage run -a --branch bin/kconfig-hardened-check -c $C -l /proc/cmdline -m json
-                coverage run -a --branch bin/kconfig-hardened-check -c $C -l /proc/cmdline -m show_ok
-                coverage run -a --branch bin/kconfig-hardened-check -c $C -l /proc/cmdline -m show_fail
+                coverage run -a --branch bin/kconfig-hardened-check -c $C -l ./cmdline_example
+                coverage run -a --branch bin/kconfig-hardened-check -c $C -l ./cmdline_example -m verbose > /dev/null
+                coverage run -a --branch bin/kconfig-hardened-check -c $C -l ./cmdline_example -m json
+                coverage run -a --branch bin/kconfig-hardened-check -c $C -l ./cmdline_example -m show_ok
+                coverage run -a --branch bin/kconfig-hardened-check -c $C -l ./cmdline_example -m show_fail
         done
         echo -e "\n>>>>> checking $COUNT configs is done <<<<<"
 
@@ -101,7 +103,7 @@ jobs:
         echo ">>>>> lonely -l <<<<<"
         ! coverage run -a --branch bin/kconfig-hardened-check -l /proc/cmdline
 
-        echo ">>>>> wrong modes for -p  <<<<<"
+        echo ">>>>> wrong modes for -p <<<<<"
         ! coverage run -a --branch bin/kconfig-hardened-check -p X86_64 -m show_ok
         ! coverage run -a --branch bin/kconfig-hardened-check -p X86_64 -m show_fail
 
@@ -115,30 +117,40 @@ jobs:
         ! coverage run -a --branch bin/kconfig-hardened-check -c error.config
 
         echo ">>>>> strange kernel version string <<<<<"
-        sed  '3 s/5./version 5./' test.config > error.config
+        sed '3 s/5./version 5./' test.config > error.config
         ! coverage run -a --branch bin/kconfig-hardened-check -c error.config
 
         echo ">>>>> no arch <<<<<"
-        sed  '305d' test.config > error.config
+        sed '305d' test.config > error.config
         ! coverage run -a --branch bin/kconfig-hardened-check -c error.config
 
         echo ">>>>> more than one arch <<<<<"
         cp test.config error.config
-        echo  'CONFIG_ARM64=y' >> error.config
+        echo 'CONFIG_ARM64=y' >> error.config
         ! coverage run -a --branch bin/kconfig-hardened-check -c error.config
 
         echo ">>>>> invalid disabled kconfig option <<<<<"
-        sed  '28 s/is not set/is not set yet/' test.config > error.config
+        sed '28 s/is not set/is not set yet/' test.config > error.config
+        ! coverage run -a --branch bin/kconfig-hardened-check -c error.config
+
+        echo ">>>>> invalid enabled kconfig option <<<<<"
+        cp test.config error.config
+        echo 'CONFIG_FOO=is not set' >> error.config
         ! coverage run -a --branch bin/kconfig-hardened-check -c error.config
 
         echo ">>>>> one config option multiple times <<<<<"
         cp test.config error.config
-        echo  'CONFIG_BUG=y' >> error.config
+        echo 'CONFIG_BUG=y' >> error.config
+        ! coverage run -a --branch bin/kconfig-hardened-check -c error.config
+
+        echo ">>>>> invalid compiler versions <<<<<"
+        cp test.config error.config
+        sed '8 s/CONFIG_CLANG_VERSION=0/CONFIG_CLANG_VERSION=120000/' test.config > error.config
         ! coverage run -a --branch bin/kconfig-hardened-check -c error.config
 
         echo ">>>>> multi-line cmdline file <<<<<"
-        echo  'hey man 1' > cmdline
-        echo  'hey man 2' >> cmdline
+        echo 'hey man 1' > cmdline
+        echo 'hey man 2' >> cmdline
         ! coverage run -a --branch bin/kconfig-hardened-check -c test.config -l cmdline
 
     - name: Prepare final coverage report
@@ -146,11 +158,20 @@ jobs:
         coverage xml -i -o coverage.xml
 
     - name: Handle coverage
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v3
       with:
-        file: ./coverage.xml
+        files: ./coverage.xml
         flags: functional_test
         name: codecov-umbrella
         fail_ci_if_error: true
         verbose: true
 
+    - name: Erase coverage
+      run: |
+        coverage erase
+        rm ./coverage.xml
+
+    - name: Run unit-tests and collect coverage
+      run: |
+        coverage run --include=kconfig_hardened_check/engine.py,kconfig_hardened_check/test_engine.py -m unittest -v
+        coverage xml -i -o coverage_unittest.xml