utils: Extract rmFile from utils module

rmFile has been relocated to common.fileutils.
Adjusted for pep8 compliant names.

Change-Id: I3f07166326353ecb2ebabfe9897ab9fce9d480ad
Signed-off-by: Edward Haas <[email protected]>

lib/vdsm/common/fileutils.py

@@ -18,6 +18,9 @@
 #
 from __future__ import absolute_import
 
+import errno
+import logging
+
 import os
 
 
@@ -30,3 +33,20 @@ def touch_file(file_path):
     """
     with open(file_path, 'a'):
         os.utime(file_path, None)
+
+
+def rm_file(file_to_remove):
+    """
+    Try to remove a file.
+
+    If the file doesn't exist it's assumed that it was already removed.
+    """
+    try:
+        os.unlink(file_to_remove)
+    except OSError as e:
+        if e.errno == errno.ENOENT:
+            logging.warning("File: %s already removed", file_to_remove)
+        else:
+            logging.error("Removing file: %s failed", file_to_remove,
+                          exc_info=True)
+            raise

lib/vdsm/mkimage.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2012 Red Hat, Inc.
+# Copyright 2012-2017 Red Hat, Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -32,7 +32,7 @@
     DISKIMAGE_USER, DISKIMAGE_GROUP
 from vdsm.constants import P_VDSM_RUN
 from vdsm.commands import execCmd
-from vdsm.utils import rmFile
+from vdsm.common.fileutils import rm_file
 from vdsm.storage import mount
 from vdsm.storage.fileUtils import resolveUid, resolveGid
 
@@ -153,7 +153,7 @@ def mkIsoFs(vmId, files, volumeName=None):
 
         if os.path.exists(isopath):
             logging.warning("iso file %r exists, removing", isopath)
-            rmFile(isopath)
+            rm_file(isopath)
 
         fd = os.open(isopath, os.O_CREAT | os.O_RDONLY | os.O_EXCL, mode)
         os.close(fd)

lib/vdsm/network/configurators/ifcfg.py

@@ -40,7 +40,7 @@
 from vdsm import constants
 from vdsm import dsaversion
 from vdsm import hooks
-from vdsm import utils
+from vdsm.common import fileutils
 from vdsm.common.conv import tobool
 
 from vdsm.network import ifacetracking
@@ -390,7 +390,7 @@ def __init__(self):
 
     @staticmethod
     def _removeFile(filename):
-        utils.rmFile(filename)
+        fileutils.rm_file(filename)
         logging.debug("Removed file %s", filename)
 
     @classmethod

lib/vdsm/network/configurators/ifcfg_acquire.py

@@ -1,4 +1,4 @@
-# Copyright 2014 Red Hat, Inc.
+# Copyright 2014-2017 Red Hat, Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -21,7 +21,7 @@
 import glob
 import os
 
-from vdsm import utils
+from vdsm.common import fileutils
 from vdsm.network.netinfo import misc
 from vdsm.network.nm import networkmanager
 from vdsm.network.nm.errors import NMDeviceNotFoundError
@@ -141,4 +141,4 @@ def _normalize_device_filenames(device, device_files):
         if device_files:
             os.rename(device_files[0], NET_CONF_PREF + device)
             for filepath in device_files[1:]:
-                utils.rmFile(filepath)
+                fileutils.rm_file(filepath)

lib/vdsm/network/ifacetracking.py

@@ -21,10 +21,9 @@
 import logging
 import os
 
+from vdsm.common.fileutils import rm_file
 from vdsm.common.fileutils import touch_file
 from vdsm.constants import P_VDSM_RUN
-from vdsm.utils import rmFile
-
 
 TRACKED_INTERFACES_FOLDER = os.path.join(P_VDSM_RUN, 'trackedInterfaces')
 
@@ -36,7 +35,7 @@ def add(device_name):
 
 def remove(device_name):
     logging.debug('Remove iface tracking for device %s', device_name)
-    rmFile(_filepath(device_name))
+    rm_file(_filepath(device_name))
 
 
 def is_tracked(device_name):

lib/vdsm/supervdsm_api/udev.py

@@ -1,4 +1,4 @@
-# Copyright 2016 Red Hat, Inc.
+# Copyright 2016-2017 Red Hat, Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -27,7 +27,7 @@
 from vdsm import commands
 from vdsm import cmdutils
 from vdsm import udevadm
-from vdsm import utils
+from vdsm.common import fileutils
 
 from vdsm.constants import EXT_CHOWN, \
     DISKIMAGE_USER, DISKIMAGE_GROUP, \
@@ -78,7 +78,7 @@ def appropriateSCSIDevice(device_name, udev_path):
 def rmAppropriateSCSIDevice(device_name, udev_path):
     rule_file = _UDEV_RULE_FILE_NAME % ('scsi', device_name)
     _log.debug("Removing rule %s", rule_file)
-    utils.rmFile(rule_file)
+    fileutils.rm_file(rule_file)
 
     _log.debug('Changing ownership (to root:disk) of device %s', udev_path)
     cmd = [EXT_CHOWN, 'root:disk', udev_path]

lib/vdsm/supervdsm_server.py

@@ -33,6 +33,7 @@
 from contextlib import closing
 
 from vdsm import concurrent
+from vdsm.common import fileutils
 from vdsm.common import sigutils
 from vdsm.common import zombiereaper
 
@@ -305,7 +306,7 @@ def wrapper(_SuperVdsm, *args, **kwargs):
             log.debug("Terminated normally")
         finally:
             if os.path.exists(address):
-                utils.rmFile(address)
+                fileutils.rm_file(address)
 
     except Exception:
         log.error("Could not start Super Vdsm", exc_info=True)

lib/vdsm/utils.py

@@ -51,6 +51,7 @@
 import weakref
 
 from vdsm.common import zombiereaper
+from vdsm.common.fileutils import rm_file
 
 _THP_STATE_PATH = '/sys/kernel/mm/transparent_hugepage/enabled'
 if not os.path.exists(_THP_STATE_PATH):
@@ -85,23 +86,6 @@ def isBlockDevice(path):
     return stat.S_ISBLK(os.stat(path).st_mode)
 
 
-def rmFile(fileToRemove):
-    """
-    Try to remove a file.
-
-    If the file doesn't exist it's assumed that it was already removed.
-    """
-    try:
-        os.unlink(fileToRemove)
-    except OSError as e:
-        if e.errno == errno.ENOENT:
-            logging.warning("File: %s already removed", fileToRemove)
-        else:
-            logging.error("Removing file: %s failed", fileToRemove,
-                          exc_info=True)
-            raise
-
-
 def rmTree(directoryToRemove):
     """
     Try to remove a directory and all it's contents.
