Cleanup the specs repo

This commit bakes several cleanups into one patch. First it clearly
separates devstack and tempest specs by creating a separate tempest
subdir for specs. The next step is moving all implemented specs/bps
into the implemented dir to indicate this. The last is deleting specs
which were outdated and never implemented.

Change-Id: I86331ac279b6a9cdb94ed4c43e5b0c41697e6a7d

doc/source/index.rst

@@ -11,7 +11,7 @@ Tempest Project Specifications
    :glob:
    :maxdepth: 2
 
-   specs/*
+   specs/tempest/*
 
 DevStack Project Specifications
 -------------------------------
@@ -28,7 +28,8 @@ Implemented Specifications
    :glob:
    :maxdepth: 1
 
-   specs/implemented/*
+   specs/tempest/implemented/*
+   specs/devstack/implemented/*
 
 ====================================
 Specification Repository Information

specs/add-basic-ceilometer-tests.rst

@@ -1,96 +0,0 @@
-::
-
- This work is licensed under a Creative Commons Attribution 3.0 Unported
- License.
-
- http://creativecommons.org/licenses/by/3.0/legalcode
-
-..
-
-==============================
-Add basic tests for Ceilometer
-==============================
-
-https://blueprints.launchpad.net/tempest/+spec/add-basic-ceilometer-tests
-
-Implement basic integration tests for the Ceilometer project.
-Related Etherpad: https://etherpad.openstack.org/p/ceilometer-tempest-testing
-
-Problem description
-===================
-
-Now Ceilometer is the important metering/monitoring projects of OpenStack.
-So it's necessary to include the basic tests into Tempest to make sure it works
-fine, as currently there are no these tests presented.
-
-Proposed change
-===============
-
-This blueprint contains the following steps to be implemented:
-
-1. Initial Ceilometer Tempest integration
-2. Basic REST API based tests
-
-1. Initial Ceilometer Tempest integration
------------------------------------------
-
-This point includes initial Telemetry client testing code, base classes and
-configuration for the Telemetry tests. This step includes Telemetry client
-to be implemented as well.
-
-2. Basic REST API based tests
------------------------------
-
-This step should cover the API functionality for the Ceilometer project. This
-requires the following changes:
-
-  * alarm-history API tests and alarming API itself
-  * notifications tests for the different types of the notifications (from
-    Nova, Cinder, Neutron, Swift, etc.)
-  * pollsters tests (with different services polling)
-  * other non-scenarios changes (if needed)
-
-
-Alternatives
-------------
-
-None
-
-Implementation
-==============
-
-Assignee(s)
------------
-
-Primary assignee:
-  * Yassine Lamgarchal <yassine.lamgarchal@enovance.com>
-
-Other contributors:
-  * Vadim Rovachev <vrovachev@mirantis.com>
-  * ravikumar-venkatesan <ravikumar.venkatesan@hp.com>
-  * Mehdi Abaakouk <mehdi.abaakouk@enovance.com>
-  * nayna-patel <nayna.patel@hp.com>
-
-Ongoing maintainer:
-  * Vadim Rovachev <vrovachev@mirantis.com>
-
-Milestones
-----------
-
-Target Milestone for completion:
-  Juno-2
-
-Work Items
-----------
-
-* [sileht] Add initial ceilometerclient testing code: DONE
-* [yassine] Add base class for Telemetry tests: DONE
-* [yassine] Add config for Telemetry: DONE
-* [vrovachev] Create telemetry client for tempest: INPROGRESS
-* [vrovachev] Create cinder notifications tests: INPROGRESS
-* [vrovachev] Create neutron notifications tests: INPROGRESS
-* [vrovachev] Create object storage notifications tests: INPROGRESS
-* [vrovachev] Create compute notifications tests: INPROGRESS
-* [ravikumar] Create all alarms tests: INPROGRESS
-* [vrovachev] Create all pollsters tests: TODO
-

specs/add-ceilometer-scenario-tests.rst

@@ -1,77 +0,0 @@
-::
-
- This work is licensed under a Creative Commons Attribution 3.0 Unported
- License.
-
- http://creativecommons.org/licenses/by/3.0/legalcode
-
-..
-
-=============================
-Add Ceilometer scenario tests
-=============================
-
-https://blueprints.launchpad.net/tempest/+spec/add-ceilometer-scenario-tests
-
-Implement complex scenario tests for the Ceilometer project.
-Related Etherpad: https://etherpad.openstack.org/p/ceilometer-tempest-testing
-
-Problem description
-===================
-
-Telemetry project uses complex interactions inside the OpenStack cloud, so it's
-needed to test not only basic Ceilometer capabilities via API testing, but also
-more complex scenarios that might happen in the cloud. In this case scenarios
-integration tests need to be implemented.
-
-Proposed change
-===============
-
-This blueprint contains the following steps to be implemented:
-
-1. Initial Tempest and Ceilometer integration for the scenario tests
-2. Scenario tests themselves (we need to start with the alarms and events
-   testing)
-
-   Simple alarms test, for example, will follow next scenario:
-   - create alarm which triggered to 'alarm' state and send callback by
-   alarm_actions if in last period more then one server had been created,
-   - create one server,
-   - check that alarm triggered to state 'ok',
-   - create two servers,
-   - check that alarm triggered to state 'alarm',
-   - check that alarms callback received.
-
-   Simple events test will look like the following:
-   - choose some action for every OpenStack service (like keypair
-   creation in Nova) that should lead to notification sent and then event
-   created, each action is followed by specific order of
-   notifications and special order of events as well,
-   - check events come and their order.
-
-Alternatives
-------------
-
-None
-
-Implementation
-==============
-
-Assignee(s)
------------
-
-Primary assignee:
-  * Artur Svechnikov <asvechnikov@mirantis.com>
-
-Milestones
-----------
-
-Target Milestone for completion:
-  Juno-2
-
-Work Items
-----------
-
-* [asvechnikov] Add Ceilometer client for scenarios tests: DONE
-* [asvechnikov] Add Ceilometer events scenarios tests: INPROGRESS
-* [asvechnikov] Add Ceilometer alarms scenarios tests: INPROGRESS

specs/barbican-api-tests.rst

@@ -1,78 +0,0 @@
-::
-
- This work is licensed under a Creative Commons Attribution 3.0 Unported
- License.
-
- http://creativecommons.org/licenses/by/3.0/legalcode
-
-..
-
-============================
-Implement Barbican API tests
-============================
-
-https://blueprints.launchpad.net/tempest/+spec/add-basic-tests-for-barbican
-
-Add test coverage in Tempest for Barbican APIs
-
-
-Problem description
-===================
-Barbican is a ReST API designed for the secure storage, provisioning and management of secrets.
-Barbican is an incubated openstack project and it is important that we have tempest tests to validate the
-functionality of Barbican API. The goal is to create a set of tests that exercises the documented
-positive paths and options of the APIs. The Barbican API specification is located at
-https://github.com/cloudkeep/barbican/wiki/Application-Programming-Interface
-
-Proposed change
-===============
-
-This blueprint proposes to add functional test coverage for Barbican APIs tests.
-Following Implementation is needed in Tempest:
-
-1. Implement service client in /tempest/services/key_management/
-2. Implement test cases in /tempest/api/key_management/
-
-1. Implement service client
----------------------------
-Seperate service clients is implemented for each type of resource
-For example:
-secrets_client.py handles API calls to the secrets resource
-orders_client.py handles API calls to the orders resource
-container_client.py handles API calls to the containers resource
-
-
-2. Implement test cases
------------------------
-Seperate folder of each type of API needs to be maintained
-
-For example:
-tempest/api/key_management/secrets
-tempest/api/key_management/orders
-tempest/api/key_management/containers
-
-Implementation
-==============
-
-Assignee(s)
------------
-
-Primary assignee:
-  Meera Belur
-
-Other contributors:
-  Apal Song
-
-Milestones
-----------
-
-Target Milestone for completion:
-  Juno-3
-
-Work Items
-----------
-- Add service clients
-- Add new test cases for each APIs using service client
-
-To manage these work items an etherpad has been created
-https://etherpad.openstack.org/p/test-barbican-api

specs/tempest/implemented/clients-return-one-value.rst

@@ -11,8 +11,8 @@ https://blueprints.launchpad.net/tempest/+spec/clients-return-one-value
 
 Currently tempest clients return a response code and body. Since we moved
 response checking to clients, almost all callers of the clients ignore the
-response code: :doc:`implemented/client-checks-success`. It would be much
+response code: :doc:`client-checks-success`. It would be
-cleaner if clients returned a single response
+much cleaner if clients returned a single response
 object that was the body, with a property to get the response status and
 headers if needed.
 

specs/trove-api-tests.rst

@@ -1,88 +0,0 @@
-::
-
- This work is licensed under a Creative Commons Attribution 3.0 Unported
- License.
-
- http://creativecommons.org/licenses/by/3.0/legalcode
-
-..
-
-============================
-Implement Trove API tests
-============================
-
-https://blueprints.launchpad.net/tempest/+spec/tempest-guest-tests
-
-Increase integration test coverage in Tempest
-
-
-Problem description
-===================
-
-Currently only below Trove APIs test cases are present in Tempest-
-    -flavor
-    -version
-
-Tempest should have more Trove APIs test coverage.
-
-
-Proposed change
-===============
-
-This blueprint proposes to add more Trove APIs tests.
-Following Implementation is needed in Tempest:
-
-1. Implement service client in /tempest/services/database/
-2. Implement test cases in /tempest/api/database/
-
-1. Implement service client
---------------------------------
-Seperate service client should be implemented for each type of APIs
-
-For example-
-
-* All instance APIs client should be implemented in
-  /tempest/api/database/json/instances_client.py
-* All backup APIs client should be implemented in
-  /tempest/api/database/json/backups_client.py
-
-2. Implement test cases
---------------------------------
-Seperate folder of each type of API needs to be maintained
-
-For example-
-
-* All instance APIs tests should go under /tempest/api/database/instances
-* All backup APIs tests should go under /tempest/api/database/backups.
-
-
-Implementation
-==============
-
-Assignee(s)
------------
-
-Primary assignee:
-  Nikhil Manchanda <SlickNik@gmail.com>
-
-Other contributors:
-
-* Ghanshyam Mann <ghanshyam.mann@nectechnologies.in>
-* Peter Stachowski <peter@tesora.com>
-* Ravikumar Venkatesan <ravikumar.venkatesan@hp.com>
-* Ashish Nigam <ashish.nigam1@globallogic.com>
-
-Milestones
-----------
-
-Target Milestone for completion:
-  Juno-3
-
-Work Items
-----------
-
-- Add service client for each type of APIs
-- Add new test cases for each APIs using service client
-
-  Tasks will be managed using etherpad :
-  (https://etherpad.openstack.org/p/trove-tempest-items)