openstack
/
charm-interface-mysql-router
Code Issues Proposed changes

MySQL Router Interface 

* requires handles communication with MySQL InnoDB Cluster
* provides handles communication with database clients
This commit is contained in:
David Ames 2019-10-03 10:31:54 -07:00
commit 7e83ac1856
13 changed files with 1106 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
.tox
.testrepository
.stestr/
__pycache__

3
.stestr.conf Normal file
View File

@ -0,0 +1,3 @@
[DEFAULT]
test_path=./unit_tests
top_dir=./

9
.travis.yml Normal file
View File

@ -0,0 +1,9 @@
language: python
python:
- "3.6"
install: pip install tox-travis
env:
- ENV=pep8
- ENV=py3
script:
- tox -e $ENV

202
LICENSE Normal file
View File

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2018 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.

125
README.md Normal file
View File

@ -0,0 +1,125 @@
# Overview
MySQL Router Interface
This interface layer handles the communication between MySQL Router and a MySQL
InnoDB Cluster and facilitates proxying database requests from database
clients.
* requires handles communication with MySQL InnoDB Cluster
* provides handles communication with database clients
# Usage
## Requires
On the requires side, the interface handles requesting a user for MySQL Router
and also handles proxying database requests to the MySQL InnoDB cluster from
its provides side.
All requests over the mysql-router interface are prefixed using the following
pattern:
```
{prefix}_username
{prefix}_hostname
{prefix}_database
```
Examples:
The mysql-router user request using the prefix, "mysqlrouter":
```
mysqlrouter_username="myr-user" mysqlrouter_hostname="192.168.1.5"
```
A proxied DB request using the prefix, "novaapi":
```
novaapi_username="nova" novaapi_hostname="192.168.1.20" novaapi_databse="nova_api"
```
The interface layer will set the following states, as appropriate:
* `{relation_name}.connected` The relation is established, but no data has
yet been exchanged.
* `{relation_name}.available` MySQL Router has a user in the MySQL InnoDB
Cluster.
* `{relation_name}.available.proxy` Proxied database requests are complete.
Received connection information is available via the following methods:
* `allowed_units(prefix)`
* `database(prefix)`
* `db_host(prefix)`
* `hostname(prefix)`
* `username(prefix)`
* `password(prefix)`
Requests can be made of the MySQL InnoDB Cluster with the following methods:
For MySQL Router itself:
```python
db_router.configure_db_router("myr-user", "192.168.1.5", "mysqlrouter")
```
For a proxied database request:
```python
db_router.configure_proxy_db("nova_api", "nova", "192.168.1.20", "novaapi")
```
For example:
```python
from charms.reactive import when, when_not
@when('db-router.connected')
def setup_database(db_router):
db_router.configure_db_router("myr-user", "192.168.1.5", "mysqlrouter")
@when('db-router.available')
def use_database(db_router):
# Multiple Database requests:
db_router.configure_proxy_db("nova", "nova", "192.168.1.20", "nova")
db_router.configure_proxy_db("nova_api", "nova", "192.168.1.20", "novaapi")
db_router.configure_proxy_db("nova_cell0", "nova", "192.168.1.20", "novacell0")
```
The interface will automatically determine the network space binding on the
local unit to present to the remote mysql-router server based on the name of
the relation. This can be overridden using the hostname parameter in the
configure_db_router and configure_proxy_db methods.
## Provides
The interface layer will set the following states, as appropriate:
* `{relation_name}.connected` The relation is established, but the client
has not provided the database information yet.
* `{relation_name}.available` The requested information is complete. The DB,
user and hostname can be created.
* Connection information is passed back to the client with the following method:
* `set_db_connection_info()`
For example:
```python
@when('shared-db.available')
@when_not('db-router.available.proxy')
def use_database(db_router, shared_db):
instance.proxy_db_and_user_requests(db_router, shared_db)
@when('shared-db.available')
@when('db-router.available.proxy')
def use_database(db_router, shared_db):
instance.proxy_db_and_user_responses(db_router, shared_db)
```
The interface will automatically determine the network space binding on the
local unit to present to the remote mysql-shared client based on the name of
the relation. This can be overridden using the db_host parameter of the
set_db_connection_info method.

13
interface.yaml Normal file
View File

