commit 5acafe3b04e2b2533587cdfb68b3eb0754e48705 Author: Frode Nordahl Date: Fri Sep 27 15:44:32 2019 +0200 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2f71a88 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +.tox +.stestr +*__pycache__* +*.pyc +build +interfaces +layers +*.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/requirements.txt b/requirements.txt new file mode 100644 index 0000000..20f335d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +# This file is managed centrally. If you find the need to modify this as a +# one-off, please don't. Intead, consult #openstack-charms and ask about +# requirements management in charms via bot-control. Thank you. +# +# Build requirements +charm-tools>=2.4.4 +simplejson diff --git a/src/HACKING.md b/src/HACKING.md new file mode 100644 index 0000000..b63d1f8 --- /dev/null +++ b/src/HACKING.md @@ -0,0 +1,7 @@ +# Overview + +This charm is developed as part of the OpenStack Charms project, and as such you +should refer to the [OpenStack Charm Development Guide](https://github.com/openstack/charm-guide) for details on how +to contribute to this charm. + +You can find its source code here: . diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..0152e31 --- /dev/null +++ b/src/README.md @@ -0,0 +1,15 @@ +# Overview + +OVN provides open source network virtualization for Open vSwitch (OVS). + +Subordinate charm that deploys the ``networking-ovn`` component on +``neutron-api`` units and augments Neutron's configuration for use with +the OVN ML2 plugin. + +# Usage + +# Bugs + +Please report bugs on [Launchpad](https://bugs.launchpad.net/charm-neutron-api-plugin-ovn/+filebug). + +For general questions please refer to the OpenStack [Charm Guide](https://docs.openstack.org/charm-guide/latest/). diff --git a/src/copyright b/src/copyright new file mode 100644 index 0000000..8aa5eea --- /dev/null +++ b/src/copyright @@ -0,0 +1,6 @@ +Format: http://dep.debian.net/deps/dep5/ + +Files: * +Copyright: Copyright 2019, Canonical Ltd +License: Apache-2.0 + diff --git a/src/icon.svg b/src/icon.svg new file mode 100644 index 0000000..dcefac0 --- /dev/null +++ b/src/icon.svg @@ -0,0 +1,191 @@ + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + OVN + + + + + + + + + + + + diff --git a/src/layer.yaml b/src/layer.yaml new file mode 100644 index 0000000..9985d6c --- /dev/null +++ b/src/layer.yaml @@ -0,0 +1,13 @@ +includes: + - layer:leadership + - layer:openstack + - interface:ovsdb-cms + - interface:neutron-plugin-api-subordinate +options: + basic: + use_venv: True + include_system_packages: False +repo: https://github.com/openstack/charm-neutron-api-plugin-ovn +config: + deletes: + - verbose 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/charm/__init__.py b/src/lib/charm/__init__.py new file mode 100644 index 0000000..5705e5d --- /dev/null +++ b/src/lib/charm/__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/charm/openstack/__init__.py b/src/lib/charm/openstack/__init__.py new file mode 100644 index 0000000..5705e5d --- /dev/null +++ b/src/lib/charm/openstack/__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/charm/openstack/neutron_api_plugin_ovn.py b/src/lib/charm/openstack/neutron_api_plugin_ovn.py new file mode 100644 index 0000000..ac5a156 --- /dev/null +++ b/src/lib/charm/openstack/neutron_api_plugin_ovn.py @@ -0,0 +1,31 @@ +# 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 os +import subprocess + +import charms.reactive as reactive + +import charmhelpers.core as ch_core + +import charms_openstack.adapters +import charms_openstack.charm + + +class NeutronAPIPluginOvn(charms_openstack.charm.OpenStackCharm): + release = 'train' + name = 'ovn' + packages = ['python3-networking-ovn'] + required_relations = ['neutron-plugin', 'ovsdb-cms'] + python_version = 3 diff --git a/src/metadata.yaml b/src/metadata.yaml new file mode 100644 index 0000000..4a89a24 --- /dev/null +++ b/src/metadata.yaml @@ -0,0 +1,23 @@ +name: neutron-api-plugin-ovn +summary: Neutron OVN ML2 plugin +maintainer: OpenStack Charmers +description: | + Subordinate charm that deploys the ``networking-ovn`` component on + ``neutron-api`` units and augments Neutron's configuration for use with + the OVN ML2 plugin. +tags: + - networking +series: + - bionic + - disco +subordinate: true +requires: + container: + interface: juju-info + scope: container + ovsdb-cms: + interface: ovsdb-cms +provides: + neutron-plugin: + interface: neutron-plugin-api-subordinate + scope: container diff --git a/src/reactive/__init__.py b/src/reactive/__init__.py new file mode 100644 index 0000000..5705e5d --- /dev/null +++ b/src/reactive/__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/reactive/neutron_api_plugin_ovn_handlers.py b/src/reactive/neutron_api_plugin_ovn_handlers.py new file mode 100644 index 0000000..05371d2 --- /dev/null +++ b/src/reactive/neutron_api_plugin_ovn_handlers.py @@ -0,0 +1,89 @@ +# 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 charmhelpers.core as ch_core + +import charms.reactive as reactive +import charms.leadership as leadership + +import charms_openstack.bus +import charms_openstack.charm as charm + + +charms_openstack.bus.discover() + +# Use the charms.openstack defaults for common states and hooks +charm.use_defaults( + 'charm.installed', + 'config.changed', + 'update-status', + 'upgrade-charm', + 'certificates.available', +) + + +@reactive.when_none('neutron-plugin.db_migration', + 'neutron-plugin.available') +@reactive.when('charm.installed') +def flag_db_migration(): + reactive.set_flag('neutron-plugin.db_migration') + + +@reactive.when_none('neutron-plugin.available', 'run-default-update-status') +@reactive.when('neutron-plugin.connected') +def request_db_migration(): + neutron = reactive.endpoint_from_flag('neutron-plugin.connected') + neutron.request_db_migration() + + +@reactive.when('neutron-plugin.connected') +def configure_neutron(): + neutron = reactive.endpoint_from_flag( + 'neutron-plugin.connected') + ch_core.hookenv.log('DEBUG: neutron_config_data="{}"' + .format(neutron.neutron_config_data)) + neutron.configure_plugin( + 'ovn', + subordinate_configuration={ + 'neutron-api': { + '/etc/neutron/neutron.conf': { + 'sections': { + 'blablabla': [ + ('neutron_conf_key1', 'val1'), + ], + }, + }, + '/etc/neutron/plugins/ml2/ml2_conf.ini': { + 'sections': { + 'ovn': [ + ('ml2_conf_key1', 'val1'), + ], + }, + }, + }, + }, + ) + + +@reactive.when('neutron-plugin.available') +def assess_status(): + with charm.provide_charm_instance() as instance: + instance.assess_status() + + +@reactive.when('ovsdb-cms.available') +def poke_ovsdb(): + ovsdb = reactive.endpoint_from_flag('ovsdb-cms.available') + ch_core.hookenv.log('DEBUG: cluster_remote_addrs="{}"' + .format(list(ovsdb.cluster_remote_addrs))) diff --git a/src/test-requirements.txt b/src/test-requirements.txt new file mode 100644 index 0000000..5a78c3e --- /dev/null +++ b/src/test-requirements.txt @@ -0,0 +1,11 @@ +# This file is managed centrally. If you find the need to modify this as a +# one-off, please don't. Intead, consult #openstack-charms and ask about +# requirements management in charms via bot-control. Thank you. +charm-tools>=2.4.4 +coverage>=3.6 +mock>=1.2 +flake8>=2.2.4,<=2.4.1 +stestr>=2.2.0 +requests>=2.18.4 +git+https://github.com/openstack-charmers/zaza.git#egg=zaza +git+https://github.com/openstack-charmers/zaza-openstack-tests.git@add-ovn#egg=zaza.openstack diff --git a/src/tests/bundles/bionic-stein.yaml b/src/tests/bundles/bionic-stein.yaml new file mode 100644 index 0000000..44e1f67 --- /dev/null +++ b/src/tests/bundles/bionic-stein.yaml @@ -0,0 +1,55 @@ +series: bionic +applications: + keystone: + charm: cs:~openstack-charmers-next/keystone + num_units: 1 + options: + openstack-origin: cloud:bionic-stein + mysql: + charm: cs:~openstack-charmers-next/percona-cluster + num_units: 1 + neutron-api: + series: bionic + charm: /home/frode/Projects/OpenStack/charm-neutron-api + num_units: 3 + options: + manage-neutron-plugin-legacy-mode: false + openstack-origin: cloud:bionic-stein + neutron-api-plugin-ovn: + series: bionic + charm: neutron-api-plugin-ovn + rabbitmq-server: + charm: cs:~openstack-charmers-next/rabbitmq-server + num_units: 1 + vault: + charm: cs:~openstack-charmers-next/vault + num_units: 1 + ovn: + series: bionic + charm: /home/frode/Projects/OpenStack/charm-ovn/build/builds/ovn + num_units: 3 + options: + source: cloud:bionic-train +relations: +- - mysql:shared-db + - keystone:shared-db +- - mysql:shared-db + - neutron-api:shared-db +- - neutron-api:amqp + - rabbitmq-server:amqp +- - neutron-api:identity-service + - keystone:identity-service +- - neutron-api-plugin-ovn:neutron-plugin + - neutron-api:neutron-plugin-api-subordinate +- - neutron-api-plugin-ovn:ovsdb-cms + - ovn:ovsdb-cms +- - vault:shared-db + - mysql:shared-db +- - ovn:certificates + - vault:certificates +- - neutron-api-plugin-ovn:certificates + - vault:certificates +- - keystone:certificates + - vault:certificates +- - neutron-api:certificates + - vault:certificates diff --git a/src/tests/tests.yaml b/src/tests/tests.yaml new file mode 100644 index 0000000..80ba55e --- /dev/null +++ b/src/tests/tests.yaml @@ -0,0 +1,17 @@ +charm_name: neutron-api-plugin-ovn +smoke_bundles: +- bionic-stein +target_deploy_status: + neutron-api-plugin-ovn: + workload-status: waiting + workload-status-message: "'ovsdb-cms' incomplete" + ovn: + workload-status: blocked + workload-status-message: "'certificates' missing" + vault: + workload-status: blocked + workload-status-message: Vault needs to be initialized +configure: +- zaza.openstack.charm_tests.vault.setup.auto_initialize +tests: +- zaza.charm_tests.noop.tests.NoopTest diff --git a/src/tox.ini b/src/tox.ini new file mode 100644 index 0000000..ce45106 --- /dev/null +++ b/src/tox.ini @@ -0,0 +1,35 @@ +[tox] +envlist = pep8 +skipsdist = True + +[testenv] +setenv = VIRTUAL_ENV={envdir} + PYTHONHASHSEED=0 +whitelist_externals = juju +passenv = HOME TERM CS_API_* OS_* AMULET_* +deps = -r{toxinidir}/test-requirements.txt +install_command = + pip install {opts} {packages} + +[testenv:pep8] +basepython = python3 +deps=charm-tools +commands = charm-proof + +[testenv:func-noop] +basepython = python3 +commands = + true + +[testenv:func] +basepython = python3 +commands = + functest-run-suite --keep-model + +[testenv:func-smoke] +basepython = python3 +commands = + functest-run-suite --keep-model --smoke + +[testenv:venv] +commands = {posargs} diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..14b380e --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,13 @@ +# This file is managed centrally. If you find the need to modify this as a +# one-off, please don't. Intead, consult #openstack-charms and ask about +# requirements management in charms via bot-control. Thank you. +# +# Lint and unit test requirements +flake8>=2.2.4,<=2.4.1 +stestr>=2.2.0 +requests>=2.18.4 +charms.reactive +mock>=1.2 +nose>=1.3.7 +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..23750a8 --- /dev/null +++ b/tox.ini @@ -0,0 +1,80 @@ +# Source charm: ./tox.ini +# This file is managed centrally by release-tools and should not be modified +# within individual charm repos. +[tox] +skipsdist = True +envlist = pep8,py3 + +[testenv] +setenv = VIRTUAL_ENV={envdir} + PYTHONHASHSEED=0 + TERM=linux + CHARM_LAYERS_DIR={toxinidir}/layers + CHARM_INTERFACES_DIR={toxinidir}/interfaces + JUJU_REPOSITORY={toxinidir}/build +passenv = http_proxy https_proxy INTERFACE_PATH +install_command = + pip install {opts} {packages} +deps = + -r{toxinidir}/requirements.txt + +[testenv:build] +basepython = python3 +commands = + charm-build --log-level DEBUG -o {toxinidir}/build src {posargs} + +[testenv:py3] +basepython = python3 +deps = -r{toxinidir}/test-requirements.txt +commands = stestr run {posargs} + +[testenv:py35] +basepython = python3.5 +deps = -r{toxinidir}/test-requirements.txt +commands = stestr run {posargs} + +[testenv:py36] +basepython = python3.6 +deps = -r{toxinidir}/test-requirements.txt +commands = stestr run {posargs} + +[testenv:pep8] +basepython = python3 +deps = -r{toxinidir}/test-requirements.txt +commands = flake8 {posargs} src unit_tests + +[testenv:cover] +# Technique based heavily upon +# https://github.com/openstack/nova/blob/master/tox.ini +basepython = python3 +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt +setenv = + {[testenv]setenv} + PYTHON=coverage run +commands = + coverage erase + stestr run {posargs} + coverage combine + coverage html -d cover + coverage xml -o cover/coverage.xml + coverage report + +[coverage:run] +branch = True +concurrency = multiprocessing +parallel = True +source = + . +omit = + .tox/* + */charmhelpers/* + unit_tests/* + +[testenv:venv] +basepython = python3 +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..cc7e9a5 --- /dev/null +++ b/unit_tests/__init__.py @@ -0,0 +1,39 @@ +# 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() + +import mock +import charms +charms.leadership = mock.MagicMock() +keystoneauth1 = mock.MagicMock() +neutronclient = mock.MagicMock() +sys.modules['charms.leadership'] = charms.leadership +keystoneauth1 = mock.MagicMock() +novaclient = mock.MagicMock() +neutron_lib = mock.MagicMock() +sys.modules['charms.leadership'] = charms.leadership +sys.modules['keystoneauth1'] = keystoneauth1 +sys.modules['novaclient'] = novaclient +sys.modules['neutronclient'] = neutronclient +sys.modules['neutronclient.v2_0'] = neutronclient.v2_0 +sys.modules['neutron_lib'] = neutron_lib +sys.modules['neutron_lib.constants'] = neutron_lib.constants diff --git a/unit_tests/test_lib_charm_openstack_ovn.py b/unit_tests/test_lib_charm_openstack_ovn.py new file mode 100644 index 0000000..7c549f8 --- /dev/null +++ b/unit_tests/test_lib_charm_openstack_ovn.py @@ -0,0 +1,159 @@ +# 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 +import os + +import charms_openstack.test_utils as test_utils + +import charm.openstack.ovn as ovn + + +class TestOVNConfigProperties(test_utils.PatchHelper): + + def test_cluster_local_addr(self): + self.patch_object(ovn.ch_core.hookenv, 'unit_get') + cls = mock.MagicMock() + self.assertEquals(ovn.cluster_local_addr(cls), self.unit_get()) + + def test_db_nb_port(self): + cls = mock.MagicMock() + self.assertEquals(ovn.db_nb_port(cls), ovn.DB_NB_PORT) + + def test_db_sb_port(self): + cls = mock.MagicMock() + self.assertEquals(ovn.db_sb_port(cls), ovn.DB_SB_PORT) + + +class Helper(test_utils.PatchHelper): + + def setUp(self): + super().setUp() + self.patch_release(ovn.OVNCharm.release) + + +class TestOVNCharm(Helper): + + def test_install(self): + self.patch_object(ovn.charms_openstack.charm.OpenStackCharm, + 'install') + self.patch_object(ovn.os.path, 'islink') + self.islink.return_value = False + self.patch_object(ovn.os, 'symlink') + c = ovn.OVNCharm() + c.install() + self.islink.assert_called_once_with( + '/etc/systemd/system/ovn-central.service') + self.symlink.assert_called_once_with( + '/dev/null', + '/etc/systemd/system/ovn-central.service') + self.install.assert_called_once_with() + + def test__default_port_list(self): + c = ovn.OVNCharm() + self.assertEquals( + c._default_port_list(), + [ovn.DB_NB_PORT, ovn.DB_SB_PORT]) + + def test_ports_to_check(self): + c = ovn.OVNCharm() + c._default_port_list = mock.MagicMock() + c.ports_to_check() + c._default_port_list.assert_called_once_with() + + def test_enable_services(self): + self.patch_object(ovn.ch_core.host, 'service_resume') + c = ovn.OVNCharm() + c.check_if_paused = mock.MagicMock() + c.check_if_paused.return_value = ('status', 'message') + c.enable_services() + c.check_if_paused.assert_called_once_with() + self.assertFalse(self.service_resume.called) + c.check_if_paused.return_value = (None, None) + c.enable_services() + self.service_resume.assert_called_once_with('ovn-central') + + def test_ovs_controller_cert(self): + c = ovn.OVNCharm() + self.assertEquals( + c.ovs_controller_cert, + os.path.join(ovn.OVS_ETCDIR, 'cert_host')) + + def test_ovs_controller_key(self): + c = ovn.OVNCharm() + self.assertEquals( + c.ovs_controller_key, + os.path.join(ovn.OVS_ETCDIR, 'key_host')) + + def test_run(self): + self.patch_object(ovn.subprocess, 'run') + self.patch_object(ovn.ch_core.hookenv, 'log') + c = ovn.OVNCharm() + c.run('some', 'args') + self.run.assert_called_once_with( + ('some', 'args'), + stdout=ovn.subprocess.PIPE, + stderr=ovn.subprocess.STDOUT, + check=True, + universal_newlines=True) + + def test_configure_tls(self): + self.patch_object(ovn.ch_core.hookenv, 'service_name') + self.service_name.return_value = 'fakeservice' + self.patch_object(ovn.charms_openstack.charm.OpenStackCharm, + 'configure_tls') + self.configure_tls.return_value = [{ + 'cert': 'fakecert', + 'key': 'fakekey', + 'cn': 'fakecn', + }] + c = ovn.OVNCharm() + c.configure_cert = mock.MagicMock() + c.run = mock.MagicMock() + c.configure_tls() + self.configure_tls.assert_called_once_with(certificates_interface=None) + c.configure_cert.assert_called_once_with( + ovn.OVS_ETCDIR, + 'fakecert', + 'fakekey', + cn='host') + c.run.assert_has_calls([ + mock.call('ovs-vsctl', + 'set-ssl', + '/etc/openvswitch/key_host', + '/etc/openvswitch/cert_host', + '/usr/local/share/ca-certificates/fakeservice.crt'), + mock.call('ovn-nbctl', + 'set-ssl', + '/etc/openvswitch/key_host', + '/etc/openvswitch/cert_host', + '/usr/local/share/ca-certificates/fakeservice.crt'), + mock.call('ovn-sbctl', + 'set-ssl', + '/etc/openvswitch/key_host', + '/etc/openvswitch/cert_host', + '/usr/local/share/ca-certificates/fakeservice.crt'), + mock.call('ovn-nbctl', + 'set-connection', + 'pssl:6641'), + mock.call('ovn-sbctl', + 'set-connection', + 'role=ovn-controller', + 'pssl:6642'), + mock.call('ovs-vsctl', + 'set', + 'open', + '.', + 'external-ids:ovn-remote=ssl:127.0.0.1:6642') + ]) diff --git a/unit_tests/test_reactive_ovn_handlers.py b/unit_tests/test_reactive_ovn_handlers.py new file mode 100644 index 0000000..ee3e2a1 --- /dev/null +++ b/unit_tests/test_reactive_ovn_handlers.py @@ -0,0 +1,73 @@ +# 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 + +import reactive.ovn_handlers as handlers + +import charms_openstack.test_utils as test_utils + + +class TestRegisteredHooks(test_utils.TestRegisteredHooks): + + def test_hooks(self): + defaults = [ + 'charm.installed', + 'config.changed', + 'update-status', + 'upgrade-charm', + ] + hook_set = { + 'when': { + 'render': ('charm.installed',), + 'certificates_in_config_tls': ('config.rendered', + 'config.changed',), + }, + 'when_not_all': { + 'certificates_in_config_tls': ('config.default.ssl_ca', + 'config.default.ssl_cert', + 'config.default.ssl_key',), + }, + } + # test that the hooks were registered via the + # reactive.ovn_handlers + self.registered_hooks_test_helper(handlers, hook_set, defaults) + + +class TestOvnHandlers(test_utils.PatchHelper): + + def setUp(self): + super().setUp() + # self.patch_release(octavia.OctaviaCharm.release) + self.charm = mock.MagicMock() + self.patch_object(handlers.charm, 'provide_charm_instance', + new=mock.MagicMock()) + self.provide_charm_instance().__enter__.return_value = \ + self.charm + self.provide_charm_instance().__exit__.return_value = None + + def test_render(self): + self.patch_object(handlers.charm, 'use_defaults') + self.patch_object(handlers.reactive, 'set_flag') + self.charm.enable_services.return_value = False + handlers.render() + self.charm.render_with_interfaces.assert_called_once_with([]) + self.charm.enable_services.assert_called_once_with() + self.assertFalse(self.use_defaults.called) + self.assertFalse(self.set_flag.called) + self.charm.assess_status.assert_called_once_with() + self.charm.enable_services.return_value = True + handlers.render() + self.use_defaults.assert_called_once_with('certificates.available') + self.set_flag.assert_called_once_with('config.rendered')