Feature/add ruff workflow (#26)

Co-authored-by: kroskinskiis <ivo.kroskinski@tno.nl>

Author: xncz8h

.github/workflows/format.yml

@@ -0,0 +1,25 @@
+name: Pyformat
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ruff
+        pip install poetry
+        poetry install
+    - name: Analysing the code with Ruff
+      run: |
+        ruff format --check

examples/pong_example.py

@@ -23,24 +23,24 @@ def capability_pong_callback(command: Command) -> ResultStructure:
         description="If ping, return pong",
         value="pong",
         constant=True,
-        external=False)
+        external=False,
+    )
 
     context = command.command.context
 
     return ResultStructure(
-        state="success", context=context, variables={"result": result})
+        state="success", context=context, variables={"result": result}
+    )
 
 
 def main(mqtt_broker: str, mqtt_port: int, username: str, password: str) -> None:
-
     finId = "soarca-fin--pingpong-f877bb3a-bb37-429e-8ece-2d4286cf326d"
     agentName = "soarca-fin-pong-f896bb3b-bb37-429e-8ece-2d4286cf326d"
     externalReferenceName = "external-reference-example-name"
     capabilityId = "mod-pong--e896aa3b-bb37-429e-8ece-2d4286cf326d"
 
     # Create AgentStructure
-    agent = AgentStructure(
-        name=agentName)
+    agent = AgentStructure(name=agentName)
 
     # Create ExternalReference
     external_reference = ExternalReference(name=externalReferenceName)
@@ -51,18 +51,18 @@ def main(mqtt_broker: str, mqtt_port: int, username: str, password: str) -> None
         description="step description",
         external_references=[external_reference],
         command="pong",
-        target=agentName)
+        target=agentName,
+    )
 
     # Create CapabilityStructure
     capability_structure = CapabilityStructure(
         capability_id=capabilityId,
         type=WorkFlowStepEnum.action,
         name="Ping Pong capability",
         version="0.0.1",
-        step={
-            "test": step_structure},
-        agent={
-            "testagent": agent})
+        step={"test": step_structure},
+        agent={"testagent": agent},
+    )
 
     # Create Soarca fin
     fin = SoarcaFin(finId)

soarca_fin_python_library/abstract_classes/i_executor.py

@@ -4,7 +4,6 @@
 
 
 class IExecutor(ABC):
-
     @abstractmethod
     def queue_message(self, message: Message) -> None:
         pass

soarca_fin_python_library/abstract_classes/i_mqtt_client.py

@@ -5,13 +5,15 @@
 
 
 class IMQTTClient(ABC):
-
     @abstractmethod
-    def on_connect(self, client: Client,
-                   userdata,
-                   connect_flags: ConnectFlags,
-                   reason_code: ReasonCode,
-                   properties: Properties):
+    def on_connect(
+        self,
+        client: Client,
+        userdata,
+        connect_flags: ConnectFlags,
+        reason_code: ReasonCode,
+        properties: Properties,
+    ):
         pass
 
     @abstractmethod

soarca_fin_python_library/abstract_classes/i_parser.py

@@ -4,7 +4,6 @@
 
 
 class IParser(ABC):
-
     @abstractmethod
     def parse_on_message(self, message: mqtt.MQTTMessage) -> Message:
         pass

soarca_fin_python_library/abstract_classes/i_soarca_fin.py

@@ -4,9 +4,10 @@
 
 
 class ISoarcaFin(ABC):
-
     @abstractmethod
-    def set_config_MQTT_server(self, host: str, port: str, username: str, password: str) -> None:
+    def set_config_MQTT_server(
+        self, host: str, port: str, username: str, password: str
+    ) -> None:
         pass
 
     @abstractmethod

soarca_fin_python_library/executor.py

@@ -21,7 +21,6 @@
 
 
 class Executor(IExecutor):
-
     def __init__(self, executor_id: str, callback, queue: Queue, mqttc: Client):
         self.queue: Queue[Message] = queue
         self.mqttc: Client = mqttc
