Test failure on Galactic

[jtbandes]

Description

We recently had tests start failing on galactic:

https://github.com/foxglove/schemas/actions/runs/5137329133/jobs/9245476136

  /usr/bin/bash -c source /opt/ros/galactic/setup.sh && colcon test-result --verbose
  build/foxglove_msgs/Testing/20230531-2033/Test.xml: 28 tests, 0 errors, 2 failures, 0 skipped
  - pep257_rosidl_generated_py
    <<< failure message
      -- run_test.py: invoking following command in '/__w/schemas/schemas/ros_ws/src/1itt8uep1co/schemas/ros_foxglove_msgs':
       - /opt/ros/galactic/bin/ament_pep257 --xunit-file /__w/schemas/schemas/ros_ws/build/foxglove_msgs/test_results/foxglove_msgs/pep257_rosidl_generated_py.xunit.xml /__w/schemas/schemas/ros_ws/build/foxglove_msgs/rosidl_generator_py/foxglove_msgs
      Traceback (most recent call last):
        File "/opt/ros/galactic/bin/ament_pep257", line 11, in <module>
          load_entry_point('ament-pep257==0.10.7', 'console_scripts', 'ament_pep257')()
        File "/opt/ros/galactic/lib/python3.8/site-packages/ament_pep257/main.py", line 126, in main
          report = generate_pep257_report(args.paths, excludes, args.ignore, args.select,
        File "/opt/ros/galactic/lib/python3.8/site-packages/ament_pep257/main.py", line 192, in generate_pep257_report
          for filename, checked_codes, ignore_decorators in files_to_check:
      ValueError: too many values to unpack (expected 3)
      -- run_test.py: return code 1
      -- run_test.py: generate result file '/__w/schemas/schemas/ros_ws/build/foxglove_msgs/test_results/foxglove_msgs/pep257_rosidl_generated_py.xunit.xml' with failed test
      -- run_test.py: verify result file '/__w/schemas/schemas/ros_ws/build/foxglove_msgs/test_results/foxglove_msgs/pep257_rosidl_generated_py.xunit.xml'
    >>>

CI workflow is here: https://github.com/foxglove/schemas/blob/main/.github/workflows/ci.yml

This error seems to be the same as #795, but that's marked closed and was for rolling anyway.

System (please complete the following information)

• OS: GitHub Actions ubuntu-latest
• ROS 2 Distro: Galactic

[christophebedard]

This is due to a new version of pydocstyle (6.2.0). It was fixed in ament_lint (ament/ament_lint#428), but it wasn't backported to Galactic since it's EOL.

The problem here is that you're getting a new version of pydocstyle even on Focal. This is because it's installed using pip: https://github.com/ros-tooling/setup-ros-docker/blob/fae3c8d623e6f9fc930794e05b96663dcae189d4/setup-ros.sh#L148. This is similar to ros-tooling/setup-ros#535: we should switch to using system packages instead of pip (to match the current installation instructions).

[jtbandes]

Thank you for the quick response! Is there a work in progress or ETA on that fix?

[christophebedard]

Not sure about the ETA. I've started working on it for setup-ros (but don't have much time), but for setup-ros-docker it would probably be way quicker, since we only need to copy each distro's installation instructions without any code/TypeScript.

The workaround is to remove the newer version of pydocstyle installed by pip and install pydocstyle from apt before the action-ros-ci step.

[jtbandes]

Thanks for the tip, I was able to work around it like this foxglove/schemas@f01e9cc (borrowed from ros2-rust/ros2_rust#302)