-
Notifications
You must be signed in to change notification settings - Fork 31
refactor: handle INJECT_FACTS_AS_VARS=false by using ansible_facts instead #480
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
Conversation
Reviewer's GuideRefactors the role and tests to stop using deprecated top-level Ansible fact variables and instead consistently reference facts via ansible_facts, updating required fact lists, conditionals, templates, task commands, and documentation accordingly. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
[citest] |
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 found 2 issues, and left some high level feedback:
- In the Jinja templates (e.g. input_ovirt.j2), the use of single quotes around ansible_facts keys inside single-quoted strings (
'{{ ansible_facts['fqdn'] }}') will break parsing; switch either the outer quotes to double quotes or the inner ones to double quotes (e.g."{{ ansible_facts['fqdn'] }}"or'{{ ansible_facts["fqdn"] }}'). - Where you now access ansible_facts keys directly (e.g.
ansible_facts['domain'],ansible_facts['hostname']), consider usingansible_facts.get('...')or providing a safe default in Jinja to avoid hard failures if a fact is missing or partially gathered.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the Jinja templates (e.g. input_ovirt.j2), the use of single quotes around ansible_facts keys inside single-quoted strings (`'{{ ansible_facts['fqdn'] }}'`) will break parsing; switch either the outer quotes to double quotes or the inner ones to double quotes (e.g. `"{{ ansible_facts['fqdn'] }}"` or `'{{ ansible_facts["fqdn"] }}'`).
- Where you now access ansible_facts keys directly (e.g. `ansible_facts['domain']`, `ansible_facts['hostname']`), consider using `ansible_facts.get('...')` or providing a safe default in Jinja to avoid hard failures if a fact is missing or partially gathered.
## Individual Comments
### Comment 1
<location> `roles/rsyslog/templates/input_ovirt.j2:57` </location>
<code_context>
set $!message = $.ovirt!message;
set $!level = $.ovirt!level;
- set $!hostname = '{{ ansible_fqdn }}';
+ set $!hostname = '{{ ansible_facts['fqdn'] }}';
set $!ovirt!cluster_name = '{{ __ovirt_vds_cluster_name }}';
- set $!ipaddr4 = '{{ ansible_default_ipv4.address }}';
</code_context>
<issue_to_address>
**issue (bug_risk):** The quoting here is invalid Jinja and will likely break template rendering.
This line uses single quotes for both the Jinja expression and the dictionary key, which is invalid syntax. Use different quote types for the outer string and the key, e.g.
```j2
set $!hostname = '{{ ansible_facts["fqdn"] }}';
```
or:
```j2
set $!hostname = "{{ ansible_facts['fqdn'] }}";
```
</issue_to_address>
### Comment 2
<location> `roles/rsyslog/templates/input_ovirt.j2:59` </location>
<code_context>
+ set $!hostname = '{{ ansible_facts['fqdn'] }}';
set $!ovirt!cluster_name = '{{ __ovirt_vds_cluster_name }}';
- set $!ipaddr4 = '{{ ansible_default_ipv4.address }}';
+ set $!ipaddr4 = '{{ ansible_facts['default_ipv4']['address'] }}';
set $!ovirt!engine_fqdn = '{{ __ovirt_engine_fqdn }}';
set $.input_type = "ovirt";
</code_context>
<issue_to_address>
**issue (bug_risk):** Similar quoting issue here will cause a Jinja syntax error.
This uses single quotes for both the Jinja string and the dict keys, which is invalid. Use alternating quote styles, e.g.:
```j2
set $!ipaddr4 = '{{ ansible_facts["default_ipv4"]["address"] }}';
```
or:
```j2
set $!ipaddr4 = "{{ ansible_facts['default_ipv4']['address'] }}";
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
ac702e7 to
6c563c0
Compare
|
[citest] |
…stead 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. 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 <[email protected]>
6c563c0 to
3f9681c
Compare
|
[citest] |
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.
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 [email protected]
Summary by Sourcery
Update role and tests to use ansible_facts lookups instead of deprecated fact variables, ensuring compatibility with INJECT_FACTS_AS_VARS=false and newer Ansible versions.
Enhancements:
Documentation:
Tests: