ETR01SDK-466: Refactor model

.github/workflows/coverage.yml

@@ -40,52 +40,41 @@ jobs:
         with:
           python-version: '3.12'
 
-      - name: Download ts-tvl wheel
-        run: |
-          curl -s "https://api.github.com/repos/tropicsquare/ts-tvl/releases/tags/2.3" > release.json
-
-          WHEEL_URL=$(jq -r '.assets[] | select(.name | endswith(".whl")) | .browser_download_url' release.json)
-          if [ -z "$WHEEL_URL" ]; then
-            echo "No .whl file found in the release." >&2
-            exit 1
-          fi
-
-          WHEEL_FILE_NAME=$(basename "$WHEEL_URL")
-          echo "WHEEL_FILE_NAME=$WHEEL_FILE_NAME" >> $GITHUB_ENV
-          curl -L -o "$WHEEL_FILE_NAME" "$WHEEL_URL"
-
       - name: Install dependencies
         run: |
-            sudo apt-get install cmake build-essential
-            pip install ${{ env.WHEEL_FILE_NAME }}
+            sudo apt-get install cmake build-essential ninja-build
+            ./tests/functional/model/download_deps.sh
+            ./scripts/tropic01_model/install_linux.sh
+            source ./scripts/tropic01_model/.venv/bin/activate
             pip install gcovr jsonschema
 
       - name: Compile and run functional tests with coverage enabled, export trace
         run: |
-            cd tropic01_model/
+            source ./scripts/tropic01_model/.venv/bin/activate
+            cd tests/functional/model/
             cmake ./ -B build -G Ninja -DLT_CAL=mbedtls_v4 -DLT_BUILD_TESTS=1 -DLT_TEST_COVERAGE=1
             cd build/
             ninja
             ctest -V
 
-            cd ..
-            gcovr --json coverage_trace.json --exclude 'build/_deps/.*|\.\./tests/.*|\.\./vendor/.*|\.\./hal/.*|\.\./cal/.*'
+            gcovr --json coverage_trace.json --exclude '.*_deps/.*|.*cal/.*|.*hal/.*' -r ../../../..
 
       - name: Compile and run functional mock tests with coverage enabled, export trace
         run: |
+          source ./scripts/tropic01_model/.venv/bin/activate
           cd tests/functional_mock
           mkdir -p build
           cd build
           cmake -G Ninja -DLT_TEST_COVERAGE=1 ..
           ninja
           ctest -V
 
-          cd ..
-          gcovr --json coverage_trace.json --exclude 'build/_deps/.*|\.\./tests/.*|\.\./vendor/.*|\.\./\.\./hal/.*|\.\./\.\./cal/.*'
+          gcovr --json coverage_trace.json --exclude '.*_deps/.*|.*cal/.*|.*hal/.*' -r ../../..
 
       - name: Merge coverage and generate markdown report
         run: |
-          gcovr --json-add-tracefile tropic01_model/coverage_trace.json --json-add-tracefile tests/functional_mock/coverage_trace.json --markdown coverage_report.md
+          source ./scripts/tropic01_model/.venv/bin/activate
+          gcovr --json-add-tracefile tests/functional_mock/build/coverage_trace.json --json-add-tracefile tests/functional/model/build/coverage_trace.json --markdown coverage_report.md
 
       - name: Post or update PR comment
         uses: actions/github-script@v7

.github/workflows/functional_mock_tests.yml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-            sudo apt-get install cmake build-essential
+            sudo apt-get install cmake build-essential ninja-build
             pip install jsonschema jinja2
 
       - name: Compile functional mock tests with AddressSanitizer
@@ -58,7 +58,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-            sudo apt-get install cmake build-essential valgrind
+            sudo apt-get install cmake build-essential valgrind ninja-build
             pip install jsonschema jinja2
 
       - name: Compile functional mock tests with Valgrind

.github/workflows/integration_tests.yml

@@ -24,44 +24,34 @@ jobs:
         with:
           python-version: '3.8'
 
