Add new unit test for snap and route modules (#607)

Signed-off-by: vivekpandeyibm <[email protected]>

tests/unit/plugins/modules/test_route.py

@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2025- IBM, Inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+import unittest
+from unittest import mock
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.ibm.power_aix.plugins.modules import route
+
+from .common.utils import AnsibleFailJson, fail_json
+
+
+class TestRouteCommandFunctions(unittest.TestCase):
+    def setUp(self):
+        self.module = mock.Mock(spec=AnsibleModule)
+        self.module.fail_json = fail_json
+        self.module.fail_json.side_effect = AnsibleFailJson
+
+        # Default parameters for route module
+        params = dict()
+        params["action"] = "add"  # Default action for tests
+        params["destination"] = None
+        params["gateway"] = None
+        params["netmask"] = None
+        params["prefixlen"] = None
+        params["arguments"] = {}
+        params["flush"] = False
+        params["numeric"] = False
+        params["ioctl_preference"] = False
+        params["verbose"] = False
+        params["flags"] = "host"  # Default flag for tests
+        params["family"] = None
+
+        self.module.params = params
+
+        # Mock command return values
+        rc, stdout, stderr = 0, "sample stdout", "sample stderr"
+        self.module.run_command.return_value = (rc, stdout, stderr)
+
+    def test_normalize_route_entry_valid_cidr(self):
+        result = route.normalize_route_entry(self.module, "10.12/16")
+        self.assertEqual(result, "10.12.0.0/16")
+
+    def test_normalize_route_entry_invalid_cidr(self):
+        with self.assertRaises(AnsibleFailJson) as result:
+            route.normalize_route_entry(self.module, "10.12.300/16")
+        self.assertIn("Failed to normalize route_entry", result.exception.args[0]['msg'])
+
+    def test_normalize_route_entry_no_slash(self):
+        result = route.normalize_route_entry(self.module, "10.12.15.1")
+        self.assertEqual(result, "10.12.15.1")
+
+    def test_parse_routing_table_single_entry(self):
+        self.module.run_command.return_value = (0, "10.0.0.0/24 192.168.1.1", "")
+        # Call the function to parse the routing table
+        routing_table, gateways = route.parse_routing_table(self.module)
+        self.assertEqual(str(routing_table[0]), "10.0.0.0/24")
+        self.assertEqual(gateways[0], "192.168.1.1")  # Access the single gateway directly
+
+    def test_parse_routing_table_success(self):
+        self.module.run_command.return_value = (0, "10.0.0.0/24 192.168.1.1\n10.0.1.0/24 192.168.1.2", "")
+        routing_table, gateways = route.parse_routing_table(self.module)
+        self.assertEqual(len(routing_table), 2)
+        self.assertEqual(gateways, ["192.168.1.1", "192.168.1.2"])
+
+    def test_parse_routing_table_failure(self):
+        self.module.run_command.return_value = (1, "", "Error fetching routing table")
+        with self.assertRaises(AnsibleFailJson) as result:
+            route.parse_routing_table(self.module)
+        self.assertIn("Failed to fetch routing table", result.exception.args[0]['msg'])
+
+    def test_check_destination_in_routing_table_found(self):
+        self.module.params.update({
+            "netmask": None,
+            "prefixlen": 24,
+            "flags": "net",
+            "gateway": "192.168.1.1",
+            "action": "add"
+        })
+        self.module.run_command.return_value = (0, "10.0.0.0/24 192.168.1.1", "")
+        result = route.check_destination_in_routing_table(self.module, "10.0.0.0")
+        self.assertTrue(result)
+
+    def test_check_destination_in_routing_table_not_found(self):
+        self.module.params.update({
+            "netmask": None,
+            "prefixlen": 24,
+            "flags": "net",
+            "gateway": "192.168.1.1",
+            "action": "add"
+        })
+        self.module.run_command.return_value = (0, "10.0.1.0/24 192.168.1.2", "")
+        result = route.check_destination_in_routing_table(self.module, "10.0.0.0")
+        self.assertFalse(result)
+
+    def test_calculate_network_address_with_netmask(self):
+        result = route.calculate_network_address(self.module, "192.168.1.1", "255.255.255.0")
+        self.assertEqual(result, "192.168.1.0")
+
+    def test_calculate_network_address_with_prefix(self):
+        result = route.calculate_network_address(self.module, "192.168.1.1", 24)
+        self.assertEqual(result, "192.168.1.0")
+
+    def test_build_route_command_flush(self):
+        self.module.params = {
+            "flush": True
+        }
+        cmd = route.build_route_command(self.module)
+        self.assertEqual(cmd, "route -f")
+
+    def test_build_route_command_with_destination(self):
+        self.module.params = {
+            "action": "add",
+            "destination": "192.168.1.1",
+            "prefixlen": None,
+            "flags": "host",
+            "flush": False,
+            "numeric": False,
+            "ioctl_preference": False,
+            "verbose": False,
+            "gateway": "192.168.1.254",
+            "netmask": None,
+            "arguments": None,
+            "family": None
+        }
+        cmd = route.build_route_command(self.module)
+        self.assertEqual(cmd, "route add -host 192.168.1.1 192.168.1.254")
+
+    def test_build_route_command_with_net(self):
+        self.module.params = {
+            "action": "add",
+            "destination": "192.168.1.4",
+            "prefixlen": 24,
+            "flags": "net",
+            "flush": False,
+            "numeric": False,
+            "ioctl_preference": False,
+            "verbose": False,
+            "gateway": "192.168.1.1",
+            "netmask": None,
+            "arguments": None,
+            "family": None
+        }
+        cmd = route.build_route_command(self.module)
+        self.assertEqual(cmd, "route add -net 192.168.1.4 -prefixlen 24 192.168.1.1")
+
+    def test_run_route_command_success(self):
+        self.module.params = {
+            "action": "add",
+            "destination": "192.168.1.4",
+            "prefixlen": 24,
+            "flags": "net",
+            "flush": False,
+            "numeric": False,
+            "ioctl_preference": False,
+            "verbose": False,
+            "gateway": "192.168.1.1",
+            "netmask": None,
+            "arguments": None,
+            "family": None
+        }
+        self.module.run_command.return_value = (0, "Command executed successfully", "")
+        rc, stdout, stderr, cmd = route.run_route_command(self.module)
+        self.assertEqual(stdout, "Command executed successfully")
+
+    def test_run_route_command_failure(self):
+        self.module.params = {
+            "action": "add",
+            "destination": "192.168.1.4",
+            "prefixlen": 24,
+            "flags": "net",
+            "flush": False,
+            "numeric": False,
+            "ioctl_preference": False,
+            "verbose": False,
+            "gateway": "192.168.1.1",
+            "netmask": None,
+            "arguments": None,
+            "family": None
+        }
+        self.module.run_command.return_value = (1, "", "Error occurred")
+        with self.assertRaises(AnsibleFailJson) as result:
+            route.run_route_command(self.module)
+
+        exception_result = result.exception.args[0]
+        self.assertTrue(exception_result['failed'])
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/unit/plugins/modules/test_snap.py

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2025- IBM, Inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+import unittest
+from unittest import mock
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.ibm.power_aix.plugins.modules import snap
+from .common.utils import (
+    AnsibleFailJson, fail_json
+)
+
+
+class TestSnapCommand(unittest.TestCase):
+    def setUp(self):
+        self.module = mock.Mock(spec=AnsibleModule)
+        self.module.fail_json = fail_json
+        self.module.fail_json.side_effect = AnsibleFailJson
+
+        # Parameters for snap module
+        params = dict()
+        params["all_info"] = False
+        params["compress"] = False
+        params["general_info"] = False
+        params["live_kernel"] = False
+        params["hacmp"] = False
+        params["reset"] = False
+        params["file_system_info"] = False
+        params["collects_dump"] = False
+        params["installation_info"] = False
+        params["kernel_info"] = False
+        params["security_info"] = False
+        params["workload_manager_info"] = False
+        params["hardware_info"] = False
+        self.module.params = params
+
+        # Mock command return values
+        rc, stdout, stderr = 0, "sample stdout", "sample stderr"
+        self.module.run_command.return_value = (rc, stdout, stderr)
+
+    def test_snap_general_option_all_info(self):
+        self.module.params["all_info"] = True
+        cmd = snap.snap_general_option(self.module)
+        self.assertEqual(cmd, ['snap', '-a'])
+
+    def test_snap_general_option_hacmp(self):
+        self.module.params["all_info"] = False
+        self.module.params["hacmp"] = True
+        cmd = snap.snap_general_option(self.module)
+        self.assertEqual(cmd, ['snap', '-e'])
+
+    def test_snap_general_option_file_system_info(self):
+        self.module.params["file_system_info"] = True
+        cmd = snap.snap_general_option(self.module)
+        self.assertEqual(cmd, ['snap', '-f'])
+
+    def test_snap_general_option_live_kernel(self):
+        self.module.params["live_kernel"] = True
+        cmd = snap.snap_general_option(self.module)
+        self.assertEqual(cmd, ['snap', '-U'])
+
+    def test_snap_general_option_multiple_params(self):
+        self.module.params.update({
+            "file_system_info": True,
+            "installation_info": True,
+            "kernel_info": True,
+            "workload_manager_info": True,
+            "general_info": True,
+            "security_info": True,
+            "compress": True,
+        })
+        cmd = snap.snap_general_option(self.module)
+        self.assertEqual(cmd, ['snap', '-f', '-i', '-k', '-w', '-S', '-g', '-c'])
+
+    def test_snap_general_option_hardware_info(self):
+        self.module.params["hardware_info"] = True
+        cmd = snap.snap_general_option(self.module)
+        self.assertEqual(cmd, ['snap', '-H'])
+
+    def test_snap_general_option_collects_dump(self):
+        self.module.params["collects_dump"] = True
+        cmd = snap.snap_general_option(self.module)
+        self.assertEqual(cmd, ['snap', '-D'])
+
+    # build_snap_command function calling
+    def test_build_snap_command_hacmp(self):
+        self.module.params["all_info"] = False
+        self.module.params["hacmp"] = True
+        cmd = snap.build_snap_command(self.module)
+        self.assertEqual(cmd, ['snap', '-e'])
+
+    def test_run_snap_command_with_expect_failed(self):
+        rc, stdout, stderr = 1, "Cleanup completed. Command execution failed", "sample stderr"
+        self.module.run_command.return_value = (rc, stdout, stderr)
+        with self.assertRaises(AnsibleFailJson) as result:
+            snap.run_snap_command_with_expect(self.module)
+        testResult = result.exception.args[0]
+        self.assertTrue(testResult['failed'])
+
+    def test_run_snap_command_with_expect_command_failed(self):
+        rc, stdout, stderr = 1, "Error occurred during cleanup", "Detailed error message"
+        self.module.run_command.return_value = (rc, stdout, stderr)
+        # `module.fail_json` raises the expected exception
+        with self.assertRaises(AnsibleFailJson) as result:
+            snap.run_snap_command_with_expect(self.module)
+        exception_result = result.exception.args[0]
+        self.assertTrue(exception_result['failed'])
+
+    def test_run_snap_command_with_expect_nothing_to_clean(self):
+        rc, stdout, stderr = 0, "Cleanup completed. Nothing to clean up", "sample stderr"
+        self.module.run_command.return_value = (rc, stdout, stderr)
+
+        result = snap.run_snap_command_with_expect(self.module)
+        self.assertEqual(result['msg'], "No cleanup was required.")
+
+    def test_run_snap_command_with_expect_successfull(self):
+        rc, stdout, stderr = 0, "Cleanup completed. Command executed successfully", "sample stderr"
+        self.module.run_command.return_value = (rc, stdout, stderr)
+
+        result = snap.run_snap_command_with_expect(self.module)
+        self.assertEqual(result['msg'], "Command executed successfully.")
+
+
+if __name__ == '__main__':
+    unittest.main()