@ -0,0 +1,13 @@
name: mysql-router
summary: Interface for integrating MySQL Router and MySQL InnoDB Cluster
maintainer: OpenStack Charmers <openstack-charmers@lists.ubuntu.com>
ignore:
- 'unit_tests'
- '.stestr.conf'
- 'test-requirements.txt'
- 'tox.ini'
- '.gitignore'
- '.travis.yml'
- '.zuul.yaml'
- '.tox'
- '.git'

106
provides.py Normal file
View File

@ -0,0 +1,106 @@
# 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.
from charms import reactive
import charmhelpers.contrib.network.ip as ch_net_ip
class MySQLRouterProvides(reactive.Endpoint):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.ingress_address = ch_net_ip.get_relation_ip(self.endpoint_name)
def relation_ids(self):
return [x.relation_id for x in self.relations]
def set_ingress_address(self):
for relation in self.relations:
relation.to_publish_raw["ingress-address"] = self.ingress_address
relation.to_publish_raw["private-address"] = self.ingress_address
def available(self):
for unit in self.all_joined_units:
# Check for prefixed username
for key in unit.received.keys():
if "_username" in key:
return True
return False
@reactive.when('endpoint.{endpoint_name}.joined')
def joined(self):
reactive.clear_flag(self.expand_name('{endpoint_name}.available'))
reactive.set_flag(self.expand_name('{endpoint_name}.connected'))
self.set_ingress_address()
@reactive.when('endpoint.{endpoint_name}.changed')
def changed(self):
flags = (
self.expand_name(
'endpoint.{endpoint_name}.changed.database'),
self.expand_name(
'endpoint.{endpoint_name}.changed.username'),
self.expand_name(
'endpoint.{endpoint_name}.changed.hostname'),
)
if reactive.all_flags_set(*flags):
for flag in flags:
reactive.clear_flag(flag)
if self.available():
reactive.set_flag(self.expand_name('{endpoint_name}.available'))
else:
reactive.clear_flag(self.expand_name('{endpoint_name}.available'))
@reactive.when_any('endpoint.{endpoint_name}.broken',
'endpoint.{endpoint_name}.departed')
def departed(self):
flags = (
self.expand_name('{endpoint_name}.connected'),
self.expand_name('{endpoint_name}.available'),
)
for flag in flags:
reactive.clear_flag(flag)
def set_db_connection_info(
self, relation_id, db_host, password,
allowed_units=None, prefix=None):
"""Send database connection information to the client.
:param relation_id: Relation ID to set connection information on
:type relation_id: str
:param db_host: Host IP or hostname for connecting to the DB
:type db_host: str
:param password: Password for connecting to the DB
:type password: str
:param allowed_units: Space delimited unit names allowed to connect to
the DB.
:type allowed_units: str
:param prefix: Prefix to use for responses.
:type prefix: str
:side effect: Data is set on the relation
:returns: None, this function is called for its side effect
:rtype: None
"""
# No prefix for db_host
self.relations[relation_id].to_publish["db_host"] = db_host
if not prefix:
self.relations[relation_id].to_publish["password"] = password
self.relations[relation_id].to_publish[
"allowed_units"] = allowed_units
else:
self.relations[relation_id].to_publish[
"{}_password".format(prefix)] = password
self.relations[relation_id].to_publish[
"{}_allowed_units".format(prefix)] = allowed_units

162
requires.py Normal file
View File