-      - name: Download ts-tvl wheel
-        run: |
-          curl -s "https://api.github.com/repos/tropicsquare/ts-tvl/releases/tags/2.3" > release.json
-
-          WHEEL_URL=$(jq -r '.assets[] | select(.name | endswith(".whl")) | .browser_download_url' release.json)
-          if [ -z "$WHEEL_URL" ]; then
-            echo "No .whl file found in the release." >&2
-            exit 1
-          fi
-
-          WHEEL_FILE_NAME=$(basename "$WHEEL_URL")
-          echo "WHEEL_FILE_NAME=$WHEEL_FILE_NAME" >> $GITHUB_ENV
-          curl -L -o "$WHEEL_FILE_NAME" "$WHEEL_URL"
-
       - name: Install dependencies
         run: |
-            sudo apt-get install cmake build-essential
-            pip install ${{ env.WHEEL_FILE_NAME }}
+            sudo apt-get install cmake build-essential ninja-build
+            ./tests/functional/model/download_deps.sh
+            ./scripts/tropic01_model/install_linux.sh
+            source ./scripts/tropic01_model/.venv/bin/activate
             pip install jsonschema
 
       - name: Compile libtropic with tests and AddressSanitizer
         run: |
-            cd tropic01_model/
-            cmake ./ -B build -G Ninja -DLT_CAL=mbedtls_v4 -DLT_BUILD_TESTS=1 -DCMAKE_BUILD_TYPE=Debug -DLT_ASAN=1
+            source ./scripts/tropic01_model/.venv/bin/activate
+            cd tests/functional/model/
+            cmake ./ -B build -G Ninja -DLT_CAL=mbedtls_v4 -DCMAKE_BUILD_TYPE=Debug -DLT_ASAN=1
             cd build/
             ninja
 
       - name: Execute tests with CTest
         run: |
-            cd tropic01_model/build/
+            source ./scripts/tropic01_model/.venv/bin/activate
+            cd tests/functional/model/build
             ctest -V
 
       - name: Upload run logs
         if: always()
         uses: actions/upload-artifact@v4
         with:
           name: asan_run_logs
-          path: tropic01_model/build/run_logs/
+          path: tests/functional/model/build/run_logs
 
   tests_valgrind:
     name: Run tests with Valgrind
@@ -77,41 +67,31 @@ jobs:
         with:
           python-version: '3.8'
 
-      - name: Download ts-tvl wheel
-        run: |
-          curl -s "https://api.github.com/repos/tropicsquare/ts-tvl/releases/tags/2.3" > release.json
-
-          WHEEL_URL=$(jq -r '.assets[] | select(.name | endswith(".whl")) | .browser_download_url' release.json)
-          if [ -z "$WHEEL_URL" ]; then
-            echo "No .whl file found in the release." >&2
-            exit 1
-          fi
-
-          WHEEL_FILE_NAME=$(basename "$WHEEL_URL")
-          echo "WHEEL_FILE_NAME=$WHEEL_FILE_NAME" >> $GITHUB_ENV
-          curl -L -o "$WHEEL_FILE_NAME" "$WHEEL_URL"
-
       - name: Install dependencies
         run: |
-            sudo apt-get install cmake build-essential valgrind
-            pip install ${{ env.WHEEL_FILE_NAME }}
+            sudo apt-get install cmake build-essential valgrind ninja-build
+            ./tests/functional/model/download_deps.sh
+            ./scripts/tropic01_model/install_linux.sh
+            source ./scripts/tropic01_model/.venv/bin/activate
             pip install jsonschema
 
       - name: Compile libtropic with tests and Valgrind
         run: |
-            cd tropic01_model/
-            cmake ./ -B build -G Ninja -DLT_CAL=mbedtls_v4 -DLT_BUILD_TESTS=1 -DCMAKE_BUILD_TYPE=Debug -DLT_VALGRIND=1
+            source ./scripts/tropic01_model/.venv/bin/activate
+            cd tests/functional/model/
+            cmake ./ -B build -G Ninja -DLT_CAL=mbedtls_v4 -DCMAKE_BUILD_TYPE=Debug -DLT_VALGRIND=1
             cd build/
             ninja
 
       - name: Execute tests with CTest
         run: |
-            cd tropic01_model/build/
+            source ./scripts/tropic01_model/.venv/bin/activate
+            cd tests/functional/model/build
             ctest -V
 
       - name: Upload run logs
         if: always()
         uses: actions/upload-artifact@v4
         with:
           name: valgrind_run_logs
-          path: tropic01_model/build/run_logs/
+          path: tests/functional/model/build/run_logs

.github/workflows/run_examples.yml

@@ -1,4 +1,4 @@
-name: Run examples against TROPIC01 model
+name: Run examples for TROPIC01 model
 on:
   push:
     branches:
