Merge pull request #821 from OpenTrafficCam/bug/9548-incomplete-filenames-in-otanalytics-if-video-name-has-multiple-dots

bug/9548-incomplete-filenames-in-otanalytics-if-video-name-has-multiple-dots

Author: schubsen

.github/workflows/system-test.yml

@@ -0,0 +1,34 @@
+---
+name: System Test With Pytest
+
+on:
+  # Run tests each time a PR is opened or changed.
+  # Allow other Workflows (e.g., build workflows) to call this workflow.
+  pull_request:
+  workflow_call:
+
+permissions: read-all
+
+jobs:
+  test:
+    name: Execute system tests across various operating systems and Python versions.
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        py: ["3.12"]
+      fail-fast: true
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+      - name: Set up Python ${{ matrix.py }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.py }}
+      - name: Run Python System Tests
+        uses: platomo/test-python-app-action@v4
+        timeout-minutes: 60
+        with:
+          py-version: ${{ matrix.py }}
+          package-path: OTAnalytics
+          test-path: tests/system

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.py }}
-      - name: Run Python Tests
+      - name: Run Python Unit Tests
         uses: platomo/test-python-app-action@v4
         timeout-minutes: 60
         with:

OTAnalytics/adapter_ui/dummy_viewmodel.py

@@ -33,6 +33,7 @@
     RELATIVE_SECTION_OFFSET,
     SUPPORTED_FORMATS,
 )
+from OTAnalytics.adapter_ui.file_export_dto import ExportFileDto
 from OTAnalytics.adapter_ui.flow_adapter import (
     GeometricCenterCalculator,
     InnerSegmentsCenterCalculator,
@@ -61,6 +62,7 @@
 )
 from OTAnalytics.application.config import (
     CONTEXT_FILE_TYPE_EVENTS,
+    CONTEXT_FILE_TYPE_ROAD_USER_ASSIGNMENTS,
     CONTEXT_FILE_TYPE_TRACK_STATISTICS,
     CUTTING_SECTION_MARKER,
     OTCONFIG_FILE_TYPE,
@@ -97,6 +99,7 @@
     UpdateSectionCoordinates,
 )
 from OTAnalytics.application.use_cases.export_events import (
+    EventExportSpecification,
     EventListExporter,
     ExporterNotFoundError,
 )
@@ -109,6 +112,7 @@
     ExportSpecification,
 )
 from OTAnalytics.application.use_cases.save_otflow import NoSectionsToSave
+from OTAnalytics.application.use_cases.suggest_save_path import SavePathSuggestion
 from OTAnalytics.application.use_cases.track_statistics_export import (
     TrackStatisticsExportSpecification,
 )
@@ -611,13 +615,13 @@ def show_current_project(self, _: Any = None) -> None:
         self.frame_project.update(name=project.name, start_date=project.start_date)
 
     async def save_otconfig(self) -> None:
-        suggested_save_path = self._application.suggest_save_path(OTCONFIG_FILE_TYPE)
+        save_suggestion = self._application.suggest_save_path(OTCONFIG_FILE_TYPE)
         configuration_file = await self._ui_factory.ask_for_save_file_path(
             title="Save configuration as",
             filetypes=[(f"{OTCONFIG_FILE_TYPE} file", f"*.{OTCONFIG_FILE_TYPE}")],
             defaultextension=f".{OTCONFIG_FILE_TYPE}",
-            initialfile=suggested_save_path.name,
-            initialdir=suggested_save_path.parent,
+            initialfile=save_suggestion.file_path.name,
+            initialdir=save_suggestion.save_directory,
         )
         if not configuration_file:
             return
@@ -870,16 +874,16 @@ def _load_otflow(self, otflow_file: Path) -> None:
         self.refresh_items_on_canvas()
 
     async def save_configuration(self) -> None:
-        suggested_save_path = self._application.suggest_save_path(OTCONFIG_FILE_TYPE)
+        save_suggestion = self._application.suggest_save_path(OTCONFIG_FILE_TYPE)
         configuration_file = await self._ui_factory.ask_for_save_file_path(
             title="Save configuration as",
             filetypes=[
                 (f"{OTCONFIG_FILE_TYPE} file", f"*.{OTCONFIG_FILE_TYPE}"),
                 (f"{OTFLOW_FILE_TYPE} file", f"*.{OTFLOW_FILE_TYPE}"),
             ],
             defaultextension=f".{OTCONFIG_FILE_TYPE}",
-            initialfile=suggested_save_path.name,
-            initialdir=suggested_save_path.parent,
+            initialfile=save_suggestion.file_path.name,
+            initialdir=save_suggestion.save_directory,
         )
         if not configuration_file.stem:
             return
@@ -1389,33 +1393,40 @@ async def export_events(self) -> None:
             for key, exporter in self._event_list_export_formats.items()
         }
         try:
