Merge pull request #871 from diffblue/vlindex-in-CI

Vlindex in CI

Author: tautschnig

.github/workflows/pull-request-checks.yaml

@@ -125,6 +125,12 @@ jobs:
           name: ebmc-binary
           retention-days: 5
           path: src/ebmc/ebmc
+      - name: Upload the vlindex binary
+        uses: actions/upload-artifact@v4
+        with:
+          name: vlindex-binary
+          retention-days: 5
+          path: src/vlindex/vlindex
 
   # This job takes approximately 4 minutes
   benchmarking:
@@ -167,8 +173,17 @@ jobs:
           path: ebmc
       - name: Try the ebmc binary
         run: chmod a+x ./ebmc/ebmc ; ./ebmc/ebmc --version
-      - name: Hazard3
-        run: PATH=$PATH:$PWD/ebmc examples/Hazard3/Hazard3.sh
+      - name: ebmc on Hazard3
+        run: PATH=$PATH:$PWD/ebmc examples/Hazard3/Hazard3-ebmc.sh
+      - name: Get the vlindex binary
+        uses: actions/download-artifact@v4
+        with:
+          name: vlindex-binary
+          path: vlindex
+      - name: Try the vlindex binary
+        run: chmod a+x ./vlindex/vlindex ; ./vlindex/vlindex --version
+      - name: vlindex on Hazard3
+        run: PATH=$PATH:$PWD/vlindex examples/Hazard3/Hazard3-vlindex.sh
 
   # This job takes approximately 15 minutes
   check-centos8-make-gcc:

examples/Hazard3/Hazard3.sh renamed to examples/Hazard3/Hazard3-ebmc.sh

@@ -0,0 +1,34 @@
+#!/bin/sh
+
+# abort on error
+set -e
+
+# clone Hazard3 repo if not done yet
+if [ ! -e Hazard3/.git ] ; then
+  git clone https://github.com/Wren6991/Hazard3 --branch v1.0 --depth 1
+fi
+
+cd Hazard3
+
+vlindex -I hdl | tee vlindex-output
+
+grep "Number of" vlindex-output > vlindex-output-filtered
+
+# This errors when there's a diff
+diff vlindex-output-filtered - << EOM
+Number of files...........: 46
+Number of symlinked files.: 0
+Number of lines...........: 12093
+Number of modules.........: 46
+Number of UDPs............: 0
+Number of checkers........: 0
+Number of classes.........: 0
+Number of packages........: 0
+Number of interfaces......: 0
+Number of functions.......: 7
+Number of tasks...........: 0
+Number of properties......: 0
+Number of sequences.......: 0
+Number of module instances: 71
+Number of configurations..: 0
+EOM

examples/Hazard3/Hazard3-vlindex.sh

@@ -22,6 +22,7 @@ class vlindex_parse_optionst : public parse_options_baset
 
   vlindex_parse_optionst(int argc, const char **argv)
     : parse_options_baset(
+        "(version)"
         "(top)"
         "(hierarchy)"
         "(modules)"