Skip to content

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

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#223
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 nbde_server role tests through a shared task wrapper that clears Ansible facts before each role invocation to verify the role gathers required facts itself.

Tests:

  • Introduce a reusable tests/tasks/run_role_with_clear_facts.yml helper to clear facts and then run the nbde_server role, with optional control over tasks_from, public vars, and failure handling.
  • Update nbde_server test playbooks to use the new helper instead of include_role directly, passing __sr_public where needed and no longer relying on play-level 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>
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Mar 19, 2026

Reviewer's Guide

This PR refactors nbde_server role tests to run the role via a shared task helper that clears Ansible facts before each role invocation and adds optional failure-handling semantics, ensuring the role correctly gathers the facts it relies on even under explicit fact gathering settings.

File-Level Changes

Change Details Files
Introduce a reusable helper task file that clears facts then runs the nbde_server role, with optional failure suppression semantics.
  • Create tests/tasks/run_role_with_clear_facts.yml to first run meta: clear_facts then include the linux-system-roles.nbde_server role
  • Parameterize tasks_from, public, and failed_when behavior via __sr_tasks_from, __sr_public, and __sr_failed_when variables
  • Implement a block/rescue pattern to ignore role errors when __sr_failed_when is explicitly set to false while still executing the role normally otherwise
tests/tasks/run_role_with_clear_facts.yml
Update tests to use the new helper instead of directly including the nbde_server role and adjust fact-gathering behavior.
  • Replace include_role: linux-system-roles.nbde_server with include_tasks: tasks/run_role_with_clear_facts.yml in nbde_server-related tests
  • Pass __sr_public: true where tests previously used public: true on include_role calls
  • Drop explicit gather_facts settings from playbooks that now rely on the role to gather any required facts itself
tests/tests_nbde_server_keys_dir.yml
tests/tests_nbde_server_rotate_keys.yml
tests/tests_nbde_server_service_state.yml
tests/tests_deploy_keys.yml
tests/tests_share_system_dir.yml
tests/tests_fetch_keys_deploy_not_set.yml
tests/tests_fetch_keys_deploy_set.yml
tests/tests_tangd_custom_port.yml
tests/tests_default.yml
tests/tests_default_vars.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
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 0da9252 into linux-system-roles:main Mar 19, 2026
37 checks passed
@richm richm deleted the clear_facts branch March 19, 2026 22:32
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