mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 09:23:56 +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.
93 lines
3.3 KiB
Python
93 lines
3.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
'''
|
|
:codeauthor: :email:`Nicole Thomas <nicole@saltstack.com>`
|
|
'''
|
|
|
|
# Import Salt Libs
|
|
from __future__ import absolute_import
|
|
|
|
# Import Salt Testing Libs
|
|
from tests.support.unit import TestCase, skipIf
|
|
from tests.support.mock import NO_MOCK, NO_MOCK_REASON
|
|
|
|
# Import Salt Libs
|
|
import salt.utils.http as http
|
|
|
|
|
|
@skipIf(NO_MOCK, NO_MOCK_REASON)
|
|
class HTTPTestCase(TestCase):
|
|
'''
|
|
Unit TestCase for the salt.utils.http module.
|
|
'''
|
|
|
|
# sanitize_url tests
|
|
|
|
def test_sanitize_url_hide_fields_none(self):
|
|
'''
|
|
Tests sanitizing a url when the hide_fields kwarg is None.
|
|
'''
|
|
mock_url = 'https://api.testing.com/?&foo=bar&test=testing'
|
|
ret = http.sanitize_url(mock_url, hide_fields=None)
|
|
self.assertEqual(ret, mock_url)
|
|
|
|
def test_sanitize_url_no_elements(self):
|
|
'''
|
|
Tests sanitizing a url when no elements should be sanitized.
|
|
'''
|
|
mock_url = 'https://api.testing.com/?&foo=bar&test=testing'
|
|
ret = http.sanitize_url(mock_url, [''])
|
|
self.assertEqual(ret, mock_url)
|
|
|
|
def test_sanitize_url_single_element(self):
|
|
'''
|
|
Tests sanitizing a url with only a single element to be sanitized.
|
|
'''
|
|
mock_url = 'https://api.testing.com/?&keep_it_secret=abcdefghijklmn' \
|
|
'&api_action=module.function'
|
|
mock_ret = 'https://api.testing.com/?&keep_it_secret=XXXXXXXXXX&' \
|
|
'api_action=module.function'
|
|
ret = http.sanitize_url(mock_url, ['keep_it_secret'])
|
|
self.assertEqual(ret, mock_ret)
|
|
|
|
def test_sanitize_url_multiple_elements(self):
|
|
'''
|
|
Tests sanitizing a url with multiple elements to be sanitized.
|
|
'''
|
|
mock_url = 'https://api.testing.com/?rootPass=badpassword%21' \
|
|
'&skipChecks=True&api_key=abcdefghijklmn' \
|
|
'&NodeID=12345&api_action=module.function'
|
|
mock_ret = 'https://api.testing.com/?rootPass=XXXXXXXXXX' \
|
|
'&skipChecks=True&api_key=XXXXXXXXXX' \
|
|
'&NodeID=12345&api_action=module.function'
|
|
ret = http.sanitize_url(mock_url, ['api_key', 'rootPass'])
|
|
self.assertEqual(ret, mock_ret)
|
|
|
|
# _sanitize_components tests
|
|
|
|
def test_sanitize_components_no_elements(self):
|
|
'''
|
|
Tests when zero elements need to be sanitized.
|
|
'''
|
|
mock_component_list = ['foo=bar', 'bar=baz', 'hello=world']
|
|
mock_ret = 'foo=bar&bar=baz&hello=world&'
|
|
ret = http._sanitize_url_components(mock_component_list, 'api_key')
|
|
self.assertEqual(ret, mock_ret)
|
|
|
|
def test_sanitize_components_one_element(self):
|
|
'''
|
|
Tests a single component to be sanitized.
|
|
'''
|
|
mock_component_list = ['foo=bar', 'api_key=abcdefghijklmnop']
|
|
mock_ret = 'foo=bar&api_key=XXXXXXXXXX&'
|
|
ret = http._sanitize_url_components(mock_component_list, 'api_key')
|
|
self.assertEqual(ret, mock_ret)
|
|
|
|
def test_sanitize_components_multiple_elements(self):
|
|
'''
|
|
Tests two componenets to be sanitized.
|
|
'''
|
|
mock_component_list = ['foo=bar', 'foo=baz', 'api_key=testing']
|
|
mock_ret = 'foo=XXXXXXXXXX&foo=XXXXXXXXXX&api_key=testing&'
|
|
ret = http._sanitize_url_components(mock_component_list, 'foo')
|
|
self.assertEqual(ret, mock_ret)
|