Skip to content

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

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

Conversation

@richm
Copy link
Copy Markdown
Collaborator

@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

Ensure kernel_settings role tests run the role with cleared Ansible facts to verify it gathers required facts explicitly.

New Features:

  • Add a reusable test task file to clear Ansible facts and invoke the kernel_settings role with configurable options.

Enhancements:

  • Refactor existing kernel_settings tests to use a shared task file for invoking the role instead of including the role directly, removing explicit fact gathering from 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>
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Mar 19, 2026

Reviewer's Guide

Test playbooks now invoke the kernel_settings role through a shared task file that clears facts before each role run, and a helper task file simulates include_role semantics (including public and failed_when behavior) while ensuring the role itself gathers any facts it relies on rather than depending on pre-gathered facts.

File-Level Changes

Change Details Files
Introduce a shared task wrapper that clears Ansible facts before running the kernel_settings role to validate fact-gathering behavior and emulate include_role options.
  • Added tests/tasks/run_role_with_clear_facts.yml that first runs meta: clear_facts, then conditionally includes linux-system-roles.kernel_settings with __sr_failed_when=false semantics via a block/rescue, and finally includes the role normally when failures should be propagated.
  • Parameterized the wrapper with __sr_tasks_from, __sr_public, and __sr_failed_when to mirror include_role tasks_from, public, and failed_when behaviors.
tests/tasks/run_role_with_clear_facts.yml
Update existing tests to use the new wrapper instead of including the role directly and adjust fact-gathering at the play level.
  • Replaced direct include_role calls for linux-system-roles.kernel_settings with include_tasks: tasks/run_role_with_clear_facts.yml in change_settings, simple_settings, default, bool_not_allowed, and cleanup-related tests, passing __sr_public where previously public: true was used.
  • Removed explicit gather_facts configuration from tests that no longer need it because the role is expected to gather the facts it needs itself.
tests/tests_change_settings.yml
tests/tests_simple_settings.yml
tests/tests_default.yml
tests/tests_bool_not_allowed.yml
tests/tasks/cleanup.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 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
Copy Markdown
Collaborator Author

richm commented Mar 19, 2026

[citest]

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