Merge pull request #284 from krcb197/261-introduce-the-pathological-register-set-to-the-test-flow

Add Pathological Test to the CI

Author: krcb197

.github/workflows/action.yaml

@@ -425,10 +425,47 @@ jobs:
         mypy autoformatted_output
         python -m unittest discover -s autoformatted_output
 
+  pathological:
+
+    needs:
+      - integration_tests
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[peakrdl]
+          python -m pip install mypy
+
+      - name: Prepare System RDL
+        run: |
+          mkdir ./pathological_test
+          python -m tests.pathological_register_maps.pathological_rdl_builder ./pathological_test/deep.rdl deep
+
+      - name: build_package
+        run: |
+          peakrdl python ./pathological_test/deep.rdl -o ./pathological_test/ --skip_library_copy
+
+      - name: type check generated code
+        run: |
+           mypy ./pathological_test/deep/
+
+      - name: Run unit tests
+        run: python -m unittest discover -s ./pathological_test/
+
   #-------------------------------------------------------------------------------
   build:
     needs:
       - autoformating
+      - pathological
 
     name: Build source distribution
     runs-on: ubuntu-latest

…egister_maps/pathalogical_rdl_builder.py …egister_maps/pathological_rdl_builder.pytests/pathological_register_maps/pathalogical_rdl_builder.py renamed to tests/pathological_register_maps/pathological_rdl_builder.py tests/pathological_register_maps/pathalogical_rdl_builder.py renamed to tests/pathological_register_maps/pathological_rdl_builder.py

@@ -17,6 +17,7 @@
 
 The file is used for making pathological system RDL files for stress testing the tool
 """
+import argparse
 import os
 from typing import Optional
 from pathlib import Path
@@ -232,7 +233,17 @@ def addrmap_generator():
                                               name_prefix='top_level_addr')
 
 
+CommandLineParser = argparse.ArgumentParser(
+    description='Generate a pathological system RDL file to test the generator')
+CommandLineParser.add_argument('output_filename', type=Path,
+                               help='Filename of the systemRDL file to generate')
+CommandLineParser.add_argument('addrmap_name', type=str,
+                               help='Name of the top level address map')
+
 if __name__ == '__main__':
 
+    CommandLineArgs = CommandLineParser.parse_args()
+
     generator = PathologicalRDL()
-    generator.export_code(Path('deep.rdl'), addrmap_name='deep')
+    generator.export_code(CommandLineArgs.output_filename,
+                          addrmap_name=CommandLineArgs.addrmap_name)