tests: Improve Ansible fail_msg formatting

By switching to block style (`|`) with clip (no `-` or `+`) the failure messages don't require quoting and gain a single trailing newline. This causes Ansible to print them as block style, when using the yaml stdout callback plugin. As a result the values have one less layer of quoting and quote escaping, making them much easier to read.
mitogen-hq · Oct 6, 2024 · 6accc87 · 6accc87
1 parent 17d3f39
commit 6accc87
Show file tree

Hide file tree

Showing 96 changed files with 407 additions and 193 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -23,6 +23,7 @@ Unreleased
 
 * :gh:issue:`1106` :mod:`ansible_mitogen`: Support for `ansible_ssh_password`
   connection variable, and templated SSH connection password.
+* :gh:issue:`1136` tests: Improve Ansible fail_msg formatting.
 
 
 v0.3.11 (2024-10-30)

diff --git a/tests/ansible/integration/action/copy.yml b/tests/ansible/integration/action/copy.yml
@@ -77,7 +77,8 @@
         that:
           - item.stat.checksum == item.item.expected_checksum
         quiet: true  # Avoid spamming stdout with 400 kB of item.item.content
-        fail_msg: item={{ item }}
+        fail_msg: |
+          item={{ item }}
       with_items: "{{ stat.results }}"
       loop_control:
         label: "{{ item.stat.path }}"

diff --git a/tests/ansible/integration/action/fixup_perms2__copy.yml b/tests/ansible/integration/action/fixup_perms2__copy.yml
@@ -16,7 +16,8 @@
     - assert:
         that:
         -  out.stat.mode in ("0644", "0664")
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: "Copy files from content: arg"
       copy:
@@ -29,7 +30,8 @@
     - assert:
         that:
         -  out.stat.mode == "0400"
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: Cleanup local weird mode file
       file:
@@ -55,7 +57,8 @@
     - assert:
         that:
         - out.stat.mode in ("0644", "0664")
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: Copy file with weird mode, preserving mode
       copy:
@@ -69,7 +72,8 @@
     - assert:
         that:
         - out.stat.mode == "1462"
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: Copy file with weird mode, explicit mode
       copy:
@@ -84,7 +88,8 @@
     - assert:
         that:
         - out.stat.mode == "1461"
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: Cleanup
       file:

diff --git a/tests/ansible/integration/action/low_level_execute_command.yml b/tests/ansible/integration/action/low_level_execute_command.yml
@@ -15,7 +15,8 @@
           - 'raw.rc == 0'
           - 'raw.stdout_lines[-1]|to_text == "2"'
           - 'raw.stdout[-1]|to_text == "2"'
-        fail_msg: raw={{raw}}
+        fail_msg: |
+          raw={{ raw }}
 
     - name: Run raw module with sudo
       become: true
@@ -39,6 +40,7 @@
             ["root\r\n"],
             ["root"],
           )
-        fail_msg: raw={{raw}}
+        fail_msg: |
+          raw={{ raw }}
   tags:
     - low_level_execute_command
diff --git a/tests/ansible/integration/action/make_tmp_path.yml b/tests/ansible/integration/action/make_tmp_path.yml
@@ -42,13 +42,17 @@
       assert:
         that:
         - good_temp_path == good_temp_path2
-        fail_msg: good_temp_path={{good_temp_path}} good_temp_path2={{good_temp_path2}}
+        fail_msg: |
+          good_temp_path={{ good_temp_path }}
+          good_temp_path2={{ good_temp_path2 }}
 
     - name: "Verify different subdir for both tasks"
       assert:
         that:
         - tmp_path.path != tmp_path2.path
-        fail_msg: tmp_path={{tmp_path}} tmp_path2={{tmp_path2}}
+        fail_msg: |
+          tmp_path={{ tmp_path }}
+          tmp_path2={{ tmp_path2 }}
 
     #
     # Verify subdirectory removal.
@@ -69,7 +73,9 @@
         that:
         - not stat1.stat.exists
         - not stat2.stat.exists