@@ -41,7 +40,6 @@ def stop_executor(self):
 
     # Main executor loop. Polls for messages in the queue and parsers them.
     def start_executor(self):
-
         log.info("Thread started for %s", self.id)
         self.running = True
 
@@ -56,7 +54,9 @@ def start_executor(self):
                             self._put_message_in_queue(message)
                         else:
                             log.debug(
-                                "Received unknown (n)ack with message_id: %s", message.message_id)
+                                "Received unknown (n)ack with message_id: %s",
+                                message.message_id,
+                            )
                     case Register():
                         self._handle_register_message(message)
                     case Unregister():
@@ -68,7 +68,8 @@ def start_executor(self):
                     case _:
                         # Send Nack?
                         log.warning(
-                            "Unimplemented command: %s", message.model_dump_json())
+                            "Unimplemented command: %s", message.model_dump_json()
+                        )
             except Empty:
                 pass
 
@@ -115,7 +116,9 @@ def _handle_unregister_self_message(self, message: UnregisterSelf):
                 retries -= 1
                 if retries == 0:
                     log.fatal(
-                        "Did not receive an ack for message %s. Aborting...", message.message_id)
+                        "Did not receive an ack for message %s. Aborting...",
+                        message.message_id,
+                    )
                     exit(-1)
 
     # Handles self generated register message.
@@ -147,7 +150,9 @@ def _handle_register_message(self, message: Register):
                 retries -= 1
                 if retries == 0:
                     log.fatal(
-                        "Did not receive an ack for message %s. Aborting...", message.message_id)
+                        "Did not receive an ack for message %s. Aborting...",
+                        message.message_id,
+                    )
                     exit(-1)
 
     # Handles a command message from SOARCA.
@@ -164,8 +169,7 @@ def _handle_command_message(self, message: Command):
         message_id = str(uuid1())
         timestamp = datetime.now(timezone.utc).isoformat()
         meta = Meta(timestamp=timestamp, sender_id=self.id)
-        result = Result(message_id=message_id, meta=meta,
-                        result=resultStruct)
+        result = Result(message_id=message_id, meta=meta, result=resultStruct)
 
         # Send result back
         self._send_message_as_json(result)
@@ -187,7 +191,9 @@ def _handle_command_message(self, message: Command):
             if retries == 0:
                 self.acks.remove(message_id)
                 log.error(
-                    "Did not receive an acknowledgement for message %s. Skipping message...", result.message_id)
+                    "Did not receive an acknowledgement for message %s. Skipping message...",
+                    result.message_id,
+                )
                 break
 
     # Publishes a message as JSON on a topic. Default topic is self.id.
@@ -221,12 +227,12 @@ def _wait_for_ack(self, message_id: str):
                         log.info("Received ack for message: %s", message_id)
                         return
                     case Nack():
-                        log.warning(
-                            "Received nack for message: %s", message_id)
+                        log.warning("Received nack for message: %s", message_id)
                         raise RuntimeError("Received a nack")
                     case _:
                         raise TypeError(
-                            f"Unexpected message type {message.model_dump_json()}")
+                            f"Unexpected message type {message.model_dump_json()}"
+                        )
 
             except Empty as e:
                 log.warning("Did not receive an ack")

soarca_fin_python_library/models/ack.py

@@ -1,4 +1,3 @@
-
 from soarca_fin_python_library.models.message import Message
 
 

soarca_fin_python_library/models/command_sub_structure.py

@@ -1,7 +1,9 @@
 from typing import Optional
 from pydantic import BaseModel
 
-from soarca_fin_python_library.models.authentication_information import AuthenticationInformation
+from soarca_fin_python_library.models.authentication_information import (
+    AuthenticationInformation,
+)
 from soarca_fin_python_library.models.context import Context
 from soarca_fin_python_library.models.variable import Variable
 

soarca_fin_python_library/models/meta.py

@@ -3,4 +3,4 @@
 
 class Meta(BaseModel):
     timestamp: str
-    sender_id: str
+    sender_id: str