@ -0,0 +1,162 @@
from charmhelpers.core import hookenv
from charms.reactive import RelationBase
from charms.reactive import hook
from charms.reactive import scopes
class MySQLRouterRequires(RelationBase):
scope = scopes.GLOBAL
# These remote data fields will be automatically mapped to accessors
# with a basic documentation string provided.
auto_accessors = ['db_host', 'ssl_ca', 'ssl_cert', 'ssl_key']
@hook('{requires:mysql-router}-relation-joined')
def joined(self):
self.set_state('{relation_name}.connected')
@hook('{requires:mysql-router}-relation-changed')
def changed(self):
if self.db_router_data_complete():
self.set_state('{relation_name}.available')
if self.proxy_db_data_complete():
self.set_state('{relation_name}.available.proxy')
if self.ssl_data_complete():
self.set_state('{relation_name}.available.ssl')
@hook('{requires:mysql-router}-relation-{broken,departed}')
def departed(self):
# Clear state
self.remove_state('{relation_name}.connected')
self.remove_state('{relation_name}.available')
self.remove_state('{relation_name}.proxy.available')
self.remove_state('{relation_name}.available.ssl')
# Check if this is the last unit
for conversation in self.conversations():
for rel_id in conversation.relation_ids:
if len(hookenv.related_units(rel_id)) > 0:
# This is not the last unit so reevaluate state
self.joined()
self.changed()
def configure_db_router(self, username, hostname, prefix):
"""
Called by charm layer that uses this interface to configure a database.
"""
relation_info = {
prefix + '_username': username,
prefix + '_hostname': hostname,
}
self.set_prefix(prefix)
self.set_remote(**relation_info)
self.set_local(**relation_info)
def configure_proxy_db(self, database, username, hostname, prefix):
"""
Called by charm layer that uses this interface to configure a database.
"""
relation_info = {
prefix + '_database': database,
prefix + '_username': username,
prefix + '_hostname': hostname,
}
self.set_prefix(prefix)
self.set_remote(**relation_info)
self.set_local(**relation_info)
def set_prefix(self, prefix):
"""
Store all of the database prefixes in a list.
"""
prefixes = self.get_local('prefixes')
if prefixes:
if prefix not in prefixes:
self.set_local('prefixes', prefixes + [prefix])
else:
self.set_local('prefixes', [prefix])
def get_prefixes(self):
"""
Return the list of saved prefixes.
"""
return self.get_local('prefixes')
def database(self, prefix):
"""
Return a configured database name.
"""
return self.get_local(prefix + '_database')
def username(self, prefix):
"""
Return a configured username.
"""
return self.get_local(prefix + '_username')
def hostname(self, prefix):
"""
Return a configured hostname.
"""
return self.get_local(prefix + '_hostname')
def password(self, prefix):
"""
Return a database password.
"""
return self.get_remote(prefix + '_password')
def allowed_units(self, prefix):
"""
Return a database's allowed_units.
"""
return self.get_remote(prefix + '_allowed_units')
def db_router_data_complete(self):
"""
Check if required db router data is complete.
"""
data = {
'db_host': self.db_host(),
}
if self.get_prefixes():
suffixes = ['_password']
for prefix in self.get_prefixes():
for suffix in suffixes:
key = prefix + suffix
data[key] = self.get_remote(key)
if all(data.values()):
return True
return False
def proxy_db_data_complete(self):
"""
Check if required proxy databases data is complete.
"""
data = {
'db_host': self.db_host(),
}
# The mysql-router prefix + proxied db prefixes
if len(self.get_prefixes()) > 1:
suffixes = ['_password', '_allowed_units']
for prefix in self.get_prefixes():
for suffix in suffixes:
key = prefix + suffix
data[key] = self.get_remote(key)
if all(data.values()):
return True
return False
def ssl_data_complete(self):
"""
Check if optional ssl data provided by mysql is complete.
"""
# Note: ssl_ca can also be set but isn't required
data = {
'ssl_cert': self.ssl_cert(),
'ssl_key': self.ssl_key(),
}
if all(data.values()):
return True
return False

5
test-requirements.txt Normal file
View File

@ -0,0 +1,5 @@
charms.reactive
flake8>=2.2.4,<=2.4.1
mock>=1.2
stestr>=2.2.0
git+https://github.com/openstack/charms.openstack.git#egg=charms.openstack

42
tox.ini Normal file
View File

@ -0,0 +1,42 @@
[tox]
envlist = pep8,py3
skipsdist = True
# NOTE(beisner): Avoid build/test env pollution by not enabling sitepackages.
sitepackages = False
# NOTE(beisner): Avoid false positives by not skipping missing interpreters.
skip_missing_interpreters = False
[testenv]
setenv = VIRTUAL_ENV={envdir}
PYTHONHASHSEED=0
install_command =
pip install {opts} {packages}
commands = stestr run {posargs}
passenv = HOME TERM
deps = -r{toxinidir}/test-requirements.txt
[testenv:py34]
basepython = python3.4
[testenv:py35]
basepython = python3.5
[testenv:py36]
basepython = python3.6
[testenv:py37]
basepython = python3.7
[testenv:py3]
basepython = python3
[testenv:pep8]
basepython = python3
commands = flake8 {posargs}
[testenv:venv]
basepython = python3
commands = {posargs}
[flake8]
ignore = E402,E226

22
unit_tests/__init__.py Normal file
View File

@ -0,0 +1,22 @@
# 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 sys
sys.path.append('src')
sys.path.append('src/lib')
# Mock out charmhelpers so that we can test without it.
import charms_openstack.test_mocks # noqa
charms_openstack.test_mocks.mock_charmhelpers()