-        fail_msg: stat1={{stat1}} stat2={{stat2}}
+        fail_msg: |
+          stat1={{ stat1 }}
+          stat2={{ stat2 }}
 
     #
     # Verify good directory persistence.
@@ -84,7 +90,8 @@
       assert:
         that:
         - stat.stat.exists
-        fail_msg: stat={{stat}}
+        fail_msg: |
+          stat={{ stat }}
 
     #
     # Write some junk into the temp path.
@@ -107,7 +114,8 @@
     - assert:
         that:
         - not out.stat.exists
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     #
     # root
@@ -126,7 +134,9 @@
         that:
         - tmp_path2.path != tmp_path_root.path
         - tmp_path2.path|dirname != tmp_path_root.path|dirname
-        fail_msg: tmp_path_root={{tmp_path_root}} tmp_path2={{tmp_path2}}
+        fail_msg: |
+          tmp_path_root={{ tmp_path_root }}
+          tmp_path2={{ tmp_path2 }}
 
     #
     # readonly homedir
@@ -157,7 +167,8 @@
         that:
         - out.module_path.startswith(good_temp_path2)
         - out.module_tmpdir.startswith(good_temp_path2)
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
   tags:
     - make_tmp_path
     - mitogen_only
diff --git a/tests/ansible/integration/action/remote_expand_user.yml b/tests/ansible/integration/action/remote_expand_user.yml
@@ -26,7 +26,8 @@
       register: out
     - assert:
         that: out.result == user_facts.ansible_facts.ansible_user_dir ~ '/foo'
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: "Expand ~/foo with become active. ~ is become_user's home."
       action_passthrough:
@@ -49,7 +50,8 @@
       register: out
     - assert:
         that: out.result == user_facts.ansible_facts.ansible_user_dir ~ '/foo'
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: "Expanding $HOME/foo has no effect."
       action_passthrough:
@@ -60,7 +62,8 @@
       register: out
     - assert:
         that: out.result == '$HOME/foo'
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     # ------------------------
 
@@ -73,7 +76,8 @@
       register: out
     - assert:
         that: out.result == user_facts.ansible_facts.ansible_user_dir ~ '/foo'
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: "sudoable; Expand ~/foo with become active. ~ is become_user's home."
       action_passthrough:
@@ -97,7 +101,8 @@
       register: out
     - assert:
         that: out.result == user_facts.ansible_facts.ansible_user_dir ~ '/foo'
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: "sudoable; Expanding $HOME/foo has no effect."
       action_passthrough:
@@ -108,6 +113,7 @@
       register: out
     - assert:
         that: out.result == '$HOME/foo'
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
   tags:
     - remote_expand_user
diff --git a/tests/ansible/integration/action/remote_file_exists.yml b/tests/ansible/integration/action/remote_file_exists.yml
@@ -12,7 +12,8 @@
       register: out
     - assert:
         that: out.result == False
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: Ensure does-exist does
       copy:
@@ -24,7 +25,8 @@
       register: out
     - assert:
         that: out.result == True
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: Cleanup
       file:

diff --git a/tests/ansible/integration/action/remove_tmp_path.yml b/tests/ansible/integration/action/remove_tmp_path.yml
@@ -23,7 +23,8 @@
     - assert:
         that:
         - not out2.stat.exists
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - stat:
         path: "{{out.src|dirname}}"
@@ -32,7 +33,8 @@
     - assert:
         that:
         - not out2.stat.exists
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - file:
         path: /tmp/remove_tmp_path_test

diff --git a/tests/ansible/integration/action/synchronize.yml b/tests/ansible/integration/action/synchronize.yml
@@ -66,7 +66,8 @@
 
         - assert:
             that: outout == "item!"
-            fail_msg: outout={{outout}}
+            fail_msg: |
+              outout={{ outout }}
       when: False
 
     # TODO: https://github.com/dw/mitogen/issues/692

