diff --git a/README.rst b/README.rst index d0b1af9..b5954f0 100644 --- a/README.rst +++ b/README.rst @@ -2,19 +2,72 @@ intel-nfv-ci-tests ================== -.. image:: https://img.shields.io/travis/stackforge/intel-nfv-ci-tests.svg - :target: https://travis-ci.org/stackforge/intel-nfv-ci-tests +A Tempest plugin providing integration tests for NFV features. -.. image:: https://img.shields.io/pypi/v/intel-nfv-ci-tests.svg - :target: https://pypi.python.org/pypi/intel-nfv-ci-tests - - -Repository containing tests for Intel NFV 3rd party CI - -* Free software: Apache 2.0 license -* Documentation: https://intel-nfv-ci-tests.readthedocs.org. +This plugin is run as part of the +`Intel NFV third-party CI `_. Features -------- -* TODO +The tests validate the following features: + +* NUMA topologies +* CPU pinning +* Hugepages + +Requirements +------------ + +The features tested are all dependent on underlying hardware support. As such, +the following platform features are required: + +* Simultaneous multithreading (SMT) technology, e.g. Hyper-threading, must be + available and enabled +* A NUMA topology is required. This will generally mean a dual-socket board or + a CPU with Cluster-on-Die technology +* Hugepages must be supported + +Installation +------------ + +The plugin should be installed like any other package. Once installed, it will +be detected on subsequent runs of Temptest and enabled by default. + +At the command line, run:: + + $ pip install intel-nfv-ci-tests + +Or, if you have virtualenvwrapper installed, run:: + + $ mkvirtualenv intel-nfv-ci-tests + $ pip install intel-nfv-ci-tests + +Be aware that this package will not be available if running Tempest in a +different virtualenv, e.g. via a Tox target. + +Usage +----- + +All test commands should be run from the Tempest install directory, e.g. +``/opt/stack/tempest``. + +To list all Intel NFV CI tempest cases, run:: + + $ testr list-tests intel_nfv_ci_tests + +To run only these tests, run:: + + $ ./run_tempest.sh -N -- intel_nfv_ci_tests + +Alternatively, run via ``testr``:: + + $ testr run intel_nfv_ci_tests + +Or via tox:: + + $ tox -e all-plugin intel_nfv_ci_tests + +To run a single test case, run with test case name:: + + $ ./run_tempest.sh -N -- intel_nfv_ci_tests.tests.scenario.test_hugepages.TestHugepages diff --git a/doc/source/conf.py b/doc/source/conf.py deleted file mode 100755 index 620e9ba..0000000 --- a/doc/source/conf.py +++ /dev/null @@ -1,233 +0,0 @@ -# -*- coding: utf-8 -*- -# -# intel-nfv-ci-tests documentation build configuration file, created by -# sphinx-quickstart on Tue Jul 9 22:26:36 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 os -import sys - -import pbr - -# 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('.')) - -# Get the project root dir, which is the parent dir of this -cwd = os.getcwd() -project_root = os.path.dirname(cwd) - -# Insert the project root dir as the first element in the PYTHONPATH. -# This lets us ensure that the source package is imported, and that its -# version is used. -sys.path.insert(0, project_root) - -# -- 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.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'intel_nfv_ci_tests' -copyright = u'2015-present, Intel Corporation' - -# 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 = pbr.version.VersionInfo('intel_nfv_ci_tests') -# The full version, including alpha/beta/rc tags. -release = pbr.version.VersionInfo('intel_nfv_ci_tests') - -# 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 = False - -# 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 = [] - -# If true, keep warnings as "system message" paragraphs in the built -# documents. -# keep_warnings = False - - -# -- 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 = 'intel-nfv-ci-testsdoc' - - -# -- 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', 'intel-nfv-ci-tests.tex', - u'intel-nfv-ci-tests Documentation', - u'Intel Corporation', '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 diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index ac7b6bc..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst deleted file mode 100644 index 90b4560..0000000 --- a/doc/source/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. intel-nfv-ci-tests documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to intel-nfv-ci-tests's documentation! -============================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - readme - installation - usage - contributing - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/doc/source/installation.rst b/doc/source/installation.rst deleted file mode 100644 index 9dafc6b..0000000 --- a/doc/source/installation.rst +++ /dev/null @@ -1,13 +0,0 @@ -============ -Installation -============ - -At the command line:: - - $ easy_install intel-nfv-ci-tests - -Or, if you have virtualenvwrapper installed:: - - $ mkvirtualenv intel-nfv-ci-tests - $ pip install intel-nfv-ci-tests - diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index 581313c..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,23 +0,0 @@ -===== -Usage -===== - -To list all Intel NFV CI tempest cases, go to tempest directory, then run:: - - $ testr list-tests intel_nfv_ci_tests - -To run only these tests in tempest, go to tempest directory, then run:: - - $ ./run_tempest.sh -N -- intel_nfv_ci_tests - -You can also run them using ``testr``:: - - $ testr run intel_nfv_ci_tests - -To run a single test case, go to tempest directory, then run with test case name, e.g.:: - - $ ./run_tempest.sh -N -- intel_nfv_ci_tests.tests.scenario.test_hugepages.TestHugepages - -Alternatively, to run Intel NFV CI tempest plugin tests using tox, go to tempest directory, then run:: - - $ tox -eall-plugin intel_nfv_ci_tests diff --git a/setup.cfg b/setup.cfg index c924bba..8021986 100644 --- a/setup.cfg +++ b/setup.cfg @@ -18,11 +18,6 @@ project-url = https://github.com/openstack/intel-nfv-ci-tests tempest.test_plugins = intel-nfv-ci-tests = intel_nfv_ci_tests.plugin:IntelNFVPlugin -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source - [wheel] universal = 1 diff --git a/tox.ini b/tox.ini index dfed927..e7bdc6a 100644 --- a/tox.ini +++ b/tox.ini @@ -20,9 +20,6 @@ commands = bash tools/flake8wrap.sh {posargs} [testenv:venv] commands = {posargs} -[testenv:docs] -commands = python setup.py build_sphinx - [flake8] # H803 skipped on purpose per list discussion. # E123, E125 skipped as they are invalid PEP-8. @@ -41,4 +38,4 @@ commands = python setup.py build_sphinx ignore = E123,E125,E126,E128,E129,E265,H301,H305,H307,H402,H404,H405,H904,H803 show-source = True builtins = _ -exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build +exclude=.venv,.git,.tox,dist,*openstack/common*,*lib/python*,*egg,build