Add mock scripts for various commands and enhance Azure Load Balancer metadata handling

Author: devanshjainms

src/roles/ha_db_hana/tasks/fs-freeze.yml

@@ -51,7 +51,7 @@
           changed_when:                 cleanup_failed_resource_post.rc == 0
           ignore_errors:                true
 
-        - name:                         "Test Execution: Validate HANA DB cluster status"
+        - name:                         "Test Execution: Validate HANA DB cluster status 1"
           when:                         cluster_status_pre.AUTOMATED_REGISTER | lower == "true"
           get_cluster_status_db:
             operation_step:             "test_execution"
@@ -67,7 +67,7 @@
     - name:                             "Test Execution: Freeze File System on Primary Node init"
       when:                             ansible_hostname == cluster_status_pre.primary_node
       block:
-        - name:                         "Test Execution: Validate HANA DB cluster status"
+        - name:                         "Test Execution: Validate HANA DB cluster status 2"
           get_cluster_status_db:
             operation_step:             "post_failover"
             database_sid:               "{{ db_sid | lower }}"

src/roles/ha_db_hana/tasks/sbd-fencing.yml

@@ -69,7 +69,7 @@
     - name:                             "Test Execution: SBD Inquisitor kill manual fail over"
       when:                             ansible_hostname == cluster_status_pre.primary_node
       block:
-        - name:                         "Test Execution: Validate HANA DB cluster status"
+        - name:                         "Test Execution: Validate HANA DB cluster status 2"
           get_cluster_status_db:
             operation_step:             "test_execution"
             database_sid:               "{{ db_sid | lower }}"

src/roles/ha_db_hana/tasks/secondary-crash-index.yml

@@ -64,7 +64,7 @@
                                         cluster_status_test_execution.primary_node == cluster_status_pre.primary_node and
                                         cluster_status_test_execution.secondary_node == ""
 
-        - name:                         "Test Execution: Validate HANA DB cluster status"
+        - name:                         "Test Execution: Validate HANA DB cluster status 2"
           get_cluster_status_db:
             operation_step:             "post_failover"
             database_sid:               "{{ db_sid | lower }}"

src/roles/ha_db_hana/tasks/secondary-echo-b.yml

@@ -59,7 +59,7 @@
                                         cluster_status_test_execution.primary_node == cluster_status_pre.primary_node and
                                         cluster_status_test_execution.secondary_node == ""
 
-        - name:                         "Test Execution: Validate HANA DB cluster status"
+        - name:                         "Test Execution: Validate HANA DB cluster status 2"
           get_cluster_status_db:
             operation_step:             "post_failover"
             database_sid:               "{{ db_sid | lower }}"

tests/roles/ha_db_hana/az_lb_test.py

@@ -0,0 +1,112 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+"""
+Test class for Azure LB configuration validation tasks.
+
+This test class uses pytest to run functional tests on the Azure LB configuration validation tasks
+defined in roles/ha_db_hana/tasks/azure-lb.yml. It sets up a temporary test environment,
+mocks necessary Python modules and commands, and verifies the execution of the tasks.
+"""
+
+import os
+import shutil
+from pathlib import Path
+import pytest
+from tests.roles.ha_db_hana.roles_testing_base_db import RolesTestingBaseDB
+
+
+class TestAzLBConfigValidation(RolesTestingBaseDB):
+    """
+    Test class for Azure LB configuration validation tasks.
+    """
+
+    @pytest.fixture
+    def test_environment(self, ansible_inventory):
+        """
+        Set up a temporary test environment for the Azure LB configuration validation tasks.
+
+        :param ansible_inventory: Path to the Ansible inventory file.
+        :type ansible_inventory: str
+        :yield temp_dir: Path to the temporary test environment.
+        :ytype: str
+        """
+
+        temp_dir = self.setup_test_environment(
+            role_type="ha_db_hana",
+            ansible_inventory=ansible_inventory,
+            task_name="azure-lb",
+            task_description="The test validates the Azure load balancer configuration.",
+            module_names=[
+                "project/library/get_azure_lb",
+                "project/library/log_parser",
+                "project/library/send_telemetry_data",
+                "project/library/get_package_list",
+                "bin/crm_resource",
+            ],
+            extra_vars_override={"node_tier": "hana"},
+        )
+
+        os.makedirs(f"{temp_dir}/project/roles/ha_db_hana/tasks/files", exist_ok=True)
+        self.file_operations(
+            operation="write",
+            file_path=f"{temp_dir}/project/roles/ha_db_hana/tasks/files/constants.yaml",
+            content=self.file_operations(
+                operation="read",
+                file_path=Path(__file__).parent.parent / "mock_data/mock_azure_lb.txt",
+            ),
+        )
+
+        os.makedirs(f"{temp_dir}/project/library", exist_ok=True)
+        self.file_operations(
+            operation="write",
+            file_path=f"{temp_dir}/project/library/uri",
+            content=self.file_operations(
+                operation="read",
+                file_path=Path(__file__).parent.parent / "mock_data/azure_metadata.txt",
+            ),
+        )
+        os.chmod(f"{temp_dir}/project/library/uri", 0o755)
+
+        yield temp_dir
+        shutil.rmtree(temp_dir)
+
+    def test_ha_config_validation_success(self, test_environment, ansible_inventory):
+        """
+        Test the Azure LB configuration validation tasks using Ansible Runner.
+
+        :param test_environment: Path to the temporary test environment.
+        :type test_environment: str
+        :param ansible_inventory: Path to the Ansible inventory file.
+        :type ansible_inventory: str
+        """
+        result = self.run_ansible_playbook(
+            test_environment=test_environment, inventory_file_name="inventory_db.txt"
+        )
+
+        assert result.rc == 0, (
+            f"Playbook failed with status: {result.rc}\n"
+            f"STDOUT: {result.stdout.read() if result.stdout else 'No output'}\n"
+            f"STDERR: {result.stderr.read() if result.stderr else 'No errors'}\n"
+            f"Events: {[e.get('event') for e in result.events if 'event' in e]}"
+        )
+
+        ok_events, failed_events = [], []
+        for event in result.events:
+            if event.get("event") == "runner_on_ok":
+                ok_events.append(event)
+            elif event.get("event") == "runner_on_failed":
+                failed_events.append(event)
+
+        assert len(ok_events) > 0
+        assert len(failed_events) == 0
+
+        for event in ok_events:
+            task = event.get("event_data", {}).get("task")
+            task_result = event.get("event_data", {}).get("res")
+            if "Retrieve Subscription ID" in task:
+                assert task_result.get("changed") is False
+            if "Azure Load Balancer check" in task:
+                assert task_result.get("changed") is False
+                assert task_result["details"]["parameters"][1].get("name") == "probe_threshold"
+                assert task_result["details"]["parameters"][1].get("value") == "2"

