11 implement osi validation check against a set of rules

.github/workflows/build_osi-validation.yml

@@ -0,0 +1,55 @@
+name: Build osi-validation
+
+on:
+  workflow_call:
+
+jobs:
+  build_esmini:
+    name: Build osi-validation
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Cache osi-validation
+        id: cache-osi-validation
+        uses: actions/cache@v3
+        with:
+          path: /tmp/osi-validation
+          key: ${{ runner.os }}-osi-validation
+
+      - name: Get osi-validation
+        if: steps.cache-osi-validation.outputs.cache-hit != 'true'
+        working-directory: /tmp
+        env:
+          GIT_CLONE_PROTECTION_ACTIVE: false
+        run: git clone https://github.com/OpenSimulationInterface/osi-validation.git
+
+      - name: Update Submodules
+        if: steps.cache-osi-validation.outputs.cache-hit != 'true'
+        working-directory: /tmp/osi-validation
+        run: git submodule update --init
+
+      - name: Build osi-validation
+        if: steps.cache-osi-validation.outputs.cache-hit != 'true'
+        working-directory: /tmp/osi-validation
+        run: |
+          python3 -m venv .venv
+          source .venv/bin/activate
+          python3 -m pip install --upgrade pip
+          python3 -m pip install -r requirements_develop.txt
+          cd open-simulation-interface && python3 -m pip install . && cd ..
+          python3 -m pip install -r requirements.txt
+          python3 rules2yml.py -d rules
+          python3 -m pip install .
+
+      - name: Generate default rules
+        if: steps.cache-osi-validation.outputs.cache-hit != 'true'
+        working-directory: /tmp/osi-validation
+        run: |
+          source .venv/bin/activate
+          python3 rules2yml.py
+
+      - name: Add Commit ID to Cache
+        if: steps.cache-osi-validation.outputs.cache-hit != 'true'
+        working-directory: /tmp/osi-validation
+        run: |
+          git rev-parse --short HEAD > commit-id.txt

.github/workflows/cl2.yml

@@ -16,9 +16,9 @@ jobs:
     name: Build esmini FMU
     uses: ./.github/workflows/build_esmini.yml
 
-  build_osi_field_checker_fmu:
-    name: Build OSI Field Checker FMU
-    uses: ./.github/workflows/build_osi_field_checker.yml
+  build_osi-validation:
+    name: Build osi-validation
+    uses: ./.github/workflows/build_osi-validation.yml
 
   build_openmcx:
     name: Build OpenMCx
@@ -39,7 +39,7 @@ jobs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
 
   run_integration_test:
-    needs: [build_tracefile_player, build_tracefile_writer, build_openmcx, build_osi_field_checker_fmu, build_esmini, generate_integration_test_paths]
+    needs: [build_tracefile_player, build_tracefile_writer, build_openmcx, build_esmini, generate_integration_test_paths]
     name: Integration Test
     runs-on: ubuntu-latest
     strategy:
@@ -91,12 +91,12 @@ jobs:
           path: /tmp/esmini_fmu
           key: ${{ runner.os }}-esmini-fmu
 
-      - name: Cache OSI Field Checker
-        id: cache-osi-field-checker
+      - name: Cache osi-validation
+        id: cache-osi-validation
         uses: actions/cache@v3
         with:
-          path: /tmp/osi-field-checker
-          key: ${{ runner.os }}-osi-field-checker
+          path: /tmp/osi-validation
+          key: ${{ runner.os }}-osi-validation
 
       - name: Cache OpenMCx
         id: cache-openmcx
@@ -121,6 +121,35 @@ jobs:
       - name: Install dependencies
         run: sudo apt install -y libxml2-dev zlib1g-dev libzip-dev
 
