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

Use a shared task file to run the tlog role after clearing Ansible facts so tests verify the role gathers all required facts itself.

Tests:

• Replace direct role/import_role usage in tlog test playbooks with a helper task file that clears facts then runs the role, optionally exposing public variables.
• Stop relying on play-level gather_facts in tests_default.yml, instead invoking the role via the new run_role_with_clear_facts.yml helper.

[sourcery-ai]

Reviewer's Guide

Test playbooks now invoke the tlog role via a shared helper task file that clears Ansible facts before each role run, ensuring the role gathers required facts itself and supporting optional public variable export and controlled failure handling.

File-Level Changes

Change	Details	Files
Introduce a reusable helper task file to clear Ansible facts and run the tlog role with optional public vars and custom failure handling.	Add tests/tasks/run_role_with_clear_facts.yml which first executes meta: clear_facts and then includes the linux-system-roles.tlog role Implement __sr_tasks_from, __sr_public, and __sr_failed_when parameters to control tasks_from, public var export, and failure handling semantics Use a block/rescue wrapper to simulate include_role with failed_when: false by swallowing failures when __sr_failed_when is explicitly false and running the role normally otherwise	tests/tasks/run_role_with_clear_facts.yml
Refactor existing tests to call the tlog role through the new helper task instead of using roles/import_role directly, and ensure public vars are exported where needed.	Update tests_sssd.yml test cases to replace direct import_role calls with include_tasks: tasks/run_role_with_clear_facts.yml, passing __sr_public: true for scenarios that rely on role-exported variables Change tests_cockpit.yml to run the role using the helper task for both with and without cockpit cases, passing __sr_public: true so tests can access role variables Modify tests_default.yml to remove the roles section and gather_facts configuration, and instead run the tlog role via the helper task under tasks Adjust tests_default_vars.yml to invoke the tlog role through the helper task with __sr_public: true before asserting that all variables are defined Update tests_example.yml to drop the roles section and run the README example via the helper task under tasks	tests/tests_sssd.yml tests/tests_cockpit.yml tests/tests_default.yml tests/tests_default_vars.yml tests/tests_example.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:

• Switching from roles:/import_role to include_tasks: run_role_with_clear_facts.yml changes the default public behavior of the role, so it’s worth double-checking all call sites that rely on role-exported variables and explicitly pass __sr_public: true there (or set a default inside run_role_with_clear_facts.yml).
• The debug in the rescue block of run_role_with_clear_facts.yml will fire on every ignored failure and may add a lot of noise to test output; consider adding a verbosity parameter or a more concise message so failures are still traceable without overwhelming logs.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Switching from `roles:`/`import_role` to `include_tasks: run_role_with_clear_facts.yml` changes the default `public` behavior of the role, so it’s worth double-checking all call sites that rely on role-exported variables and explicitly pass `__sr_public: true` there (or set a default inside `run_role_with_clear_facts.yml`).
- The `debug` in the rescue block of `run_role_with_clear_facts.yml` will fire on every ignored failure and may add a lot of noise to test output; consider adding a `verbosity` parameter or a more concise message so failures are still traceable without overwhelming logs.

---

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

[richm]

[citest]

[richm]

[citest]

[richm]

[citest]

[richm]

[citest_bad]