Windows iSCSI driver: Fixes copy disk method exception handling

In the copy_vhd_disk method, it is assumed that if the copy operation
fails, a wmi.x_wmi exception will be raised. This is wrong. In fact,
none of the methods called there can raise such an exception in those
circumstances.

At the moment, this method will not raise an exception even if the
copy operation fails.

This patch adds a check to see if the source image actually exists.
The according CIM_DataFile Copy method's return value is checked as
well in order to see if the operation failed or not.

Change-Id: I778ecd61adb007995b629b36044caac78cd16889
Closes-Bug: #1356398

diff --git a/cinder/tests/windows/test_windows_utils.py b/cinder/tests/windows/test_windows_utils.py
new file mode 100644 (file)
index 0000000..9e2377b
--- /dev/null
+++ b/cinder/tests/windows/test_windows_utils.py
@@ -0,0 +1,61 @@
+#  Copyright 2015 Cloudbase Solutions Srl
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import mock
+
+from cinder import exception
+from cinder import test
+from cinder.volume.drivers.windows import windows_utils
+
+
+class WindowsUtilsTestCase(test.TestCase):
+
+    def setUp(self):
+        super(WindowsUtilsTestCase, self).setUp()
+
+        windows_utils.WindowsUtils.__init__ = lambda x: None
+        self.wutils = windows_utils.WindowsUtils()
+        self.wutils._conn_cimv2 = mock.MagicMock()
+
+    def _test_copy_vhd_disk(self, source_exists=True, copy_failed=False):
+        fake_data_file_object = mock.MagicMock()
+        fake_data_file_object.Copy.return_value = [int(copy_failed)]
+
+        fake_vhd_list = [fake_data_file_object] if source_exists else []
+        mock_query = mock.Mock(return_value=fake_vhd_list)
+        self.wutils._conn_cimv2.query = mock_query
+
+        if not source_exists or copy_failed:
+            self.assertRaises(exception.VolumeBackendAPIException,
+                              self.wutils.copy_vhd_disk,
+                              mock.sentinel.src,
+                              mock.sentinel.dest)
+        else:
+            self.wutils.copy_vhd_disk(mock.sentinel.src, mock.sentinel.dest)
+
+            expected_query = (
+                "Select * from CIM_DataFile where Name = '%s'" %
+                mock.sentinel.src)
+            mock_query.assert_called_once_with(expected_query)
+            fake_data_file_object.Copy.assert_called_with(
+                mock.sentinel.dest)
+
+    def test_copy_vhd_disk(self):
+        self._test_copy_vhd_disk()
+
+    def test_copy_vhd_disk_invalid_source(self):
+        self._test_copy_vhd_disk(source_exists=False)
+
+    def test_copy_vhd_disk_copy_failed(self):
+        self._test_copy_vhd_disk(copy_failed=True)

diff --git a/cinder/volume/drivers/windows/windows_utils.py b/cinder/volume/drivers/windows/windows_utils.py
index 1cbb143f059eb3e6163621f10db3db2c5eccbdcc..ae2a3c0fd5e51890e64b4f6d58c9eace94d5d7fc 100644 (file)
--- a/cinder/volume/drivers/windows/windows_utils.py
+++ b/cinder/volume/drivers/windows/windows_utils.py
@@ -311,20 +311,28 @@ class WindowsUtils(object):
 
     def copy_vhd_disk(self, source_path, destination_path):
         """Copy the vhd disk from source path to destination path."""
-        try:
-            vhdfiles = self._conn_cimv2.query(
-                "Select * from CIM_DataFile where Name = '" +
-                source_path + "'")
-            if len(vhdfiles) > 0:
-                vhdfiles[0].Copy(destination_path)
-        except wmi.x_wmi as exc:
-            err_msg = (_(
-                'copy_vhd_disk: error when copying disk from source path : '
-                '%(src_path)s to destination path: %(dest_path)s '
-                '. WMI exception: '
-                '%(wmi_exc)s') % {'src_path': source_path,
-                                  'dest_path': destination_path,
-                                  'wmi_exc': exc})
+        # Note: As WQL is a small subset of SQL which does not allow multiple
+        # queries or comments, WQL queries are not exposed to WQL injection.
+        vhdfiles = self._conn_cimv2.query(
+            "Select * from CIM_DataFile where Name = '%s'" % source_path)
+        if len(vhdfiles) > 0:
+            ret_val = vhdfiles[0].Copy(destination_path)[0]
+            if ret_val:
+                err_msg = (
+                    _('Could not copy virtual disk %(src_path)s '
+                      'to %(dest_path)s. Error code: %(error_code)s') %
+                    {'src_path': source_path,
+                     'dest_path': destination_path,
+                     'error_code': ret_val})
+                LOG.error(err_msg)
+                raise exception.VolumeBackendAPIException(data=err_msg)
+
+        else:
+            err_msg = (
+                _('Could not copy virtual disk %(src_path)s '
+                  'to %(dest_path)s. Could not find source path.') %
+                {'src_path': source_path,
+                 'dest_path': destination_path})
             LOG.error(err_msg)
             raise exception.VolumeBackendAPIException(data=err_msg)