From 7da7fe08a7e60f34a56cd08cca372df75b25b74d Mon Sep 17 00:00:00 2001 From: Kien Nguyen Date: Thu, 26 Oct 2017 09:47:31 +0700 Subject: [PATCH] Rework README * Correct links but documentation link still 404 NOT FOUND, will check it later. * Add description. * Add team repository and tag. Change-Id: I55aea097f72f1ee3f838c1b25fc28ada80f7d4f9 --- README.rst | 42 ++++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index c678cf3..4d8fec5 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,37 @@ -=============================== -zun_tempest_plugin -=============================== +======================== +Team and repository tags +======================== -Tempest plugin zun_tempest_plugin +.. image:: http://governance.openstack.org/badges/zun-tempest-plugin.svg + :target: http://governance.openstack.org/reference/tags/index.html -Please fill here a long description which must be at least 3 lines wrapped on -80 cols, so that distribution package maintainers can use it in their packages. -Note that this is a hard requirement. +========================== +Tempest Integration of Zun +========================== + +This directory contains Tempest tests to cover the Zun project, as well +as a plugin to automatically load these tests into tempest. + +See the Tempest plugin docs for information on using it: +http://docs.openstack.org/developer/tempest/plugin.html#using-plugins * Free software: Apache license -* Documentation: http://docs.openstack.org/developer/zun_tempest_plugin -* Source: http://git.openstack.org/cgit/openstack/zun_tempest_plugin +* Documentation: http://docs.openstack.org/developer/zun-tempest-plugin +* Source: http://git.openstack.org/cgit/openstack/zun-tempest-plugin * Bugs: http://bugs.launchpad.net/zun -Features --------- +Running the tests +----------------- -* TODO +To run all tests from this plugin, install Zun into your environment and +navigate to tempest directory:: + + $ cd /opt/stack/tempest + +Run this command:: + + $ tox -e all-plugin -- zun_tempest_plugin.tests.tempest.api + +To run a single test case, run with the test case name, for example:: + + $ tox -e all-plugin -- zun_tempest_plugin.tests.tempest.api.test_containers.test_list_containers