#2646 - Added a custom pre-commit hook that ensure the copyright clause is added to .py and .rst files.

2024-06-05 09:11:37 +01:00
parent c705a15d00
commit 81bcf99855
332 changed files with 505 additions and 365 deletions
--- a/tests/unit_tests/_primaite/init.py
+++ b/tests/unit_tests/_primaite/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_game/init.py
+++ b/tests/unit_tests/_primaite/_game/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_game/_agent/init.py
+++ b/tests/unit_tests/_primaite/_game/_agent/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_game/_agent/test_actions.py
+++ b/tests/unit_tests/_primaite/_game/_agent/test_actions.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from unittest.mock import Mock

 import pytest
--- a/tests/unit_tests/_primaite/_game/_agent/test_probabilistic_agent.py
+++ b/tests/unit_tests/_primaite/_game/_agent/test_probabilistic_agent.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from primaite.game.agent.actions import ActionManager
 from primaite.game.agent.observations.observation_manager import NestedObservation, ObservationManager
 from primaite.game.agent.rewards import RewardFunction
--- a/tests/unit_tests/_primaite/_interface/init.py
+++ b/tests/unit_tests/_primaite/_interface/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_interface/test_request.py
+++ b/tests/unit_tests/_primaite/_interface/test_request.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest
 from pydantic import ValidationError

--- a/tests/unit_tests/_primaite/_session/init.py
+++ b/tests/unit_tests/_primaite/_session/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_session/test_episode_schedule.py
+++ b/tests/unit_tests/_primaite/_session/test_episode_schedule.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest
 import yaml

--- a/tests/unit_tests/_primaite/_simulator/init.py
+++ b/tests/unit_tests/_primaite/_simulator/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_domain/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_domain/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_domain/test_account.py
+++ b/tests/unit_tests/_primaite/_simulator/_domain/test_account.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Test the account module of the simulator."""
 import pytest

--- a/tests/unit_tests/_primaite/_simulator/_domain/test_controller.py
+++ b/tests/unit_tests/_primaite/_simulator/_domain/test_controller.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_file_system/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_file_system/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_file_system/test_file.py
+++ b/tests/unit_tests/_primaite/_simulator/_file_system/test_file.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import warnings

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_file_system/test_file_actions.py
+++ b/tests/unit_tests/_primaite/_simulator/_file_system/test_file_actions.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Tuple

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_file_system/test_file_system.py
+++ b/tests/unit_tests/_primaite/_simulator/_file_system/test_file_system.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.file_system.file import File
--- a/tests/unit_tests/_primaite/_simulator/_file_system/test_file_system_actions.py
+++ b/tests/unit_tests/_primaite/_simulator/_file_system/test_file_system_actions.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Tuple

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_file_system/test_folder.py
+++ b/tests/unit_tests/_primaite/_simulator/_file_system/test_folder.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.file_system.file import File
--- a/tests/unit_tests/_primaite/_simulator/_file_system/test_folder_actions.py
+++ b/tests/unit_tests/_primaite/_simulator/_file_system/test_folder_actions.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import warnings
 from typing import Tuple

--- a/tests/unit_tests/_primaite/_simulator/_network/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_network/_hardware/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_hardware/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/test_acl.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/test_acl.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/test_router.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/test_router.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address

 from primaite.simulator.network.hardware.nodes.network.router import ACLAction, Router
--- a/tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/test_switch.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/test_switch.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
--- a/tests/unit_tests/_primaite/_simulator/_network/_hardware/test_nic.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_hardware/test_nic.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import re
 from ipaddress import IPv4Address

--- a/tests/unit_tests/_primaite/_simulator/_network/_hardware/test_node_actions.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_hardware/test_node_actions.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.file_system.file import File
--- a/tests/unit_tests/_primaite/_simulator/_network/_transmission/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_transmission/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_network/_transmission/test_data_link_layer.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_transmission/test_data_link_layer.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.network.protocols.icmp import ICMPPacket
--- a/tests/unit_tests/_primaite/_simulator/_network/_transmission/test_network_layer.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/_transmission/test_network_layer.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.network.protocols.icmp import ICMPPacket, ICMPType
--- a/tests/unit_tests/_primaite/_simulator/_network/test_container.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/test_container.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import json

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_network/test_utils.py
+++ b/tests/unit_tests/_primaite/_simulator/_network/test_utils.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from primaite.simulator.network.utils import convert_bytes_to_megabits, convert_megabits_to_bytes


--- a/tests/unit_tests/_primaite/_simulator/_system/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_system/_applications/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_applications/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_system/_applications/_red_applications/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_applications/_red_applications/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_system/_applications/_red_applications/test_data_manipulation_bot.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_applications/_red_applications/test_data_manipulation_bot.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.network.hardware.base import Node
--- a/tests/unit_tests/_primaite/_simulator/_system/_applications/_red_applications/test_dos_bot.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_applications/_red_applications/test_dos_bot.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_system/_applications/test_application_actions.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_applications/test_application_actions.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_system/_applications/test_applications.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_applications/test_applications.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from primaite.simulator.system.applications.application import ApplicationOperatingState
 from primaite.simulator.system.software import SoftwareHealthState

--- a/tests/unit_tests/_primaite/_simulator/_system/_applications/test_database_client.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_applications/test_database_client.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address
 from typing import Tuple
 from uuid import uuid4
--- a/tests/unit_tests/_primaite/_simulator/_system/_applications/test_web_browser.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_applications/test_web_browser.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
--- a/tests/unit_tests/_primaite/_simulator/_system/_services/init.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_services/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/tests/unit_tests/_primaite/_simulator/_system/_services/test_database.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_services/test_database.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.network.hardware.base import Node
--- a/tests/unit_tests/_primaite/_simulator/_system/_services/test_dns_client.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_services/test_dns_client.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_system/_services/test_dns_server.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_services/test_dns_server.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_system/_services/test_ftp_client.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_services/test_ftp_client.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_system/_services/test_ftp_server.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_services/test_ftp_server.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.file_system.file_system_item_abc import FileSystemItemHealthStatus
--- a/tests/unit_tests/_primaite/_simulator/_system/_services/test_service_actions.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_services/test_service_actions.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from primaite.simulator.system.services.service import ServiceOperatingState
 from primaite.simulator.system.software import SoftwareHealthState

--- a/tests/unit_tests/_primaite/_simulator/_system/_services/test_services.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_services/test_services.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from uuid import uuid4

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_system/_services/test_web_server.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/_services/test_web_server.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
--- a/tests/unit_tests/_primaite/_simulator/_system/core/test_sys_log.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/core/test_sys_log.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from uuid import uuid4

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/_system/test_software.py
+++ b/tests/unit_tests/_primaite/_simulator/_system/test_software.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Dict

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/test_core.py
+++ b/tests/unit_tests/_primaite/_simulator/test_core.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Callable, Dict, List, Literal, Tuple

 import pytest
--- a/tests/unit_tests/_primaite/_simulator/test_sim_container.py
+++ b/tests/unit_tests/_primaite/_simulator/test_sim_container.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from primaite.simulator.sim_container import Simulation
				`@@ -0,0 +1 @@`
				`# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK`