Merge pull request #18 from edwin7026/testgen_filter

Testgen filter

Author: neelgala

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.4] - 2024-04-16
+- test generator filter for generate phase is added
+
 ## [1.4.3] - 2024-04-16
 - bug fixes; instruction count functionality added to self-checks
 

docs/source/installation.rst

@@ -219,6 +219,8 @@ Output for ``river_core generate --help``:
                           Auto detects
                           river_core.ini in current directory or in the ~
                           directory
+    --filter_testgen TEXT Pass sublist of test generators to use from the 
+                          ones given in the config INI file 
     -v, --verbosity TEXT  Set the verbosity level for the framework
     --version             Show the version and exit.
     --help                Show this message and exit.

river_core/__init__.py

@@ -4,4 +4,4 @@
 
 __author__ = """InCore Semiconductors"""
 __email__ = '[email protected]'
-__version__ = '1.4.3'
+__version__ = '1.5.0'

river_core/main.py

@@ -190,15 +190,20 @@ def compile(config, test_list, coverage, verbosity, dut_stage, ref_stage,
     help=
     'Read option defaults from the INI file\nAuto detects river_core.ini in current directory or in the ~ directory'
 )
+@click.option(
+    '--filter_testgen',
+    help=
+    'Override the test generators given by the config file'
+)
 @cli.command()
-def generate(config, verbosity):
+def generate(config, verbosity, filter_testgen):
     """
     subcommand to generate programs.
     """
     logger.info(constants.header_temp.format(__version__))
     if not config:
         config = check_config()
-    rivercore_generate(config, verbosity)
+    rivercore_generate(config, verbosity, filter_testgen)
 
 
 @click.version_option(version=__version__)

river_core/rivercore.py

@@ -274,7 +274,7 @@ def rivercore_clean(config_file, verbosity):
             logger.info(output_dir + ' directory deleted')
 
 
-def rivercore_generate(config_file, verbosity):
+def rivercore_generate(config_file, verbosity, filter_testgen):
     '''
         Function to generate the assembly programs using the plugin as configured in the config.ini.
 
@@ -312,8 +312,22 @@ def rivercore_generate(config_file, verbosity):
     logger.info("ISA : {0}".format(config['river_core']['isa']))
     test_list = {}
 
+    if filter_testgen:
+        filter_testgen = filter_testgen.rstrip().split(',')
+        # check if chosen test generators does not exist in the config[generator]
+        suite_list_set = set(suite_list)
+        filter_testgen_set = set(filter_testgen)
+        if not filter_testgen_set.issubset(suite_list_set):
+            logger.err("Test generator(s) passed does not exist in the config file")
+        suite_list = list(suite_list_set.intersection(filter_testgen_set))
+
     for suite in suite_list:
 
+        # for suite not in filter_testgen
+        if filter_testgen:
+            if suite not in filter_testgen:
+                continue
+
         # Give Plugin Info
         logger.info("Plugin Jobs : {0}".format(config[suite]['jobs']))
         logger.info("Plugin Seed : {0}".format(config[suite]['seed']))

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.4.3
+current_version = 1.5.0
 commit = True
 tag = True
 

setup.py

@@ -62,6 +62,6 @@ def read_requires():
     tests_require=test_requirements,
     url=
     'https://github.com/incoresemi/river_core',
-    version='1.4.3',
+    version='1.5.0',
     zip_safe=False,
 )