[P] Update diagram to reflect projet usecase

.gitea/workflows/reset-docker.yaml

@@ -7,13 +7,10 @@ jobs:
     name: Reset docker state
     steps:
       - name: Stop all containers
-        if: ${{always()}}
         run: docker stop $(docker ps -a | cut -d " " -f 1 | tail -n +2)
       
       - name: Remove all containers
-        if: ${{always()}}
         run: docker rm $(docker ps -a | cut -d " " -f 1 | tail -n +2)
 
       - name: Remove extra volumes
-        if: ${{always()}}
         run: docker volume rm road_vision_postgres_data road_vision_pgadmin-data

.gitea/workflows/tests.yaml

@@ -49,28 +49,12 @@ jobs:
         working-directory: IoT-Systems
         run: docker-compose down -v --remove-orphans
 
-  mapview-test:
-    name: MapView testing
-    runs-on: host-arch-x86_64
-    steps:
-      - name: Clone repository
-        run: git clone --revision ${{ gitea.sha }} --depth 1 ${{ gitea.server_url }}/${{ gitea.repository }}
-
-      - name: Build MapView testing container
-        working-directory: IoT-Systems
-        run: docker build -t local/mapview -f MapView/Dockerfile-test .
-
-      - name: Run MapView tests
-        working-directory: IoT-Systems
-        run: docker run --rm -it -v $PWD/MapView:/app:ro local/mapview
-
   integration-smoke-test:
     name: Integration smoke testing
     runs-on: host-arch-x86_64
     needs:
       - hub-test
       - store-test
-      - mapview-test
     steps:
       - name: Clone repository
         run: git clone --revision ${{ gitea.sha }} --depth 1 ${{ gitea.server_url }}/${{ gitea.repository }}

MapView/Dockerfile-test

@@ -1,14 +0,0 @@
-# Use the official Python image as the base image
-FROM python:latest
-# Set the working directory inside the container
-WORKDIR /app
-# Copy the requirements.txt file and install dependencies
-COPY MapView/requirements.txt .
-RUN sed -i 's/==.*//' requirements.txt
-
-RUN apt update && apt install -y libgl-dev libsdl1.2-dev
-
-RUN pip install --no-cache-dir -r requirements.txt
-RUN pip install --root-user-action ignore --no-cache-dir python-unittest kivy[base] pygame
-
-CMD ["./test-entry.sh"]

MapView/datasource.py

@@ -39,11 +39,7 @@ class Datasource:
         self.connection_status = None
         self._new_points = []
         self._active_markers = []
-
-        try:
         asyncio.ensure_future(self.connect_to_server())
-        except RuntimeError:
-            Logger.info("No event loop detected, running in offline mode")
 
     def get_new_points(self):
         Logger.debug(self._new_points)

MapView/test-entry.sh

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-PYTHONPATH=$PWD python3 -m unittest tests.test_mp

MapView/tests/test_mp.py

@@ -1,137 +0,0 @@
-import unittest
-import sys
-from unittest.mock import Mock
-
-sys.modules['lineMapLayer'] = Mock()
-sys.modules['config'] = Mock()
-
-from main import get_lat_lon, MapViewApp
-from datasource import Datasource as DataSourceClass
-
-
-# -----------------------
-# get_lat_lon
-# -----------------------
-class TestGetLatLon(unittest.TestCase):
-
-    def test_dict(self):
-        point = {"lat": 50.45, "lon": 30.52}
-        self.assertEqual(get_lat_lon(point), (50.45, 30.52))
-
-    def test_tuple(self):
-        point = (50.45, 30.52)
-        self.assertEqual(get_lat_lon(point), (50.45, 30.52))
-
-    def test_list(self):
-        point = [50.45, 30.52]
-        self.assertEqual(get_lat_lon(point), (50.45, 30.52))
-
-    def test_invalid(self):
-        point = {"lat": None, "lon": 30.52}
-        self.assertIsNone(get_lat_lon(point))
-
-
-# -----------------------
-# map_lat_lon_to_marker
-# -----------------------
-class TestMapLatLonToMarker(unittest.TestCase):
-
-    def setUp(self):
-        self.instance = MapViewApp()
-
-    def test_marker_found(self):
-        marker = Mock()
-        marker.lat = 30.52
-        marker.lon = 50.45
-
-        self.instance.pothole_markers = [marker]
-        self.instance.bump_markers = []
-
-        result = self.instance.map_lat_lon_to_marker(50.45, 30.52)
-
-        self.assertEqual(result, marker)
-
-    def test_marker_not_found(self):
-        self.instance.pothole_markers = []
-        self.instance.bump_markers = []
-
-        result = self.instance.map_lat_lon_to_marker(50.45, 30.52)
-
-        self.assertIsNone(result)
-
-
-# -----------------------
-# map_lat_lon_to_processed_agent_data
-# -----------------------
-class TestMapLatLonToProcessedAgentData(unittest.TestCase):
-
-    def setUp(self):
-        self.instance = DataSourceClass()
-
-    def test_returns_marker(self):
-        marker = Mock()
-        marker.latitude = 30.52
-        marker.longitude = 50.45
-
-        self.instance._active_markers = [marker]
-
-        result = self.instance.map_lat_lon_to_processed_agent_data(50.45, 30.52)
-
-        self.assertIsNotNone(result)
-        self.assertEqual(result, marker)
-
-    def test_marker_is_close_enough(self):
-        marker = Mock()
-        marker.latitude = 30.521
-        marker.longitude = 50.452
-
-        self.instance._active_markers = [marker]
-
-        result = self.instance.map_lat_lon_to_processed_agent_data(50.45, 30.52)
-
-        self.assertIsNotNone(result)
-        self.assertEqual(result, marker)
-
-    def test_marker_is_too_far(self):
-        marker = Mock()
-        marker.latitude = 30.524
-        marker.longitude = 50.454
-
-        self.instance._active_markers = [marker]
-
-        result = self.instance.map_lat_lon_to_processed_agent_data(50.45, 30.52)
-
-        self.assertIsNone(result)
-
-    def test_return_closer_marker(self):
-        marker1 = Mock()
-        marker1.latitude = 30.521
-        marker1.longitude = 50.451
-
-        marker2 = Mock()
-        marker2.latitude = 30.524
-        marker2.longitude = 50.454
-
-        self.instance._active_markers = [marker1, marker2]
-
-        result = self.instance.map_lat_lon_to_processed_agent_data(50.452, 30.522)
-        self.assertIsNotNone(result)
-        self.assertEqual(result, marker1)
-
-        result = self.instance.map_lat_lon_to_processed_agent_data(50.453, 30.523)
-        self.assertIsNotNone(result)
-        self.assertEqual(result, marker2)
-
-        result = self.instance.map_lat_lon_to_processed_agent_data(50.459, 30.529)
-        self.assertIsNone(result)
-
-    def test_empty_markers(self):
-        self.instance._active_markers = []
-
-        result = self.instance.map_lat_lon_to_processed_agent_data(50.45, 30.52)
-
-        self.assertIsNone(result)
-
-
-if __name__ == "__main__":
-    unittest.main()

