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/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
new file mode 100644
index 0000000..3b31283
--- /dev/null
+++ b/.idea/inspectionProfiles/profiles_settings.xml
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.testr.conf b/.testr.conf
new file mode 100644
index 0000000..8819686
--- /dev/null
+++ b/.testr.conf
@@ -0,0 +1,7 @@
+[DEFAULT]
+test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \
+ OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \
+ OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \
+ ${PYTHON:-python} -m subunit.run discover tests $LISTOPT $IDOPTION
+test_id_option=--load-list $IDFILE
+test_list_option=--list
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..cd5fb7c
--- /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
\ No newline at end of file
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..11dcaea
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,57 @@
+===============================
+OpenStack Vitrage Specifications
+===============================
+
+This git repository is used to hold approved design specifications for additions
+to the Vitrage 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//
+
+Where there are two sub-directories:
+
+ specs//approved: specifications approved but not yet implemented
+ specs//implemented: implemented specifications
+
+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.
+
+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/` 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.
+
+Prior to the Kilo development cycle this repository was not used for
+spec reviews. Reviews prior to Juno were completed entirely through
+Launchpad blueprints::
+
+ http://blueprints.launchpad.net/vitrage
+
+Starting from the Kilo-1 development milestone Vitrage performs the pilot of
+the specs repos approach.
+
+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.
\ No newline at end of file
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100644
index 0000000..4339e9d
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,280 @@
+# -*- 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('.'))
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# -- 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',
+ 'yasfb',
+ ]
+
+# Feed configuration for yasfb
+feed_base_url = 'https://wiki.openstack.org/wiki/Vitrage'
+feed_author = 'OpenStack Vitrage 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'Vitrage Specs'
+copyright = u'%s, OpenStack Vitrage 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',
+ '**/template.rst',
+]
+
+# 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 = ['vitrage-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.
+if on_rtd:
+ html_theme = 'sphinx_rtd_theme'
+else:
+ 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 = 'Vitrage-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', 'Vitrage-specs.tex', u'Vitrage Specs',
+ u'OpenStack Vitrage 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', 'Vitrage-specs', u'Vitrage Design Specs',
+ u'OpenStack Vitrage Team', 'vitrage-specs', 'Design specifications for the Vitrage 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'Vitrage Specs'
+epub_author = u'OpenStack Vitrage Team'
+epub_publisher = u'OpenStack Vitrage Team'
+epub_copyright = u'2014, OpenStack Vitrage 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
\ No newline at end of file
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..fffba9f
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,19 @@
+.. vitrage-specs documentation master file
+
+======================
+Vitrage Specifications
+======================
+
+Mitaka specs:
+
+.. toctree::
+ :glob:
+ :maxdepth: 1
+
+ specs/mitaka/*
+
+==================
+Indices and tables
+==================
+
+* :ref:`search`
\ No newline at end of file
diff --git a/doc/source/redirect.py b/doc/source/redirect.py
new file mode 100644
index 0000000..b987038
--- /dev/null
+++ b/doc/source/redirect.py
@@ -0,0 +1,52 @@
+# 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.
+
+# Stolen from openstack/nova-specs
+
+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')
\ No newline at end of file
diff --git a/doc/source/specs b/doc/source/specs
new file mode 120000
index 0000000..e9a536b
--- /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..2b846ea
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,9 @@
+# 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.
+
+pbr>=0.6,!=0.7,<1.0
+sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
+testrepository>=0.0.18
+testtools>=0.9.34
+yasfb
\ No newline at end of file
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..21ec076
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,23 @@
+[metadata]
+name = vitrage-specs
+summary = OpenStack Vitrage Project Development Specs
+description-file =
+ README.rst
+author = OpenStack
+author-email = openstack-dev@lists.openstack.org
+home-page = http://launchpad.net/vitrage
+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
\ No newline at end of file
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..7eeb36b
--- /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)
\ No newline at end of file
diff --git a/specs/mitaka/README.rst b/specs/mitaka/README.rst
new file mode 100644
index 0000000..797939a
--- /dev/null
+++ b/specs/mitaka/README.rst
@@ -0,0 +1,29 @@
+Mitaka specifications
+=====================
+
+This directory is supposed to hold approved specifications for the 'Mitaka' release.
+You are welcome in contributing to Vitrage!
+
+
+Vitrage
+-------
+
+Vitrage Project introduces a Root Cause Analysis (RCA) engine for organizing,
+analyzing and expanding OpenStack alarms & events, yielding insights
+regarding the Root Cause of problems and deducing the existence of problems
+before they are directly detected.
+
+Vitrage Project Resources
+-------------------------
+
+* Project status, bugs, and blueprints are tracked on
+ `Launchpad `_
+
+* Additional resources are linked from the project
+ `Wiki `_ page
+
+
+License
+-------
+
+Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
diff --git a/specs/template.rst b/specs/template.rst
new file mode 100644
index 0000000..4d486de
--- /dev/null
+++ b/specs/template.rst
@@ -0,0 +1,275 @@
+..
+ 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/vitrage/+spec/example
+
+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.
+
+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 launchpad URL, for
+ example a URL of: https://blueprints.launchpad.net/vitrage/+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 inline feedback on the diagram itself.
+
+* If your specification proposes any changes to the Vitrage REST API such
+ as changing parameters which can be returned or accepted, or even
+ the semantics of what happens when a client calls into the API, then
+ you should add the APIImpact flag to the commit message. Specifications with
+ the APIImpact flag can be found with the following query:
+
+ https://review.openstack.org/#/q/status:open+project:openstack/vitrage-specs+message:apiimpact,n,z
+
+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 Deployer
+
+* For a major reworking of something existing it would describe the
+ problems in that feature that are being addressed.
+
+
+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?
+
+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.
+
+Data model impact
+-----------------
+
+Changes which require modifications to the data model often have a wider impact
+on the system. The community often has strong opinions on how the data model
+should be evolved, from both a functional and performance perspective. It is
+therefore important to capture and gain agreement as early as possible on any
+proposed changes to the data model.
+
+Questions which need to be addressed by this section include:
+
+* What new data objects and/or database schema changes is this going to
+ require?
+
+* What database migrations will accompany this change.
+
+* How will the initial set of new data objects be generated, for example if you
+ need to take into account existing instances, or modify other existing data
+ describe how that will work.
+
+REST API impact
+---------------
+
+Each API method which is either added or changed should have the following
+
+* Specification for the method
+
+ * A description of what the method does suitable for use in
+ user documentation
+
+ * Method type (POST/PUT/GET/DELETE)
+
+ * Normal http response code(s)
+
+ * Expected error http response code(s)
+
+ * A description for each possible error code should be included
+ describing semantic errors which can cause it such as
+ inconsistent parameters supplied to the method, or when an
+ instance is not in an appropriate state for the request to
+ succeed. Errors caused by syntactic problems covered by the JSON
+ schema definition do not need to be included.
+
+ * URL for the resource
+
+ * Parameters which can be passed via the url
+
+* Example use case including typical API samples for both data supplied
+ by the caller and the response
+
+* Discuss any policy changes, and discuss what things a deployer needs to
+ think about when defining their policy.
+
+Versioning impact
+-----------------
+
+Discuss how your change affects versioning and backward compatibility:
+
+* Can it break any existing DSL code even in theory?
+
+* If you make changes to Vitrage package please state how the version number
+ should be incremented?
+
+* Does your change require newer version of external or internal component?
+
+* How to keep backward compatibility with code and consumers that were
+ available prior to your change?
+
+Other end user impact
+---------------------
+
+Aside from the API, are there other ways a user will interact with this
+feature?
+
+* What does the user interface there look like?
+
+Deployer impact
+---------------
+
+Discuss things that will affect how you deploy and configure OpenStack
+that have not already been mentioned, such as:
+
+* What config options are being added? Should they be more generic than
+ proposed (for example a flag that other hypervisor drivers might want to
+ implement as well)? Are the default values ones which will work well in
+ real deployments?
+
+* Is this a change that takes immediate effect after its merged, or is it
+ something that has to be explicitly enabled?
+
+* If this change is a new binary, how would it be deployed?
+
+* Please state anything that those doing continuous deployment, or those
+ upgrading from the previous release, need to be aware of. Also describe
+ any plans to deprecate configuration values or features. For example, if we
+ change the directory name that instances are stored in, how do we handle
+ instance directories created before the change landed? Do we move them? Do
+ we have a special case in the code? Do we assume that the operator will
+ recreate all the instances in their cloud?
+
+Developer impact
+----------------
+
+Discuss things that will affect other developers working on OpenStack,
+such as:
+
+* If the blueprint proposes a change to the driver API, discussion of how
+ other hypervisors would implement the feature is required.
+
+Horizon impact
+--------------
+
+Does it require changes to the horizon? If so, changes
+should be described well. If it's about complex changes than probably a
+separate blueprint / spec should be created for it.
+
+
+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 vitrage, 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 Vitrage, 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 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)? Is this untestable in vitrage-ci? If so,
+are there mitigation plans (3rd party testing, gate enhancements, etc).
+
+
+Documentation Impact
+====================
+
+What is the impact on the docs team of this change? Some changes might require
+donating resources to the docs team to have the documentation updated. Don't
+repeat details discussed above, but please reference them here.
+
+
+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
\ No newline at end of file
diff --git a/tests/__init__.py b/tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/tests/test_titles.py b/tests/test_titles.py
new file mode 100644
index 0000000..9277487
--- /dev/null
+++ b/tests/test_titles.py
@@ -0,0 +1,102 @@
+# 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 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':
+ section = self._get_title(node)
+ titles[section['name']] = section['subtitles']
+ return titles
+
+ def _check_titles(self, fname, titles):
+ expected_titles = ('Problem description', 'Proposed change',
+ 'Implementation', 'Dependencies',
+ 'Testing', 'Documentation Impact',
+ 'References')
+ self.assertEqual(
+ sorted(expected_titles),
+ sorted(titles.keys()),
+ "Expected titles not found in document %s" % fname)
+
+ proposed = 'Proposed change'
+ self.assertIn('Alternatives', titles[proposed])
+ self.assertIn('Data model impact', titles[proposed])
+ self.assertIn('REST API impact', titles[proposed])
+ self.assertIn('Versioning impact', titles[proposed])
+ self.assertIn('Other end user impact', titles[proposed])
+ self.assertIn('Deployer impact', titles[proposed])
+ self.assertIn('Developer impact', titles[proposed])
+ self.assertIn('Horizon impact', titles[proposed])
+
+ impl = 'Implementation'
+ self.assertIn('Assignee(s)', titles[impl])
+ self.assertIn('Work Items', titles[impl])
+
+ 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) < 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):
+ files = ['specs/template.rst'] + glob.glob('specs/*/*/*')
+ for filename in files:
+ self.assertTrue(filename.endswith(".rst"),
+ "spec's file must uses 'rst' extension.")
+ with open(filename) as f:
+ data = f.read()
+
+ spec = docutils.core.publish_doctree(data)
+ titles = self._get_titles(spec)
+ self._check_titles(filename, titles)
+ self._check_lines_wrapping(filename, data)
+ self._check_no_cr(filename, data)
+ self._check_trailing_spaces(filename, data)
\ No newline at end of file
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..6c81996
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,21 @@
+[tox]
+minversion = 1.6
+envlist = docs,py27
+skipsdist = True
+
+[testenv]
+usedevelop = True
+setenv = VIRTUAL_ENV={envdir}
+install_command = pip install -U {opts} {packages}
+deps = -r{toxinidir}/requirements.txt
+commands = python setup.py testr --slowest --testr-args='{posargs}'
+
+[testenv:venv]
+commands = {posargs}
+
+[testenv:docs]
+commands = python setup.py build_sphinx
+
+[testenv:doc8]
+deps = -r{toxinidir}/requirements.txt doc8
+commands = doc8 doc/source
\ No newline at end of file