test(components): Do not overwrite system_vehicle_components_template.json during tests

Author: amilcarlucas

ardupilot_methodic_configurator/backend_filesystem_program_settings.py

@@ -9,6 +9,7 @@
 """
 
 # from sys import exit as sys_exit
+import os
 from contextlib import suppress as contextlib_suppress
 from dataclasses import dataclass
 from glob import glob as glob_glob
@@ -470,6 +471,12 @@ def get_recent_vehicle_dirs() -> list[str]:
 
     @staticmethod
     def get_templates_base_dir() -> str:
+        # Allow tests to override the templates directory in a safe temporary location
+        test_templates_dir = os.environ.get("AMC_COMPONENT_TEMPLATES_DIR_TEST")
+        if test_templates_dir:
+            logging_debug("Using test templates directory: %s", test_templates_dir)
+            return test_templates_dir
+
         package_path = importlib_files("ardupilot_methodic_configurator")
         logging_debug("current script directory1: %s", package_path)
         if platform_system() == "Windows":

ardupilot_methodic_configurator/backend_filesystem_vehicle_components.py

@@ -233,12 +233,24 @@ def save_component_templates_to_file(self, templates_to_save: dict[str, list[dic
             # System templates are part of the software installation and get updated when the program
             # is updated and deleted when the program is un-installed.
             templates_filename = "system_vehicle_components_template.json"
-            # Check if local system template file exists, use local dir if so.
+            # Check if local system template file exists, use local templates_dir if so.
             try:
-                local_dir = importlib_files("ardupilot_methodic_configurator") / "vehicle_templates"
-                filepath = str(local_dir / templates_filename)
+                templates_dir = ProgramSettings.get_templates_base_dir()
+                filepath = os_path.join(templates_dir, templates_filename)
+
                 if os_path.exists(filepath):
                     existing_templates = self._load_system_templates(filepath)
+                else:
+                    # Fallback to package path when system-wide path is unavailable
+                    local_dir = importlib_files("ardupilot_methodic_configurator") / "vehicle_templates"
+                    filepath = str(local_dir / templates_filename)
+                    if os_path.exists(filepath):
+                        existing_templates = self._load_system_templates(filepath)
+
+                # Ensure folder exists for safe writing in test and normal mode
+                dir_name = os_path.dirname(filepath)
+                if dir_name:
+                    os_makedirs(dir_name, exist_ok=True)
             except (OSError, ValueError) as e:
                 logging_debug("Failed to check local template file: %s", e)
                 # Fall back to default templates_dir

tests/unit_backend_filesystem_vehicle_components.py

@@ -160,9 +160,10 @@ def test_save_component_templates_to_file_os_error(self, mock_get_base_dir, mock
     @patch("ardupilot_methodic_configurator.backend_filesystem_vehicle_components.os_path.exists")
     @patch("builtins.open", new_callable=mock_open)
     @patch("ardupilot_methodic_configurator.backend_filesystem_vehicle_components.os_makedirs")
+    @patch("ardupilot_methodic_configurator.backend_filesystem_vehicle_components.safe_write")
     @patch("ardupilot_methodic_configurator.backend_filesystem_program_settings.ProgramSettings.get_templates_base_dir")
-    def test_save_component_templates_to_file_uses_local_dir_when_local_file_exists(
-        self, mock_get_base_dir, mock_makedirs, mock_file, mock_exists
+    def test_save_component_templates_to_file_uses_local_dir_when_local_file_exists(  # pylint: disable=too-many-arguments,too-many-positional-arguments
+        self, mock_get_base_dir, mock_safe_write, mock_makedirs, mock_file, mock_exists
     ) -> None:
         """
         Test that system templates use local directory when local file exists.
@@ -174,15 +175,17 @@ def test_save_component_templates_to_file_uses_local_dir_when_local_file_exists(
         mock_get_base_dir.return_value = "/system/templates"
         mock_makedirs.return_value = None
         mock_exists.return_value = True  # Local file exists
+        mock_safe_write.return_value = None
 
         vehicle_components_system = VehicleComponents(save_component_to_system_templates=True)
         templates_to_save = {"Component1": [{"name": "Test", "data": {}}]}
 
         error, msg = vehicle_components_system.save_component_templates_to_file(templates_to_save)
 
         assert error is False
-        # Should use local dir, which contains "ardupilot_methodic_configurator/vehicle_templates"
-        assert "ardupilot_methodic_configurator/vehicle_templates/system_vehicle_components_template.json" in msg
+        # Should use local dir, which contains system template filename (path may vary by environment)
+        assert "system_vehicle_components_template.json" in msg
+        assert "/system/templates" in msg or "ardupilot_methodic_configurator/vehicle_templates" in msg
 
     @patch.object(VehicleComponents, "_load_system_templates")
     @patch.object(VehicleComponents, "save_component_templates_to_file")