diff --git a/tests/ansible/integration/action/transfer_data.yml b/tests/ansible/integration/action/transfer_data.yml
@@ -22,7 +22,8 @@
     - assert:
         that: |
           out.content|b64decode == '{"I am JSON": true}'
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: Create text transfer data
       action_passthrough:
@@ -37,7 +38,8 @@
     - assert:
         that:
           out.content|b64decode == 'I am text.'
-        fail_msg: out={{out}}
+        fail_msg: |
+          out={{ out }}
 
     - name: Cleanup transfer data
       file:

diff --git a/tests/ansible/integration/async/multiple_items_loop.yml b/tests/ansible/integration/async/multiple_items_loop.yml
@@ -33,6 +33,7 @@
       - out.results[1].stdout == 'hi-from-job-2'
       - out.results[1].rc == 0
       - out.results[1].delta > '0:00:05'
-      fail_msg: out={{out}}
+      fail_msg: |
+        out={{ out }}
   tags:
     - multiple_items_loop
diff --git a/tests/ansible/integration/async/result_binary_producing_json.yml b/tests/ansible/integration/async/result_binary_producing_json.yml
@@ -27,7 +27,8 @@
         (job.started == 1) and
         (job.changed == True) and
         (job.finished == 0)
-      fail_msg: job={{job}}
+      fail_msg: |
+        job={{ job }}
 
   - name: busy-poll up to 100000 times
     async_status:
@@ -52,7 +53,8 @@
         - async_out.failed == False
         - async_out.msg == "Hello, world."
         - 'async_out.stderr == "binary_producing_json: oh noes\n"'
-      fail_msg: async_out={{async_out}}
+      fail_msg: |
+        async_out={{ async_out }}
     vars:
       async_out: "{{result.content|b64decode|from_json}}"
   tags:

diff --git a/tests/ansible/integration/async/result_binary_producing_junk.yml b/tests/ansible/integration/async/result_binary_producing_junk.yml
@@ -38,7 +38,8 @@
         - async_out.msg.startswith("Traceback")
         - '"ValueError: No start of json char found\n" in async_out.msg'
         - 'async_out.stderr == "binary_producing_junk: oh noes\n"'
-      fail_msg: async_out={{async_out}}
+      fail_msg: |
+        async_out={{ async_out }}
     vars:
       async_out: "{{result.content|b64decode|from_json}}"
   tags:

diff --git a/tests/ansible/integration/async/result_shell_echo_hi.yml b/tests/ansible/integration/async/result_shell_echo_hi.yml
@@ -42,14 +42,16 @@
         - async_out.start.startswith("20")
         - async_out.stderr == "there"
         - async_out.stdout == "hi"
-      fail_msg: async_out={{async_out}}
+      fail_msg: |
+        async_out={{ async_out }}
     vars:
       async_out: "{{result.content|b64decode|from_json}}"
 
   - assert:
       that:
         - async_out.invocation.module_args.stdin == None
-      fail_msg: async_out={{async_out}}
+      fail_msg: |
+        async_out={{ async_out }}
     when:
       - ansible_version.full is version('2.4', '>=', strict=True)
     vars:

diff --git a/tests/ansible/integration/async/runner_new_process.yml b/tests/ansible/integration/async/runner_new_process.yml
@@ -15,7 +15,9 @@
   - assert:
       that:
       - sync_proc1.pid == sync_proc2.pid
-      fail_msg: sync_proc1={{sync_proc1}} sync_proc2={{sync_proc2}}
+      fail_msg: |
+        sync_proc1={{ sync_proc1 }}
+        sync_proc2={{ sync_proc2 }}
     when: is_mitogen
 
   - name: get async process ID.
@@ -52,7 +54,9 @@
       - sync_proc1.pid == sync_proc2.pid
       - async_result1.pid != sync_proc1.pid
       - async_result1.pid != async_result2.pid
-      fail_msg: async_result1={{async_result1}} async_result2={{async_result2}}
+      fail_msg: |
+        async_result1={{ async_result1 }}
+        async_result2={{ async_result2 }}
     when: is_mitogen
   tags:
     - runner_new_process