Browse Source

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
changes/78/198078/3
Matthew Treinish 7 years ago
parent
commit
c5b1920556
No known key found for this signature in database
GPG Key ID: FD12A0F214C9E177
  1. 5
      doc/source/index.rst
  2. 96
      specs/add-basic-ceilometer-tests.rst
  3. 77
      specs/add-ceilometer-scenario-tests.rst
  4. 78
      specs/barbican-api-tests.rst
  5. 0
      specs/devstack/implemented/devstack-logging-and-service-names.rst
  6. 0
      specs/tempest/add-icehouse-swift-tests.rst
  7. 0
      specs/tempest/autogen-negative-tests.rst
  8. 0
      specs/tempest/branchless-tempest-extensions.rst
  9. 0
      specs/tempest/consistent-service-method-names.rst
  10. 0
      specs/tempest/fuzzy-test.rst
  11. 0
      specs/tempest/implemented/add-service-tags.rst
  12. 0
      specs/tempest/implemented/api-schema-unification.rst
  13. 0
      specs/tempest/implemented/branchless-tempest.rst
  14. 0
      specs/tempest/implemented/cinder-v2-api-tests.rst
  15. 0
      specs/tempest/implemented/client-checks-success.rst
  16. 4
      specs/tempest/implemented/clients-return-one-value.rst
  17. 0
      specs/tempest/implemented/config-verification.rst
  18. 0
      specs/tempest/implemented/javelin2.rst
  19. 0
      specs/tempest/implemented/meta-data-and-uuid-for-tests.rst
  20. 0
      specs/tempest/implemented/minversion-check-for-cli-tests.rst
  21. 0
      specs/tempest/implemented/more-selectable-swift-tests.rst
  22. 0
      specs/tempest/implemented/multi-keystone-api-version-tests.rst
  23. 0
      specs/tempest/implemented/neutron-advanced-scenarios.rst
  24. 0
      specs/tempest/implemented/post-run-cleanup.rst
  25. 0
      specs/tempest/implemented/rearrange-nova-response-schemas.rst
  26. 0
      specs/tempest/implemented/resource-cleanup.rst
  27. 0
      specs/tempest/implemented/tempest-client-scenarios.rst
  28. 0
      specs/tempest/implemented/tempest-library.rst
  29. 0
      specs/tempest/implemented/test-accounts-continued.rst
  30. 0
      specs/tempest/implemented/test-accounts.rst
  31. 0
      specs/tempest/ipv6-api-testing-parity.rst
  32. 0
      specs/tempest/keystone-v3-jobs.rst
  33. 0
      specs/tempest/ssh-auth-strategy.rst
  34. 0
      specs/tempest/stress-api-tracking.rst
  35. 0
      specs/tempest/tempest-cli-improvements.rst
  36. 0
      specs/tempest/tempest-external-plugin-interface.rst
  37. 88
      specs/trove-api-tests.rst

5
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

96
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

77
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

78
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

0
specs/devstack/devstack-logging-and-service-names.rst → specs/devstack/implemented/devstack-logging-and-service-names.rst

0
specs/add-icehouse-swift-tests.rst → specs/tempest/add-icehouse-swift-tests.rst

0
specs/autogen-negative-tests.rst → specs/tempest/autogen-negative-tests.rst

0
specs/branchless-tempest-extensions.rst → specs/tempest/branchless-tempest-extensions.rst

0
specs/consistent-service-method-names.rst → specs/tempest/consistent-service-method-names.rst

0
specs/fuzzy-test.rst → specs/tempest/fuzzy-test.rst

0
specs/implemented/add-service-tags.rst → specs/tempest/implemented/add-service-tags.rst

0
specs/implemented/api-schema-unification.rst → specs/tempest/implemented/api-schema-unification.rst

0
specs/implemented/branchless-tempest.rst → specs/tempest/implemented/branchless-tempest.rst

0
specs/implemented/cinder-v2-api-tests.rst → specs/tempest/implemented/cinder-v2-api-tests.rst

0
specs/implemented/client-checks-success.rst → specs/tempest/implemented/client-checks-success.rst

4
specs/clients-return-one-value.rst → 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
cleaner if clients returned a single response
response code: :doc:`client-checks-success`. It would be
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.

0
specs/config-verification.rst → specs/tempest/implemented/config-verification.rst

0
specs/javelin2.rst → specs/tempest/implemented/javelin2.rst

0
specs/meta-data-and-uuid-for-tests.rst → specs/tempest/implemented/meta-data-and-uuid-for-tests.rst

0
specs/implemented/minversion-check-for-cli-tests.rst → specs/tempest/implemented/minversion-check-for-cli-tests.rst

0
specs/implemented/more-selectable-swift-tests.rst → specs/tempest/implemented/more-selectable-swift-tests.rst

0
specs/implemented/multi-keystone-api-version-tests.rst → specs/tempest/implemented/multi-keystone-api-version-tests.rst

0
specs/neutron-advanced-scenarios.rst → specs/tempest/implemented/neutron-advanced-scenarios.rst

0
specs/implemented/post-run-cleanup.rst → specs/tempest/implemented/post-run-cleanup.rst

0
specs/implemented/rearrange-nova-response-schemas.rst → specs/tempest/implemented/rearrange-nova-response-schemas.rst

0
specs/implemented/resource-cleanup.rst → specs/tempest/implemented/resource-cleanup.rst

0
specs/implemented/tempest-client-scenarios.rst → specs/tempest/implemented/tempest-client-scenarios.rst

0
specs/tempest-library.rst → specs/tempest/implemented/tempest-library.rst

0
specs/test-accounts-continued.rst → specs/tempest/implemented/test-accounts-continued.rst

0
specs/implemented/test-accounts.rst → specs/tempest/implemented/test-accounts.rst

0
specs/ipv6-api-testing-parity.rst → specs/tempest/ipv6-api-testing-parity.rst

0
specs/keystone-v3-jobs.rst → specs/tempest/keystone-v3-jobs.rst

0
specs/ssh-auth-strategy.rst → specs/tempest/ssh-auth-strategy.rst

0
specs/stress-api-tracking.rst → specs/tempest/stress-api-tracking.rst

0
specs/tempest-cli-improvements.rst → specs/tempest/tempest-cli-improvements.rst

0
specs/tempest-external-plugin-interface.rst → specs/tempest/tempest-external-plugin-interface.rst

88
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)
Loading…
Cancel
Save