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 #182
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 and test environments to run Ansible with facts not injected as variables, and adjusts role variables accordingly to remain compatible under the new behavior. Flow diagram for Ansible fact usage in bootloader role variablesflowchart TD
A["Start CI test run"] --> B["Ansible collects facts from managed_host"]
B --> C["SR_ANSIBLE_INJECT_FACT_VARS=false applied in CI"]
C --> D["Ansible config INJECT_FACTS_AS_VARS=false"]
D --> E["Evaluate role vars in vars/main.yml"]
E --> F["__bootloader_rh_distros and __bootloader_rh_distros_fedora defined"]
F --> G["__bootloader_is_rh_distro: ansible_distribution in __bootloader_rh_distros"]
G --> H["__bootloader_is_rh_distro_fedora: ansible_distribution in __bootloader_rh_distros_fedora"]
H --> I["Conditionals in tasks use these booleans"]
I --> J["Tasks execute based on detected distribution type"]
J --> K["End CI test run"]
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 variable changes in
vars/main.ymlandtests/vars/rh_distros_vars.ymlswitch fromansible_facts['distribution']toansible_distribution, which goes in the opposite direction of the PR description (facts-as-vars is what’s being deprecated); these should likely remain or be converted to theansible_facts[...]style if the goal is to be future-proof withANSIBLE_INJECT_FACT_VARS=false. - In the
tft.ymlworkflow you setSR_ANSIBLE_INJECT_FACT_VARS=falseinstead ofANSIBLE_INJECT_FACT_VARS=false; please double-check that the underlying tooling actually propagatesSR_ANSIBLE_INJECT_FACT_VARSinto the Ansible environment, otherwise this change will not have the intended effect.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The variable changes in `vars/main.yml` and `tests/vars/rh_distros_vars.yml` switch from `ansible_facts['distribution']` to `ansible_distribution`, which goes in the opposite direction of the PR description (facts-as-vars is what’s being deprecated); these should likely remain or be converted to the `ansible_facts[...]` style if the goal is to be future-proof with `ANSIBLE_INJECT_FACT_VARS=false`.
- In the `tft.yml` workflow you set `SR_ANSIBLE_INJECT_FACT_VARS=false` instead of `ANSIBLE_INJECT_FACT_VARS=false`; please double-check that the underlying tooling actually propagates `SR_ANSIBLE_INJECT_FACT_VARS` into the Ansible environment, otherwise this change will not have the intended effect.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
Align Ansible variable usage and CI configuration with the desired facts-as-vars behavior.
Enhancements:
CI: