Handle complex quoting in extra args in pull cli (#50212)

* added proper testing

fixes #40729

(cherry picked from commit b6824669df)
(cherry picked from commit e010034151)

changelogs/fragments/fix_pull_extra.yml

@@ -0,0 +1,2 @@
+bugfixes:
+    - fix ansible-pull hanlding of extra args, complex quoting is needed for inline JSON

lib/ansible/cli/pull.py

@@ -32,6 +32,7 @@ from ansible.cli import CLI
 from ansible import constants as C
 from ansible.errors import AnsibleOptionsError
 from ansible.module_utils._text import to_native, to_text
+from ansible.module_utils.six.moves import shlex_quote
 from ansible.plugins.loader import module_loader
 from ansible.utils.cmd_functions import run_cmd
 
@@ -234,7 +235,7 @@ class PullCLI(CLI):
         cmd = '%s/ansible %s %s -m %s -a "%s" all -l "%s"' % (bin_path, inv_opts, base_opts, self.options.module_name, repo_opts, limit_opts)
 
         for ev in self.options.extra_vars:
-            cmd += ' -e "%s"' % ev
+            cmd += ' -e %s' % shlex_quote(ev)
 
         # Nap?
         if self.options.sleep:
@@ -269,7 +270,7 @@ class PullCLI(CLI):
                 cmd += " --vault-id=%s" % vault_id
 
         for ev in self.options.extra_vars:
-            cmd += ' -e "%s"' % ev
+            cmd += ' -e %s' % shlex_quote(ev)
         if self.options.ask_sudo_pass or self.options.ask_su_pass or self.options.become_ask_pass:
             cmd += ' --ask-become-pass'
         if self.options.skip_tags:

test/integration/targets/pull/pull-integration-test/local.yml

@@ -11,3 +11,9 @@
       failed_when: "'testhost1.example.com' == inventory_hostname"
     - name: final task, has to be reached for the test to succeed
       debug: msg="MAGICKEYWORD"
+
+    - name: check that extra vars are correclty passed
+      assert:
+        that:
+            - docker_registries_login is defined
+      tags: ['never', 'test_ev']

test/integration/targets/pull/runme.sh

@@ -23,21 +23,34 @@ cd "${repo_dir}"
     git commit -m "Initial commit."
 )
 
+function pass_tests {
+	# test for https://github.com/ansible/ansible/issues/13688
+	if ! grep MAGICKEYWORD "${temp_log}"; then
+	    echo "Missing MAGICKEYWORD in output."
+	    exit 1
+	fi
+
+	# test for https://github.com/ansible/ansible/issues/13681
+	if egrep '127\.0\.0\.1.*ok' "${temp_log}"; then
+	    echo "Found host 127.0.0.1 in output. Only localhost should be present."
+	    exit 1
+	fi
+	# make sure one host was run
+	if ! egrep 'localhost.*ok' "${temp_log}"; then
+	    echo "Did not find host localhost in output."
+	    exit 1
+	fi
+}
+
 ANSIBLE_CONFIG='' ansible-pull -d "${pull_dir}" -U "${repo_dir}" "$@" | tee "${temp_log}"
 
-# test for https://github.com/ansible/ansible/issues/13688
+pass_tests
-if ! grep MAGICKEYWORD "${temp_log}"; then
+
-    echo "Missing MAGICKEYWORD in output."
+# ensure complex extra vars work
-    exit 1
+PASSWORD='test'
-fi
+USER=${USER:-'broken_docker'}
-
+JSON_EXTRA_ARGS='{"docker_registries_login": [{ "docker_password": "'"${PASSWORD}"'", "docker_username": "'"${USER}"'", "docker_registry_url":"repository-manager.company.com:5001"}], "docker_registries_logout": [{ "docker_password": "'"${PASSWORD}"'", "docker_username": "'"${USER}"'", "docker_registry_url":"repository-manager.company.com:5001"}] }'
-# test for https://github.com/ansible/ansible/issues/13681
+
-if egrep '127\.0\.0\.1.*ok' "${temp_log}"; then
+ANSIBLE_CONFIG='' ansible-pull -d "${pull_dir}" -U "${repo_dir}" -e "${JSON_EXTRA_ARGS}" "$@" --tags untagged,test_ev | tee "${temp_log}"
-    echo "Found host 127.0.0.1 in output. Only localhost should be present."
+
-    exit 1
+pass_tests
-fi
-# make sure one host was run
-if ! egrep 'localhost.*ok' "${temp_log}"; then
-    echo "Did not find host localhost in output."
-    exit 1
-fi