salt/tests/unit/modules/test_cmdmod.py

312 lines
12 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
'''
:codeauthor: :email:`Nicole Thomas <nicole@saltstack.com>`
'''
2014-12-02 04:50:40 +00:00
# Import python libs
from __future__ import absolute_import
2017-03-27 15:25:09 +00:00
import os
import sys
import tempfile
2014-12-02 04:50:40 +00:00
# Import Salt Libs
2017-03-27 15:25:09 +00:00
import salt.utils
import salt.modules.cmdmod as cmdmod
2014-11-26 03:00:16 +00:00
from salt.exceptions import CommandExecutionError
from salt.log import LOG_LEVELS
# Import Salt Testing Libs
2017-02-19 15:35:30 +00:00
from tests.support.mixins import LoaderModuleMockMixin
from tests.support.unit import TestCase, skipIf
from tests.support.mock import (
2014-11-30 23:22:45 +00:00
mock_open,
2017-03-27 15:25:09 +00:00
Mock,
2014-11-30 23:22:45 +00:00
MagicMock,
NO_MOCK,
NO_MOCK_REASON,
patch
)
2014-11-30 23:22:45 +00:00
DEFAULT_SHELL = 'foo/bar'
MOCK_SHELL_FILE = '# List of acceptable shells\n' \
'\n'\
'/bin/bash\n'
@skipIf(NO_MOCK, NO_MOCK_REASON)
2017-02-19 15:35:30 +00:00
class CMDMODTestCase(TestCase, LoaderModuleMockMixin):
'''
Unit tests for the salt.modules.cmdmod module
'''
def setup_loader_modules(self):
return {cmdmod: {}}
2017-02-19 15:35:30 +00:00
@classmethod
def setUpClass(cls):
cls.mock_loglevels = {'info': 'foo', 'all': 'bar', 'critical': 'bar',
'trace': 'bar', 'garbage': 'bar', 'error': 'bar',
'debug': 'bar', 'warning': 'bar', 'quiet': 'bar'}
@classmethod
def tearDownClass(cls):
del cls.mock_loglevels
2014-11-26 03:00:16 +00:00
def test_render_cmd_no_template(self):
'''
Tests return when template=None
'''
self.assertEqual(cmdmod._render_cmd('foo', 'bar', None),
('foo', 'bar'))
2014-11-26 03:00:16 +00:00
def test_render_cmd_unavailable_engine(self):
'''
Tests CommandExecutionError raised when template isn't in the
template registry
'''
self.assertRaises(CommandExecutionError,
cmdmod._render_cmd,
'boo', 'bar', 'baz')
def test_check_loglevel_bad_level(self):
'''
Tests return of providing an invalid loglevel option
'''
with patch.dict(LOG_LEVELS, self.mock_loglevels):
self.assertEqual(cmdmod._check_loglevel(level='bad_loglevel'), 'foo')
def test_check_loglevel_bad_level_not_str(self):
'''
Tests the return of providing an invalid loglevel option that is not a string
'''
with patch.dict(LOG_LEVELS, self.mock_loglevels):
self.assertEqual(cmdmod._check_loglevel(level=1000), 'foo')
def test_check_loglevel_quiet(self):
'''
Tests the return of providing a loglevel of 'quiet'
'''
with patch.dict(LOG_LEVELS, self.mock_loglevels):
self.assertEqual(cmdmod._check_loglevel(level='quiet'), None)
def test_check_loglevel_utils_quite(self):
'''
Tests the return of quiet=True
'''
with patch.dict(LOG_LEVELS, self.mock_loglevels):
self.assertEqual(cmdmod._check_loglevel(quiet=True), None)
2014-11-30 23:22:45 +00:00
def test_parse_env_not_env(self):
'''
Tests the return of an env that is not an env
'''
self.assertEqual(cmdmod._parse_env(None), {})
def test_parse_env_list(self):
'''
Tests the return of an env that is a list
'''
ret = {'foo': None, 'bar': None}
self.assertEqual(ret, cmdmod._parse_env(['foo', 'bar']))
def test_parse_env_dict(self):
'''
Test the return of an env that is not a dict
'''
self.assertEqual(cmdmod._parse_env('test'), {})
def test_run_shell_is_not_file(self):
'''
Tests error raised when shell is not available after _is_valid_shell error msg
and os.path.isfile returns False
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=False)):
with patch('os.path.isfile', MagicMock(return_value=False)):
self.assertRaises(CommandExecutionError, cmdmod._run, 'foo', 'bar')
2014-11-30 23:22:45 +00:00
def test_run_shell_file_no_access(self):
'''
Tests error raised when shell is not available after _is_valid_shell error msg,
os.path.isfile returns True, but os.access returns False
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=False)):
with patch('os.path.isfile', MagicMock(return_value=True)):
with patch('os.access', MagicMock(return_value=False)):
self.assertRaises(CommandExecutionError, cmdmod._run, 'foo', 'bar')
2014-11-30 23:22:45 +00:00
def test_run_runas_with_windows(self):
'''
Tests error raised when runas is passed on windows
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=True)):
with patch.dict(cmdmod.__grains__, {'os': 'fake_os'}):
self.assertRaises(CommandExecutionError,
cmdmod._run,
'foo', 'bar', runas='baz')
2014-11-30 23:22:45 +00:00
def test_run_user_not_available(self):
'''
Tests return when runas user is not available
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('os.path.isfile', MagicMock(return_value=True)):
with patch('os.access', MagicMock(return_value=True)):
self.assertRaises(CommandExecutionError, cmdmod._run, 'foo', 'bar', runas='baz')
2014-11-30 23:22:45 +00:00
def test_run_zero_umask(self):
'''
Tests error raised when umask is set to zero
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=False)):
with patch('os.path.isfile', MagicMock(return_value=True)):
with patch('os.access', MagicMock(return_value=True)):
self.assertRaises(CommandExecutionError, cmdmod._run, 'foo', 'bar', umask=0)
2014-11-30 23:22:45 +00:00
def test_run_invalid_umask(self):
'''
Tests error raised when an invalid umask is given
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=False)):
with patch('os.path.isfile', MagicMock(return_value=True)):
with patch('os.access', MagicMock(return_value=True)):
self.assertRaises(CommandExecutionError, cmdmod._run, 'foo', 'bar', umask='baz')
2014-11-30 23:22:45 +00:00
2014-12-01 02:14:21 +00:00
def test_run_invalid_cwd_not_abs_path(self):
'''
Tests error raised when cwd is not an absolute path
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=False)):
with patch('os.path.isfile', MagicMock(return_value=True)):
with patch('os.access', MagicMock(return_value=True)):
self.assertRaises(CommandExecutionError, cmdmod._run, 'foo', 'bar')
2014-12-01 02:14:21 +00:00
def test_run_invalid_cwd_not_dir(self):
'''
Tests error raised when cwd is not a dir
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=False)):
with patch('os.path.isfile', MagicMock(return_value=True)):
with patch('os.access', MagicMock(return_value=True)):
with patch('os.path.isabs', MagicMock(return_value=True)):
self.assertRaises(CommandExecutionError, cmdmod._run, 'foo', 'bar')
2014-12-01 02:14:21 +00:00
def test_run_no_vt_os_error(self):
'''
Tests error raised when not useing vt and OSError is provided
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=False)):
with patch('os.path.isfile', MagicMock(return_value=True)):
with patch('os.access', MagicMock(return_value=True)):
with patch('salt.utils.timed_subprocess.TimedProc', MagicMock(side_effect=OSError)):
self.assertRaises(CommandExecutionError, cmdmod._run, 'foo')
2014-12-01 02:14:21 +00:00
def test_run_no_vt_io_error(self):
'''
Tests error raised when not useing vt and IOError is provided
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=False)):
with patch('os.path.isfile', MagicMock(return_value=True)):
with patch('os.access', MagicMock(return_value=True)):
with patch('salt.utils.timed_subprocess.TimedProc', MagicMock(side_effect=IOError)):
self.assertRaises(CommandExecutionError, cmdmod._run, 'foo')
2014-12-01 02:14:21 +00:00
@skipIf(salt.utils.is_windows(), 'Do not run on Windows')
2014-12-01 02:14:21 +00:00
def test_run(self):
'''
Tests end result when a command is not found
'''
2017-04-10 13:00:57 +00:00
with patch('salt.modules.cmdmod._is_valid_shell', MagicMock(return_value=True)):
with patch('salt.utils.is_windows', MagicMock(return_value=False)):
with patch('os.path.isfile', MagicMock(return_value=True)):
with patch('os.access', MagicMock(return_value=True)):
ret = cmdmod._run('foo', use_vt=True).get('stderr')
self.assertIn('foo', ret)
2014-12-01 02:14:21 +00:00
2014-11-30 23:22:45 +00:00
def test_is_valid_shell_windows(self):
'''
Tests return if running on windows
'''
2017-04-10 13:00:57 +00:00
with patch('salt.utils.is_windows', MagicMock(return_value=True)):
self.assertTrue(cmdmod._is_valid_shell('foo'))
2014-11-30 23:22:45 +00:00
@skipIf(salt.utils.is_windows(), 'Do not run on Windows')
2014-11-30 23:22:45 +00:00
def test_is_valid_shell_none(self):
'''
Tests return of when os.path.exists(/etc/shells) isn't available
'''
2017-04-10 13:00:57 +00:00
with patch('os.path.exists', MagicMock(return_value=False)):
self.assertIsNone(cmdmod._is_valid_shell('foo'))
2014-11-30 23:22:45 +00:00
def test_is_valid_shell_available(self):
'''
Tests return when provided shell is available
'''
2017-04-10 13:00:57 +00:00
with patch('os.path.exists', MagicMock(return_value=True)):
with patch('salt.utils.fopen', mock_open(read_data=MOCK_SHELL_FILE)):
self.assertTrue(cmdmod._is_valid_shell('/bin/bash'))
2014-11-30 23:22:45 +00:00
@skipIf(salt.utils.is_windows(), 'Do not run on Windows')
2014-11-30 23:22:45 +00:00
def test_is_valid_shell_unavailable(self):
'''
Tests return when provided shell is not available
'''
2017-04-10 13:00:57 +00:00
with patch('os.path.exists', MagicMock(return_value=True)):
with patch('salt.utils.fopen', mock_open(read_data=MOCK_SHELL_FILE)):
self.assertFalse(cmdmod._is_valid_shell('foo'))
2017-03-27 15:25:09 +00:00
2017-04-10 13:00:57 +00:00
def test_os_environment_remains_intact(self):
2017-03-27 15:25:09 +00:00
'''
Make sure the OS environment is not tainted after running a command
that specifies runas.
'''
2017-04-10 13:00:57 +00:00
with patch('pwd.getpwnam') as getpwnam_mock:
with patch('subprocess.Popen') as popen_mock:
environment = os.environ.copy()
2017-03-27 15:25:09 +00:00
2017-04-10 13:00:57 +00:00
popen_mock.return_value = Mock(
communicate=lambda *args, **kwags: ['{}', None],
pid=lambda: 1,
retcode=0
)
2017-03-27 15:25:09 +00:00
2017-04-10 13:00:57 +00:00
with patch.dict(cmdmod.__grains__, {'os': 'Darwin', 'os_family': 'Solaris'}):
if sys.platform.startswith(('freebsd', 'openbsd')):
shell = '/bin/sh'
else:
shell = '/bin/bash'
2017-03-27 15:25:09 +00:00
2017-04-10 13:00:57 +00:00
cmdmod._run('ls',
cwd=tempfile.gettempdir(),
runas='foobar',
shell=shell)
2017-03-27 15:25:09 +00:00
2017-04-10 13:00:57 +00:00
environment2 = os.environ.copy()
2017-03-27 15:25:09 +00:00
2017-04-10 13:00:57 +00:00
self.assertEqual(environment, environment2)
2017-03-27 15:25:09 +00:00
2017-04-10 13:00:57 +00:00
getpwnam_mock.assert_called_with('foobar')
2017-03-27 15:25:09 +00:00
def test_run_cwd_doesnt_exist_issue_7154(self):
'''
cmd.run should fail and raise
salt.exceptions.CommandExecutionError if the cwd dir does not
exist
'''
cmd = 'echo OHAI'
cwd = '/path/to/nowhere'
try:
cmdmod.run_all(cmd, cwd=cwd)
except CommandExecutionError:
pass
else:
raise RuntimeError