diff options
| author | omnom62 <omnom62@outlook.com> | 2026-11-10 04:49:02 +1000 |
|---|---|---|
| committer | omnom62 <omnom62@outlook.com> | 2026-11-10 04:49:02 +1000 |
| commit | ea32385588d1eac0bea48faa3822ae60715c1dcf (patch) | |
| tree | f74d44cf0bb0968d073d0cb220bf9a652ea24151 /tests/unit/modules | |
| parent | 4e59e33e38daf8df4cb1aaedfb39a8a95e927531 (diff) | |
| download | rest.vyos-t8989_snmp_server_core7.tar.gz rest.vyos-t8989_snmp_server_core7.zip | |
T8989: vyos_command CORE7 fixest8989_snmp_server_core7
Diffstat (limited to 'tests/unit/modules')
| -rw-r--r-- | tests/unit/modules/test_vyos_command.py | 72 |
1 files changed, 71 insertions, 1 deletions
diff --git a/tests/unit/modules/test_vyos_command.py b/tests/unit/modules/test_vyos_command.py index 5b474f9..ec81e92 100644 --- a/tests/unit/modules/test_vyos_command.py +++ b/tests/unit/modules/test_vyos_command.py @@ -6,9 +6,12 @@ __metaclass__ = type import unittest -from unittest.mock import MagicMock +from unittest.mock import MagicMock, patch +from ansible_collections.vyos.rest.plugins.module_utils.vyos import VyOSRestError +from ansible_collections.vyos.rest.plugins.modules import vyos_command as command_module from ansible_collections.vyos.rest.plugins.modules.vyos_command import ( + CommandFailed, evaluate_conditions, parse_command, run_commands, @@ -107,5 +110,72 @@ class TestVyOSCommandRunCommands(unittest.TestCase): self.assertEqual(result, [""]) +class TestVyOSCommandFailures(unittest.TestCase): + """CORE-7: a command the device rejects must fail the task, not hide in stdout.""" + + def setUp(self): + self.vyos = MagicMock() + + def test_a_rejected_command_raises_with_the_earlier_output(self): + self.vyos.show.side_effect = ["out1", VyOSRestError("Invalid command (HTTP 400)")] + with self.assertRaises(CommandFailed) as ctx: + run_commands(self.vyos, ["show version", "show bogus"]) + self.assertEqual(ctx.exception.command, "show bogus") + self.assertIn("Invalid command", ctx.exception.error) + self.assertEqual(ctx.exception.stdout, ["out1"]) + + def test_the_first_command_failing_leaves_no_output(self): + self.vyos.show.side_effect = VyOSRestError("boom") + with self.assertRaises(CommandFailed) as ctx: + run_commands(self.vyos, ["show version"]) + self.assertEqual(ctx.exception.stdout, []) + + def test_other_exceptions_are_bugs_and_propagate(self): + self.vyos.show.side_effect = RuntimeError("connection reset") + with self.assertRaises(RuntimeError): + run_commands(self.vyos, ["show version"]) + + def run_main(self, show_side_effect, **params): + module = MagicMock() + module.params = dict( + { + "commands": ["show version", "show bogus"], + "wait_for": None, + "match": "all", + "retries": 3, + "interval": 0, + }, + **params, + ) + module.fail_json.side_effect = SystemExit + self.vyos.show.side_effect = show_side_effect + with patch.object(command_module, "AnsibleModule", return_value=module): + with patch.object(command_module, "VyOSModule", return_value=self.vyos): + try: + command_module.main() + except SystemExit: + pass + return module + + def test_main_fails_the_task_and_keeps_the_output_so_far(self): + module = self.run_main(["out1", VyOSRestError("Invalid command (HTTP 400)")]) + kwargs = module.fail_json.call_args[1] + self.assertIn("command failed: show bogus", kwargs["msg"]) + self.assertEqual(kwargs["failed_command"], "show bogus") + self.assertEqual(kwargs["stdout"], ["out1"]) + module.exit_json.assert_not_called() + + def test_a_rejected_command_is_not_retried(self): + module = self.run_main(VyOSRestError("boom"), wait_for=["result[0] contains x"]) + self.assertEqual(self.vyos.show.call_count, 1) + module.fail_json.assert_called_once() + + def test_main_still_succeeds_when_every_command_works(self): + module = self.run_main(["out1", "out2"]) + module.fail_json.assert_not_called() + kwargs = module.exit_json.call_args[1] + self.assertEqual((kwargs["changed"], kwargs["stdout"]), (False, ["out1", "out2"])) + + if __name__ == "__main__": unittest.main() |
