From 5a5ac25dab7a35322cbe1c358bb39f529d53d5d5 Mon Sep 17 00:00:00 2001 From: Frode Nordahl Date: Fri, 6 Sep 2019 14:44:43 +0200 Subject: [PATCH] Initial commit --- .gitignore | 7 ++ .stestr.conf | 3 + LICENSE | 202 +++++++++++++++++++++++++++++++ README.md | 39 ++++++ src/lib/README.md | 7 ++ src/lib/__init__.py | 13 ++ src/lib/ovsdb.py | 91 ++++++++++++++ src/ovsdb-cluster/interface.yaml | 11 ++ src/ovsdb-cluster/lib | 1 + src/ovsdb-cluster/peers.py | 33 +++++ src/ovsdb-cluster/provides.py | 42 +++++++ src/ovsdb-cluster/requires.py | 41 +++++++ src/ovsdb-cms/interface.yaml | 11 ++ src/ovsdb-cms/lib | 1 + src/ovsdb-cms/provides.py | 42 +++++++ src/ovsdb-cms/requires.py | 42 +++++++ src/ovsdb/interface.yaml | 11 ++ src/ovsdb/lib | 1 + src/ovsdb/provides.py | 42 +++++++ src/ovsdb/requires.py | 42 +++++++ test-requirements.txt | 7 ++ tox.ini | 38 ++++++ unit_tests/__init__.py | 22 ++++ unit_tests/test_lib_ovsdb.py | 152 +++++++++++++++++++++++ 24 files changed, 901 insertions(+) create mode 100644 .gitignore create mode 100644 .stestr.conf create mode 100644 LICENSE create mode 100644 README.md create mode 100644 src/lib/README.md create mode 100644 src/lib/__init__.py create mode 100644 src/lib/ovsdb.py create mode 100644 src/ovsdb-cluster/interface.yaml create mode 120000 src/ovsdb-cluster/lib create mode 100644 src/ovsdb-cluster/peers.py create mode 100644 src/ovsdb-cluster/provides.py create mode 100644 src/ovsdb-cluster/requires.py create mode 100644 src/ovsdb-cms/interface.yaml create mode 120000 src/ovsdb-cms/lib create mode 100644 src/ovsdb-cms/provides.py create mode 100644 src/ovsdb-cms/requires.py create mode 100644 src/ovsdb/interface.yaml create mode 120000 src/ovsdb/lib create mode 100644 src/ovsdb/provides.py create mode 100644 src/ovsdb/requires.py create mode 100644 test-requirements.txt create mode 100644 tox.ini create mode 100644 unit_tests/__init__.py create mode 100644 unit_tests/test_lib_ovsdb.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2da5a7d --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +.tox +.stestr +*__pycache__* +*.pyc +build +.unit-state.db +*.swp diff --git a/.stestr.conf b/.stestr.conf new file mode 100644 index 0000000..5fcccac --- /dev/null +++ b/.stestr.conf @@ -0,0 +1,3 @@ +[DEFAULT] +test_path=./unit_tests +top_dir=./ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -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 [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..72c7d3e --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Overview + +This repository contains a set of similar interfaces with common code broken +out to a separate module. + +This interface facilitates a provider charm to publish connection properties +of a OVSDB and a requirer charm to consume a remote OVSDB. + +# Usage + +No explicit handler is required to consume this interface in charms +that consume this interface. + +In addittion to the states automatically set based on relation data by +``charms.reactive.Endpoint``, the interface provides the +``ovsdb.available`` state. + +# metadata + +To consume this interface in your charm or layer, add the following to `layer.yaml`: + +```yaml +includes: ['interface:ovsdb'] +``` + +and add a provider or requires interface of type `ovsdb` to your charm or +layers `metadata.yaml`: + +```yaml +requires: + ovsdb: + interface: ovsdb +``` + +# Bugs + +Please report bugs on [Launchpad](https://bugs.launchpad.net/openstack-charms/+filebug). + +For development questions please refer to the OpenStack [Charm Guide](https://github.com/openstack/charm-guide). diff --git a/src/lib/README.md b/src/lib/README.md new file mode 100644 index 0000000..01ddf20 --- /dev/null +++ b/src/lib/README.md @@ -0,0 +1,7 @@ +The python modules kept in this directory contain code shared among the +individual interfaces distributed as part of this repository. + +> **Note**: Do not use the ``charms.reactive`` decorators that take flags + as arguments to wrap functions or methods in the shared files. Consume + the shared code from the interface specific files and declare which flags + to react to there. diff --git a/src/lib/__init__.py b/src/lib/__init__.py new file mode 100644 index 0000000..5705e5d --- /dev/null +++ b/src/lib/__init__.py @@ -0,0 +1,13 @@ +# 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. diff --git a/src/lib/ovsdb.py b/src/lib/ovsdb.py new file mode 100644 index 0000000..156cd94 --- /dev/null +++ b/src/lib/ovsdb.py @@ -0,0 +1,91 @@ +# 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. + +# NOTE: Do not use the ``charms.reactive`` decorators that take flags +# as arguments to wrap functions or methods in this shared library. +# +# Consume the shared code from the interface specific files and declare +# which flags to react to there. + +import inspect +import ipaddress + +import charmhelpers.core as ch_core + +import charms.reactive as reactive + + +class OVSDB(reactive.Endpoint): + + @property + def cluster_local_addr(self): + for relation in self.relations: + ng_data = ch_core.hookenv.network_get( + self.expand_name('{endpoint_name}'), + relation_id=relation.relation_id) + for interface in ng_data.get('bind-addresses', []): + for addr in interface.get('addresses', []): + return addr['address'] + + @property + def cluster_addrs(self): + for relation in self.relations: + for unit in relation.units: + try: + addr = ipaddress.ip_address( + unit.received.get('bound-address', '')) + except ValueError: + continue + if isinstance(addr, ipaddress.IPv6Address): + yield '[{}]'.format(addr) + else: + yield '{}'.format(addr) + + def expected_peers_available(self): + if len(self.all_joined_units) == len( + list(ch_core.hookenv.expected_peer_units())): + for relation in self.relations: + for unit in relation.units: + if not unit.received.get('bound-address'): + break + else: + continue + break + else: + return True + return False + + def publish_cluster_local_addr(self): + """Announce the address we bound our OVSDB Servers to. + + This will be used by our peers and clients to build a connection + string to the remote cluster. + """ + for relation in self.relations: + relation.to_publish['bound-address'] = self.cluster_local_addr + + def joined(self): + ch_core.hookenv.log('{}: {} -> {}' + .format(self._endpoint_name, + type(self).__name__, + inspect.currentframe().f_code.co_name), + level=ch_core.hookenv.INFO) + reactive.set_flag(self.expand_name('{endpoint_name}.connected')) + self.publish_cluster_local_addr() + if self.expected_peers_available: + reactive.set_flag(self.expand_name('{endpoint_name}.available')) + + def broken(self): + reactive.clear_flag(self.expand_name('{endpoint_name}.available')) + reactive.clear_flag(self.expand_name('{endpoint_name}.connected')) diff --git a/src/ovsdb-cluster/interface.yaml b/src/ovsdb-cluster/interface.yaml new file mode 100644 index 0000000..a35b904 --- /dev/null +++ b/src/ovsdb-cluster/interface.yaml @@ -0,0 +1,11 @@ +name: ovsdb-cluster +summary: Interface for OVSDB +maintainer: OpenStack Charmers +repo: https://github.com/openstack-charmers/charm-interface-ovsdb.git +ignore: + - 'unit_tests' + - '.stestr.conf' + - 'test-requirements.txt' + - 'tox.ini' + - '.gitignore' + - '.travis.yml' diff --git a/src/ovsdb-cluster/lib b/src/ovsdb-cluster/lib new file mode 120000 index 0000000..5bf80bf --- /dev/null +++ b/src/ovsdb-cluster/lib @@ -0,0 +1 @@ +../lib/ \ No newline at end of file diff --git a/src/ovsdb-cluster/peers.py b/src/ovsdb-cluster/peers.py new file mode 100644 index 0000000..2eef42d --- /dev/null +++ b/src/ovsdb-cluster/peers.py @@ -0,0 +1,33 @@ +# 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. + +# the reactive framework unfortunately does not grok `import as` in conjunction +# with decorators on class instance methods, so we have to revert to `from ...` +# imports +from charms.reactive import ( + when, +) + +from .lib import ovsdb as ovsdb + + +class OVSDBClusterPeer(ovsdb.OVSDB): + + @when('endpoint.{endpoint_name}.joined') + def joined(self): + super().joined() + + @when('endpoint.{endpoint_name}.broken') + def broken(self): + super().broken() diff --git a/src/ovsdb-cluster/provides.py b/src/ovsdb-cluster/provides.py new file mode 100644 index 0000000..d9e1e82 --- /dev/null +++ b/src/ovsdb-cluster/provides.py @@ -0,0 +1,42 @@ +# 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. + +# the reactive framework unfortunately does not grok `import as` in conjunction +# with decorators on class instance methods, so we have to revert to `from ...` +# imports + +import inspect + +import charmhelpers.core as ch_core + +from charms.reactive import ( + when, +) + +from .lib import ovsdb as ovsdb + + +class OVSDBClusterProvides(ovsdb.OVSDB): + + @when('endpoint.{endpoint_name}.joined') + def joined(self): + ch_core.hookenv.log('{}: {} -> {}' + .format(self._endpoint_name, + type(self).__name__, + inspect.currentframe().f_code.co_name), + level=ch_core.hookenv.INFO) + + @when('endpoint.{endpoint_name}.broken') + def broken(self): + super().broken() diff --git a/src/ovsdb-cluster/requires.py b/src/ovsdb-cluster/requires.py new file mode 100644 index 0000000..22b87bb --- /dev/null +++ b/src/ovsdb-cluster/requires.py @@ -0,0 +1,41 @@ +# 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. + +import inspect + +import charmhelpers.core as ch_core + +# the reactive framework unfortunately does not grok `import as` in conjunction +# with decorators on class instance methods, so we have to revert to `from ...` +# imports +from charms.reactive import ( + when, +) + +from .lib import ovsdb as ovsdb + + +class OVSDBClusterRequires(ovsdb.OVSDB): + + @when('endpoint.{endpoint_name}.joined') + def joined(self): + ch_core.hookenv.log('{}: {} -> {}' + .format(self._endpoint_name, + type(self).__name__, + inspect.currentframe().f_code.co_name), + level=ch_core.hookenv.INFO) + + @when('endpoint.{endpoint_name}.broken') + def broken(self): + super().broken() diff --git a/src/ovsdb-cms/interface.yaml b/src/ovsdb-cms/interface.yaml new file mode 100644 index 0000000..0502913 --- /dev/null +++ b/src/ovsdb-cms/interface.yaml @@ -0,0 +1,11 @@ +name: ovsdb-cms +summary: Interface for OVSDB +maintainer: OpenStack Charmers +repo: https://github.com/openstack-charmers/charm-interface-ovsdb.git +ignore: + - 'unit_tests' + - '.stestr.conf' + - 'test-requirements.txt' + - 'tox.ini' + - '.gitignore' + - '.travis.yml' diff --git a/src/ovsdb-cms/lib b/src/ovsdb-cms/lib new file mode 120000 index 0000000..dc598c5 --- /dev/null +++ b/src/ovsdb-cms/lib @@ -0,0 +1 @@ +../lib \ No newline at end of file diff --git a/src/ovsdb-cms/provides.py b/src/ovsdb-cms/provides.py new file mode 100644 index 0000000..b27dc26 --- /dev/null +++ b/src/ovsdb-cms/provides.py @@ -0,0 +1,42 @@ +# 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. + +# the reactive framework unfortunately does not grok `import as` in conjunction +# with decorators on class instance methods, so we have to revert to `from ...` +# imports + +import inspect + +import charmhelpers.core as ch_core + +from charms.reactive import ( + when, +) + +from .lib import ovsdb as ovsdb + + +class OVSDBCMSProvides(ovsdb.OVSDB): + + @when('endpoint.{endpoint_name}.joined') + def joined(self): + ch_core.hookenv.log('{}: {} -> {}' + .format(self._endpoint_name, + type(self).__name__, + inspect.currentframe().f_code.co_name), + level=ch_core.hookenv.INFO) + + @when('endpoint.{endpoint_name}.broken') + def broken(self): + super().broken() diff --git a/src/ovsdb-cms/requires.py b/src/ovsdb-cms/requires.py new file mode 100644 index 0000000..3e13ae8 --- /dev/null +++ b/src/ovsdb-cms/requires.py @@ -0,0 +1,42 @@ +# 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. + +# the reactive framework unfortunately does not grok `import as` in conjunction +# with decorators on class instance methods, so we have to revert to `from ...` +# imports + +import inspect + +import charmhelpers.core as ch_core + +from charms.reactive import ( + when, +) + +from .lib import ovsdb as ovsdb + + +class OVSDBCMSRequires(ovsdb.OVSDB): + + @when('endpoint.{endpoint_name}.joined') + def joined(self): + ch_core.hookenv.log('{}: {} -> {}' + .format(self._endpoint_name, + type(self).__name__, + inspect.currentframe().f_code.co_name), + level=ch_core.hookenv.INFO) + + @when('endpoint.{endpoint_name}.broken') + def broken(self): + super().broken() diff --git a/src/ovsdb/interface.yaml b/src/ovsdb/interface.yaml new file mode 100644 index 0000000..74ac479 --- /dev/null +++ b/src/ovsdb/interface.yaml @@ -0,0 +1,11 @@ +name: ovsdb +summary: Interface for OVSDB +maintainer: OpenStack Charmers +repo: https://github.com/openstack-charmers/charm-interface-ovsdb.git +ignore: + - 'unit_tests' + - '.stestr.conf' + - 'test-requirements.txt' + - 'tox.ini' + - '.gitignore' + - '.travis.yml' diff --git a/src/ovsdb/lib b/src/ovsdb/lib new file mode 120000 index 0000000..dc598c5 --- /dev/null +++ b/src/ovsdb/lib @@ -0,0 +1 @@ +../lib \ No newline at end of file diff --git a/src/ovsdb/provides.py b/src/ovsdb/provides.py new file mode 100644 index 0000000..ffeaef9 --- /dev/null +++ b/src/ovsdb/provides.py @@ -0,0 +1,42 @@ +# 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. + +# the reactive framework unfortunately does not grok `import as` in conjunction +# with decorators on class instance methods, so we have to revert to `from ...` +# imports + +import inspect + +import charmhelpers.core as ch_core + +from charms.reactive import ( + when, +) + +from .lib import ovsdb as ovsdb + + +class OVSDBProvides(ovsdb.OVSDB): + + @when('endpoint.{endpoint_name}.joined') + def joined(self): + ch_core.hookenv.log('{}: {} -> {}' + .format(self._endpoint_name, + type(self).__name__, + inspect.currentframe().f_code.co_name), + level=ch_core.hookenv.INFO) + + @when('endpoint.{endpoint_name}.broken') + def broken(self): + super().broken() diff --git a/src/ovsdb/requires.py b/src/ovsdb/requires.py new file mode 100644 index 0000000..11d0718 --- /dev/null +++ b/src/ovsdb/requires.py @@ -0,0 +1,42 @@ +# 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. + +# the reactive framework unfortunately does not grok `import as` in conjunction +# with decorators on class instance methods, so we have to revert to `from ...` +# imports + +import inspect + +import charmhelpers.core as ch_core + +from charms.reactive import ( + when, +) + +from .lib import ovsdb as ovsdb + + +class OVSDBRequires(ovsdb.OVSDB): + + @when('endpoint.{endpoint_name}.joined') + def joined(self): + ch_core.hookenv.log('{}: {} -> {}' + .format(self._endpoint_name, + type(self).__name__, + inspect.currentframe().f_code.co_name), + level=ch_core.hookenv.INFO) + + @when('endpoint.{endpoint_name}.broken') + def broken(self): + super().broken() diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..ac58161 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,7 @@ +# Lint and unit test requirements +flake8 +os-testr>=0.4.1 +charms.reactive +mock>=1.2 +coverage>=3.6 +git+https://github.com/openstack/charms.openstack.git#egg=charms.openstack diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..bf2661b --- /dev/null +++ b/tox.ini @@ -0,0 +1,38 @@ +[tox] +skipsdist = True +envlist = pep8,py3 +skip_missing_interpreters = True + +[testenv] +setenv = VIRTUAL_ENV={envdir} + PYTHONHASHSEED=0 + TERM=linux +install_command = + pip install {opts} {packages} + +[testenv:py3] +basepython = python3 +deps = -r{toxinidir}/test-requirements.txt +commands = ostestr {posargs} + +[testenv:py35] +basepython = python3.5 +deps = -r{toxinidir}/test-requirements.txt +commands = ostestr {posargs} + +[testenv:py36] +basepython = python3.6 +deps = -r{toxinidir}/test-requirements.txt +commands = ostestr {posargs} + +[testenv:pep8] +basepython = python3 +deps = -r{toxinidir}/test-requirements.txt +commands = flake8 {posargs} + +[testenv:venv] +commands = {posargs} + +[flake8] +# E402 ignore necessary for path append before sys module import in actions +ignore = E402 diff --git a/unit_tests/__init__.py b/unit_tests/__init__.py new file mode 100644 index 0000000..7b5dac4 --- /dev/null +++ b/unit_tests/__init__.py @@ -0,0 +1,22 @@ +# 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. + +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() diff --git a/unit_tests/test_lib_ovsdb.py b/unit_tests/test_lib_ovsdb.py new file mode 100644 index 0000000..ea02f56 --- /dev/null +++ b/unit_tests/test_lib_ovsdb.py @@ -0,0 +1,152 @@ +# 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 mock + +from lib import ovsdb + +import charms_openstack.test_utils as test_utils + + +_hook_args = {} + + +class TestNeutronLoadBalancerRequires(test_utils.PatchHelper): + + def setUp(self): + super().setUp() + self.target = ovsdb.OVSDB('some-relation', []) + self._patches = {} + self._patches_start = {} + + def tearDown(self): + self.target = None + for k, v in self._patches.items(): + v.stop() + setattr(self, k, None) + self._patches = None + self._patches_start = None + + def patch_target(self, attr, return_value=None): + mocked = mock.patch.object(self.target, attr) + self._patches[attr] = mocked + started = mocked.start() + started.return_value = return_value + self._patches_start[attr] = started + setattr(self, attr, started) + + def patch_topublish(self): + self.patch_target('_relations') + relation = mock.MagicMock() + to_publish = mock.PropertyMock() + type(relation).to_publish = to_publish + self._relations.__iter__.return_value = [relation] + return relation.to_publish + + def test_cluster_local_addr(self): + relation = mock.MagicMock() + relation.relation_id = 'some-endpoint:42' + self.patch_target('_relations') + self._relations.__iter__.return_value = [relation] + self.patch_target('expand_name') + self.expand_name.return_value = 'some-relation' + self.patch_object(ovsdb.ch_core.hookenv, 'network_get') + self.network_get.return_value = { + 'bind-addresses': [ + { + 'macaddress': '', + 'interfacename': '', + 'addresses': [ + { + 'hostname': '', + 'address': '42.42.42.42', + 'cidr': '' + }, + ], + }, + ], + 'egress-subnets': ['42.42.42.42/32'], + 'ingress-addresses': ['42.42.42.42'], + } + self.assertEquals(self.target.cluster_local_addr, '42.42.42.42') + self.network_get.assert_called_once_with( + 'some-relation', relation_id='some-endpoint:42') + + def test_cluster_addrs(self): + + def _assert_generator(iterable, expect): + for value in iterable: + self.assertEquals(value, expect) + + relation = mock.MagicMock() + relation.relation_id = 'some-endpoint:42' + unit = mock.MagicMock() + relation.units.__iter__.return_value = [unit] + self.patch_target('_relations') + self._relations.__iter__.return_value = [relation] + unit.received.get.return_value = '127.0.0.1' + _assert_generator(self.target.cluster_addrs, '127.0.0.1') + unit.received.get.assert_called_once_with('bound-address', '') + unit.received.get.return_value = '::1' + _assert_generator(self.target.cluster_addrs, '[::1]') + + def test_expected_peers_available(self): + # self.patch_target('_all_joined_units') + self.patch_object(ovsdb.ch_core.hookenv, 'expected_peer_units') + self.patch_target('_relations') + self.target._all_joined_units = ['aFakeUnit'] + self.expected_peer_units.return_value = ['aFakeUnit'] + relation = mock.MagicMock() + unit = mock.MagicMock() + relation.units.__iter__.return_value = [unit] + self._relations.__iter__.return_value = [relation] + unit.received.get.return_value = '127.0.0.1' + self.assertTrue(self.target.expected_peers_available()) + unit.received.get.assert_called_once_with('bound-address') + unit.received.get.return_value = '' + self.assertFalse(self.target.expected_peers_available()) + self.expected_peer_units.return_value = ['firstFakeUnit', + 'secondFakeUnit'] + unit.received.get.return_value = '127.0.0.1' + self.assertFalse(self.target.expected_peers_available()) + + def test_publish_cluster_local_addr(self): + to_publish = self.patch_topublish() + self.target.publish_cluster_local_addr() + to_publish.__setitem__.assert_called_once_with('bound-address', None) + + def test_joined(self): + self.patch_object(ovsdb.reactive, 'set_flag') + self.patch_target('publish_cluster_local_addr') + self.patch_target('expected_peers_available') + self.expected_peers_available.__bool__.return_value = False + self.target.joined() + self.expected_peers_available.__bool__.assert_called_once_with() + self.set_flag.assert_called_once_with('some-relation.connected') + self.publish_cluster_local_addr.assert_called_once_with() + self.set_flag.reset_mock() + self.expected_peers_available.__bool__.return_value = True + self.target.joined() + self.set_flag.assert_has_calls([ + mock.call('some-relation.connected'), + mock.call('some-relation.available'), + ]) + + def test_broken(self): + self.patch_object(ovsdb.reactive, 'clear_flag') + self.target.broken() + self.clear_flag.assert_has_calls([ + mock.call('some-relation.available'), + mock.call('some-relation.connected'), + ])