mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 17:09:03 +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.
96 lines
2.9 KiB
Python
96 lines
2.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
'''
|
|
:codeauthor: :email:`Pedro Algarvio (pedro@algarvio.me)`
|
|
:copyright: Copyright 2014 by the SaltStack Team, see AUTHORS for more details.
|
|
:license: Apache 2.0, see LICENSE for more details.
|
|
|
|
|
|
tests.support.xmlunit
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
XML Unit Tests
|
|
'''
|
|
# pylint: disable=wrong-import-order,wrong-import-position
|
|
|
|
# Import python libs
|
|
from __future__ import absolute_import
|
|
import io
|
|
import sys
|
|
import logging
|
|
|
|
# Import 3rd-party libs
|
|
from salt.ext import six
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
try:
|
|
import xmlrunner.runner
|
|
import xmlrunner.result
|
|
HAS_XMLRUNNER = True
|
|
|
|
class _DelegateIO(object):
|
|
'''
|
|
This class defines an object that captures whatever is written to
|
|
a stream or file.
|
|
'''
|
|
|
|
def __init__(self, delegate):
|
|
self._captured = six.StringIO()
|
|
self.delegate = delegate
|
|
|
|
def write(self, text):
|
|
if six.PY2 and isinstance(text, six.text_type):
|
|
text = text.encode(__salt_system_encoding__)
|
|
self._captured.write(text)
|
|
self.delegate.write(text)
|
|
|
|
def fileno(self):
|
|
return self.delegate.fileno()
|
|
|
|
def __getattr__(self, attr):
|
|
try:
|
|
return getattr(self._captured, attr)
|
|
except (AttributeError, io.UnsupportedOperation):
|
|
return getattr(self.delegate, attr)
|
|
|
|
class _XMLTestResult(xmlrunner.result._XMLTestResult):
|
|
def startTest(self, test):
|
|
log.debug('>>>>> START >>>>> {0}'.format(test.id()))
|
|
# xmlrunner classes are NOT new-style classes
|
|
xmlrunner.result._XMLTestResult.startTest(self, test)
|
|
if self.buffer:
|
|
# Let's override the values of self._stdXXX_buffer
|
|
# We want a similar sys.stdXXX file like behaviour
|
|
self._stderr_buffer = _DelegateIO(sys.__stderr__)
|
|
self._stdout_buffer = _DelegateIO(sys.__stdout__)
|
|
sys.stderr = self._stderr_buffer
|
|
sys.stdout = self._stdout_buffer
|
|
|
|
def stopTest(self, test):
|
|
log.debug('<<<<< END <<<<<<< {0}'.format(test.id()))
|
|
# xmlrunner classes are NOT new-style classes
|
|
return xmlrunner.result._XMLTestResult.stopTest(self, test)
|
|
|
|
class XMLTestRunner(xmlrunner.runner.XMLTestRunner):
|
|
def _make_result(self):
|
|
return _XMLTestResult(
|
|
self.stream,
|
|
self.descriptions,
|
|
self.verbosity,
|
|
self.elapsed_times
|
|
)
|
|
|
|
def run(self, test):
|
|
result = xmlrunner.runner.XMLTestRunner.run(self, test)
|
|
self.stream.writeln('Finished generating XML reports')
|
|
return result
|
|
|
|
except ImportError:
|
|
HAS_XMLRUNNER = False
|
|
|
|
class XMLTestRunner(object):
|
|
'''
|
|
This is a dumb class just so we don't break projects at import time
|
|
'''
|