156
unit_tests/test_provides.py Normal file
View File

@ -0,0 +1,156 @@
# 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 charms_openstack.test_utils as test_utils
import mock
import provides
class TestRegisteredHooks(test_utils.TestRegisteredHooks):
def test_hooks(self):
defaults = []
hook_set = {
"when": {
"joined": (
"endpoint.{endpoint_name}.joined",),
"changed": (
"endpoint.{endpoint_name}.changed",),
"departed": ("endpoint.{endpoint_name}.broken",
"endpoint.{endpoint_name}.departed",),
},
}
# test that the hooks were registered
self.registered_hooks_test_helper(provides, hook_set, defaults)
class TestMySQLRouterProvides(test_utils.PatchHelper):
def setUp(self):
super().setUp()
self._patches = {}
self._patches_start = {}
self.patch_object(provides.reactive, "clear_flag")
self.patch_object(provides.reactive, "set_flag")
self.fake_unit = mock.MagicMock()
self.fake_unit.unit_name = "myunit/4"
self.fake_unit.received = {"username": None}
self.fake_relation_id = "shared-db:19"
self.fake_relation = mock.MagicMock()
self.fake_relation.relation_id = self.fake_relation_id
self.fake_relation.units = [self.fake_unit]
self.ep_name = "ep"
self.ep = provides.MySQLRouterProvides(
self.ep_name, [self.fake_relation_id])
self.ep.ingress_address = "10.10.10.10"
self.ep.relations[0] = self.fake_relation
def tearDown(self):
self.ep = None
for k, v in self._patches.items():
v.stop()
setattr(self, k, None)
self._patches = None
self._patches_start = None
def test_joined(self):
self.ep.set_ingress_address = mock.MagicMock()
self.ep.joined()
self.clear_flag.assert_called_once_with(
"{}.available".format(self.ep_name))
self.set_flag.assert_called_once_with(
"{}.connected".format(self.ep_name))
self.ep.set_ingress_address.assert_called_once()
def test_changed_not_available(self):
self.ep.available = mock.MagicMock()
self.ep.available.return_value = False
self.ep.changed()
_calls = [
mock.call("{}.available".format(self.ep_name)),
mock.call("endpoint.{}.changed.database".format(self.ep_name)),
mock.call("endpoint.{}.changed.username".format(self.ep_name)),
mock.call("endpoint.{}.changed.hostname".format(self.ep_name))]
self.clear_flag.assert_has_calls(_calls, any_order=True)
self.set_flag.assert_not_called()
def test_changed_available(self):
self.ep.available = mock.MagicMock()
self.ep.available.return_value = True
self.ep.changed()
_calls = [
mock.call("endpoint.{}.changed.database".format(self.ep_name)),
mock.call("endpoint.{}.changed.username".format(self.ep_name)),
mock.call("endpoint.{}.changed.hostname".format(self.ep_name))]
self.clear_flag.assert_has_calls(_calls, any_order=True)
self.set_flag.assert_called_once_with(
"{}.available".format(self.ep_name))
def test_departed(self):
self.ep.departed()
_calls = [
mock.call("{}.available".format(self.ep_name)),
mock.call("{}.connected".format(self.ep_name))]
self.clear_flag.assert_has_calls(_calls, any_order=True)
def test_relation_ids(self):
self.assertEqual([self.fake_relation_id], self.ep.relation_ids())
def test_set_ingress_address(self):
_calls = [
mock.call("ingress-address", self.ep.ingress_address),
mock.call("private-address", self.ep.ingress_address)]
self.ep.set_ingress_address()
self.fake_relation.to_publish_raw.__setitem__.assert_has_calls(_calls)
def test_available_not_available(self):
self.assertFalse(self.ep.available())
def test_available_prefixed_available(self):
self.fake_unit.received["prefix_username"] = "user"
self.assertTrue(self.ep.available())
def test_set_db_connection_info_no_prefix(self):
_pw = "fakepassword"
self.ep.set_db_connection_info(
self.fake_relation_id,
self.ep.ingress_address,
_pw,
allowed_units=self.fake_unit.unit_name)
_calls = [
mock.call("db_host", self.ep.ingress_address),
mock.call("password", _pw),
mock.call("allowed_units", self.fake_unit.unit_name)]
self.fake_relation.to_publish.__setitem__.assert_has_calls(_calls)
def test_set_db_connection_info_prefixed(self):
_p = "prefix"
_pw = "fakepassword"
self.ep.set_db_connection_info(
self.fake_relation_id,
self.ep.ingress_address,
_pw,
allowed_units=self.fake_unit.unit_name,
prefix=_p)
_calls = [
mock.call("db_host", self.ep.ingress_address),
mock.call("{}_password".format(_p), _pw),
mock.call("{}_allowed_units".format(_p), self.fake_unit.unit_name)]
self.fake_relation.to_publish.__setitem__.assert_has_calls(_calls)

