openstack
/
charm-interface-dashboard-plugin
Code Issues Proposed changes
Charm Interface - OpenStack Dashboard Plugin
4 Commits 1 Branch 0 Tags 107 KiB
Python 100%
Go to file
Paul Goins 3dd814ef13 Added tox environment for gathering coverage 
This technique was borrowed from the tox "cover" environment in
openstack/nova's tox.ini.  This leverages the fact that stestr lets
you override the python executable via the PYTHON environment
variable.  Doing this allows us to easily generate coverage for our
unit tests.

An important caveat is that this does not provide any coverage for
tests via zaza, amulet, etc.  It is purely focused on the unit tests.

Note that this replaces the previous .coveragerc; coverage
configuration is instead pulled from tox.ini.

Change-Id: I78170741219749d8bfb5eb7eb247877814fb9824
 		2019-03-01 14:40:08 +01:00
unit_tests Add 'connected' state to please charms_openstack state check 2018-11-18 00:23:53 +01:00
.gitignore Add ``dashboard-plugin`` interface code and unit tests 2018-11-06 10:53:09 +01:00
.gitreview Add repo config 2018-11-14 15:41:14 +01: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 Added tox environment for gathering coverage 2019-03-01 14:40:08 +01: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 'connected' state to please charms_openstack state check 2018-11-18 00:23:53 +01:00
test-requirements.txt Add ``dashboard-plugin`` interface code and unit tests 2018-11-06 10:53:09 +01:00
tox.ini Added tox environment for gathering coverage 2019-03-01 14:40:08 +01: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.