ci: use ANSIBLE_INJECT_FACT_VARS=false by default for testing#64
Merged
Conversation
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. Update README-ostree.md if needed. 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 tests with fact injection disabled and updates documentation to reference the new ansible_facts-based variables instead of deprecated fact vars. Sequence diagram for CI Ansible test run with ANSIBLE_INJECT_FACT_VARS disabledsequenceDiagram
title CI Ansible test run with ANSIBLE_INJECT_FACT_VARS disabled
actor Developer
participant GitHubActions
participant TFTWorkflow
participant SystemRolesTests
participant AnsibleEngine
Developer->>GitHubActions: Open PR / push commit
GitHubActions->>GitHubActions: Trigger tft workflow job
GitHubActions->>TFTWorkflow: Start job with env (SR_ANSIBLE_INJECT_FACT_VARS=false)
TFTWorkflow->>SystemRolesTests: Run tests with SR_ANSIBLE_INJECT_FACT_VARS=false
SystemRolesTests->>AnsibleEngine: Execute playbooks with INJECT_FACTS_AS_VARS=false
AnsibleEngine-->>SystemRolesTests: Use ansible_facts based variables
SystemRolesTests-->>TFTWorkflow: Report test results
TFTWorkflow-->>GitHubActions: Exit status
GitHubActions-->>Developer: CI status on PR
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In the workflows,
qemu-kvm-integration-testssetsANSIBLE_INJECT_FACT_VARSdirectly whiletft.ymlpassesSR_ANSIBLE_INJECT_FACT_VARS; consider standardizing how this is wired through (or adding a brief inline note) so it's clear where the actualANSIBLE_INJECT_FACT_VARSenvironment variable is ultimately set for Ansible.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the workflows, `qemu-kvm-integration-tests` sets `ANSIBLE_INJECT_FACT_VARS` directly while `tft.yml` passes `SR_ANSIBLE_INJECT_FACT_VARS`; consider standardizing how this is wired through (or adding a brief inline note) so it's clear where the actual `ANSIBLE_INJECT_FACT_VARS` environment variable is ultimately set for Ansible.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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
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.
Update README-ostree.md if needed.
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
Adopt Ansible's non-injected facts usage in CI and documentation to prepare for upcoming deprecations.
CI:
Documentation: