From 85c8e3e60d4414e1af63b8e1b0449e6800122cac Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Thu, 30 Jun 2016 19:28:04 -0400 Subject: [PATCH] Add basic tempest run instructions to the quickstart This commit adds details for using tempest run to execute tempest tests to the quickstart guide in the readme. Partially-implements: bp tempest-run-cmd Change-Id: I7c5b51e4f055424fa62b1b262b2d1c96918e46eb --- README.rst | 14 ++++++++++++-- doc/source/run.rst | 2 ++ 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 725a890c14..28ff368e92 100644 --- a/README.rst +++ b/README.rst @@ -91,8 +91,18 @@ as it is simpler, and quicker to work with. any changes to it otherwise Tempest will not know how to load it. #. Once the configuration is done you're now ready to run Tempest. This can - be done with testr directly or any `testr`_ based test runner, like - `ostestr`_. For example, from the working dir running:: + be done using the :ref:`tempest_run` command. This can be done by either + cd'ing into the tempest workspace directory and running:: + + $ tempest run + + Or use the ``--workspace`` argument to run in the workspace you created + regarless of your current working directory. For example:: + + $ tempest run --workspace cloud-01 + + There is also the option to use testr directly, or any `testr`_ based test + runner, like `ostestr`_. For example, from the working dir running:: $ ostestr --regex '(?!.*\[.*\bslow\b.*\])(^tempest\.(api|scenario))' diff --git a/doc/source/run.rst b/doc/source/run.rst index 07fa5f7f46..ce7f03ef94 100644 --- a/doc/source/run.rst +++ b/doc/source/run.rst @@ -1,3 +1,5 @@ +.. _tempest_run: + ----------- Tempest Run -----------