ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-09-12 16:08:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Fix "Text file busy" exception in atomic_move (#9526) (#17204)

Browse source 
tempfile.NamedTemporaryFile keeps a file handle causing os.rename() to fail with windows based vboxfs: [Errno 26] Text file busy.
Changed NamedTemporaryFile to mkstemp() and added a finally block to unlink the temp file in each and every case.
This commit is contained in:
Alexander Stock 2016-08-26 16:41:17 +02:00 • committed by Toshio Kuratomi
commit 238cccf166
2 changed files with 57 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

84
lib/ansible/module_utils/basic.py
View file

@ -1944,55 +1944,59 @@ class AnsibleModule(object):
dest_dir = os.path.dirname(dest) dest_dir = os.path.dirname(dest)
dest_file = os.path.basename(dest) dest_file = os.path.basename(dest)
try: try:
tmp_dest = tempfile.NamedTemporaryFile( tmp_dest_fd, tmp_dest_name = tempfile.mkstemp(
prefix=".ansible_tmp", dir=dest_dir, suffix=dest_file) prefix=".ansible_tmp", dir=dest_dir, suffix=dest_file)
except (OSError, IOError): except (OSError, IOError):
e = get_exception() e = get_exception()
self.fail_json(msg='The destination directory (%s) is not writable by the current user. Error was: %s' % (dest_dir, e)) self.fail_json(msg='The destination directory (%s) is not writable by the current user. Error was: %s' % (dest_dir, e))
try: # leaves tmp file behind when sudo and not root try:
if switched_user and os.getuid() != 0:
# cleanup will happen by 'rm' of tempdir
# copy2 will preserve some metadata
shutil.copy2(src, tmp_dest.name)
else:
shutil.move(src, tmp_dest.name)
if self.selinux_enabled():
self.set_context_if_different(
tmp_dest.name, context, False)
try: try:
tmp_stat = os.stat(tmp_dest.name) # close tmp file handle before file operations to prevent text file busy errors on vboxfs synced folders (windows host)
if dest_stat and (tmp_stat.st_uid != dest_stat.st_uid or tmp_stat.st_gid != dest_stat.st_gid): os.close(tmp_dest_fd)
os.chown(tmp_dest.name, dest_stat.st_uid, dest_stat.st_gid) # leaves tmp file behind when sudo and not root
except OSError: if switched_user and os.getuid() != 0:
e = get_exception() # cleanup will happen by 'rm' of tempdir
if e.errno != errno.EPERM: # copy2 will preserve some metadata
raise shutil.copy2(src, tmp_dest_name)
os.rename(tmp_dest.name, dest) else:
except (shutil.Error, OSError, IOError): shutil.move(src, tmp_dest_name)
e = get_exception() if self.selinux_enabled():
# sadly there are some situations where we cannot ensure atomicity, but only if self.set_context_if_different(
# the user insists and we get the appropriate error we update the file unsafely tmp_dest_name, context, False)
if unsafe_writes and e.errno == errno.EBUSY:
#TODO: issue warning that this is an unsafe operation, but doing it cause user insists
try: try:
try: tmp_stat = os.stat(tmp_dest_name)
out_dest = open(dest, 'wb') if dest_stat and (tmp_stat.st_uid != dest_stat.st_uid or tmp_stat.st_gid != dest_stat.st_gid):
in_src = open(src, 'rb') os.chown(tmp_dest_name, dest_stat.st_uid, dest_stat.st_gid)
shutil.copyfileobj(in_src, out_dest) except OSError:
finally: # assuring closed files in 2.4 compatible way
if out_dest:
out_dest.close()
if in_src:
in_src.close()
except (shutil.Error, OSError, IOError):
e = get_exception() e = get_exception()
self.fail_json(msg='Could not write data to file (%s) from (%s): %s' % (dest, src, e)) if e.errno != errno.EPERM:
raise
os.rename(tmp_dest_name, dest)
except (shutil.Error, OSError, IOError):
e = get_exception()
# sadly there are some situations where we cannot ensure atomicity, but only if
# the user insists and we get the appropriate error we update the file unsafely
if unsafe_writes and e.errno == errno.EBUSY:
#TODO: issue warning that this is an unsafe operation, but doing it cause user insists
try:
try:
out_dest = open(dest, 'wb')
in_src = open(src, 'rb')
shutil.copyfileobj(in_src, out_dest)
finally: # assuring closed files in 2.4 compatible way
if out_dest:
out_dest.close()
if in_src:
in_src.close()
except (shutil.Error, OSError, IOError):
e = get_exception()
self.fail_json(msg='Could not write data to file (%s) from (%s): %s' % (dest, src, e))
else: else:
self.fail_json(msg='Could not replace file: %s to %s: %s' % (src, dest, e)) self.fail_json(msg='Could not replace file: %s to %s: %s' % (src, dest, e))
finally:
self.cleanup(tmp_dest.name) self.cleanup(tmp_dest_name)
if creating: if creating:
# make sure the file has the correct permissions # make sure the file has the correct permissions

26
test/units/module_utils/test_basic.py
View file

@ -741,7 +741,7 @@ class TestModuleUtilsBasic(ModuleTestCase):
with patch('os.lchown', side_effect=OSError) as m: with patch('os.lchown', side_effect=OSError) as m:
self.assertRaises(SystemExit, am.set_group_if_different, '/path/to/file', 'root', False) self.assertRaises(SystemExit, am.set_group_if_different, '/path/to/file', 'root', False)
@patch('tempfile.NamedTemporaryFile') @patch('tempfile.mkstemp')
@patch('os.umask') @patch('os.umask')
@patch('shutil.copyfileobj') @patch('shutil.copyfileobj')
@patch('shutil.move') @patch('shutil.move')
@ -755,8 +755,10 @@ class TestModuleUtilsBasic(ModuleTestCase):
@patch('os.chmod') @patch('os.chmod')
@patch('os.stat') @patch('os.stat')
@patch('os.path.exists') @patch('os.path.exists')
@patch('os.close')
def test_module_utils_basic_ansible_module_atomic_move( def test_module_utils_basic_ansible_module_atomic_move(
self, self,
_os_close,
_os_path_exists, _os_path_exists,
_os_stat, _os_stat,
_os_chmod, _os_chmod,
@ -770,7 +772,7 @@ class TestModuleUtilsBasic(ModuleTestCase):
_shutil_move, _shutil_move,
_shutil_copyfileobj, _shutil_copyfileobj,
_os_umask, _os_umask,
_tempfile_NamedTemporaryFile, _tempfile_mkstemp,
): ):
from ansible.module_utils import basic from ansible.module_utils import basic
@ -903,20 +905,21 @@ class TestModuleUtilsBasic(ModuleTestCase):
self.assertRaises(SystemExit, am.atomic_move, '/path/to/src', '/path/to/dest') self.assertRaises(SystemExit, am.atomic_move, '/path/to/src', '/path/to/dest')
# next we test with EPERM so it continues to the alternate code for moving # next we test with EPERM so it continues to the alternate code for moving
# test with NamedTemporaryFile raising an error first # test with mkstemp raising an error first
_os_path_exists.side_effect = [False, False] _os_path_exists.side_effect = [False, False]
_os_getlogin.return_value = 'root' _os_getlogin.return_value = 'root'
_os_getuid.return_value = 0 _os_getuid.return_value = 0
_os_close.return_value = None
_pwd_getpwuid.return_value = ('root', '', 0, 0, '', '', '') _pwd_getpwuid.return_value = ('root', '', 0, 0, '', '', '')
_os_umask.side_effect = [18, 0] _os_umask.side_effect = [18, 0]
_os_rename.side_effect = [OSError(errno.EPERM, 'failing with EPERM'), None] _os_rename.side_effect = [OSError(errno.EPERM, 'failing with EPERM'), None]
_tempfile_NamedTemporaryFile.return_value = None _tempfile_mkstemp.return_value = None
_tempfile_NamedTemporaryFile.side_effect = OSError() _tempfile_mkstemp.side_effect = OSError()
am.selinux_enabled.return_value = False am.selinux_enabled.return_value = False
self.assertRaises(SystemExit, am.atomic_move, '/path/to/src', '/path/to/dest') self.assertRaises(SystemExit, am.atomic_move, '/path/to/src', '/path/to/dest')
# then test with it creating a temp file # then test with it creating a temp file
_os_path_exists.side_effect = [False, False] _os_path_exists.side_effect = [False, False, False]
_os_getlogin.return_value = 'root' _os_getlogin.return_value = 'root'
_os_getuid.return_value = 0 _os_getuid.return_value = 0
_pwd_getpwuid.return_value = ('root', '', 0, 0, '', '', '') _pwd_getpwuid.return_value = ('root', '', 0, 0, '', '', '')
@ -927,23 +930,20 @@ class TestModuleUtilsBasic(ModuleTestCase):
mock_stat3 = MagicMock() mock_stat3 = MagicMock()
_os_stat.return_value = [mock_stat1, mock_stat2, mock_stat3] _os_stat.return_value = [mock_stat1, mock_stat2, mock_stat3]
_os_stat.side_effect = None _os_stat.side_effect = None
mock_tempfile = MagicMock() _tempfile_mkstemp.return_value = (None, '/path/to/tempfile')
mock_tempfile.name = '/path/to/tempfile' _tempfile_mkstemp.side_effect = None
_tempfile_NamedTemporaryFile.return_value = mock_tempfile
_tempfile_NamedTemporaryFile.side_effect = None
am.selinux_enabled.return_value = False am.selinux_enabled.return_value = False
# FIXME: we don't assert anything here yet # FIXME: we don't assert anything here yet
am.atomic_move('/path/to/src', '/path/to/dest') am.atomic_move('/path/to/src', '/path/to/dest')
# same as above, but with selinux enabled # same as above, but with selinux enabled
_os_path_exists.side_effect = [False, False] _os_path_exists.side_effect = [False, False, False]
_os_getlogin.return_value = 'root' _os_getlogin.return_value = 'root'
_os_getuid.return_value = 0 _os_getuid.return_value = 0
_pwd_getpwuid.return_value = ('root', '', 0, 0, '', '', '') _pwd_getpwuid.return_value = ('root', '', 0, 0, '', '', '')
_os_umask.side_effect = [18, 0] _os_umask.side_effect = [18, 0]
_os_rename.side_effect = [OSError(errno.EPERM, 'failing with EPERM'), None] _os_rename.side_effect = [OSError(errno.EPERM, 'failing with EPERM'), None]
mock_tempfile = MagicMock() _tempfile_mkstemp.return_value = (None, None)
_tempfile_NamedTemporaryFile.return_value = mock_tempfile
mock_context = MagicMock() mock_context = MagicMock()
am.selinux_default_context.return_value = mock_context am.selinux_default_context.return_value = mock_context
am.selinux_enabled.return_value = True am.selinux_enabled.return_value = True