Add ``dashboard-plugin`` interface code and unit tests
This commit is contained in:
commit
2a1d5d445e
|
@ -0,0 +1,7 @@
|
|||
.tox
|
||||
.stestr
|
||||
*__pycache__*
|
||||
*.pyc
|
||||
build
|
||||
.unit-state.db
|
||||
*.swp
|
|
@ -0,0 +1,3 @@
|
|||
[DEFAULT]
|
||||
test_path=./unit_tests
|
||||
top_dir=./
|
|
@ -0,0 +1,6 @@
|
|||
language: python
|
||||
python:
|
||||
- "3.6"
|
||||
install: pip install tox-travis
|
||||
script:
|
||||
- tox -e pep8,py3
|
|
@ -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.
|
|
@ -0,0 +1,37 @@
|
|||
# Overview
|
||||
|
||||
This interface is for use with OpenStack Dashboard plugin subordinate charms.
|
||||
|
||||
# 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
|
||||
``{endpoint_name}.available`` state.
|
||||
|
||||
Properties for ``release``, ``bin_path``, and ``openstack_dir`` are also
|
||||
provided.
|
||||
|
||||
# metadata
|
||||
|
||||
To consume this interface in your charm or layer, add the following to `layer.yaml`:
|
||||
|
||||
```yaml
|
||||
includes: ['interface:dashboard-plugin']
|
||||
```
|
||||
|
||||
and add a requires interface of type ``dashboard-plugin`` to your charm or layers ``metadata.yaml``:
|
||||
|
||||
```yaml
|
||||
requires:
|
||||
dashboard:
|
||||
interface: dashboard-plugin
|
||||
```
|
||||
|
||||
# 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).
|
|
@ -0,0 +1,11 @@
|
|||
name: dashboard-plugin
|
||||
summary: Plugin interface for OpenStack Dashboard
|
||||
maintainer: OpenStack Charmers <openstack-charmers@lists.ubuntu.com>
|
||||
repo: https://github.com/openstack-charmers/charm-interface-dashboard-plugin.git
|
||||
ignore:
|
||||
- 'unit_tests'
|
||||
- '.stestr.conf'
|
||||
- 'test-requirements.txt'
|
||||
- 'tox.ini'
|
||||
- '.gitignore'
|
||||
- '.travis.yml'
|
|
@ -0,0 +1,87 @@
|
|||
# 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 (
|
||||
Endpoint,
|
||||
clear_flag,
|
||||
set_flag,
|
||||
when_all,
|
||||
when_not,
|
||||
)
|
||||
|
||||
|
||||
class DashboardPluginRequires(Endpoint):
|
||||
@when_all('endpoint.{endpoint_name}.joined',
|
||||
'endpoint.{endpoint_name}.changed.release',
|
||||
'endpoint.{endpoint_name}.changed.bin_path',
|
||||
'endpoint.{endpoint_name}.changed.openstack_dir')
|
||||
def joined(self):
|
||||
clear_flag(
|
||||
self.expand_name(
|
||||
'endpoint.{endpoint_name}.changed.release'))
|
||||
clear_flag(
|
||||
self.expand_name(
|
||||
'endpoint.{endpoint_name}.changed.bin_path'))
|
||||
clear_flag(
|
||||
self.expand_name(
|
||||
'endpoint.{endpoint_name}.changed.openstack_dir'))
|
||||
set_flag(self.expand_name('{endpoint_name}.available'))
|
||||
|
||||
@when_not('endpoint.{endpoint_name}.joined')
|
||||
def broken(self):
|
||||
clear_flag(self.expand_name('{endpoint_name}.available'))
|
||||
|
||||
@property
|
||||
def release(self):
|
||||
"""Retrieve the OpenStack release from principal
|
||||
|
||||
:returns release: OpenStack release of principal
|
||||
:rtype release: str
|
||||
"""
|
||||
return self.all_joined_units.received.get('release')
|
||||
|
||||
@property
|
||||
def bin_path(self):
|
||||
"""Retrieve bin_path property from principal charm
|
||||
|
||||
:returns bin_path: bin_path property from principal charm
|
||||
:rtype bin_path: str
|
||||
"""
|
||||
return self.all_joined_units.received.get('bin_path')
|
||||
|
||||
@property
|
||||
def openstack_dir(self):
|
||||
"""Retrieve openstack_dir property from principal charm
|
||||
|
||||
:returns openstack_dir: openstack_dir property from principal charm
|
||||
:rtype openstack_dir: str
|
||||
"""
|
||||
return self.all_joined_units.received.get('openstack_dir')
|
||||
|
||||
def publish_plugin_info(self, local_settings, priority):
|
||||
"""Publish information about our plugin to principal charm
|
||||
|
||||
:parm local_settings: String is pasted verbatim into the
|
||||
local_settings.py of the principal.
|
||||
:type local_settings: str
|
||||
:param priority: Value used by principal to order the configuration
|
||||
blobs when multiple plugin subordinates are present.
|
||||
:type priority: str
|
||||
"""
|
||||
for relation in self.relations:
|
||||
relation.to_publish['local-settings'] = local_settings
|
||||
relation.to_publish['priority'] = priority
|
|
@ -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
|
|
@ -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
|
|
@ -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()
|
|
@ -0,0 +1,102 @@
|
|||
# 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 mock
|
||||
|
||||
import requires
|
||||
|
||||
import charms_openstack.test_utils as test_utils
|
||||
|
||||
|
||||
_hook_args = {}
|
||||
|
||||
|
||||
class TestRegisteredHooks(test_utils.TestRegisteredHooks):
|
||||
|
||||
def test_hooks(self):
|
||||
defaults = []
|
||||
hook_set = {
|
||||
'when_all': {
|
||||
'joined': (
|
||||
'endpoint.{endpoint_name}.joined',
|
||||
'endpoint.{endpoint_name}.changed.release',
|
||||
'endpoint.{endpoint_name}.changed.bin_path',
|
||||
'endpoint.{endpoint_name}.changed.openstack_dir',),
|
||||
},
|
||||
'when_not': {
|
||||
'broken': ('endpoint.{endpoint_name}.joined',),
|
||||
},
|
||||
}
|
||||
# test that the hooks were registered via the
|
||||
# reactive.barbican_handlers
|
||||
self.registered_hooks_test_helper(requires, hook_set, defaults)
|
||||
|
||||
|
||||
class TestDashboardPluginRequires(test_utils.PatchHelper):
|
||||
|
||||
def setUp(self):
|
||||
super().setUp()
|
||||
self.dashboard_req = requires.DashboardPluginRequires(
|
||||
'some-relation', [])
|
||||
self._patches = {}
|
||||
self._patches_start = {}
|
||||
|
||||
def tearDown(self):
|
||||
self.dashboard_req = None
|
||||
for k, v in self._patches.items():
|
||||
v.stop()
|
||||
setattr(self, k, None)
|
||||
self._patches = None
|
||||
self._patches_start = None
|
||||
|
||||
def patch_dashboard(self, attr, return_value=None):
|
||||
mocked = mock.patch.object(self.dashboard_req, 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_dashboard('_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_joined(self):
|
||||
self.patch_object(requires, 'clear_flag')
|
||||
self.patch_object(requires, 'set_flag')
|
||||
self.dashboard_req.joined()
|
||||
self.clear_flag.assert_has_calls([
|
||||
mock.call('endpoint.some-relation.changed.release'),
|
||||
mock.call('endpoint.some-relation.changed.bin_path'),
|
||||
mock.call('endpoint.some-relation.changed.openstack_dir'),
|
||||
])
|
||||
self.set_flag.assert_called_once_with('some-relation.available')
|
||||
|
||||
def test_broken(self):
|
||||
self.patch_object(requires, 'clear_flag')
|
||||
self.dashboard_req.broken()
|
||||
self.clear_flag.assert_called_once_with('some-relation.available')
|
||||
|
||||
def test_publish_plugin_info(self):
|
||||
to_publish = self.patch_topublish()
|
||||
local_settings = 'key = value'
|
||||
priority = 'priority'
|
||||
self.dashboard_req.publish_plugin_info(local_settings, priority)
|
||||
to_publish.__setitem__.assert_has_calls([
|
||||
mock.call('local-settings', local_settings),
|
||||
mock.call('priority', priority),
|
||||
])
|
Loading…
Reference in New Issue