test(generated files): Add tests for generated files

Author: amilcarlucas

tests/gettext_capture_helper.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+
+"""
+Shared utilities for capturing gettext invocations in generated modules.
+
+This file is part of ArduPilot Methodic Configurator. https://github.com/ArduPilot/MethodicConfigurator
+
+SPDX-FileCopyrightText: 2024-2025 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
+
+SPDX-License-Identifier: GPL-3.0-or-later
+"""
+
+from collections.abc import Callable
+from types import ModuleType
+
+import pytest
+
+
+def capture_gettext_calls(
+    monkeypatch: pytest.MonkeyPatch,
+    module: ModuleType,
+    target: Callable[[], None],
+) -> list[str]:
+    """Patch module._ to record every string that flows through gettext."""
+    captured_values: list[str] = []
+
+    def fake_gettext(value: str) -> str:
+        captured_values.append(value)
+        return value
+
+    monkeypatch.setattr(module, "_", fake_gettext)
+    target()
+    return captured_values

tests/test_configuration_steps_strings_bdd.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+
+"""
+Behavior-driven datatype tests for configuration_steps_strings module.
+
+This file is part of ArduPilot Methodic Configurator. https://github.com/ArduPilot/MethodicConfigurator
+
+SPDX-FileCopyrightText: 2025 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
+
+SPDX-License-Identifier: GPL-3.0-or-later
+"""
+
+from gettext_capture_helper import capture_gettext_calls
+
+from ardupilot_methodic_configurator import configuration_steps_strings as config_strings
+
+
+class TestConfigurationStepsStringsModule:
+    """BDD tests for string collection helpers."""
+
+    def test_configuration_steps_strings_invokes_gettext_with_text(self, monkeypatch) -> None:
+        """
+        configuration_steps_strings forwards collected strings to gettext.
+
+        GIVEN: configuration_steps_strings aggregates literal strings from JSON resources
+        WHEN: The gettext capture helper intercepts inputs
+        THEN: Every captured value is a non-empty string and the function returns None
+        """
+        captured_values = capture_gettext_calls(
+            monkeypatch,
+            config_strings,
+            config_strings.configuration_steps_strings,
+        )
+        assert captured_values
+        assert all(isinstance(value, str) and value for value in captured_values)
+
+    def test_configuration_steps_descriptions_invokes_gettext_with_text(self, monkeypatch) -> None:
+        """
+        configuration_steps_descriptions forwards schema strings to gettext.
+
+        GIVEN: configuration_steps_descriptions enumerates strings from the schema file
+        WHEN: The shared capture helper records gettext inputs
+        THEN: Every value reaching gettext is a non-empty string and the function returns None
+        """
+        captured_values = capture_gettext_calls(
+            monkeypatch,
+            config_strings,
+            config_strings.configuration_steps_descriptions,
+        )
+        assert captured_values
+        assert all(isinstance(value, str) and value for value in captured_values)

tests/test_data_model_fc_ids_bdd.py

