Skip to content

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

Merged
richm merged 1 commit intolinux-system-roles:mainfrom
richm:clear_facts
Mar 19, 2026
Merged

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

Conversation

@richm
Copy link
Copy Markdown
Contributor

@richm richm commented Mar 19, 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.

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by Sourcery

Run the rhc role in tests via a helper task file that clears facts before each invocation to verify the role gathers the facts it requires.

Tests:

  • Add a shared test task file that clears Ansible facts then runs the rhc role, optionally exposing public vars and handling expected failures.
  • Update all rhc role tests to use the new helper task file instead of including the role directly, and stop explicitly disabling fact gathering in those playbooks.

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

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm requested a review from ptoscano as a code owner March 19, 2026 23:07
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Mar 19, 2026

Reviewer's Guide

Refactors all role invocations in the test playbooks to run through a new helper task file that clears Ansible facts before including the linux-system-roles.rhc role, enabling verification that the role gathers required facts itself and adding support for a simulated failed_when=false behavior via wrapper variables.

File-Level Changes

Change Details Files
Introduce a helper task file that clears facts then runs the linux-system-roles.rhc role, with optional behavior flags.
  • Add tests/tasks/run_role_with_clear_facts.yml which first executes meta: clear_facts.
  • In the helper, conditionally run the role inside a block/rescue when __sr_failed_when is explicitly false to ignore role failures.
  • Run the role normally with configurable tasks_from and public export controlled via __sr_tasks_from and __sr_public variables, defaulting to main and false.
  • Use a when condition with default to true on __sr_failed_when to decide whether to run the normal role task.
tests/tasks/run_role_with_clear_facts.yml
Update all test playbooks to invoke the role via the new helper tasks instead of include_role, and stop disabling fact gathering at the play level.
  • Remove gather_facts: false from multiple test plays so that test behavior around facts is controlled by the helper file instead.
  • Replace include_role: name: linux-system-roles.rhc with include_tasks: tasks/run_role_with_clear_facts.yml across all tests.
  • Where tests previously set include_role.public: true, pass __sr_public: true to the helper to preserve variable export semantics.
  • Preserve all existing vars passed to the role by passing them unchanged alongside the new helper-specific variables.
tests/tests_proxy.yml
tests/tests_register_unregister.yml
tests/tests_release.yml
tests/tests_insights_ansible_host.yml
tests/tests_insights_display_name.yml
tests/tests_insights_client_register.yml
tests/tests_insights_tags.yml
tests/tests_insights_autoupdate.yml
tests/tests_insights_remediation.yml
tests/tests_repositories.yml
tests/tests_environments.yml
tests/tests_default.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

@richm
Copy link
Copy Markdown
Contributor Author

richm commented Mar 19, 2026

[citest]

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 reviewed your changes and they look great!


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 richm merged commit d7b12e8 into linux-system-roles:main Mar 19, 2026
29 checks passed
@richm richm deleted the clear_facts branch March 19, 2026 23:34
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