Fixes flaky RobotState test (backport #3105)

[mergify[bot]]

Description

Fixes #3103 by ensuring that the dirty_link_transforms_ member is cleared before querying the RobotState

See #3102 for more details on the cause.

TLDR:

Setting the build type to Release causes tests to silently fail, whereas Debug does not (some tests rely on assert calls, which are enabled / disabled based on the presence of the NDBUG macro variable, which is set by CMake depending on the build type).

See the SonarScan pipeline call to ros-industrial/industrial_ci@master, which sets DCMAKE_BUILD_TYPE to Debug (and where the tests fail), and the same call in the rolling-ci pipeline (where the tests pass), which sets the same variable to Release.

I've also added a comment (and demonstration of the fix, at least for this test) locally.

Checklist

• [x] Required by CI: Code is auto formatted using clang-format
• [x] Extend the tutorials / documentation reference
• [x] Document API changes relevant to the user in the MIGRATION.md notes
• [x] Create tests, which fail without this PR reference
• [x] Include a screenshot if changing a GUI
• [ ] While waiting for someone to review your request, please help review another open pull request to support the maintainers

---

This is an automatic backport of pull request #3105 done by Mergify.

[mergify[bot]]

Cherry-pick of f20265a5a2551b3270373d6ff6925c1299adc6c6 has failed:

On branch mergify/bp/humble/pr-3105
Your branch is up to date with 'origin/humble'.

You are currently cherry-picking commit f20265a5a.
  (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)

Unmerged paths:
  (use "git add <file>..." to mark resolution)
    both modified:   moveit_core/robot_state/test/robot_state_test.cpp

no changes added to commit (use "git add" and/or "git commit -a")

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

[TSNoble]

@sea-bass Thanks for fixing the conflicts 😄