Generated schemas test that functionally addresses NREL#379

Author: softwareengineerprogrammer

src/geophires_x_schema_generator/main.py

@@ -5,19 +5,14 @@
 from geophires_x_schema_generator import GeophiresXSchemaGenerator
 from geophires_x_schema_generator import HipRaXSchemaGenerator
 
-if __name__ == '__main__':
-    parser = argparse.ArgumentParser()
-    parser.add_argument('--build-in-src', required=False, choices=[True, False], default=True)
-    parser.add_argument('--build-path', required=False)
-    args = parser.parse_args()
-    build_in_src = args.build_in_src
 
+def generate_schemas(build_in_src: bool, build_path: str | Path) -> None:
     build_dir = Path(Path(__file__).parent)
-    if not args.build_in_src:
+    if not build_in_src:
         build_dir = Path(Path(__file__).parent.parent.parent, 'build')
 
-    if args.build_path:
-        build_dir = Path(args.build_path)
+    if build_path:
+        build_dir = Path(build_path)
 
     build_dir.mkdir(exist_ok=True)
 
@@ -44,3 +39,13 @@ def build(json_file_name_prefix: str, generator: GeophiresXSchemaGenerator, rst_
 
     build('geophires-', GeophiresXSchemaGenerator(), 'parameters.rst')
     build('hip-ra-x-', HipRaXSchemaGenerator(), 'hip_ra_x_parameters.rst')
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--build-in-src', required=False, choices=[True, False], default=True)
+    parser.add_argument('--build-path', required=False)
+    args = parser.parse_args()
+    build_in_src_ = args.build_in_src
+    build_path_ = args.build_path if args.build_path else None
+    generate_schemas(build_in_src_, build_path_)

tests/geophires_x_schema_generator_tests/test_generated_schemas.py

@@ -0,0 +1,35 @@
+import json
+import tempfile
+from pathlib import Path
+
+from base_test_case import BaseTestCase
+from geophires_x_schema_generator.main import generate_schemas
+
+
+class GeneratedSchemasTestCase(BaseTestCase):
+
+    def test_generated_schemas_up_to_date(self) -> None:
+        try:
+            build_dir: Path = Path(tempfile.gettempdir())
+            generate_schemas(False, build_dir)
+
+            def assert_schema(schema_file_name: str) -> None:
+                with open(Path(build_dir, schema_file_name), encoding='utf-8') as f:
+                    generated_geophires_request_schema = json.loads(f.read())
+
+                src_geophires_request_path = Path(
+                    self._get_test_file_path(f'../../src/geophires_x_schema_generator/{schema_file_name}')
+                )
+                with open(src_geophires_request_path, encoding='utf-8') as f:
+                    src_geophires_request_schema = json.loads(f.read())
+
+                self.assertDictEqual(generated_geophires_request_schema, src_geophires_request_schema)
+
+            assert_schema('geophires-request.json')
+            assert_schema('geophires-result.json')
+            assert_schema('hip-ra-x-request.json')
+        except AssertionError as ae:
+            raise AssertionError(
+                'Generated schemas in source are not up-to-date. '
+                'Run src/geophires_x_schema_generator/main.py to update them.'
+            ) from ae