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

[20655] Fix flakey Log tests (backport #4582) #4590

Merged
merged 2 commits into from
Mar 26, 2024
Merged

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Mar 20, 2024

Description

Test LogMacrosTests.default_macros_test has been sporadically failing in Github CI, especially on Windows.
Analysis showed it was due to a race condition in HELPER_WaitForEntries, and the test not accounting for the value of FASTDDS_ENFORCE_LOG_INFO.

This PR fixes the race condition in HELPER_WaitForEntries by early returning the collection of log entries, and fixes default_macros_test by always waiting for 3 entries and then checking that the expected number of entries is returned, also taking into consideration the value of FASTDDS_ENFORCE_LOG_INFO.

@Mergifyio backport 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.

  • Changes are ABI compatible.

  • 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 #4582 done by [Mergify](https://mergify.com).

* Refs #20655. Improve HELPER_WaitForEntries.

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

* Refs #20655. Fix default_macros_test.

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

---------

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

# Conflicts:
#	test/unittest/logging/log_macros/LogMacrosDefaultTests.cpp
Copy link
Contributor Author

mergify bot commented Mar 20, 2024

Cherry-pick of bdef74e has failed:

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

You are currently cherry-picking commit bdef74e2e.
  (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:   test/unittest/logging/LogTests.cpp
	modified:   test/unittest/logging/log_macros/LogMacros.hpp

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   test/unittest/logging/log_macros/LogMacrosDefaultTests.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

@mergify mergify bot added the conflicts Backport PR wich git cherry pick failed label Mar 20, 2024
@mergify mergify bot mentioned this pull request Mar 20, 2024
12 tasks
@EduPonz EduPonz added this to the v2.6.8 milestone Mar 20, 2024
@Mario-DL
Copy link
Member

@MiguelCompany would you mind addressing the conflicts here ?

@Mario-DL
Copy link
Member

Friendly ping @MiguelCompany

Signed-off-by: Miguel Company <[email protected]>
@MiguelCompany MiguelCompany removed the conflicts Backport PR wich git cherry pick failed label Mar 25, 2024
@MiguelCompany
Copy link
Member

Friendly ping @MiguelCompany

@Mario-DL done

@Mario-DL Mario-DL closed this Mar 25, 2024
@Mario-DL Mario-DL reopened this Mar 25, 2024
@Mario-DL
Copy link
Member

@richiprosima please test this

@Mario-DL Mario-DL added the ci-pending PR which CI is running label Mar 25, 2024
Copy link
Member

@Mario-DL Mario-DL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Github CI test fails are unrelated. Jenkins green.

@Mario-DL Mario-DL 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 Mar 25, 2024
@EduPonz EduPonz merged commit b29c6c0 into 2.6.x Mar 26, 2024
17 of 21 checks passed
@EduPonz EduPonz deleted the mergify/bp/2.6.x/pr-4582 branch March 26, 2024 07:22
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.

3 participants