Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[21245] Fix topic interference on liveliness_changed status (backport #4988) #5032

Merged
merged 3 commits into from
Jul 9, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jul 4, 2024

Description

PR #4822 (and its backports) introduced a regression that was not detected until we requested ROS 2 rolling to use branch 2.14.x here

This PR:

  1. Adds infrastructure to create Blackbox tests that simulate the behavior of ROS 2 node
  2. Adds a ROS2 black-box test trying to mimick the test that regressed
  3. Add a standard black-box regression test for the issue discovered
  4. Fixes the issue

@Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x

Contributor Checklist

  • Commit messages follow the project guidelines.

  • The code follows the style guidelines of this project.

  • Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally

  • Any new/modified methods have been properly documented using Doxygen.

  • N/A Any new configuration API has an equivalent XML API (with the corresponding XSD extension)

  • Changes are backport compatible: they do NOT break ABI nor change library core behavior.

  • Changes are API compatible.

  • N/A New feature has been added to the versions.md file (if applicable).

  • N/A New feature has been documented/Current behavior is correctly described in the documentation.

  • Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

This is an automatic backport of pull request #4988 done by [Mergify](https://mergify.com).

* Refs #21189. Basic infrastructure for ROS2 blackbox tests.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added callback for liveliness_changed event.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added ROS2 regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added blackbox regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatefulReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatelessReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Uncrustify and doxygen.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Change liveliness announcement periods.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Create ROS 2 builtin endpoints.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix type and QoS on ros_discovery_info.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Avoid collision with true ROS 2 topics.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Uncrustify.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix warnings on MacOS.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix tsan reported deadlock.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix long-standing deadlock in WLP.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix build after rebase.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 9243ead)

# Conflicts:
#	src/cpp/rtps/reader/StatefulReader.cpp
#	src/cpp/rtps/reader/StatelessReader.cpp
#	test/blackbox/common/BlackboxTestsLivelinessQos.cpp
@mergify mergify bot added the conflicts Backport PR wich git cherry pick failed label Jul 4, 2024
Copy link
Contributor Author

mergify bot commented Jul 4, 2024

Cherry-pick of 9243ead has failed:

On branch mergify/bp/2.14.x/pr-4988
Your branch is up to date with 'origin/2.14.x'.

You are currently cherry-picking commit 9243eadae.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   src/cpp/rtps/builtin/liveliness/WLP.cpp
	new file:   test/blackbox/common/DDSBlackboxTestsROS2.cpp
	new file:   test/blackbox/common/ros2/Context.hpp
	new file:   test/blackbox/common/ros2/DataReaderHolder.hpp
	new file:   test/blackbox/common/ros2/DataWriterHolder.hpp
	new file:   test/blackbox/common/ros2/GenericHolder.hpp
	new file:   test/blackbox/common/ros2/Node.hpp
	new file:   test/blackbox/common/ros2/PublicationNode.hpp
	new file:   test/blackbox/common/ros2/SubscriptionNode.hpp
	new file:   test/blackbox/common/ros2/TopicHolder.hpp

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   src/cpp/rtps/reader/StatefulReader.cpp
	both modified:   src/cpp/rtps/reader/StatelessReader.cpp
	both modified:   test/blackbox/common/BlackboxTestsLivelinessQos.cpp

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

Signed-off-by: Miguel Company <[email protected]>
@MiguelCompany MiguelCompany removed the conflicts Backport PR wich git cherry pick failed label Jul 5, 2024
@MiguelCompany MiguelCompany self-requested a review July 5, 2024 05:30
@github-actions github-actions bot added the ci-pending PR which CI is running label Jul 5, 2024
@MiguelCompany MiguelCompany added this to the v2.14.3 milestone Jul 5, 2024
@MiguelCompany MiguelCompany requested review from MiguelCompany and removed request for MiguelCompany July 5, 2024 08:28
Signed-off-by: Miguel Company <[email protected]>
@MiguelCompany MiguelCompany requested review from MiguelCompany and removed request for MiguelCompany July 9, 2024 05:50
@EduPonz
Copy link
Member

EduPonz commented Jul 9, 2024

@Mergifyio backport 2.13.x 2.10.x 2.6.x

Copy link
Contributor Author

mergify bot commented Jul 9, 2024

backport 2.13.x 2.10.x 2.6.x

✅ Backports have been created

@EduPonz EduPonz added ready-to-merge Ready to be merged. CI and changes have been reviewed and approved. and removed ci-pending PR which CI is running labels Jul 9, 2024
@EduPonz EduPonz merged commit 4a6b934 into 2.14.x Jul 9, 2024
18 checks passed
@EduPonz EduPonz deleted the mergify/bp/2.14.x/pr-4988 branch July 9, 2024 13:31
mergify bot added a commit that referenced this pull request Jul 9, 2024
* Fix topic interference on `liveliness_changed` status (#4988)

* Refs #21189. Basic infrastructure for ROS2 blackbox tests.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added callback for liveliness_changed event.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added ROS2 regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added blackbox regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatefulReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatelessReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Uncrustify and doxygen.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Change liveliness announcement periods.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Create ROS 2 builtin endpoints.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix type and QoS on ros_discovery_info.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Avoid collision with true ROS 2 topics.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Uncrustify.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix warnings on MacOS.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix tsan reported deadlock.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix long-standing deadlock in WLP.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix build after rebase.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 9243ead)

# Conflicts:
#	src/cpp/rtps/reader/StatefulReader.cpp
#	src/cpp/rtps/reader/StatelessReader.cpp
#	test/blackbox/common/BlackboxTestsLivelinessQos.cpp

* Fix conflicts

Signed-off-by: Miguel Company <[email protected]>

* Fix build after backport.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit 4a6b934)
mergify bot added a commit that referenced this pull request Jul 9, 2024
* Fix topic interference on `liveliness_changed` status (#4988)

* Refs #21189. Basic infrastructure for ROS2 blackbox tests.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added callback for liveliness_changed event.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added ROS2 regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added blackbox regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatefulReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatelessReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Uncrustify and doxygen.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Change liveliness announcement periods.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Create ROS 2 builtin endpoints.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix type and QoS on ros_discovery_info.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Avoid collision with true ROS 2 topics.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Uncrustify.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix warnings on MacOS.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix tsan reported deadlock.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix long-standing deadlock in WLP.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix build after rebase.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 9243ead)

# Conflicts:
#	src/cpp/rtps/reader/StatefulReader.cpp
#	src/cpp/rtps/reader/StatelessReader.cpp
#	test/blackbox/common/BlackboxTestsLivelinessQos.cpp

* Fix conflicts

Signed-off-by: Miguel Company <[email protected]>

* Fix build after backport.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit 4a6b934)

# Conflicts:
#	src/cpp/rtps/reader/StatelessReader.cpp
mergify bot added a commit that referenced this pull request Jul 9, 2024
* Fix topic interference on `liveliness_changed` status (#4988)

* Refs #21189. Basic infrastructure for ROS2 blackbox tests.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added callback for liveliness_changed event.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added ROS2 regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added blackbox regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatefulReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatelessReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Uncrustify and doxygen.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Change liveliness announcement periods.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Create ROS 2 builtin endpoints.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix type and QoS on ros_discovery_info.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Avoid collision with true ROS 2 topics.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Uncrustify.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix warnings on MacOS.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix tsan reported deadlock.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix long-standing deadlock in WLP.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix build after rebase.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 9243ead)

# Conflicts:
#	src/cpp/rtps/reader/StatefulReader.cpp
#	src/cpp/rtps/reader/StatelessReader.cpp
#	test/blackbox/common/BlackboxTestsLivelinessQos.cpp

* Fix conflicts

Signed-off-by: Miguel Company <[email protected]>

* Fix build after backport.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit 4a6b934)

# Conflicts:
#	src/cpp/rtps/reader/StatefulReader.cpp
#	src/cpp/rtps/reader/StatelessReader.cpp
EduPonz pushed a commit that referenced this pull request Jul 10, 2024
…#5044)

* Fix topic interference on `liveliness_changed` status (#4988)

* Refs #21189. Basic infrastructure for ROS2 blackbox tests.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added callback for liveliness_changed event.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added ROS2 regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Added blackbox regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatefulReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix StatelessReader.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Uncrustify and doxygen.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Change liveliness announcement periods.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Create ROS 2 builtin endpoints.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix type and QoS on ros_discovery_info.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Avoid collision with true ROS 2 topics.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Uncrustify.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix warnings on MacOS.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21245. Fix tsan reported deadlock.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix long-standing deadlock in WLP.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21189. Fix build after rebase.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 9243ead)

# Conflicts:
#	src/cpp/rtps/reader/StatefulReader.cpp
#	src/cpp/rtps/reader/StatelessReader.cpp
#	test/blackbox/common/BlackboxTestsLivelinessQos.cpp

* Fix conflicts

Signed-off-by: Miguel Company <[email protected]>

* Fix build after backport.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit 4a6b934)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-merge Ready to be merged. CI and changes have been reviewed and approved.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants