diff --git a/README.rst b/README.rst index 1f44832e30..992d19bf11 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,11 @@ Tempest - The OpenStack Integration Test Suite ============================================== -This is a set of integration tests to be run against a live cluster. +This is a set of integration tests to be run against a live OpenStack +cluster. Tempest has batteries of tests for OpenStack API validation, +Scenarios, and other specific tests useful in validating an OpenStack +deployment. + Quickstart ---------- @@ -25,13 +29,10 @@ and reference data to be used in testing. .. note:: - If you have a running devstack environment, look at the - environment variables in your ``devstack/localrc`` file. - The ADMIN_PASSWORD variable should match the api_key value - in the tempest.conf [nova] configuration section. In addition, - you will need to get the UUID identifier of the image that - devstack uploaded and set the image_ref value in the [environment] - section in the tempest.conf to that image UUID. + If you have a running devstack environment, tempest will be + automatically configured and placed in ``/opt/stack/tempest``. It + will have a configuration file already set up to work with your + devstack installation. Tempest is not tied to any single test runner, but Nose been the most commonly used tool. After setting up your configuration file, you can execute @@ -45,14 +46,12 @@ To run one single test :: Configuration ------------- -At present, there are three sections to be configured: nova, environment, -and image. The nova section includes information about your Keystone endpoint, -as well as valid credentials for a user. It also contains logical timeouts -for certain actions. The environment section contains reference data to be -used when testing the Compute portion of OpenStack, as well as feature flags -for tests that may or may not work based on your hypervisor or current -environment. Lastly, the image section contains credentials and endpoints for -the Glance image service. +Detailed configuration of tempest is beyond the scope of this +document. The etc/tempest.conf.sample attempts to be a self +documenting version of the configuration. + +The most important pieces that are needed are the user ids, openstack +endpoints, and basic flavors and images needed to run tests. Common Issues ------------- diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000000..a55df76da8 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,285 @@ +# -*- coding: utf-8 -*- +# +# Tempest documentation build configuration file, created by +# sphinx-quickstart on Tue May 21 17:43:32 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Tempest' +copyright = u'2013, Sean Dague' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = 'havana' +# The full version, including alpha/beta/rc tags. +release = 'havana' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Tempestdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Tempest.tex', u'Tempest Documentation', + u'Sean Dague', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'tempest', u'Tempest Documentation', + [u'Sean Dague'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Tempest', u'Tempest Documentation', + u'Sean Dague', 'Tempest', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'Tempest' +epub_author = u'Sean Dague' +epub_publisher = u'Sean Dague' +epub_copyright = u'2013, Sean Dague' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True diff --git a/doc/source/field_guide/api.rst b/doc/source/field_guide/api.rst new file mode 120000 index 0000000000..ce0f6b7226 --- /dev/null +++ b/doc/source/field_guide/api.rst @@ -0,0 +1 @@ +../../../tempest/api/README.rst \ No newline at end of file diff --git a/doc/source/field_guide/cli.rst b/doc/source/field_guide/cli.rst new file mode 120000 index 0000000000..13caef51b8 --- /dev/null +++ b/doc/source/field_guide/cli.rst @@ -0,0 +1 @@ +../../../tempest/cli/README.rst \ No newline at end of file diff --git a/doc/source/field_guide/index.rst b/doc/source/field_guide/index.rst new file mode 120000 index 0000000000..6f24b575c8 --- /dev/null +++ b/doc/source/field_guide/index.rst @@ -0,0 +1 @@ +../../../tempest/README.rst \ No newline at end of file diff --git a/doc/source/field_guide/scenario.rst b/doc/source/field_guide/scenario.rst new file mode 120000 index 0000000000..19ce39e2ee --- /dev/null +++ b/doc/source/field_guide/scenario.rst @@ -0,0 +1 @@ +../../../tempest/scenario/README.rst \ No newline at end of file diff --git a/doc/source/field_guide/stress.rst b/doc/source/field_guide/stress.rst new file mode 120000 index 0000000000..d39d0f8c61 --- /dev/null +++ b/doc/source/field_guide/stress.rst @@ -0,0 +1 @@ +../../../tempest/stress/README.rst \ No newline at end of file diff --git a/doc/source/field_guide/thirdparty.rst b/doc/source/field_guide/thirdparty.rst new file mode 120000 index 0000000000..3fd6a51495 --- /dev/null +++ b/doc/source/field_guide/thirdparty.rst @@ -0,0 +1 @@ +../../../tempest/thirdparty/README.rst \ No newline at end of file diff --git a/doc/source/field_guide/whitebox.rst b/doc/source/field_guide/whitebox.rst new file mode 120000 index 0000000000..47f6069875 --- /dev/null +++ b/doc/source/field_guide/whitebox.rst @@ -0,0 +1 @@ +../../../tempest/whitebox/README.rst \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000000..e37e2506dc --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,36 @@ +.. Tempest documentation master file, created by + sphinx-quickstart on Tue May 21 17:43:32 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Tempest Testing Project +=================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + overview + + +Field Guide: + +.. toctree:: + :maxdepth: 2 + + field_guide/index + field_guide/api + field_guide/cli + field_guide/scenario + field_guide/stress + field_guide/thirdparty + field_guide/whitebox + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/overview.rst b/doc/source/overview.rst new file mode 120000 index 0000000000..c768ff7d97 --- /dev/null +++ b/doc/source/overview.rst @@ -0,0 +1 @@ +../../README.rst \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index 59050cd2d2..3b13b603dc 100644 --- a/setup.cfg +++ b/setup.cfg @@ -25,6 +25,11 @@ setup-hooks = scripts = bin/tempest +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source + [nosetests] # NOTE(jkoelker) To run the test suite under nose install the following # coverage http://pypi.python.org/pypi/coverage diff --git a/tempest/README.rst b/tempest/README.rst index 6718ee02b3..63f3ad0c4a 100644 --- a/tempest/README.rst +++ b/tempest/README.rst @@ -1,5 +1,5 @@ Tempest Field Guide ------------ +======== Tempest is designed to be useful for a large number of different environments. This includes being useful for gating commits to diff --git a/tools/test-requires b/tools/test-requires index cba42a4c41..27851da424 100644 --- a/tools/test-requires +++ b/tools/test-requires @@ -6,3 +6,6 @@ hacking>=0.5.3,<0.6 # #TODO(afazekas): ensure pg_config installed psycopg2 +# needed for doc build +sphinx>=1.1.2 + diff --git a/tox.ini b/tox.ini index 066a2b5d57..d6c2c417fa 100644 --- a/tox.ini +++ b/tox.ini @@ -49,6 +49,11 @@ commands = nosetests --logging-format '%(asctime)-15s %(message)s' --with-xunit --xunit-file=nosetests-full.xml -sv tempest/api tempest/scenario tempest/thirdparty tempest/cli python -m tools/tempest_coverage -c report --html +[testenv:venv] +commands = {posargs} +deps = -r{toxinidir}/tools/pip-requires + -r{toxinidir}/tools/test-requires + [testenv:pep8] commands = flake8 deps = -r{toxinidir}/tools/pip-requires