salt/tests/integration/modules/file.py
Pedro Algarvio fc59d5e832 Python 3 Fixes (Pt. 2) (#39397)
* Typo in comment

* First convert to string if not already a string. Then to bytes under Py3.

The reason being that jids from the CLI, at least the one fed in
integration.runners.jobs.ManageTest.test_loopup_jid is loaded as an
integer, and, while the Py2 code converts JIDs to strings, under Py3, we
assume JID's are already strings.

* Mark tests which require root permissions to run

* Allow declaring that the function IS a class method.

```
Python 3.5.3 (default, Jan 21 2017, 00:29:12)
[GCC 6.3.1 20170109] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> class Foo:
...     def bar(self):
...         print('bar')
...
>>> import inspect
>>> inspect.ismethod(Foo.bar)
False
>>> inspect.ismethod(Foo().bar)
True
```

On Python 2, `inspect.ismethod` returns `True` for bound and unbound
methods while on Python 3 it only returns `True` for bound methods.
The explicit `is_class_method` is to avoid instantiating the class just
to get the function signature.

* Always decode responses to the Python version native string implementation

* Just compare the objects as matching list.

Asserting same item count doesn't make that much sense.

* Py3 compatibility

* Fix saltnado tests under Py3

* Python 3 compatibility

* Show me the full traceback

* Revert "Convert fileserver data from bytes to strings"

This reverts commit e53972f8c6.

* Revert "Under Py3, we get `bytes` when using the roots backend directly"

This reverts commit 9f73b240c1.

* Convert from bytes to str if not a binary file

* Py3 compatibility fixes.

Convert file contents from bytes to string if not a binary file
2017-02-14 16:20:56 -07:00

259 lines
10 KiB
Python

# -*- coding: utf-8 -*-
# Import python libs
from __future__ import absolute_import
import getpass
import grp
import pwd
import os
import shutil
import sys
# Import Salt Testing libs
from salttesting import skipIf
from salttesting.helpers import ensure_in_syspath
from salttesting.mock import patch, MagicMock
ensure_in_syspath('../../')
# Import salt libs
import integration
import salt.utils
from salt.modules import file as filemod
class FileModuleTest(integration.ModuleCase):
'''
Validate the file module
'''
def setUp(self):
self.myfile = os.path.join(integration.TMP, 'myfile')
with salt.utils.fopen(self.myfile, 'w+') as fp:
fp.write('Hello\n')
self.mydir = os.path.join(integration.TMP, 'mydir/isawesome')
if not os.path.isdir(self.mydir):
# left behind... Don't fail because of this!
os.makedirs(self.mydir)
self.mysymlink = os.path.join(integration.TMP, 'mysymlink')
if os.path.islink(self.mysymlink):
os.remove(self.mysymlink)
os.symlink(self.myfile, self.mysymlink)
self.mybadsymlink = os.path.join(integration.TMP, 'mybadsymlink')
if os.path.islink(self.mybadsymlink):
os.remove(self.mybadsymlink)
os.symlink('/nonexistentpath', self.mybadsymlink)
super(FileModuleTest, self).setUp()
def tearDown(self):
if os.path.isfile(self.myfile):
os.remove(self.myfile)
if os.path.islink(self.mysymlink):
os.remove(self.mysymlink)
if os.path.islink(self.mybadsymlink):
os.remove(self.mybadsymlink)
shutil.rmtree(self.mydir, ignore_errors=True)
super(FileModuleTest, self).tearDown()
@skipIf(salt.utils.is_windows(), 'No chgrp on Windows')
def test_chown(self):
user = getpass.getuser()
if sys.platform == 'darwin':
group = 'staff'
elif sys.platform.startswith(('linux', 'freebsd', 'openbsd')):
group = grp.getgrgid(pwd.getpwuid(os.getuid()).pw_gid).gr_name
ret = self.run_function('file.chown', arg=[self.myfile, user, group])
self.assertIsNone(ret)
fstat = os.stat(self.myfile)
self.assertEqual(fstat.st_uid, os.getuid())
self.assertEqual(fstat.st_gid, grp.getgrnam(group).gr_gid)
@skipIf(salt.utils.is_windows(), 'No chgrp on Windows')
def test_chown_no_user(self):
user = 'notanyuseriknow'
group = grp.getgrgid(pwd.getpwuid(os.getuid()).pw_gid).gr_name
ret = self.run_function('file.chown', arg=[self.myfile, user, group])
self.assertIn('not exist', ret)
@skipIf(salt.utils.is_windows(), 'No chgrp on Windows')
def test_chown_no_user_no_group(self):
user = 'notanyuseriknow'
group = 'notanygroupyoushoulduse'
ret = self.run_function('file.chown', arg=[self.myfile, user, group])
self.assertIn('Group does not exist', ret)
self.assertIn('User does not exist', ret)
@skipIf(salt.utils.is_windows(), 'No chgrp on Windows')
def test_chown_no_path(self):
user = getpass.getuser()
if sys.platform == 'darwin':
group = 'staff'
elif sys.platform.startswith(('linux', 'freebsd', 'openbsd')):
group = grp.getgrgid(pwd.getpwuid(os.getuid()).pw_gid).gr_name
ret = self.run_function('file.chown',
arg=['/tmp/nosuchfile', user, group])
self.assertIn('File not found', ret)
@skipIf(salt.utils.is_windows(), 'No chgrp on Windows')
def test_chown_noop(self):
user = ''
group = ''
ret = self.run_function('file.chown', arg=[self.myfile, user, group])
self.assertIsNone(ret)
fstat = os.stat(self.myfile)
self.assertEqual(fstat.st_uid, os.getuid())
self.assertEqual(fstat.st_gid, os.getgid())
@skipIf(salt.utils.is_windows(), 'No chgrp on Windows')
def test_chgrp(self):
if sys.platform == 'darwin':
group = 'everyone'
elif sys.platform.startswith(('linux', 'freebsd', 'openbsd')):
group = grp.getgrgid(pwd.getpwuid(os.getuid()).pw_gid).gr_name
ret = self.run_function('file.chgrp', arg=[self.myfile, group])
self.assertIsNone(ret)
fstat = os.stat(self.myfile)
self.assertEqual(fstat.st_gid, grp.getgrnam(group).gr_gid)
@skipIf(salt.utils.is_windows(), 'No chgrp on Windows')
def test_chgrp_failure(self):
group = 'thisgroupdoesntexist'
ret = self.run_function('file.chgrp', arg=[self.myfile, group])
self.assertIn('not exist', ret)
def test_patch(self):
if not self.run_function('cmd.has_exec', ['patch']):
self.skipTest('patch is not installed')
src_patch = os.path.join(
integration.FILES, 'file', 'base', 'hello.patch')
src_file = os.path.join(integration.TMP, 'src.txt')
with salt.utils.fopen(src_file, 'w+') as fp:
fp.write('Hello\n')
# dry-run should not modify src_file
ret = self.minion_run('file.patch', src_file, src_patch, dry_run=True)
assert ret['retcode'] == 0, repr(ret)
with salt.utils.fopen(src_file) as fp:
self.assertEqual(fp.read(), 'Hello\n')
ret = self.minion_run('file.patch', src_file, src_patch)
assert ret['retcode'] == 0, repr(ret)
with salt.utils.fopen(src_file) as fp:
self.assertEqual(fp.read(), 'Hello world\n')
def test_remove_file(self):
ret = self.run_function('file.remove', arg=[self.myfile])
self.assertTrue(ret)
def test_remove_dir(self):
ret = self.run_function('file.remove', arg=[self.mydir])
self.assertTrue(ret)
def test_remove_symlink(self):
ret = self.run_function('file.remove', arg=[self.mysymlink])
self.assertTrue(ret)
def test_remove_broken_symlink(self):
ret = self.run_function('file.remove', arg=[self.mybadsymlink])
self.assertTrue(ret)
def test_cannot_remove(self):
ret = self.run_function('file.remove', arg=['tty'])
self.assertEqual(
'ERROR executing \'file.remove\': File path must be absolute: tty', ret
)
def test_source_list_for_single_file_returns_unchanged(self):
ret = self.run_function('file.source_list', ['salt://http/httpd.conf',
'filehash', 'base'])
self.assertEqual(list(ret), ['salt://http/httpd.conf', 'filehash'])
def test_source_list_for_list_returns_existing_file(self):
filemod.__salt__ = {
'cp.list_master': MagicMock(
return_value=['http/httpd.conf.fallback']),
'cp.list_master_dirs': MagicMock(return_value=[]),
}
filemod.__context__ = {}
ret = filemod.source_list(['salt://http/httpd.conf',
'salt://http/httpd.conf.fallback'],
'filehash', 'base')
self.assertEqual(list(ret), ['salt://http/httpd.conf.fallback', 'filehash'])
def test_source_list_for_list_returns_file_from_other_env(self):
def list_master(env):
dct = {'base': [], 'dev': ['http/httpd.conf']}
return dct[env]
filemod.__salt__ = {
'cp.list_master': MagicMock(side_effect=list_master),
'cp.list_master_dirs': MagicMock(return_value=[]),
}
filemod.__context__ = {}
ret = filemod.source_list(['salt://http/httpd.conf?saltenv=dev',
'salt://http/httpd.conf.fallback'],
'filehash', 'base')
self.assertEqual(list(ret), ['salt://http/httpd.conf?saltenv=dev', 'filehash'])
def test_source_list_for_list_returns_file_from_dict(self):
filemod.__salt__ = {
'cp.list_master': MagicMock(return_value=['http/httpd.conf']),
'cp.list_master_dirs': MagicMock(return_value=[]),
}
filemod.__context__ = {}
ret = filemod.source_list(
[{'salt://http/httpd.conf': ''}], 'filehash', 'base')
self.assertEqual(list(ret), ['salt://http/httpd.conf', 'filehash'])
@patch('salt.modules.file.os.remove')
def test_source_list_for_list_returns_file_from_dict_via_http(self, remove):
remove.return_value = None
filemod.__salt__ = {
'cp.list_master': MagicMock(return_value=[]),
'cp.list_master_dirs': MagicMock(return_value=[]),
'cp.cache_file': MagicMock(return_value='/tmp/http.conf'),
}
filemod.__context__ = {}
ret = filemod.source_list(
[{'http://t.est.com/http/httpd.conf': 'filehash'}], '', 'base')
self.assertEqual(list(ret), ['http://t.est.com/http/httpd.conf', 'filehash'])
def test_source_list_for_single_local_file_slash_returns_unchanged(self):
ret = self.run_function('file.source_list', [self.myfile,
'filehash', 'base'])
self.assertEqual(list(ret), [self.myfile, 'filehash'])
def test_source_list_for_single_local_file_proto_returns_unchanged(self):
ret = self.run_function('file.source_list', ['file://' + self.myfile,
'filehash', 'base'])
self.assertEqual(list(ret), ['file://' + self.myfile, 'filehash'])
def test_source_list_for_list_returns_existing_local_file_slash(self):
ret = filemod.source_list([self.myfile + '-foo',
self.myfile],
'filehash', 'base')
self.assertEqual(list(ret), [self.myfile, 'filehash'])
def test_source_list_for_list_returns_existing_local_file_proto(self):
ret = filemod.source_list(['file://' + self.myfile + '-foo',
'file://' + self.myfile],
'filehash', 'base')
self.assertEqual(list(ret), ['file://' + self.myfile, 'filehash'])
def test_source_list_for_list_returns_local_file_slash_from_dict(self):
ret = filemod.source_list(
[{self.myfile: ''}], 'filehash', 'base')
self.assertEqual(list(ret), [self.myfile, 'filehash'])
def test_source_list_for_list_returns_local_file_proto_from_dict(self):
ret = filemod.source_list(
[{'file://' + self.myfile: ''}], 'filehash', 'base')
self.assertEqual(list(ret), ['file://' + self.myfile, 'filehash'])
if __name__ == '__main__':
from integration import run_tests
run_tests(FileModuleTest)