Merge "Close files on image create"

Author: Jenkins

openstackclient/image/v1/image.py

@@ -15,6 +15,7 @@
 
 """Image V1 Action Implementations"""
 
+import io
 import logging
 import os
 import six
@@ -214,40 +215,46 @@ def take_action(self, parsed_args):
             elif parsed_args.file:
                 # Send an open file handle to glanceclient so it will
                 # do a chunked transfer
-                kwargs["data"] = open(parsed_args.file, "rb")
+                kwargs["data"] = io.open(parsed_args.file, "rb")
             else:
                 # Read file from stdin
-                kwargs["data"] = None
                 if sys.stdin.isatty() is not True:
                     if msvcrt:
                         msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
                     # Send an open file handle to glanceclient so it will
                     # do a chunked transfer
                     kwargs["data"] = sys.stdin
 
+        # Wrap the call to catch exceptions in order to close files
         try:
-            image = utils.find_resource(
-                image_client.images,
-                parsed_args.name,
-            )
-
-            # Preserve previous properties if any are being set now
-            if image.properties:
-                if parsed_args.properties:
-                    image.properties.update(kwargs['properties'])
-                kwargs['properties'] = image.properties
-
-        except exceptions.CommandError:
-            if not parsed_args.volume:
-                # This is normal for a create or reserve (create w/o an image)
-                # But skip for create from volume
-                image = image_client.images.create(**kwargs)
-        else:
-            # Update an existing reservation
+            try:
+                image = utils.find_resource(
+                    image_client.images,
+                    parsed_args.name,
+                )
 
-            # If an image is specified via --file, --location or
-            # --copy-from let the API handle it
-            image = image_client.images.update(image.id, **kwargs)
+                # Preserve previous properties if any are being set now
+                if image.properties:
+                    if parsed_args.properties:
+                        image.properties.update(kwargs['properties'])
+                    kwargs['properties'] = image.properties
+
+            except exceptions.CommandError:
+                if not parsed_args.volume:
+                    # This is normal for a create or reserve (create w/o
+                    # an image), but skip for create from volume
+                    image = image_client.images.create(**kwargs)
+            else:
+                # Update an existing reservation
+
+                # If an image is specified via --file, --location or
+                # --copy-from let the API handle it
+                image = image_client.images.update(image.id, **kwargs)
+        finally:
+            # Clean up open files - make sure data isn't a string
+            if ('data' in kwargs and hasattr(kwargs['data'], 'close') and
+               kwargs['data'] != sys.stdin):
+                    kwargs['data'].close()
 
         info = {}
         info.update(image._info)

openstackclient/tests/image/v1/test_image.py

@@ -139,14 +139,17 @@ def test_image_reserve_options(self):
         self.assertEqual(image_fakes.IMAGE_columns, columns)
         self.assertEqual(image_fakes.IMAGE_data, data)
 
-    @mock.patch('six.moves.builtins.open')
-    def test_image_create_file(self, open_mock):
+    @mock.patch('openstackclient.image.v1.image.io.open', name='Open')
+    def test_image_create_file(self, mock_open):
+        mock_file = mock.MagicMock(name='File')
+        mock_open.return_value = mock_file
+        mock_open.read.return_value = image_fakes.image_data
         mock_exception = {
             'find.side_effect': exceptions.CommandError('x'),
             'get.side_effect': exceptions.CommandError('x'),
         }
         self.images_mock.configure_mock(**mock_exception)
-        open_mock.return_value = image_fakes.image_data
+
         arglist = [
             '--file', 'filer',
             '--unprotected',
@@ -169,7 +172,11 @@ def test_image_create_file(self, open_mock):
         # DisplayCommandBase.take_action() returns two tuples
         columns, data = self.cmd.take_action(parsed_args)
 
-        open_mock.assert_called_with('filer', 'rb')
+        # Ensure input file is opened
+        mock_open.assert_called_with('filer', 'rb')
+
+        # Ensure the input file is closed
+        mock_file.close.assert_called_with()
 
         # ImageManager.get(name)
         self.images_mock.get.assert_called_with(image_fakes.image_name)
@@ -185,7 +192,7 @@ def test_image_create_file(self, open_mock):
                 'Alpha': '1',
                 'Beta': '2',
             },
-            data=image_fakes.image_data,
+            data=mock_file,
         )
 
         # Verify update() was not called, if it was show the args