Add mock data and scripts for HA SCS role testing

Author: devanshjainms

tests/roles/__init__.py renamed to tests/roles/ha_scs/__init__.py

@@ -12,7 +12,7 @@
 import shutil
 from pathlib import Path
 import pytest
-from tests.roles.roles_testing_base import RolesTestingBase
+from tests.roles.ha_scs.roles_testing_base import RolesTestingBase
 
 
 class TestASCSMigration(RolesTestingBase):

tests/roles/ascs_migration_test.py renamed to tests/roles/ha_scs/ascs_migration_test.py

@@ -12,7 +12,7 @@
 import shutil
 from pathlib import Path
 import pytest
-from tests.roles.roles_testing_base import RolesTestingBase
+from tests.roles.ha_scs.roles_testing_base import RolesTestingBase
 
 
 class TestASCSNodeCrash(RolesTestingBase):

tests/roles/ascs_node_crash_test.py renamed to tests/roles/ha_scs/ascs_node_crash_test.py

@@ -0,0 +1,127 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+"""
+Test class for ASCS HA config validation tasks
+
+This test class uses pytest to run functional tests on the ASCS HA config validation tasks
+defined in roles/ha_scs/tasks/ha-config.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_scs.roles_testing_base import RolesTestingBase
+
+
+class TestASCSHaConfigValidation(RolesTestingBase):
+    """
+    Test class for ASCS HA config validation tasks.
+    """
+
+    @pytest.fixture
+    def ascs_migration_tasks(self):
+        """
+        Load the ASCS HA config validation tasks from the YAML file.
+
+        :return: Parsed YAML content of the tasks file.
+        :rtype: dict
+        """
+        return self.file_operations(
+            operation="read",
+            file_path=Path(__file__).parent.parent.parent / "src/roles/ha_scs/tasks/ha-config.yml",
+        )
+
+    @pytest.fixture
+    def test_environment(self, ansible_inventory):
+        """
+        Set up a temporary test environment for the ASCS HA config 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(
+            ansible_inventory=ansible_inventory,
+            task_name="ha-config",
+            task_description="The ASCS HA config validation test validates the SCS/ERS cluster "
+            + "configuration and other system configuration",
+            module_names=[
+                "project/library/get_pcmk_properties_scs",
+                "project/library/log_parser",
+                "project/library/send_telemetry_data",
+                "bin/crm_resource",
+                "bin/crm",
+            ],
+        )
+
+        os.makedirs(f"{temp_dir}/project/roles/ha_scs/tasks/files", exist_ok=True)
+        self.file_operations(
+            operation="write",
+            file_path=f"{temp_dir}/project/roles/ha_scs/tasks/files/constants.yaml",
+            content=self.file_operations(
+                operation="read",
+                file_path=Path(__file__).parent / "mock_data/cluster_config.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 / "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 ASCS migration 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,
+        )
+
+        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 "Virtual Machine name" in task:
+                assert task_result.get("changed") is False
+            if "HA Configuration check" in task:
+                assert task_result.get("changed") is False
+                assert (
+                    task_result["details"].get("parameters", {})[1].get("name")
+                    == "migration-threshold"
+                )
+                assert task_result["details"].get("parameters", {})[1].get("value") == "3"

tests/roles/ha_scs/ha_config_test.py

@@ -0,0 +1,37 @@
+#!/usr/bin/python3
+from ansible.module_utils.basic import AnsibleModule
+import json
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            url=dict(type='str', required=True),
+            use_proxy=dict(type='bool', required=False),
+            headers=dict(type='dict', required=False)
+        )
+    )
+
+    # Check if this is the Azure metadata request
+    if "169.254.169.254/metadata/instance" in module.params['url']:
+        result = {
+            "changed": False,
+            "json": {
+                "compute": {
+                    "name": "scs01",
+                    "vmId": "12345678-1234-1234-1234-123456789012",
+                    "location": "eastus"
+                }
+            },
+            "status": 200
+        }
+    else:
+        result = {
+            "changed": False,
+            "status": 404,
+            "msg": "URL not mocked"
+        }
+
+    module.exit_json(**result)
+
+if __name__ == '__main__':
+    main()

tests/roles/ha_scs/mock_data/azure_metadata.txt

@@ -0,0 +1,15 @@
+CRM_CONFIG_DEFAULTS:
+  cluster-infrastructure:             corosync
+  priority-fencing-delay:             '30'
+  stonith-action:                     reboot
+  stonith-enabled:                    'false'
+  concurrent-fencing:                 'true'
+  maintenance-mode:                   'false'
+  node-health-strategy:               'custom'
+  azure-events-az_globalPullState:    'IDLE'
+
+RSC_DEFAULTS:
+  migration-threshold:                '3'
+  priority:                           '1'
+  resource-stickiness:                '1'
+