Initial commit

Add file repository structure
* AUTHORS
* Changelog
* LICENSE
* README.rst
* doc
* specs
* tests
* requirements.txt
* setup.py
* setup.cfg
* tox.ini
* tools

Change-Id: Icc4b0f58f50a019b7cd7dfaf945ebd7b1ba87a89

.gitignore

@@ -0,0 +1,6 @@
+*.pyc
+.venv
+doc/source/index.rst
+doc/build
+.tox
+.testrepository

.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

AUTHORS

@@ -0,0 +1 @@
+Vladimir Kozhukalov <vkozhukalov@mirantis.com>

ChangeLog

@@ -0,0 +1,5 @@
+CHANGES
+=======
+
+* Initial commit
+* Added .gitreview

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

README.rst

@@ -0,0 +1,39 @@
+========================
+Packetary Specifications
+========================
+
+This git repository is used to hold approved design specifications for additions
+to the Packetary project.  Reviews of the specs are done in gerrit, using a similar
+workflow to how we review and merge changes to the code itself.
+
+The layout of this repository is::
+
+  specs/<release>/
+
+You can find an example spec in `doc/source/specs/template.rst`.
+
+Specifications are proposed for a given release by adding them to the
+`specs/<release>` directory and posting it for review.  The implementation
+status of a blueprint for a given release can be found by looking at the
+blueprint in launchpad.  Not all approved blueprints will get fully implemented.
+
+Specifications have to be re-proposed for every release.  The review may be
+quick, but even if something was previously approved, it should be re-reviewed
+to make sure it still makes sense as written.
+
+Please note, Launchpad blueprints are still used for tracking the
+current status of blueprints. For more information, see::
+
+  https://wiki.openstack.org/wiki/Blueprints
+
+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.

doc/source/conf.py

@@ -0,0 +1,303 @@
+# -*- 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 subprocess
+import sys
+import os
+import os.path
+import glob
+
+# 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.intersphinx',
+              'sphinx.ext.todo',
+              'sphinx.ext.viewcode',
+              'oslosphinx',
+              'sphinxcontrib.httpdomain',
+             ]
+
+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'Packetary Specs'
+copyright = u'2016, Packetary'
+
+# 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 = ['packetary-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
+# "<project> v<release> 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 = subprocess.Popen(
+    git_cmd, stdout=subprocess.PIPE).communicate()[0]
+
+# 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 <link> 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 = 'Packetary-Specsdoc'
+
+confdir = os.path.dirname(os.path.abspath(__file__))
+workdir = os.path.join(confdir, "..", "..")
+releases = [os.path.basename(dirname) for dirname in
+            glob.iglob("{0}/specs/[0-9]*.[0-9]*(.[0.9]*)*".format(workdir))]
+
+with open(os.path.join(confdir, 'header.rst.template')) as f:
+    header = f.read()
+
+with open(os.path.join(confdir, 'footer.rst.template')) as f:
+    footer = f.read()
+
+with open(os.path.join(confdir, 'index.rst'), 'w') as f:
+    f.write(header)
+
+    for specdir in sorted(releases):
+        f.write("""
+{0} approved specs:
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   specs/{0}/*
+
+
+""".format(specdir))
+
+    f.write(footer)
+
+# -- 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', 'packetary-specs.tex', u'Packetary Specs',
+   u'Packetary 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', 'packetary-specs', u'Packetary Design Specs',
+   u'Packetary Team', 'packetary-specs',
+   'Design specifications for the packetary 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'Packetary Specs'
+epub_author = u'Packetary Team'
+epub_publisher = u'Packetary Team'
+epub_copyright = u'2016, Packetary'
+
+# 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

doc/source/footer.rst.template

@@ -0,0 +1,6 @@
+==================
+Indices and tables
+==================
+
+* :ref:`search`
+

doc/source/header.rst.template

