Merge remote-tracking branch 'origin/dev' into feature/remove-ftp-client-default-app

tests/conftest.py

@@ -1,19 +1,14 @@
 # © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
-from datetime import datetime
-from pathlib import Path
-from typing import Any, Dict, Optional, Tuple, Union
+from typing import Any, Dict, Tuple
 
 import pytest
-import yaml
-from _pytest.monkeypatch import MonkeyPatch
 
-from primaite import getLogger, PRIMAITE_PATHS
+from primaite import getLogger
 from primaite.game.agent.actions import ActionManager
 from primaite.game.agent.interface import AbstractAgent
 from primaite.game.agent.observations.observation_manager import NestedObservation, ObservationManager
 from primaite.game.agent.rewards import RewardFunction
 from primaite.game.game import PrimaiteGame
-from primaite.simulator import SIM_OUTPUT
 from primaite.simulator.file_system.file_system import FileSystem
 from primaite.simulator.network.container import Network
 from primaite.simulator.network.hardware.nodes.host.computer import Computer
@@ -32,7 +27,6 @@ from primaite.simulator.system.services.dns.dns_server import DNSServer
 from primaite.simulator.system.services.service import Service
 from primaite.simulator.system.services.web_server.web_server import WebServer
 from tests import TEST_ASSETS_ROOT
-from tests.mock_and_patch.get_session_path_mock import temp_user_sessions_path
 
 ACTION_SPACE_NODE_VALUES = 1
 ACTION_SPACE_NODE_ACTION_VALUES = 1
@@ -40,21 +34,6 @@ ACTION_SPACE_NODE_ACTION_VALUES = 1
 _LOGGER = getLogger(__name__)
 
 
-@pytest.fixture(scope="function", autouse=True)
-def set_syslog_output_to_true():
-    """Will be run before each test."""
-    monkeypatch = MonkeyPatch()
-    monkeypatch.setattr(
-        SIM_OUTPUT,
-        "path",
-        Path(TEST_ASSETS_ROOT.parent.parent / "simulation_output" / datetime.now().strftime("%Y-%m-%d_%H-%M-%S")),
-    )
-    monkeypatch.setattr(SIM_OUTPUT, "save_pcap_logs", False)
-    monkeypatch.setattr(SIM_OUTPUT, "save_sys_logs", False)
-
-    yield
-
-
 class TestService(Service):
     """Test Service class"""
 

tests/e2e_integration_tests/environments/test_rllib_single_agent_environment.py

@@ -38,3 +38,5 @@ def test_rllib_single_agent_compatibility():
     save_file = Path(tempfile.gettempdir()) / "ray/"
     algo.save(save_file)
     assert save_file.exists()
+
+    save_file.unlink()  # clean up

tests/e2e_integration_tests/environments/test_sb3_environment.py

@@ -25,3 +25,4 @@ def test_sb3_compatibility():
     model.save(save_path)
 
     assert (save_path).exists()
+    save_path.unlink()  # clean up

tests/integration_tests/cli/__init__.py

@@ -0,0 +1,11 @@
+from typing import List
+
+from typer.testing import CliRunner, Result
+
+from primaite.cli import app
+
+
+def cli(args: List[str]) -> Result:
+    """Pass in a list of arguments and it will return the result."""
+    runner = CliRunner()
+    return runner.invoke(app, args)

tests/integration_tests/cli/test_dev_cli.py

