Skip to content

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

Merged
richm merged 1 commit into
linux-system-roles:mainfrom
richm:clear_facts
Apr 10, 2026
Merged

test: ensure role gathers the facts it uses by having test clear_facts before include_role#24
richm merged 1 commit into
linux-system-roles:mainfrom
richm:clear_facts

Conversation

@richm
Copy link
Copy Markdown
Collaborator

@richm richm commented Apr 9, 2026

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.

@richm richm requested a review from spetrosi as a code owner April 9, 2026 14:03
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Apr 9, 2026

Reviewer's Guide

Refactors trustee_client role tests to run the role via a shared task file that clears Ansible facts before each invocation, ensuring the role gathers its own required facts and simplifying test playbooks.

File-Level Changes

Change Details Files
Introduce a shared task helper to clear facts then run the trustee_client role, with optional failure handling semantics mirroring include_role parameters.
  • Create tests/tasks/run_role_with_clear_facts.yml that first runs meta: clear_facts before including the linux-system-roles.trustee_client role.
  • Support __sr_tasks_from, __sr_public, and __sr_failed_when variables to mimic include_role tasks_from/public/failed_when behavior.
  • Implement a block/rescue pattern to ignore role failures when __sr_failed_when is explicitly set to false, while running the role normally otherwise.
tests/tasks/run_role_with_clear_facts.yml
Update existing trustee_client tests to use the new helper task file instead of direct role inclusion and remove explicit gather_facts settings.
  • Replace roles: linux-system-roles.trustee_client with an include_tasks call to tasks/run_role_with_clear_facts.yml, passing __sr_public: true where needed.
  • Switch tests that previously used include_role for trustee_client to instead include the shared run_role_with_clear_facts.yml helper.
  • Remove explicit gather_facts declarations from test playbooks, relying on the helper to manage fact state via meta: clear_facts.
tests/tests_kbs_config.yml
tests/tests_default.yml
tests/tests_secret_registration_client.yml
tests/tests_encrypt_disk.yml
tests/tests_trustee_gc_disabled.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

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • In several test playbooks you removed gather_facts: false from the play while adding run_role_with_clear_facts.yml; since the play-level default is gather_facts: true, this now does an unnecessary initial fact gathering that is immediately cleared—consider restoring gather_facts: false on those plays to match the description and avoid redundant work.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In several test playbooks you removed `gather_facts: false` from the play while adding `run_role_with_clear_facts.yml`; since the play-level default is `gather_facts: true`, this now does an unnecessary initial fact gathering that is immediately cleared—consider restoring `gather_facts: false` on those plays to match the description and avoid redundant work.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@richm
Copy link
Copy Markdown
Collaborator Author

richm commented Apr 9, 2026

[citest]

@richm richm self-assigned this Apr 9, 2026
…s before include_role

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.

Also includes changes to support Ansible partner certification checking

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm
Copy link
Copy Markdown
Collaborator Author

richm commented Apr 9, 2026

[citest]

@richm richm merged commit f3c7c03 into linux-system-roles:main Apr 10, 2026
36 checks passed
@richm richm deleted the clear_facts branch April 10, 2026 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant