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 rmeggins@redhat.com

Summary by Sourcery

Run the linux-system-roles.template role in tests with facts cleared beforehand to validate it gathers required facts itself.

Tests:

• Add a reusable task file that clears facts and then runs the linux-system-roles.template role under configurable conditions.
• Update existing tests to invoke the role via the new clear-facts task helper instead of relying on play-level gather_facts settings.

[sourcery-ai]

Reviewer's Guide

Adds a reusable Ansible task helper to clear all facts before running the linux-system-roles.template role, and updates tests to invoke the role via this helper so that the role’s own fact gathering behavior is exercised, including optional handling of role failures via a flag.

File-Level Changes

Change	Details	Files
Introduce reusable test helper task file that clears Ansible facts then runs the template role, with optional failure-ignoring behavior.	Create tests/tasks/run_role_with_clear_facts.yml that first runs meta: clear_facts and then includes the linux-system-roles.template role. Support configurable tasks_from and public parameters for the included role via __sr_tasks_from and __sr_public variables. Add an optional __sr_failed_when flag that, when false, executes the role in a block/rescue sequence to simulate include_role with failed_when: false and ignore role failures.	tests/tasks/run_role_with_clear_facts.yml
Refactor existing tests to use the new helper task file instead of directly running the role or gathering facts.	Update tests/tests_default.yml to remove direct role usage and gather_facts, and instead include tasks/run_role_with_clear_facts.yml with __sr_public: true before header checks. Update tests/tests_include_vars_from_parent.yml to no longer rely on play-level gather_facts, preparing it to run the role with explicit fact handling.	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 left some high level feedback:

• In tests_default.yml you removed gather_facts: false, which means the play now gathers facts and then immediately clears them; if the intention is still to verify the role runs with no initial facts, consider keeping gather_facts: false to avoid the extra gather and keep the test semantics explicit.
• The new run_role_with_clear_facts.yml helper hardcodes the role name (linux-system-roles.template), which is fine for this repo but makes the helper less reusable; if you foresee using the same pattern elsewhere, consider parameterizing the role name via a variable.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In `tests_default.yml` you removed `gather_facts: false`, which means the play now gathers facts and then immediately clears them; if the intention is still to verify the role runs with no initial facts, consider keeping `gather_facts: false` to avoid the extra gather and keep the test semantics explicit.
- The new `run_role_with_clear_facts.yml` helper hardcodes the role name (`linux-system-roles.template`), which is fine for this repo but makes the helper less reusable; if you foresee using the same pattern elsewhere, consider parameterizing the role name via a variable.

---

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.}