From 44fed344d12a4b867051b24aab22584e6ac32ce5 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Fri, 1 Dec 2017 16:44:57 -0600 Subject: [PATCH] Clean up some initial repo creation boilerplate Minor cleanup of things not needed for our tempest plugin. Change-Id: Ib309cb1f87211e82eae0d27fa2464ec13a9deca6 Needed-by: I5ff95ca13f02ed6e0afb35f0d6bb5c36d4111f5a Implements: blueprint goal-split-tempest-plugin --- .gitreview | 2 +- CONTRIBUTING.rst | 2 +- README.rst | 70 ++++- bindep.txt | 3 + cinder/tests/tempest/README.rst | 61 ----- releasenotes/notes/.placeholder | 0 releasenotes/source/_static/.placeholder | 0 releasenotes/source/_templates/.placeholder | 0 releasenotes/source/conf.py | 280 -------------------- releasenotes/source/index.rst | 8 - releasenotes/source/unreleased.rst | 5 - setup.cfg | 5 +- test-requirements.txt | 4 +- tox.ini | 15 +- 14 files changed, 65 insertions(+), 390 deletions(-) create mode 100644 bindep.txt delete mode 100644 cinder/tests/tempest/README.rst delete mode 100644 releasenotes/notes/.placeholder delete mode 100644 releasenotes/source/_static/.placeholder delete mode 100644 releasenotes/source/_templates/.placeholder delete mode 100644 releasenotes/source/conf.py delete mode 100644 releasenotes/source/index.rst delete mode 100644 releasenotes/source/unreleased.rst diff --git a/.gitreview b/.gitreview index 164aca3..e507b59 100644 --- a/.gitreview +++ b/.gitreview @@ -1,4 +1,4 @@ [gerrit] host=review.openstack.org port=29418 -project=openstack/keystone-tempest-plugin.git +project=openstack/cinder-tempest-plugin.git diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 574481a..0ce69d1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -14,4 +14,4 @@ Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: - https://bugs.launchpad.net/cinder_tempest_plugin + https://bugs.launchpad.net/cinder diff --git a/README.rst b/README.rst index 27ca590..d7ab3a1 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,61 @@ -=============================== -cinder_tempest_plugin -=============================== +=============================================== +Tempest Integration for Cinder +=============================================== -It contains tempest plugin tests for Cinder. +This directory contains additional Cinder tempest tests. -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. +See the tempest plugin docs for information on using it: +https://docs.openstack.org/tempest/latest/plugin.html#using-plugins -* Free software: Apache license -* Documentation: http://docs.openstack.org/developer/openstack -* Source: http://git.openstack.org/cgit/cinder-tempest-plugin -* Bugs: http://bugs.launchpad.net/cinder-tempest-plugin +To run all tests from this plugin, install cinder into your environment. Then +from the tempest directory run:: -Features --------- + $ tox -e all-plugin -- volume + + +It is expected that Cinder third party CI's use the all-plugin tox environment +above for all test runs. Developers can also use this locally to perform more +extensive testing. + +Any typical devstack instance should be able to run all Cinder plugin tests. +For completeness, here is an example of a devstack local.conf that should +work. Update backend information to fit your environment. + +:: + + [[local|localrc]] + VIRT_DRIVER=libvirt + ADMIN_PASSWORD=secret + SERVICE_TOKEN=$ADMIN_PASSWORD + MYSQL_PASSWORD=$ADMIN_PASSWORD + RABBIT_PASSWORD=$ADMIN_PASSWORD + SERVICE_PASSWORD=$ADMIN_PASSWORD + LOGFILE=$DEST/logs/stack.sh.log + LOGDAYS=2 + SYSLOG=False + LOG_COLOR=False + RECLONE=yes + ENABLED_SERVICES=c-api,c-sch,c-vol,cinder,dstat,g-api,g-reg,key,mysql, + n-api,n-cond,n-cpu,n-crt,n-net,n-sch,rabbit,tempest + CINDER_ENABLED_BACKENDS=lvmdriver-1 + CINDER_DEFAULT_VOLUME_TYPE=lvmdriver-1 + CINDER_VOLUME_CLEAR=none + TEMPEST_ENABLED_BACKENDS=lvmdriver-1 + TEMPEST_VOLUME_DRIVER=lvmdriver-1 + TEMPEST_VOLUME_VENDOR="Open Source" + TEMPEST_STORAGE_PROTOCOL=iSCSI + LIBVIRT_FIREWALL_DRIVER=nova.virt.firewall.NoopFirewallDriver + VIRT_DRIVER=libvirt + ACTIVE_TIMEOUT=120 + BOOT_TIMEOUT=120 + ASSOCIATE_TIMEOUT=120 + TERMINATE_TIMEOUT=120 + + + [[post-config|$CINDER_CONF]] + [DEFAULT] + [lvmdriver-1] + volume_driver=cinder.volume.drivers.lvm.LVMISCSIDriver + volume_group=stack-volumes-1 + volume_backend_name=lvmdriver-1 -* TODO diff --git a/bindep.txt b/bindep.txt new file mode 100644 index 0000000..90f9a3a --- /dev/null +++ b/bindep.txt @@ -0,0 +1,3 @@ +# No extra binaries needed for this repo directly. +# This file is added in case of future needs, and to prevent fallback to the +# full default package list. diff --git a/cinder/tests/tempest/README.rst b/cinder/tests/tempest/README.rst deleted file mode 100644 index 079321d..0000000 --- a/cinder/tests/tempest/README.rst +++ /dev/null @@ -1,61 +0,0 @@ -=============================================== -Tempest Integration for Cinder -=============================================== - -This directory contains additional Cinder tempest tests. - -See the tempest plugin docs for information on using it: -https://docs.openstack.org/tempest/latest/plugin.html#using-plugins - -To run all tests from this plugin, install cinder into your environment. Then -from the tempest directory run:: - - $ tox -e all-plugin -- volume - - -It is expected that Cinder third party CI's use the all-plugin tox environment -above for all test runs. Developers can also use this locally to perform more -extensive testing. - -Any typical devstack instance should be able to run all Cinder plugin tests. -For completeness, here is an example of a devstack local.conf that should -work. Update backend information to fit your environment. - -:: - - [[local|localrc]] - VIRT_DRIVER=libvirt - ADMIN_PASSWORD=secret - SERVICE_TOKEN=$ADMIN_PASSWORD - MYSQL_PASSWORD=$ADMIN_PASSWORD - RABBIT_PASSWORD=$ADMIN_PASSWORD - SERVICE_PASSWORD=$ADMIN_PASSWORD - LOGFILE=$DEST/logs/stack.sh.log - LOGDAYS=2 - SYSLOG=False - LOG_COLOR=False - RECLONE=yes - ENABLED_SERVICES=c-api,c-sch,c-vol,cinder,dstat,g-api,g-reg,key,mysql, - n-api,n-cond,n-cpu,n-crt,n-net,n-sch,rabbit,tempest - CINDER_ENABLED_BACKENDS=lvmdriver-1 - CINDER_DEFAULT_VOLUME_TYPE=lvmdriver-1 - CINDER_VOLUME_CLEAR=none - TEMPEST_ENABLED_BACKENDS=lvmdriver-1 - TEMPEST_VOLUME_DRIVER=lvmdriver-1 - TEMPEST_VOLUME_VENDOR="Open Source" - TEMPEST_STORAGE_PROTOCOL=iSCSI - LIBVIRT_FIREWALL_DRIVER=nova.virt.firewall.NoopFirewallDriver - VIRT_DRIVER=libvirt - ACTIVE_TIMEOUT=120 - BOOT_TIMEOUT=120 - ASSOCIATE_TIMEOUT=120 - TERMINATE_TIMEOUT=120 - - - [[post-config|$CINDER_CONF]] - [DEFAULT] - [lvmdriver-1] - volume_driver=cinder.volume.drivers.lvm.LVMISCSIDriver - volume_group=stack-volumes-1 - volume_backend_name=lvmdriver-1`` - diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py deleted file mode 100644 index aa4787b..0000000 --- a/releasenotes/source/conf.py +++ /dev/null @@ -1,280 +0,0 @@ -# -*- coding: utf-8 -*- -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# 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. - -# 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 = [ - 'openstackdocstheme', - 'reno.sphinxext', -] - -# 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'cinder_tempest_plugin Release Notes' -copyright = u'2017, OpenStack Developers' - -# openstackdocstheme options -repository_name = 'cinder_tempest_plugin/cinder_tempest_plugin' -bug_project = 'cinder_tempest_plugin' -bug_tag = '' - -# 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. -# The full version, including alpha/beta/rc tags. -release = '' -# The short X.Y version. -version = '' - -# 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 = [] - -# 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 = [] - -# 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 = 'openstackdocs' - -# 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'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# 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 = 'cinder_tempest_pluginReleaseNotesdoc' - - -# -- 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, or own class]). -latex_documents = [ - ('index', 'cinder_tempest_pluginReleaseNotes.tex', - u'cinder_tempest_plugin Release Notes Documentation', - u'OpenStack Foundation', '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', 'cinder_tempest_pluginrereleasenotes', - u'cinder_tempest_plugin Release Notes Documentation', - [u'OpenStack Foundation'], 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', 'cinder_tempest_plugin ReleaseNotes', - u'cinder_tempest_plugin Release Notes Documentation', - u'OpenStack Foundation', 'cinder_tempest_pluginReleaseNotes', - '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' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - -# -- Options for Internationalization output ------------------------------ -locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst deleted file mode 100644 index d03a6bb..0000000 --- a/releasenotes/source/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -============================================ - cinder_tempest_plugin Release Notes -============================================ - -.. toctree:: - :maxdepth: 1 - - unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst deleted file mode 100644 index cd22aab..0000000 --- a/releasenotes/source/unreleased.rst +++ /dev/null @@ -1,5 +0,0 @@ -============================== - Current Series Release Notes -============================== - -.. release-notes:: diff --git a/setup.cfg b/setup.cfg index d355947..879c210 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = cinder_tempest_plugin -summary = It contains tempest plugin tests for Cinder. +summary = Tempest plugin tests for Cinder. description-file = README.rst author = OpenStack @@ -16,8 +16,7 @@ classifier = Programming Language :: Python :: 2 Programming Language :: Python :: 2.7 Programming Language :: Python :: 3 - Programming Language :: Python :: 3.3 - Programming Language :: Python :: 3.4 + Programming Language :: Python :: 3.5 [files] packages = diff --git a/test-requirements.txt b/test-requirements.txt index f559c0e..c769ab7 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,7 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -hacking>=0.12.0,<0.13 # Apache-2.0 +hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage>=4.0,!=4.4 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD @@ -11,5 +11,3 @@ oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT openstackdocstheme>=1.11.0 # Apache-2.0 -# releasenotes -reno>=1.8.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index c888992..328da2e 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 2.0 -envlist = py34,py27,pypy,pep8 +envlist = pep8 skipsdist = True [testenv] @@ -18,19 +18,6 @@ commands = flake8 {posargs} [testenv:venv] commands = {posargs} -[testenv:cover] -commands = python setup.py test --coverage --testr-args='{posargs}' - -[testenv:docs] -commands = python setup.py build_sphinx - -[testenv:releasenotes] -commands = - sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html - -[testenv:debug] -commands = oslo_debug_helper {posargs} - [flake8] # E123, E125 skipped as they are invalid PEP-8.