-            event_list_exporter, file = await self._configure_event_exporter(
+            event_list_exporter, export_config = await self._configure_event_exporter(
                 export_format_extensions
             )
-            self._application.export_events(Path(file), event_list_exporter)
+            specification = EventExportSpecification(
+                export_directory=export_config.export_directory,
+                export_filename_stem=export_config.file_stem,
+                export_mode=OVERWRITE,
+            )
+            self._application.export_events(specification, event_list_exporter)
             logger().info(
-                f"Exporting eventlist using {event_list_exporter.get_name()} to {file}"
+                f"Exporting eventlist using {event_list_exporter.get_name()} to "
+                f"{export_config.as_file_path()}"
             )
         except CancelExportFile:
             logger().info("User canceled configuration of export")
 
     async def _configure_event_exporter(
         self, export_format_extensions: dict[str, str]
-    ) -> tuple[EventListExporter, Path]:
+    ) -> tuple[EventListExporter, ExportFileDto]:
         export_config = await self._ui_factory.configure_export_file(
             title="Export events",
             export_format_extensions=export_format_extensions,
-            initial_file_stem=CONTEXT_FILE_TYPE_EVENTS,
+            context_file_type=CONTEXT_FILE_TYPE_EVENTS,
             viewmodel=self,
         )
-        file = export_config.file
-        export_format = export_config.export_format
-        event_list_exporter = self._event_list_export_formats.get(export_format, None)
+        event_list_exporter = self._event_list_export_formats.get(
+            export_config.export_format, None
+        )
         if event_list_exporter is None:
             raise ExporterNotFoundError(
                 f"{event_list_exporter} is not a valid export format"
             )
-        return event_list_exporter, file
+
+        return event_list_exporter, export_config
 
     def set_track_offset(self, offset_x: float, offset_y: float) -> None:
         start_msg_popup = self._ui_factory.minimal_info_box(
@@ -1697,18 +1708,20 @@ async def export_road_user_assignments(self) -> None:
             export_config = await self._ui_factory.configure_export_file(
                 title="Export road user assignments",
                 export_format_extensions=export_formats,
-                initial_file_stem="road_user_assignments",
+                context_file_type=CONTEXT_FILE_TYPE_ROAD_USER_ASSIGNMENTS,
                 viewmodel=self,
             )
             logger().debug(export_config)
-            save_path = export_config.file
-            export_format = export_config.export_format
-
             export_specification = ExportSpecification(
-                save_path, export_format, OVERWRITE
+                export_directory=export_config.export_directory,
+                export_filename_stem=export_config.file_stem,
+                format=export_config.export_format,
+                export_mode=OVERWRITE,
             )
             self._application.export_road_user_assignments(export_specification)
-            logger().info(f"Exporting road user assignments to {save_path}")
+            logger().info(
+                f"Exporting road user assignments to {export_config.as_file_path()}"
+            )
         except CancelExportFile:
             logger().info("User canceled configuration of export")
 
@@ -1776,7 +1789,9 @@ def update_svz_metadata_view(self, _: Any = None) -> None:
     def update_remark_view(self, _: Any = None) -> None:
         self.frame_remark.load_remark()
 
-    def get_save_path_suggestion(self, file_type: str, context_file_type: str) -> Path:
+    def get_save_path_suggestion(
+        self, file_type: str, context_file_type: str
+    ) -> SavePathSuggestion:
         return self._application.suggest_save_path(file_type, context_file_type)
 
     def set_frame_track_statistics(self, frame: AbstractFrameTrackStatistics) -> None:
@@ -1808,17 +1823,19 @@ async def export_track_statistics(self) -> None:
             export_config = await self._ui_factory.configure_export_file(
                 title="Export track statistics",
                 export_format_extensions=export_formats,
-                initial_file_stem=CONTEXT_FILE_TYPE_TRACK_STATISTICS,
+                context_file_type=CONTEXT_FILE_TYPE_TRACK_STATISTICS,
                 viewmodel=self,
             )
             logger().debug(export_config)
-            save_path = export_config.file
-            export_format = export_config.export_format
-
             export_specification = TrackStatisticsExportSpecification(
-                save_path, export_format, OVERWRITE
+                export_directory=export_config.export_directory,
+                export_filename_stem=export_config.file_stem,
+                format=export_config.export_format,
+                export_mode=OVERWRITE,
+            )
+            destination = self._application.export_track_statistics(
+                export_specification
             )
-            self._application.export_track_statistics(export_specification)
-            logger().info(f"Exporting track statistics to {save_path}")
+            logger().info(f"Exporting track statistics to {destination}")
         except CancelExportFile:
             logger().info("User canceled configuration of export")

OTAnalytics/adapter_ui/file_export_dto.py

@@ -4,5 +4,28 @@
 
 @dataclass(frozen=True)
 class ExportFileDto:
-    file: Path
+    """
+    Data transfer object for file export information.
+
+    Attributes:
+        export_directory (Path): The directory where the file will be exported.
+        file_stem (str): The stem of the file name (without extension).
+        export_format (str): The format of the exported file. The file extension.
+    """
+
+    export_directory: Path
+    file_stem: str
+    export_format_extension: str
     export_format: str
+
+    @classmethod
+    def from_file_path(cls, file_path: Path, export_format: str) -> "ExportFileDto":
+        return cls(
+            export_directory=file_path.parent,
+            file_stem=file_path.stem,
+            export_format_extension=file_path.suffix,
+            export_format=export_format,
+        )
+
+    def as_file_path(self) -> Path:
+        return self.export_directory / f"{self.file_stem}{self.export_format_extension}"

OTAnalytics/adapter_ui/ui_factory.py

@@ -64,7 +64,7 @@ async def configure_export_file(
         self,
         title: str,
         export_format_extensions: dict[str, str],
-        initial_file_stem: str,
+        context_file_type: str,
         viewmodel: ViewModel,
     ) -> ExportFileDto:
         raise NotImplementedError

OTAnalytics/adapter_ui/view_model.py

@@ -28,6 +28,7 @@
 from OTAnalytics.application import geometry
 from OTAnalytics.application.use_cases.cut_tracks_with_sections import CutTracksDto
 from OTAnalytics.application.use_cases.editor.section_editor import MetadataProvider
+from OTAnalytics.application.use_cases.suggest_save_path import SavePathSuggestion
 from OTAnalytics.domain.date import DateRange
 from OTAnalytics.domain.event import EventRepositoryEvent
 from OTAnalytics.domain.filter import FilterElement
@@ -447,7 +448,9 @@ def set_svz_metadata_frame(self, frame: AbstractFrameSvzMetadata) -> None:
         raise NotImplementedError
 
     @abstractmethod
-    def get_save_path_suggestion(self, file_type: str, context_file_type: str) -> Path:
+    def get_save_path_suggestion(
+        self, file_type: str, context_file_type: str
+    ) -> SavePathSuggestion:
         raise NotImplementedError
 
     @abstractmethod

OTAnalytics/application/analysis/traffic_counting.py

@@ -899,7 +899,7 @@ class Exporter(ABC):
     """
 
     @abstractmethod
-    def export(self, counts: Count, export_mode: ExportMode) -> None:
+    def export(self, counts: Count, export_mode: ExportMode) -> Path:
         """
         Export the given counts.
 
@@ -908,6 +908,9 @@ def export(self, counts: Count, export_mode: ExportMode) -> None:
             export_mode (ExportMode): export mode specifies whether result data
                 should overwrite file, be appended (or flushed to file in case
                 of stateful exporter).
+
+        Returns:
+            Path: path to the exported file.
         """
         raise NotImplementedError
 
@@ -1124,7 +1127,7 @@ def __init__(
         self._traffic_counting = traffic_counting
         self._exporter_factory = exporter_factory
 
-    def export(self, specification: CountingSpecificationDto) -> None:
+    def export(self, specification: CountingSpecificationDto) -> Path:
         """
         Export the traffic countings based on the currently available events and flows.
 
@@ -1138,7 +1141,7 @@ def export(self, specification: CountingSpecificationDto) -> None:
             flows, specification, self._traffic_counting.provide_get_sections_by_id()
         )
         exporter = self._exporter_factory.create_exporter(export_specification)
