Skip to content

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

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#245
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

Add a shared test task wrapper that clears Ansible facts before invoking the nbde_client role and update tests to use it for role execution.

Enhancements:

  • Introduce a reusable task wrapper that clears facts, supports public variable export, and optionally ignores role failures when executing the nbde_client role in tests.

Tests:

  • Run nbde_client role in all tests via a new run_role_with_clear_facts.yml task file instead of direct include_role/import_role usage to verify the role gathers required facts itself.

…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

sourcery-ai bot commented Mar 19, 2026

Reviewer's Guide

Refactors nbde_client role tests to run the role via a shared helper task file that clears all Ansible facts before each role invocation, and adds support variables to mimic include_role parameters while preserving test behavior and error handling semantics.

File-Level Changes

Change Details Files
Introduce a shared helper task file that clears facts then runs the nbde_client role with optional public/tasks_from/failed_when behavior.
  • Add tests/tasks/run_role_with_clear_facts.yml to call meta: clear_facts before executing the linux-system-roles.nbde_client role.
  • Expose shim variables (__sr_tasks_from, __sr_public, __sr_failed_when) that map to include_role parameters tasks_from, public, and failed_when.
  • Implement a block+rescue wrapper path that ignores role failures when __sr_failed_when is explicitly set to false, plus a normal path when it is true or undefined.
tests/tasks/run_role_with_clear_facts.yml
Update existing tests to invoke the nbde_client role via the new helper task file instead of include_role/roles usage, and adjust how public/role variables are passed.
  • Replace include_role: linux-system-roles.nbde_client calls with include_tasks: tasks/run_role_with_clear_facts.yml across nbde_client test playbooks and helper task files.
  • Where tests previously relied on include_role public: true, pass __sr_public: true into the helper include instead.
  • Switch tests/tests_default.yml from using roles: to an explicit task that includes the helper file, and remove gather_facts usage where the helper now controls fact gathering behavior.
  • Drop explicit gather_facts: true from tests that no longer need it because facts are managed inside the helper.
tests/tests_use_existing_binding.yml
tests/tests_default.yml
tests/tests_default_vars.yml
tests/tests_key_rotation.yml
tests/tests_simple_bind.yml
tests/tasks/bind_slot_with_passphrase.yml
tests/tasks/verify_idempotency.yml
tests/tests_bind_high_availability.yml
tests/tests_error_handling.yml
tests/tests_passphrase_temporary.yml
tests/tests_passphrase_temporary_keyfile.yml
tests/tests_simple_bind_keyfile.yml
tests/tests_simple_bind_unbind.yml
tests/tests_simple_bind_unbind_keyfile.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

@richm
Copy link
Contributor Author

richm commented Mar 19, 2026

[citest]

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