mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 08:58:59 +00:00
3184168365
This PR is part of what will be an ongoing effort to use explicit unicode strings in Salt. Because Python 3 does not suport Python 2's raw unicode string syntax (i.e. `ur'\d+'`), we must use `salt.utils.locales.sdecode()` to ensure that the raw string is unicode. However, because of how `salt/utils/__init__.py` has evolved into the hulking monstrosity it is today, this means importing a large module in places where it is not needed, which could negatively impact performance. For this reason, this PR also breaks out some of the functions from `salt/utils/__init__.py` into new/existing modules under `salt/utils/`. The long term goal will be that the modules within this directory do not depend on importing `salt.utils`. A summary of the changes in this PR is as follows: * Moves the following functions from `salt.utils` to new locations (including a deprecation warning if invoked from `salt.utils`): `to_bytes`, `to_str`, `to_unicode`, `str_to_num`, `is_quoted`, `dequote`, `is_hex`, `is_bin_str`, `rand_string`, `contains_whitespace`, `clean_kwargs`, `invalid_kwargs`, `which`, `which_bin`, `path_join`, `shlex_split`, `rand_str`, `is_windows`, `is_proxy`, `is_linux`, `is_darwin`, `is_sunos`, `is_smartos`, `is_smartos_globalzone`, `is_smartos_zone`, `is_freebsd`, `is_netbsd`, `is_openbsd`, `is_aix` * Moves the functions already deprecated by @rallytime to the bottom of `salt/utils/__init__.py` for better organization, so we can keep the deprecated ones separate from the ones yet to be deprecated as we continue to break up `salt.utils` * Updates `salt/*.py` and all files under `salt/client/` to use explicit unicode string literals. * Gets rid of implicit imports of `salt.utils` (e.g. `from salt.utils import foo` becomes `import salt.utils.foo as foo`). * Renames the `test.rand_str` function to `test.random_hash` to more accurately reflect what it does * Modifies `salt.utils.stringutils.random()` (née `salt.utils.rand_string()`) such that it returns a string matching the passed size. Previously this function would get `size` bytes from `os.urandom()`, base64-encode it, and return the result, which would in most cases not be equal to the passed size.
177 lines
6.9 KiB
Python
177 lines
6.9 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 tests.support.case import ModuleCase
|
|
from tests.support.unit import skipIf
|
|
from tests.support.paths import FILES, TMP
|
|
|
|
# Import salt libs
|
|
import salt.utils.files
|
|
import salt.utils.platform
|
|
|
|
|
|
class FileModuleTest(ModuleCase):
|
|
'''
|
|
Validate the file module
|
|
'''
|
|
def setUp(self):
|
|
self.myfile = os.path.join(TMP, 'myfile')
|
|
with salt.utils.files.fopen(self.myfile, 'w+') as fp:
|
|
fp.write('Hello\n')
|
|
self.mydir = os.path.join(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(TMP, 'mysymlink')
|
|
if os.path.islink(self.mysymlink):
|
|
os.remove(self.mysymlink)
|
|
os.symlink(self.myfile, self.mysymlink)
|
|
self.mybadsymlink = os.path.join(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.platform.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.platform.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.platform.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.platform.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.platform.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.platform.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.platform.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(
|
|
FILES, 'file', 'base', 'hello.patch')
|
|
src_file = os.path.join(TMP, 'src.txt')
|
|
with salt.utils.files.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.files.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.files.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_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'])
|