@@ -11,7 +11,7 @@ on:
 
 jobs:
   examples_asan:
-    name: Run examples with AddressSanitizer
+    name: Compile and run examples for TROPIC01 model with Valgrind
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -24,123 +24,30 @@ jobs:
         with:
           python-version: '3.8'
 
-      - name: Download ts-tvl wheel
-        run: |
-          curl -s "https://api.github.com/repos/tropicsquare/ts-tvl/releases/tags/2.3" > release.json
-
-          WHEEL_URL=$(jq -r '.assets[] | select(.name | endswith(".whl")) | .browser_download_url' release.json)
-          if [ -z "$WHEEL_URL" ]; then
-            echo "No .whl file found in the release." >&2
-            exit 1
-          fi
-
-          WHEEL_FILE_NAME=$(basename "$WHEEL_URL")
-          echo "WHEEL_FILE_NAME=$WHEEL_FILE_NAME" >> $GITHUB_ENV
-          curl -L -o "$WHEEL_FILE_NAME" "$WHEEL_URL"
-
       - name: Install dependencies
         run: |
-            sudo apt-get install cmake build-essential
-            pip install ${{ env.WHEEL_FILE_NAME }}
+            sudo apt-get install cmake build-essential valgrind ninja-build
+            ./tests/functional/model/download_deps.sh
+            ./scripts/tropic01_model/install_linux.sh
+            source ./scripts/tropic01_model/.venv/bin/activate
             pip install jsonschema
 
-      - name: Compile libtropic with examples and AddressSanitizer
+      - name: Compile and run Hello World example
         run: |
-            cd tropic01_model/
-            cmake ./ -B build -G Ninja -DLT_CAL=mbedtls_v4 -DLT_BUILD_EXAMPLES=1 -DCMAKE_BUILD_TYPE=Debug -DLT_ASAN=1
+            source ./scripts/tropic01_model/.venv/bin/activate
+            cd examples/model/hello_world
+            cmake ./ -B build -G Ninja
             cd build/
             ninja
-
-      - name: Create configuration for the model
-        run: |
-            cd tropic01_model/build/
-            LAB_BATCH_PKG_DIR=$(cmake -LAH .. | grep '^LAB_BATCH_PKG_DIR:' | cut -d'=' -f2)
-            echo "LAB_BATCH_PKG_DIR=$LAB_BATCH_PKG_DIR" >> $GITHUB_ENV
-            python3 ../create_model_cfg.py --pkg-dir "$LAB_BATCH_PKG_DIR" --riscv-fw-ver 2.0.0 --model-cfg ./model_cfg.yml
-
-      - name: Execute each example
-        run: |
-            cd tropic01_model/build/
-            for exe in ./lt_ex_*; do
-              if [[ -x "$exe" && ! -d "$exe" ]]; then
-                python3 ../../scripts/model_runner.py \
-                  -e "$exe" \
-                  -c model_cfg.yml \
-                  -o run_logs/
-              fi
-            done
-
-      - name: Upload run logs
-        if: always()
-        uses: actions/upload-artifact@v4
-        with:
-          name: asan_run_logs
-          path: tropic01_model/build/run_logs/
-
-  examples_valgrind:
-    name: Run examples with Valgrind
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4.1.7
-        with:
-          submodules: recursive
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.8'
-
-      - name: Download ts-tvl wheel
-        run: |
-          curl -s "https://api.github.com/repos/tropicsquare/ts-tvl/releases/tags/2.3" > release.json
-
-          WHEEL_URL=$(jq -r '.assets[] | select(.name | endswith(".whl")) | .browser_download_url' release.json)
-          if [ -z "$WHEEL_URL" ]; then
-            echo "No .whl file found in the release." >&2
-            exit 1
-          fi
-
-          WHEEL_FILE_NAME=$(basename "$WHEEL_URL")
-          echo "WHEEL_FILE_NAME=$WHEEL_FILE_NAME" >> $GITHUB_ENV
-          curl -L -o "$WHEEL_FILE_NAME" "$WHEEL_URL"
-
-      - name: Install dependencies
-        run: |
-            sudo apt-get install cmake build-essential valgrind
-            pip install ${{ env.WHEEL_FILE_NAME }}
-            pip install jsonschema
-
-      - name: Compile libtropic with examples
-        run: |
-            cd tropic01_model/
-            cmake ./ -B build -G Ninja -DLT_CAL=mbedtls_v4 -DLT_BUILD_EXAMPLES=1 -DCMAKE_BUILD_TYPE=Debug
-            cd build/
-            ninja
-
-      - name: Create configuration for the model
-        run: |
-            cd tropic01_model/build/
-            LAB_BATCH_PKG_DIR=$(cmake -LAH .. | grep '^LAB_BATCH_PKG_DIR:' | cut -d'=' -f2)
-            echo "LAB_BATCH_PKG_DIR=$LAB_BATCH_PKG_DIR" >> $GITHUB_ENV
-            python3 ../create_model_cfg.py --pkg-dir "$LAB_BATCH_PKG_DIR" --riscv-fw-ver 2.0.0 --model-cfg ./model_cfg.yml
-
-      - name: Execute each example
-        run: |
-            cd tropic01_model/build/
-            for exe in ./lt_ex_*; do
-              if [[ -x "$exe" && ! -d "$exe" ]]; then
-                python3 ../../scripts/model_runner.py \
-                  -e "$exe" \
-                  -c model_cfg.yml \
-                  -o run_logs/ \
-                  --use-valgrind
-              fi
-            done
+            python3 ../../../../scripts/tropic01_model/model_runner.py \
+              -e ./libtropic_hello_world \
+              -c ../../../../scripts/tropic01_model/model_cfg.yml \
+              -o run_logs/ \
+              --use-valgrind
 
       - name: Upload run logs
         if: always()
         uses: actions/upload-artifact@v4
         with:
           name: valgrind_run_logs
