Merge "Support image save with chunk-size option"

Zuul · openstack-gerrit · commit d90e18b08cf1 · 2025-08-15T13:37:16.000Z
diff --git a/openstackclient/image/v1/image.py b/openstackclient/image/v1/image.py
@@ -528,6 +528,16 @@ class SaveImage(command.Command):
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--chunk-size",
+            type=int,
+            default=1024,
+            metavar="<chunk-size>",
+            help=_(
+                "Size in bytes to read from the wire and buffer at one "
+                "time (default: 1024)"
+            ),
+        )
         parser.add_argument(
             "--file",
             metavar="<filename>",
@@ -550,7 +560,12 @@ def take_action(self, parsed_args):
         if output_file is None:
             output_file = getattr(sys.stdout, "buffer", sys.stdout)
 
-        image_client.download_image(image.id, stream=True, output=output_file)
+        image_client.download_image(
+            image.id,
+            stream=True,
+            output=output_file,
+            chunk_size=parsed_args.chunk_size,
+        )
 
 
 class SetImage(command.Command):
diff --git a/openstackclient/image/v2/image.py b/openstackclient/image/v2/image.py
@@ -1073,6 +1073,16 @@ class SaveImage(command.Command):
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--chunk-size",
+            type=int,
+            default=1024,
+            metavar="<chunk-size>",
+            help=_(
+                "Size in bytes to read from the wire and buffer at one "
+                "time (default: 1024)"
+            ),
+        )
         parser.add_argument(
             "--file",
             metavar="<filename>",
@@ -1097,7 +1107,12 @@ def take_action(self, parsed_args):
         if output_file is None:
             output_file = getattr(sys.stdout, "buffer", sys.stdout)
 
-        image_client.download_image(image.id, stream=True, output=output_file)
+        image_client.download_image(
+            image.id,
+            stream=True,
+            output=output_file,
+            chunk_size=parsed_args.chunk_size,
+        )
 
 
 class SetImage(command.Command):
diff --git a/openstackclient/tests/unit/image/v1/test_image.py b/openstackclient/tests/unit/image/v1/test_image.py
@@ -757,3 +757,50 @@ def test_image_show_human_readable(self):
 
         size_index = columns.index('size')
         self.assertEqual(data[size_index].human_readable(), '2K')
+
+
+class TestImageSave(image_fakes.TestImagev1):
+    image = image_fakes.create_one_image({})
+
+    def setUp(self):
+        super().setUp()
+
+        self.image_client.find_image.return_value = self.image
+        self.image_client.download_image.return_value = self.image
+
+        # Get the command object to test
+        self.cmd = image.SaveImage(self.app, None)
+
+    def test_save_data(self):
+        arglist = ['--file', '/path/to/file', self.image.id]
+
+        verifylist = [('file', '/path/to/file'), ('image', self.image.id)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        self.image_client.download_image.assert_called_once_with(
+            self.image.id, output='/path/to/file', stream=True, chunk_size=1024
+        )
+
+    def test_save_data_with_chunk_size(self):
+        arglist = [
+            '--file',
+            '/path/to/file',
+            '--chunk-size',
+            '2048',
+            self.image.id,
+        ]
+
+        verifylist = [
+            ('file', '/path/to/file'),
+            ('chunk_size', 2048),
+            ('image', self.image.id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        self.image_client.download_image.assert_called_once_with(
+            self.image.id, output='/path/to/file', stream=True, chunk_size=2048
+        )
diff --git a/openstackclient/tests/unit/image/v2/test_image.py b/openstackclient/tests/unit/image/v2/test_image.py
@@ -2238,7 +2238,29 @@ def test_save_data(self):
         self.cmd.take_action(parsed_args)
 
         self.image_client.download_image.assert_called_once_with(
-            self.image.id, stream=True, output='/path/to/file'
+            self.image.id, output='/path/to/file', stream=True, chunk_size=1024
+        )
+
+    def test_save_data_with_chunk_size(self):
+        arglist = [
+            '--file',
+            '/path/to/file',
+            '--chunk-size',
+            '2048',
+            self.image.id,
+        ]
+
+        verifylist = [
+            ('filename', '/path/to/file'),
+            ('chunk_size', 2048),
+            ('image', self.image.id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        self.image_client.download_image.assert_called_once_with(
+            self.image.id, output='/path/to/file', stream=True, chunk_size=2048
         )
 
 
diff --git a/releasenotes/notes/add-chunk-size-to-image-save-37871f9e62693264.yaml b/releasenotes/notes/add-chunk-size-to-image-save-37871f9e62693264.yaml
@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Add ``--chunk-size`` option to ``image save`` command to  control the size
+    of bytes to read at one time.
