fix: handle absolute package xml path in ros backend (#451)

Author: nichmor

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

@@ -45,7 +45,17 @@ def generate_recipe(
         channels: list[str] | None = None,
     ) -> GeneratedRecipe:
         """Generate a recipe for a Python package."""
-        manifest_root = Path(manifest_path)
+        manifest_path_obj = Path(manifest_path)
+        # nichmor: I'm confused here what we should expect
+        # an absolute path to package.xml or a directory containing it
+        # so I'm handling both cases
+        if manifest_path_obj.is_file():
+            if manifest_path_obj.name != "package.xml":
+                raise ValueError("Manifest filename must be package.xml for ROS packages.")
+            manifest_root = manifest_path_obj.parent
+        else:
+            manifest_root = manifest_path_obj
+
         backend_config: ROSBackendConfig = ROSBackendConfig.model_validate(
             config,
             context={
@@ -75,7 +85,7 @@ def generate_recipe(
         generated_recipe = GeneratedRecipe.from_model(model, metadata_provider)
 
         # Read package.xml for dependency extraction
-        package_xml_str = get_package_xml_content(manifest_root)
+        package_xml_str = get_package_xml_content(package_xml_path)
         ros_env_defaults = {
             "ROS_DISTRO": backend_config.distro.name,
             "ROS_VERSION": "1" if backend_config.distro.check_ros1() else "2",

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

@@ -55,9 +55,8 @@ def get_build_input_globs(config: dict[str, Any], editable: bool) -> list[str]:
     return all_globs
 
 
-def get_package_xml_content(manifest_root: Path) -> str:
+def get_package_xml_content(package_xml_path: Path) -> str:
     """Read package.xml file from the manifest root."""
-    package_xml_path = manifest_root / "package.xml"
     if not package_xml_path.exists():
         raise FileNotFoundError(f"package.xml not found at {package_xml_path}")
 

backends/pixi-build-ros/tests/__snapshots__/test_version_constraints.ambr

@@ -1,4 +1,81 @@
 # serializer version: 1
+# name: test_generate_recipe_with_explicit_package_xml_path
+  '''
+  context: {}
+  package:
+    name: ros-noetic-custom-ros
+    version: 0.0.1
+  source: []
+  build:
+    number: null
+    script:
+      content: ''
+      env: {}
+      secrets: []
+  requirements:
+    build:
+    - ros-noetic-catkin
+    - libgl-devel
+    - libopengl-devel
+    - xorg-libx11
+    - xorg-libxext
+    - ros-noetic-ros-package <=2.0.0
+    - ros-noetic-ros-package-msgs <=2.0.0
+    - ros-noetic-ros-package2 <2.0.0a0
+    - qt-main >=5.15.0,<5.16.0
+    - tinyxml2 ==10.0.0
+    - asio <10.0.0
+    - ninja
+    - python
+    - setuptools
+    - git
+    - git-lfs
+    - cmake
+    - cpython
+    - patch
+    - make
+    - coreutils
+    - ${{ compiler('c') }}
+    - ${{ compiler('cxx') }}
+    host:
+    - ros-noetic-catkin
+    - libgl-devel
+    - libopengl-devel
+    - xorg-libx11
+    - xorg-libxext
+    - ros-noetic-ros-package <=2.0.0
+    - ros-noetic-ros-package-msgs <=2.0.0
+    - ros-noetic-ros-package2 <2.0.0a0
+    - qt-main >=5.15.0,<5.16.0
+    - tinyxml2 ==10.0.0
+    - asio <10.0.0
+    - python
+    - numpy
+    - pip
+    - pkg-config
+    - ros-distro-mutex
+    run:
+    - ros-noetic-ros-package <=2.0.0
+    - ros-noetic-ros-package-msgs <=2.0.0
+    - ros-noetic-ros-package2 <2.0.0a0
+    - qt-main >=5.15.0,<5.16.0
+    - tinyxml2 ==10.0.0
+    - asio <10.0.0
+    - ros-distro-mutex
+    run_constraints: []
+  tests: []
+  about:
+    homepage: null
+    license: LicenseRef-Apache License 2.0
+    license_file: null
+    summary: Demo
+    description: Demo
+    documentation: null
+    repository: null
+  extra: null
+  
+  '''
+# ---
 # name: test_generate_recipe_with_mutex_version
   '''
   context: {}

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

@@ -158,3 +158,49 @@ def test_generate_recipe_with_versions_in_model_and_package(
         # remove the build script as it container a tmp variable
         generated_recipe.recipe.build.script = Script("")
         assert generated_recipe.recipe.to_yaml() == snapshot
+
+
+def test_generate_recipe_with_explicit_package_xml_path(
+    package_xmls: Path, test_data_dir: Path, distro_noetic: Distro, snapshot
+):
+    """Test the generate_recipe function of ROSGenerator with versions."""
+    # Create a temporary directory to simulate the package directory
+    with tempfile.TemporaryDirectory() as temp_dir:
+        temp_path = Path(temp_dir)
+
+        # Copy the test package.xml to the temp directory
+        package_xml_source = package_xmls / "version_constraints.xml"
+        package_xml_dest = temp_path / "package.xml"
+        package_xml_dest.write_text(package_xml_source.read_text(encoding="utf-8"))
+
+        # Create a minimal ProjectModelV1 instance
+        model = ProjectModelV1()
+
+        # Create config for ROS backend
+        config = {
+            "distro": distro_noetic,
+            "noarch": False,
+            "extra-package-mappings": [str(test_data_dir / "other_package_map.yaml")],
+        }
+
+        # Create host platform
+        host_platform = Platform("linux-64")
+
+        # Create ROSGenerator instance
+        generator = ROSGenerator()
+
+        # Generate the recipe
+        generated_recipe = generator.generate_recipe(
+            model=model,
+            config=config,
+            # in other tests we always pass a directory,
+            # here we pass the explicit package.xml path
+            # to handle the situation that we do not multiply package.xml filename
+            manifest_path=str(package_xml_dest),
+            host_platform=host_platform,
+        )
+
+        # Verify the generated recipe has the expected requirements
+        # remove the build script as it container a tmp variable
+        generated_recipe.recipe.build.script = Script("")
+        assert generated_recipe.recipe.to_yaml() == snapshot