+      - name: Check For Input Trace Files
+        id: check-for-input-trace-files
+        working-directory: ./test/integration/${{ matrix.path }}
+        run: |
+          ( count=`ls -1 *.osi 2>/dev/null | wc -l`
+          if [ $count == 0 ]; then
+          echo No trace file found.
+          echo "found_trace=0" >> $GITHUB_OUTPUT
+          elif [ $count == 1 ]; then
+          echo One trace file found.
+          echo "found_trace=1" >> $GITHUB_OUTPUT
+          filename=$(ls -1 *.osi)
+          else
+          echo More than one trace file.
+          echo "found_trace=1" >> $GITHUB_OUTPUT
+          fi
+          )
+
+      - name: Check Input Trace Files with osi-validation and model output rules
+        if: steps.check-for-input-trace-files.outputs.found_trace == 1
+        run: |
+          if [ -d "./rules/input_rules" ]; then
+            source /tmp/osi-validation/.venv/bin/activate
+            for filename in ./test/integration/${{ matrix.path }}/*.osi; do
+              osivalidator --rules ./rules/input_rules --data ${filename}
+            done
+          else echo "No custom input rules found in ./rules/input_rules";
+          fi
+
       - name: Create Output Folder
         working-directory: ./test/integration/${{ matrix.path }}
         run: mkdir output
@@ -129,31 +158,54 @@ jobs:
         id: cosimulation
         run: ./openmcx/install/openmcx ./test/integration/${{ matrix.path }}/SystemStructure.ssd
 
-      - name: Check For Trace Files
-        id: check-for-trace-files
+      - name: Check For Output Trace Files
+        id: check-for-output-trace-files
         working-directory: ./test/integration/${{ matrix.path }}/output
         run: |
           ( count=`ls -1 *.osi 2>/dev/null | wc -l`
           if [ $count == 0 ]; then
           echo No trace file found.
           echo "found_trace=0" >> $GITHUB_OUTPUT
           elif [ $count == 1 ]; then
+          echo One trace file found.
           echo "found_trace=1" >> $GITHUB_OUTPUT
           filename=$(ls -1 *.osi)
           echo "trace_file_name=${filename}" >> $GITHUB_OUTPUT
           else
           echo More than one trace file.
-          echo "found_trace=0" >> $GITHUB_OUTPUT
+          echo "found_trace=1" >> $GITHUB_OUTPUT
+          zip ${{ matrix.path }}.zip *.osi
+          echo "trace_file_name=${{ matrix.path }}.zip" >> $GITHUB_OUTPUT
           fi
           )
 
-      - name: Archive Trace File
-        if: steps.check-for-trace-files.outputs.found_trace == 1
+      - name: Archive Output Trace Files
+        if: steps.check-for-output-trace-files.outputs.found_trace == 1
         uses: actions/upload-artifact@v3
         with:
-          name: ${{ steps.check-for-trace-files.outputs.trace_file_name }}
-          path: ./test/integration/${{ matrix.path }}/output/${{ steps.check-for-trace-files.outputs.trace_file_name }}
-
+          name: ${{ steps.check-for-output-trace-files.outputs.trace_file_name }}
+          path: ./test/integration/${{ matrix.path }}/output/${{ steps.check-for-output-trace-files.outputs.trace_file_name }}
+
+      - name: Check Output Trace Files with osi-validation and default rules
+        if: steps.check-for-output-trace-files.outputs.found_trace == 1
+        working-directory: ./test/integration/${{ matrix.path }}/output
+        run: |
+          source /tmp/osi-validation/.venv/bin/activate
+          for filename in ./*.osi; do
+            osivalidator --rules /tmp/osi-validation/rules/ --data ${filename}
+          done
+
+      - name: Check Output Trace Files with osi-validation and model output rules
+        if: steps.check-for-output-trace-files.outputs.found_trace == 1
+        run: |
+          if [ -d "./rules/output_rules" ]; then
+            source /tmp/osi-validation/.venv/bin/activate
+            for filename in ./test/integration/${{ matrix.path }}/output/*.osi; do
+              osivalidator --rules ./rules/output_rules --data ${filename}
+            done
+          else echo "No custom output rules found in ./rules/output_rules";
+          fi
+
       - name: Check For Python Scripts
         id: check-for-python-scripts
         working-directory: ./test/integration/${{ matrix.path }}
@@ -186,7 +238,7 @@ jobs:
       - name: Run Trace File Analysis
         if: steps.check-for-python-scripts.outputs.found_script == 1
         working-directory: ./test/integration/${{ matrix.path }}
-        run: python3 ${{ steps.check-for-python-scripts.outputs.python_file_name }} output/${{ steps.check-for-trace-files.outputs.trace_file_name }}
+        run: python3 ${{ steps.check-for-python-scripts.outputs.python_file_name }} output/${{ steps.check-for-output-trace-files.outputs.trace_file_name }}
 
       - name: Failed?
         if: steps.cosimulation.outputs.failed == 1

README.md

@@ -37,29 +37,33 @@ Each parameter should have a short description as shown in the following example
 ## Interface
 
 What interfaces are used as model input and model output?
-All required field of the interface shall be named in a list as shown in the following example.
+All required and optional messages of the interface shall be named in a list as shown in the following example.
 
 ### Input: Required Fields in osi3::SensorView and/or osi3::TrafficCommand
 
-* `sensor_view.global_ground_truth.timestamp`
-* `sensor_view.global_ground_truth.host_vehicle_id`
-* `sensor_view.global_ground_truth.moving_object.id`
-* `sensor_view.global_ground_truth.moving_object.base.position`
-* `sensor_view.global_ground_truth.moving_object.base.orientation`
-* `sensor_view.global_ground_truth.moving_object.base.velocity`
-* `traffic_command.traffic_participant_id`
-* `traffic_command.action`
+| OSI Message                                                      | Required / Optional |
+|------------------------------------------------------------------|---------------------|
+| `sensor_view.global_ground_truth.timestamp`                      | required            |
+| `sensor_view.global_ground_truth.host_vehicle_id`                | required            |
+| `sensor_view.global_ground_truth.moving_object.id`               | required            |
+| `sensor_view.global_ground_truth.moving_object.base.position`    | required            |
+| `sensor_view.global_ground_truth.moving_object.base.orientation` | required            |
+| `sensor_view.global_ground_truth.moving_object.base.velocity`    | required            |
+| `traffic_command.traffic_participant_id`                         | required            |
+| `traffic_command.action`                                         | optional            |
 
 ### Output: Fields in osi3::TrafficUpdate and/or osi3::TrafficCommandUpdate filled by the Model
 
-* `traffic_update.version`
-* `traffic_update.timestamp`
-* `traffic_update.update.base.position`
-* `traffic_update.update.base.orientation`
-* `traffic_update.update.base.velocity`
-* `traffic_command_update.version`
-* `traffic_command_update.timestamp`
-* `traffic_command_update.dismissed_action`
+| OSI Message                               | Required / Optional |
+|-------------------------------------------|---------------------|
+| `traffic_update.version`                  | required            |
+| `traffic_update.timestamp`                | required            |
+| `traffic_update.update.base.position`     | required            |
+| `traffic_update.update.base.orientation`  | required            |
+| `traffic_update.update.base.velocity`     | required            |
+| `traffic_command_update.version`          | required            |
+| `traffic_command_update.timestamp`        | required            |
+| `traffic_command_update.dismissed_action` | optional            |
 
 ## Build Instructions