Always set junit_family to xunit2 for dashing, eloquent, and foxy

[jacobperron]

The pytest arg has precedence over a value set in an existing pytest.ini file.

To use the --pytest-args option, we have to be careful not to hide (or be hidden by) existing instances of the option. If --pytest-args already exists, then insert the additional options.

Alternative to #501 and #502

Foxy builds were failing.
Before:
After:

[cottsay]

I don't have a ton of context here, but this change seems like a good approach to me.

[jacobperron]

Foxy:

• Linux
• Linux-aarch64
• macOS
• Windows

Rolling:

• Linux
• Linux-aarch64
• macOS
• Windows

Dashing:

• Linux

[j-rivero]

The approach looks good to me, but somehow it is not being propagated to the invocation of pytest in some packages:

Foxy:

* Linux

This one is failing after run:

11: Test command: /home/jenkins-agent/workspace/ci_linux/venv/bin/python3 "-u" "/home/jenkins-agent/workspace/ci_linux/ws/install/ament_cmake_test/share/ament_cmake_test/cmake/run_test.py" "/home/jenkins-agent/workspace/ci_linux/ws/build/message_filters/test_results/message_filters/directed.py.xunit.xml" "--package-name" "message_filters" "--output-file" "/home/jenkins-agent/workspace/ci_linux/ws/build/message_filters/ament_cmake_pytest/directed.py.txt" "--command" "/home/jenkins-agent/workspace/ci_linux/venv/bin/python3" "-u" "-m" "pytest" "/home/jenkins-agent/workspace/ci_linux/ws/src/ros2/message_filters/test/directed.py" "-o" "cache_dir=/home/jenkins-agent/workspace/ci_linux/ws/build/message_filters/ament_cmake_pytest/directed.py/.cache" "--junit-xml=/home/jenkins-agent/workspace/ci_linux/ws/build/message_filters/test_results/message_filters/directed.py.xunit.xml" "--junit-prefix=message_filters"

[jacobperron]

The approach looks good to me, but somehow it is not being propagated to the invocation of pytest in some packages

Yeah, we're still seeing warnings for some subset of the packages. I bet that it is because these packages are CMake packages, adding pytests like this, for example:

https://github.com/ros2/message_filters/blob/985fac0e594c00ccc35cd4a4522fa431f2e51e2e/CMakeLists.txt#L130-L137

I think we either have to pass the appropriate args either via CMake or backport the pytest.ini changes to the Foxy branch.

[jacobperron]

Foxy (take 2):

• Linux
• Linux-aarch64
• macOS
• Windows

This time CI is with the following backports for Foxy:

• Fast-forward foxy branch rosidl#515
• Fast-forward merge pytest.ini to Foxy message_filters#48
• [foxy backport] Add pytest.ini to test_launch_testing so tests succeed locally. (#431) launch#451
• [foxy backport] Add pytest.ini so local tests don't display warning (#48) ros/resource_retriever#52
• Fast-forward Foxy rosidl_python#118
• [foxy backport] Add pytest.ini so tests succeed without warnings when run locally. (#587) rclpy#616
• [foxy backport] Add in pytest.ini so tests succeed locally. (#280) geometry2#309

[jacobperron]

I think I've backported all of the necessary pytest.ini files for this PR to work. The backports just need to be approved.