diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b44e2dc --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +bin +.coverage +.testrepository +.tox +tags +*.sw[nop] +*.pyc +.unit-state.db +trusty/ +xenial/ +.stestr +__pycache__ +func-results.json 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..49be5e1 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Overview + +This is a "source" charm, which is intended to be strictly the top +layer of a built charm. This structure declares that any included +layer assets are not intended to be consumed as a layer from a +functional or design standpoint. + +# Test and Build + +Building, pushing and publishing to the charm store is automated +by CI to ensure consistent flow. Manually building is useful for +development and testing, however. + +``` +tox -e pep8 +tox -e py34 # or py27 or py35 +tox -e build +``` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6fe3090 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +# Requirements to build the charm +charm-tools +simplejson +flake8 diff --git a/src/README.ex b/src/README.ex index e69de29..a316953 100644 --- a/src/README.ex +++ b/src/README.ex @@ -0,0 +1,22 @@ +# Overview + +This principle charm provides the Arista ML2 Plugin support to the OpenStack +Neutron API service. + +When this charm is related to the neutron-api charm it will install the +Arista Neutron packages on each neutron-api unit in the region and supply the +desired configuration to the neutron-api service. + +# Usage + +To deploy (partial deployment only): + + juju deploy neutron-api + juju deploy neutron-openvswitch + juju deploy neutron-arista + + juju add-relation neutron-api neutron-arista + juju add-relation neutron-api mysql + juju add-relation neutron-api rabbitmq-server + juju add-relation neutron-api neutron-openvswitch + juju add-relation neutron-api nova-cloud-controller diff --git a/src/lib/charm/openstack/neutron_arista.py b/src/lib/charm/openstack/neutron_arista.py index 4b72a3a..6e0f1ac 100644 --- a/src/lib/charm/openstack/neutron_arista.py +++ b/src/lib/charm/openstack/neutron_arista.py @@ -37,6 +37,23 @@ class NeutronAristaCharm(charms_openstack.charm.OpenStackCharm): # List of packages to install for this charm packages = ['python-networking-arista'] + def write_config(self): + configs = self.register_configs() + configs.write_all() + + def register_configs(release=None): + resources = OrderedDict([ + (ML2_CONFIG, { + 'services': ['neutron-server'], + 'contexts': [AristaMl2Context(), ] + }), + ]) + release = os_release('neutron-common') + configs = templating.OSConfigRenderer(templates_dir=TEMPLATES, + openstack_release=release) + for cfg, rscs in resources.items(): + configs.register(cfg, rscs['contexts']) + return configs class AristaMl2Context(context.OSContextGenerator): @@ -48,18 +65,3 @@ class AristaMl2Context(context.OSContextGenerator): 'api_type': config('api-type'), 'arista_version': config('arista-version')} return ctxt - - -def register_configs(release=None): - resources = OrderedDict([ - (ML2_CONFIG, { - 'services': ['neutron-server'], - 'contexts': [AristaMl2Context(), ] - }), - ]) - release = os_release('neutron-common') - configs = templating.OSConfigRenderer(templates_dir=TEMPLATES, - openstack_release=release) - for cfg, rscs in resources.items(): - configs.register(cfg, rscs['contexts']) - return configs diff --git a/src/reactive/neutron_arista_handlers.py b/src/reactive/neutron_arista_handlers.py index cbd9035..d10adc6 100644 --- a/src/reactive/neutron_arista_handlers.py +++ b/src/reactive/neutron_arista_handlers.py @@ -24,7 +24,6 @@ from charms_openstack.charm import ( import charm.openstack.neutron_arista as arista # noqa from charm.openstack.neutron_arista import register_configs -CONFIGS = register_configs() use_defaults('update-status') @@ -41,7 +40,8 @@ def configure_principle(api_principle): } } } - CONFIGS.write_all() + with provide_charm_instance() as charm_class: + charm_class.write_config() api_principle.configure_plugin( neutron_plugin='arista', core_plugin='neutron.plugins.ml2.plugin.Ml2Plugin', diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..9a0bed8 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,7 @@ +# Unit test requirements +flake8>=2.2.4,<=2.4.1 +os-testr>=0.4.1 +charms.reactive +mock>=1.2 +coverage>=3.6 +git+https://github.com/openstack/charms.openstack#egg=charms.openstack diff --git a/unit_tests/__init__.py b/unit_tests/__init__.py new file mode 100644 index 0000000..3ee8c94 --- /dev/null +++ b/unit_tests/__init__.py @@ -0,0 +1,37 @@ +# Copyright 2016 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 +import mock + +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() +sys.modules['charmhelpers.core.decorators'] = ( + charms_openstack.test_mocks.charmhelpers.core.decorators) + + +def _fake_retry(num_retries, base_delay=0, exc_type=Exception): + def _retry_on_exception_inner_1(f): + def _retry_on_exception_inner_2(*args, **kwargs): + return f(*args, **kwargs) + return _retry_on_exception_inner_2 + return _retry_on_exception_inner_1 + +mock.patch( + 'charmhelpers.core.decorators.retry_on_exception', + _fake_retry).start() diff --git a/unit_tests/test_lib_charm_openstack_neutron_arista.py b/unit_tests/test_lib_charm_openstack_neutron_arista.py new file mode 100644 index 0000000..c2adc13 --- /dev/null +++ b/unit_tests/test_lib_charm_openstack_neutron_arista.py @@ -0,0 +1,77 @@ +# Copyright 2016 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 __future__ import absolute_import +from __future__ import print_function + +import contextlib +import unittest + +import mock + +import charm.openstack.neutron_arista as neutron_arista + + +def FakeConfig(init_dict): + + def _config(key=None): + return init_dict[key] if key else init_dict + + return _config + + +class Helper(unittest.TestCase): + + def setUp(self): + self._patches = {} + self._patches_start = {} + self.ch_config_patch = mock.patch('charmhelpers.core.hookenv.config') + self.ch_config = self.ch_config_patch.start() + self.ch_config.side_effect = lambda: {'ssl_param': None} + + def tearDown(self): + for k, v in self._patches.items(): + v.stop() + setattr(self, k, None) + self._patches = None + self._patches_start = None + self.ch_config_patch.stop() + + def patch(self, obj, attr, return_value=None, **kwargs): + mocked = mock.patch.object(obj, attr, **kwargs) + self._patches[attr] = mocked + started = mocked.start() + started.return_value = return_value + self._patches_start[attr] = started + setattr(self, attr, started) + + def patch_object(self, obj, attr, return_value=None, name=None, new=None): + if name is None: + name = attr + if new is not None: + mocked = mock.patch.object(obj, attr, new=new) + else: + mocked = mock.patch.object(obj, attr) + self._patches[name] = mocked + started = mocked.start() + if new is None: + started.return_value = return_value + self._patches_start[name] = started + setattr(self, name, started) + + +class TestNeutronAristaCharm(Helper): + + def test_write_config(self): + pass diff --git a/unit_tests/test_neutron_arista_handlers.py b/unit_tests/test_neutron_arista_handlers.py new file mode 100644 index 0000000..c72ca00 --- /dev/null +++ b/unit_tests/test_neutron_arista_handlers.py @@ -0,0 +1,41 @@ +import mock + +import reactive.designate_handlers as handlers + +import charms_openstack.test_utils as test_utils + + +class TestRegisteredHooks(test_utils.TestRegisteredHooks): + + def test_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. + all_interfaces = ( + 'neutron-plugin-api-subordinate.connected', ) + hook_set = { + 'when': { + 'configure_principle': ( + 'neutron-plugin-api-subordinate.connected', ), + } + } + # test that the hooks were registered via the + # reactive.barbican_handlers + self.registered_hooks_test_helper(handlers, hook_set, []) + + +class TestHandlers(test_utils.PatchHelper): + + def _patch_provide_charm_instance(self): + the_charm = mock.MagicMock() + self.patch_object(handlers, 'provide_charm_instance', + name='provide_charm_instance', + new=mock.MagicMock()) + self.provide_charm_instance().__enter__.return_value = the_charm + self.provide_charm_instance().__exit__.return_value = None + return the_charm + + def test_configure_principal(self): + the_charm = self._patch_provide_charm_instance() + handlers.configure_principle('neutron-api') + the_charm.write_config.assert_called_once_with()