Allow to specify the image type to upload

When trying to just replace a single image in the overcloud,
the client is asking for all the images to be present in
the working directory. Allowing to pass an image-type flag
(with os/ipa values), that will restrict the upload to that type.

Change-Id: I4e48458f83d2a646aad873b0577dc3bea766d2d7
Fixes-Bug: #1778500

releasenotes/notes/upload-only-existing-images-4c84a73dddd6c862.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - Add a new feature called image-type, that accepts 'os' and
+    'ironic-python-agent' values.
+    When specified, it restricts the image to upload to that type, making it
+    easier to replace ipa/os images without having to collect the full set in
+    our working directory.

tripleoclient/tests/v1/overcloud_image/test_overcloud_image.py

@@ -831,3 +831,120 @@ class TestUploadOvercloudImageFullMultiArch(TestPluginV1):
             mock.call('sudo cp -f "./ironic-python-agent.initramfs" '
                       '"/httpboot/p9-ppc64le/agent.ramdisk"', shell=True),
         ])
+
+
+class TestUploadOnlyExisting(TestPluginV1):
+    def setUp(self):
+        super(TestUploadOnlyExisting, self).setUp()
+
+        # Get the command object to test
+        self.cmd = overcloud_image.UploadOvercloudImage(self.app, None)
+        self.app.client_manager.image = mock.Mock()
+        self.app.client_manager.image.version = 2.0
+        self.app.client_manager.image.images.create.return_value = (
+            mock.Mock(id=10, name='imgname', properties={},
+                      created_at='2015-07-31T14:37:22.000000'))
+        self.cmd._check_file_exists = mock.Mock()
+        self.cmd._read_image_file_pointer = mock.Mock(return_value=b'IMGDATA')
+
+    @mock.patch('subprocess.check_call', autospec=True)
+    @mock.patch('os.path.isfile', autospec=True)
+    def test_overcloud_upload_just_ipa_wholedisk(
+            self, mock_isfile_call, mock_subprocess_call):
+        self.cmd._image_changed = mock.Mock(return_value=True)
+        self.cmd._image_try_update = mock.Mock(return_value=None)
+        self.cmd._read_image_file_pointer = mock.Mock(return_value=b'IMGDATA')
+
+        parsed_args = self.check_parser(
+            self.cmd, ['--whole-disk', '--image-type=ironic-python-agent'], [])
+
+        self.cmd._files_changed = mock.Mock(return_value=True)
+        self.cmd.take_action(parsed_args)
+
+        # ensure check_file_exists has not been called
+        self.assertItemsEqual(self.cmd._check_file_exists.call_args_list,
+                              [mock.call('./ironic-python-agent.initramfs'),
+                               mock.call('./ironic-python-agent.kernel')])
+
+        # ensure try_update has been called just with ipa
+        files = []
+        for item in self.cmd._image_try_update.call_args_list:
+            files.append(item[0][1])
+        self.assertEqual(files, ['./ironic-python-agent.kernel',
+                                 './ironic-python-agent.initramfs'])
+
+    @mock.patch('subprocess.check_call', autospec=True)
+    @mock.patch('os.path.isfile', autospec=True)
+    def test_overcloud_upload_just_os_wholedisk(
+            self, mock_isfile_call, mock_subprocess_call):
+        self.cmd._image_changed = mock.Mock(return_value=True)
+        self.cmd._image_try_update = mock.Mock(return_value=None)
+        self.cmd._read_image_file_pointer = mock.Mock(return_value=b'IMGDATA')
+
+        parsed_args = self.check_parser(
+            self.cmd, ['--whole-disk', '--image-type=os'], [])
+
+        self.cmd._files_changed = mock.Mock(return_value=True)
+        self.cmd.take_action(parsed_args)
+
+        # ensure check_file_exists has been called just with ipa
+        self.assertItemsEqual(self.cmd._check_file_exists.call_args_list,
+                              [mock.call('./overcloud-full.qcow2')])
+
+        # ensure try_update has been called just with ipa
+        files = []
+        for item in self.cmd._image_try_update.call_args_list:
+            files.append(item[0][1])
+        self.assertEqual(files, ['./overcloud-full.qcow2'])
+
+    @mock.patch('subprocess.check_call', autospec=True)
+    @mock.patch('os.path.isfile', autospec=True)
+    def test_overcloud_upload_just_ipa(
+            self, mock_isfile_call, mock_subprocess_call):
+        self.cmd._image_changed = mock.Mock(return_value=True)
+        self.cmd._image_try_update = mock.Mock(return_value=None)
+        self.cmd._read_image_file_pointer = mock.Mock(return_value=b'IMGDATA')
+
+        parsed_args = self.check_parser(
+            self.cmd, ['--image-type=ironic-python-agent'], [])
+
+        self.cmd._files_changed = mock.Mock(return_value=True)
+        self.cmd.take_action(parsed_args)
+
+        # ensure check_file_exists has been called just with ipa
+        self.assertItemsEqual(self.cmd._check_file_exists.call_args_list,
+                              [mock.call('./ironic-python-agent.initramfs'),
+                               mock.call('./ironic-python-agent.kernel')])
+
+        # ensure try_update has been called just with ipa
+        files = []
+        for item in self.cmd._image_try_update.call_args_list:
+            files.append(item[0][1])
+        self.assertEqual(files, ['./ironic-python-agent.kernel',
+                                 './ironic-python-agent.initramfs'])
+
+    @mock.patch('subprocess.check_call', autospec=True)
+    @mock.patch('os.path.isfile', autospec=True)
+    def test_overcloud_upload_just_os(
+            self, mock_isfile_call, mock_subprocess_call):
+        self.cmd._image_changed = mock.Mock(return_value=True)
+        self.cmd._image_try_update = mock.Mock(return_value=None)
+        self.cmd._read_image_file_pointer = mock.Mock(return_value=b'IMGDATA')
+
+        parsed_args = self.check_parser(
+            self.cmd, ['--image-type=os'], [])
+
+        self.cmd._files_changed = mock.Mock(return_value=True)
+        self.cmd.take_action(parsed_args)
+
+        # ensure check_file_exists has been called just with ipa
+        self.assertItemsEqual(self.cmd._check_file_exists.call_args_list,
+                              [mock.call('./overcloud-full.qcow2')])
+
+        # ensure try_update has been called just with ipa
+        files = []
+        for item in self.cmd._image_try_update.call_args_list:
+            files.append(item[0][1])
+        self.assertEqual(files, ['./overcloud-full.vmlinuz',
+                                 './overcloud-full.initrd',
+                                 './overcloud-full.qcow2'])

