Fix raw_vars functionality for Ansible 2.4.1 #915
Merged
Conversation
This file contains 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
In Ansible 2.4.1 only, the VariableManager get_vars() does not return
group vars unless method parameters include a task object. Trellis
raw_vars functionality did not pass a task and thus did not receive
group vars and could not wrap the variable values in `{% raw %}`.
Temporarily feed a dummy Task() to get_vars() as a temporary fix
until the Trellis minimum Ansible requirement >= 2.4.2, when the
issue should be resolved in upstream Ansible.
|
👍 |
primozcigler
added a commit
to primozcigler/trellis
that referenced
this pull request
Nov 19, 2017
* tag '1.0.0-rc.2': 1.0.0-rc.2 Update to WP-CLI 1.4.1. Disallow duplicate site keys within a host's wordpress_sites (roots#910) Replace bare Dataloader() with pre-loaded play._loader (roots#917) Remove outdated to_unicode import from plugin utils (roots#916) Fix raw_vars functionality for Ansible 2.4.1 (roots#915) Enable ioapic Update vagrant_box_version to current release
primozcigler
added a commit
to proteusthemes/pt-ops
that referenced
this pull request
Jan 5, 2018
* trellis/master: (292 commits) Bump Ansible version_tested_max to 2.4.2.0 (roots#932) Add MariaDB 10.2 PPA Remove cron_file if WP system cron disabled (roots#927) Add Code of Conduct [ci skip] Expose the deploy_helper keep_releases option (roots#922) Close roots#580 - Switch from .dev to .test Update acme-tiny commit hash Enable select deploy configs to optionally vary by site (roots#919) 1.0.0-rc.2 Update to WP-CLI 1.4.1. Disallow duplicate site keys within a host's wordpress_sites (roots#910) Replace bare Dataloader() with pre-loaded play._loader (roots#917) Remove outdated to_unicode import from plugin utils (roots#916) Fix raw_vars functionality for Ansible 2.4.1 (roots#915) Enable ioapic Update vagrant_box_version to current release Dynamically increase ansible_group_priority for selected env (roots#909) Bump Ansible version_tested_max to 2.4.1.0 (roots#911) Clarify DB task name. Update wp-cli to 1.4.0. ...
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.
This PR fixes broken
raw_varsfunctionality for Ansible 2.4.1.Background. In contrast to prior versions, Ansible 2.4.1 populates
basedirsonly if ataskis passed to theVariableManager'sget_vars(). Without a knownbasedir, nogroup_varsfiles are loaded, such thatget_vars()no longer returns any group vars, only host vars and play vars. Thebasedirsdefinitions and group vars retrieval should go back to normal in Ansible 2.4.2 (fix in ansible/ansible#32269).Implications for Trellis. The Trellis
raw_varsfeature retrieves and wraps var values in{% raw %}using thev2_playbook_on_play_startcallback, not during any particular task. Thus Trellis did not pass anytasktoget_vars(). With Ansible 2.4.1, this means theraw_varsfeature couldn't find nor process any group vars, risking jinja templating errors (e.g., for password vars with random characters).Implementation. This PR passes a dummy
Task()toget_vars()just sobasedirswill be populated and group vars retrieved. The is no other effect of passing in thetask:task._roleisNone,task.environmentisNone, andtask.get_vars()returns{}.Future. It should be ok to remove the dummy
taskonce the Trellis minimum requirement for Ansible is 2.4.2+. I decided not to bother making the dummy task conditional on Ansible version 2.4.1 given that it had no problematic effects in 2.4.0 nor in 2.4.2.0-0.2.beta2.