From: Sergey Vilgelm <sergey@vilgelm.info>
Date: Wed, 8 Jul 2015 12:18:13 +0000 (+0300)
Subject: Switch to the oslo_utils.fileutils
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=212aff327a36f925be3be69b9b54b946dbdd5c2a;p=openstack-build%2Fcinder-build.git

Switch to the oslo_utils.fileutils

fileutils is graduated in the oslo.utils library.
Use the open function from builtins instead of fileutils.file_open.
Change the test_backup_volume (test_scality module) and
test_restore_backup (test_scality, test_volume) functions to use
mock library instead of mox.

Implements: blueprint graduate-fileutils[1]
[1] https://blueprints.launchpad.net/oslo-incubator/+spec/graduate-fileutils

Change-Id: I7abf0273bf2b90c72f51ebf4896808eaabb91969
---

diff --git a/cinder/image/image_utils.py b/cinder/image/image_utils.py
index 76897c186..05477f597 100644
--- a/cinder/image/image_utils.py
+++ b/cinder/image/image_utils.py
@@ -33,12 +33,12 @@ import tempfile
 from oslo_concurrency import processutils
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_utils import fileutils
 from oslo_utils import timeutils
 from oslo_utils import units
 
 from cinder import exception
 from cinder.i18n import _, _LI, _LW
-from cinder.openstack.common import fileutils
 from cinder.openstack.common import imageutils
 from cinder import utils
 from cinder.volume import throttling
