From e3c72230cda45798b4d9bd98c7f296d2895c4027 Mon Sep 17 00:00:00 2001
From: Felix Fontein <felix@fontein.de>
Date: Thu, 17 Mar 2022 20:15:13 +0100
Subject: [PATCH] unarchive: fix io_buffer_size option, remove ignore.txt entry
 (#77271)

* Fix io_buffer_size option.

* Remove ignore.txt entry by adding action plugin only options to module's argument spec.

* Add changelog fragment.

* Adjust unit tests.
---
 changelogs/fragments/77271-unarchive.yml |  2 ++
 lib/ansible/modules/unarchive.py         | 11 +++++++++--
 test/sanity/ignore.txt                   |  1 -
 test/units/modules/test_unarchive.py     |  2 ++
 4 files changed, 13 insertions(+), 3 deletions(-)
 create mode 100644 changelogs/fragments/77271-unarchive.yml

diff --git a/changelogs/fragments/77271-unarchive.yml b/changelogs/fragments/77271-unarchive.yml
new file mode 100644
index 00000000000..deca48e5045
--- /dev/null
+++ b/changelogs/fragments/77271-unarchive.yml
@@ -0,0 +1,2 @@
+bugfixes:
+  - "unarchive - the ``io_buffer_size`` option added in 2.12 was not accepted by the module (https://github.com/ansible/ansible/pull/77271)."
diff --git a/lib/ansible/modules/unarchive.py b/lib/ansible/modules/unarchive.py
index b7a482191ef..e9062a7c79a 100644
--- a/lib/ansible/modules/unarchive.py
+++ b/lib/ansible/modules/unarchive.py
@@ -52,7 +52,7 @@ options:
     description:
       - Size of the volatile memory buffer that is used for extracting files from the archive in bytes.
     type: int
-    default: 64 KiB
+    default: 65536
     version_added: "2.12"
   list_files:
     description:
@@ -304,7 +304,7 @@ class ZipArchive(object):
         self.file_args = file_args
         self.opts = module.params['extra_opts']
         self.module = module
-        self.io_buffer_size = module.params.get("io_buffer_size", 64 * 1024)
+        self.io_buffer_size = module.params["io_buffer_size"]
         self.excludes = module.params['exclude']
         self.includes = []
         self.include_files = self.module.params['include']
@@ -976,6 +976,13 @@ def main():
             include=dict(type='list', elements='str', default=[]),
             extra_opts=dict(type='list', elements='str', default=[]),
             validate_certs=dict(type='bool', default=True),
+            io_buffer_size=dict(type='int', default=64 * 1024),
+
+            # Options that are for the action plugin, but ignored by the module itself.
+            # We have them here so that the sanity tests pass without ignores, which
+            # reduces the likelihood of further bugs added.
+            copy=dict(type='bool', default=True),
+            decrypt=dict(type='bool', default=True),
         ),
         add_file_common_args=True,
         # check-mode only works for zip files, we cover that later
diff --git a/test/sanity/ignore.txt b/test/sanity/ignore.txt
index 005434e84aa..268aeefc94f 100644
--- a/test/sanity/ignore.txt
+++ b/test/sanity/ignore.txt
@@ -94,7 +94,6 @@ lib/ansible/modules/stat.py validate-modules:undocumented-parameter
 lib/ansible/modules/systemd.py validate-modules:parameter-invalid
 lib/ansible/modules/systemd.py validate-modules:return-syntax-error
 lib/ansible/modules/sysvinit.py validate-modules:return-syntax-error
-lib/ansible/modules/unarchive.py validate-modules:nonexistent-parameter-documented
 lib/ansible/modules/uri.py validate-modules:doc-required-mismatch
 lib/ansible/modules/user.py validate-modules:doc-default-does-not-match-spec
 lib/ansible/modules/user.py validate-modules:doc-default-incompatible-type
diff --git a/test/units/modules/test_unarchive.py b/test/units/modules/test_unarchive.py
index c3300372766..3e7a58c98b8 100644
--- a/test/units/modules/test_unarchive.py
+++ b/test/units/modules/test_unarchive.py
@@ -52,6 +52,7 @@ class TestCaseZipArchive:
             "extra_opts": "",
             "exclude": "",
             "include": "",
+            "io_buffer_size": 65536,
         }
 
         z = ZipArchive(
@@ -74,6 +75,7 @@ class TestCaseTgzArchive:
             "extra_opts": "",
             "exclude": "",
             "include": "",
+            "io_buffer_size": 65536,
         }
         fake_ansible_module.check_mode = False