|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +# |
| 3 | +# Copyright (c) 2025, Jana Hoch <[email protected]> |
| 4 | +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) |
| 5 | +# SPDX-License-Identifier: GPL-3.0-or-later |
| 6 | + |
| 7 | +from __future__ import absolute_import, division, print_function |
| 8 | + |
| 9 | +__metaclass__ = type |
| 10 | + |
| 11 | +from unittest.mock import patch |
| 12 | + |
| 13 | +import pytest |
| 14 | + |
| 15 | +proxmoxer = pytest.importorskip("proxmoxer") |
| 16 | + |
| 17 | +from ansible.module_utils import basic |
| 18 | +from ansible_collections.community.proxmox.plugins.modules import proxmox_firewall_info |
| 19 | +from ansible_collections.community.internal_test_tools.tests.unit.plugins.modules.utils import ( |
| 20 | + ModuleTestCase, |
| 21 | + set_module_args, |
| 22 | +) |
| 23 | +import ansible_collections.community.proxmox.plugins.module_utils.proxmox as proxmox_utils |
| 24 | + |
| 25 | +RAW_FIREWALL_RULES = [ |
| 26 | + { |
| 27 | + "ipversion": 4, |
| 28 | + "digest": "245f9fb31d5f59543dedc5a84ba7cd6afa4dbcc0", |
| 29 | + "log": "nolog", |
| 30 | + "action": "ACCEPT", |
| 31 | + "enable": 1, |
| 32 | + "type": "out", |
| 33 | + "source": "1.1.1.1", |
| 34 | + "pos": 0 |
| 35 | + }, |
| 36 | + { |
| 37 | + "enable": 1, |
| 38 | + "pos": 1, |
| 39 | + "source": "1.0.0.1", |
| 40 | + "type": "out", |
| 41 | + "action": "ACCEPT", |
| 42 | + "digest": "245f9fb31d5f59543dedc5a84ba7cd6afa4dbcc0", |
| 43 | + "ipversion": 4 |
| 44 | + } |
| 45 | +] |
| 46 | + |
| 47 | +RAW_GROUPS = [ |
| 48 | + { |
| 49 | + "digest": "fdb62dec01018d4f35c83ecc2ae3f110a8b3bd62", |
| 50 | + "group": "test1" |
| 51 | + }, |
| 52 | + { |
| 53 | + "group": "test2", |
| 54 | + "digest": "fdb62dec01018d4f35c83ecc2ae3f110a8b3bd62" |
| 55 | + } |
| 56 | +] |
| 57 | + |
| 58 | +RAW_ALIASES = [ |
| 59 | + { |
| 60 | + "name": "test1", |
| 61 | + "cidr": "10.10.1.0/24", |
| 62 | + "digest": "978391f460484e8d4fb3ca785cfe5a9d16fe8b1f", |
| 63 | + "ipversion": 4 |
| 64 | + }, |
| 65 | + { |
| 66 | + "name": "test2", |
| 67 | + "cidr": "10.10.2.0/24", |
| 68 | + "digest": "978391f460484e8d4fb3ca785cfe5a9d16fe8b1f", |
| 69 | + "ipversion": 4 |
| 70 | + }, |
| 71 | + { |
| 72 | + "name": "test3", |
| 73 | + "cidr": "10.10.3.0/24", |
| 74 | + "digest": "978391f460484e8d4fb3ca785cfe5a9d16fe8b1f", |
| 75 | + "ipversion": 4 |
| 76 | + } |
| 77 | +] |
| 78 | + |
| 79 | +RAW_CLUSTER_RESOURCES = [ |
| 80 | + { |
| 81 | + "vmid": 100, |
| 82 | + "maxcpu": 8, |
| 83 | + "memhost": 860138496, |
| 84 | + "type": "qemu", |
| 85 | + "id": "qemu/100", |
| 86 | + "diskread": 127452302, |
| 87 | + "netin": 42, |
| 88 | + "netout": 0, |
| 89 | + "cpu": 0.0046731498237984, |
| 90 | + "uptime": 119787, |
| 91 | + "template": 0, |
| 92 | + "disk": 0, |
| 93 | + "name": "nextcloud", |
| 94 | + "maxdisk": 644245094400, |
| 95 | + "mem": 445415424, |
| 96 | + "status": "running", |
| 97 | + "diskwrite": 1024, |
| 98 | + "maxmem": 8589934592, |
| 99 | + "node": "pve" |
| 100 | + } |
| 101 | +] |
| 102 | + |
| 103 | + |
| 104 | +def exit_json(*args, **kwargs): |
| 105 | + """function to patch over exit_json; package return data into an exception""" |
| 106 | + if 'changed' not in kwargs: |
| 107 | + kwargs['changed'] = False |
| 108 | + raise SystemExit(kwargs) |
| 109 | + |
| 110 | + |
| 111 | +def fail_json(*args, **kwargs): |
| 112 | + """function to patch over fail_json; package return data into an exception""" |
| 113 | + kwargs['failed'] = True |
| 114 | + raise SystemExit(kwargs) |
| 115 | + |
| 116 | + |
| 117 | +def get_module_args(level="cluster", vmid=None, node=None, vnet=None, group=None): |
| 118 | + return { |
| 119 | + "api_host": "host", |
| 120 | + "api_user": "user", |
| 121 | + "api_password": "password", |
| 122 | + "level": level, |
| 123 | + "vmid": vmid, |
| 124 | + "node": node, |
| 125 | + "vnet": vnet, |
| 126 | + "group": group |
| 127 | + } |
| 128 | + |
| 129 | + |
| 130 | +class TestProxmoxFirewallModule(ModuleTestCase): |
| 131 | + def setUp(self): |
| 132 | + super(TestProxmoxFirewallModule, self).setUp() |
| 133 | + proxmox_utils.HAS_PROXMOXER = True |
| 134 | + self.module = proxmox_firewall_info |
| 135 | + self.mock_module_helper = patch.multiple(basic.AnsibleModule, |
| 136 | + exit_json=exit_json, |
| 137 | + fail_json=fail_json) |
| 138 | + self.mock_module_helper.start() |
| 139 | + self.connect_mock = patch( |
| 140 | + "ansible_collections.community.proxmox.plugins.module_utils.proxmox.ProxmoxAnsible._connect", |
| 141 | + ).start() |
| 142 | + |
| 143 | + self.connect_mock.return_value.cluster.resources.get.return_value = ( |
| 144 | + RAW_CLUSTER_RESOURCES |
| 145 | + ) |
| 146 | + |
| 147 | + mock_cluster_fw = self.connect_mock.return_value.cluster.return_value.firewall.return_value |
| 148 | + mock_vm100_fw = self.connect_mock.return_value.nodes.return_value.return_value.return_value.firewall.return_value |
| 149 | + |
| 150 | + mock_cluster_fw.rules.get.return_value = RAW_FIREWALL_RULES |
| 151 | + mock_cluster_fw.groups.return_value.get.return_value = RAW_GROUPS |
| 152 | + mock_cluster_fw.aliases.return_value.get.return_value = RAW_ALIASES |
| 153 | + |
| 154 | + mock_vm100_fw.rules.get.return_value = RAW_FIREWALL_RULES |
| 155 | + mock_vm100_fw.aliases.return_value.get.return_value = RAW_ALIASES |
| 156 | + |
| 157 | + def tearDown(self): |
| 158 | + self.connect_mock.stop() |
| 159 | + self.mock_module_helper.stop() |
| 160 | + super(TestProxmoxFirewallModule, self).tearDown() |
| 161 | + |
| 162 | + def test_cluster_level_info(self): |
| 163 | + with pytest.raises(SystemExit) as exc_info: |
| 164 | + with set_module_args(get_module_args()): |
| 165 | + self.module.main() |
| 166 | + result = exc_info.value.args[0] |
| 167 | + assert result["changed"] is False |
| 168 | + assert result["msg"] == "successfully retrieved firewall rules and groups" |
| 169 | + assert result["firewall_rules"] == RAW_FIREWALL_RULES |
| 170 | + assert result["groups"] == ['test1', 'test2'] |
| 171 | + assert result["aliases"] == RAW_ALIASES |
| 172 | + |
| 173 | + def test_vm_level_info(self): |
| 174 | + with pytest.raises(SystemExit) as exc_info: |
| 175 | + with set_module_args(get_module_args(level='vm', vmid=100)): |
| 176 | + self.module.main() |
| 177 | + result = exc_info.value.args[0] |
| 178 | + assert result["changed"] is False |
| 179 | + assert result["msg"] == "successfully retrieved firewall rules and groups" |
| 180 | + assert result["firewall_rules"] == RAW_FIREWALL_RULES |
| 181 | + assert result["groups"] == ['test1', 'test2'] |
| 182 | + assert result["aliases"] == RAW_ALIASES |
0 commit comments