Add docker_container_copy_into module (#545)

* Move copying functionality to module_utils. * Add docker_container_copy_into module. * Use new module in other tests. * Fix copyright and attributes. * Improve idempotency, improve stat code. * Document and test when a stopped container works. * Improve owner/group detection error handling when container is stopped. * Fix formulation. Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com> * Improve file comparison. * Avoid reading whole file at once. * Stream when fetching files from daemon. * Fix comment. * Use read() instead of read1(). * Stream files when copying into container. * Linting. * Add force parameter. * Simplify library code. * Linting. * Add content and content_is_b64 options. * Make force=false work as for copy module: only copy if the destination does not exist. * Improve docs. * content should be no_log. * Implement diff mode. * Improve error handling. * Lint and improve. * Set owner/group ID to avoid ID lookup (which fails in paused containers). * Apply suggestions from code review Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com> Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
2026-07-29 11:55:04 +00:00 · 2023-01-09 11:52:29 +01:00
parent 134d32cae6
commit e198e4ab43
26 changed files with 3920 additions and 101 deletions
@@ -0,0 +1,29 @@
+# Copyright 2022 Red Hat | Ansible
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import pytest
+import tarfile
+
+from ansible_collections.community.docker.plugins.module_utils._scramble import (
+    scramble,
+    unscramble,
+)
+
+
+@pytest.mark.parametrize('plaintext, key, scrambled', [
+    (u'', b'0', '=S='),
+    (u'hello', b'\x00', '=S=aGVsbG8='),
+    (u'hello', b'\x01', '=S=aWRtbW4='),
+])
+def test_scramble_unscramble(plaintext, key, scrambled):
+    scrambled_ = scramble(plaintext, key)
+    print('{0!r} == {1!r}'.format(scrambled_, scrambled))
+    assert scrambled_ == scrambled
+
+    plaintext_ = unscramble(scrambled, key)
+    print('{0!r} == {1!r}'.format(plaintext_, plaintext))
+    assert plaintext_ == plaintext
@@ -0,0 +1,78 @@
+# Copyright 2022 Red Hat | Ansible
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import pytest
+import tarfile
+
+from ansible_collections.community.docker.plugins.module_utils.copy import (
+    _stream_generator_to_fileobj,
+)
+
+
+def _simple_generator(sequence):
+    for elt in sequence:
+        yield elt
+
+
+@pytest.mark.parametrize('chunks, read_sizes', [
+    (
+        [
+            (1, b'1'),
+            (1, b'2'),
+            (1, b'3'),
+            (1, b'4'),
+        ],
+        [
+            1,
+            2,
+            3,
+        ]
+    ),
+    (
+        [
+            (1, b'123'),
+            (1, b'456'),
+            (1, b'789'),
+        ],
+        [
+            1,
+            4,
+            2,
+            2,
+            2,
+        ]
+    ),
+    (
+        [
+            (10 * 1024 * 1024, b'0'),
+            (10 * 1024 * 1024, b'1'),
+        ],
+        [
+            1024 * 1024 - 5,
+            5 * 1024 * 1024 - 3,
+            10 * 1024 * 1024 - 2,
+            2 * 1024 * 1024 - 1,
+            2 * 1024 * 1024 + 5 + 3 + 2 + 1,
+        ]
+    ),
+])
+def test__stream_generator_to_fileobj(chunks, read_sizes):
+    chunks = [count * data for count, data in chunks]
+    stream = _simple_generator(chunks)
+    expected = b''.join(chunks)
+
+    buffer = b''
+    totally_read = 0
+    f = _stream_generator_to_fileobj(stream)
+    for read_size in read_sizes:
+        chunk = f.read(read_size)
+        assert len(chunk) == min(read_size, len(expected) - len(buffer))
+        buffer += chunk
+        totally_read += read_size
+
+    assert buffer == expected[:len(buffer)]
+    assert min(totally_read, len(expected)) == len(buffer)