salt/tests/unit/output/test_json_out.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

72 lines
2.4 KiB
Python

# -*- coding: utf-8 -*-
'''
unittests for json outputter
'''
# Import Python Libs
from __future__ import absolute_import
import json
# Import Salt Testing Libs
from tests.support.mixins import LoaderModuleMockMixin
from tests.support.unit import TestCase
from tests.support.mock import patch
# Import Salt Libs
import salt.output.json_out as json_out
# Import 3rd-party libs
from salt.ext import six
class JsonTestCase(TestCase, LoaderModuleMockMixin):
'''
Test cases for salt.output.json_out
'''
def setup_loader_modules(self):
return {json_out: {}}
def setUp(self):
self.data = {'test': 'two', 'example': 'one'}
self.addCleanup(delattr, self, 'data')
def test_default_output(self):
ret = json_out.output(self.data)
self.assertIn('"test": "two"', ret)
self.assertIn('"example": "one"', ret)
def test_pretty_output(self):
with patch.dict(json_out.__opts__, {'output_indent': 'pretty'}):
ret = json_out.output(self.data)
self.assertIn('"test": "two"', ret)
self.assertIn('"example": "one"', ret)
def test_indent_output(self):
with patch.dict(json_out.__opts__, {'output_indent': 2}):
ret = json_out.output(self.data)
self.assertIn('"test": "two"', ret)
self.assertIn('"example": "one"', ret)
def test_negative_zero_output(self):
with patch.dict(json_out.__opts__, {'output_indent': 0}):
ret = json_out.output(self.data)
self.assertIn('"test": "two"', ret)
self.assertIn('"example": "one"', ret)
def test_negative_int_output(self):
with patch.dict(json_out.__opts__, {'output_indent': -1}):
ret = json_out.output(self.data)
self.assertIn('"test": "two"', ret)
self.assertIn('"example": "one"', ret)
def test_unicode_output(self):
with patch.dict(json_out.__opts__, {'output_indent': 'pretty'}):
data = {'test': '\xe1', 'example': 'one'}
expect = ('{"message": "\'utf8\' codec can\'t decode byte 0xe1 in position 0: unexpected end of data", '
'"error": "Unable to serialize output to json"}')
ret = json_out.output(data)
if six.PY2:
self.assertEqual(expect, ret)
else:
self.assertEqual(json.loads(ret), data)