From f45ba2e604755e6ef92da690e80ad695913230a5 Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Mon, 24 Aug 2015 15:05:01 -0400 Subject: [PATCH] Cleanup tempest docs a bit This commit fixes a few things in the tempest docs. First it fixes all of the sphinx warnings and enables fail on warn to ensure we're using valid sphinx everywhere. It also adds a link from the configuration guide to the sample config file. Change-Id: I3ad645a6bbfa46b4498e1732410743e46d6eb0cb --- HACKING.rst | 11 +++++------ README.rst | 2 -- REVIEWING.rst | 2 +- doc/source/account_generator.rst | 6 +++--- doc/source/configuration.rst | 3 ++- doc/source/index.rst | 1 - setup.cfg | 3 +++ tempest/README.rst | 2 +- tempest/cmd/account_generator.py | 4 ++-- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/HACKING.rst b/HACKING.rst index 8e0ac4482a..a918f4adc9 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -72,11 +72,10 @@ for providing more information. Most other assert method can include more information by default. For example ``self.assertIn`` can include the whole set. -It is recommended to use testtools matcher for the more tricky assertions. -`[doc] `_ +It is recommended to use testtools `matcher`_ for the more tricky assertions. +You can implement your own specific `matcher`_ as well. -You can implement your own specific matcher as well. -`[doc] `_ +.. _matcher: http://testtools.readthedocs.org/en/latest/for-test-authors.html#matchers If the test case fails you can see the related logs and the information carried by the exception (exception class, backtrack and exception info). @@ -158,8 +157,8 @@ is to create an interface description in a python file under sections for the test (one of those is mandatory): - A resource (part of the URL of the request): Resources needed for a test - must be created in `setUpClass` and registered with `set_resource` e.g.: - `cls.set_resource("server", server['id'])` + must be created in `setUpClass` and registered with `set_resource` e.g.: + `cls.set_resource("server", server['id'])` - A json schema: defines properties for a request. diff --git a/README.rst b/README.rst index d94fbdd6d0..7108eaf183 100644 --- a/README.rst +++ b/README.rst @@ -191,8 +191,6 @@ tests by using ``testr`` :: $> testr run --parallel -.. _testr: http://testrepository.readthedocs.org/en/latest/MANUAL.html - To run one single test serially :: $> testr run tempest.api.compute.servers.test_servers_negative.ServersNegativeTestJSON.test_reboot_non_existent_server diff --git a/REVIEWING.rst b/REVIEWING.rst index 74bd2adb69..12ccb75a33 100644 --- a/REVIEWING.rst +++ b/REVIEWING.rst @@ -34,7 +34,7 @@ should not be approved. Reject Copy and Paste Test Code ------------------------- +------------------------------- When creating new tests that are similar to existing tests it is tempting to simply copy the code and make a few modifications. This increases code size and the maintenance burden. Such changes should not be approved if it is easy to diff --git a/doc/source/account_generator.rst b/doc/source/account_generator.rst index 1c30473253..032a20dbce 100644 --- a/doc/source/account_generator.rst +++ b/doc/source/account_generator.rst @@ -1,5 +1,5 @@ --------------------------------- +-------------------------------------- Tempest Test-Account Generator Utility --------------------------------- +-------------------------------------- -.. automodule:: tempest.cmd.account_generator \ No newline at end of file +.. automodule:: tempest.cmd.account_generator diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 3c109b59d7..ec430b7911 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -6,7 +6,8 @@ Tempest Configuration Guide This guide is a starting point for configuring tempest. It aims to elaborate on and explain some of the mandatory and common configuration settings and how they are used in conjunction. The source of truth on each option is the sample -config file which explains the purpose of each individual option. +config file which explains the purpose of each individual option. You can see +the sample config file here: :ref:`tempest-sampleconf` Lock Path --------- diff --git a/doc/source/index.rst b/doc/source/index.rst index e9f2161c48..fe6074fc2f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -24,7 +24,6 @@ where your test contributions should go. field_guide/index field_guide/api - field_guide/cli field_guide/scenario field_guide/stress field_guide/thirdparty diff --git a/setup.cfg b/setup.cfg index ab40f12f7c..46e21f10f7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -42,5 +42,8 @@ all_files = 1 build-dir = doc/build source-dir = doc/source +[pbr] +warnerrors = True + [wheel] universal = 1 diff --git a/tempest/README.rst b/tempest/README.rst index fec28740ec..f93a173d85 100644 --- a/tempest/README.rst +++ b/tempest/README.rst @@ -57,7 +57,7 @@ several test jobs in parallel and can run any existing test in Tempest as a stress job. :ref:`third_party_field_guide` ------------------------------ +------------------------------ Many openstack components include 3rdparty API support. It is completely legitimate for Tempest to include tests of 3rdparty APIs, diff --git a/tempest/cmd/account_generator.py b/tempest/cmd/account_generator.py index e05cab3689..3d24547ab6 100755 --- a/tempest/cmd/account_generator.py +++ b/tempest/cmd/account_generator.py @@ -25,7 +25,7 @@ have the username, tenant_name, password and roles. **Usage:** ``tempest-account-generator [-h] [OPTIONS] accounts_file.yaml``. Positional Arguments ------------------ +-------------------- **accounts_file.yaml** (Required) Provide an output accounts yaml file. Utility creates a .yaml file in the directory where the command is ran. The appropriate name for the file is *accounts.yaml* and it should be placed in *tempest/etc* @@ -49,7 +49,7 @@ You're probably familiar with these, but just to remind:: +----------+------------------+----------------------+ Optional Arguments ------------------ +------------------ **-h**, **--help** (Optional) Shows help message with the description of utility and its arguments, and exits.