salt/tests/unit/test_files.py

80 lines
2.5 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
'''
tests.unit.file_test
~~~~~~~~~~~~~~~~~~~~
'''
# Import pytohn libs
from __future__ import absolute_import
import os
2014-11-22 11:31:40 +00:00
import copy
import shutil
import tempfile
# Import Salt Testing libs
from tests.support.unit import TestCase
# Import Salt libs
Use explicit unicode strings + break up salt.utils 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.
2017-07-25 01:47:15 +00:00
from salt.ext import six
import salt.utils.files
2014-11-22 11:31:40 +00:00
class FilesTestCase(TestCase):
STRUCTURE = {
'foo': {
'foofile.txt': 'fooSTRUCTURE'
},
'bar': {
'barfile.txt': 'barSTRUCTURE'
}
}
def _create_temp_structure(self, temp_directory, structure):
2014-11-22 11:31:40 +00:00
for folder, files in six.iteritems(structure):
current_directory = os.path.join(temp_directory, folder)
os.makedirs(current_directory)
2014-11-22 11:31:40 +00:00
for name, content in six.iteritems(files):
path = os.path.join(temp_directory, folder, name)
with salt.utils.files.fopen(path, 'w+') as fh:
fh.write(content)
def _validate_folder_structure_and_contents(self, target_directory,
desired_structure):
2014-11-22 11:31:40 +00:00
for folder, files in six.iteritems(desired_structure):
for name, content in six.iteritems(files):
path = os.path.join(target_directory, folder, name)
with salt.utils.files.fopen(path) as fh:
assert fh.read().strip() == content
def setUp(self):
super(FilesTestCase, self).setUp()
self.temp_dir = tempfile.mkdtemp()
self._create_temp_structure(self.temp_dir,
self.STRUCTURE)
def tearDown(self):
super(FilesTestCase, self).tearDown()
shutil.rmtree(self.temp_dir)
def test_recursive_copy(self):
test_target_directory = tempfile.mkdtemp()
TARGET_STRUCTURE = {
'foo': {
'foo.txt': 'fooTARGET_STRUCTURE'
},
'baz': {
'baz.txt': 'bazTARGET_STRUCTURE'
}
}
self._create_temp_structure(test_target_directory, TARGET_STRUCTURE)
try:
salt.utils.files.recursive_copy(self.temp_dir, test_target_directory)
DESIRED_STRUCTURE = copy.copy(TARGET_STRUCTURE)
DESIRED_STRUCTURE.update(self.STRUCTURE)
self._validate_folder_structure_and_contents(
test_target_directory,
DESIRED_STRUCTURE
)
finally:
shutil.rmtree(test_target_directory)