@@ -163,7 +147,7 @@ def forceLink(src, dst):
         os.link(src, dst)
     except OSError as e:
         if e.errno == errno.EEXIST:
-            rmFile(dst)
+            rm_file(dst)
             os.link(src, dst)
         else:
             logging.error("Linking file: %s to %s failed", src, dst,
@@ -815,7 +799,7 @@ def kill_and_rm_pid(pid, pid_file):
         else:
             raise
     if pid_file is not None:
-        rmFile(pid_file)
+        rm_file(pid_file)
 
 
 def unique(iterable):
@@ -888,7 +872,7 @@ def atomic_file_write(filename, flag):
         with open(tmp_filename, flag) as f:
             yield f
     except:
-        rmFile(tmp_filename)
+        rm_file(tmp_filename)
         raise
     else:
         os.rename(tmp_filename, filename)

lib/vdsm/virt/containers/xmlfile.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2016 Red Hat, Inc.
+# Copyright 2016-2017 Red Hat, Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -31,7 +31,7 @@
 
 from vdsm.virt import metadata
 from vdsm.virt import xmlconstants
-from vdsm.utils import rmFile
+from vdsm.common.fileutils import rm_file
 from vdsm import constants
 
 
@@ -72,7 +72,7 @@ def save(self, root):
 
     def clear(self):
         self._log.debug('clearing XML for container %s', self._name)
-        rmFile(self.path)
+        rm_file(self.path)
 
 
 class ConfigError(Exception):

lib/vdsm/virt/recovery.py

@@ -28,6 +28,7 @@
 
 import libvirt
 
+from vdsm.common import fileutils
 from vdsm.common import response
 from vdsm.compat import pickle
 from vdsm import constants
@@ -89,7 +90,7 @@ def name(self):
 
     def cleanup(self):
         with self._lock:
-            utils.rmFile(self._path)
+            fileutils.rm_file(self._path)
             self._path = None
 
     def save(self, vm):

lib/vdsm/virt/utils.py

@@ -29,7 +29,8 @@
 import os.path
 import threading
 
-from vdsm.utils import monotonic_time, rmFile
+from vdsm.common.fileutils import rm_file
+from vdsm.utils import monotonic_time
 
 log = logging.getLogger('virt.utils')
 
@@ -124,8 +125,8 @@ def _get_live(self, key):
 
 def cleanup_guest_socket(sock):
     if os.path.islink(sock):
-        rmFile(os.path.realpath(sock))
-    rmFile(sock)
+        rm_file(os.path.realpath(sock))
+    rm_file(sock)
 
 
 class DynamicBoundedSemaphore(object):

tests/hookValidation.py

@@ -25,6 +25,7 @@
 from functools import wraps
 from vdsm import constants
 from vdsm import utils
+from vdsm.common import fileutils
 
 
 def _createHookScript(hook_path, hook_filename, script=None):
@@ -78,11 +79,11 @@ def wrapper(*args, **kwargs):
                 output = test_function(*args, **kwargs)
             finally:
                 if directory_existed:
-                    utils.rmFile(hook_path + '/' + hook_name)
+                    fileutils.rm_file(hook_path + '/' + hook_name)
                 else:
                     utils.rmTree(hook_path)
 
-                utils.rmFile(cookie_file)
+                fileutils.rm_file(cookie_file)
 
                 if not functional:
                     constants.P_VDSM_HOOKS = old_vdsm_hooks

tests/network/conf_persistence_test.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2013-2016 Red Hat, Inc.
+# Copyright 2013-2017 Red Hat, Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -26,10 +26,10 @@
 
 from nose.plugins.attrib import attr
 
+from vdsm.common.fileutils import rm_file
 from vdsm.network import errors as ne
 from vdsm.network.canonicalize import canonicalize_networks
 from vdsm.network.netconfpersistence import Config, Transaction
-from vdsm.utils import rmFile
 
 from testlib import VdsmTestCase as TestCaseBase
 
@@ -73,7 +73,7 @@ def testInit(self):
             persistence = Config(self.tempdir)
             self.assertEqual(persistence.networks[NETWORK], NETWORK_ATTRIBUTES)
         finally:
-            rmFile(filePath)
+            rm_file(filePath)
 
     def testSetAndRemoveNetwork(self):
         persistence = Config(self.tempdir)

tests/network/conf_test.py

@@ -167,7 +167,7 @@ def testPersistentBackup(self):
 
 @attr(type='unit')
 @mock.patch.object(ifcfg_acquire.networkmanager, 'is_running', lambda: False)
-@mock.patch.object(ifcfg_acquire.utils, 'rmFile')
+@mock.patch.object(ifcfg_acquire.fileutils, 'rm_file')
 @mock.patch.object(ifcfg_acquire.os, 'rename')
 @mock.patch.object(ifcfg_acquire.glob, 'iglob')
 @mock.patch.object(ifcfg_acquire.misc, 'open', create=True)

tests/network/netfunctestlib.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2016 Red Hat, Inc.
+# Copyright 2016-2017 Red Hat, Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -27,7 +27,7 @@
 
 from nose.plugins.skip import SkipTest
 
-from vdsm import utils
+from vdsm.common import fileutils
 import vdsm.config
 from vdsm.network import kernelconfig
 from vdsm.network.ip import dhclient
@@ -430,7 +430,7 @@ def _cleanup(self):
         for attr in six.itervalues(self.setup_bonds):
             nics_used += attr['nics']
         for nic in nics_used:
-            utils.rmFile(IFCFG_PREFIX + nic)
+            fileutils.rm_file(IFCFG_PREFIX + nic)
 
         return status, msg
 

vdsm/storage/blockVolume.py

@@ -25,6 +25,7 @@
 from vdsm import constants
 from vdsm import qemuimg
 from vdsm.common import exception
+from vdsm.common import fileutils
 from vdsm.common.threadlocal import vars
 from vdsm.compat import sanlock
 from vdsm.config import config
@@ -38,7 +39,6 @@
 from vdsm.storage import task
 from vdsm.storage.misc import deprecated
 from vdsm.storage.volumemetadata import VolumeMetadata
-import vdsm.utils as utils
 
 import volume
 import image
@@ -492,7 +492,7 @@ def _create(cls, dom, imgUUID, volUUID, size, volFormat, preallocate,
         lvm.createLV(dom.sdUUID, volUUID, "%s" % lvSize, activate=True,
                      initialTags=(sc.TAG_VOL_UNINIT,))
 
-        utils.rmFile(volPath)
+        fileutils.rm_file(volPath)
         os.symlink(lvm.lvPath(dom.sdUUID, volUUID), volPath)
 
         if not volParent:
@@ -707,7 +707,7 @@ def getDevPath(self):
     @classmethod
     def shareVolumeRollback(cls, taskObj, volPath):
         cls.log.info("Volume rollback for volPath=%s", volPath)
-        utils.rmFile(volPath)
+        fileutils.rm_file(volPath)
 
     def getVolumeTag(self, tagPrefix):
         return self._manifest.getVolumeTag(tagPrefix)