257
unit_tests/test_requires.py Normal file
View File

@ -0,0 +1,257 @@
# 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 unittest
import mock
import requires
_hook_args = {}
def mock_hook(*args, **kwargs):
def inner(f):
# remember what we were passed. Note that we can't actually determine
# the class we're attached to, as the decorator only gets the function.
_hook_args[f.__name__] = dict(args=args, kwargs=kwargs)
return f
return inner
class TestMySQLRouterRequires(unittest.TestCase):
@classmethod
def setUpClass(cls):
cls._patched_hook = mock.patch('charms.reactive.hook', mock_hook)
cls._patched_hook_started = cls._patched_hook.start()
# force requires to rerun the mock_hook decorator:
# try except is Python2/Python3 compatibility as Python3 has moved
# reload to importlib.
try:
reload(requires)
except NameError:
import importlib
importlib.reload(requires)
@classmethod
def tearDownClass(cls):
cls._patched_hook.stop()
cls._patched_hook_started = None
cls._patched_hook = None
# and fix any breakage we did to the module
try:
reload(requires)
except NameError:
import importlib
importlib.reload(requires)
def setUp(self):
self._patches = {}
self._patches_start = {}
self._rel_ids = ["mysql-router:3"]
self._remote_data = {}
self._local_data = {}
self._conversation = mock.MagicMock()
self._conversation.relation_ids = self._rel_ids
self._conversation.scope = requires.scopes.GLOBAL
self._conversation.get_remote.side_effect = self.get_fake_remote_data
self._conversation.get_local.side_effect = self.get_fake_local_data
# The Relation object
self.mysql_router = requires.MySQLRouterRequires(
'mysql-router', [self._conversation])
self.patch_mysql_router('conversations', [self._conversation])
self.patch_mysql_router('set_remote')
self.patch_mysql_router('set_local')
self.patch_mysql_router('set_state')
self.patch_mysql_router('remove_state')
self.patch_mysql_router('db_host', "10.5.0.21")
def tearDown(self):
self.mysql_router = None
for k, v in self._patches.items():
v.stop()
setattr(self, k, None)
self._patches = None
self._patches_start = None
def patch_mysql_router(self, attr, return_value=None):
mocked = mock.patch.object(self.mysql_router, attr)
self._patches[attr] = mocked
started = mocked.start()
started.return_value = return_value
self._patches_start[attr] = started
setattr(self, attr, started)
def get_fake_remote_data(self, key, default=None):
return self._remote_data.get(key) or default
def get_fake_local_data(self, key, default=None):
return self._local_data.get(key) or default
def test_registered_hooks(self):
# test that the hooks actually registered the relation expressions that
# are meaningful for this interface: this is to handle regressions.
# The keys are the function names that the hook attaches to.
hook_patterns = {
'joined': ('{requires:mysql-router}-relation-joined',),
'changed': ('{requires:mysql-router}-relation-changed',),
'departed': (
'{requires:mysql-router}-relation-{broken,departed}',)}
for k, v in _hook_args.items():
self.assertEqual(hook_patterns[k], v['args'])
def test_changed_available(self):
self.patch_mysql_router('db_router_data_complete', True)
self.patch_mysql_router('proxy_db_data_complete', True)
self.patch_mysql_router('ssl_data_complete', True)
self._local_data = {"prefixes": ["myprefix"]}
_calls = [
mock.call("{relation_name}.available"),
mock.call("{relation_name}.available.proxy"),
mock.call("{relation_name}.available.ssl")]
self.mysql_router.changed()
self.set_state.assert_has_calls(_calls)
def test_changed_not_available(self):
self.patch_mysql_router('db_router_data_complete', False)
self._local_data = {"prefixes": ["myprefix"]}
self.mysql_router.changed()
self.set_state.assert_not_called()
def test_joined(self):
self.mysql_router.joined()
self.set_state.assert_called_once_with('{relation_name}.connected')
def test_departed(self):
self.mysql_router.departed()
_calls = [
mock.call("{relation_name}.available")]
self.remove_state.assert_has_calls(_calls)
def test_db_router_data_complete_missing_prefix(self):
self._remote_data = {"password": "1234",
"allowed_units": "unit/1"}
assert self.mysql_router.db_router_data_complete() is False
def test_db_router_data_complete(self):
self._local_data = {"prefixes": ["myprefix"]}
self._remote_data = {"myprefix_password": "1234",
"myprefix_allowed_units": "unit/1"}
assert self.mysql_router.db_router_data_complete() is True
self.db_host.return_value = None
assert self.mysql_router.db_router_data_complete() is False
def test_proxy_db_data_incomplete(self):
self._local_data = {"prefixes": ["myprefix"]}
self._remote_data = {"myprefix_password": "1234",
"myprefix_allowed_units": "unit/1"}
assert self.mysql_router.proxy_db_data_complete() is False
def test_proxy_db_data_complete(self):
self._local_data = {"prefixes": ["myprefix", "db"]}
self._remote_data = {"myprefix_password": "1234",
"myprefix_allowed_units": "unit/1",
"db_password": "1234",
"db_allowed_units": "unit/1"}
assert self.mysql_router.proxy_db_data_complete() is True
self.db_host.return_value = None
assert self.mysql_router.proxy_db_data_complete() is False
def test_ssl_data_incomplete(self):
self.patch_mysql_router('ssl_cert', "somecert")
self.patch_mysql_router('ssl_key', "somekey")
assert self.mysql_router.ssl_data_complete() is True
self.ssl_key.return_value = None
assert self.mysql_router.ssl_data_complete() is False
def test_local_accessors(self):
_prefix = "myprefix"
_value = "value"
_tests = {
"database": self.mysql_router.database,
"username": self.mysql_router.username,
"hostname": self.mysql_router.hostname}
# Not set
for key, test in _tests.items():
self.assertEqual(test(_prefix), None)
# Set
self._local_data = {"prefixes": [_prefix]}
for key, test in _tests.items():
self._local_data["{}_{}".format(_prefix, key)] = _value
self.assertEqual(test(_prefix), _value)
def test_remote_accessors(self):
_prefix = "myprefix"
_value = "value"
_tests = {
"password": self.mysql_router.password,
"allowed_units": self.mysql_router.allowed_units}
# Not set
for key, test in _tests.items():
self.assertEqual(test(_prefix), None)
# Set
self._local_data = {"prefixes": [_prefix]}
for key, test in _tests.items():
self._remote_data = {"{}_{}".format(_prefix, key): _value}
self.assertEqual(test(_prefix), _value)
def test_configure_db_router(self):
self.patch_mysql_router('set_prefix')
_user = "user"
_host = "host"
_prefix = "prefix"
_expected = {
"{}_username".format(_prefix): _user,
"{}_hostname".format(_prefix): _host}
self.mysql_router.configure_db_router(_user, _host, prefix=_prefix)
self.set_remote.assert_called_once_with(**_expected)
self.set_local.assert_called_once_with(**_expected)
self.set_prefix.assert_called_once()
def test_configure_proxy_db(self):
self.patch_mysql_router('set_prefix')
_db = "db"
_user = "user"
_host = "host"
_prefix = "prefix"
_expected = {
"{}_database".format(_prefix): _db,
"{}_username".format(_prefix): _user,
"{}_hostname".format(_prefix): _host}
self.mysql_router.configure_proxy_db(_db, _user, _host, prefix=_prefix)
self.set_remote.assert_called_once_with(**_expected)
self.set_local.assert_called_once_with(**_expected)
self.set_prefix.assert_called_once()
def test_get_prefix(self):
_prefix = "prefix"
self._local_data = {"prefixes": [_prefix]}
self.assertEqual(
self.mysql_router.get_prefixes(), [_prefix])
def test_set_prefix(self):
# First
_prefix = "prefix"
self.mysql_router.set_prefix(_prefix)
self.set_local.assert_called_once_with("prefixes", [_prefix])
# More than one
self.set_local.reset_mock()
self._local_data = {"prefixes": [_prefix]}
_second = "secondprefix"
self.mysql_router.set_prefix(_second)
self.set_local.assert_called_once_with("prefixes", [_prefix, _second])