-        exporter.export(counts, specification.export_mode)
+        return exporter.export(counts, specification.export_mode)
 
     def get_supported_formats(self) -> Iterable[ExportFormat]:
         """

OTAnalytics/application/analysis/traffic_counting_specification.py

@@ -2,6 +2,7 @@
 from dataclasses import dataclass
 from datetime import datetime
 from enum import Enum
+from pathlib import Path
 from typing import Iterable
 
 from OTAnalytics.application.export_formats.export_mode import ExportMode
@@ -43,7 +44,8 @@ class CountingSpecificationDto:
     interval_in_minutes: int
     modes: list[str]
     output_format: str
-    output_file: str
+    export_directory: Path
+    export_filename_stem: str
     export_mode: ExportMode
     count_all_events: bool = False
     counting_event: CountingEvent = CountingEvent.START
@@ -55,7 +57,8 @@ def with_end(self, end: datetime) -> "CountingSpecificationDto":
             interval_in_minutes=self.interval_in_minutes,
             modes=self.modes,
             output_format=self.output_format,
-            output_file=self.output_file,
+            export_directory=self.export_directory,
+            export_filename_stem=self.export_filename_stem,
             export_mode=self.export_mode,
             count_all_events=self.count_all_events,
             counting_event=self.counting_event,
@@ -83,12 +86,16 @@ def format(self) -> str:
         return self.counting_specification.output_format
 
     @property
-    def output_file(self) -> str:
-        return self.counting_specification.output_file
+    def export_directory(self) -> Path:
+        return self.counting_specification.export_directory
+
+    @property
+    def export_filename_stem(self) -> str:
+        return self.counting_specification.export_filename_stem
 
 
 class ExportCounts(ABC):
-    def export(self, specification: CountingSpecificationDto) -> None:
+    def export(self, specification: CountingSpecificationDto) -> Path:
         raise NotImplementedError
 
     def get_supported_formats(self) -> Iterable[ExportFormat]: