From ce1accedbce1d841d2fa88676fabbdaa1487f92f Mon Sep 17 00:00:00 2001
From: Alex Willmer <alex@moreati.org.uk>
Date: Fri, 30 Aug 2024 16:00:52 +0100
Subject: [PATCH] tests: Refactor Ansible copy integration tests to be loop
 driven

This is in anticipation of #1110, which only exhibits inside a with_items:
loop. For this refactor `loop:` is used, to confirm the refactored tests are
still correct. A subsequent commit will change them to with_items.

The content of the files and their SHA1 checksums are unchanged.
---
 tests/ansible/integration/action/copy.yml | 125 +++++++++++-----------
 1 file changed, 62 insertions(+), 63 deletions(-)

diff --git a/tests/ansible/integration/action/copy.yml b/tests/ansible/integration/action/copy.yml
index 73f3bd1e..cbebe3ab 100644
--- a/tests/ansible/integration/action/copy.yml
+++ b/tests/ansible/integration/action/copy.yml
@@ -2,91 +2,90 @@
 
 - name: integration/action/copy.yml
   hosts: test-targets
-  tasks:
-    - name: Create tiny file
-      copy:
-        dest: /tmp/copy-tiny-file
-        content:
-          this is a tiny file.
-      delegate_to: localhost
-      run_once: true
+  vars:
+    sourced_files:
+      - src: /tmp/copy-tiny-file
+        dest: /tmp/copy-tiny-file.out
+        content: this is a tiny file.
+        expected_checksum: f29faa9a6f19a700a941bf2aa5b281643c4ec8a0
+      - src: /tmp/copy-large-file
+        dest: /tmp/copy-large-file.out
+        content: "{{ 'x' * 200000 }}"
+        expected_checksum: 62951f943c41cdd326e5ce2b53a779e7916a820d
+
+    inline_files:
+      - dest: /tmp/copy-tiny-inline-file.out
+        content: tiny inline content
+        expected_checksum: b26dd6444595e2bdb342aa0a91721b57478b5029
+      - dest: /tmp/copy-large-inline-file.out
+        content: |
+          {{ 'y' * 200000 }}
+        expected_checksum: d675f47e467eae19e49032a2cc39118e12a6ee72
 
-    - name: Create large file
+    files: "{{ sourced_files + inline_files }}"
+  tasks:
+    - name: Create sourced files
       copy:
-        dest: /tmp/copy-large-file
-        # Must be larger than Connection.SMALL_SIZE_LIMIT.
-        content: "{% for x in range(200000) %}x{% endfor %}"
+        dest: "{{ item.src }}"
+        content: "{{ item.content }}"
+        mode: u=rw,go=r
+      loop: "{{ sourced_files }}"
+      loop_control:
+        label: "{{ item.src }}"
       delegate_to: localhost
       run_once: true
 
-    - name: Cleanup copied files
+    - name: Cleanup lingering destination files
       file:
+        path: "{{ item.dest }}"
         state: absent
-        path: "{{item}}"
-      with_items:
-      - /tmp/copy-tiny-file.out
-      - /tmp/copy-large-file.out
-      - /tmp/copy-tiny-inline-file.out
-      - /tmp/copy-large-inline-file.out
+      loop: "{{ files }}"
+      loop_control:
+        label: "{{ item.dest }}"
 
-    - name: Copy large file
+    - name: Copy sourced files
       copy:
-        dest: /tmp/copy-large-file.out
-        src: /tmp/copy-large-file
-
-    - name: Copy tiny file
-      copy:
-        dest: /tmp/copy-tiny-file.out
-        src: /tmp/copy-tiny-file
+        src: "{{ item.src }}"
+        dest: "{{ item.dest }}"
+        mode: u=rw,go=r
+      loop: "{{ sourced_files }}"
+      loop_control:
+        label: "{{ item.dest }}"
 
-    - name: Copy tiny inline file
+    - name: Copy inline files
       copy:
-        dest: /tmp/copy-tiny-inline-file.out
-        content: "tiny inline content"
-
-    - name: Copy large inline file
-      copy:
-        dest: /tmp/copy-large-inline-file.out
-        content: |
-          {% for x in range(200000) %}y{% endfor %}
+        dest: "{{ item.dest }}"
+        content: "{{ item.content }}"
+        mode: u=rw,go=r
+      loop: "{{ inline_files }}"
+      loop_control:
+        label: "{{ item.dest }}"
 
     # stat results
 
     - name: Stat copied files
       stat:
-        path: "{{item}}"
-      with_items:
-      - /tmp/copy-tiny-file.out
-      - /tmp/copy-large-file.out
-      - /tmp/copy-tiny-inline-file.out
-      - /tmp/copy-large-inline-file.out
+        path: "{{ item.dest }}"
+      loop: "{{ files }}"
+      loop_control:
+        label: "{{ item.dest }}"
       register: stat
 
     - assert:
         that:
-        - stat.results[0].stat.checksum == "f29faa9a6f19a700a941bf2aa5b281643c4ec8a0"
-        - stat.results[1].stat.checksum == "62951f943c41cdd326e5ce2b53a779e7916a820d"
-        - stat.results[2].stat.checksum == "b26dd6444595e2bdb342aa0a91721b57478b5029"
-        - stat.results[3].stat.checksum == "d675f47e467eae19e49032a2cc39118e12a6ee72"
-        fail_msg: stat={{stat}}
+          - item.stat.checksum == item.item.expected_checksum
+        quiet: true  # Avoid spamming stdout with 400 kB of item.item.content
+        fail_msg: item={{ item }}
+      loop: "{{ stat.results }}"
+      loop_control:
+        label: "{{ item.stat.path }}"
 
-    - name: Cleanup files
+    - name: Cleanup destination files
       file:
+        path: "{{ item.dest }}"
         state: absent
-        path: "{{item}}"
-      with_items:
-      - /tmp/copy-tiny-file
-      - /tmp/copy-tiny-file.out
-      - /tmp/copy-no-mode
-      - /tmp/copy-no-mode.out
-      - /tmp/copy-with-mode
-      - /tmp/copy-with-mode.out
-      - /tmp/copy-large-file
-      - /tmp/copy-large-file.out
-      - /tmp/copy-tiny-inline-file.out
-      - /tmp/copy-large-inline-file
-      - /tmp/copy-large-inline-file.out
-
-    # end of cleaning out files (again)
+      loop: "{{ files }}"
+      loop_control:
+        label: "{{ item.dest }}"
   tags:
     - copy