Refine changelog entries and enhance reporting by adding framework version retrieval

Author: devanshjainms

docs/CHANGELOG.md

@@ -13,4 +13,4 @@ Release Date: 11-04-2025
    - 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/DB2 database types.
+   - Support for validating SAP systems with HANA and IBM Db2 databases.

scripts/sap_automation_qa.sh

@@ -348,15 +348,13 @@ retrieve_secret_from_key_vault() {
 # :param system_params: The path to the SAP parameters file.
 # :param auth_type: The authentication type (e.g., "SSHKEY", "VMPASSWORD").
 # :param system_config_folder: The path to the system configuration folder.
-# :param framework_version: The framework version from VERSION file.
 # :return: None. Exits with the return code of the ansible-playbook command.
 run_ansible_playbook() {
     local playbook_name=$1
     local system_hosts=$2
     local system_params=$3
     local auth_type=$4
     local system_config_folder=$5
-    local framework_version=$6
 
     local extra_vars=""
     if [[ -n "$TEST_GROUPS" || -n "$TEST_CASES" ]]; then
@@ -380,7 +378,7 @@ run_ansible_playbook() {
         log "INFO" "Offline mode: Skipping SSH authentication setup"
         command="ansible-playbook ${cmd_dir}/../src/$playbook_name.yml -i $system_hosts \
             -e @$VARS_FILE -e @$system_params -e '_workspace_directory=$system_config_folder' \
-            -e \"framework_version=$framework_version\" $extra_vars --connection=local"
+            -e $extra_vars --connection=local"
     else
         # Set local secret_id and key_vault_id if defined
         local secret_id=$(grep "^secret_id:" "$system_params" | awk '{split($0,a,": "); print a[2]}' | xargs || true)
@@ -405,7 +403,7 @@ run_ansible_playbook() {
                     "Temporary SSH key file not found. Please check the Key Vault secret ID."
                 command="ansible-playbook ${cmd_dir}/../src/$playbook_name.yml -i $system_hosts --private-key $temp_file \
                     -e @$VARS_FILE -e @$system_params -e '_workspace_directory=$system_config_folder' \
-                    -e \"framework_version=$framework_version\" $extra_vars"
+                    -e $extra_vars"
             else
                 local ssh_key_dir="${cmd_dir}/../WORKSPACES/SYSTEM/$SYSTEM_CONFIG_NAME"
                 local ssh_key=""
@@ -438,7 +436,7 @@ run_ansible_playbook() {
                 chmod 600 "$ssh_key"
                 command="ansible-playbook ${cmd_dir}/../src/$playbook_name.yml -i $system_hosts --private-key $ssh_key \
                     -e @$VARS_FILE -e @$system_params -e '_workspace_directory=$system_config_folder' \
-                    -e \"framework_version=$framework_version\" $extra_vars"
+                    -e $extra_vars"
             fi
 
         elif [[ "$auth_type" == "VMPASSWORD" ]]; then
@@ -452,14 +450,14 @@ run_ansible_playbook() {
                     "Temporary password file not found. Please check the Key Vault secret ID."
                 command="ansible-playbook ${cmd_dir}/../src/$playbook_name.yml -i $system_hosts \
                     --extra-vars 'ansible_ssh_pass=$(cat $temp_file)' --extra-vars @$VARS_FILE -e @$system_params \
-                    -e '_workspace_directory=$system_config_folder' -e \"framework_version=$framework_version\" $extra_vars"
+                    -e '_workspace_directory=$system_config_folder' -e $extra_vars"
             else
                 local password_file="${cmd_dir}/../WORKSPACES/SYSTEM/$SYSTEM_CONFIG_NAME/password"
                 check_file_exists "$password_file" \
                     "password file not found in WORKSPACES/SYSTEM/$SYSTEM_CONFIG_NAME directory."
                 command="ansible-playbook ${cmd_dir}/../src/$playbook_name.yml -i $system_hosts \
                     --extra-vars 'ansible_ssh_pass=$(cat $password_file)' --extra-vars @$VARS_FILE -e @$system_params \
-                    -e '_workspace_directory=$system_config_folder' -e \"framework_version=$framework_version\" $extra_vars"
+                    -e '_workspace_directory=$system_config_folder' -e $extra_vars"
             fi
 
         else
@@ -547,9 +545,7 @@ main() {
     playbook_name=$(get_playbook_name "$TEST_TYPE" "$SAP_FUNCTIONAL_TEST_TYPE" "$OFFLINE_MODE")
     log "INFO" "Using playbook: $playbook_name."
 
-    FRAMEWORK_VERSION=$(read_version_file)
-    log "INFO" "Framework version: $FRAMEWORK_VERSION"
-    run_ansible_playbook "$playbook_name" "$SYSTEM_HOSTS" "$SYSTEM_PARAMS" "$AUTHENTICATION_TYPE" "$SYSTEM_CONFIG_FOLDER" "$FRAMEWORK_VERSION"
+    run_ansible_playbook "$playbook_name" "$SYSTEM_HOSTS" "$SYSTEM_PARAMS" "$AUTHENTICATION_TYPE" "$SYSTEM_CONFIG_FOLDER"
 
 }
 

scripts/utils.sh

@@ -233,26 +233,3 @@ install_packages() {
         log "INFO" "All required packages are already installed."
     fi
 }
-
-
-# Function to read VERSION file
-# Looks for VERSION file in the project root directory
-# :return: The version string from the VERSION file
-read_version_file() {
-    local script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-    local project_root="$(cd "$script_dir/.." && pwd)"
-    local version_file="$project_root/VERSION"
-    
-    if [[ -f "$version_file" ]]; then
-        local version
-        version=$(<"$version_file")
-        version=$(echo "$version" | tr -d '[:space:]')
-        if [[ -z "$version" ]]; then
-            log "ERROR" "VERSION file is empty at: $version_file"
-        fi
-        echo "$version"
-    else
-        log "ERROR" "VERSION file not found at: $version_file"
-        exit 1
-    fi
-}

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 }}"