Updated CM diff report filename generation

Author: Kolea Plesco

ted_sws/mapping_suite_processor/entrypoints/cli/cmd_conceptual_mapping_differ.py

@@ -12,12 +12,11 @@
 from ted_sws.mapping_suite_processor.entrypoints.cli import CONCEPTUAL_MAPPINGS_FILE_TEMPLATE
 from ted_sws.mapping_suite_processor.services.conceptual_mapping_differ import \
     mapping_suite_diff_files_conceptual_mappings, mapping_suite_diff_repo_conceptual_mappings, \
-    generate_conceptual_mappings_diff_html_report
+    generate_conceptual_mappings_diff_html_report, generate_conceptual_mappings_diff_filename
 
 CMD_NAME = "CMD_CONCEPTUAL_MAPPING_DIFFER"
 
 DEFAULT_REPORT_OUTPUT_FOLDER = "."
-DEFAULT_REPORT_FILE_NAME = "conceptual_mappings_diff"
 
 """
 USAGE:
@@ -57,16 +56,22 @@ def _report(self, diff, files: list):
             "mapping_suite_ids": self.mapping_suite_ids,
             "files": files
         })
-        report_file_file_name_json = Path(self.output_folder) / (DEFAULT_REPORT_FILE_NAME + ".json")
+        diff_object = ConceptualMappingDiff(**diff)
+        filename_base = generate_conceptual_mappings_diff_filename(diff_object)
+        output_path: Path = Path(self.output_folder)
+
+        report_file_file_name_json = output_path / (filename_base + ".json")
         with open(report_file_file_name_json, 'w+') as report_file:
             report_file.write(json.dumps(diff, indent=2))
-        report_file_file_name_html = Path(self.output_folder) / (DEFAULT_REPORT_FILE_NAME + ".html")
+
+        report_file_file_name_html = output_path / (filename_base + ".html")
         with open(report_file_file_name_html, 'w+') as report_file:
-            report_file.write(
-                generate_conceptual_mappings_diff_html_report(
-                    ConceptualMappingDiff(**diff)
-                )
-            )
+            report_file.write(generate_conceptual_mappings_diff_html_report(diff_object))
+
+        self.log(
+            f"Generated {LOG_WARN_TEXT.format(report_file_file_name_json)}" +
+            f" and {LOG_WARN_TEXT.format(report_file_file_name_html)} report files" +
+            f" in \"{LOG_WARN_TEXT.format(self.output_folder)}\" folder.")
 
     @classmethod
     def _conceptual_mappings_file_path(cls, mappings_path, mapping_suite_id):

ted_sws/mapping_suite_processor/services/conceptual_mapping_differ.py

@@ -21,6 +21,8 @@
 GITHUB_CONCEPTUAL_MAPPINGS_PATH = "{GITHUB_BASE}/raw/{GIT_BRANCH}/mappings/{MAPPING_SUITE_ID}/" + \
                                   MS_TRANSFORM_FOLDER_NAME + "/" + MS_CONCEPTUAL_MAPPING_FILE_NAME
 
+DEFAULT_REPORT_FILE_NAME = "cm_diff"
+
 
 class ConceptualMappingDiffDataTransformer:
     data: dict
@@ -237,3 +239,19 @@ def generate_conceptual_mappings_diff_html_report(diff: ConceptualMappingDiff):
     )
     html_report = TEMPLATES.get_template(CONCEPTUAL_MAPPINGS_DIFF_HTML_REPORT_TEMPLATE).render(diff)
     return html_report
+
+
+def generate_conceptual_mappings_diff_filename(diff: ConceptualMappingDiff, prefix: str = DEFAULT_REPORT_FILE_NAME,
+                                               ext: str = None) -> str:
+    filename: str = prefix
+    cm1_metadata: dict = diff.metadata.metadata[0]
+    if cm1_metadata:
+        filename += f"_{cm1_metadata['identifier']}_v{cm1_metadata['mapping_version']}"
+    cm2_metadata: dict = diff.metadata.metadata[1]
+    if cm2_metadata:
+        if cm1_metadata:
+            filename += "_vs"
+        filename += f"_{cm2_metadata['identifier']}_v{cm2_metadata['mapping_version']}"
+    if ext:
+        filename += ext
+    return filename

tests/e2e/mapping_suite_processor/conceptual_mapping_differ/test_conceptual_mapping_differ.py

@@ -1,8 +1,9 @@
-from ted_sws.core.model.transform import ConceptualMapping, ConceptualMappingMetadata
+from ted_sws.core.model.transform import ConceptualMapping, ConceptualMappingMetadata, ConceptualMappingDiff
 from ted_sws.data_manager.adapters.mapping_suite_repository import MS_TRANSFORM_FOLDER_NAME, \
     MS_CONCEPTUAL_MAPPING_FILE_NAME
 from ted_sws.mapping_suite_processor.services.conceptual_mapping_differ import mapping_suite_diff_conceptual_mappings, \
-    mapping_suite_diff_files_conceptual_mappings, mapping_suite_diff_repo_conceptual_mappings
+    mapping_suite_diff_files_conceptual_mappings, mapping_suite_diff_repo_conceptual_mappings, \
+    generate_conceptual_mappings_diff_filename
 
 
 def test_mapping_suite_diff_conceptual_mappings():
@@ -53,3 +54,14 @@ def test_mapping_suite_diff_repo_conceptual_mappings(github_mapping_suite_id, pa
         mapping_suite_id=[github_mapping_suite_id, "package_F03_test"]
     )
     assert diff['data']['original']
+
+
+def test_generate_conceptual_mappings_diff_filename(package_folder_path, package_F03_folder_path):
+    """"""
+    filepath1 = package_folder_path / MS_TRANSFORM_FOLDER_NAME / MS_CONCEPTUAL_MAPPING_FILE_NAME
+    filepath2 = package_F03_folder_path / MS_TRANSFORM_FOLDER_NAME / MS_CONCEPTUAL_MAPPING_FILE_NAME
+
+    diff = mapping_suite_diff_files_conceptual_mappings([filepath1, filepath2])
+    filename = generate_conceptual_mappings_diff_filename(ConceptualMappingDiff(**diff), "conceptual_mappings_diff",
+                                                          ".json")
+    assert filename == "conceptual_mappings_diff_F03_v0.0.1_vs_package_F03_v2.2.0.json"