salt/tests/unit/states/test_blockdev.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

110 lines
4.3 KiB
Python

# -*- coding: utf-8 -*-
'''
:codeauthor: :email:`Jayesh Kariya <jayeshk@saltstack.com>`
'''
# Import Python libs
from __future__ import absolute_import
import os
# 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)
# Import Salt Libs
import salt.states.blockdev as blockdev
import salt.utils.path
@skipIf(NO_MOCK, NO_MOCK_REASON)
class BlockdevTestCase(TestCase, LoaderModuleMockMixin):
'''
Test cases for salt.states.blockdev
'''
def setup_loader_modules(self):
return {blockdev: {}}
# 'tuned' function tests: 1
def test_tuned(self):
'''
Test to manage options of block device
'''
name = '/dev/vg/master-data'
ret = {'name': name,
'result': True,
'changes': {},
'comment': ''}
comt = ('Changes to {0} cannot be applied. '
'Not a block device. ').format(name)
with patch.dict(blockdev.__salt__, {'file.is_blkdev': False}):
ret.update({'comment': comt})
self.assertDictEqual(blockdev.tuned(name), ret)
comt = ('Changes to {0} will be applied '.format(name))
with patch.dict(blockdev.__salt__, {'file.is_blkdev': True}):
ret.update({'comment': comt, 'result': None})
with patch.dict(blockdev.__opts__, {'test': True}):
self.assertDictEqual(blockdev.tuned(name), ret)
# 'formatted' function tests: 1
def test_formatted(self):
'''
Test to manage filesystems of partitions.
'''
name = '/dev/vg/master-data'
ret = {'name': name,
'result': False,
'changes': {},
'comment': ''}
with patch.object(os.path, 'exists', MagicMock(side_effect=[False, True,
True, True,
True])):
comt = ('{0} does not exist'.format(name))
ret.update({'comment': comt})
self.assertDictEqual(blockdev.formatted(name), ret)
mock_ext4 = MagicMock(return_value='ext4')
# Test state return when block device is already in the correct state
with patch.dict(blockdev.__salt__, {'cmd.run': mock_ext4}):
comt = '{0} already formatted with ext4'.format(name)
ret.update({'comment': comt, 'result': True})
self.assertDictEqual(blockdev.formatted(name), ret)
# Test state return when provided block device is an invalid fs_type
with patch.dict(blockdev.__salt__, {'cmd.run': MagicMock(return_value='')}):
ret.update({'comment': 'Invalid fs_type: foo-bar',
'result': False})
with patch.object(salt.utils.path, 'which',
MagicMock(return_value=False)):
self.assertDictEqual(blockdev.formatted(name, fs_type='foo-bar'), ret)
# Test state return when provided block device state will change and test=True
with patch.dict(blockdev.__salt__, {'cmd.run': MagicMock(return_value='new-thing')}):
comt = ('Changes to {0} will be applied '.format(name))
ret.update({'comment': comt, 'result': None})
with patch.object(salt.utils.path, 'which',
MagicMock(return_value=True)):
with patch.dict(blockdev.__opts__, {'test': True}):
self.assertDictEqual(blockdev.formatted(name), ret)
# Test state return when block device format fails
with patch.dict(blockdev.__salt__, {'cmd.run': MagicMock(return_value=mock_ext4),
'disk.format_': MagicMock(return_value=True)}):
comt = ('Failed to format {0}'.format(name))
ret.update({'comment': comt, 'result': False})
with patch.object(salt.utils.path, 'which',
MagicMock(return_value=True)):
with patch.dict(blockdev.__opts__, {'test': False}):
self.assertDictEqual(blockdev.formatted(name), ret)