322514211b
It maps the name of the config values that we use in our templates to the name of the key in the snap config. This allows us to stick a bunch of stuff in the questions namespace in the snap config, and to use dashes, with minimal changes to our templates. Drop Python 2 support, to fix tests. Change-Id: I48b86b5e557e30f81e9cc415e7fa3a9133aa9f39
442 lines
18 KiB
Python
442 lines
18 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
"""
|
|
test_snap_openstack
|
|
----------------------------------
|
|
|
|
Tests for `snap_openstack` module.
|
|
"""
|
|
|
|
import os
|
|
import sys
|
|
|
|
from mock import call
|
|
from mock import mock_open
|
|
from mock import patch
|
|
|
|
from snap_openstack import base
|
|
from snap_openstack.tests import base as test_base
|
|
from snap_openstack import utils
|
|
|
|
TEST_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)),
|
|
'data')
|
|
|
|
MOCK_SNAP_ENV = {
|
|
'snap_common': '/var/snap/keystone/common',
|
|
'snap_data': '/var/snap/keystone/x1',
|
|
'snap': '/snap/keystone/current',
|
|
}
|
|
MOCK_SNAP_CONFIG = {
|
|
'foo': 'bar',
|
|
'baz': 'qux',
|
|
'quux': None
|
|
}
|
|
|
|
|
|
class TestOpenStackSnapExecute(test_base.TestCase):
|
|
|
|
@classmethod
|
|
def mock_exists(cls, path):
|
|
'''Test helper for os.path.exists'''
|
|
paths = {
|
|
'/snap/keystone/current/etc/keystone/keystone.conf': True,
|
|
'/var/snap/keystone/common/etc/keystone/keystone.conf.d': True,
|
|
'/var/snap/keystone/common/etc/nginx/snap/nginx.conf': True,
|
|
'/var/snap/keystone/common/etc/uwsgi/snap/keystone.ini': True,
|
|
}
|
|
return paths.get(path, False)
|
|
|
|
def mock_exists_overrides(cls, path):
|
|
'''Test helper for os.path.exists'''
|
|
paths = {
|
|
'/snap/keystone/current/etc/keystone/keystone.conf': True,
|
|
'/var/snap/keystone/common/etc/keystone/keystone.conf.d': True,
|
|
'/var/snap/keystone/common/etc/keystone/keystone.conf': True,
|
|
'/var/snap/keystone/common/etc/nginx/snap/nginx.conf': True,
|
|
'/var/snap/keystone/common/etc/nginx/nginx.conf': True,
|
|
'/var/snap/keystone/common/etc/uwsgi/snap/keystone.ini': True,
|
|
'/var/snap/keystone/common/etc/uwsgi/keystone.ini': True,
|
|
}
|
|
return paths.get(path, False)
|
|
|
|
def mock_snap_utils(self, mock_utils):
|
|
'''Mock SnapUtils code'''
|
|
mock_utils_obj = mock_utils.return_value
|
|
mock_utils_obj.snap_env = MOCK_SNAP_ENV
|
|
mock_utils_obj.snap_config.return_value = MOCK_SNAP_CONFIG
|
|
return mock_utils_obj
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch.object(base, 'os')
|
|
def test_base_snap_config(self, mock_os, mock_utils,
|
|
mock_renderer):
|
|
'''Ensure wrapped binary called with full args list'''
|
|
mock_utils_obj = self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
mock_os.path.exists.side_effect = self.mock_exists
|
|
mock_os.environ = {}
|
|
mock_os.path.basename.side_effect = 'keystone.conf'
|
|
snap.launch(['snap-openstack', 'launch', 'keystone-manage'])
|
|
mock_os.execvpe.assert_called_with(
|
|
'/snap/keystone/current/bin/keystone-manage',
|
|
['/snap/keystone/current/bin/keystone-manage',
|
|
'--config-file=/snap/keystone/current/etc/keystone/keystone.conf',
|
|
'--config-dir=/var/snap/keystone/common/etc/keystone/'
|
|
'keystone.conf.d'],
|
|
{},
|
|
)
|
|
self.assertEqual(mock_utils_obj.snap_env['foo'], 'bar')
|
|
self.assertTrue(mock_utils_obj.snap_env['quux'] is None)
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch.object(base, 'os')
|
|
def test_base_snap_config_override(self, mock_os, mock_utils,
|
|
mock_renderer):
|
|
'''Ensure wrapped binary called with full args list'''
|
|
self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
mock_os.path.exists.side_effect = self.mock_exists_overrides
|
|
mock_os.environ = {}
|
|
mock_os.path.basename.side_effect = 'keystone.conf'
|
|
snap.launch(['snap-openstack', 'launch', 'keystone-manage'])
|
|
mock_os.execvpe.assert_called_with(
|
|
'/snap/keystone/current/bin/keystone-manage',
|
|
['/snap/keystone/current/bin/keystone-manage',
|
|
'--config-file=/var/snap/keystone/common/etc/keystone/'
|
|
'keystone.conf',
|
|
'--config-dir=/var/snap/keystone/common/etc/keystone/'
|
|
'keystone.conf.d'],
|
|
{},
|
|
)
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch.object(base, 'os')
|
|
def test_base_snap_config_no_logging(self, mock_os, mock_utils,
|
|
mock_renderer):
|
|
'''Ensure wrapped binary called correctly with no logfile'''
|
|
self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
mock_os.path.exists.side_effect = self.mock_exists
|
|
mock_os.environ = {}
|
|
mock_os.path.basename.side_effect = 'keystone.conf'
|
|
snap.launch(['snap-openstack',
|
|
'launch',
|
|
'keystone-manage',
|
|
'db', 'sync'])
|
|
mock_os.execvpe.assert_called_with(
|
|
'/snap/keystone/current/bin/keystone-manage',
|
|
['/snap/keystone/current/bin/keystone-manage',
|
|
'--config-file=/snap/keystone/current/etc/keystone/keystone.conf',
|
|
'--config-dir=/var/snap/keystone/common/etc/keystone/'
|
|
'keystone.conf.d',
|
|
'db', 'sync'],
|
|
{},
|
|
)
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch.object(base, 'os')
|
|
def test_base_snap_config_missing_entry_point(self, mock_os, mock_utils,
|
|
mock_renderer):
|
|
'''Ensure ValueError raised for missing entry_point'''
|
|
self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
mock_os.path.exists.side_effect = self.mock_exists
|
|
mock_os.environ = {}
|
|
self.assertRaises(ValueError,
|
|
snap.launch,
|
|
['snap-openstack',
|
|
'launch',
|
|
'keystone-api'])
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch.object(base, 'os')
|
|
def test_base_snap_config_uwsgi(self, mock_os, mock_utils,
|
|
mock_renderer):
|
|
'''Ensure wrapped binary of uwsgi called with correct arguments'''
|
|
self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
mock_os.path.exists.side_effect = self.mock_exists
|
|
mock_os.environ = {}
|
|
mock_os.path.basename.side_effect = 'keystone.conf'
|
|
builtin = '__builtin__'
|
|
if sys.version_info > (3, 0):
|
|
builtin = 'builtins'
|
|
with patch('{}.open'.format(builtin), mock_open(), create=True):
|
|
snap.launch(['snap-openstack', 'launch', 'keystone-uwsgi'])
|
|
mock_os.execvpe.assert_called_with(
|
|
'/snap/keystone/current/bin/uwsgi',
|
|
['/snap/keystone/current/bin/uwsgi', '--master',
|
|
'--die-on-term', '-H', '/snap/keystone/current/usr',
|
|
'--emperor', '/var/snap/keystone/common/etc/uwsgi/snap',
|
|
'--logto', '/var/snap/keystone/common/log/uwsgi.log'],
|
|
{},
|
|
)
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch.object(base, 'os')
|
|
def test_base_snap_config_uwsgi_override(self, mock_os, mock_utils,
|
|
mock_renderer):
|
|
'''Ensure wrapped binary of uwsgi called with correct arguments'''
|
|
self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
mock_os.path.exists.side_effect = self.mock_exists_overrides
|
|
mock_os.environ = {}
|
|
mock_os.path.basename.side_effect = 'keystone.conf'
|
|
mock_os.listdir.side_effect = (
|
|
'/var/snap/keystone/common/etc/uwsgi/config.ini'
|
|
)
|
|
builtin = '__builtin__'
|
|
if sys.version_info > (3, 0):
|
|
builtin = 'builtins'
|
|
with patch('{}.open'.format(builtin), mock_open(), create=True):
|
|
snap.launch(['snap-openstack', 'launch', 'keystone-uwsgi'])
|
|
mock_os.execvpe.assert_called_with(
|
|
'/snap/keystone/current/bin/uwsgi',
|
|
['/snap/keystone/current/bin/uwsgi', '--master',
|
|
'--die-on-term', '-H', '/snap/keystone/current/usr',
|
|
'--emperor', '/var/snap/keystone/common/etc/uwsgi',
|
|
'--logto', '/var/snap/keystone/common/log/uwsgi.log'],
|
|
{},
|
|
)
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch.object(base, 'os')
|
|
def test_base_snap_config_nginx(self, mock_os, mock_utils,
|
|
mock_renderer):
|
|
'''Ensure wrapped binary of nginx called with correct arguments'''
|
|
self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
mock_os.path.exists.side_effect = self.mock_exists
|
|
mock_os.environ = {}
|
|
snap.launch(['snap-openstack', 'launch', 'keystone-nginx'])
|
|
mock_os.execvpe.assert_called_with(
|
|
'/snap/keystone/current/usr/sbin/nginx',
|
|
['/snap/keystone/current/usr/sbin/nginx', '-g',
|
|
'daemon on; master_process on;',
|
|
'-c', '/var/snap/keystone/common/etc/nginx/snap/nginx.conf'],
|
|
{},
|
|
)
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch.object(base, 'os')
|
|
def test_base_snap_config_nginx_override(self, mock_os, mock_utils,
|
|
mock_renderer):
|
|
'''Ensure wrapped binary of nginx called with correct arguments'''
|
|
self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
mock_os.path.exists.side_effect = self.mock_exists_overrides
|
|
mock_os.environ = {}
|
|
snap.launch(['snap-openstack', 'launch', 'keystone-nginx'])
|
|
mock_os.execvpe.assert_called_with(
|
|
'/snap/keystone/current/usr/sbin/nginx',
|
|
['/snap/keystone/current/usr/sbin/nginx', '-g',
|
|
'daemon on; master_process on;',
|
|
'-c', '/var/snap/keystone/common/etc/nginx/nginx.conf'],
|
|
{},
|
|
)
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch.object(base, 'os')
|
|
def test_base_snap_config_invalid_ep_type(self, mock_os, mock_utils,
|
|
mock_renderer):
|
|
'''Ensure endpoint types are correctly validated'''
|
|
self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
mock_os.path.exists.side_effect = self.mock_exists
|
|
self.assertRaises(ValueError,
|
|
snap.launch,
|
|
['snap-openstack',
|
|
'launch',
|
|
'keystone-broken'])
|
|
|
|
|
|
class TestOpenStackSnapSetup(test_base.TestCase):
|
|
|
|
def mock_snap_utils(self, mock_utils):
|
|
'''Mock SnapUtils code'''
|
|
mock_utils_obj = mock_utils.return_value
|
|
mock_utils_obj.snap_env = MOCK_SNAP_ENV
|
|
mock_utils_obj.snap_config.return_value = MOCK_SNAP_CONFIG
|
|
mock_utils_obj.ensure_dir.return_value = None
|
|
mock_utils_obj.chmod.return_value = None
|
|
mock_utils_obj.chown.return_value = None
|
|
return mock_utils_obj
|
|
|
|
@patch.object(base, 'SnapFileRenderer')
|
|
@patch('snap_openstack.base.SnapUtils')
|
|
@patch('oslo_concurrency.lockutils.lock')
|
|
@patch.object(base, 'os')
|
|
def test_base_setup(self, mock_os, mock_lock, mock_utils, mock_renderer):
|
|
'''Ensure setup method handles snap-openstack.yaml keys/values'''
|
|
mock_utils_obj = self.mock_snap_utils(mock_utils)
|
|
snap = base.OpenStackSnap(os.path.join(TEST_DIR,
|
|
'snap-openstack.yaml'))
|
|
builtin = '__builtin__'
|
|
if sys.version_info > (3, 0):
|
|
builtin = 'builtins'
|
|
with patch('{}.open'.format(builtin), mock_open(), create=True):
|
|
snap.setup()
|
|
mock_lock.assert_called_once_with(
|
|
'setup.lock', external=True,
|
|
lock_path='/var/snap/keystone/x1/snap-openstack')
|
|
mock_utils_obj.chmod.assert_called_with(
|
|
'/var/snap/keystone/common/lib', 0o755)
|
|
mock_utils_obj.chown.assert_called_with(
|
|
'/var/snap/keystone/common/lib', 'root', 'root')
|
|
expected = [
|
|
call('/var/snap/keystone/common/etc/keystone/keystone.conf.d',
|
|
perms=488),
|
|
call('/var/snap/keystone/common/etc/nginx/sites-enabled',
|
|
perms=488),
|
|
call('/var/snap/keystone/common/etc/nginx/snap/sites-enabled',
|
|
perms=488),
|
|
call('/var/snap/keystone/common/etc/uwsgi/snap',
|
|
perms=488),
|
|
call('/var/snap/keystone/common/etc/keystone/keystone.conf.d/'
|
|
'keystone-snap.conf',
|
|
is_file=True),
|
|
call('/var/snap/keystone/common/etc/nginx/snap/sites-enabled/'
|
|
'keystone.conf',
|
|
is_file=True),
|
|
call('/var/snap/keystone/common/etc/nginx/snap/nginx.conf',
|
|
is_file=True)
|
|
]
|
|
mock_utils_obj.ensure_dir.assert_has_calls(expected, any_order=True)
|
|
self.assertEqual(mock_utils_obj.snap_env['foo'], 'bar')
|
|
self.assertTrue(mock_utils_obj.snap_env['quux'] is None)
|
|
|
|
|
|
class TestSnapUtils(test_base.TestCase):
|
|
|
|
@patch.object(utils, 'os')
|
|
def test_init(self, mock_os):
|
|
'''Ensure __init__() and _collect_snap_env() behave as expected'''
|
|
utils.SnapUtils()
|
|
expected = [
|
|
call('SNAP_NAME'),
|
|
call('SNAP_VERSION'),
|
|
call('SNAP_REVISION'),
|
|
call('SNAP_ARCH'),
|
|
call('SNAP_LIBRARY_PATH'),
|
|
call('SNAP'),
|
|
call('SNAP_DATA'),
|
|
call('SNAP_COMMON'),
|
|
call('SNAP_USER_DATA'),
|
|
call('SNAP_USER_COMMON'),
|
|
call('TMPDIR'),
|
|
]
|
|
mock_os.environ.get.assert_has_calls(expected, any_order=True)
|
|
|
|
@patch.object(utils, 'subprocess')
|
|
@patch.object(utils, 'os')
|
|
def test_snap_config(self, mock_os, mock_subprocess):
|
|
'''snap_config fetch snapctl vals from the environment.'''
|
|
faux_config = {
|
|
'foo': 'questions.foo',
|
|
'baz': 'questions.baz',
|
|
'quux': 'questions.quux',
|
|
|
|
}
|
|
faux_snap_config = {
|
|
'questions.foo': 'bar',
|
|
'questions.baz': 'qux',
|
|
'questions.quux': '',
|
|
}
|
|
|
|
def faux_check_output(commands):
|
|
'''Replacement for check output.
|
|
|
|
We expect this to be called with a list of commands,
|
|
the last of which is the key that we're looking for.
|
|
'''
|
|
return faux_snap_config[commands[-1]].encode('utf-8')
|
|
|
|
mock_subprocess.check_output = faux_check_output
|
|
|
|
keys = faux_config
|
|
|
|
snap_utils = utils.SnapUtils()
|
|
snap_config = snap_utils.snap_config(keys)
|
|
|
|
self.assertEqual(snap_config['foo'], 'bar')
|
|
self.assertEqual(snap_config['baz'], 'qux')
|
|
self.assertTrue(snap_config['quux'] is None)
|
|
|
|
@patch.object(utils, 'os')
|
|
def test_ensure_dir(self, mock_os):
|
|
'''Ensure ensure_dir behaves as expected for a directory'''
|
|
snap_utils = utils.SnapUtils()
|
|
mock_os.path.exists.return_value = False
|
|
mock_os.path.dirname.return_value = '/var/snap/keystone/common/lib'
|
|
snap_utils.ensure_dir('/var/snap/keystone/common/lib/file',
|
|
is_file=True, perms=0o755)
|
|
mock_os.path.dirname.assert_called_with('/var/snap/keystone/common/'
|
|
'lib/file')
|
|
mock_os.path.exists.assert_called_with('/var/snap/keystone/common/lib')
|
|
mock_os.makedirs.assert_called_with('/var/snap/keystone/common/lib',
|
|
0o755)
|
|
|
|
@patch.object(utils, 'os')
|
|
def test_ensure_dir_is_file(self, mock_os):
|
|
'''Ensure ensure_dir behaves as expected for a file'''
|
|
snap_utils = utils.SnapUtils()
|
|
mock_os.path.exists.return_value = False
|
|
snap_utils.ensure_dir('/var/snap/keystone/common/lib', perms=0o755)
|
|
mock_os.path.exists.assert_called_with('/var/snap/keystone/common/lib')
|
|
mock_os.makedirs.assert_called_with('/var/snap/keystone/common/lib',
|
|
0o755)
|
|
|
|
@patch.object(utils, 'pwd')
|
|
@patch.object(utils, 'grp')
|
|
@patch.object(utils, 'os')
|
|
def test_chown(self, mock_os, mock_grp, mock_pwd):
|
|
'''Ensure chown behaves as expected'''
|
|
class Ids(object):
|
|
pw_uid = 0
|
|
gr_gid = 0
|
|
snap_utils = utils.SnapUtils()
|
|
mock_pwd.getpwnam.return_value = Ids()
|
|
mock_grp.getgrnam.return_value = Ids()
|
|
snap_utils.chown('/var/snap/keystone/common/lib', 'root', 'root')
|
|
mock_pwd.getpwnam.assert_called_with('root')
|
|
mock_grp.getgrnam.assert_called_with('root')
|
|
mock_os.chown.assert_called_with('/var/snap/keystone/common/lib', 0, 0)
|
|
|
|
@patch.object(utils, 'os')
|
|
def test_chmod(self, mock_os):
|
|
'''Ensure chmod behaves as expected'''
|
|
snap_utils = utils.SnapUtils()
|
|
snap_utils.chmod('/var/snap/keystone/common/lib', 0o750)
|
|
mock_os.chmod.assert_called_with('/var/snap/keystone/common/lib',
|
|
0o750)
|