Merge remote-tracking branch 'origin/dev' into feature/901-change-functionality-acl-rules

src/primaite/common/__init__.py

@@ -1,2 +1,2 @@
-# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+# Crown Owned Copyright (C) Dstl 2023. DEFCON 703. Shared in confidence.
 """Objects which are shared between many PrimAITE modules."""

src/primaite/common/custom_typing.py

@@ -1,8 +1,8 @@
-from typing import Type, Union
+from typing import Union
 
 from primaite.nodes.active_node import ActiveNode
 from primaite.nodes.passive_node import PassiveNode
 from primaite.nodes.service_node import ServiceNode
 
-NodeUnion: Type = Union[ActiveNode, PassiveNode, ServiceNode]
+NodeUnion = Union[ActiveNode, PassiveNode, ServiceNode]
 """A Union of ActiveNode, PassiveNode, and ServiceNode."""

src/primaite/common/enums.py

@@ -1,4 +1,4 @@
-# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+# Crown Owned Copyright (C) Dstl 2023. DEFCON 703. Shared in confidence.
 """Enumerations for APE."""
 
 from enum import Enum, IntEnum
@@ -148,6 +148,7 @@ class ActionType(Enum):
     ANY = 2
 
 
+# TODO: this is not used anymore, write a ticket to delete it.
 class ObservationType(Enum):
     """Observation type enumeration."""
 

src/primaite/common/protocol.py

@@ -1,21 +1,21 @@
-# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+# Crown Owned Copyright (C) Dstl 2023. DEFCON 703. Shared in confidence.
 """The protocol class."""
 
 
 class Protocol(object):
     """Protocol class."""
 
-    def __init__(self, _name):
+    def __init__(self, _name: str) -> None:
         """
         Initialise a protocol.
 
         :param _name: The name of the protocol
         :type _name: str
         """
-        self.name = _name
-        self.load = 0  # bps
+        self.name: str = _name
+        self.load: int = 0  # bps
 
-    def get_name(self):
+    def get_name(self) -> str:
         """
         Gets the protocol name.
 
@@ -24,7 +24,7 @@ class Protocol(object):
         """
         return self.name
 
-    def get_load(self):
+    def get_load(self) -> int:
         """
         Gets the protocol load.
 
@@ -33,7 +33,7 @@ class Protocol(object):
         """
         return self.load
 
-    def add_load(self, _load):
+    def add_load(self, _load: int) -> None:
         """
         Adds load to the protocol.
 
@@ -42,6 +42,6 @@ class Protocol(object):
         """
         self.load += _load
 
-    def clear_load(self):
+    def clear_load(self) -> None:
         """Clears the load on this protocol."""
         self.load = 0

src/primaite/common/service.py

@@ -1,4 +1,4 @@
-# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+# Crown Owned Copyright (C) Dstl 2023. DEFCON 703. Shared in confidence.
 """The Service class."""
 
 from primaite.common.enums import SoftwareState
@@ -7,7 +7,7 @@ from primaite.common.enums import SoftwareState
 class Service(object):
     """Service class."""
 
-    def __init__(self, name: str, port: str, software_state: SoftwareState):
+    def __init__(self, name: str, port: str, software_state: SoftwareState) -> None:
         """
         Initialise a service.
 
@@ -15,12 +15,12 @@ class Service(object):
         :param port: The service port.
         :param software_state: The service SoftwareState.
         """
-        self.name = name
-        self.port = port
-        self.software_state = software_state
-        self.patching_count = 0
+        self.name: str = name
+        self.port: str = port
+        self.software_state: SoftwareState = software_state
+        self.patching_count: int = 0
 
-    def reduce_patching_count(self):
+    def reduce_patching_count(self) -> None:
         """Reduces the patching count for the service."""
         self.patching_count -= 1
         if self.patching_count <= 0: