Block network test (#14)

* Add functional tests for HANA DB block network and update task names

* Add mock sleep command script for testing purposes

Co-Authored-by: Dhruv Aggarwal <[email protected]>

* Fix typo in docstring and clean up conditional checks in block network test

---------

Co-authored-by: devanshjain <[email protected]>
Co-authored-by: hdamecharla <[email protected]>

Author: 3 people

src/roles/ha_db_hana/tasks/block-network.yml

@@ -116,7 +116,7 @@
           ansible.builtin.wait_for:
             timeout:                        60
 
-        - 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 }}"
@@ -150,7 +150,7 @@
           ansible.builtin.wait_for:
             timeout:                        60
 
-        - 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 }}"

tests/roles/ha_db_hana/block_network_test.py

@@ -0,0 +1,140 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+"""
+Test class for HANA DB block network between primary and secondary nodes.
+
+This test class uses pytest to run functional tests on the HANA DB block-network
+tasks defined in roles/ha_db_hana/tasks/block-network.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 TestBlockNetworkTest(RolesTestingBaseDB):
+    """
+    Test class for HANA DB block network between primary and secondary nodes.
+    """
+
+    @pytest.fixture
+    def test_environment(self, ansible_inventory):
+        """
+        Set up a temporary test environment for the HANA DB block-network test
+
+        :param ansible_inventory: Path to the Ansible inventory file.
+        :type ansible_inventory: str
+        :param task_type: Dictionary with task configuration details.
+        :type task_type: dict
+        :yield temp_dir: Path to the temporary test environment.
+        :type: str
+        """
+
+        task_counter_file = "/tmp/get_cluster_status_counter_block-network"
+        if os.path.exists(task_counter_file):
+            os.remove(task_counter_file)
+
+        if os.path.exists("/tmp/ping_counter_block-network"):
+            os.remove("/tmp/ping_counter_block-network")
+
+        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/iptables",
+            "bin/ping",
+            "bin/echo",
+            "bin/sleep",
+        ]
+
+        temp_dir = self.setup_test_environment(
+            role_type="ha_db_hana",
+            ansible_inventory=ansible_inventory,
+            task_name="block-network",
+            task_description="The block network test validates failover scenarios",
+            module_names=module_names,
+            extra_vars_override={
+                "node_tier": "hana",
+                "NFS_provider": "ANF",
+                "database_cluster_type": "ISCSI",
+            },
+        )
+
+        playbook_content = self.file_operations(
+            operation="read",
+            file_path=f"{temp_dir}/project/roles/ha_db_hana/tasks/block-network.yml",
+        )
+        self.file_operations(
+            operation="write",
+            file_path=f"{temp_dir}/project/roles/ha_db_hana/tasks/block-network.yml",
+            content=playbook_content.replace(
+                "for i in $(seq 1 20); do",
+                "for i in {1..20}; do",
+            ),
+        )
+
+        yield temp_dir
+        shutil.rmtree(temp_dir)
+
+    def test_functional_db_primary_node_success(self, test_environment, ansible_inventory):
+        """
+        Test the HANA DB block network between primary and secondary nodes.
+        This test verifies the successful execution of the block network task and checks
+
+        :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",
+            task_type="block-network",
+        )
+
+        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
+        # There will be 1 failed event, connection failure to primary node
+        # This is the behavior be have mocked in the ping functionality
+        assert len(failed_events) == 1
+
+        post_status = {}
+        pre_status = {}
+
+        for event in ok_events:
+            task = event.get("event_data", {}).get("task")
+            task_result = event.get("event_data", {}).get("res")
+
+            if task and "Create a firewall" in task:
+                assert task_result.get("rc") == 0
+            elif task and "Pre Validation: Validate HANA DB" in task:
+                pre_status = task_result
+            elif task and "Test Execution: Validate HANA DB cluster status 2" in task:
+                post_status = task_result
+            elif task and "Remove any location_constraints" in task:
+                assert task_result.get("changed")
+
+        assert post_status.get("primary_node") == pre_status.get("secondary_node")
+        assert post_status.get("secondary_node") == pre_status.get("primary_node")

tests/roles/mock_data/ping.txt

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+task_type="${TEST_TASK_TYPE:-default}"
+counter_file="/tmp/ping_counter_${task_type}"
+
+if [[ -f "$counter_file" ]]; then
+    counter=$(< "$counter_file")
+    counter=${counter:-0}
+else
+    counter=0
+fi
+
+counter=$((counter + 1))
+echo "$counter" > "$counter_file"
+
+if (( counter % 2 == 1 )); then
+    exit 1
+else
+    exit 0
+fi

tests/roles/mock_data/sleep.txt

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+echo "Mock: sleep command executed"
+exit 0