generated from linux-system-roles/template
-
Notifications
You must be signed in to change notification settings - Fork 13
ci: use ANSIBLE_INJECT_FACT_VARS=false by default for testing #183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ansible 2.20 has deprecated the use of Ansible facts as variables. For example, `ansible_distribution` is now deprecated in favor of `ansible_facts["distribution"]`. This is due to making the default setting `INJECT_FACTS_AS_VARS=false`. For now, this will create WARNING messages, but in Ansible 2.24 it will be an error. In order to ensure that commits and PRs conform to this, use ANSIBLE_INJECT_FACT_VARS=false by default in our CI testing. See https://docs.ansible.com/projects/ansible/latest/porting_guides/porting_guide_core_2.20.html#inject-facts-as-vars Signed-off-by: Rich Megginson <rmeggins@redhat.com>
Reviewer's guide (collapsed on small PRs)Reviewer's GuideConfigures CI to run Ansible with ANSIBLE_INJECT_FACT_VARS disabled by default and adjusts test variables and TFT workflow wiring to be compatible with this behavior. Flow diagram for SR_ANSIBLE_INJECT_FACT_VARS to Ansible behaviorflowchart TD
A[GitHubActions tft workflow sets SR_ANSIBLE_INJECT_FACT_VARS=false] --> B[Terraform TFT receives SR_ANSIBLE_INJECT_FACT_VARS]
B --> C[Terraform passes environment to Ansible test runs]
C --> D[Ansible runs with ANSIBLE_INJECT_FACT_VARS=false]
D --> E[Facts only available under ansible_facts map]
E --> F[tests vars rh_distros_vars and playbooks must use ansible_facts keys]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey - I've left some high level feedback:
- The change in tests/vars/rh_distros_vars.yml goes in the opposite direction of the description/Ansible 2.20 guidance: you’re replacing ansible_facts['distribution'] with ansible_distribution, but with ANSIBLE_INJECT_FACT_VARS=false set in CI, you should be moving to ansible_facts['distribution'] everywhere instead of using the injected variable.
- Now that ANSIBLE_INJECT_FACT_VARS/SR_ANSIBLE_INJECT_FACT_VARS is being set in the workflows, consider centralizing or reusing this configuration (e.g., via a shared action or script) so the default doesn’t silently diverge between different CI jobs in the future.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The change in tests/vars/rh_distros_vars.yml goes in the opposite direction of the description/Ansible 2.20 guidance: you’re replacing ansible_facts['distribution'] with ansible_distribution, but with ANSIBLE_INJECT_FACT_VARS=false set in CI, you should be moving to ansible_facts['distribution'] everywhere instead of using the injected variable.
- Now that ANSIBLE_INJECT_FACT_VARS/SR_ANSIBLE_INJECT_FACT_VARS is being set in the workflows, consider centralizing or reusing this configuration (e.g., via a shared action or script) so the default doesn’t silently diverge between different CI jobs in the future.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ansible 2.20 has deprecated the use of Ansible facts as variables. For
example,
ansible_distributionis now deprecated in favor ofansible_facts["distribution"]. This is due to making the defaultsetting
INJECT_FACTS_AS_VARS=false. For now, this will create WARNINGmessages, but in Ansible 2.24 it will be an error.
In order to ensure that commits and PRs conform to this, use
ANSIBLE_INJECT_FACT_VARS=false by default in our CI testing.
See https://docs.ansible.com/projects/ansible/latest/porting_guides/porting_guide_core_2.20.html#inject-facts-as-vars
Signed-off-by: Rich Megginson rmeggins@redhat.com
Summary by Sourcery
Configure CI to run Ansible with facts not injected as variables and adjust test vars accordingly.
CI:
Tests: