Skip to content

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

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#176
richm merged 1 commit intolinux-system-roles:mainfrom
richm:clear_facts

Conversation

@richm
Copy link
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

Update test playbooks to run the postgresql role via a shared task file that clears facts before each invocation, ensuring the role gathers any facts it relies on.

Tests:

  • Add a shared task file that clears Ansible facts then runs the postgresql role, supporting control over tasks_from, public vars export, and failure handling.
  • Refactor existing postgresql role tests to include the new task file instead of calling the role directly and remove now-unnecessary gather_facts settings.

…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 spetrosi as a code owner March 19, 2026 22:48
@sourcery-ai
Copy link

sourcery-ai bot commented Mar 19, 2026

Reviewer's Guide

Adds a reusable test task file that clears Ansible facts before invoking the postgresql role, then updates existing tests to use it so that the role’s fact-gathering behavior is exercised and failure-handling semantics can be controlled via variables.

File-Level Changes

Change Details Files
Introduce a shared test task file that clears facts and then runs the postgresql role with optional failure-handling control.
  • Add tests/tasks/run_role_with_clear_facts.yml that first performs meta: clear_facts, then conditionally runs linux-system-roles.postgresql via include_role depending on __sr_failed_when.
  • Implement a special block that simulates include_role failed_when=false semantics by catching failures and emitting a debug message instead of failing.
  • Expose inputs __sr_tasks_from, __sr_public, and __sr_failed_when to parameterize which role tasks run, whether variables are public, and how failures are treated.
tests/tasks/run_role_with_clear_facts.yml
Refactor tests to invoke the postgresql role through the new clear-facts wrapper instead of including the role directly.
  • Replace include_role calls with include_tasks: tasks/run_role_with_clear_facts.yml in install_and_check.yml and pass __sr_public where previously public: true was used.
  • Switch tests that previously disabled fact gathering to rely on the wrapper task file, removing explicit gather_facts settings from several playbooks.
  • Update tests that use input files or config files to pass __sr_public and any existing role vars through the new wrapper so behavior remains equivalent while starting from cleared facts.
tests/tasks/install_and_check.yml
tests/tests_input_file.yml
tests/tests_config_files.yml
tests/tests_bootc_e2e.yml
tests/tests_default.yml
tests/tests_include_vars_from_parent.yml
tests/tests_versions.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

@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
Copy link
Contributor Author

richm commented Mar 19, 2026

[citest]

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