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.
195 lines
7.4 KiB
Python
195 lines
7.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Import Python libs
|
|
from __future__ import absolute_import
|
|
|
|
# Import Salt Testing Libs
|
|
from tests.support.mixins import LoaderModuleMockMixin
|
|
from tests.support.unit import skipIf, TestCase
|
|
from tests.support.mock import (
|
|
NO_MOCK,
|
|
NO_MOCK_REASON,
|
|
MagicMock,
|
|
patch,
|
|
call
|
|
)
|
|
|
|
# Import 3rd-party libs
|
|
from salt.ext import six
|
|
|
|
# Import Salt Libs
|
|
import salt.states.proxy as proxy
|
|
|
|
|
|
@skipIf(NO_MOCK, NO_MOCK_REASON)
|
|
class ProxyTestCase(TestCase, LoaderModuleMockMixin):
|
|
'''
|
|
Validate the proxy state
|
|
'''
|
|
def setup_loader_modules(self):
|
|
return {proxy: {}}
|
|
|
|
def test_set_proxy_macos(self):
|
|
'''
|
|
Test to make sure we can set the proxy settings on macOS
|
|
'''
|
|
with patch.dict(proxy.__grains__, {'os': 'Darwin'}):
|
|
expected = {'changes': {
|
|
'new': [
|
|
{'port': '3128',
|
|
'server': '192.168.0.1',
|
|
'service': 'http',
|
|
'user': 'frank'},
|
|
{'port': '3128',
|
|
'server': '192.168.0.1',
|
|
'service': 'https',
|
|
'user': 'frank'},
|
|
{'port': '3128',
|
|
'server': '192.168.0.1',
|
|
'service': 'ftp',
|
|
'user': 'frank'},
|
|
{'bypass_domains': ['salt.com', 'test.com']}]
|
|
},
|
|
'comment': 'http proxy settings updated correctly\nhttps proxy settings updated correctly\nftp proxy '
|
|
'settings updated correctly\nProxy bypass domains updated correctly\n',
|
|
'name': '192.168.0.1',
|
|
'result': True}
|
|
|
|
set_proxy_mock = MagicMock(return_value=True)
|
|
patches = {
|
|
'proxy.get_http_proxy': MagicMock(return_value={}),
|
|
'proxy.get_https_proxy': MagicMock(return_value={}),
|
|
'proxy.get_ftp_proxy': MagicMock(return_value={}),
|
|
'proxy.get_proxy_bypass': MagicMock(return_value=[]),
|
|
'proxy.set_http_proxy': set_proxy_mock,
|
|
'proxy.set_https_proxy': set_proxy_mock,
|
|
'proxy.set_ftp_proxy': set_proxy_mock,
|
|
'proxy.set_proxy_bypass': set_proxy_mock,
|
|
}
|
|
|
|
with patch.dict(proxy.__salt__, patches):
|
|
out = proxy.managed('192.168.0.1', '3128', user='frank', password='passw0rd',
|
|
bypass_domains=['salt.com', 'test.com'])
|
|
if six.PY3:
|
|
# Sorting is different in Py3
|
|
out['changes']['new'][-1]['bypass_domains'] = sorted(out['changes']['new'][-1]['bypass_domains'])
|
|
|
|
calls = [
|
|
call('192.168.0.1', '3128', 'frank', 'passw0rd', 'Ethernet'),
|
|
call('192.168.0.1', '3128', 'frank', 'passw0rd', 'Ethernet'),
|
|
call('192.168.0.1', '3128', 'frank', 'passw0rd', 'Ethernet'),
|
|
call(['salt.com', 'test.com'], 'Ethernet')
|
|
]
|
|
|
|
set_proxy_mock.assert_has_calls(calls)
|
|
self.assertEqual(out, expected)
|
|
|
|
def test_set_proxy_macos_same(self):
|
|
'''
|
|
Test to make sure we can set the proxy settings on macOS
|
|
'''
|
|
with patch.dict(proxy.__grains__, {'os': 'Darwin'}):
|
|
expected = {'changes': {
|
|
},
|
|
'comment': 'http proxy settings already set.\nhttps proxy settings already set.\nftp proxy settings'
|
|
' already set.\nProxy bypass domains are already set correctly.\n',
|
|
'name': '192.168.0.1',
|
|
'result': True}
|
|
|
|
proxy_val = {
|
|
'enabled': True,
|
|
'server': '192.168.0.1',
|
|
'port': '3128'
|
|
}
|
|
|
|
set_proxy_mock = MagicMock()
|
|
patches = {
|
|
'proxy.get_http_proxy': MagicMock(return_value=proxy_val),
|
|
'proxy.get_https_proxy': MagicMock(return_value=proxy_val),
|
|
'proxy.get_ftp_proxy': MagicMock(return_value=proxy_val),
|
|
'proxy.get_proxy_bypass': MagicMock(return_value=['test.com', 'salt.com']),
|
|
'proxy.set_http_proxy': set_proxy_mock,
|
|
'proxy.set_https_proxy': set_proxy_mock,
|
|
'proxy.set_ftp_proxy': set_proxy_mock,
|
|
'proxy.set_proxy_bypass': set_proxy_mock,
|
|
}
|
|
|
|
with patch.dict(proxy.__salt__, patches):
|
|
out = proxy.managed('192.168.0.1', '3128', user='frank', password='passw0rd',
|
|
bypass_domains=['salt.com', 'test.com'])
|
|
|
|
assert not set_proxy_mock.called
|
|
self.assertEqual(out, expected)
|
|
|
|
def test_set_proxy_windows(self):
|
|
'''
|
|
Test to make sure we can set the proxy settings on Windows
|
|
'''
|
|
with patch.dict(proxy.__grains__, {'os': 'Windows'}):
|
|
expected = {
|
|
'changes': {},
|
|
'comment': 'Proxy settings updated correctly',
|
|
'name': '192.168.0.1',
|
|
'result': True
|
|
}
|
|
|
|
set_proxy_mock = MagicMock(return_value=True)
|
|
patches = {
|
|
'proxy.get_proxy_win': MagicMock(return_value={}),
|
|
'proxy.get_proxy_bypass': MagicMock(return_value=[]),
|
|
'proxy.set_proxy_win': set_proxy_mock,
|
|
}
|
|
|
|
with patch.dict(proxy.__salt__, patches):
|
|
out = proxy.managed('192.168.0.1', '3128', user='frank', password='passw0rd',
|
|
bypass_domains=['salt.com', 'test.com'])
|
|
|
|
set_proxy_mock.assert_called_once_with('192.168.0.1', '3128', ['http', 'https', 'ftp'],
|
|
['salt.com', 'test.com'])
|
|
self.assertEqual(out, expected)
|
|
|
|
def test_set_proxy_windows_same(self):
|
|
'''
|
|
Test to make sure we can set the proxy settings on Windows
|
|
'''
|
|
with patch.dict(proxy.__grains__, {'os': 'Windows'}):
|
|
expected = {
|
|
'changes': {},
|
|
'comment': 'Proxy settings already correct.',
|
|
'name': '192.168.0.1',
|
|
'result': True
|
|
}
|
|
|
|
proxy_val = {
|
|
'enabled': True,
|
|
'http': {
|
|
'enabled': True,
|
|
'server': '192.168.0.1',
|
|
'port': '3128'
|
|
},
|
|
'https': {
|
|
'enabled': True,
|
|
'server': '192.168.0.1',
|
|
'port': '3128'
|
|
},
|
|
'ftp': {
|
|
'enabled': True,
|
|
'server': '192.168.0.1',
|
|
'port': '3128'
|
|
}
|
|
}
|
|
|
|
set_proxy_mock = MagicMock(return_value=True)
|
|
patches = {
|
|
'proxy.get_proxy_win': MagicMock(return_value=proxy_val),
|
|
'proxy.get_proxy_bypass': MagicMock(return_value=['salt.com', 'test.com']),
|
|
'proxy.set_proxy_win': set_proxy_mock,
|
|
}
|
|
|
|
with patch.dict(proxy.__salt__, patches):
|
|
out = proxy.managed('192.168.0.1', '3128', user='frank', password='passw0rd',
|
|
bypass_domains=['salt.com', 'test.com'])
|
|
|
|
assert not set_proxy_mock.called
|
|
self.assertEqual(out, expected)
|