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.
236 lines
8.4 KiB
Python
236 lines
8.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Import python
|
|
from __future__ import absolute_import
|
|
import os
|
|
import time
|
|
import subprocess
|
|
|
|
# Import Salt Testing libs
|
|
from tests.support.case import ModuleCase
|
|
from tests.support.unit import skipIf
|
|
from tests.support.paths import TMP
|
|
|
|
# Import salt libs
|
|
import salt.utils.path
|
|
from salt.modules.virtualenv_mod import KNOWN_BINARY_NAMES
|
|
|
|
# Import 3rd-party libs
|
|
from salt.ext import six
|
|
|
|
|
|
@skipIf(six.PY3, 'supervisor does not work under python 3')
|
|
@skipIf(salt.utils.path.which_bin(KNOWN_BINARY_NAMES) is None, 'virtualenv not installed')
|
|
@skipIf(salt.utils.path.which('supervisorctl') is None, 'supervisord not installed')
|
|
class SupervisordModuleTest(ModuleCase):
|
|
'''
|
|
Validates the supervisorctl functions.
|
|
'''
|
|
def setUp(self):
|
|
super(SupervisordModuleTest, self).setUp()
|
|
|
|
self.venv_test_dir = os.path.join(TMP, 'supervisortests')
|
|
self.venv_dir = os.path.join(self.venv_test_dir, 'venv')
|
|
self.supervisor_sock = os.path.join(self.venv_dir, 'supervisor.sock')
|
|
|
|
if not os.path.exists(self.venv_dir):
|
|
os.makedirs(self.venv_test_dir)
|
|
self.run_function('virtualenv.create', [self.venv_dir])
|
|
self.run_function(
|
|
'pip.install', [], pkgs='supervisor', bin_env=self.venv_dir)
|
|
|
|
self.supervisord = os.path.join(self.venv_dir, 'bin', 'supervisord')
|
|
if not os.path.exists(self.supervisord):
|
|
self.skipTest('Failed to install supervisor in test virtualenv')
|
|
self.supervisor_conf = os.path.join(self.venv_dir, 'supervisor.conf')
|
|
|
|
def start_supervisord(self, autostart=True):
|
|
self.run_state(
|
|
'file.managed', name=self.supervisor_conf,
|
|
source='salt://supervisor.conf', template='jinja',
|
|
context={
|
|
'supervisor_sock': self.supervisor_sock,
|
|
'virtual_env': self.venv_dir,
|
|
'autostart': autostart
|
|
}
|
|
)
|
|
if not os.path.exists(self.supervisor_conf):
|
|
self.skipTest('failed to create supervisor config file')
|
|
self.supervisor_proc = subprocess.Popen(
|
|
[self.supervisord, '-c', self.supervisor_conf]
|
|
)
|
|
if self.supervisor_proc.poll() is not None:
|
|
self.skipTest('failed to start supervisord')
|
|
timeout = 10
|
|
while not os.path.exists(self.supervisor_sock):
|
|
if timeout == 0:
|
|
self.skipTest(
|
|
'supervisor socket not found - failed to start supervisord'
|
|
)
|
|
break
|
|
else:
|
|
time.sleep(1)
|
|
timeout -= 1
|
|
|
|
def tearDown(self):
|
|
if hasattr(self, 'supervisor_proc') and \
|
|
self.supervisor_proc.poll() is not None:
|
|
self.run_function(
|
|
'supervisord.custom', ['shutdown'],
|
|
conf_file=self.supervisor_conf, bin_env=self.venv_dir)
|
|
self.supervisor_proc.wait()
|
|
del self.venv_dir
|
|
del self.venv_test_dir
|
|
del self.supervisor_sock
|
|
del self.supervisord
|
|
del self.supervisor_conf
|
|
|
|
def test_start_all(self):
|
|
'''
|
|
Start all services when they are not running.
|
|
'''
|
|
self.start_supervisord(autostart=False)
|
|
ret = self.run_function(
|
|
'supervisord.start', [], conf_file=self.supervisor_conf,
|
|
bin_env=self.venv_dir)
|
|
self.assertIn('sleep_service: started', ret)
|
|
self.assertIn('sleep_service2: started', ret)
|
|
|
|
def test_start_all_already_running(self):
|
|
'''
|
|
Start all services when they are running.
|
|
'''
|
|
self.start_supervisord(autostart=True)
|
|
ret = self.run_function(
|
|
'supervisord.start', [], conf_file=self.supervisor_conf,
|
|
bin_env=self.venv_dir
|
|
)
|
|
self.assertEqual(ret, '')
|
|
|
|
def test_start_one(self):
|
|
'''
|
|
Start a specific service that is not running.
|
|
'''
|
|
self.start_supervisord(autostart=False)
|
|
ret = self.run_function(
|
|
'supervisord.start', ['sleep_service'],
|
|
conf_file=self.supervisor_conf, bin_env=self.venv_dir)
|
|
self.assertEqual(ret, 'sleep_service: started')
|
|
|
|
def test_start_one_already_running(self):
|
|
'''
|
|
Try to start a specific service that is running.
|
|
'''
|
|
self.start_supervisord(autostart=True)
|
|
ret = self.run_function(
|
|
'supervisord.start', ['sleep_service'],
|
|
conf_file=self.supervisor_conf, bin_env=self.venv_dir)
|
|
self.assertEqual(ret, 'sleep_service: ERROR (already started)')
|
|
|
|
def test_restart_all(self):
|
|
'''
|
|
Restart all services when they are running.
|
|
'''
|
|
self.start_supervisord(autostart=True)
|
|
ret = self.run_function(
|
|
'supervisord.restart', [], conf_file=self.supervisor_conf,
|
|
bin_env=self.venv_dir)
|
|
self.assertIn('sleep_service: stopped', ret)
|
|
self.assertIn('sleep_service2: stopped', ret)
|
|
self.assertIn('sleep_service: started', ret)
|
|
self.assertIn('sleep_service2: started', ret)
|
|
|
|
def test_restart_all_not_running(self):
|
|
'''
|
|
Restart all services when they are not running.
|
|
'''
|
|
self.start_supervisord(autostart=False)
|
|
ret = self.run_function(
|
|
'supervisord.restart', [], conf_file=self.supervisor_conf,
|
|
bin_env=self.venv_dir)
|
|
# These 2 services might return in different orders so test separately
|
|
self.assertIn('sleep_service: started', ret)
|
|
self.assertIn('sleep_service2: started', ret)
|
|
|
|
def test_restart_one(self):
|
|
'''
|
|
Restart a specific service that is running.
|
|
'''
|
|
self.start_supervisord(autostart=True)
|
|
ret = self.run_function(
|
|
'supervisord.restart', ['sleep_service'],
|
|
conf_file=self.supervisor_conf, bin_env=self.venv_dir)
|
|
self.assertEqual(ret, 'sleep_service: stopped\nsleep_service: started')
|
|
|
|
def test_restart_one_not_running(self):
|
|
'''
|
|
Restart a specific service that is not running.
|
|
'''
|
|
self.start_supervisord(autostart=False)
|
|
ret = self.run_function(
|
|
'supervisord.restart', ['sleep_service'],
|
|
conf_file=self.supervisor_conf, bin_env=self.venv_dir)
|
|
self.assertIn('sleep_service: ERROR (not running)', ret)
|
|
self.assertIn('sleep_service: started', ret)
|
|
|
|
def test_stop_all(self):
|
|
'''
|
|
Stop all services when they are running.
|
|
'''
|
|
self.start_supervisord(autostart=True)
|
|
ret = self.run_function(
|
|
'supervisord.stop', [], conf_file=self.supervisor_conf,
|
|
bin_env=self.venv_dir)
|
|
self.assertIn('sleep_service: stopped', ret)
|
|
self.assertIn('sleep_service2: stopped', ret)
|
|
|
|
def test_stop_all_not_running(self):
|
|
'''
|
|
Stop all services when they are not running.
|
|
'''
|
|
self.start_supervisord(autostart=False)
|
|
ret = self.run_function(
|
|
'supervisord.stop', [], conf_file=self.supervisor_conf,
|
|
bin_env=self.venv_dir)
|
|
self.assertEqual(ret, '')
|
|
|
|
def test_stop_one(self):
|
|
'''
|
|
Stop a specific service that is running.
|
|
'''
|
|
self.start_supervisord(autostart=True)
|
|
ret = self.run_function(
|
|
'supervisord.stop', ['sleep_service'],
|
|
conf_file=self.supervisor_conf, bin_env=self.venv_dir)
|
|
self.assertEqual(ret, 'sleep_service: stopped')
|
|
|
|
def test_stop_one_not_running(self):
|
|
'''
|
|
Stop a specific service that is not running.
|
|
'''
|
|
self.start_supervisord(autostart=False)
|
|
ret = self.run_function(
|
|
'supervisord.stop', ['sleep_service'],
|
|
conf_file=self.supervisor_conf, bin_env=self.venv_dir)
|
|
self.assertEqual(ret, 'sleep_service: ERROR (not running)')
|
|
|
|
def test_status_all(self):
|
|
'''
|
|
Status for all services
|
|
'''
|
|
self.start_supervisord(autostart=True)
|
|
ret = self.run_function(
|
|
'supervisord.status', [], conf_file=self.supervisor_conf,
|
|
bin_env=self.venv_dir)
|
|
self.assertEqual(list(ret.keys()), ['sleep_service', 'sleep_service2'])
|
|
|
|
def test_status_one(self):
|
|
'''
|
|
Status for a specific service.
|
|
'''
|
|
self.start_supervisord(autostart=True)
|
|
ret = self.run_function(
|
|
'supervisord.status', ['sleep_service'],
|
|
conf_file=self.supervisor_conf, bin_env=self.venv_dir)
|
|
self.assertTrue(ret)
|