feat(ros): add mapping file to globs (#418)

Author: tdejager

backends/pixi-build-ros/src/pixi_build_ros/config.py

@@ -25,18 +25,20 @@ def _parse_str_as_abs_path(value: str | Path, manifest_root: Path) -> Path:
 class PackageMappingSource:
     """Describes where additional package mapping data comes from."""
 
-    def __init__(self, mapping: dict[str, PackageMapEntry]):
+    def __init__(self, mapping: dict[str, PackageMapEntry], source_file: Path | None = None):
         if mapping is None:
             raise ValueError("PackageMappingSource mapping cannot be null.")
         if not isinstance(mapping, dict):
             raise TypeError("PackageMappingSource mapping must be a dictionary.")
         # Copy to keep the source immutable for callers.
         self.mapping: dict[str, PackageMapEntry] = dict(mapping)
+        # Track the source file path if this came from a file
+        self.source_file: Path | None = source_file
 
     @classmethod
     def from_mapping(cls, mapping: dict[str, PackageMapEntry]) -> "PackageMappingSource":
         """Create a source directly from a mapping dictionary."""
-        return cls(mapping)
+        return cls(mapping, source_file=None)
 
     @classmethod
     def from_file(cls, file_path: str | Path) -> "PackageMappingSource":
@@ -48,11 +50,15 @@ def from_file(cls, file_path: str | Path) -> "PackageMappingSource":
             data = yaml.safe_load(f) or {}
         if not isinstance(data, dict):
             raise TypeError("Expected package map file to contain a dictionary.")
-        return cls(data)
+        return cls(data, source_file=path)
 
     def get_package_mapping(self) -> dict[str, PackageMapEntry]:
         return dict(self.mapping)
 
+    def get_source_file(self) -> Path | None:
+        """Return the source file path if this mapping came from a file."""
+        return self.source_file
+
 
 class ROSBackendConfig(pydantic.BaseModel, extra="forbid", arbitrary_types_allowed=True):
     """ROS backend configuration."""
@@ -78,6 +84,14 @@ def is_noarch(self) -> bool:
         """Whether to build a noarch package or a platform-specific package."""
         return self.noarch is None or self.noarch
 
+    def get_package_mapping_file_paths(self) -> list[Path]:
+        """Get all file paths from package mappings that came from files."""
+        file_paths = []
+        for source in self.extra_package_mappings:
+            if source_file := source.get_source_file():
+                file_paths.append(source_file)
+        return file_paths
+
     @pydantic.field_validator("distro", mode="before")
     @classmethod
     def _parse_distro(cls, value: str | Distro) -> Distro:

backends/pixi-build-ros/src/pixi_build_ros/metadata_provider.py

@@ -49,18 +49,22 @@ def __init__(  # type: ignore[no-untyped-def]  # no typing for args and kwargs
         package_xml_path: str,
         *args,
         extra_input_globs: list[str] | None = None,
+        package_mapping_files: list[str] | None = None,
         **kwargs,
     ):
         """
         Initialize the metadata provider with a package.xml file path.
 
         Args:
             package_xml_path: Path to the package.xml file
+            extra_input_globs: Additional glob patterns to include
+            package_mapping_files: Package mapping file paths to track as inputs
         """
         super().__init__(*args, **kwargs)
         self.package_xml_path = package_xml_path
         self._package_data: PackageData | None = None
         self._extra_input_globs = list(extra_input_globs or [])
+        self._package_mapping_files = list(package_mapping_files or [])
         # Early load the package.xml data to ensure it's valid
         _ = self._package_xml_data
 
@@ -170,7 +174,8 @@ def repository(self) -> str | None:
     def input_globs(self) -> list[str]:
         """Return input globs that affect this metadata provider."""
         base_globs = ["package.xml", "CMakeLists.txt", "setup.py", "setup.cfg"]
-        return list(set(base_globs + self._extra_input_globs))
+        all_globs = base_globs + self._extra_input_globs + self._package_mapping_files
+        return list(set(all_globs))
 
 
 class ROSPackageXmlMetadataProvider(PackageXmlMetadataProvider):
@@ -187,15 +192,22 @@ def __init__(
         distro_name: str | None = None,
         *,
         extra_input_globs: list[str] | None = None,
+        package_mapping_files: list[str] | None = None,
     ):
         """
         Initialize the ROS metadata provider.
 
         Args:
             package_xml_path: Path to the package.xml file
-            distro: ROS distro. If None, will use the base package name without distro prefix.
+            distro_name: ROS distro. If None, will use the base package name without distro prefix.
+            extra_input_globs: Additional glob patterns to include
+            package_mapping_files: Package mapping file paths to track as inputs
         """
-        super().__init__(package_xml_path, extra_input_globs=extra_input_globs)
+        super().__init__(
+            package_xml_path,
+            extra_input_globs=extra_input_globs,
+            package_mapping_files=package_mapping_files,
+        )
         self._distro_name: str | None = distro_name
 
     def name(self) -> str | None:

backends/pixi-build-ros/src/pixi_build_ros/ros_generator.py

@@ -48,10 +48,13 @@ def generate_recipe(
         )
         # Create metadata provider for package.xml
         package_xml_path = manifest_root / "package.xml"
+        # Get package mapping file paths to include in input globs
+        package_mapping_files = [str(path) for path in backend_config.get_package_mapping_file_paths()]
         metadata_provider = ROSPackageXmlMetadataProvider(
             str(package_xml_path),
             backend_config.distro.name,
             extra_input_globs=list(backend_config.extra_input_globs or []),
+            package_mapping_files=package_mapping_files,
         )
 
         # Create base recipe from model with metadata provider

backends/pixi-build-ros/tests/test_meta_data_provider.py

@@ -41,3 +41,60 @@ def test_metadata_provider_raises_on_broken_xml(package_xmls: Path):
     # Verify the exception contains location information
     error = exc_info.value
     assert "Failed to parse package.xml" in str(error)
+
+
+def test_metadata_provider_includes_package_mapping_files_in_input_globs():
+    """Test that package mapping files from config are included in input_globs."""
+    import tempfile
+    import yaml
+    from pixi_build_ros.config import ROSBackendConfig
+
+    with tempfile.TemporaryDirectory() as temp_dir:
+        temp_path = Path(temp_dir)
+
+        # Create a package.xml inline
+        package_xml_content = """<?xml version="1.0"?>
+<package format="2">
+  <name>test_package</name>
+  <version>1.0.0</version>
+  <description>Test package</description>
+  <maintainer email="test@test.com">Test</maintainer>
+  <license>Apache-2.0</license>
+</package>
+"""
+        package_xml_path = temp_path / "package.xml"
+        package_xml_path.write_text(package_xml_content)
+
+        # Create a mapping file inline
+        mapping_content = {"custom_package": {"conda": ["custom-conda-package"]}}
+        mapping_file_path = temp_path / "custom_mapping.yaml"
+        with open(mapping_file_path, "w") as f:
+            yaml.dump(mapping_content, f)
+
+        # Create config with the mapping file
+        config = {
+            "distro": "noetic",
+            "extra-package-mappings": [str(mapping_file_path)],
+        }
+
+        backend_config = ROSBackendConfig.model_validate(config, context={"manifest_root": temp_path})
+
+        # Get package mapping file paths
+        package_mapping_files = [str(path) for path in backend_config.get_package_mapping_file_paths()]
+
+        # Create metadata provider
+        metadata_provider = ROSPackageXmlMetadataProvider(
+            str(package_xml_path),
+            distro_name="noetic",
+            package_mapping_files=package_mapping_files,
+        )
+
+        # Get input globs
+        input_globs = metadata_provider.input_globs()
+
+        # Verify the mapping file is included
+        assert str(mapping_file_path) in input_globs
+
+        # Verify base globs are still present
+        assert "package.xml" in input_globs
+        assert "CMakeLists.txt" in input_globs