test: ensure role gathers the facts it uses by having test clear_facts before include_role

[richm]

The role gathers the facts it uses. For example, if the user uses
ANSIBLE_GATHERING=explicit, the role uses the setup module with the
facts and subsets it requires.

This change allows us to test this. Before every role invocation, the test
will use meta: clear_facts so that the role starts with no facts.

Create a task file tests/tasks/run_role_with_clear_facts.yml to do the tasks
to clear the facts and run the role. Note that this means we don't need to
use gather_facts for the tests.

Some vars defined using ansible_facts have been changed to be defined with
set_fact instead. This is because of the fact that vars are lazily
evaluated - the var might be referenced when the facts have been cleared, and
will issue an error like ansible_facts["distribution"] is undefined. This is
typically done for blocks that have a when condition that uses ansible_facts
and the block has a role invocation using run_role_with_clear_facts.yml
These have been rewritten to define the when condition using set_fact. This
is because the when condition is evaluated every time a task is invoked in the
block, and if the facts are cleared, this will raise an undefined variable error.

Signed-off-by: Rich Megginson [email protected]

Summary by Sourcery

Ensure the keylime_server role is executed in tests with facts cleared so it must gather the facts it uses.

Tests:

• Add a reusable test task file that clears cached facts before running the keylime_server role, with support for controlling exported vars and failure handling.
• Update existing tests to invoke the keylime_server role through the new clear-facts wrapper instead of directly including the role or gathering facts upfront.

[sourcery-ai]

Reviewer's Guide

Test playbooks now invoke the keylime_server role via a shared helper task file that clears all Ansible facts before including the role, allowing verification that the role gathers the facts it needs itself, and they add a mechanism to optionally ignore role failures in tests.

File-Level Changes

Change	Details	Files
Introduce a reusable helper task file that clears facts and then runs the keylime_server role with configurable options used by tests.	Create tests/tasks/run_role_with_clear_facts.yml which first executes meta: clear_facts and then includes the linux-system-roles.keylime_server role Add parameters __sr_tasks_from, __sr_public, and __sr_failed_when to control which tasks to run, whether to expose role variables, and whether to treat role failures as fatal Implement a block/rescue flow to simulate include_role failed_when behavior, ignoring failures when __sr_failed_when is explicitly set to false while still running the role normally when __sr_failed_when is true or undefined	tests/tasks/run_role_with_clear_facts.yml
Update existing tests to use the new helper task file instead of directly including the role or gathering facts.	Modify tests/tests_default.yml to replace direct include_role of linux-system-roles.keylime_server with include_tasks: tasks/run_role_with_clear_facts.yml while passing __sr_public: true Remove explicit gather_facts settings in tests that are now redundant because the helper clears facts before each role execution Simplify tests/tests_include_vars_from_parent.yml by dropping gather_facts: true since fact gathering is now handled by the role itself	tests/tests_default.yml tests/tests_include_vars_from_parent.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}