diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b774adf --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +AUTHORS +ChangeLog +build +.tox +.venv +*.egg* +*.swp +*.swo +*.pyc +.testrepository \ No newline at end of file diff --git a/.testr.conf b/.testr.conf new file mode 100644 index 0000000..1641f86 --- /dev/null +++ b/.testr.conf @@ -0,0 +1,4 @@ +[DEFAULT] +test_command=OS_STDOUT_CAPTURE=1 OS_STDERR_CAPTURE=1 OS_TEST_TIMEOUT=60 ${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION +test_id_option=--load-list $IDFILE +test_list_option=--list diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..75a29c4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,3 @@ +This work is licensed under a Creative Commons Attribution 3.0 Unported License. + +http://creativecommons.org/licenses/by/3.0/legalcode diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6e119cb --- /dev/null +++ b/README.rst @@ -0,0 +1,152 @@ +======= +README +======= + +NextGen Specifications +====================== + + +This git repository is used to hold approved design specifications for the +NextGen project. Reviews of the specs are done in gerrit, using a similar +workflow to how we review and merge changes to the code itself. For specific +policies around specification review, refer to the end of this document. + +The layout of this repository is:: + + specs// + +Where there are two sub-directories: + + specs//approved: specifications approved but not yet implemented + specs//implemented: implemented specifications + +The lifecycle of a specification +-------------------------------- + +TODO(slukjanov): Cleanup the readme for NextGen case. + +Developers proposing a specification should propose a new file in the +``approved`` directory. nextgen-specs-core will review the change in the usual +manner for the OpenStack project, and eventually it will get merged if a +consensus is reached. At this time the Launchpad blueprint is also approved. +The developer is then free to propose code reviews to implement their +specification. These reviews should be sure to reference the Launchpad +blueprint in their commit message for tracking purposes. + +Once all code for the feature is merged into Nova, the Launchpad blueprint is +marked complete. As the developer of an approved specification it is your +responsibility to mark your blueprint complete when all of the required +patches have merged. + +Periodically, someone from nextgen-specs-core will move implemented specifications +from the ``approved`` directory to the ``implemented`` directory. Whilst +individual developers are welcome to propose this move for their implemented +specifications, we have generally just done this in a batch at the end of the +release cycle. It is important to create redirects when this is done so that +existing links to the approved specification are not broken. Redirects aren't +symbolic links, they are defined in a file which sphinx consumes. An example +is at ``specs/kilo/redirects``. + +This directory structure allows you to see what we thought about doing, +decided to do, and actually got done. Users interested in functionality in a +given release should only refer to the ``implemented`` directory. + +Example specifications +---------------------- + +You can find an example spec in ``specs/template.rst``. + +Backlog specifications +---------------------- + +Additionally, we allow the proposal of specifications that do not have a +developer assigned to them. These are proposed for review in the same manner as +above, but are added to:: + + specs/backlog/approved + +Specifications in this directory indicate the original author has either +become unavailable, or has indicated that they are not going to implement the +specification. The specifications found here are available as projects for +people looking to get involved with Nova. If you are interested in +claiming a spec, start by posting a review for the specification that moves it +from this directory to the next active release. Please set yourself as the new +`primary assignee` and maintain the original author in the `other contributors` +list. + +Design documents for releases prior to Juno +------------------------------------------- + +Prior to the Juno development cycle, this repository was not used for spec +reviews. Reviews prior to Juno were completed entirely through `Launchpad +blueprints `_ + +Please note, Launchpad blueprints are still used for tracking the +current status of blueprints. For more information, see +https://wiki.openstack.org/wiki/Blueprints + +Working with gerrit and specification unit tests +------------------------------------------------ + +For more information about working with gerrit, see +http://docs.openstack.org/infra/manual/developers.html#development-workflow + +To validate that the specification is syntactically correct (i.e. get more +confidence in the Jenkins result), please execute the following command:: + + $ tox + +After running ``tox``, the documentation will be available for viewing in HTML +format in the ``doc/build/`` directory. + +Specification review policies +============================= + +There are a number of review policies which nextgen-specs-core will apply when +reviewing proposed specifications. They are: + +Trivial specifications +---------------------- + +Proposed changes which are trivial (very small amounts of code) and don't +change any of our public APIs are sometimes not required to provide a +specification. In these cases a Launchpad blueprint is considered sufficient. +These proposals are approved during the `Open Discussion` portion of the +weekly nova IRC meeting. If you think your proposed feature is trivial and +meets these requirements, we recommend you bring it up for discussion there +before writing a full specification. + +Previously approved specifications +---------------------------------- + +`Specifications are only approved for a single release`. If your specification +was previously approved but not implemented (or not completely implemented), +then you must seek re-approval for the specification. You can re-propose your +specification by doing the following: + +* Copy (not move) your specification to the right directory for the current release. +* Update the document to comply with the new template. +* If there are no functional changes to the specification (only template changes) then add the `Previously-approved: ` tag to your commit message. +* Send for review. +* nextgen-specs-core will merge specifications which meet these requirements with a single +2. + +Specifications which depend on merging code in other OpenStack projects +----------------------------------------------------------------------- + +For specifications `that depend on code in other OpenStack projects merging` +we will not approve the nova specification until the code in that other project +has merged. The best example of this is Cinder and Neutron drivers. To +indicate your specification is in this state, please use the Depends-On git +commit message tag. The correct format is `Depends-On: `. nextgen-specs-core can approve the specification at any time, but it wont +merge until the code we need to land in the other project has merged as well. + +New libvirt image backends +-------------------------- + +There are some cases where an author might propose adding a new libvirt +driver image storage backend which does not require code in other OpenStack +projects. An example was the ceph image storage backend, if we treat that as +separate from the ceph volume support code. Implementing a new image storage +backend in the libvirt drive always requires a specification because of our +historical concerns around adequate CI testing. diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..0a4a6e7 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,276 @@ +# -*- 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 datetime +import sys +import 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 = ['redirect', + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode', + 'oslosphinx', + 'yasfb', + ] + +# Feed configuration for yasfb +# feed_base_url = 'TBD' +# feed_author = 'NextGen Team' + +todo_include_todos = True + +# 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'NextGen Specs' +copyright = u'%s, NextGen Team' % datetime.date.today().year + +# 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 = ['nextgen-specs.'] + +# -- Options for man page output ---------------------------------------------- +man_pages = [] + +# -- 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 = 'nature' + +# 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 + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1" +html_last_updated_fmt = os.popen(git_cmd).read() + +# 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 = False + +# If false, no index is generated. +html_use_index = False + +# 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 = 'NextGen-Specsdoc' + + +# -- 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', 'NextGen-specs.tex', u'NextGen Specs', + u'NextGen Team', '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 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', 'NextGen-specs', u'NextGen Design Specs', + u'NextGen Team', 'nextgen-specs', 'Design specifications for the NextGen 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'NextGen Specs' +epub_author = u'NextGen Team' +epub_publisher = u'NextGen Team' +epub_copyright = u'2014, NextGen Team' + +# 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/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..8ddf70d --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,53 @@ +.. nextgen-specs documentation master file + +============================== +NextGen Project Specifications +============================== + +Priorities +========== + +Lists of the most priority specs: + +.. toctree:: + :glob: + :maxdepth: 1 + + priorities/initial-priorities + +Specifications +============== + +Here you can find the specs, and spec templates: + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/initial/approved/* + +There are also some approved backlog specifications that are looking for owners: + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/backlog/approved/* + +Process +======= + +Documentation for nextgen-specs process: + +.. toctree:: + :maxdepth: 1 + + How to submit a spec + +For more details, look at spec template for the specific release, and see the +wiki page on Blueprints: https://wiki.openstack.org/wiki/Blueprints + +Indices and tables +================== + +* :ref:`search` diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 0000000..a6210d3 --- /dev/null +++ b/doc/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst diff --git a/doc/source/redirect.py b/doc/source/redirect.py new file mode 100644 index 0000000..a0b9637 --- /dev/null +++ b/doc/source/redirect.py @@ -0,0 +1,52 @@ +# Copied from openstack/nova-specs + +# A simple sphinx plugin which creates HTML redirections from old names +# to new names. It does this by looking for files named "redirect" in +# the documentation source and using the contents to create simple HTML +# redirection pages for changed filenames. + +import os.path + +from sphinx.application import ENV_PICKLE_FILENAME +from sphinx.util.console import bold + + +def setup(app): + from sphinx.application import Sphinx + if not isinstance(app, Sphinx): + return + app.connect('build-finished', emit_redirects) + + +def process_redirect_file(app, path, ent): + parent_path = path.replace(app.builder.srcdir, app.builder.outdir) + with open(os.path.join(path, ent)) as redirects: + for line in redirects.readlines(): + from_path, to_path = line.rstrip().split(' ') + from_path = from_path.replace('.rst', '.html') + to_path = to_path.replace('.rst', '.html') + + redirected_filename = os.path.join(parent_path, from_path) + redirected_directory = os.path.dirname(redirected_filename) + if not os.path.exists(redirected_directory): + os.makedirs(redirected_directory) + with open(redirected_filename, 'w') as f: + f.write('' + % to_path) + + +def emit_redirects(app, exc): + app.builder.info(bold('scanning %s for redirects...') % app.builder.srcdir) + + def process_directory(path): + for ent in os.listdir(path): + p = os.path.join(path, ent) + if os.path.isdir(p): + process_directory(p) + elif ent == 'redirects': + app.builder.info(' found redirects at %s' % p) + process_redirect_file(app, path, ent) + + process_directory(app.builder.srcdir) + app.builder.info('...done') diff --git a/doc/source/redirects b/doc/source/redirects new file mode 120000 index 0000000..af65f09 --- /dev/null +++ b/doc/source/redirects @@ -0,0 +1 @@ +../../specs/redirects \ No newline at end of file diff --git a/doc/source/specs b/doc/source/specs new file mode 120000 index 0000000..87a4030 --- /dev/null +++ b/doc/source/specs @@ -0,0 +1 @@ +../../specs \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..5aaaa59 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +oslosphinx +pbr>=1.6 # Apache-2.0 +sphinx>=1.1.2,<1.2 +testrepository>=0.0.18 +testtools>=0.9.34 +yasfb>=0.5.1 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..46cd0b8 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,23 @@ +[metadata] +name = nextgen-specs +summary = NextGen Project Development Specs +description-file = + README.rst +author = NextGen +author-email = nextgen-all@mirantis.com +home-page = http://mirantis.jira.com/wiki/display/NG/ +classifier = + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source + +[pbr] +warnerrors = True + +[wheel] +universal = 1 diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..70c2b3f --- /dev/null +++ b/setup.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. +# +# 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 MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/specs/redirects b/specs/redirects new file mode 100644 index 0000000..e69de29 diff --git a/specs/template.rst b/specs/template.rst new file mode 100644 index 0000000..4dd1ddb --- /dev/null +++ b/specs/template.rst @@ -0,0 +1,179 @@ +===================================== +Example Spec - The title of your epic +===================================== + +Include the URL of your Jira Epic. + +Introduction paragraph -- why are we doing anything? A single paragraph of +prose that operators can understand. The title and this first paragraph +should be used as the subject line and body of the commit message +respectively. + +TODO(slukjanov): detailed notes about spec process. + +Some notes about using this template: + +* Your spec should be in ReSTructured text, like this template. + +* Please wrap text at 79 columns. + +.. * The filename in the git repository should match the Epic short name + +* Please do not delete any of the sections in this template. If you have + nothing to say for a whole section, just write: None + +* For help with syntax, see http://sphinx-doc.org/rest.html + +* To test out your formatting, build the docs using tox and see the generated + HTML file in doc/build/html/specs/ + +.. * If you would like to provide a diagram with your spec, ascii diagrams are + required. http://asciiflow.com/ is a very nice tool to assist with making + ascii diagrams. The reason for this is that the tool used to review specs is + based purely on plain text. Plain text will allow review to proceed without + having to look at additional files which can not be viewed in gerrit. It + will also allow inline feedback on the diagram itself. + + +Problem description +=================== + +A detailed description of the problem. What problem is this blueprint +addressing? + +Use Cases +--------- + +What use cases does this address? What impact on actors does this change have? +Ensure you are clear about the actors in each use case: Developer, End User, +Deployer etc. + +Proposed change +=============== + +Here is where you cover the change you propose to make in detail. How do you +propose to solve this problem? + +If this is one part of a larger effort make it clear where this piece ends. In +other words, what's the scope of this effort? + +At this point, if you would like to just get feedback on if the problem and +proposed change fit in project, you can stop here and post this for review to get +preliminary feedback. If so please say: +Posting to get preliminary feedback on the scope of this spec. + +Alternatives +------------ + +What other ways could we do this thing? Why aren't we using those? This doesn't +have to be a full literature review, but it should demonstrate that thought has +been put into why the proposed solution is an appropriate one. + +TODO(slukjanov) impacts +----------------------- + +Implementation +============== + +Assignee(s) +----------- + +Who is leading the writing of the code? Or is this a blueprint where you're +throwing it out there to see who picks it up? + +If more than one person is working on the implementation, please designate the +primary author and contact. + +Primary assignee: + + +Other contributors: + + +Work Items +---------- + +Work items or tasks -- break the feature up into the things that need to be +done to implement it. Those parts might end up being done by different people, +but we're mostly trying to understand the timeline for implementation. + + +Dependencies +============ + +* Include specific references to specs and/or blueprints in NextGen, or in other + projects, that this one either depends on or is related to. + +.. * If this requires functionality of another project that is not currently used +.. by NextGen (such as the glance v2 API when we previously only required v1), +.. document that fact. + +* Does this feature require any new library dependencies or code otherwise not + included in OpenStack? Or does it depend on a specific version of library? + + +Testing +======= + +Please discuss the important scenarios needed to test here, as well as +specific edge cases we should be ensuring work correctly. For each +scenario please specify if this requires specialized hardware, a full +openstack environment, or can be simulated inside the NextGen tree. + +Please discuss how the change will be tested. We especially want to know what +tempest tests will be added. It is assumed that unit test coverage will be +added so that doesn't need to be mentioned explicitly, but discussion of why +you think unit tests are sufficient and we don't need to add more tempest +tests would need to be included. + +Is this untestable in gate given current limitations (specific hardware / +software configurations available)? If so, are there mitigation plans (3rd +party testing, gate enhancements, etc). + + +Documentation Impact +==================== + +Which audiences are affected most by this change, and which documentation +titles on docs.openstack.org should be updated because of this change? Don't +repeat details discussed above, but reference them here in the context of +documentation for multiple audiences. For example, the Operations Guide targets +cloud operators, and the End User Guide would need to be updated if the change +offers a new feature available through the CLI or dashboard. If a config option +changes or is deprecated, note here that the documentation needs to be updated +to reflect this specification's change. + +References +========== + +Please add any useful references here. You are not required to have any +reference. Moreover, this specification should still make sense when your +references are unavailable. Examples of what you could include are: + +* Links to mailing list or IRC discussions + +* Links to notes from a summit session + +* Links to relevant research, if appropriate + +* Related specifications as appropriate (e.g. if it's an EC2 thing, link the + EC2 docs) + +* Anything else you feel it is worthwhile to refer to + + +History +======= + +Optional section for Mitaka intended to be used each time the spec +is updated to describe new design, API or any database schema +updated. Useful to let reader understand what's happened along the +time. + +.. list-table:: Revisions + :header-rows: 1 + + * - Release Name + - Description + * - Mitaka + - Introduced diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..86f503a --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,5 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +hacking>=0.10.0,<0.11 diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_directories.py b/tests/test_directories.py new file mode 100644 index 0000000..a5c356f --- /dev/null +++ b/tests/test_directories.py @@ -0,0 +1,34 @@ +# 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. + +# Copied from openstack/nova-specs + +import glob +import os + +import testtools + + +class TestDirectories(testtools.TestCase): + + def test_directories(self): + releases = [x.split('/')[1] for x in glob.glob('specs/*/')] + for release in releases: + files = os.listdir("specs/%s/" % release) + valid = ['redirects', 'implemented', 'approved'] + for name in files: + if name.startswith('.'): + continue + self.assertIn(name, valid, + "Found unexpected file in " + "'specs/%s', specs should be submitted to " + "'specs/%s/approved'" % (release, release)) diff --git a/tests/test_titles.py b/tests/test_titles.py new file mode 100644 index 0000000..dcb2673 --- /dev/null +++ b/tests/test_titles.py @@ -0,0 +1,129 @@ +# 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. + +# Copied from openstack/nova-specs + +import glob +import re + +import docutils.core +import testtools + + +# Used for new sections introduced during a release. +# - "History" introduced in Liberty should be +# mandatory for M. +OPTIONAL_SECTIONS = ("History",) + + +class TestTitles(testtools.TestCase): + def _get_title(self, section_tree): + section = { + 'subtitles': [], + } + for node in section_tree: + if node.tagname == 'title': + section['name'] = node.rawsource + elif node.tagname == 'section': + subsection = self._get_title(node) + section['subtitles'].append(subsection['name']) + return section + + def _get_titles(self, spec): + titles = {} + for node in spec: + if node.tagname == 'section': + # Note subsection subtitles are thrown away + section = self._get_title(node) + titles[section['name']] = section['subtitles'] + return titles + + def _check_titles(self, filename, expect, actual): + missing_sections = [x for x in expect.keys() if ( + x not in actual.keys()) and (x not in OPTIONAL_SECTIONS)] + extra_sections = [x for x in actual.keys() if x not in expect.keys()] + + msgs = [] + if len(missing_sections) > 0: + msgs.append("Missing sections: %s" % missing_sections) + if len(extra_sections) > 0: + msgs.append("Extra sections: %s" % extra_sections) + + for section in expect.keys(): + missing_subsections = [x for x in expect[section] + if x not in actual.get(section, {})] + # extra subsections are allowed + if len(missing_subsections) > 0: + msgs.append("Section '%s' is missing subsections: %s" + % (section, missing_subsections)) + + if len(msgs) > 0: + self.fail("While checking '%s':\n %s" + % (filename, "\n ".join(msgs))) + + def _check_lines_wrapping(self, tpl, raw): + code_block = False + for i, line in enumerate(raw.split("\n")): + # NOTE(ndipanov): Allow code block lines to be longer than 79 ch + if code_block: + if not line or line.startswith(" "): + continue + else: + code_block = False + if "::" in line: + code_block = True + if "http://" in line or "https://" in line: + continue + # Allow lines which do not contain any whitespace + if re.match("\s*[^\s]+$", line): + continue + self.assertTrue( + len(line) < 80, + msg="%s:%d: Line limited to a maximum of 79 characters." % + (tpl, i + 1)) + + def _check_no_cr(self, tpl, raw): + matches = re.findall('\r', raw) + self.assertEqual( + len(matches), 0, + "Found %s literal carriage returns in file %s" % + (len(matches), tpl)) + + def _check_trailing_spaces(self, tpl, raw): + for i, line in enumerate(raw.split("\n")): + trailing_spaces = re.findall(" +$", line) + self.assertEqual(len(trailing_spaces), 0, + "Found trailing spaces on line %s of %s" % (i + 1, tpl)) + + def test_template(self): + components = [x.split('/')[1] for x in glob.glob('specs/*/')] + self.assertTrue(len(components), "Not able to find spec directories") + for component in components: + with open("specs/%s-template.rst" % component) as f: + template = f.read() + spec = docutils.core.publish_doctree(template) + template_titles = self._get_titles(spec) + + files = glob.glob("specs/%s/*/*" % component) + for filename in files: + self.assertTrue(filename.endswith(".rst"), + "spec %s must use 'rst' extension." + % filename) + with open(filename) as f: + data = f.read() + + spec = docutils.core.publish_doctree(data) + titles = self._get_titles(spec) + self._check_titles(filename, template_titles, titles) + self._check_lines_wrapping(filename, data) + self._check_no_cr(filename, data) + self._check_trailing_spaces(filename, data) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..27cdecd --- /dev/null +++ b/tox.ini @@ -0,0 +1,31 @@ +[tox] +minversion = 1.6 +envlist = docs,py27,pep8 +skipsdist = True + +[testenv] +usedevelop = True +setenv = VIRTUAL_ENV={envdir} +install_command = pip install -U {opts} {packages} +deps = -r{toxinidir}/requirements.txt +whitelist_externals = find +commands = + find . -type f -name "*.pyc" -delete + python setup.py testr --slowest --testr-args='{posargs}' + +[testenv:venv] +commands = {posargs} + +[testenv:docs] +commands = + find . -type f -name "*.pyc" -delete + python setup.py build_sphinx + +[testenv:pep8] +deps = -r{toxinidir}/test-requirements.txt +commands = + flake8 {posargs} + +[flake8] +ignore = E128 +exclude = .venv,.git,.tox,doc,.eggs