-          path: tropic01_model/build/run_logs/
+          path: examples/model/hello_world/build/run_logs/

.gitignore

@@ -6,6 +6,5 @@ docs_build/
 venv/
 __pycache__/
 .model_config_save.yaml
-model_cfg.yml
 *.whl
 _deps/

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   about if and how the LF is translated automatically (e.g., `stdio.h` implementation of major desktop platforms) or if you
   need to modify the behavior yourself (e.g., by modifiying `_write` syscall on STM32), or (in the case of the embedded platforms)
   you just need to configure your serial monitor correctly, so it expects only LF character (and not CR+LF pair).
+- Moved TROPIC01 Model related files to `scripts/tropic01_model`.
 
 ### Added
 - Logging: `lt_port_log` function for platform-specific logging mechanism; is used by the logging macros declared in `libtropic_logging.h`.

docs/for_contributors/tests/code_coverage.md

@@ -22,8 +22,8 @@ ctest -V
 
 After CTest finishes, use [gcovr](https://github.com/gcovr/gcovr) to export results:
 ```shell
-# Execute this from the tropic01_model/ directory!
-gcovr --json coverage_trace.json --exclude 'build/_deps/.*|\.\./tests/.*|\.\./vendor/.*|\.\./hal/.*|\.\./cal/.*'
+# Execute this from the tests/functional/model/build directory!
+gcovr --json coverage_trace.json --exclude '.*_deps/.*|.*cal/.*|.*hal/.*' -r ../../../..
 ```
 
 ## Running Functional Mock Tests
@@ -40,16 +40,16 @@ ctest -V
 
 After CTest finishes, use [gcovr](https://github.com/gcovr/gcovr) to export results:
 ```shell
-# Execute this from the tests/functional_mock directory!
-gcovr --json coverage_trace.json --exclude 'build/_deps/.*|\.\./tests/.*|\.\./vendor/.*|\.\./\.\./hal/.*|\.\./\.\./cal/.*'
+# Execute this from the tests/functional_mock/build directory!
+gcovr --json coverage_trace.json --exclude '.*_deps/.*|.*cal/.*|.*hal/.*' -r ../../..
 ```
 
 ## Merging and Exporting Total Coverage
 Use the following command to merge results and export in text format:
 
 ```shell
 # Execute this from the repository root (or adjust paths accordingly)
-gcovr --json-add-tracefile tropic01_model/coverage_trace.json  --json-add-tracefile tests/functional_mock/coverage_trace.json --txt coverage.txt
+gcovr --json-add-tracefile tests/functional_mock/build/coverage_trace.json --json-add-tracefile tests/functional/model/build/coverage_trace.json --txt coverage.txt
 ```
 
 !!! tip "Tip: Gcovr Output Formats"