Skip to content

Readme.md

Latest commit

 

History

History
139 lines (111 loc) · 4.64 KB

Readme.md

File metadata and controls

139 lines (111 loc) · 4.64 KB

ROS2 Package Xml Validator & Formatter

Validates and formats package.xml files to enforce consistency and ROS 2 schema compliance.

✅ What it does:

  • XML Schema Validation & Correction
  • Dependency Grouping & Sorting
    • Grouped by type (e.g. build_depend, test_depend)
    • Sorted alphabetically within each group
  • Non-Destructive Edits
    • Leaves comments and indentation unchanged
  • Launch-File Dependency Validation
    • Scans Python (.py), YAML (.yaml/.yml), and XML (.xml) launch files for package references
    • validates and corrects that all referenced pkgs are declared in the package xml (as <exec_depend> or <depend>)
    • similarly the test folder is parsed to extract missing <test_depend> dependencies
  • Rosdep Key Checking
    • verifies that all declared pkgs exist as rodsdep key (optional)
  • CMakeFile Comparison and Synchronization
    • compares build dependencies and test dependencies with dependencies in the CMakeLists.txt (optional)
    • automatically inserts missing package xml dependencies from the CMakeList as <depend> or <build_depend> (optional)
  • Export Build Type Validation
    • makes sure the package.xml includes the appropriate build_type export (e.g. ament_cmake, ament_python)

Example: Enforced Grouping of the dependencies

<package format="3">
  ...
  <buildtool_depend>ament_cmake</buildtool_depend>

  <depend>controller_manager_msgs</depend>
  <depend>pluginlib</depend>
  <depend>rclcpp</depend>
  <depend>rclcpp_action</depend>

  <test_depend>ament_lint_auto</test_depend>
  <test_depend>ament_lint_common</test_depend>
  ...
  <export>
    <build_type>ament_cmake</build_type>
  </export>
</package>

🛠️ Usage Example

package-xml-validator [-h] [--check-only] [--file FILE] [--verbose] [--check-with-xmllint] [--skip-rosdep-key-validation] [--compare-with-cmake] [src ...]

Validate and format ROS2 package.xml files.

positional arguments:
  src                           List of files or directories to process.

options:
  -h, --help                    show this help message and exit
  --check-only                  Only check for errors without correcting.
  --file FILE                   Path to a single XML file to process. If provided, 'src' arguments are ignored.
  --verbose                     Enable verbose output.
  --check-with-xmllint          Recheck XML schema using xmllint.
  --skip-rosdep-key-validation  Check if rosdeps are valid.
  --compare-with-cmake          Check if all CMake dependencies are in package.xml.
  --auto-fill-missing-deps      Automatically fill missing dependencies in package.xml. Note: --compare-with-cmake must be set.

Example with verbose logging:

package-xml-validator ~/hector/src/hector_gamepad_manager/hector_gamepad_plugin_interface --check-only --compare-with-cmake --verbose
Processing hector_gamepad_plugin_interface...
✅ [1/10] Check for invalid tags passed.
✅ [2/10] Check for empty lines passed.
✅ [3/10] Check for duplicate elements passed.
✅ [4/10] Check element occurrences passed.
✅ [5/10] Check element order passed.
✅ [6/10] Check dependency order passed.
✅ [7/10] Check launch dependencies passed.
✅ [8/10] Check build type export passed.
✅ [8/10] Check ROS dependencies passed.
✅ [9/10] Check CMake dependencies passed.
🎉 All `package.xml` files are valid and nicely formatted. 🚀

✅ Pre-commit Hook Setup

Use pre-commit to automatically validate and format package.xml files before each commit.

1. Install pre-commit

pip install pre-commit

2. Add to .pre-commit-config.yaml

repos:
  - repo: git@github.com:Joschi3/package_xml_validation.git
    rev: v1.2.0
    hooks:
      - id: format-package-xml
        name: Format package.xml

3. Install the hook (run once)

pre-commit install

This ensures the check runs every time you git commit.

4. Run manually (e.g. on first setup)

pre-commit run --all-files

🧪 CI Use: Check-only Mode

If you're running in CI and want to fail on violations without modifying files, use:

package-xml-validator --check-only --compare-with-cmake .

This will:

  • Validate all package.xml files
  • Print any formatting/schema issues
  • check validity of rosdep keys
  • compare the depenedencies with the dependencies listed in the CMakeList.txt
  • Exit non-zero if any problems are found → No files will be modified
  • if rosdep is not available in the CI environment use the --skip-rosdep-key-validation flag