diagrams/architecture-diagram.puml

@@ -1,81 +0,0 @@
-@startuml
-interface MQTT as mqtt1
-interface MQTT as mqtt2
-interface HTTP as http1
-interface HTTP as http2
-interface WebSocket
-
-node Agent {
-  component Accelerometer
-  component GPS
-  component CarParkingSlots
-  component "Data Aggregator" as agent_agg
-}
-
-node Edge {
-  component AgentMQTTAdapter
-  component AgentDataProcessor
-  component HubMQTTAdapter
-  component HubHTTPAdapter
-}
-
-node Hub {
-  component EdgeHTTPAdapter
-  component EdgeMQTTAdapter
-  component Aggregator
-  component StoreHTTPAdapter
-  component Redis
-}
-
-node Store {
-  component "HTTP Rest API" as store_http
-  component "SQL Adapter" as store_sql
-  component "Websocket API" as store_ws
-}
-
-node MapView {
-  component "Store Processor" as mv_sp
-  component "Input Handler" as mv_ih
-  component "Map"
-}
-
-component PostgreSQL
-
-agent_agg --> Accelerometer
-agent_agg --> GPS
-agent_agg --> CarParkingSlots
-
-agent_agg -> mqtt1
-
-mqtt1 <- AgentMQTTAdapter
-AgentMQTTAdapter -> AgentDataProcessor
-AgentDataProcessor --> HubMQTTAdapter
-AgentDataProcessor --> HubHTTPAdapter
-HubMQTTAdapter --> mqtt2
-HubHTTPAdapter --> http1
-
-mqtt2 <-- EdgeMQTTAdapter
-http1 <-- EdgeHTTPAdapter
-EdgeMQTTAdapter --> Aggregator
-EdgeHTTPAdapter --> Aggregator
-Aggregator <--> Redis
-StoreHTTPAdapter <-- Aggregator
-
-http2 <-- StoreHTTPAdapter
-store_http --> http2
-store_http -> store_sql
-store_sql <- store_ws
-store_ws --> WebSocket
-
-store_sql <--> PostgreSQL
-
-WebSocket <-- mv_sp
-mv_sp <-- mv_ih
-mv_sp --> Map
-
-actor Spectator as user
-
-Map --> user
-mv_ih <-- user
-
-@enduml

diagrams/use-case.puml

@@ -0,0 +1,23 @@
+@startuml
+rectangle IoT-Systems {
+  usecase "Collect telemetry (accelerometer + GPS)" as uc1
+  usecase "Send telemetry" as uc2
+  usecase "Process telemetry" as uc3
+  usecase "Determine road condition (pothole / bump /\nnormal)" as uc4
+  usecase "View road defect marks" as uc5
+  usecase "View route on map" as uc6
+}
+
+rectangle "The user is the card operator" as uc10
+rectangle "Sensor Agent\n(Device/STM32/Emulator)" as uc11
+
+uc11 - uc1
+uc11 - uc2
+
+uc10 - uc5
+uc10 - uc6
+
+uc2 -.|> uc3 : <<include>>
+uc3 -.|> uc4 : <<include>>
+
+@enduml