[P] Integrate MapView testing into CI pipeline

.gitea/workflows/reset-docker.yaml

@@ -7,10 +7,13 @@ 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

@@ -28,24 +28,49 @@ jobs:
       - name: Clone repository
         run: git clone --revision ${{ gitea.sha }} --depth 1 ${{ gitea.server_url }}/${{ gitea.repository }}
 
+      - name: Start postgres_db container for testing
+        working-directory: IoT-Systems
+        run: docker-compose up -d postgres_db
+
       - name: Build Store testing container
         working-directory: IoT-Systems
         run: docker build -t local/store/${{gitea.sha}} -f store/Dockerfile-test .
 
       - name: Run Store tests
         working-directory: IoT-Systems
-        run: docker run --rm -it local/store/${{gitea.sha}}
+        run: docker run --network host --rm -it local/store/${{gitea.sha}}
 
       - name: Clean up containers
         if: ${{always()}}
         run: docker image rm local/store/${{gitea.sha}}
 
+      - name: Clean up docker-compose
+        if: ${{always()}}
+        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

@@ -0,0 +1,14 @@
+# 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

@@ -9,6 +9,7 @@ from config import STORE_HOST, STORE_PORT
 
 # Pydantic models
 class ProcessedAgentData(BaseModel):
+    id: int
     road_state: str
     user_id: int
     x: float
@@ -32,12 +33,17 @@ class ProcessedAgentData(BaseModel):
 
 
 class Datasource:
-    def __init__(self, user_id: int):
+    def __init__(self):
+        self.websocket: Connection | None = None
         self.index = 0
-        self.user_id = user_id
         self.connection_status = None
         self._new_points = []
-        asyncio.ensure_future(self.connect_to_server())
+        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)
@@ -46,11 +52,12 @@ class Datasource:
         return points
 
     async def connect_to_server(self):
-        uri = f"ws://{STORE_HOST}:{STORE_PORT}/ws/{self.user_id}"
+        uri = f"ws://{STORE_HOST}:{STORE_PORT}/ws"
         while True:
             Logger.debug("CONNECT TO SERVER")
             async with websockets.connect(uri) as websocket:
                 self.connection_status = "Connected"
+                self.websocket = websocket
                 try:
                     while True:
                         data = await websocket.recv()
@@ -60,6 +67,26 @@ class Datasource:
                     self.connection_status = "Disconnected"
                     Logger.debug("SERVER DISCONNECT")
 
+    def update_db_record_visibility(self, record_id):
+        if self.websocket:
+            data = json.dumps({"id": record_id})
+            asyncio.ensure_future(self.websocket.send(data))
+
+    def map_lat_lon_to_processed_agent_data(self, lat: float, lon: float) -> ProcessedAgentData | None:
+        distances = tuple((abs(lon - marker.latitude) ** 2 + abs(lat - marker.longitude) ** 2) ** 0.5 for marker in
+                          self._active_markers)
+
+        if len(distances) == 0:
+            return None
+
+        min_distance = min(distances)
+        marker = self._active_markers[distances.index(min_distance)]
+
+        if min_distance < 0.005:
+            return marker
+        else:
+            return None
+
     def handle_received_data(self, data):
         # Update your UI or perform actions with received data here
         Logger.debug(f"Received data: {data}")
@@ -70,6 +97,9 @@ class Datasource:
             ],
             key=lambda v: v.timestamp,
         )
