From f25b89208f86f68dafde15a16ae47ab21e8ab17b Mon Sep 17 00:00:00 2001 From: Eoghan Glynn Date: Tue, 20 May 2014 23:47:43 +0100 Subject: [PATCH] Initial telemetry-specs structure --- CONTRIBUTING.rst | 18 ++ HACKING.rst | 4 + LICENSE | 175 ++++++++++++++++++++ MANIFEST.in | 6 + README.rst | 15 ++ babel.cfg | 1 + doc/source/conf.py | 75 +++++++++ doc/source/index.rst | 27 +++ doc/source/specs | 1 + openstack-common.conf | 6 + requirements.txt | 6 + setup.cfg | 23 +++ setup.py | 22 +++ specs/juno/template.rst | 1 + specs/template.rst | 359 ++++++++++++++++++++++++++++++++++++++++ tests/__init__.py | 0 tests/test_titles.py | 88 ++++++++++ tox.ini | 17 ++ 18 files changed, 844 insertions(+) create mode 100644 CONTRIBUTING.rst create mode 100644 HACKING.rst create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.rst create mode 100644 babel.cfg create mode 100755 doc/source/conf.py create mode 100644 doc/source/index.rst create mode 120000 doc/source/specs create mode 100644 openstack-common.conf create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100755 setup.py create mode 120000 specs/juno/template.rst create mode 100644 specs/template.rst create mode 100644 tests/__init__.py create mode 100644 tests/test_titles.py create mode 100644 tox.ini diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..5a2f68d --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,18 @@ +If you would like to contribute to the development of OpenStack, +you must follow the steps in the "If you're a developer, start here" +section of this page: + + http://wiki.openstack.org/HowToContribute + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + http://wiki.openstack.org/GerritWorkflow + +Pull requests submitted through GitHub will be ignored. + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/ceilometer + https://bugs.launchpad.net/python-ceilometerclient diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 0000000..ef93566 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,4 @@ +telemetry-specs Style Commandments +================================== + +Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..67db858 --- /dev/null +++ b/LICENSE @@ -0,0 +1,175 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..90f8a7a --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,6 @@ +include AUTHORS +include ChangeLog +exclude .gitignore +exclude .gitreview + +global-exclude *.pyc \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..84fdc1f --- /dev/null +++ b/README.rst @@ -0,0 +1,15 @@ +=============================== +telemetry-specs +=============================== + +Telemetry specs repository + +* Free software: Apache license +* Source: http://git.openstack.org/cgit/openstack/telemetry-specs +* Bugs: http://bugs.launchpad.net/ceilometer + http://bugs.launchpad.net/python-ceilometerclient + +Features +-------- + +* TODO diff --git a/babel.cfg b/babel.cfg new file mode 100644 index 0000000..efceab8 --- /dev/null +++ b/babel.cfg @@ -0,0 +1 @@ +[python: **.py] diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..30e7eaa --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,75 @@ +# -*- 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. + +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) +# -- General configuration ---------------------------------------------------- + +# 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', + 'oslosphinx' +] + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'telemtry-specs' +copyright = u'2013, OpenStack Foundation' + +# 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 + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +# html_theme_path = ["."] +# html_theme = '_theme' +# html_static_path = ['static'] + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', + '%s.tex' % project, + u'%s Documentation' % project, + u'OpenStack Foundation', 'manual'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..a443879 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,27 @@ +.. telemetry documentation master file + +================================ +Telemetry Program Specifications +================================ + +Contents: + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/* + +Juno approved specs: + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/juno/* + +================== +Indices and tables +================== + +* :ref:`search` 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/openstack-common.conf b/openstack-common.conf new file mode 100644 index 0000000..39982c4 --- /dev/null +++ b/openstack-common.conf @@ -0,0 +1,6 @@ +[DEFAULT] + +# The list of modules to copy from oslo-incubator.git + +# The base module to hold the copy of openstack.common +base=telemetry-specs diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..bdd3e93 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +docutils==0.9.1 +oslosphinx +pbr>=0.6,<1.0 +sphinx>=1.1.2,<1.2 +testrepository>=0.0.18 +testtools>=0.9.34 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..ec86f03 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,23 @@ +[metadata] +name = telemetry-specs +summary = Telemetry specs repository +description-file = + README.rst +author = OpenStack +author-email = openstack-dev@lists.openstack.org +home-page = http://www.openstack.org/ +classifier = + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + +[build_sphinx] +source-dir = doc/source +build-dir = doc/build +all_files = 1 + +[pbr] +warnerrors = True + +[wheel] +universal = 1 diff --git a/setup.py b/setup.py new file mode 100755 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/juno/template.rst b/specs/juno/template.rst new file mode 120000 index 0000000..dc9373e --- /dev/null +++ b/specs/juno/template.rst @@ -0,0 +1 @@ +../template.rst \ No newline at end of file diff --git a/specs/template.rst b/specs/template.rst new file mode 100644 index 0000000..61a6cea --- /dev/null +++ b/specs/template.rst @@ -0,0 +1,359 @@ +.. + 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/ceilometer/+spec/example +https://blueprints.launchpad.net/python-ceilometerclient/+spec/example + +Introduction paragraph -- why are we doing anything? A single paragraph of +free-form text that other developers and operators 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 filename in the git repository should match the launchpad URL, for + example a URL of: + + https://blueprints.launchpad.net/ceilometer/+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. + +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 Cloud Operator + +* For a major reworking of something existing it would describe the + problems in that feature that are being addressed. In this case, any + potential migration issues must be called out upfront. + +* For a major functional area not currently addressed within the + OpenStack Telemetry program, ensure you describe why you think + this is appropriate given our project mandate and mission statement. + +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? If this larger effort may span +several release cycles, state this explicitly. + +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. Especially if +there's a history in the community of divided opinion on this issue. + +Data model impact +----------------- + +Changes which require modifications to the data model often have a wider impact +on the system and its performance, or lack thereof. 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, treating the sql-alchemy + and nosql cases separately. + +* Will this add to the on-the-fly data massaging cruft that we've accreted + over time? + +* 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 defintion do not need to be included. + + * URL for the resource + + * Parameters which can be passed via the url + + * example JSON fragments for the body data if appropriate + + * example JSON fragments for the response data if any + +* 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. + +* Discuss whether this change should be backported to any currently supported + API versions (e.g. to v2 when this is put on the deprecation path in favor + of a new v3 API) + +Security impact +--------------- + +Describe any potential security impact on the system. The principal issue +to consider is: + +* Does this change impact on the direct or indirect visibility of data + in the metering store in a way that doesn't respect full segregation + between non-admin tenants. + +An example of such a concern would the on_behalf_of mechanism in the +alarm evaluation logic. + +For more detailed guidance, please see the OpenStack Security Guidelines as +a reference (https://wiki.openstack.org/wiki/Security/Guidelines). These +guidelines are a work in progress and are designed to help you identify +security best practices. For further information, feel free to reach out +to the OpenStack Security Group at openstack-security@lists.openstack.org. + +Pipeline impact +--------------- + +Please specify any changes to the metering pipeline, from the data aquisition +agents, via the publication conduit(s), through to the database dispatch layer. +For example: + +* Is yet another agent required to host the data aquisition pollsters or + notification handlers? + +* If accommodated in an existing agent, is the scaling of that agent impacted? + +* Is explicit configuration of the source and/or transformations required + in the pipeline.yaml? + +* Is the typical cadence of data aquisition likely in practice to be unusually + frequent or infrequent? + +* Is an excplicit resource discovery extension required to retrieve target + resources? + +* Is AMQP the appropriate publication conduit for these data? + +* Is any change required to the metering message signature verification + used by the collector? + +Other end user impact +--------------------- + +Aside from the API, are there other ways a user will interact with this +feature? + +* If a service-side feature, does this change also have an impact on + python-ceilometerclient? What does the user interface there look like? + +* Should this feature be exposed via the Horizon metering dashboard? + +Performance/Scalability Impacts +------------------------------- + +Describe any potential performance or scaling impact on the system, considering +for example: + +* The volume of new metering data generated, and the knock-on impact + of this on the latency of the publication conduit and database dispatch + layer. + +* Whether any new data retention policies are required. + +* How any new APIs and/or storage driver methods will perform when scaled + over very large datasets. + +* Whether any explicit performance testing would be advisable to validate + the new feature, either at the PoC stage, and/or in its final form. + + +Other 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? + +* How is the storage driver feature parity matrix impacted? Traditionally + new features were often only supported initially in the mongodb and + sql-alchemy drivers, leaving the more niche drivers to catch up later. + Though this is established custom and practice, you must explicitly + state which drivers you intend to address in the first cut. + +* 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? Will the puppet + or chef recipes in wide use require extension to accommodate this feature. + +* 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 pipeline.yaml format, how do we handle pipelines created before + the change landed? Do we transform them? Do we continue to support the + old format in a deprecated form? + +* Please state anythng that those doing downstream distro-oriented packaging + need to be aware of. For example, is a new service being added, or many + new transitive dependencies pulled in, or a new feature that is effectively + optional and hence suited to seperate packaging. + +Developer impact +---------------- + +Discuss things that will affect other developers working on OpenStack, +such as: + +* If the blueprint proposes a change to the internal storage driver or + hypervisor inspector APIs, discussion of how existing implementations + of these APIs would implement the feature is required. + + +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: + + +Ongoing maintainer: + + +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. + + +Future lifecycle +================ + +The Telemetry program is explicitly not interested in "code drops", where +some new niche feature is landed, but then ongoing active maintainership +is not provided by either the original author and/or an obviously sustainable +user community. You must address how you envisage the ongoing maintenance +of the feature being handled through the next two release cycles. + + +Dependencies +============ + +* Include specific references to specs and/or blueprints under the Telemetry + program, or in other programs, that the current blueprint one either depends + on or is related to. + +* If this requires functionality of another pogram that is not currently used + by Telemetry (such as a new or extended library provided by the Oslo program), + document that fact. + +* Does this feature require any new external dependencies or code otherwise not + included in OpenStack? Or does it depend on a specific version of library? Is + this library already packaged for the major distros (i.e. derivatives of + Debian and Fedora). + + +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 and scenario test coverage +will be added so that doesn't need to be mentioned explicitly, but discussion +of why you think unit/scenario tests are sufficient and we don't need to add +more tempest testcases would need to be included. + +Is this untestable in the upstream gate given current limitations (specific +hardware / software configurations available)? 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, appropriately distilled or summarized + +* Related specifications as appropriate (e.g. if it's calling out to a REST + API exposed by another OpenStack service, link to that API definition) + +* Anything else you feel it is worthwhile to refer to + 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..28ebe5f --- /dev/null +++ b/tests/test_titles.py @@ -0,0 +1,88 @@ +# 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 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, titles): + self.assertEqual(7, len(titles)) + + problem = 'Problem description' + self.assertIn(problem, titles) + self.assertEqual(0, len(titles[problem])) + + proposed = 'Proposed change' + self.assertIn(proposed, titles) + self.assertEqual(6, len(titles[proposed])) + self.assertIn('Alternatives', titles[proposed]) + self.assertIn('Security impact', titles[proposed]) + self.assertIn('Other end user impact', titles[proposed]) + self.assertIn('Performance Impact', titles[proposed]) + self.assertIn('Other deployer impact', titles[proposed]) + self.assertIn('Developer impact', titles[proposed]) + + impl = 'Implementation' + self.assertIn(impl, titles) + self.assertEqual(2, len(titles[impl])) + self.assertIn('Assignee(s)', titles[impl]) + self.assertIn('Work Items', titles[impl]) + + deps = 'Dependencies' + self.assertIn(deps, titles) + self.assertEqual(0, len(titles[deps])) + + testing = 'Testing' + self.assertIn(testing, titles) + self.assertEqual(0, len(titles[testing])) + + docs = 'Documentation Impact' + self.assertIn(docs, titles) + self.assertEqual(0, len(titles[docs])) + + refs = 'References' + self.assertIn(refs, titles) + self.assertEqual(0, len(titles[refs])) + + 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(titles) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..b92724b --- /dev/null +++ b/tox.ini @@ -0,0 +1,17 @@ +[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