@@ -0,0 +1,98 @@
+#!/usr/bin/env python3
+
+"""
+Behavior-driven tests that validate the structure of the data_model_fc_ids module.
+
+This file is part of ArduPilot Methodic Configurator. https://github.com/ArduPilot/MethodicConfigurator
+
+SPDX-FileCopyrightText: 2025 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
+
+SPDX-License-Identifier: GPL-3.0-or-later
+"""
+
+from ardupilot_methodic_configurator import data_model_fc_ids as fc_ids
+
+
+class TestFlightControllerIdsDataIntegrity:
+    """BDD-style tests ensuring the generated FC ID data keeps expected types."""
+
+    def test_vid_vendor_dict_ensures_int_keys_and_string_lists(self) -> None:
+        """
+        VID vendor mapping uses integers and string lists.
+
+        GIVEN: The VID to vendor mapping contains multiple USB vendors
+        WHEN: The mapping is inspected for datatype consistency
+        THEN: Every key is an integer and every value is a non-empty list of strings
+        """
+        for vid, vendors in fc_ids.VID_VENDOR_DICT.items():
+            assert isinstance(vid, int)
+            assert isinstance(vendors, list)
+            assert vendors, "Vendor list must not be empty"
+            assert all(isinstance(name, str) and name for name in vendors)
+
+    def test_vid_pid_product_dict_uses_tuple_keys_and_string_lists(self) -> None:
+        """
+        VID/PID mapping stores tuple keys and string lists.
+
+        GIVEN: The VID/PID to product mapping represents USB products
+        WHEN: The mapping is validated
+        THEN: Keys are (int, int) tuples and values are non-empty string lists
+        """
+        for key, products in fc_ids.VID_PID_PRODUCT_DICT.items():
+            assert isinstance(key, tuple)
+            assert len(key) == 2
+            assert all(isinstance(part, int) for part in key)
+            assert isinstance(products, list)
+            assert products, "Product list must not be empty"
+            assert all(isinstance(product, str) and product for product in products)
+
+    def test_apj_board_dicts_share_identical_keys_and_string_values(self) -> None:
+        """
+        APJ board dictionaries expose matching key sets.
+
+        GIVEN: The APJ board dictionaries describe names, vendors, and MCU series
+        WHEN: The dictionaries are compared
+        THEN: They expose the same key set and each entry lists non-empty strings
+        """
+        name_keys = set(fc_ids.APJ_BOARD_ID_NAME_DICT)
+        vendor_keys = set(fc_ids.APJ_BOARD_ID_VENDOR_DICT)
+        mcu_keys = set(fc_ids.APJ_BOARD_ID_MCU_SERIES_DICT)
+
+        assert name_keys == vendor_keys == mcu_keys
+
+        for board_id in name_keys:
+            assert isinstance(board_id, int)
+            names = fc_ids.APJ_BOARD_ID_NAME_DICT[board_id]
+            vendors = fc_ids.APJ_BOARD_ID_VENDOR_DICT[board_id]
+            mcu_series = fc_ids.APJ_BOARD_ID_MCU_SERIES_DICT[board_id]
+
+            assert isinstance(names, list)
+            assert names
+            assert isinstance(vendors, list)
+            assert vendors
+            assert isinstance(mcu_series, list)
+            assert mcu_series
+            assert all(isinstance(name, str) and name for name in names)
+            assert all(isinstance(vendor, str) and vendor for vendor in vendors)
+            assert all(isinstance(series, str) and series for series in mcu_series)
+
+    def test_mcu_series_mapping_references_known_board_ids(self) -> None:
+        """
+        MCU series entries only reference known board IDs.
+
+        GIVEN: The MCU series to board ID mapping cross-references board metadata
+        WHEN: The mapping is validated
+        THEN: Every series is a string and every referenced ID exists in the board dictionaries
+        """
+        known_board_ids = set(fc_ids.APJ_BOARD_ID_NAME_DICT)
+        referenced_board_ids: set[int] = set()
+
+        for series, board_ids in fc_ids.MCU_SERIES_APJ_BOARD_ID_DICT.items():
+            assert isinstance(series, str)
+            assert series
+            assert isinstance(board_ids, list)
+            assert board_ids
+            assert all(isinstance(board_id, int) and board_id in known_board_ids for board_id in board_ids)
+            referenced_board_ids.update(board_ids)
+
+        assert referenced_board_ids.issuperset(known_board_ids)

tests/test_vehicle_components_translations_bdd.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+
+"""
+Behavior-driven datatype tests for vehicle_components translation helpers.
+
+This file is part of ArduPilot Methodic Configurator. https://github.com/ArduPilot/MethodicConfigurator
+
+SPDX-FileCopyrightText: 2025 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
+
+SPDX-License-Identifier: GPL-3.0-or-later
+"""
+
+from gettext_capture_helper import capture_gettext_calls
+
+from ardupilot_methodic_configurator import vehicle_components
+
+
+class TestVehicleComponentsTranslationHelpers:
+    """BDD coverage for vehicle component translation helpers."""
+
+    def test_translatable_strings_forward_literals_to_gettext(self, monkeypatch) -> None:
+        """
+        translatable_strings forwards every literal to gettext.
+
+        GIVEN: translatable_strings simply enumerates literal strings
+        WHEN: The shared gettext capture helper records inputs
+        THEN: The recorder captures non-empty strings exclusively
+        """
+        captured_values = capture_gettext_calls(
+            monkeypatch,
+            vehicle_components,
+            vehicle_components.translatable_strings,
+        )
+
+        assert captured_values
+        assert all(isinstance(value, str) and value for value in captured_values)
+
+    def test_translatable_descriptions_forward_literals_to_gettext(self, monkeypatch) -> None:
+        """
+        translatable_descriptions forwards schema literals to gettext.
+
+        GIVEN: translatable_descriptions iterates strings from the schema definition
+        WHEN: The helper intercepts gettext invocations
+        THEN: The recorder receives only non-empty strings
+        """
+        captured_values = capture_gettext_calls(
+            monkeypatch,
+            vehicle_components,
+            vehicle_components.translatable_descriptions,
+        )
+
+        assert captured_values
+        assert all(isinstance(value, str) and value for value in captured_values)