From 39d9cb5977634d467cba7b3421a07a82186e4e90 Mon Sep 17 00:00:00 2001 From: Gabriel Adrian Samfira Date: Wed, 16 Sep 2020 13:04:52 +0000 Subject: [PATCH] Allign project layout with OS reactive charms --- .stestr.conf | 4 + .zuul.yaml | 4 + LICENSE | 202 ++++++++++++++++++ docs/.keep | 0 rebuild | 5 + requirements.txt | 11 + src/README.md | 1 + src/config.yaml | 21 ++ src/layer.yaml | 7 + src/lib/charm/openstack/neutron_ironic.py | 36 ++++ src/metadata.yaml | 22 ++ src/reactive/neutron_ironic_handlers.py | 68 ++++++ ...utron_plugins_ml2_ironic_neutron_agent.ini | 34 +++ src/test-requirements.txt | 8 + src/tox.ini | 50 +++++ test-requirements.txt | 24 +++ tox.ini | 97 +++++++++ unit_tests/__init__.py | 37 ++++ unit_tests/test_neutron_ironic_handlers.py | 48 +++++ 19 files changed, 679 insertions(+) create mode 100644 .stestr.conf create mode 100644 .zuul.yaml create mode 100644 LICENSE create mode 100644 docs/.keep create mode 100644 rebuild create mode 100644 requirements.txt create mode 100644 src/README.md create mode 100644 src/config.yaml create mode 100644 src/layer.yaml create mode 100644 src/lib/charm/openstack/neutron_ironic.py create mode 100644 src/metadata.yaml create mode 100644 src/reactive/neutron_ironic_handlers.py create mode 100644 src/templates/etc_neutron_plugins_ml2_ironic_neutron_agent.ini create mode 100644 src/test-requirements.txt create mode 100644 src/tox.ini create mode 100644 test-requirements.txt create mode 100644 tox.ini create mode 100644 unit_tests/__init__.py create mode 100644 unit_tests/test_neutron_ironic_handlers.py diff --git a/.stestr.conf b/.stestr.conf new file mode 100644 index 0000000..2808535 --- /dev/null +++ b/.stestr.conf @@ -0,0 +1,4 @@ +[DEFAULT] +test_path=./unit_tests +top_dir=./ + diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..fd20909 --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,4 @@ +- project: + templates: + - openstack-python3-charm-jobs + - openstack-cover-jobs 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/docs/.keep b/docs/.keep new file mode 100644 index 0000000..e69de29 diff --git a/rebuild b/rebuild new file mode 100644 index 0000000..5d1e84b --- /dev/null +++ b/rebuild @@ -0,0 +1,5 @@ +# This file is used to trigger rebuilds +# when dependencies of the charm change, +# but nothing in the charm needs to. +# simply change the uuid to something new +0f7f02ff-1295-4635-9ea5-9453c45b6c9e \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..aaaa3e0 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,11 @@ +# This file is managed centrally by release-tools and should not be modified +# within individual charm repos. See the 'global' dir contents for available +# choices of *requirements.txt files for OpenStack Charms: +# https://github.com/openstack-charmers/release-tools +# +setuptools<50.0.0 # https://github.com/pypa/setuptools/commit/04e3df22df840c6bb244e9b27bc56750c44b7c85 +# Build requirements +charm-tools>=2.4.4 +# importlib-resources 1.1.0 removed Python 3.5 support +importlib-resources<1.1.0 +simplejson diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..07dd0c5 --- /dev/null +++ b/src/README.md @@ -0,0 +1 @@ +# Overview diff --git a/src/config.yaml b/src/config.yaml new file mode 100644 index 0000000..6aa8c0f --- /dev/null +++ b/src/config.yaml @@ -0,0 +1,21 @@ +options: + openstack-origin: + default: distro + type: string + description: | + Repository from which to install. May be one of the following: + distro (default), ppa:somecustom/ppa, a deb url sources entry, + or a supported Ubuntu Cloud Archive e.g. + . + cloud:- + cloud:-/updates + cloud:-/staging + cloud:-/proposed + . + See https://wiki.ubuntu.com/OpenStack/CloudArchive for info on which + cloud archives are available and supported. + region: + default: RegionOne + type: string + description: | + Name of the OpenStack region. diff --git a/src/layer.yaml b/src/layer.yaml new file mode 100644 index 0000000..2f03774 --- /dev/null +++ b/src/layer.yaml @@ -0,0 +1,7 @@ +includes: +- 'layer:openstack' +- 'interface:neutron-plugin-api-subordinate' +- 'interface:keystone-credentials' +options: + basic: + use_venv: False diff --git a/src/lib/charm/openstack/neutron_ironic.py b/src/lib/charm/openstack/neutron_ironic.py new file mode 100644 index 0000000..b69cbeb --- /dev/null +++ b/src/lib/charm/openstack/neutron_ironic.py @@ -0,0 +1,36 @@ +from charmhelpers.core.hookenv import ( + config, + log +) +import charms_openstack.charm as charm + +IRONIC_AGENT_CONF = "/etc/neutron/plugins/ml2/ironic_neutron_agent.ini" + + +def request_endpoint_information(keystone): + charm = NeutronIronicAgentCharm.singleton + keystone.request_credentials( + charm.name, region=charm.region) + + +class NeutronIronicAgentCharm(charm.OpenStackCharm): + abstract_class = False + + release = 'train' + name = 'ironic' + group = 'neutron' + + python_version = 3 + packages = ['ironic-neutron-agent', 'python3-ironic-neutron-agent'] + default_service = 'ironic-neutron-agent' + services = [default_service,] + + restart_map = { + IRONIC_AGENT_CONF: [default_service, ], + } + + release_pkg = version_package = 'neutron-common' + + def install(self): + self.configure_source() + super().install() diff --git a/src/metadata.yaml b/src/metadata.yaml new file mode 100644 index 0000000..a3fe228 --- /dev/null +++ b/src/metadata.yaml @@ -0,0 +1,22 @@ +name: neutron-api-plugin-ironic +summary: Ironic bare metal ML2 plugin support for Neutron-API +maintainer: Gabriel-Adrian Samfira +description: | + Ironic baremetal mechanism driver and ironic neutron agent support +tags: + - misc + - networking +subordinate: true +series: + - bionic + - focal +provides: + neutron-plugin-api-subordinate: + interface: neutron-plugin-api-subordinate + scope: container +requires: + container: + interface: juju-info + scope: container + identity-credentials: + interface: keystone-credentials diff --git a/src/reactive/neutron_ironic_handlers.py b/src/reactive/neutron_ironic_handlers.py new file mode 100644 index 0000000..1b05b88 --- /dev/null +++ b/src/reactive/neutron_ironic_handlers.py @@ -0,0 +1,68 @@ +import charms.reactive as reactive +import charm.openstack.neutron_ironic as ironic + +import json + +from charmhelpers.core.hookenv import ( + config, + log, +) + +from charms_openstack.charm import ( + provide_charm_instance, + use_defaults, + optional_interfaces, +) + + +use_defaults( + 'charm.default-select-release', + 'update-status', +) + +@reactive.when('identity-credentials.available') +def render_stuff(*args): + with provide_charm_instance() as ironic_charm: + ironic_charm.render_with_interfaces( + optional_interfaces(args)) + ironic_charm.assess_status() + reactive.set_state('config.complete') + + +@reactive.when('identity-credentials.connected') +def setup_endpoint(keystone): + with provide_charm_instance() as charm_class: + ironic.request_endpoint_information(keystone) + charm_class.assess_status() + + +@reactive.when_not('ironic-agent-package.installed') +@reactive.when('neutron-plugin-api-subordinate.available') +def install_ironic(): + with provide_charm_instance() as charm_class: + charm_class.install() + reactive.set_state('ironic-agent-package.installed') + + +@reactive.when_any('neutron-plugin-api-subordinate.connected') +def configure_principal(): + try: + api_principal = reactive.endpoint_from_flag( + 'neutron-plugin-api-subordinate.connected') + + mech_drivers = [] + existing_mech_drivers = api_principal.neutron_config_data.get( + 'mechanism_drivers', None) + if existing_mech_drivers: + mech_drivers.extend(existing_mech_drivers.split(',')) + + mech_drivers.append("baremetal") + mechanism_drivers = ','.join(mech_drivers) + except AttributeError: + log("The principal charm isn't ready yet. " + "Postponing its configuration...") + return + + api_principal.configure_plugin( + neutron_plugin='ironic', + mechanism_drivers=mechanism_drivers) diff --git a/src/templates/etc_neutron_plugins_ml2_ironic_neutron_agent.ini b/src/templates/etc_neutron_plugins_ml2_ironic_neutron_agent.ini new file mode 100644 index 0000000..96bdfdc --- /dev/null +++ b/src/templates/etc_neutron_plugins_ml2_ironic_neutron_agent.ini @@ -0,0 +1,34 @@ +{% if identity_credentials.auth_host -%} +{% if identity_credentials.api_version and identity_credentials.api_version == "3" -%} +{% set auth_ver = "v3" -%} +{% else -%} +{% set auth_ver = "v2.0" -%} +{% endif -%} + +[ironic] +region_name = {{ options.region }} +auth_version = {{auth_ver}} +auth_uri = {{ identity_credentials.auth_protocol }}://{{ identity_credentials.auth_host }}:{{ identity_credentials.credentials_port }}/{{auth_ver}} +auth_url = {{ identity_credentials.auth_protocol }}://{{ identity_credentials.auth_host }}:{{ identity_credentials.credentials_port }} +auth_type = password + +{% if identity_credentials.credentials_project_domain_name -%} +project_domain_name = {{ identity_credentials.credentials_project_domain_name }} +user_domain_name = {{ identity_credentials.credentials_user_domain_name }} +{% else %} +project_domain_name = default +user_domain_name = default +{% endif -%} + +username = {{ identity_credentials.credentials_username }} +password = {{ identity_credentials.credentials_password }} +project_name = {{identity_credentials.credentials_project}} + +admin_user = {{ identity_credentials.credentials_username }} +admin_password = {{ identity_credentials.credentials_password }} +admin_tenant_name = {{identity_credentials.credentials_project}} + +{% if identity_credentials.signing_dir -%} +signing_dir = {{ identity_credentials.signing_dir }} +{% endif -%} +{% endif -%} diff --git a/src/test-requirements.txt b/src/test-requirements.txt new file mode 100644 index 0000000..d3c9be8 --- /dev/null +++ b/src/test-requirements.txt @@ -0,0 +1,8 @@ +# This file is managed centrally by release-tools and should not be modified +# within individual charm repos. See the 'global' dir contents for available +# choices of *requirements.txt files for OpenStack Charms: +# https://github.com/openstack-charmers/release-tools +# +# Functional Test Requirements (let Zaza's dependencies solve all dependencies here!) +git+https://github.com/openstack-charmers/zaza.git#egg=zaza +git+https://github.com/openstack-charmers/zaza-openstack-tests.git#egg=zaza.openstack diff --git a/src/tox.ini b/src/tox.ini new file mode 100644 index 0000000..07a7adc --- /dev/null +++ b/src/tox.ini @@ -0,0 +1,50 @@ +# Source charm (with zaza): ./src/tox.ini +# This file is managed centrally by release-tools and should not be modified +# within individual charm repos. See the 'global' dir contents for available +# choices of tox.ini for OpenStack Charms: +# https://github.com/openstack-charmers/release-tools + +[tox] +envlist = pep8 +skipsdist = True +# NOTE: Avoid build/test env pollution by not enabling sitepackages. +sitepackages = False +# NOTE: Avoid false positives by not skipping missing interpreters. +skip_missing_interpreters = False + +[testenv] +setenv = VIRTUAL_ENV={envdir} + PYTHONHASHSEED=0 +whitelist_externals = juju +passenv = HOME TERM CS_* OS_* TEST_* +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 = + functest-run-suite --help + +[testenv:func] +basepython = python3 +commands = + functest-run-suite --keep-model + +[testenv:func-smoke] +basepython = python3 +commands = + functest-run-suite --keep-model --smoke + +[testenv:func-target] +basepython = python3 +commands = + functest-run-suite --keep-model --bundle {posargs} + +[testenv:venv] +commands = {posargs} diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..d078e27 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,24 @@ +# This file is managed centrally by release-tools and should not be modified +# within individual charm repos. See the 'global' dir contents for available +# choices of *requirements.txt files for OpenStack Charms: +# https://github.com/openstack-charmers/release-tools +# +setuptools<50.0.0 # https://github.com/pypa/setuptools/commit/04e3df22df840c6bb244e9b27bc56750c44b7c85 +# Lint and unit test requirements +flake8>=2.2.4 +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 +# +# Revisit for removal / mock improvement: +netifaces # vault +psycopg2-binary # vault +tenacity # vault +pbr # vault +cryptography # vault, keystone-saml-mellon +lxml # keystone-saml-mellon +hvac # vault, barbican-vault diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..c91922e --- /dev/null +++ b/tox.ini @@ -0,0 +1,97 @@ +# Source charm: ./tox.ini +# This file is managed centrally by release-tools and should not be modified +# within individual charm repos. See the 'global' dir contents for available +# choices of tox.ini for OpenStack Charms: +# https://github.com/openstack-charmers/release-tools + +[tox] +skipsdist = True +envlist = pep8,py3 +# NOTE: Avoid build/test env pollution by not enabling sitepackages. +sitepackages = False +# NOTE: Avoid false positives by not skipping missing interpreters. +skip_missing_interpreters = False + +[testenv] +setenv = VIRTUAL_ENV={envdir} + PYTHONHASHSEED=0 + TERM=linux + LAYER_PATH={toxinidir}/layers + INTERFACE_PATH={toxinidir}/interfaces + JUJU_REPOSITORY={toxinidir}/build +passenv = http_proxy https_proxy INTERFACE_PATH LAYER_PATH JUJU_REPOSITORY +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 --slowest {posargs} + +[testenv:py35] +basepython = python3.5 +deps = -r{toxinidir}/test-requirements.txt +commands = stestr run --slowest {posargs} + +[testenv:py36] +basepython = python3.6 +deps = -r{toxinidir}/test-requirements.txt +commands = stestr run --slowest {posargs} + +[testenv:py37] +basepython = python3.7 +deps = -r{toxinidir}/test-requirements.txt +commands = stestr run --slowest {posargs} + +[testenv:py38] +basepython = python3.8 +deps = -r{toxinidir}/test-requirements.txt +commands = stestr run --slowest {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 --slowest {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,W503,W504 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_neutron_ironic_handlers.py b/unit_tests/test_neutron_ironic_handlers.py new file mode 100644 index 0000000..9fad4db --- /dev/null +++ b/unit_tests/test_neutron_ironic_handlers.py @@ -0,0 +1,48 @@ +import mock + +import reactive.neutron_ironic_handlers as handlers + +import charms_openstack.test_utils as test_utils + + +class TestRegisteredHooks(test_utils.TestRegisteredHooks): + + def test_hooks(self): + hook_set = { + 'when': { + 'configure_principle': ( + 'neutron-plugin-api-subordinate.connected', ), + 'install_ironic': ( + 'neutron-plugin-api-subordinate.available', ), + 'render_stuff': ( + 'identity-credentials.available', ), + 'setup_endpoint': ( + 'identity-credentials.connected', ), + } + } + self.registered_hooks_test_helper(handlers, hook_set, []) + + +class TestHandlers(test_utils.PatchHelper): + + def test_configure_principal(self): + mocked_reactive = mock.MagicMock() + self.patch_object(handlers, 'reactive', + name='reactive', + new=mocked_reactive) + principal_charm = mock.MagicMock() + mocked_reactive.endpoint_from_flag.return_value = principal_charm + principal_charm.neutron_config_data = { + 'mechanism_drivers': 'driver1,driver2' + } + + mocked_config = mock.MagicMock() + self.patch_object(handlers, 'config', + name='config', + new=mocked_config) + mocked_config.return_value = 'my_config_value' + + handlers.configure_principal() + principal_charm.configure_plugin.assert_called_once_with( + neutron_plugin='ironic', + mechanism_drivers='driver1,driver2,baremetal')