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.

Sign up for GitHub

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

Jump to bottom

[20655] Fix flakey Log tests #4582

Merged
merged 2 commits into from
Mar 20, 2024
Merged

[20655] Fix flakey Log tests #4582

merged 2 commits into from
Mar 20, 2024

Conversation

MiguelCompany
Copy link
Member

@MiguelCompany MiguelCompany commented Mar 19, 2024 •
edited by EduPonz
Loading

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.

@MiguelCompany
Refs #20655. Improve HELPER_WaitForEntries.
6191496 
Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
@MiguelCompany
Refs #20655. Fix default_macros_test.
35177ad 
Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
@MiguelCompany MiguelCompany added this to the v2.14.1 milestone Mar 19, 2024
@MiguelCompany MiguelCompany changed the title Fix flakey Log tests [20655] Fix flakey Log tests Mar 19, 2024
Mario-DL
Mario-DL approved these changes Mar 19, 2024
View reviewed changes
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 with green CI

@Mario-DL
Copy link
Member

@richiprosima please test this

1 similar comment
@EduPonz
Copy link

EduPonz commented Mar 20, 2024

@richiprosima please test this

@EduPonz
Copy link

EduPonz commented Mar 20, 2024

@richiprosima please test windows

@EduPonz EduPonz added the ci-pending PR which CI is running label Mar 20, 2024
@EduPonz
Copy link

EduPonz commented Mar 20, 2024

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

@EduPonz EduPonz removed the ci-pending PR which CI is running label Mar 20, 2024
@mergify Mergify
Copy link
Contributor

mergify bot commented Mar 20, 2024 •
edited
Loading

backport 2.13.x 2.10.x 2.6.x

✅ Backports have been created

@EduPonz EduPonz merged commit bdef74e into master Mar 20, 2024
13 of 15 checks passed
@EduPonz EduPonz deleted the hotfix/20655 branch March 20, 2024 18:46
mergify bot pushed a commit that referenced this pull request Mar 20, 2024
@MiguelCompany @mergify
Fix flaky Log tests (#4582)
b0795a3 
* Refs #20655. Improve HELPER_WaitForEntries.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #20655. Fix default_macros_test.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

---------

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit bdef74e)
@mergify mergify bot mentioned this pull request Mar 20, 2024
Merged
12 tasks
mergify bot pushed a commit that referenced this pull request Mar 20, 2024
@MiguelCompany @mergify
Fix flaky Log tests (#4582)
3f2cb0e 
* Refs #20655. Improve HELPER_WaitForEntries.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #20655. Fix default_macros_test.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

---------

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit bdef74e)
@mergify mergify bot mentioned this pull request Mar 20, 2024
Merged
12 tasks
mergify bot pushed a commit that referenced this pull request Mar 20, 2024
@MiguelCompany @mergify
Fix flaky Log tests (#4582)
45134f0 
* Refs #20655. Improve HELPER_WaitForEntries.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #20655. Fix default_macros_test.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

---------

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit bdef74e)

# Conflicts:
#	test/unittest/logging/log_macros/LogMacrosDefaultTests.cpp
@mergify mergify bot mentioned this pull request Mar 20, 2024
Merged
12 tasks
EduPonz pushed a commit that referenced this pull request Mar 26, 2024
@mergify @MiguelCompany
Fix flaky Log tests (#4582) (#4590)
b29c6c0 
* Fix flaky Log tests (#4582)

* Refs #20655. Improve HELPER_WaitForEntries.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #20655. Fix default_macros_test.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

---------

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit bdef74e)

# Conflicts:
#	test/unittest/logging/log_macros/LogMacrosDefaultTests.cpp

* Fix conflicts

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

---------

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
Co-authored-by: Miguel Company <miguelcompany@eprosima.com>
EduPonz pushed a commit that referenced this pull request Mar 28, 2024
@mergify @MiguelCompany
Fix flaky Log tests (#4582) (#4588)
2492cf2 
* Refs #20655. Improve HELPER_WaitForEntries.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #20655. Fix default_macros_test.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

---------

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit bdef74e)

Co-authored-by: Miguel Company <miguelcompany@eprosima.com>
MiguelCompany added a commit that referenced this pull request Mar 29, 2024
@MiguelCompany
Fix flaky Log tests (#4582)
012c487 
* Refs #20655. Improve HELPER_WaitForEntries.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #20655. Fix default_macros_test.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

---------

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit bdef74e)
MiguelCompany added a commit that referenced this pull request Mar 29, 2024
@mergify @MiguelCompany
Fix flaky Log tests (#4582) (#4589)
f2f9c2c 
* Refs #20655. Improve HELPER_WaitForEntries.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #20655. Fix default_macros_test.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

---------

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit bdef74e)

Co-authored-by: Miguel Company <miguelcompany@eprosima.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mario-DL Mario-DL Mario-DL approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.14.1
Development

Successfully merging this pull request may close these issues.
3 participants
@MiguelCompany @Mario-DL @EduPonz