527 lines
20 KiB
Python
527 lines
20 KiB
Python
# Copyright 2019 Canonical Ltd
|
|
#
|
|
# 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.
|
|
|
|
import copy
|
|
import collections
|
|
import json
|
|
import mock
|
|
|
|
import charms_openstack.test_utils as test_utils
|
|
|
|
import charm.openstack.mysql_router as mysql_router
|
|
|
|
|
|
class TestMySQLRouterProperties(test_utils.PatchHelper):
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.cls = mock.MagicMock()
|
|
self.patch_object(mysql_router.ch_core.hookenv, "local_unit")
|
|
self.patch_object(mysql_router.ch_net_ip, "get_relation_ip")
|
|
|
|
def test_shared_db_address(self):
|
|
_addr = "127.0.0.1"
|
|
self.assertEqual(
|
|
mysql_router.shared_db_address(self.cls), _addr)
|
|
|
|
def test_db_router_address(self):
|
|
_addr = "10.10.10.30"
|
|
self.get_relation_ip.return_value = _addr
|
|
self.assertEqual(
|
|
mysql_router.db_router_address(self.cls), _addr)
|
|
self.get_relation_ip.assert_called_once_with("db-router")
|
|
|
|
|
|
class FakeException(Exception):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
pass
|
|
|
|
@property
|
|
def output(self):
|
|
return "Mocked Exception".encode("UTF-8")
|
|
|
|
@property
|
|
def code(self):
|
|
return 1
|
|
|
|
|
|
class TestMySQLRouterCharm(test_utils.PatchHelper):
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.patch_object(mysql_router, "os")
|
|
self.patch_object(mysql_router, "subprocess")
|
|
self.patch_object(mysql_router.reactive.flags, "set_flag")
|
|
self.patch_object(mysql_router.reactive.flags, "clear_flag")
|
|
self.patch_object(
|
|
mysql_router.reactive.relations, "endpoint_from_flag")
|
|
self.patch_object(mysql_router.ch_net_ip, "get_relation_ip")
|
|
self.patch_object(mysql_router.ch_core.hookenv, "local_unit")
|
|
self.patch_object(mysql_router.ch_core.host, "adduser")
|
|
self.patch_object(mysql_router.ch_core.host, "add_group")
|
|
self.patch_object(mysql_router.ch_core.host, "user_exists")
|
|
self.patch_object(mysql_router.ch_core.host, "group_exists")
|
|
self.patch_object(mysql_router.ch_core.host, "mkdir")
|
|
|
|
self.stdout = mock.MagicMock()
|
|
self.subprocess.STDOUT = self.stdout
|
|
self.subprocess.PIPE = self.stdout
|
|
|
|
self.patch_object(
|
|
mysql_router.mysql, "get_db_data")
|
|
self.get_db_data.side_effect = self._fake_get_db_data
|
|
|
|
self.db_router = mock.MagicMock()
|
|
self.shared_db = mock.MagicMock()
|
|
|
|
self.mock_unprefixed = "UNPREFIXED"
|
|
self.keystone_shared_db = mock.MagicMock()
|
|
self.keystone_shared_db.relation_id = "shared-db:5"
|
|
self.nova_shared_db = mock.MagicMock()
|
|
self.nova_shared_db.relation_id = "shared-db:20"
|
|
# Keystone shared-db
|
|
self.keystone_unit_name = "keystone/7"
|
|
self.keystone_unit_ip = "10.10.10.70"
|
|
self.keystone_unit = mock.MagicMock()
|
|
self.keystone_unit.unit_name = self.keystone_unit_name
|
|
self.keystone_unit.relation = self.keystone_shared_db
|
|
self.keystone_shared_db.joined_units = [self.keystone_unit]
|
|
self.keystone_shared_db.all_joined_units.received = {
|
|
"database": "keystone", "username": "keystone",
|
|
"hostname": self.keystone_unit_ip}
|
|
self.keystone_shared_db.all_joined_units.__getitem__.return_value = (
|
|
self.keystone_unit)
|
|
self.keystone_shared_db.relations = {
|
|
self.keystone_shared_db.relation_id: self.keystone_shared_db}
|
|
# Nova shared-db
|
|
self.nova_unit_name = "nova/12"
|
|
self.nova_unit_ip = "10.20.20.70"
|
|
self.nova_unit = mock.MagicMock()
|
|
self.nova_unit.unit_name = self.nova_unit_name
|
|
self.nova_unit.relation = self.nova_shared_db
|
|
self.nova_shared_db.joined_units = [self.nova_unit]
|
|
self.nova_shared_db.all_joined_units.received = {
|
|
"nova_database": "nova", "nova_username": "nova",
|
|
"nova_hostname": self.nova_unit_ip,
|
|
"novaapi_database": "nova_api", "novaapi_username": "nova",
|
|
"novaapi_hostname": self.nova_unit_ip,
|
|
"novacell0_database": "nova_cell0", "novacell0_username": "nova",
|
|
"novacell0_hostname": self.nova_unit_ip}
|
|
self.nova_shared_db.all_joined_units.__getitem__.return_value = (
|
|
self.nova_unit)
|
|
self.nova_shared_db.relations = {
|
|
self.nova_shared_db.relation_id: self.nova_shared_db}
|
|
|
|
def _fake_get_allowed_units(self, interface):
|
|
return " ".join(
|
|
[x.unit_name for x in
|
|
interface.joined_units])
|
|
|
|
def _fake_get_db_data(self, relation_data, unprefixed=None):
|
|
# This "fake" get_db_data looks a lot like the real thing.
|
|
# Charmhelpers is mocked out entirely and attempting to
|
|
# mock the output made the test setup more difficult.
|
|
settings = copy.deepcopy(relation_data)
|
|
databases = collections.OrderedDict()
|
|
|
|
singleset = {"database", "username", "hostname"}
|
|
if singleset.issubset(settings):
|
|
settings["{}_{}".format(unprefixed, "hostname")] = (
|
|
settings["hostname"])
|
|
settings.pop("hostname")
|
|
settings["{}_{}".format(unprefixed, "database")] = (
|
|
settings["database"])
|
|
settings.pop("database")
|
|
settings["{}_{}".format(unprefixed, "username")] = (
|
|
settings["username"])
|
|
settings.pop("username")
|
|
|
|
for k, v in settings.items():
|
|
db = k.split("_")[0]
|
|
x = "_".join(k.split("_")[1:])
|
|
if db not in databases:
|
|
databases[db] = collections.OrderedDict()
|
|
databases[db][x] = v
|
|
|
|
return databases
|
|
|
|
def test_mysqlrouter_bin(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.mysqlrouter_bin,
|
|
"/usr/bin/mysqlrouter")
|
|
|
|
def test_db_router_endpoint(self):
|
|
self.endpoint_from_flag.return_value = self.db_router
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.db_router_endpoint,
|
|
self.db_router)
|
|
|
|
def test_db_prefix(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.db_prefix,
|
|
"mysqlrouter")
|
|
|
|
def test_db_router_user(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.db_router_user,
|
|
"mysqlrouteruser")
|
|
|
|
def test_db_router_password(self):
|
|
_json_pass = '"clusterpass"'
|
|
_pass = "clusterpass"
|
|
self.endpoint_from_flag.return_value = self.db_router
|
|
self.db_router.password.return_value = _json_pass
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.db_router_password,
|
|
_pass)
|
|
|
|
def test_db_router_address(self):
|
|
_addr = "10.10.10.30"
|
|
self.get_relation_ip.return_value = _addr
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.db_router_address,
|
|
_addr)
|
|
|
|
def test_cluster_address(self):
|
|
_json_addr = '"10.10.10.50"'
|
|
_addr = "10.10.10.50"
|
|
self.endpoint_from_flag.return_value = self.db_router
|
|
self.db_router.db_host.return_value = _json_addr
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.cluster_address,
|
|
_addr)
|
|
|
|
def test_shared_db_address(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.shared_db_address,
|
|
"127.0.0.1")
|
|
|
|
def test_mysqlrouter_working_dir(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.mysqlrouter_working_dir,
|
|
"/var/lib/mysql/mysqlrouter")
|
|
|
|
def test_mysqlrouter_home_dir(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.mysqlrouter_home_dir,
|
|
"/var/lib/mysql")
|
|
|
|
def test_mysqlrouter_group(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.mysqlrouter_group,
|
|
"mysql")
|
|
|
|
def test_mysqlrouter_user(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.assertEqual(
|
|
mrc.mysqlrouter_user,
|
|
"mysql")
|
|
|
|
def test_install(self):
|
|
self.patch_object(
|
|
mysql_router.charms_openstack.charm.OpenStackCharm,
|
|
"install", "super_install")
|
|
self.patch_object(mysql_router.shutil, "copy")
|
|
self.os.path.exists.return_value = False
|
|
self.group_exists.return_value = False
|
|
self.user_exists.return_value = False
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
mrc.configure_source = mock.MagicMock()
|
|
mrc.install()
|
|
self.super_install.assert_called_once()
|
|
mrc.configure_source.assert_called_once()
|
|
self.add_group.assert_called_once_with("mysql", system_group=True)
|
|
self.adduser.assert_called_once_with(
|
|
"mysql", home_dir="/var/lib/mysql", primary_group="mysql",
|
|
shell="/usr/sbin/nologin", system_user=True)
|
|
self.mkdir.assert_called_once_with(
|
|
"/var/lib/mysql", group="mysql", owner="mysql", perms=0o755)
|
|
|
|
self.copy.assert_called_once()
|
|
self.subprocess.check_output.assert_called_once_with(
|
|
['/usr/bin/systemctl', 'enable', 'mysqlrouter'],
|
|
stderr=self.subprocess.STDOUT)
|
|
|
|
def test_get_db_helper(self):
|
|
self.patch_object(
|
|
mysql_router.mysql, "MySQL8Helper")
|
|
_helper = mock.MagicMock()
|
|
_json_addr = '"10.10.10.70"'
|
|
_json_pass = '"clusterpass"'
|
|
self.endpoint_from_flag.return_value = self.db_router
|
|
self.db_router.db_host.return_value = _json_addr
|
|
self.db_router.password.return_value = _json_pass
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.MySQL8Helper.return_value = _helper
|
|
self.assertEqual(_helper, mrc.get_db_helper())
|
|
self.MySQL8Helper.assert_called_once()
|
|
|
|
def test_states_to_check(self):
|
|
self.patch_object(
|
|
mysql_router.charms_openstack.charm.OpenStackCharm,
|
|
"states_to_check", "super_states")
|
|
self.super_states.return_value = {}
|
|
_required_rels = ["shared-db", "db-router"]
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
_results = mrc.states_to_check(_required_rels)
|
|
_states_to_check = [x[0] for x in _results["charm"]]
|
|
self.super_states.assert_called_once_with(_required_rels)
|
|
self.assertTrue(
|
|
mysql_router.MYSQL_ROUTER_BOOTSTRAPPED in _states_to_check)
|
|
self.assertTrue(
|
|
mysql_router.MYSQL_ROUTER_STARTED in _states_to_check)
|
|
self.assertTrue(
|
|
mysql_router.DB_ROUTER_PROXY_AVAILABLE in _states_to_check)
|
|
|
|
def test_check_mysql_connection(self):
|
|
self.patch_object(
|
|
mysql_router.mysql, "MySQL8Helper")
|
|
_helper = mock.MagicMock()
|
|
_json_pass = '"clusterpass"'
|
|
_pass = "clusterpass"
|
|
_user = "mysqlrouteruser"
|
|
_addr = "127.0.0.1"
|
|
self.endpoint_from_flag.return_value = self.db_router
|
|
self.db_router.password.return_value = _json_pass
|
|
|
|
self.patch_object(
|
|
mysql_router.mysql.MySQLdb, "_exceptions")
|
|
self._exceptions.OperationalError = Exception
|
|
_helper = mock.MagicMock()
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
mrc.get_db_helper = mock.MagicMock()
|
|
mrc.get_db_helper.return_value = _helper
|
|
|
|
# Connects
|
|
self.assertTrue(mrc.check_mysql_connection())
|
|
_helper.connect.assert_called_once_with(
|
|
_user, _pass, _addr)
|
|
|
|
# Fails
|
|
_helper.reset_mock()
|
|
_helper.connect.side_effect = self._exceptions.OperationalError
|
|
self.assertFalse(mrc.check_mysql_connection())
|
|
_helper.connect.assert_called_once_with(
|
|
_user, _pass, _addr)
|
|
|
|
def test_custom_assess_status_check(self):
|
|
_check = mock.MagicMock()
|
|
_check.return_value = None, None
|
|
_conn_check = mock.MagicMock()
|
|
_conn_check.return_value = True
|
|
|
|
# All is well
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
mrc.check_if_paused = _check
|
|
mrc.check_interfaces = _check
|
|
mrc.check_mandatory_config = _check
|
|
mrc.check_mysql_connection = _conn_check
|
|
|
|
self.assertEqual((None, None), mrc.custom_assess_status_check())
|
|
self.assertEqual(3, len(_check.mock_calls))
|
|
_conn_check.assert_called_once_with()
|
|
|
|
# First checks fail
|
|
_check.return_value = "blocked", "for some reason"
|
|
self.assertEqual(
|
|
("blocked", "for some reason"),
|
|
mrc.custom_assess_status_check())
|
|
|
|
# MySQL connect fails
|
|
_check.return_value = None, None
|
|
_conn_check.return_value = False
|
|
self.assertEqual(
|
|
("blocked", "Failed to connect to MySQL"),
|
|
mrc.custom_assess_status_check())
|
|
|
|
def test_bootstrap_mysqlrouter(self):
|
|
_json_addr = '"10.10.10.60"'
|
|
_json_pass = '"clusterpass"'
|
|
_pass = json.loads(_json_pass)
|
|
_addr = json.loads(_json_addr)
|
|
_user = "mysql"
|
|
_port = "3006"
|
|
self.endpoint_from_flag.return_value = self.db_router
|
|
self.db_router.password.return_value = _json_pass
|
|
self.db_router.db_host.return_value = _json_addr
|
|
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
mrc.options.system_user = _user
|
|
mrc.options.base_port = _port
|
|
|
|
# Successful
|
|
mrc.bootstrap_mysqlrouter()
|
|
self.subprocess.check_output.assert_called_once_with(
|
|
[mrc.mysqlrouter_bin, "--user", _user, "--bootstrap",
|
|
"{}:{}@{}".format(mrc.db_router_user, _pass, _addr),
|
|
"--directory", mrc.mysqlrouter_working_dir, "--conf-use-sockets",
|
|
"--conf-base-port", _port],
|
|
stderr=self.stdout)
|
|
self.set_flag.assert_called_once_with(
|
|
mysql_router.MYSQL_ROUTER_BOOTSTRAPPED)
|
|
|
|
# Fail
|
|
self.subprocess.reset_mock()
|
|
self.set_flag.reset_mock()
|
|
self.subprocess.CalledProcessError = FakeException
|
|
self.subprocess.check_output.side_effect = (
|
|
self.subprocess.CalledProcessError)
|
|
mrc.bootstrap_mysqlrouter()
|
|
self.set_flag.assert_not_called()
|
|
|
|
def test_start_mysqlrouter(self):
|
|
self.patch_object(mysql_router.ch_core.host, "service_start")
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
|
|
mrc.start_mysqlrouter()
|
|
self.service_start.assert_called_once_with("mysqlrouter")
|
|
self.set_flag.assert_called_once_with(
|
|
mysql_router.MYSQL_ROUTER_STARTED)
|
|
|
|
def test_stop_mysqlrouter(self):
|
|
self.patch_object(mysql_router.ch_core.host, "service_stop")
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
|
|
mrc.stop_mysqlrouter()
|
|
self.service_stop.assert_called_once_with("mysqlrouter")
|
|
|
|
def test_restart_mysqlrouter(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.patch_object(mysql_router.ch_core.host, "service_restart")
|
|
|
|
mrc.restart_mysqlrouter()
|
|
self.service_restart.assert_called_once_with("mysqlrouter")
|
|
|
|
def test_proxy_db_and_user_requests_no_prefix(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
mrc.proxy_db_and_user_requests(self.keystone_shared_db, self.db_router)
|
|
self.db_router.configure_proxy_db.assert_called_once_with(
|
|
'keystone', 'keystone', self.keystone_unit_ip,
|
|
prefix=mrc._unprefixed)
|
|
|
|
def test_proxy_db_and_user_requests_prefixed(self):
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
mrc.proxy_db_and_user_requests(self.nova_shared_db, self.db_router)
|
|
_calls = [
|
|
mock.call('nova', 'nova', self.nova_unit_ip, prefix="nova"),
|
|
mock.call('nova_api', 'nova', self.nova_unit_ip,
|
|
prefix="novaapi"),
|
|
mock.call('nova_cell0', 'nova', self.nova_unit_ip,
|
|
prefix="novacell0")]
|
|
self.db_router.configure_proxy_db.assert_has_calls(
|
|
_calls, any_order=True)
|
|
|
|
def test_proxy_db_and_user_responses_unprefixed(self):
|
|
_json_pass = '"pass"'
|
|
_pass = json.loads(_json_pass)
|
|
_local_unit = "kmr/5"
|
|
self.db_router.password.return_value = _json_pass
|
|
self.local_unit.return_value = _local_unit
|
|
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.db_router.get_prefixes.return_value = [
|
|
mrc._unprefixed, mrc.db_prefix]
|
|
|
|
# Allowed Units unset
|
|
self.db_router.allowed_units.return_value = '""'
|
|
|
|
mrc.proxy_db_and_user_responses(
|
|
self.db_router, self.keystone_shared_db)
|
|
self.keystone_shared_db.set_db_connection_info.assert_called_once_with(
|
|
self.keystone_shared_db.relation_id, mrc.shared_db_address,
|
|
_pass, None, prefix=None)
|
|
|
|
# Allowed Units set correctly
|
|
self.keystone_shared_db.set_db_connection_info.reset_mock()
|
|
self.db_router.allowed_units.return_value = json.dumps(_local_unit)
|
|
mrc.proxy_db_and_user_responses(
|
|
self.db_router, self.keystone_shared_db)
|
|
|
|
self.keystone_shared_db.set_db_connection_info.assert_called_once_with(
|
|
self.keystone_shared_db.relation_id, mrc.shared_db_address,
|
|
_pass, self.keystone_unit_name, prefix=None)
|
|
|
|
# Confirm msyqlrouter credentials are not sent over the shared-db
|
|
# relation
|
|
for call in self.keystone_shared_db.set_db_connection_info.mock_calls:
|
|
self.assertNotEqual(mrc.db_prefix, call.kwargs.get("prefix"))
|
|
|
|
def test_proxy_db_and_user_responses_prefixed(self):
|
|
_json_pass = '"pass"'
|
|
_pass = json.loads(_json_pass)
|
|
_local_unit = "nmr/5"
|
|
_nova = "nova"
|
|
_novaapi = "novaapi"
|
|
_novacell0 = "novacell0"
|
|
self.db_router.password.return_value = _json_pass
|
|
self.local_unit.return_value = _local_unit
|
|
|
|
mrc = mysql_router.MySQLRouterCharm()
|
|
self.db_router.get_prefixes.return_value = [
|
|
mrc.db_prefix, _nova, _novaapi, _novacell0]
|
|
|
|
# Allowed Units unset
|
|
self.db_router.allowed_units.return_value = '""'
|
|
mrc.proxy_db_and_user_responses(self.db_router, self.nova_shared_db)
|
|
_calls = [
|
|
mock.call(
|
|
self.nova_shared_db.relation_id, mrc.shared_db_address, _pass,
|
|
None, prefix=_nova),
|
|
mock.call(
|
|
self.nova_shared_db.relation_id, mrc.shared_db_address, _pass,
|
|
None, prefix=_novaapi),
|
|
mock.call(
|
|
self.nova_shared_db.relation_id, mrc.shared_db_address, _pass,
|
|
None, prefix=_novacell0),
|
|
]
|
|
self.nova_shared_db.set_db_connection_info.assert_has_calls(
|
|
_calls, any_order=True)
|
|
|
|
# Allowed Units set correctly
|
|
self.nova_shared_db.set_db_connection_info.reset_mock()
|
|
self.db_router.allowed_units.return_value = json.dumps(_local_unit)
|
|
mrc.proxy_db_and_user_responses(self.db_router, self.nova_shared_db)
|
|
_calls = [
|
|
mock.call(
|
|
self.nova_shared_db.relation_id, mrc.shared_db_address, _pass,
|
|
self.nova_unit_name, prefix=_nova),
|
|
|
|
mock.call(
|
|
self.nova_shared_db.relation_id, mrc.shared_db_address, _pass,
|
|
self.nova_unit_name, prefix=_novaapi),
|
|
|
|
mock.call(
|
|
self.nova_shared_db.relation_id, mrc.shared_db_address, _pass,
|
|
self.nova_unit_name, prefix=_novacell0),
|
|
]
|
|
self.nova_shared_db.set_db_connection_info.assert_has_calls(
|
|
_calls, any_order=True)
|
|
|
|
# Confirm msyqlrouter credentials are not sent over the shared-db
|
|
# relation
|
|
for call in self.nova_shared_db.set_db_connection_info.mock_calls:
|
|
self.assertNotEqual(mrc.db_prefix, call.kwargs.get("prefix"))
|