@@ -343,11 +343,11 @@ def upload_volume(context, image_service, image_meta, volume_path,
         LOG.debug("%s was %s, no need to convert to %s",
                   image_id, volume_format, image_meta['disk_format'])
         if os.name == 'nt' or os.access(volume_path, os.R_OK):
-            with fileutils.file_open(volume_path, 'rb') as image_file:
+            with open(volume_path, 'rb') as image_file:
                 image_service.update(context, image_id, {}, image_file)
         else:
             with utils.temporary_chown(volume_path):
-                with fileutils.file_open(volume_path) as image_file:
+                with open(volume_path) as image_file:
                     image_service.update(context, image_id, {}, image_file)
         return
 
@@ -378,7 +378,7 @@ def upload_volume(context, image_service, image_meta, volume_path,
                 reason=_("Converted to %(f1)s, but format is now %(f2)s") %
                 {'f1': image_meta['disk_format'], 'f2': data.file_format})
 
-        with fileutils.file_open(tmp, 'rb') as image_file:
+        with open(tmp, 'rb') as image_file:
             image_service.update(context, image_id, {}, image_file)
 
 
diff --git a/cinder/openstack/common/fileutils.py b/cinder/openstack/common/fileutils.py
deleted file mode 100644
index 1191ce8f4..000000000
--- a/cinder/openstack/common/fileutils.py
+++ /dev/null
@@ -1,149 +0,0 @@
-# Copyright 2011 OpenStack Foundation.
-# All Rights Reserved.
-#
-#    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 contextlib
-import errno
-import logging
-import os
-import stat
-import tempfile
-
-from oslo_utils import excutils
-
-LOG = logging.getLogger(__name__)
-
-_FILE_CACHE = {}
-DEFAULT_MODE = stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO
-
-
-def ensure_tree(path, mode=DEFAULT_MODE):
-    """Create a directory (and any ancestor directories required)
-
-    :param path: Directory to create
-    :param mode: Directory creation permissions
-    """
-    try:
-        os.makedirs(path, mode)
-    except OSError as exc:
-        if exc.errno == errno.EEXIST:
-            if not os.path.isdir(path):
-                raise
-        else:
-            raise
-
-
-def read_cached_file(filename, force_reload=False):
-    """Read from a file if it has been modified.
-
-    :param force_reload: Whether to reload the file.
-    :returns: A tuple with a boolean specifying if the data is fresh
-              or not.
-    """
-    global _FILE_CACHE
-
-    if force_reload:
-        delete_cached_file(filename)
-
-    reloaded = False
-    mtime = os.path.getmtime(filename)
-    cache_info = _FILE_CACHE.setdefault(filename, {})
-
-    if not cache_info or mtime > cache_info.get('mtime', 0):
-        LOG.debug("Reloading cached file %s", filename)
-        with open(filename) as fap:
-            cache_info['data'] = fap.read()
-        cache_info['mtime'] = mtime
-        reloaded = True
-    return (reloaded, cache_info['data'])
-
-
-def delete_cached_file(filename):
-    """Delete cached file if present.
-
-    :param filename: filename to delete
-    """
-    global _FILE_CACHE
-
-    if filename in _FILE_CACHE:
-        del _FILE_CACHE[filename]
-
-
-def delete_if_exists(path, remove=os.unlink):
-    """Delete a file, but ignore file not found error.
-
-    :param path: File to delete
-    :param remove: Optional function to remove passed path
-    """
-
-    try:
-        remove(path)
-    except OSError as e:
-        if e.errno != errno.ENOENT:
-            raise
-
-
-@contextlib.contextmanager
-def remove_path_on_error(path, remove=delete_if_exists):
-    """Protect code that wants to operate on PATH atomically.
-    Any exception will cause PATH to be removed.
-
-    :param path: File to work with
-    :param remove: Optional function to remove passed path
-    """
-
-    try:
-        yield
-    except Exception:
-        with excutils.save_and_reraise_exception():
-            remove(path)
-
-
-def file_open(*args, **kwargs):
-    """Open file
-
-    see built-in open() documentation for more details
-
-    Note: The reason this is kept in a separate module is to easily
-    be able to provide a stub module that doesn't alter system
-    state at all (for unit tests)
-    """
-    return open(*args, **kwargs)
-
-
-def write_to_tempfile(content, path=None, suffix='', prefix='tmp'):
-    """Create temporary file or use existing file.
-
-    This util is needed for creating temporary file with
-    specified content, suffix and prefix. If path is not None,
-    it will be used for writing content. If the path doesn't
-    exist it'll be created.
-
-    :param content: content for temporary file.
-    :param path: same as parameter 'dir' for mkstemp
-    :param suffix: same as parameter 'suffix' for mkstemp
-    :param prefix: same as parameter 'prefix' for mkstemp
-
-    For example: it can be used in database tests for creating
-    configuration files.
-    """
-    if path:
-        ensure_tree(path)
-
-    (fd, path) = tempfile.mkstemp(suffix=suffix, dir=path, prefix=prefix)
-    try:
-        os.write(fd, content)
-    finally:
-        os.close(fd)
-    return path
diff --git a/cinder/tests/unit/backup/fake_swift_client2.py b/cinder/tests/unit/backup/fake_swift_client2.py
index 4dcd75d12..475722405 100644
--- a/cinder/tests/unit/backup/fake_swift_client2.py
+++ b/cinder/tests/unit/backup/fake_swift_client2.py
@@ -23,8 +23,6 @@ from six.moves import http_client
 
 from swiftclient import client as swift
 
-from cinder.openstack.common import fileutils
-
 
 class FakeSwiftClient2(object):
     def __init__(self, *args, **kwargs):
@@ -72,14 +70,14 @@ class FakeSwiftConnection2(object):
         if container == 'socket_error_on_get':
             raise socket.error(111, 'ECONNREFUSED')
         object_path = tempfile.gettempdir() + '/' + container + '/' + name
-        with fileutils.file_open(object_path, 'rb') as object_file:
+        with open(object_path, 'rb') as object_file:
             return (None, object_file.read())
 
     def put_object(self, container, name, reader, content_length=None,
                    etag=None, chunk_size=None, content_type=None,
                    headers=None, query_string=None):
         object_path = tempfile.gettempdir() + '/' + container + '/' + name
-        with fileutils.file_open(object_path, 'wb') as object_file:
+        with open(object_path, 'wb') as object_file:
             object_file.write(reader.read())
         return hashlib.md5(reader.read()).hexdigest()
 
diff --git a/cinder/tests/unit/targets/targets_fixture.py b/cinder/tests/unit/targets/targets_fixture.py
index c67974020..0657943dd 100644
--- a/cinder/tests/unit/targets/targets_fixture.py
+++ b/cinder/tests/unit/targets/targets_fixture.py
@@ -15,9 +15,9 @@ import shutil
 import tempfile
 
 import mock
+from oslo_utils import fileutils
 from oslo_utils import timeutils
 
-from cinder.openstack.common import fileutils
 from cinder import test
 from cinder.volume import configuration as conf
 
diff --git a/cinder/tests/unit/test_glusterfs.py b/cinder/tests/unit/test_glusterfs.py
index 3a375e72a..776acafa2 100644
--- a/cinder/tests/unit/test_glusterfs.py
+++ b/cinder/tests/unit/test_glusterfs.py
@@ -627,7 +627,7 @@ class GlusterFsDriverTestCase(test.TestCase):
                 assert_called_once_with(snap_ref, volume_ref, volume['size'])
             self.assertTrue(mock_delete_snapshot.called)
 
-    @mock.patch('cinder.openstack.common.fileutils.delete_if_exists')
+    @mock.patch('oslo_utils.fileutils.delete_if_exists')
     def test_delete_volume(self, mock_delete_if_exists):
         volume = self._simple_volume()
         volume_filename = 'volume-%s' % self.VOLUME_UUID
diff --git a/cinder/tests/unit/test_gpfs.py b/cinder/tests/unit/test_gpfs.py
index f55631b53..2114f41df 100644
--- a/cinder/tests/unit/test_gpfs.py
+++ b/cinder/tests/unit/test_gpfs.py
@@ -1407,7 +1407,7 @@ class GPFSDriverTestCase(test.TestCase):
         self.driver.copy_volume_to_image('', volume, '', '')
 
     @mock.patch('cinder.volume.drivers.ibm.gpfs.GPFSDriver._delete_gpfs_file')
-    @mock.patch('cinder.openstack.common.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch('cinder.utils.temporary_chown')
     @mock.patch('cinder.volume.drivers.ibm.gpfs.GPFSDriver._gpfs_redirect')
     @mock.patch('cinder.volume.drivers.ibm.gpfs.GPFSDriver.'
@@ -1431,7 +1431,7 @@ class GPFSDriverTestCase(test.TestCase):
         mock_local_path.return_value = self.volumes_path
         self.driver.backup_volume('', backup, backup_service)
 
-    @mock.patch('cinder.openstack.common.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch('cinder.utils.temporary_chown')
     @mock.patch('cinder.volume.drivers.ibm.gpfs.GPFSDriver.local_path')
     def test_restore_backup(self,
diff --git a/cinder/tests/unit/test_image_utils.py b/cinder/tests/unit/test_image_utils.py
index cd7fe5e45..580270174 100644
--- a/cinder/tests/unit/test_image_utils.py
+++ b/cinder/tests/unit/test_image_utils.py
@@ -366,7 +366,7 @@ class TestTemporaryDir(test.TestCase):
 
 class TestUploadVolume(test.TestCase):
     @mock.patch('cinder.image.image_utils.CONF')
-    @mock.patch('cinder.image.image_utils.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch('cinder.image.image_utils.qemu_img_info')
     @mock.patch('cinder.image.image_utils.convert_image')
     @mock.patch('cinder.image.image_utils.temporary_file')
@@ -401,7 +401,7 @@ class TestUploadVolume(test.TestCase):
 
     @mock.patch('cinder.image.image_utils.utils.temporary_chown')
     @mock.patch('cinder.image.image_utils.CONF')
-    @mock.patch('cinder.image.image_utils.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch('cinder.image.image_utils.qemu_img_info')
     @mock.patch('cinder.image.image_utils.convert_image')
     @mock.patch('cinder.image.image_utils.temporary_file')
@@ -430,7 +430,7 @@ class TestUploadVolume(test.TestCase):
 
     @mock.patch('cinder.image.image_utils.utils.temporary_chown')
     @mock.patch('cinder.image.image_utils.CONF')
-    @mock.patch('cinder.image.image_utils.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch('cinder.image.image_utils.qemu_img_info')
     @mock.patch('cinder.image.image_utils.convert_image')
     @mock.patch('cinder.image.image_utils.temporary_file')
@@ -457,7 +457,7 @@ class TestUploadVolume(test.TestCase):
             mock_open.return_value.__enter__.return_value)
 
     @mock.patch('cinder.image.image_utils.CONF')
-    @mock.patch('cinder.image.image_utils.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch('cinder.image.image_utils.qemu_img_info')
     @mock.patch('cinder.image.image_utils.convert_image')
     @mock.patch('cinder.image.image_utils.temporary_file')
diff --git a/cinder/tests/unit/test_quobyte.py b/cinder/tests/unit/test_quobyte.py
index 62bc3beff..12b774050 100644
--- a/cinder/tests/unit/test_quobyte.py
+++ b/cinder/tests/unit/test_quobyte.py
@@ -557,7 +557,7 @@ class QuobyteDriverTestCase(test.TestCase):
                                                                volume['size'])
         drv._delete_snapshot.assert_called_once_with(mock.ANY)
 
-    @mock.patch('cinder.openstack.common.fileutils.delete_if_exists')
+    @mock.patch('oslo_utils.fileutils.delete_if_exists')
     def test_delete_volume(self, mock_delete_if_exists):
         volume = self._simple_volume()
         volume_filename = 'volume-%s' % self.VOLUME_UUID
diff --git a/cinder/tests/unit/test_scality.py b/cinder/tests/unit/test_scality.py
index 013ead607..d705fd9b5 100644
--- a/cinder/tests/unit/test_scality.py
+++ b/cinder/tests/unit/test_scality.py
@@ -28,10 +28,7 @@ from oslo_utils import units
 from cinder import context
 from cinder import exception
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
-from cinder.openstack.common import imageutils
 from cinder import test
-from cinder import utils
 from cinder.volume import configuration as conf
 from cinder.volume.drivers import scality
 
@@ -281,51 +278,50 @@ class ScalityDriverTestCase(test.TestCase):
 
         self._driver.extend_volume(self.TEST_VOLUME, self.TEST_NEWSIZE)
 
-    def test_backup_volume(self):
-        self.mox = mox_lib.Mox()
-        self._driver.db = self.mox.CreateMockAnything()
-        self.mox.StubOutWithMock(self._driver.db, 'volume_get')
-
+    @mock.patch('six.moves.builtins.open')
+    @mock.patch('cinder.utils.temporary_chown')
+    @mock.patch('cinder.image.image_utils.qemu_img_info')
+    def test_backup_volume(self, qemu_img_info, temporary_chown, mock_open):
         volume = {'id': '2', 'name': self.TEST_VOLNAME}
-        self._driver.db.volume_get(context, volume['id']).AndReturn(volume)
-
-        info = imageutils.QemuImgInfo()
-        info.file_format = 'raw'
-        self.mox.StubOutWithMock(image_utils, 'qemu_img_info')
-        image_utils.qemu_img_info(self.TEST_VOLPATH).AndReturn(info)
-
-        self.mox.StubOutWithMock(utils, 'temporary_chown')
-        mock_tempchown = mock.MagicMock()
-        utils.temporary_chown(self.TEST_VOLPATH).AndReturn(mock_tempchown)
-
-        self.mox.StubOutWithMock(fileutils, 'file_open')
-        mock_fileopen = mock.MagicMock()
-        fileutils.file_open(self.TEST_VOLPATH).AndReturn(mock_fileopen)
-
         backup = {'volume_id': volume['id']}
-        mock_servicebackup = self.mox.CreateMockAnything()
-        mock_servicebackup.backup(backup, mox_lib.IgnoreArg())
-
-        self.mox.ReplayAll()
-
-        self._driver.backup_volume(context, backup, mock_servicebackup)
-
-    def test_restore_backup(self):
+        info = mock.Mock()
+        info.file_format = 'raw'
+        info.backing_file = None
+        qemu_img_info.return_value = info
+        backup_service = mock.Mock()
+
+        with mock.patch.object(self._driver, 'db') as db:
+            db.volume_get.return_value = volume
+
+            self._driver.backup_volume(context, backup, backup_service)
+
+            db.volume_get.assert_called_once_with(context, volume['id'])
+            qemu_img_info.assert_called_once_with(self.TEST_VOLPATH)
+            temporary_chown.asser_called_once_with(self.TEST_VOLPATH)
+            mock_open.assert_called_once_with(self.TEST_VOLPATH)
+            backup_service.backup.asser_called_once_with(backup, mock.ANY)
+
+            info.backing_file = 'not None'
+            self.assertRaises(exception.InvalidVolume,
+                              self._driver.backup_volume,
+                              context, backup, backup_service)
+
+            info.file_format = 'not raw'
+            self.assertRaises(exception.InvalidVolume,
+                              self._driver.backup_volume,
+                              context, backup, backup_service)
+
+    @mock.patch('six.moves.builtins.open')
+    @mock.patch('cinder.utils.temporary_chown')
+    def test_restore_backup(self, temporary_chown, mock_open):
         volume = {'id': '2', 'name': self.TEST_VOLNAME}
-
-        self.mox.StubOutWithMock(utils, 'temporary_chown')
-        mock_tempchown = mock.MagicMock()
-        utils.temporary_chown(self.TEST_VOLPATH).AndReturn(mock_tempchown)
-
-        self.mox.StubOutWithMock(fileutils, 'file_open')
-        mock_fileopen = mock.MagicMock()
-        fileutils.file_open(self.TEST_VOLPATH, 'wb').AndReturn(mock_fileopen)
-
         backup = {'id': 123, 'volume_id': volume['id']}
-        mock_servicebackup = self.mox.CreateMockAnything()
-        mock_servicebackup.restore(backup, volume['id'], mox_lib.IgnoreArg())
-
-        self.mox.ReplayAll()
+        backup_service = mock.Mock()
 
         self._driver.restore_backup(context, backup, volume,
-                                    mock_servicebackup)
+                                    backup_service)
+
+        temporary_chown.asser_called_once_with(self.TEST_VOLPATH)
+        mock_open.assert_called_once_with(self.TEST_VOLPATH, 'wb')
+        backup_service.restore.asser_called_once_with(backup, volume['id'],
+                                                      mock.ANY)
diff --git a/cinder/tests/unit/test_vmware_vmdk.py b/cinder/tests/unit/test_vmware_vmdk.py
index 663e0d144..dcc20c420 100644
--- a/cinder/tests/unit/test_vmware_vmdk.py
+++ b/cinder/tests/unit/test_vmware_vmdk.py
@@ -1428,7 +1428,7 @@ class VMwareEsxVmdkDriverTestCase(test.TestCase):
                           fake_name, fake_size)
 
     @mock.patch.object(image_transfer, 'copy_stream_optimized_disk')
-    @mock.patch('cinder.openstack.common.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(VMDK_DRIVER, '_temporary_file')
     @mock.patch('oslo_utils.uuidutils.generate_uuid')
     @mock.patch.object(VMDK_DRIVER, '_create_backing')
@@ -1484,7 +1484,7 @@ class VMwareEsxVmdkDriverTestCase(test.TestCase):
 
     @mock.patch.object(VMDK_DRIVER, 'extend_volume')
     @mock.patch.object(VMDK_DRIVER, '_restore_backing')
-    @mock.patch('cinder.openstack.common.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(VMDK_DRIVER, '_temporary_file')
     @mock.patch('oslo_utils.uuidutils.generate_uuid')
     @mock.patch.object(VMDK_DRIVER, 'volumeops')
@@ -1650,10 +1650,9 @@ class VMwareEsxVmdkDriverTestCase(test.TestCase):
 
     @mock.patch.object(VMDK_DRIVER, '_delete_temp_backing')
     @mock.patch.object(image_transfer, 'download_stream_optimized_data')
-    @mock.patch('cinder.openstack.common.fileutils.file_open')
+    @mock.patch('cinder.volume.drivers.vmware.vmdk.open')
     @mock.patch.object(VMDK_DRIVER, 'volumeops')
-    @mock.patch(
-        'cinder.volume.drivers.vmware.vmdk.VMwareEsxVmdkDriver._get_disk_type')
+    @mock.patch.object(VMDK_DRIVER, '_get_disk_type')
     @mock.patch.object(VMDK_DRIVER, '_get_storage_profile_id')
     @mock.patch.object(VMDK_DRIVER, 'session')
     @mock.patch.object(VMDK_DRIVER, '_select_ds_for_volume')
@@ -2515,7 +2514,7 @@ class VMwareVcVmdkDriverTestCase(VMwareEsxVmdkDriverTestCase):
                                  _select_ds_for_volume)
 
     @mock.patch.object(image_transfer, 'copy_stream_optimized_disk')
-    @mock.patch('cinder.openstack.common.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(VMDK_DRIVER, '_temporary_file')
     @mock.patch('oslo_utils.uuidutils.generate_uuid')
     @mock.patch.object(VMDK_DRIVER, '_create_backing')
@@ -2528,7 +2527,7 @@ class VMwareVcVmdkDriverTestCase(VMwareEsxVmdkDriverTestCase):
 
     @mock.patch.object(VMDK_DRIVER, 'extend_volume')
     @mock.patch.object(VMDK_DRIVER, '_restore_backing')
-    @mock.patch('cinder.openstack.common.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(VMDK_DRIVER, '_temporary_file')
     @mock.patch('oslo_utils.uuidutils.generate_uuid')
     @mock.patch.object(VMDK_DRIVER, 'volumeops')
@@ -2554,7 +2553,7 @@ class VMwareVcVmdkDriverTestCase(VMwareEsxVmdkDriverTestCase):
 
     @mock.patch.object(VMDK_DRIVER, '_delete_temp_backing')
     @mock.patch.object(image_transfer, 'download_stream_optimized_data')
-    @mock.patch('cinder.openstack.common.fileutils.file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(VMDK_DRIVER, 'volumeops')
     @mock.patch(
         'cinder.volume.drivers.vmware.vmdk.VMwareEsxVmdkDriver._get_disk_type')
@@ -2635,8 +2634,8 @@ class VMwareVcVmdkDriverTestCase(VMwareEsxVmdkDriverTestCase):
         vops.update_backing_disk_uuid.assert_called_once_with(backing,
                                                               volume['id'])
 
-    @mock.patch('cinder.openstack.common.fileutils.ensure_tree')
-    @mock.patch('cinder.openstack.common.fileutils.delete_if_exists')
+    @mock.patch('oslo_utils.fileutils.ensure_tree')
+    @mock.patch('oslo_utils.fileutils.delete_if_exists')
     @mock.patch('tempfile.mkstemp')
     @mock.patch('os.close')
     def test_temporary_file(
diff --git a/cinder/tests/unit/test_volume.py b/cinder/tests/unit/test_volume.py
index 09425c64d..07486b627 100644
--- a/cinder/tests/unit/test_volume.py
+++ b/cinder/tests/unit/test_volume.py
@@ -39,7 +39,6 @@ from stevedore import extension
 from taskflow.engines.action_engine import engine
 
 from cinder.api import common
-from cinder.backup import driver as backup_driver
 from cinder.brick.local_dev import lvm as brick_lvm
 from cinder.compute import nova
 from cinder import context
@@ -48,7 +47,6 @@ from cinder import exception
 from cinder.image import image_utils
 from cinder import keymgr
 from cinder import objects
-from cinder.openstack.common import fileutils
 import cinder.policy
 from cinder import quota
 from cinder import test
@@ -5644,7 +5642,7 @@ class GenericVolumeDriverTestCase(DriverTestCase):
     driver_name = "cinder.tests.unit.fake_driver.LoggingVolumeDriver"
 
     @mock.patch.object(utils, 'temporary_chown')
-    @mock.patch.object(fileutils, 'file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(os_brick.initiator.connector,
                        'get_connector_properties')
     @mock.patch.object(db, 'volume_get')
@@ -5681,7 +5679,7 @@ class GenericVolumeDriverTestCase(DriverTestCase):
         mock_volume_get.assert_called_with(self.context, vol['id'])
 
     @mock.patch.object(utils, 'temporary_chown')
-    @mock.patch.object(fileutils, 'file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(os_brick.initiator.connector,
                        'get_connector_properties')
     @mock.patch.object(db, 'volume_get')
@@ -5729,7 +5727,7 @@ class GenericVolumeDriverTestCase(DriverTestCase):
                        'backup_use_temp_snapshot',
                        return_value=True)
     @mock.patch.object(utils, 'temporary_chown')
-    @mock.patch.object(fileutils, 'file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(os_brick.initiator.connector.LocalConnector,
                        'connect_volume')
     @mock.patch.object(os_brick.initiator.connector.LocalConnector,
@@ -5792,39 +5790,64 @@ class GenericVolumeDriverTestCase(DriverTestCase):
         self.assertTrue(self.volume.driver.remove_export_snapshot.called)
         self.assertTrue(self.volume.driver.delete_snapshot.called)
 
-    def test_restore_backup(self):
+    @mock.patch.object(utils, 'temporary_chown')
+    @mock.patch.object(os_brick.initiator.connector,
+                       'get_connector_properties')
+    @mock.patch('six.moves.builtins.open')
+    def test_restore_backup(self,
+                            mock_open,
+                            mock_get_connector_properties,
+                            mock_temporary_chown):
+        dev_null = '/dev/null'
         vol = tests_utils.create_volume(self.context)
-        backup = {'volume_id': vol['id'],
-                  'id': 'backup-for-%s' % vol['id']}
+        backup = {'volume_id': vol['id'], 'id': 'backup-for-%s' % vol['id']}
         properties = {}
-        attach_info = {'device': {'path': '/dev/null'}}
+        attach_info = {'device': {'path': dev_null}}
         root_helper = 'sudo cinder-rootwrap /etc/cinder/rootwrap.conf'
-        backup_service = self.mox.CreateMock(backup_driver.BackupDriver)
-        self.mox.StubOutWithMock(os_brick.initiator.connector,
-                                 'get_connector_properties')
-        self.mox.StubOutWithMock(self.volume.driver, '_attach_volume')
-        self.mox.StubOutWithMock(os, 'getuid')
-        self.mox.StubOutWithMock(utils, 'execute')
-        self.mox.StubOutWithMock(fileutils, 'file_open')
-        self.mox.StubOutWithMock(self.volume.driver, '_detach_volume')
-        self.mox.StubOutWithMock(self.volume.driver, 'terminate_connection')
-
-        os_brick.initiator.connector.\
-            get_connector_properties(root_helper, CONF.my_ip, False, False).\
-            AndReturn(properties)
-        self.volume.driver._attach_volume(self.context, vol, properties).\
-            AndReturn((attach_info, vol))
-        os.getuid()
-        utils.execute('chown', None, '/dev/null', run_as_root=True)
-        f = fileutils.file_open('/dev/null', 'wb').AndReturn(file('/dev/null'))
-        backup_service.restore(backup, vol['id'], f)
-        utils.execute('chown', 0, '/dev/null', run_as_root=True)
-        self.volume.driver._detach_volume(self.context, attach_info, vol,
-                                          properties)
-        self.mox.ReplayAll()
-        self.volume.driver.restore_backup(self.context, backup, vol,
-                                          backup_service)
-        self.mox.UnsetStubs()
+
+        volume_file = mock.MagicMock()
+        mock_open.return_value.__enter__.return_value = volume_file
+        mock_get_connector_properties.return_value = properties
+
+        self.volume.driver._attach_volume = mock.MagicMock()
+        self.volume.driver._attach_volume.return_value = attach_info, vol
+        self.volume.driver._detach_volume = mock.MagicMock()
+        self.volume.driver.terminate_connection = mock.MagicMock()
+        self.volume.driver.secure_file_operations_enabled = mock.MagicMock()
+        self.volume.driver.secure_file_operations_enabled.side_effect = (False,
+                                                                         True)
+        backup_service = mock.MagicMock()
+
+        for i in (1, 2):
+            self.volume.driver.restore_backup(self.context, backup, vol,
+                                              backup_service)
+
+            mock_get_connector_properties.assert_called_with(root_helper,
+                                                             CONF.my_ip,
+                                                             False, False)
+            self.volume.driver._attach_volume.assert_called_with(
+                self.context, vol, properties)
+            self.assertEqual(i, self.volume.driver._attach_volume.call_count)
+
+            self.volume.driver._detach_volume.assert_called_with(
+                self.context, attach_info, vol, properties)
+            self.assertEqual(i, self.volume.driver._detach_volume.call_count)
+
+            self.volume.driver.secure_file_operations_enabled.\
+                assert_called_with()
+            self.assertEqual(
+                i,
+                self.volume.driver.secure_file_operations_enabled.call_count
+            )
+
+            mock_temporary_chown.assert_called_once_with(dev_null)
+
+            mock_open.assert_called_with(dev_null, 'wb')
+            self.assertEqual(i, mock_open.call_count)
+
+            backup_service.restore.assert_called_with(backup, vol['id'],
+                                                      volume_file)
+            self.assertEqual(i, backup_service.restore.call_count)
 
 
 class LVMISCSIVolumeDriverTestCase(DriverTestCase):
@@ -6243,7 +6266,7 @@ class LVMVolumeDriverTestCase(DriverTestCase):
         lvm_driver.check_for_setup_error()
 
     @mock.patch.object(utils, 'temporary_chown')
-    @mock.patch.object(fileutils, 'file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(os_brick.initiator.connector,
                        'get_connector_properties')
     @mock.patch.object(db, 'volume_get')
@@ -6316,7 +6339,7 @@ class LVMVolumeDriverTestCase(DriverTestCase):
                              update)
 
     @mock.patch.object(utils, 'temporary_chown')
-    @mock.patch.object(fileutils, 'file_open')
+    @mock.patch('six.moves.builtins.open')
     @mock.patch.object(os_brick.initiator.connector,
                        'get_connector_properties')
     @mock.patch.object(db, 'volume_get')
diff --git a/cinder/tests/unit/windows/test_windows.py b/cinder/tests/unit/windows/test_windows.py
index 8e73d1630..90e4ebebc 100644
--- a/cinder/tests/unit/windows/test_windows.py
+++ b/cinder/tests/unit/windows/test_windows.py
@@ -24,9 +24,9 @@ import tempfile
 
 from mox3 import mox
 from oslo_config import cfg
+from oslo_utils import fileutils
 
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder import test
 from cinder.tests.unit.windows import db_fakes
 from cinder.volume import configuration as conf
diff --git a/cinder/volume/driver.py b/cinder/volume/driver.py
index ba2fe0563..85feacf89 100644
--- a/cinder/volume/driver.py
+++ b/cinder/volume/driver.py
@@ -28,7 +28,6 @@ from cinder import exception
 from cinder.i18n import _, _LE, _LW
 from cinder.image import image_utils
 from cinder import objects
-from cinder.openstack.common import fileutils
 from cinder import utils
 from cinder.volume import rpcapi as volume_rpcapi
 from cinder.volume import throttling
@@ -942,11 +941,11 @@ class BaseVD(object):
 
             # Secure network file systems will not chown files.
             if self.secure_file_operations_enabled():
-                with fileutils.file_open(device_path) as device_file:
+                with open(device_path) as device_file:
                     backup_service.backup(backup, device_file)
             else:
                 with utils.temporary_chown(device_path):
-                    with fileutils.file_open(device_path) as device_file:
+                    with open(device_path) as device_file:
                         backup_service.backup(backup, device_file)
 
         finally:
@@ -973,11 +972,11 @@ class BaseVD(object):
 
             # Secure network file systems will not chown files.
             if self.secure_file_operations_enabled():
-                with fileutils.file_open(volume_path, 'wb') as volume_file:
+                with open(volume_path, 'wb') as volume_file:
                     backup_service.restore(backup, volume['id'], volume_file)
             else:
                 with utils.temporary_chown(volume_path):
-                    with fileutils.file_open(volume_path, 'wb') as volume_file:
+                    with open(volume_path, 'wb') as volume_file:
                         backup_service.restore(backup, volume['id'],
                                                volume_file)
 
diff --git a/cinder/volume/drivers/glusterfs.py b/cinder/volume/drivers/glusterfs.py
index d6aaeea72..49914a0a4 100644
--- a/cinder/volume/drivers/glusterfs.py
+++ b/cinder/volume/drivers/glusterfs.py
@@ -22,12 +22,12 @@ from os_brick.remotefs import remotefs as remotefs_brick
 from oslo_concurrency import processutils
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_utils import fileutils
 from oslo_utils import units
 
 from cinder import exception
 from cinder.i18n import _, _LE, _LI, _LW
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder import utils
 from cinder.volume import driver
 from cinder.volume.drivers import remotefs as remotefs_drv
diff --git a/cinder/volume/drivers/ibm/gpfs.py b/cinder/volume/drivers/ibm/gpfs.py
index 89ca8fb3a..2c0884707 100644
--- a/cinder/volume/drivers/ibm/gpfs.py
+++ b/cinder/volume/drivers/ibm/gpfs.py
@@ -31,7 +31,6 @@ from cinder import context
 from cinder import exception
 from cinder.i18n import _, _LE, _LI
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder import utils
 from cinder.volume import driver
 from cinder.volume.drivers import nfs
@@ -955,7 +954,7 @@ class GPFSDriver(driver.ConsistencyGroupVD, driver.ExtendVD,
 
     def _do_backup(self, backup_path, backup, backup_service):
         with utils.temporary_chown(backup_path):
-            with fileutils.file_open(backup_path) as backup_file:
+            with open(backup_path) as backup_file:
                 backup_service.backup(backup, backup_file)
 
     def backup_volume(self, context, backup, backup_service):
@@ -981,7 +980,7 @@ class GPFSDriver(driver.ConsistencyGroupVD, driver.ExtendVD,
 
         volume_path = self.local_path(volume)
         with utils.temporary_chown(volume_path):
-            with fileutils.file_open(volume_path, 'wb') as volume_file:
+            with open(volume_path, 'wb') as volume_file:
                 backup_service.restore(backup, volume['id'], volume_file)
 
     def _migrate_volume(self, volume, host):
diff --git a/cinder/volume/drivers/lvm.py b/cinder/volume/drivers/lvm.py
index 2a8bce556..f0bededc4 100644
--- a/cinder/volume/drivers/lvm.py
+++ b/cinder/volume/drivers/lvm.py
@@ -30,7 +30,6 @@ from cinder.brick.local_dev import lvm as lvm
 from cinder import exception
 from cinder.i18n import _, _LE, _LI, _LW
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder import utils
 from cinder.volume import driver
 from cinder.volume import utils as volutils
@@ -504,7 +503,7 @@ class LVMVolumeDriver(driver.VolumeDriver):
 
         try:
             with utils.temporary_chown(volume_path):
-                with fileutils.file_open(volume_path) as volume_file:
+                with open(volume_path) as volume_file:
                     backup_service.backup(backup, volume_file)
         finally:
             if temp_snapshot:
@@ -516,7 +515,7 @@ class LVMVolumeDriver(driver.VolumeDriver):
         """Restore an existing backup to a new or existing volume."""
         volume_path = self.local_path(volume)
         with utils.temporary_chown(volume_path):
-            with fileutils.file_open(volume_path, 'wb') as volume_file:
+            with open(volume_path, 'wb') as volume_file:
                 backup_service.restore(backup, volume['id'], volume_file)
 
     def get_volume_stats(self, refresh=False):
diff --git a/cinder/volume/drivers/quobyte.py b/cinder/volume/drivers/quobyte.py
index 2b2760476..9f6559cf9 100644
--- a/cinder/volume/drivers/quobyte.py
+++ b/cinder/volume/drivers/quobyte.py
@@ -20,12 +20,12 @@ import os
 from oslo_concurrency import processutils
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_utils import fileutils
 
 from cinder import compute
 from cinder import exception
 from cinder.i18n import _, _LI, _LW
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder import utils
 from cinder.volume.drivers import remotefs as remotefs_drv
 
diff --git a/cinder/volume/drivers/rbd.py b/cinder/volume/drivers/rbd.py
index 43751cbe3..72a914228 100644
--- a/cinder/volume/drivers/rbd.py
+++ b/cinder/volume/drivers/rbd.py
@@ -23,13 +23,13 @@ import tempfile
 from eventlet import tpool
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_utils import fileutils
 from oslo_utils import units
 from six.moves import urllib
 
 from cinder import exception
 from cinder.i18n import _, _LE, _LI, _LW
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder import utils
 from cinder.volume import driver
 
diff --git a/cinder/volume/drivers/scality.py b/cinder/volume/drivers/scality.py
index 904f18ba1..8c154751a 100644
--- a/cinder/volume/drivers/scality.py
+++ b/cinder/volume/drivers/scality.py
@@ -22,13 +22,13 @@ import os
 from oslo_concurrency import lockutils
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_utils import fileutils
 from oslo_utils import units
 from six.moves import urllib
 
 from cinder import exception
 from cinder.i18n import _, _LI
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder import utils
 from cinder.volume import driver
 from cinder.volume import utils as volume_utils
@@ -308,7 +308,7 @@ class ScalityDriver(driver.VolumeDriver):
             raise exception.InvalidVolume(msg)
 
         with utils.temporary_chown(volume_local_path):
-            with fileutils.file_open(volume_local_path) as volume_file:
+            with open(volume_local_path) as volume_file:
                 backup_service.backup(backup, volume_file)
 
     def restore_backup(self, context, backup, volume, backup_service):
@@ -317,5 +317,5 @@ class ScalityDriver(driver.VolumeDriver):
                  {'backup': backup['id'], 'volume': volume['name']})
         volume_local_path = self.local_path(volume)
         with utils.temporary_chown(volume_local_path):
-            with fileutils.file_open(volume_local_path, 'wb') as volume_file:
+            with open(volume_local_path, 'wb') as volume_file:
                 backup_service.restore(backup, volume['id'], volume_file)
diff --git a/cinder/volume/drivers/sheepdog.py b/cinder/volume/drivers/sheepdog.py
index a20ce25c8..997e0a782 100644
--- a/cinder/volume/drivers/sheepdog.py
+++ b/cinder/volume/drivers/sheepdog.py
@@ -28,7 +28,6 @@ from oslo_utils import units
 from cinder import exception
 from cinder.i18n import _, _LE
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder.volume import driver
 
 
@@ -198,7 +197,7 @@ class SheepdogDriver(driver.VolumeDriver):
                    tmp)
             self._try_execute(*cmd)
 
-            with fileutils.file_open(tmp, 'rb') as image_file:
+            with open(tmp, 'rb') as image_file:
                 image_service.update(context, image_id, {}, image_file)
 
     def create_snapshot(self, snapshot):
diff --git a/cinder/volume/drivers/vmware/vmdk.py b/cinder/volume/drivers/vmware/vmdk.py
index 0f925ee5b..39308ded4 100644
--- a/cinder/volume/drivers/vmware/vmdk.py
+++ b/cinder/volume/drivers/vmware/vmdk.py
@@ -30,6 +30,7 @@ import tempfile
 from oslo_config import cfg
 from oslo_log import log as logging
 from oslo_utils import excutils
+from oslo_utils import fileutils
 from oslo_utils import units
 from oslo_utils import uuidutils
 from oslo_vmware import api
@@ -41,7 +42,6 @@ import six
 
 from cinder import exception
 from cinder.i18n import _, _LE, _LI, _LW
-from cinder.openstack.common import fileutils
 from cinder.volume import driver
 from cinder.volume.drivers.vmware import datastore as hub
 from cinder.volume.drivers.vmware import exceptions as vmdk_exceptions
@@ -1583,7 +1583,7 @@ class VMwareEsxVmdkDriver(driver.VolumeDriver):
         host_ip = self.configuration.vmware_host_ip
         vmdk_ds_file_path = self.volumeops.get_vmdk_path(backing)
 
-        with fileutils.file_open(tmp_file_path, "wb") as tmp_file:
+        with open(tmp_file_path, "wb") as tmp_file:
             image_transfer.copy_stream_optimized_disk(
                 context,
                 timeout,
@@ -1617,7 +1617,7 @@ class VMwareEsxVmdkDriver(driver.VolumeDriver):
                       {'tmp_path': tmp_file_path,
                        'backup_id': backup['id']})
             self._download_vmdk(context, volume, backing, tmp_file_path)
-            with fileutils.file_open(tmp_file_path, "rb") as tmp_file:
+            with open(tmp_file_path, "rb") as tmp_file:
                     LOG.debug("Calling backup service to backup file: %s.",
                               tmp_file_path)
                     backup_service.backup(backup, tmp_file)
@@ -1656,7 +1656,7 @@ class VMwareEsxVmdkDriver(driver.VolumeDriver):
         timeout = self.configuration.vmware_image_transfer_timeout_secs
         host_ip = self.configuration.vmware_host_ip
         try:
-            with fileutils.file_open(tmp_file_path, "rb") as tmp_file:
+            with open(tmp_file_path, "rb") as tmp_file:
                 vm_ref = image_transfer.download_stream_optimized_data(
                     context,
                     timeout,
@@ -1775,7 +1775,7 @@ class VMwareEsxVmdkDriver(driver.VolumeDriver):
                           "backup: %(backup_id)s.",
                           {'tmp_path': tmp_file_path,
                            'backup_id': backup['id']})
-                with fileutils.file_open(tmp_file_path, "wb") as tmp_file:
+                with open(tmp_file_path, "wb") as tmp_file:
                     LOG.debug("Calling backup service to restore backup: "
                               "%(backup_id)s to file: %(tmp_path)s.",
                               {'backup_id': backup['id'],
diff --git a/cinder/volume/drivers/windows/smbfs.py b/cinder/volume/drivers/windows/smbfs.py
index b54284780..eb31ab4c1 100644
--- a/cinder/volume/drivers/windows/smbfs.py
+++ b/cinder/volume/drivers/windows/smbfs.py
@@ -20,12 +20,12 @@ import sys
 
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_utils import fileutils
 from oslo_utils import units
 
 from cinder import exception
 from cinder.i18n import _, _LI
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder import utils
 from cinder.volume.drivers import smbfs
 from cinder.volume.drivers.windows import remotefs
diff --git a/cinder/volume/drivers/windows/windows.py b/cinder/volume/drivers/windows/windows.py
index c5d9efa27..ba0b76395 100644
--- a/cinder/volume/drivers/windows/windows.py
+++ b/cinder/volume/drivers/windows/windows.py
@@ -23,9 +23,9 @@ import os
 
 from oslo_config import cfg
 from oslo_log import log as logging
+from oslo_utils import fileutils
 
 from cinder.image import image_utils
-from cinder.openstack.common import fileutils
 from cinder.volume import driver
 from cinder.volume.drivers.windows import constants
 from cinder.volume.drivers.windows import vhdutils
diff --git a/cinder/volume/targets/cxt.py b/cinder/volume/targets/cxt.py
index fa076e35e..3d1fc0289 100644
--- a/cinder/volume/targets/cxt.py
+++ b/cinder/volume/targets/cxt.py
@@ -19,10 +19,10 @@ import re
 
 from oslo_concurrency import processutils as putils
 from oslo_log import log as logging
+from oslo_utils import fileutils
 from oslo_utils import netutils
 
 from cinder import exception
-from cinder.openstack.common import fileutils
 from cinder.i18n import _LI, _LW, _LE
 from cinder import utils
 from cinder.volume.targets import iscsi
diff --git a/cinder/volume/targets/tgt.py b/cinder/volume/targets/tgt.py
index 37dcf3fc7..5d6ac6132 100644
--- a/cinder/volume/targets/tgt.py
+++ b/cinder/volume/targets/tgt.py
@@ -17,9 +17,9 @@ import time
 
 from oslo_concurrency import processutils as putils
 from oslo_log import log as logging
+from oslo_utils import fileutils
 
 from cinder import exception
-from cinder.openstack.common import fileutils
 from cinder.i18n import _LI, _LW, _LE
 from cinder import utils
 from cinder.volume.targets import iscsi
diff --git a/openstack-common.conf b/openstack-common.conf
index 9749b729d..2827eb527 100644
--- a/openstack-common.conf
+++ b/openstack-common.conf
@@ -3,7 +3,6 @@
 # The list of modules to copy from oslo-incubator
 module=config.generator
 module=context
-module=fileutils
 module=gettextutils
 module=imageutils
 module=install_venv_common