tripleoclient/v1/overcloud_image.py

@@ -289,6 +289,14 @@ class UploadOvercloudImage(command.Command):
                    "generic images for x86_64 but offer images specific to "
                    "SandyBridge (SNB)."),
         )
+        parser.add_argument(
+            "--image-type",
+            dest="image_type",
+            choices=["os", "ironic-python-agent"],
+            help=_("If specified, allows to restrict the image type to upload "
+                   "(os for the overcloud image or ironic-python-agent for "
+                   "the ironic-python-agent one)"),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -302,17 +310,18 @@ class UploadOvercloudImage(command.Command):
 
         self.log.debug("checking if image files exist")
 
+        image_files = []
+        if parsed_args.image_type is None or \
+                parsed_args.image_type == 'ironic-python-agent':
+            image_files.append('%s.initramfs' % parsed_args.ipa_name)
+            image_files.append('%s.kernel' % parsed_args.ipa_name)
+
+        if parsed_args.image_type is None or parsed_args.image_type == 'os':
+            image_files.append(parsed_args.os_image_name)
+
         if parsed_args.whole_disk:
-            image_files = [
-                parsed_args.os_image_name
-            ]
             overcloud_image_type = 'whole disk'
         else:
-            image_files = [
-                '%s.initramfs' % parsed_args.ipa_name,
-                '%s.kernel' % parsed_args.ipa_name,
-                parsed_args.os_image_name
-            ]
             overcloud_image_type = 'partition'
 
         for image in image_files:
@@ -332,6 +341,7 @@ class UploadOvercloudImage(command.Command):
         if platform:
             properties['tripleo_platform'] = platform
 
+        if parsed_args.image_type is None or parsed_args.image_type == 'os':
             # vmlinuz and initrd only need to be uploaded for a partition image
             if not parsed_args.whole_disk:
                 (oc_vmlinuz_name,
@@ -383,7 +393,8 @@ class UploadOvercloudImage(command.Command):
                                        is_public=True,
                                        disk_format='qcow2',
                                        container_format='bare',
-                                   properties=dict({'kernel_id': kernel.id,
+                                       properties=dict(
+                                           {'kernel_id': kernel.id,
                                             'ramdisk_id': ramdisk.id},
                                            **properties),
                                        data=self._read_image_file_pointer(
@@ -395,10 +406,12 @@ class UploadOvercloudImage(command.Command):
                 img_ramdisk_id = glance_client_adaptor.get_image_property(
                     overcloud_image, 'ramdisk_id')
                 # check overcloud image links
-            if (img_kernel_id != kernel.id or img_ramdisk_id != ramdisk.id):
+                if (img_kernel_id != kernel.id or
+                        img_ramdisk_id != ramdisk.id):
                     self.log.error('Link overcloud image to it\'s initrd and '
                                    'kernel images is MISSING OR leads to OLD '
-                               'image. You can keep it or fix it manually.')
+                                   'image. You can keep it or fix it '
+                                   'manually.')
 
             else:
                 (oc_name,
@@ -421,6 +434,8 @@ class UploadOvercloudImage(command.Command):
 
             self.log.debug("uploading bm images to glance")
 
+        if parsed_args.image_type is None or \
+                parsed_args.image_type == 'ironic-python-agent':
             (deploy_kernel_name,
              deploy_kernel_extension) = plugin_utils.deploy_kernel(
                  arch=arch, platform=platform)