Charm Interface - OpenStack Dashboard Plugin
Go to file
Hervé Beraud 5fe099ee30 Use unittest.mock instead of mock
The mock third party library was needed for mock support in py2
runtimes. Since we now only support py36 and later, we can use the
standard lib unittest.mock module instead.

Note that https://github.com/openstack/charms.openstack is used during tests
and he need `mock`, unfortunatelly it doesn't declare `mock` in its
requirements so it retrieve mock from other charm project (cross dependency).
So we depend on charms.openstack first and when
Ib1ed5b598a52375e29e247db9ab4786df5b6d142 will be merged then CI
will pass without errors.

Depends-On: Ib1ed5b598a52375e29e247db9ab4786df5b6d142
Change-Id: Id1cb42a412de130a85ec48695ecdbbadc9df7a6c
2021-12-15 09:56:41 +00:00
unit_tests Use unittest.mock instead of mock 2021-12-15 09:56:41 +00:00
.gitignore Migrate unit tests from testr to stestr 2021-02-10 12:41:01 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:49:01 +00:00
.stestr.conf Add ``dashboard-plugin`` interface code and unit tests 2018-11-06 10:53:09 +01:00
.travis.yml Add ``dashboard-plugin`` interface code and unit tests 2018-11-06 10:53:09 +01:00
.zuul.yaml Switch to Ussuri jobs 2019-10-31 17:49:35 +08:00
LICENSE Add ``dashboard-plugin`` interface code and unit tests 2018-11-06 10:53:09 +01:00
README.md Add ``dashboard-plugin`` interface code and unit tests 2018-11-06 10:53:09 +01:00
interface.yaml Add ``dashboard-plugin`` interface code and unit tests 2018-11-06 10:53:09 +01:00
requires.py Add package information to the dashboard-plugin relation 2020-01-27 18:21:12 +00:00
test-requirements.txt Use unittest.mock instead of mock 2021-12-15 09:56:41 +00:00
tox.ini Migrate unit tests from testr to stestr 2021-02-10 12:41:01 +00:00

README.md

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:

includes: ['interface:dashboard-plugin']

and add a requires interface of type dashboard-plugin to your charm or layers metadata.yaml:

requires:
  dashboard:
    interface: dashboard-plugin

Bugs

Please report bugs on Launchpad.

For development questions please refer to the OpenStack Charm Guide.