From 300b03e19065d81a8011ade85af4bb258e826def Mon Sep 17 00:00:00 2001 From: Yuhu-kth Date: Tue, 4 Jun 2024 16:05:55 +0200 Subject: [PATCH 1/3] flags_controller --- .../tests/test_flags_controller.py | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 simulation-system/libs/csle-common/tests/test_flags_controller.py diff --git a/simulation-system/libs/csle-common/tests/test_flags_controller.py b/simulation-system/libs/csle-common/tests/test_flags_controller.py new file mode 100644 index 000000000..1aad5a533 --- /dev/null +++ b/simulation-system/libs/csle-common/tests/test_flags_controller.py @@ -0,0 +1,38 @@ +import pytest +import logging +from unittest.mock import MagicMock, patch +from csle_common.controllers.flags_controller import FlagsController +from csle_common.util.emulation_util import EmulationUtil +from csle_common.constants.constants import COMMANDS +from csle_common.dao.emulation_config.emulation_env_config import EmulationEnvConfig +from csle_common.dao.emulation_config.node_flags_config import NodeFlagsConfig +from csle_common.dao.emulation_config.flag import Flag +class TestFlagsControllerSuite: + """ + Test suite for flags controller + """ + + @patch('csle_common.util.emulation_util.EmulationUtil.connect_admin') + @patch('csle_common.util.emulation_util.EmulationUtil.execute_ssh_cmd') + @patch('csle_common.util.emulation_util.EmulationUtil.disconnect_admin') + def test_create_flags(self, mock_disconnect_admin, mock_execute_ssh_cmd, mock_connect_admin) -> None: + emulation_env_config = MagicMock(spec=EmulationEnvConfig) + flags_config = MagicMock() + emulation_env_config.flags_config = flags_config + flags_config.node_flag_configs = [ + NodeFlagsConfig( + ip = '10.0.0.1', + docker_gw_bridge_ip='172.17.0.1', + physical_host_ip='192.168.0.1', + flags=[ + Flag(name='flag1', dir='/dir1', id=1, path='/path/to/flag1'), + Flag(name='flag2', dir='/dir2', id=2, path='/path/to/flag2'), + ] + ), + ] + logger = MagicMock(spec=logging.Logger) + physical_server_ip = '192.168.0.1' + FlagsController.create_flags(emulation_env_config,physical_server_ip,logger) + mock_connect_admin.assert_called_once_with(emulation_env_config=emulation_env_config, ip='172.17.0.1') + mock_disconnect_admin.assert_called_once_with(emulation_env_config=emulation_env_config) + \ No newline at end of file From 84f35a5b0d3a35a76a3a8b58327859d14c9a886c Mon Sep 17 00:00:00 2001 From: Yuhu-kth Date: Wed, 5 Jun 2024 12:08:28 +0200 Subject: [PATCH 2/3] test_flags_controller --- .../libs/csle-common/tests/test_flags_controller.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/simulation-system/libs/csle-common/tests/test_flags_controller.py b/simulation-system/libs/csle-common/tests/test_flags_controller.py index 1aad5a533..2a2f7f5bd 100644 --- a/simulation-system/libs/csle-common/tests/test_flags_controller.py +++ b/simulation-system/libs/csle-common/tests/test_flags_controller.py @@ -3,7 +3,7 @@ from unittest.mock import MagicMock, patch from csle_common.controllers.flags_controller import FlagsController from csle_common.util.emulation_util import EmulationUtil -from csle_common.constants.constants import COMMANDS +import csle_common.constants.constants as constants from csle_common.dao.emulation_config.emulation_env_config import EmulationEnvConfig from csle_common.dao.emulation_config.node_flags_config import NodeFlagsConfig from csle_common.dao.emulation_config.flag import Flag @@ -35,4 +35,4 @@ def test_create_flags(self, mock_disconnect_admin, mock_execute_ssh_cmd, mock_co FlagsController.create_flags(emulation_env_config,physical_server_ip,logger) mock_connect_admin.assert_called_once_with(emulation_env_config=emulation_env_config, ip='172.17.0.1') mock_disconnect_admin.assert_called_once_with(emulation_env_config=emulation_env_config) - \ No newline at end of file + mock_execute_ssh_cmd.assert_called() \ No newline at end of file From ac50780a4738c0eee0d507e4bd99ca2fc75454f6 Mon Sep 17 00:00:00 2001 From: Yuhu-kth Date: Sat, 8 Jun 2024 15:48:33 +0200 Subject: [PATCH 3/3] added comments and ran mypy --- .../tests/test_flags_controller.py | 50 ++++++++++++------- 1 file changed, 31 insertions(+), 19 deletions(-) diff --git a/simulation-system/libs/csle-common/tests/test_flags_controller.py b/simulation-system/libs/csle-common/tests/test_flags_controller.py index 2a2f7f5bd..8cd214c12 100644 --- a/simulation-system/libs/csle-common/tests/test_flags_controller.py +++ b/simulation-system/libs/csle-common/tests/test_flags_controller.py @@ -1,38 +1,50 @@ -import pytest import logging from unittest.mock import MagicMock, patch from csle_common.controllers.flags_controller import FlagsController -from csle_common.util.emulation_util import EmulationUtil -import csle_common.constants.constants as constants from csle_common.dao.emulation_config.emulation_env_config import EmulationEnvConfig from csle_common.dao.emulation_config.node_flags_config import NodeFlagsConfig from csle_common.dao.emulation_config.flag import Flag + + class TestFlagsControllerSuite: """ Test suite for flags controller """ - - @patch('csle_common.util.emulation_util.EmulationUtil.connect_admin') - @patch('csle_common.util.emulation_util.EmulationUtil.execute_ssh_cmd') - @patch('csle_common.util.emulation_util.EmulationUtil.disconnect_admin') - def test_create_flags(self, mock_disconnect_admin, mock_execute_ssh_cmd, mock_connect_admin) -> None: + + @patch("csle_common.util.emulation_util.EmulationUtil.connect_admin") + @patch("csle_common.util.emulation_util.EmulationUtil.execute_ssh_cmd") + @patch("csle_common.util.emulation_util.EmulationUtil.disconnect_admin") + def test_create_flags( + self, mock_disconnect_admin, mock_execute_ssh_cmd, mock_connect_admin + ) -> None: + """ + Test case for creating flags using the FlagsController + + :param mock_disconnect_admin: Mocked disconnect_admin method + :param mock_execute_ssh_cmd: Mocked execute_ssh_cmd method + :param mock_connect_admin: Mocked connect_admin + """ emulation_env_config = MagicMock(spec=EmulationEnvConfig) flags_config = MagicMock() emulation_env_config.flags_config = flags_config flags_config.node_flag_configs = [ NodeFlagsConfig( - ip = '10.0.0.1', - docker_gw_bridge_ip='172.17.0.1', - physical_host_ip='192.168.0.1', + ip="10.0.0.1", + docker_gw_bridge_ip="172.17.0.1", + physical_host_ip="192.168.0.1", flags=[ - Flag(name='flag1', dir='/dir1', id=1, path='/path/to/flag1'), - Flag(name='flag2', dir='/dir2', id=2, path='/path/to/flag2'), - ] + Flag(name="flag1", dir="/dir1", id=1, path="/path/to/flag1"), + Flag(name="flag2", dir="/dir2", id=2, path="/path/to/flag2"), + ], ), ] logger = MagicMock(spec=logging.Logger) - physical_server_ip = '192.168.0.1' - FlagsController.create_flags(emulation_env_config,physical_server_ip,logger) - mock_connect_admin.assert_called_once_with(emulation_env_config=emulation_env_config, ip='172.17.0.1') - mock_disconnect_admin.assert_called_once_with(emulation_env_config=emulation_env_config) - mock_execute_ssh_cmd.assert_called() \ No newline at end of file + physical_server_ip = "192.168.0.1" + FlagsController.create_flags(emulation_env_config, physical_server_ip, logger) + mock_connect_admin.assert_called_once_with( + emulation_env_config=emulation_env_config, ip="172.17.0.1" + ) + mock_disconnect_admin.assert_called_once_with( + emulation_env_config=emulation_env_config + ) + mock_execute_ssh_cmd.assert_called()