reorder readme, fix tests (#1518)

* reorder readme, fix tests

* merged to one test command

* Restore readme.md to match main

* spell mistake

Author: SFJohnson24

.github/workflows/build-binary.yml

@@ -46,21 +46,29 @@ jobs:
             if ./core --help; then echo "test passed"; else echo "test failed"; exit 1; fi
           fi
         shell: bash
-      - name: Test Binary test-validate command
+      - name: Test Binary test-validate commands
         run: |
           cd dist/output/${{ inputs.name }}/core
           if [ "${{ runner.os }}" = "Windows" ]; then
-            ./core.exe test-validate
+            ./core.exe test-validate json
+            json_exit=$?
+            ./core.exe test-validate xpt
+            xpt_exit=$?
           else
             chmod +x core
             chmod -R 755 .
             chmod -R +r resources/
-            ./core test-validate
+            ./core test-validate json
+            json_exit=$?
+            ./core test-validate xpt
+            xpt_exit=$?
           fi
-          exit_code=$?
-          if [ $exit_code -eq 0 ]; then
-            echo "Test validate succeeded"
+
+          if [ $json_exit -eq 0 ] && [ $xpt_exit -eq 0 ]; then
+            echo "All validation tests succeeded"
+            exit 0
           else
-            echo "Test validate failed with exit code $exit_code"
+            echo "Validation tests failed (JSON: $json_exit, XPT: $xpt_exit)"
+            exit 1
           fi
         shell: bash

README.md

@@ -47,7 +47,7 @@ Once downloaded, simply unzip the file and run the following command based on yo
 
 ## Command-line Interface
 
-**Note**: the following examples are applicable to the source code and have references to "`python core.py`". When using the executable version as described in the [Quick Start](#quick-start) above, instances of "`python cored.py`" should be replaced with "`.\core.exe`" (Windows) or "`./core`" (Linux/Mac). You can also run directly on the source code by following the [Cloning](#cloning) instructions.
+**Note**: the following examples are applicable to the source code and have references to "`python core.py`". When using the executable version as described in the [Quick Start](#quick-start) above, instances of "`python core.py`" should be replaced with "`.\core.exe`" (Windows) or "`./core`" (Linux/Mac). You can also run directly on the source code by following the [Cloning](#cloning) instructions.
 
 ### Running a validation (`validate`)
 

core.py

@@ -787,7 +787,8 @@ def list_ct(cache_path: str, subsets: tuple[str]):
 
 
 @click.command()
-def test_validate():
+@click.argument("filetype", type=click.Choice(["json", "xpt"], case_sensitive=False))
+def test_validate(filetype):
     """**Release Test** validate command for executable."""
     try:
         import sys
@@ -802,102 +803,61 @@ def test_validate():
         )
 
         base_path = os.path.join("tests", "resources", "datasets")
-        ts_path = os.path.join(base_path, "TS.json")
-        ae_path = os.path.join(base_path, "ae.xpt")
-        if not all(os.path.exists(path) for path in [ts_path, ae_path]):
-            raise FileNotFoundError(
-                "Test datasets not found in tests/resources/datasets"
-            )
+        if filetype.lower() == "json":
+            test_file = os.path.join(base_path, "TS.json")
+            output_name = "json_validation_output"
+        else:
+            test_file = os.path.join(base_path, "ae.xpt")
+            output_name = "xpt_validation_output"
+        if not os.path.exists(test_file):
+            raise FileNotFoundError(f"Test dataset not found: {test_file}")
+        cache_path = DEFAULT_CACHE_PATH
+        pool_size = 10
+        log_level = "disabled"
+        standard = "sdtmig"
+        version = "3.4"
+        output_format = {ReportTypes.XLSX.value}
+        external_dictionaries = ExternalDictionariesContainer({})
+        progress = ProgressParameterOptions.BAR.value
+        max_report_errors = (0, False)
 
         with tempfile.TemporaryDirectory() as temp_dir:
-            cache_path = DEFAULT_CACHE_PATH
-            pool_size = 10
-            log_level = "disabled"
-            report_template = None
-            standard = "sdtmig"
-            version = "3.4"
-            substandard = None
-            controlled_terminology_package = set()
-            json_output = os.path.join(temp_dir, "json_validation_output")
-            xpt_output = os.path.join(temp_dir, "xpt_validation_output")
-            output_format = {ReportTypes.XLSX.value}
-            raw_report = False
-            define_version = None
-            external_dictionaries = ExternalDictionariesContainer({})
-            rules = []
-            exclude_rules = []
-            local_rules = None
-            custom_standard = False
-            progress = ProgressParameterOptions.BAR.value
-            define_xml_path = None
-            validate_xml = False
-            max_report_rows = None
-            max_report_errors = (0, False)
-            json_output = os.path.join(temp_dir, "json_validation_output")
-            jsonata_custom_functions = ()
-            run_validation(
-                Validation_args(
-                    cache_path,
-                    pool_size,
-                    [ts_path],
-                    log_level,
-                    report_template,
-                    standard,
-                    version,
-                    substandard,
-                    controlled_terminology_package,
-                    json_output,
-                    output_format,
-                    raw_report,
-                    define_version,
-                    external_dictionaries,
-                    rules,
-                    exclude_rules,
-                    local_rules,
-                    custom_standard,
-                    progress,
-                    define_xml_path,
-                    validate_xml,
-                    jsonata_custom_functions,
-                    max_report_rows,
-                    max_report_errors,
-                )
-            )
-            print("JSON validation completed successfully!")
-            xpt_output = os.path.join(temp_dir, "xpt_validation_output")
+            output = os.path.join(temp_dir, output_name)
             run_validation(
                 Validation_args(
                     cache_path,
                     pool_size,
-                    [ae_path],
+                    [test_file],
                     log_level,
-                    report_template,
+                    None,
                     standard,
                     version,
-                    substandard,
-                    controlled_terminology_package,
-                    xpt_output,
+                    None,
+                    set(),
+                    output,
                     output_format,
-                    raw_report,
-                    define_version,
+                    False,
+                    None,
                     external_dictionaries,
-                    rules,
-                    exclude_rules,
-                    local_rules,
-                    custom_standard,
+                    [],
+                    [],
+                    None,
+                    False,
                     progress,
-                    define_xml_path,
-                    validate_xml,
-                    jsonata_custom_functions,
-                    max_report_rows,
+                    None,
+                    False,
+                    (),
+                    None,
                     max_report_errors,
                 )
             )
-            print("XPT validation completed successfully!")
-        print("All validation tests completed successfully!")
+            print(f"{filetype.upper()} validation completed successfully!")
         sys.exit(0)
     except Exception as e:
-        print(f"Validation test failed: {str(e)}")
+        import traceback
+
+        print(f"{filetype.upper()} validation test failed: {str(e)}")
+        print(traceback.format_exc())
         sys.exit(1)
 
 

scripts/run_validation.py

@@ -128,6 +128,7 @@ def run_validation(args: Validation_args):
     CacheManager.register("InMemoryCacheService", InMemoryCacheService)
     manager = CacheManager()
     manager.start()
+    created_files = []
     try:
         shared_cache = get_cache_service(manager)
         engine_logger.info(f"Populating cache, cache path: {args.cache}")
@@ -156,7 +157,6 @@ def run_validation(args: Validation_args):
             data_service.dataset_implementation != PandasDataset
         )
         datasets = data_service.get_datasets()
-        created_files = []
         if large_dataset_validation and data_service.standard != "usdm":
             # convert all files to parquet temp files
             engine_logger.warning(