tests/roles/ha_db_hana/primary_node_ops_test.py

@@ -23,7 +23,14 @@ class TestDbHDBOperations(RolesTestingBaseDB):
     """
 
     @pytest.fixture(
-        params=["primary-node-crash", "primary-node-kill", "primary-echo-b", "primary-crash-index"]
+        params=[
+            "primary-node-crash",
+            "primary-node-kill",
+            "primary-echo-b",
+            "primary-crash-index",
+            "sbd-fencing",
+            "fs-freeze",
+        ]
     )
     def task_type(self, request):
         """
@@ -64,6 +71,19 @@ def task_type(self, request):
                 "command_type": "killall",
                 "validate_task": "Test Execution: Validate HANA DB cluster status",
             }
+        elif task_name == "sbd-fencing":
+            return {
+                "task_name": task_name,
+                "command_task": "Test Execution: Kill the inquisitor process",
+                "command_type": "kill",
+                "validate_task": "Test Execution: Validate HANA DB cluster status 2",
+            }
+        elif task_name == "fs-freeze":
+            return {
+                "task_name": task_name,
+                "validate_task": "Test Execution: Validate HANA DB cluster status 2",
+                "command_task": "dummy (no command)",
+            }
 
     @pytest.fixture
     def test_environment(self, ansible_inventory, task_type):
@@ -82,23 +102,33 @@ def test_environment(self, ansible_inventory, task_type):
         if os.path.exists(task_counter_file):
             os.remove(task_counter_file)
 
+        module_names = [
+            "project/library/get_cluster_status_db",
+            "project/library/log_parser",
+            "project/library/send_telemetry_data",
+            "project/library/location_constraints",
+            "project/library/check_indexserver",
+            "project/library/filesystem_freeze",
+            "bin/crm_resource",
+            "bin/crm",
+            "bin/echo",
+            "bin/killall",
+        ]
+
+        if task_type["task_name"] == "sbd-fencing":
+            module_names.extend(["bin/pgrep", "bin/kill", "bin/head"])
+
         temp_dir = self.setup_test_environment(
             role_type="ha_db_hana",
             ansible_inventory=ansible_inventory,
             task_name=task_type["task_name"],
             task_description=f"The {task_type['task_name']} test validates failover scenarios",
-            module_names=[
-                "project/library/get_cluster_status_db",
-                "project/library/log_parser",
-                "project/library/send_telemetry_data",
-                "project/library/location_constraints",
-                "project/library/check_indexserver",
-                "bin/crm_resource",
-                "bin/crm",
-                "bin/echo",
-                "bin/killall",
-            ],
-            extra_vars_override={"node_tier": "hana"},
+            module_names=module_names,
+            extra_vars_override={
+                "node_tier": "hana",
+                "NFS_provider": "ANF",
+                "database_cluster_type": "ISCSI",
+            },
         )
 
         os.makedirs(f"{temp_dir}/bin", exist_ok=True)
@@ -119,7 +149,7 @@ def test_environment(self, ansible_inventory, task_type):
         self.file_operations(
             operation="write",
             file_path=f"{temp_dir}/project/roles/ha_db_hana/tasks/{task_type['task_name']}.yml",
-            content=playbook_content.replace(
+            content=playbook_content.replace("set -o pipefail\n", "").replace(
                 "/usr/sap/{{ db_sid | upper }}/HDB{{ db_instance_number }}/", ""
             ),
         )
@@ -170,8 +200,8 @@ def test_functional_db_primary_node_success(
             task = event.get("event_data", {}).get("task")
             task_result = event.get("event_data", {}).get("res")
 
-            if task and task_type["command_task"] in task:
-                if task_type["command_type"] == "echo b":
+            if task and task_type.get("command_task") in task:
+                if task_type["command_type"] == "echo b" or task_type["command_type"] == "kill":
                     assert task_result.get("changed") is True
                 else:
                     assert task_result.get("rc") == 0