@@ -0,0 +1,171 @@
+import os
+import shutil
+import tempfile
+from pathlib import Path
+
+import pkg_resources
+import pytest
+import yaml
+
+from primaite import PRIMAITE_CONFIG
+from primaite.utils.cli.primaite_config_utils import update_primaite_application_config
+from tests.integration_tests.cli import cli
+
+
+@pytest.fixture(autouse=True)
+def test_setup():
+    """
+    Setup this test by using the default primaite app config in package
+    """
+    global PRIMAITE_CONFIG
+    current_config = PRIMAITE_CONFIG.copy()  # store the config before test
+
+    pkg_config_path = Path(pkg_resources.resource_filename("primaite", "setup/_package_data/primaite_config.yaml"))
+
+    with open(pkg_config_path, "r") as file:
+        # load from config
+        config_dict = yaml.safe_load(file)
+
+    PRIMAITE_CONFIG["developer_mode"] = config_dict["developer_mode"]
+
+    yield
+
+    PRIMAITE_CONFIG["developer_mode"] = current_config["developer_mode"]  # restore config to prevent being yelled at
+    update_primaite_application_config(config=PRIMAITE_CONFIG)
+
+
+def test_dev_mode_enable_disable():
+    """Test dev mode enable and disable."""
+    # check defaults
+    assert PRIMAITE_CONFIG["developer_mode"]["enabled"] is False  # not enabled by default
+
+    result = cli(["dev-mode", "show"])
+    assert "Production" in result.output  # should print that it is in Production mode by default
+
+    result = cli(["dev-mode", "enable"])
+
+    assert "Development" in result.output  # should print that it is in Development mode
+
+    assert PRIMAITE_CONFIG["developer_mode"]["enabled"]  # config should reflect that dev mode is enabled
+
+    result = cli(["dev-mode", "show"])
+    assert "Development" in result.output  # should print that it is in Development mode
+
+    result = cli(["dev-mode", "disable"])
+
+    assert "Production" in result.output  # should print that it is in Production mode
+
+    assert PRIMAITE_CONFIG["developer_mode"]["enabled"] is False  # config should reflect that dev mode is disabled
+
+    result = cli(["dev-mode", "show"])
+    assert "Production" in result.output  # should print that it is in Production mode
+
+
+def test_dev_mode_config_sys_log_level():
+    """Check that the system log level can be changed via CLI."""
+    # check defaults
+    assert PRIMAITE_CONFIG["developer_mode"]["sys_log_level"] == "DEBUG"  # DEBUG by default
+
+    result = cli(["dev-mode", "config", "-level", "WARNING"])
+
+    assert "sys_log_level=WARNING" in result.output  # should print correct value
+
+    # config should reflect that log level is WARNING
+    assert PRIMAITE_CONFIG["developer_mode"]["sys_log_level"] == "WARNING"
+
+    result = cli(["dev-mode", "config", "--sys-log-level", "INFO"])
+
+    assert "sys_log_level=INFO" in result.output  # should print correct value
+
+    # config should reflect that log level is WARNING
+    assert PRIMAITE_CONFIG["developer_mode"]["sys_log_level"] == "INFO"
+
+
+def test_dev_mode_config_sys_logs_enable_disable():
+    """Test that the system logs output can be enabled or disabled."""
+    # check defaults
+    assert PRIMAITE_CONFIG["developer_mode"]["output_sys_logs"] is False  # False by default
+
+    result = cli(["dev-mode", "config", "--output-sys-logs"])
+    assert "output_sys_logs=True" in result.output  # should print correct value
+
+    # config should reflect that output_sys_logs is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_sys_logs"]
+
+    result = cli(["dev-mode", "config", "--no-sys-logs"])
+    assert "output_sys_logs=False" in result.output  # should print correct value
+
+    # config should reflect that output_sys_logs is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_sys_logs"] is False
+
+    result = cli(["dev-mode", "config", "-sys"])
+    assert "output_sys_logs=True" in result.output  # should print correct value
+
+    # config should reflect that output_sys_logs is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_sys_logs"]
+
+    result = cli(["dev-mode", "config", "-nsys"])
+    assert "output_sys_logs=False" in result.output  # should print correct value
+
+    # config should reflect that output_sys_logs is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_sys_logs"] is False
+
+
+def test_dev_mode_config_pcap_logs_enable_disable():
+    """Test that the pcap logs output can be enabled or disabled."""
+    # check defaults
+    assert PRIMAITE_CONFIG["developer_mode"]["output_pcap_logs"] is False  # False by default
+
+    result = cli(["dev-mode", "config", "--output-pcap-logs"])
+    assert "output_pcap_logs=True" in result.output  # should print correct value
+
+    # config should reflect that output_pcap_logs is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_pcap_logs"]
+
+    result = cli(["dev-mode", "config", "--no-pcap-logs"])
+    assert "output_pcap_logs=False" in result.output  # should print correct value
+
+    # config should reflect that output_pcap_logs is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_pcap_logs"] is False
+
+    result = cli(["dev-mode", "config", "-pcap"])
+    assert "output_pcap_logs=True" in result.output  # should print correct value
+
+    # config should reflect that output_pcap_logs is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_pcap_logs"]
+
+    result = cli(["dev-mode", "config", "-npcap"])
+    assert "output_pcap_logs=False" in result.output  # should print correct value
+
+    # config should reflect that output_pcap_logs is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_pcap_logs"] is False
+
+
+def test_dev_mode_config_output_to_terminal_enable_disable():
+    """Test that the output to terminal can be enabled or disabled."""
+    # check defaults
+    assert PRIMAITE_CONFIG["developer_mode"]["output_to_terminal"] is False  # False by default
+
+    result = cli(["dev-mode", "config", "--output-to-terminal"])
+    assert "output_to_terminal=True" in result.output  # should print correct value
+
+    # config should reflect that output_to_terminal is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_to_terminal"]
+
+    result = cli(["dev-mode", "config", "--no-terminal"])
+    assert "output_to_terminal=False" in result.output  # should print correct value
+
+    # config should reflect that output_to_terminal is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_to_terminal"] is False
+
+    result = cli(["dev-mode", "config", "-t"])
+    assert "output_to_terminal=True" in result.output  # should print correct value
+
+    # config should reflect that output_to_terminal is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_to_terminal"]
+
+    result = cli(["dev-mode", "config", "-nt"])
+    assert "output_to_terminal=False" in result.output  # should print correct value
+
+    # config should reflect that output_to_terminal is True
+    assert PRIMAITE_CONFIG["developer_mode"]["output_to_terminal"] is False

tests/unit_tests/_primaite/_simulator/_system/core/test_sys_log.py

@@ -2,10 +2,20 @@ from uuid import uuid4
 
 import pytest
 
+from primaite import PRIMAITE_CONFIG
 from primaite.simulator import LogLevel, SIM_OUTPUT
 from primaite.simulator.system.core.sys_log import SysLog
 
 
+@pytest.fixture(autouse=True)
+def override_dev_mode_temporarily():
+    """Temporarily turn off dev mode for this test."""
+    primaite_dev_mode = PRIMAITE_CONFIG["developer_mode"]["enabled"]
+    PRIMAITE_CONFIG["developer_mode"]["enabled"] = False
+    yield  # run tests
+    PRIMAITE_CONFIG["developer_mode"]["enabled"] = primaite_dev_mode
+
+
 @pytest.fixture(scope="function")
 def syslog() -> SysLog:
     return SysLog(hostname="test")