Update README with installation and test run information
Change-Id: I3e59d03c461b42cbc644425f354ecc5c5d03aaff
This commit is contained in:
parent
9450ef731a
commit
0f761e2792
45
README.rst
45
README.rst
@ -1,3 +1,12 @@
|
||||
========================
|
||||
Team and repository tags
|
||||
========================
|
||||
|
||||
.. image:: https://governance.openstack.org/tc/badges/kuryr-tempest-plugin.svg
|
||||
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
||||
|
||||
.. Change things from this point on
|
||||
|
||||
============================
|
||||
Tempest Integration of Kuryr
|
||||
============================
|
||||
@ -8,3 +17,39 @@ Overview
|
||||
This project defines a tempest plugin containing tests used to verify the
|
||||
functionality of a kuryr installation. The plugin will automatically load
|
||||
these tests into tempest.
|
||||
|
||||
For more information about Kuryr see:
|
||||
https://docs.openstack.org/kuryr/latest/
|
||||
|
||||
For more information about Kuryr-kubernetes see:
|
||||
https://docs.openstack.org/kuryr-kubernetes/latest/
|
||||
|
||||
For more information about Tempest plugins see:
|
||||
https://docs.openstack.org/tempest/latest/plugin.html
|
||||
|
||||
* Free software: Apache license
|
||||
* Documentation: https://docs.openstack.org/kuryr-tempest-plugin/latest/
|
||||
* Source: https://opendev.org/openstack/kuryr-tempest-plugin
|
||||
* Bugs: https://bugs.launchpad.net/kuryr
|
||||
|
||||
Installing
|
||||
----------
|
||||
|
||||
Clone this repository and call from the repo::
|
||||
|
||||
$ pip install -e .
|
||||
|
||||
Running the tests
|
||||
-----------------
|
||||
|
||||
To run all the tests from this plugin, call from the tempest repo::
|
||||
|
||||
$ tox -e all -- kuryr_tempest_plugin
|
||||
|
||||
To run a single test case, call with full path, for example::
|
||||
|
||||
$ tox -e all -- kuryr_tempest_plugin.tests.scenario.test_cross_ping.TestCrossPingScenario.test_vm_pod_ping
|
||||
|
||||
To retrieve a list of all tempest tests, run::
|
||||
|
||||
$ testr list-tests
|
||||
|
Loading…
x
Reference in New Issue
Block a user