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.
198 lines
8.6 KiB
Python
198 lines
8.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
'''
|
|
:codeauthor: :email:`Jayesh Kariya <jayeshk@saltstack.com>`
|
|
'''
|
|
# Import Python libs
|
|
from __future__ import absolute_import
|
|
import tempfile
|
|
import shutil
|
|
|
|
# Import Salt Testing Libs
|
|
from tests.support.mixins import LoaderModuleMockMixin
|
|
from tests.support.paths import TMP
|
|
from tests.support.unit import skipIf, TestCase
|
|
from tests.support.mock import (
|
|
NO_MOCK,
|
|
NO_MOCK_REASON,
|
|
MagicMock,
|
|
mock_open,
|
|
patch)
|
|
|
|
# Import Salt Libs
|
|
import salt.states.virt as virt
|
|
import salt.utils.files
|
|
|
|
|
|
@skipIf(NO_MOCK, NO_MOCK_REASON)
|
|
class LibvirtTestCase(TestCase, LoaderModuleMockMixin):
|
|
'''
|
|
Test cases for salt.states.libvirt
|
|
'''
|
|
def setup_loader_modules(self):
|
|
return {virt: {}}
|
|
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
cls.pki_dir = tempfile.mkdtemp(dir=TMP)
|
|
|
|
@classmethod
|
|
def tearDownClass(cls):
|
|
shutil.rmtree(cls.pki_dir)
|
|
del cls.pki_dir
|
|
|
|
# 'keys' function tests: 1
|
|
|
|
def test_keys(self):
|
|
'''
|
|
Test to manage libvirt keys.
|
|
'''
|
|
with patch('os.path.isfile', MagicMock(return_value=False)):
|
|
name = 'sunrise'
|
|
|
|
ret = {'name': name,
|
|
'result': True,
|
|
'comment': '',
|
|
'changes': {}}
|
|
|
|
mock = MagicMock(side_effect=[[], ['libvirt.servercert.pem'],
|
|
{'libvirt.servercert.pem': 'A'}])
|
|
with patch.dict(virt.__salt__, {'pillar.ext': mock}):
|
|
comt = ('All keys are correct')
|
|
ret.update({'comment': comt})
|
|
self.assertDictEqual(virt.keys(name, basepath=self.pki_dir), ret)
|
|
|
|
with patch.dict(virt.__opts__, {'test': True}):
|
|
comt = ('Libvirt keys are set to be updated')
|
|
ret.update({'comment': comt, 'result': None})
|
|
self.assertDictEqual(virt.keys(name, basepath=self.pki_dir), ret)
|
|
|
|
with patch.dict(virt.__opts__, {'test': False}):
|
|
with patch.object(salt.utils.files, 'fopen', MagicMock(mock_open())):
|
|
comt = ('Updated libvirt certs and keys')
|
|
ret.update({'comment': comt, 'result': True,
|
|
'changes': {'servercert': 'new'}})
|
|
self.assertDictEqual(virt.keys(name, basepath=self.pki_dir), ret)
|
|
|
|
def test_keys_with_expiration_days(self):
|
|
'''
|
|
Test to manage libvirt keys.
|
|
'''
|
|
with patch('os.path.isfile', MagicMock(return_value=False)):
|
|
name = 'sunrise'
|
|
|
|
ret = {'name': name,
|
|
'result': True,
|
|
'comment': '',
|
|
'changes': {}}
|
|
|
|
mock = MagicMock(side_effect=[[], ['libvirt.servercert.pem'],
|
|
{'libvirt.servercert.pem': 'A'}])
|
|
with patch.dict(virt.__salt__, {'pillar.ext': mock}):
|
|
comt = ('All keys are correct')
|
|
ret.update({'comment': comt})
|
|
self.assertDictEqual(virt.keys(name,
|
|
basepath=self.pki_dir,
|
|
expiration_days=700), ret)
|
|
|
|
with patch.dict(virt.__opts__, {'test': True}):
|
|
comt = ('Libvirt keys are set to be updated')
|
|
ret.update({'comment': comt, 'result': None})
|
|
self.assertDictEqual(virt.keys(name,
|
|
basepath=self.pki_dir,
|
|
expiration_days=700), ret)
|
|
|
|
with patch.dict(virt.__opts__, {'test': False}):
|
|
with patch.object(salt.utils.files, 'fopen', MagicMock(mock_open())):
|
|
comt = ('Updated libvirt certs and keys')
|
|
ret.update({'comment': comt, 'result': True,
|
|
'changes': {'servercert': 'new'}})
|
|
self.assertDictEqual(virt.keys(name,
|
|
basepath=self.pki_dir,
|
|
expiration_days=700), ret)
|
|
|
|
def test_keys_with_state(self):
|
|
'''
|
|
Test to manage libvirt keys.
|
|
'''
|
|
with patch('os.path.isfile', MagicMock(return_value=False)):
|
|
name = 'sunrise'
|
|
|
|
ret = {'name': name,
|
|
'result': True,
|
|
'comment': '',
|
|
'changes': {}}
|
|
|
|
mock = MagicMock(side_effect=[[], ['libvirt.servercert.pem'],
|
|
{'libvirt.servercert.pem': 'A'}])
|
|
with patch.dict(virt.__salt__, {'pillar.ext': mock}):
|
|
comt = ('All keys are correct')
|
|
ret.update({'comment': comt})
|
|
self.assertDictEqual(virt.keys(name,
|
|
basepath=self.pki_dir,
|
|
st='California'), ret)
|
|
|
|
with patch.dict(virt.__opts__, {'test': True}):
|
|
comt = ('Libvirt keys are set to be updated')
|
|
ret.update({'comment': comt, 'result': None})
|
|
self.assertDictEqual(virt.keys(name,
|
|
basepath=self.pki_dir,
|
|
st='California'), ret)
|
|
|
|
with patch.dict(virt.__opts__, {'test': False}):
|
|
with patch.object(salt.utils.files, 'fopen', MagicMock(mock_open())):
|
|
comt = ('Updated libvirt certs and keys')
|
|
ret.update({'comment': comt, 'result': True,
|
|
'changes': {'servercert': 'new'}})
|
|
self.assertDictEqual(virt.keys(name,
|
|
basepath=self.pki_dir,
|
|
st='California'), ret)
|
|
|
|
def test_keys_with_all_options(self):
|
|
'''
|
|
Test to manage libvirt keys.
|
|
'''
|
|
with patch('os.path.isfile', MagicMock(return_value=False)):
|
|
name = 'sunrise'
|
|
|
|
ret = {'name': name,
|
|
'result': True,
|
|
'comment': '',
|
|
'changes': {}}
|
|
|
|
mock = MagicMock(side_effect=[[], ['libvirt.servercert.pem'],
|
|
{'libvirt.servercert.pem': 'A'}])
|
|
with patch.dict(virt.__salt__, {'pillar.ext': mock}):
|
|
comt = ('All keys are correct')
|
|
ret.update({'comment': comt})
|
|
self.assertDictEqual(virt.keys(name,
|
|
basepath=self.pki_dir,
|
|
country='USA',
|
|
st='California',
|
|
locality='Los_Angeles',
|
|
organization='SaltStack',
|
|
expiration_days=700), ret)
|
|
|
|
with patch.dict(virt.__opts__, {'test': True}):
|
|
comt = ('Libvirt keys are set to be updated')
|
|
ret.update({'comment': comt, 'result': None})
|
|
self.assertDictEqual(virt.keys(name,
|
|
basepath=self.pki_dir,
|
|
country='USA',
|
|
st='California',
|
|
locality='Los_Angeles',
|
|
organization='SaltStack',
|
|
expiration_days=700), ret)
|
|
|
|
with patch.dict(virt.__opts__, {'test': False}):
|
|
with patch.object(salt.utils.files, 'fopen', MagicMock(mock_open())):
|
|
comt = ('Updated libvirt certs and keys')
|
|
ret.update({'comment': comt, 'result': True,
|
|
'changes': {'servercert': 'new'}})
|
|
self.assertDictEqual(virt.keys(name,
|
|
basepath=self.pki_dir,
|
|
country='USA',
|
|
st='California',
|
|
locality='Los_Angeles',
|
|
organization='SaltStack',
|
|
expiration_days=700), ret)
|