@@ -0,0 +1,12 @@
+.. packetary-specs documentation master file
+
+================================
+Packetary Project Specifications
+================================
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   specs/*
+

doc/source/policy

@@ -0,0 +1 @@
+../../policy

doc/source/specs

@@ -0,0 +1 @@
+../../specs

requirements.txt

@@ -0,0 +1,7 @@
+docutils==0.9.1
+oslosphinx
+pbr>=0.6,!=0.7,<1.0
+sphinx>=1.1.2,!=1.2.0,<1.3
+testrepository>=0.0.18
+testtools>=0.9.34
+sphinxcontrib-httpdomain

setup.cfg

@@ -0,0 +1,23 @@
+[metadata]
+name = packetary-specs
+summary = Packetary Project Development Specs
+description-file =
+    README.rst
+author = OpenStack
+author-email = packetary-dev@lists.launchpad.net
+home-page = https://wiki.openstack.org/wiki/Packetary
+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

setup.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+# Copyright (c) 2016 Mirantis, Inc.
+#
+# 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)

specs/template.rst

@@ -0,0 +1,137 @@
+..
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
+ License.
+
+ http://creativecommons.org/licenses/by/3.0/legalcode
+
+==========================================
+Example Spec - The title of your blueprint
+==========================================
+
+Include the URL of your launchpad blueprint:
+
+https://blueprints.launchpad.net/packetary/+spec/example
+
+Introduction paragraph -- why is it necessary to do anything?
+A single paragraph of prose that reviewers can understand.
+
+Some notes about using this template:
+
+* Your spec should be in ReSTructured text, like this template.
+
+* Please wrap text at 79 columns.
+
+* The spec should be gender neutral and written in the third person aspect
+
+* The filename in the git repository should match the launchpad URL, for
+  example a URL of:
+  https://blueprints.launchpad.net/packetary/+spec/awesome-thing
+  should be named awesome-thing.rst
+
+* 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, or see:
+  http://rst.ninjs.org
+
+* 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 in-line feedback on the diagram itself.
+
+
+--------------------
+Problem description
+--------------------
+
+A detailed description of the problem:
+
+* For a new feature this might be use cases. Ensure you are clear about the
+  actors in each use case: End User vs Deploy engineer
+
+* For a major reworking of something existing it would describe the
+  problems in that feature that are being addressed.
+
+
+----------------
+Proposed changes
+----------------
+
+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?
+
+
+------------
+Alternatives
+------------
+
+What are other ways of achieving the same results? Why aren't they followed?
+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.
+
+
+--------------
+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:
+  <launchpad-id or None>
+
+Other contributors:
+  <launchpad-id or None>
+
+Mandatory design review:
+  <launchpad-id or None>
+
+
+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 Packetary,
+  or in other projects, that this one either depends on or is related to.
+
+* Does this feature require any new library dependencies or code otherwise not
+  included in Packetary? Or does it depend on a specific version of library?
+
+
+----------
+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 relevant research, if appropriate
+
+* Related specifications as appropriate
+
+* Anything else you feel it is worthwhile to refer to
+

tests/base.py

@@ -0,0 +1,83 @@
+# 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.
+
+import glob
+import re
+
+import docutils.core
+import testtools
+
+
+class BaseDocTest(testtools.TestCase):
+
+    def build_structure(self, spec):
+        section = {}
+        name = ''
+
+        for node in spec:
+            if node.tagname == 'title':
+                name = node.rawsource
+            elif node.tagname == 'section':
+                subsection, subsection_name = self.build_structure(node)
+                section[subsection_name] = subsection
+
+        return section, name
+
+    def verify_structure(self, fname, struct,
+                         expected_struct, supersection=None):
+        expected_titles = expected_struct.keys()
+        real_titles = struct.keys()
+
+        for t in expected_titles:
+            self.assertIn(t, real_titles)
+
+            substruct = expected_struct[t]
+
+            if substruct is not None:
+                self.verify_structure(fname, struct[t], substruct, t)
+
+    def check_lines_wrapping(self, tpl, raw):
+        for i, line in enumerate(raw.split('\n')):
+            if 'http://' in line or 'https://' in line:
+                continue
+            self.assertTrue(
+                len(line.decode("utf-8")) < 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 test_template(self):
+        files = self.files
+        versions = self.versions
+
+        for v in versions:
+            files.extend(glob.glob('specs/%s/*' % v))
+
+        # filtering images subdirectory
+        files = filter(lambda x: 'images' not in x, files)
+        for filename in files:
+            self.assertTrue(filename.endswith('.rst'),
+                            'Specification files must use .rst extensions.')
+            with open(filename) as f:
+                data = f.read()
+
+            spec = docutils.core.publish_doctree(data)
+            document, name = self.build_structure(spec)
+            self.verify_structure(filename, document, self.expected_structure)
+            self.check_lines_wrapping(filename, data)
+            self.check_no_cr(filename, data)

tests/test_titles.py

@@ -0,0 +1,29 @@
+# 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.
+
+from tests import base
+
+class TestTitles(base.BaseDocTest):
+    expected_structure = {
+        'Problem description': None,
+        'Proposed changes': None,
+        'Alternatives': None,
+        'Implementation': {
+            'Assignee(s)': None,
+            'Dependencies': None,
+            'Work Items': None,
+        },
+        'References': None
+    }
+
+    files = ['specs/template.rst']
+    versions = ('0.2.0', '0.3.0',)

tools/with_venv.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+tools_path=${tools_path:-$(dirname $0)}
+venv_path=${venv_path:-${tools_path}}
+venv_dir=${venv_name:-/../.venv}
+TOOLS=${tools_path}
+VENV=${venv:-${venv_path}/${venv_dir}}
+source ${VENV}/bin/activate && "$@"

tox.ini

@@ -0,0 +1,20 @@
+[tox]
+minversion = 1.6
+envlist = docs,py27
+skipsdist = True
+
+[testenv]
+usedevelop = True
+setenv = VIRTUAL_ENV={envdir}
+install_command = pip install -U {opts} {packages}
+passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
+deps = -r{toxinidir}/requirements.txt
+commands = python setup.py testr --slowest --testr-args='{posargs:}'
+
+[testenv:venv]
+commands = {posargs}
+basepython = python
+
+[testenv:docs]
+commands = python setup.py build_sphinx
+basepython = python