+
+        self._active_markers += [i for i in processed_agent_data_list if i.road_state != 'normal']
+
         new_points = [
             (
                 processed_agent_data.longitude,

MapView/main.py

@@ -15,18 +15,31 @@ line_layer_colors = [
     [1, 0, 1, 1],
 ]
 
+
+def get_lat_lon(point: dict[str, float] | list[float] | tuple[float, float]) -> tuple[float, float] | None:
+    if isinstance(point, dict):
+        lat = point.get("lat")
+        lon = point.get("lon")
+    else:
+        lat, lon = point
+
+    if lat is None or lon is None:
+        return None
+    return lat, lon
+
+
 class MapViewApp(App):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
-        self.mapview = None
-        self.datasource = Datasource(user_id=1)
+        self.mapview: MapView | None = None
+        self.datasource = Datasource()
         self.line_layers = dict()
         self.car_markers = dict()
 
         # додати необхідні змінні
-        self.bump_markers = []
-        self.pothole_markers = []
+        self.bump_markers: list[MapMarker] = []
+        self.pothole_markers: list[MapMarker] = []
 
     def on_start(self):
         """
@@ -50,7 +63,7 @@ class MapViewApp(App):
 
             # Оновлює лінію маршрута
             if user_id not in self.line_layers:
-                self.line_layers[user_id] = LineMapLayer(color = line_layer_colors[user_id % len(line_layer_colors)])
+                self.line_layers[user_id] = LineMapLayer(color=line_layer_colors[user_id % len(line_layer_colors)])
                 self.mapview.add_layer(self.line_layers[user_id])
 
             self.line_layers[user_id].add_point((lat, lon))
@@ -91,13 +104,16 @@ class MapViewApp(App):
         if user_id == config.TRACK_ID:
             self.mapview.center_on(lat, lon)
 
-    def set_pothole_marker(self, point):
-        if isinstance(point, dict):
-            lat = point.get("lat")
-            lon = point.get("lon")
-        else:
-            lat, lon = point
+    def map_lat_lon_to_marker(self, lat: float, lon: float) -> MapMarker | None:
+        flt = filter(lambda marker: lon == marker.lat and lat == marker.lon, self.pothole_markers + self.bump_markers)
 
+        try:
+            return next(flt)
+        except StopIteration:
+            return None
+
+    def set_pothole_marker(self, point):
+        lat, lon = get_lat_lon(point)
         if lat is None or lon is None:
             return
 
@@ -111,24 +127,48 @@ class MapViewApp(App):
         self.pothole_markers.append(marker)
 
     def set_bump_marker(self, point):
-        if isinstance(point, dict):
-            lat = point.get("lat")
-            lon = point.get("lon")
-        else:
-            lat, lon = point
-
+        lat, lon = get_lat_lon(point)
         if lat is None or lon is None:
             return
-        
+
         marker = MapMarker(
             lat=lat,
             lon=lon,
-            source="images/bump.png"  
+            source="images/bump.png"
         )
 
         self.mapview.add_marker(marker)
         self.bump_markers.append(marker)
 
+    def delete_pothole_marker(self, point):
+        lat, lon = get_lat_lon(point)
+        if lat is None or lon is None:
+            return
+
+        clicked_marker_data = self.datasource.map_lat_lon_to_processed_agent_data(lat, lon)
+
+        if not clicked_marker_data:
+            return
+
+        clicked_marker = self.map_lat_lon_to_marker(clicked_marker_data.latitude, clicked_marker_data.longitude)
+
+        if clicked_marker is None:
+            return
+
+        self.mapview.remove_marker(clicked_marker)
+
+        if clicked_marker in self.pothole_markers:
+            self.pothole_markers.pop(self.pothole_markers.index(clicked_marker))
+        elif clicked_marker in self.bump_markers:
+            self.bump_markers.pop(self.bump_markers.index(clicked_marker))
+
+        self.datasource.update_db_record_visibility(clicked_marker_data.id)
+
+    def on_touch_down(self, widget, touch):
+        if touch.button == "right":
+            coordinate = self.mapview.get_latlon_at(touch.x, touch.y, self.mapview.zoom)
+            self.delete_pothole_marker(coordinate)
+            return True
 
     def build(self):
         """
@@ -141,6 +181,8 @@ class MapViewApp(App):
             lon=30.5234
         )
 
+        self.mapview.bind(on_touch_down=self.on_touch_down)
+
         return self.mapview
 
 

MapView/test-entry.sh

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

MapView/tests/test_mp.py

@@ -0,0 +1,137 @@
+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

@@ -0,0 +1,81 @@
+@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/general-sequence.puml

@@ -0,0 +1,22 @@
+@startuml
+actor Worker as worker
+participant Agent as agent
+participant "Edge" as edge
+participant "Hub" as hub
+participant "Store" as store
+participant "MapView" as mapview
+actor Spectator as spectator
+
+worker -> agent : Start agent
+agent -> edge : Send sensor data
+edge -> edge : Classify road state
+edge -> hub : Send processed data
+hub -> hub : Save processed data
+hub -> store : Send processed data batch
+store -> store : Save processed data batch
+store -> mapview : Send new rows
+mapview -> spectator : Show updated paths and markers
+spectator -> mapview : Click on markers
+mapview -> spectator : Hide clicked markers
+mapview -> store : Save display preference
+@enduml

diagrams/main-activity-diagram.puml

@@ -0,0 +1,15 @@
+@startuml
+|Користувач|
+start
+:Натискає на іконку ями;
+|Система|
+:Запитує підтвердження видалення ями;
+|Користувач|
+:Підтверджує видалення ями;
+|Система|
+:Модифікує запис про яму;
+note right #ff9999: Можлива виключна ситуація 1
+:Видаляє яму;
+|Користувач|
+stop
+@enduml

store/Dockerfile-test

@@ -6,6 +6,7 @@ WORKDIR /app
 COPY store/requirements.txt .
 
 RUN pip install --no-cache-dir -r requirements.txt
+RUN pip install --root-user-action ignore --no-cache-dir pytest httpx
 # Copy the entire application into the container
 COPY store/. .
 # Run the main.py script inside the container when it starts

store/main.py

@@ -39,15 +39,18 @@ subscriptions: Set[WebSocket] = set()
 
 
 # FastAPI WebSocket endpoint
-@app.websocket("/ws/{user_id}")
-async def websocket_endpoint(websocket: WebSocket, user_id: int):
+@app.websocket("/ws")
+async def websocket_endpoint(websocket: WebSocket):
     await websocket.accept()
 
     subscriptions.add(websocket)
 
     try:
         # send already available data
-        r = processed_agent_data.select().order_by(processed_agent_data.c.timestamp)
+        r = processed_agent_data.select() \
+                                .where(processed_agent_data.c.visible == True) \
+                                .order_by(processed_agent_data.c.timestamp)
+
         session = SessionLocal()
         stored_data = session.execute(r).fetchall()
         session.close() 

store/test-entry.sh

@@ -1,3 +1,4 @@
 #!/bin/sh
 
 PYTHONPATH=$PWD python3 test/main_test.py
+PYTHONPATH=$PWD python3 -m pytest test_db.py