Add framework version tracking and update reports (#149)

Author: devanshjainms

VERSION

@@ -0,0 +1 @@
+1.0.0

docs/CHANGELOG.md

@@ -1,3 +1,16 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.
+
+
+## 1.0.0
+Release Date: 11-04-2025
+
+1. High Availability Functional Tests:
+   - Added comprehensive functional tests for High Availability (HA) configurations for SAP HANA Database with scale-up architecture.
+   - Added functional tests for HA configurations for SAP Central Services (ASCS) with Primary and Secondary nodes for ENSA1 and ENSA2 system types.
+   - Support for running HA functional tests for systems with new HANA topology - SAP HANA SR-angi.
+   - Offline Validation for HA configurations for SAP HANA Database and Central Services.
+2. Configuration Checks (preview release):
+   - Initial implementation of configuration checks for SAP systems.
+   - Support for validating SAP systems with HANA and IBM Db2 databases.

src/modules/render_html_report.py

@@ -53,6 +53,11 @@
             - Reports will be created in {workspace_directory}/quality_assurance/
         type: str
         required: true
+    framework_version:
+        description:
+            - Version of the SAP Automation QA framework
+        type: str
+        required: false
 author:
     - Microsoft Corporation
 notes:
@@ -71,6 +76,7 @@
     test_group_name: "hana_cluster_validation"
     report_template: "{{ lookup('file', 'templates/report_template.html') }}"
     workspace_directory: "/var/log/sap-automation-qa"
+    framework_version: "1.0.0"
   register: report_result
 
 - name: Show path to generated report
@@ -115,6 +121,7 @@ def __init__(
         workspace_directory: str,
         test_case_results: List[Dict[str, Any]] = [],
         system_info: Dict[str, Any] = {},
+        framework_version: str = "unknown",
     ):
         super().__init__()
         self.test_group_invocation_id = test_group_invocation_id
@@ -128,6 +135,7 @@ def __init__(
         )
         self.test_case_results = test_case_results or []
         self.system_info = system_info or {}
+        self.framework_version = framework_version
 
     def read_log_file(self) -> List[Dict[str, Any]]:
         """
@@ -184,6 +192,7 @@ def render_report(self, test_case_results: List[Dict[str, Any]]) -> None:
                                 "%m/%d/%Y, %I:%M:%S %p"
                             ),
                             "system_info": self.system_info,
+                            "framework_version": self.framework_version,
                         }
                     )
                 )
@@ -205,6 +214,7 @@ def run_module() -> None:
         workspace_directory=dict(type="str", required=True),
         test_case_results=dict(type="list", required=False),
         system_info=dict(type="dict", required=False),
+        framework_version=dict(type="str", required=False),
     )
 
     module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
@@ -216,6 +226,7 @@ def run_module() -> None:
         workspace_directory=module.params["workspace_directory"],
         test_case_results=module.params.get("test_case_results", []),
         system_info=module.params.get("system_info", {}),
+        framework_version=module.params.get("framework_version", "unknown"),
     )
 
     test_case_results = (

src/roles/misc/tasks/render-html-report.yml

@@ -14,6 +14,11 @@
       ansible.builtin.set_fact:
         html_report_template:           "{{ lookup('file', html_template_name | default('./templates/report.html')) }}"
 
+    - name:                             "Get framework version"
+      no_log:                           true
+      ansible.builtin.set_fact:
+        framework_version:              "{{ lookup('file', '../../../../VERSION') | default('unknown') }}"
+
     - name:                             "Read the log file and create a HTML report"
       render_html_report:
         test_group_invocation_id:       "{{ test_group_invocation_id }}"
@@ -22,4 +27,5 @@
         workspace_directory:            "{{ _workspace_directory }}"
         test_case_results:              "{{ all_results | default([]) }}"
         system_info:                    "{{ system_info | default({}) }}"
+        framework_version:              "{{ framework_version | default('unknown') }}"
       register:                         report_file_path

src/templates/config_checks_report.html

@@ -1391,7 +1391,7 @@ <h4 class="section-header" onclick="toggleSection('section-{{ check.hostname }}-
       </div>
     </div>
   </div>
-  <div class="footer">Report generated on: {{ report_generation_time }}</div>
+  <div class="footer">Report generated on: {{ report_generation_time }} with framework version: {{ framework_version }}</div>
   <script>
     function toggleDetails(checkId) {
       const detailsRow = document.getElementById('details-' + checkId)

src/templates/report.html

@@ -432,7 +432,7 @@ <h2 class="system-info-heading">System Information</h2>
         </div>
       </div>
     </div>
-    <div class="footer">Report generated on: {{ report_generation_time }}</div>
+    <div class="footer">Report generated on: {{ report_generation_time }} with framework version: {{ framework_version }}</div>
     <script>
       // Function to beautify JSON objects
       function formatJsonObjects() {

tests/modules/render_html_report_test.py

@@ -27,6 +27,7 @@ def module_params(self):
             "test_group_name": "test_group",
             "report_template": "report_template.html",
             "workspace_directory": "/tmp",
+            "framework_version": "1.0.0",
         }
 
     @pytest.fixture
@@ -44,6 +45,7 @@ def html_report_renderer(self, module_params):
             module_params["test_group_name"],
             module_params["report_template"],
             module_params["workspace_directory"],
+            module_params["framework_version"],
         )
 
     def test_render_report(self, mocker, html_report_renderer):
@@ -115,6 +117,7 @@ def __init__(self, argument_spec, supports_check_mode):
                     "test_group_name": "test_group",
                     "report_template": "report_template.html",
                     "workspace_directory": "/tmp",
+                    "framework_version": "1.0.0",
                 }
                 self.check_mode = False