Merge "Remove fileutils"

2 files changed, 0 insertions, 405 deletions

diff --git a/openstack/common/fileutils.py b/openstack/common/fileutils.py
deleted file mode 100644
index 1191ce8f..00000000
--- a/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/tests/unit/test_fileutils.py b/tests/unit/test_fileutils.py
deleted file mode 100644
index 2934776b..00000000
--- a/tests/unit/test_fileutils.py
+++ /dev/null
@@ -1,256 +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 errno
-import os
-import shutil
-import stat
-import tempfile
-
-import mock
-from mox3 import mox
-from oslotest import base as test_base
-import six
-
-from openstack.common import fileutils
-
-
-TEST_PERMISSIONS = stat.S_IRWXU
-
-
-class EnsureTree(test_base.BaseTestCase):
-    def test_ensure_tree(self):
-        tmpdir = tempfile.mkdtemp()
-        try:
-            testdir = '%s/foo/bar/baz' % (tmpdir,)
-            fileutils.ensure_tree(testdir, TEST_PERMISSIONS)
-            self.assertTrue(os.path.isdir(testdir))
-            self.assertEqual(os.stat(testdir).st_mode,
-                             TEST_PERMISSIONS | stat.S_IFDIR)
-        finally:
-            if os.path.exists(tmpdir):
-                shutil.rmtree(tmpdir)
-
-
-class TestCachedFile(test_base.BaseTestCase):
-
-    def setUp(self):
-        super(TestCachedFile, self).setUp()
-        self.mox = mox.Mox()
-        self.addCleanup(self.mox.UnsetStubs)
-
-    def test_read_cached_file(self):
-        self.mox.StubOutWithMock(os.path, "getmtime")
-        os.path.getmtime(mox.IgnoreArg()).AndReturn(1)
-        self.mox.ReplayAll()
-
-        fileutils._FILE_CACHE = {
-            '/this/is/a/fake': {"data": 1123, "mtime": 1}
-        }
-        fresh, data = fileutils.read_cached_file("/this/is/a/fake")
-        fdata = fileutils._FILE_CACHE['/this/is/a/fake']["data"]
-        self.assertEqual(fdata, data)
-
-    @mock.patch('os.path.getmtime', return_value=2)
-    def test_read_modified_cached_file(self, getmtime):
-
-        fileutils._FILE_CACHE = {
-            '/this/is/a/fake': {"data": 1123, "mtime": 1}
-        }
-
-        fake_contents = "lorem ipsum"
-
-        with mock.patch('six.moves.builtins.open',
-                        mock.mock_open(read_data=fake_contents)):
-            fresh, data = fileutils.read_cached_file("/this/is/a/fake")
-
-        self.assertEqual(data, fake_contents)
-        self.assertTrue(fresh)
-
-    def test_delete_cached_file(self):
-        filename = '/this/is/a/fake/deletion/of/cached/file'
-        fileutils._FILE_CACHE = {
-            filename: {"data": 1123, "mtime": 1}
-        }
-        self.assertIn(filename, fileutils._FILE_CACHE)
-        fileutils.delete_cached_file(filename)
-        self.assertNotIn(filename, fileutils._FILE_CACHE)
-
-    def test_delete_cached_file_not_exist(self):
-        # We expect that if cached file does not exist no Exception raised.
-        filename = '/this/is/a/fake/deletion/attempt/of/not/cached/file'
-        self.assertNotIn(filename, fileutils._FILE_CACHE)
-        fileutils.delete_cached_file(filename)
-        self.assertNotIn(filename, fileutils._FILE_CACHE)
-
-
-class DeleteIfExists(test_base.BaseTestCase):
-    def test_file_present(self):
-        tmpfile = tempfile.mktemp()
-
-        open(tmpfile, 'w')
-        fileutils.delete_if_exists(tmpfile)
-        self.assertFalse(os.path.exists(tmpfile))
-
-    def test_file_absent(self):
-        tmpfile = tempfile.mktemp()
-
-        fileutils.delete_if_exists(tmpfile)
-        self.assertFalse(os.path.exists(tmpfile))
-
-    def test_dir_present(self):
-        tmpdir = tempfile.mktemp()
-        os.mkdir(tmpdir)
-
-        fileutils.delete_if_exists(tmpdir, remove=os.rmdir)
-        self.assertFalse(os.path.exists(tmpdir))
-
-    def test_file_error(self):
-        def errm(path):
-            raise OSError(errno.EINVAL, '')
-
-        tmpfile = tempfile.mktemp()
-
-        open(tmpfile, 'w')
-        self.assertRaises(OSError, fileutils.delete_if_exists, tmpfile, errm)
-        os.unlink(tmpfile)
-
-
-class RemovePathOnError(test_base.BaseTestCase):
-    def test_error(self):
-        tmpfile = tempfile.mktemp()
-        open(tmpfile, 'w')
-
-        try:
-            with fileutils.remove_path_on_error(tmpfile):
-                raise Exception
-        except Exception:
-            self.assertFalse(os.path.exists(tmpfile))
-
-    def test_no_error(self):
-        tmpfile = tempfile.mktemp()
-        open(tmpfile, 'w')
-
-        with fileutils.remove_path_on_error(tmpfile):
-            pass
-        self.assertTrue(os.path.exists(tmpfile))
-        os.unlink(tmpfile)
-
-    def test_remove(self):
-        tmpfile = tempfile.mktemp()
-        open(tmpfile, 'w')
-
-        try:
-            with fileutils.remove_path_on_error(tmpfile, remove=lambda x: x):
-                raise Exception
-        except Exception:
-            self.assertTrue(os.path.exists(tmpfile))
-        os.unlink(tmpfile)
-
-    def test_remove_dir(self):
-        tmpdir = tempfile.mktemp()
-        os.mkdir(tmpdir)
-
-        try:
-            with fileutils.remove_path_on_error(
-                    tmpdir,
-                    lambda path: fileutils.delete_if_exists(path, os.rmdir)):
-                raise Exception
-        except Exception:
-            self.assertFalse(os.path.exists(tmpdir))
-
-
-class UtilsTestCase(test_base.BaseTestCase):
-    def test_file_open(self):
-        dst_fd, dst_path = tempfile.mkstemp()
-        try:
-            os.close(dst_fd)
-            with open(dst_path, 'w') as f:
-                f.write('hello')
-            with fileutils.file_open(dst_path, 'r') as fp:
-                self.assertEqual(fp.read(), 'hello')
-        finally:
-            os.unlink(dst_path)
-
-
-class WriteToTempfileTestCase(test_base.BaseTestCase):
-    def setUp(self):
-        super(WriteToTempfileTestCase, self).setUp()
-        self.content = 'testing123'.encode('ascii')
-
-    def check_file_content(self, path):
-        with open(path, 'r') as fd:
-            ans = fd.read()
-            self.assertEqual(self.content, six.b(ans))
-
-    def test_file_without_path_and_suffix(self):
-        res = fileutils.write_to_tempfile(self.content)
-        self.assertTrue(os.path.exists(res))
-
-        (basepath, tmpfile) = os.path.split(res)
-        self.assertTrue(basepath.startswith(tempfile.gettempdir()))
-        self.assertTrue(tmpfile.startswith('tmp'))
-
-        self.check_file_content(res)
-
-    def test_file_with_not_existing_path(self):
-        path = '/tmp/testing/test1'
-        res = fileutils.write_to_tempfile(self.content, path=path)
-        self.assertTrue(os.path.exists(res))
-        (basepath, tmpfile) = os.path.split(res)
-        self.assertEqual(basepath, path)
-        self.assertTrue(tmpfile.startswith('tmp'))
-
-        self.check_file_content(res)
-        shutil.rmtree('/tmp/testing')
-
-    def test_file_with_not_default_suffix(self):
-        suffix = '.conf'
-        res = fileutils.write_to_tempfile(self.content, suffix=suffix)
-        self.assertTrue(os.path.exists(res))
-
-        (basepath, tmpfile) = os.path.split(res)
-        self.assertTrue(basepath.startswith(tempfile.gettempdir()))
-        self.assertTrue(tmpfile.startswith('tmp'))
-        self.assertTrue(tmpfile.endswith('.conf'))
-
-        self.check_file_content(res)
-
-    def test_file_with_not_existing_path_and_not_default_suffix(self):
-        suffix = '.txt'
-        path = '/tmp/testing/test2'
-        res = fileutils.write_to_tempfile(self.content,
-                                          path=path,
-                                          suffix=suffix)
-        self.assertTrue(os.path.exists(res))
-
-        (basepath, tmpfile) = os.path.split(res)
-        self.assertTrue(tmpfile.startswith('tmp'))
-        self.assertEqual(basepath, path)
-        self.assertTrue(tmpfile.endswith(suffix))
-
-        self.check_file_content(res)
-        shutil.rmtree('/tmp/testing')
-
-    def test_file_with_not_default_prefix(self):
-        prefix = 'test'
-        res = fileutils.write_to_tempfile(self.content, prefix=prefix)
-        self.assertTrue(os.path.exists(res))
-
-        (basepath, tmpfile) = os.path.split(res)
-        self.assertTrue(tmpfile.startswith(prefix))
-        self.assertTrue(basepath.startswith(tempfile.gettempdir()))
-
-        self.check_file_content(res)