salt/tests/integration/modules/test_mac_xattr.py
Erik Johnson 3184168365 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-08-08 13:33:43 -05:00

178 lines
5.5 KiB
Python

# -*- coding: utf-8 -*-
'''
integration tests for mac_xattr
'''
# Import Python libs
from __future__ import absolute_import
import os
# Import Salt Testing libs
from tests.support.case import ModuleCase
from tests.support.paths import TMP
# Import Salt libs
import salt.utils.path
import salt.utils.platform
TEST_FILE = os.path.join(TMP, 'xattr_test_file.txt')
NO_FILE = os.path.join(TMP, 'xattr_no_file.txt')
class MacXattrModuleTest(ModuleCase):
'''
Validate the mac_xattr module
'''
def setUp(self):
'''
Create test file for testing extended attributes
'''
if not salt.utils.platform.is_darwin():
self.skipTest('Test only available on macOS')
if not salt.utils.path.which('xattr'):
self.skipTest('Test requires xattr binary')
self.run_function('file.touch', [TEST_FILE])
def tearDown(self):
'''
Clean up test file
'''
if os.path.exists(TEST_FILE):
os.remove(TEST_FILE)
def test_list_no_xattr(self):
'''
Make sure there are no attributes
'''
# Clear existing attributes
self.assertTrue(self.run_function('xattr.clear', [TEST_FILE]))
# Test no attributes
self.assertEqual(self.run_function('xattr.list', [TEST_FILE]), {})
# Test file not found
self.assertEqual(self.run_function('xattr.list', [NO_FILE]),
'ERROR: File not found: {0}'.format(NO_FILE))
def test_write(self):
'''
Write an attribute
'''
# Clear existing attributes
self.assertTrue(self.run_function('xattr.clear', [TEST_FILE]))
# Write some attributes
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'spongebob', 'squarepants']))
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'squidward', 'plankton']))
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'crabby', 'patty']))
# Test that they were actually added
self.assertEqual(
self.run_function('xattr.list', [TEST_FILE]),
{'spongebob': 'squarepants',
'squidward': 'plankton',
'crabby': 'patty'})
# Test file not found
self.assertEqual(
self.run_function('xattr.write', [NO_FILE, 'patrick', 'jellyfish']),
'ERROR: File not found: {0}'.format(NO_FILE))
def test_read(self):
'''
Test xattr.read
'''
# Clear existing attributes
self.assertTrue(self.run_function('xattr.clear', [TEST_FILE]))
# Write an attribute
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'spongebob', 'squarepants']))
# Read the attribute
self.assertEqual(
self.run_function('xattr.read', [TEST_FILE, 'spongebob']),
'squarepants')
# Test file not found
self.assertEqual(
self.run_function('xattr.read', [NO_FILE, 'spongebob']),
'ERROR: File not found: {0}'.format(NO_FILE))
# Test attribute not found
self.assertEqual(
self.run_function('xattr.read', [TEST_FILE, 'patrick']),
'ERROR: Attribute not found: patrick')
def test_delete(self):
'''
Test xattr.delete
'''
# Clear existing attributes
self.assertTrue(self.run_function('xattr.clear', [TEST_FILE]))
# Write some attributes
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'spongebob', 'squarepants']))
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'squidward', 'plankton']))
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'crabby', 'patty']))
# Delete an attribute
self.assertTrue(
self.run_function('xattr.delete', [TEST_FILE, 'squidward']))
# Make sure it was actually deleted
self.assertEqual(
self.run_function('xattr.list', [TEST_FILE]),
{'spongebob': 'squarepants', 'crabby': 'patty'})
# Test file not found
self.assertEqual(
self.run_function('xattr.delete', [NO_FILE, 'spongebob']),
'ERROR: File not found: {0}'.format(NO_FILE))
# Test attribute not found
self.assertEqual(
self.run_function('xattr.delete', [TEST_FILE, 'patrick']),
'ERROR: Attribute not found: patrick')
def test_clear(self):
'''
Test xattr.clear
'''
# Clear existing attributes
self.assertTrue(self.run_function('xattr.clear', [TEST_FILE]))
# Write some attributes
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'spongebob', 'squarepants']))
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'squidward', 'plankton']))
self.assertTrue(
self.run_function('xattr.write',
[TEST_FILE, 'crabby', 'patty']))
# Test Clear
self.assertTrue(self.run_function('xattr.clear', [TEST_FILE]))
# Test file not found
self.assertEqual(self.run_function('xattr.clear', [NO_FILE]),
'ERROR: File not found: {0}'.format(NO_FILE))