openstack/openstacksdk
Code Issues Proposed changes

doc: Remove references to 'examples' test env

Browse Source 
This was removed a few years ago.

Change-Id: I8011d652c1f3527b6c5e75b3c3cb1051cfe9bbbe
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2021-12-21 17:22:14 +00:00
parent 12fa1370bc
commit 05a83963f7
3 changed files with 11 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/contributor/index.rst
View File

@ -75,11 +75,10 @@ documented in our :doc:`setup <setup>` section.
Testing
-------
The project contains three test packages, one for unit tests, one for
functional tests and one for examples tests. The ``openstack.tests.unit``
package tests the SDK's features in isolation. The
``openstack.tests.functional`` and ``openstack.tests.examples`` packages test
the SDK's features and examples against an OpenStack cloud.
The project contains two test packages, one for unit tests and one for
functional tests. The ``openstack.tests.unit`` package tests the SDK's features
in isolation. The ``openstack.tests.functional`` package tests the SDK's
features and examples against an OpenStack cloud.
.. toctree::

25
doc/source/contributor/testing.rst
View File

@ -85,28 +85,3 @@ the continuous integration system.::
...
functional3: commands succeeded
congratulations :)
Examples Tests
--------------
Similar to the functional tests, the examples tests assume that you have a
public or private OpenStack cloud that you can run the tests against. In
practice, this means that the tests should initially be run against a stable
branch of `DevStack <https://docs.openstack.org/devstack/latest/>`_.
And like the functional tests, the examples tests connect to an OpenStack cloud
using `os-client-config <http://opendev.org/openstack/os-client-config>`_.
See the functional tests instructions for information on setting up DevStack
and os-client-config.
Run
***
In order to run the entire examples test suite, simply run the
``tox -e examples`` command inside of your source checkout. This will
attempt to run every test command under ``/openstack/tests/examples/``
in the source tree.::
(sdk3)$ tox -e examples
...
examples: commands succeeded
congratulations :)

17
tox.ini
View File

@ -21,12 +21,9 @@ deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/test-requirements.txt
-r{toxinidir}/requirements.txt
commands = stestr run {posargs}
stestr slowest
[testenv:examples]
commands = stestr --test-path ./openstack/tests/examples run {posargs}
stestr slowest
commands =
stestr run {posargs}
stestr slowest
[testenv:functional]
# Some jobs (especially heat) takes longer, therefore increase default timeout
@ -37,8 +34,9 @@ setenv =
OPENSTACKSDK_FUNC_TEST_TIMEOUT_LOAD_BALANCER=600
OPENSTACKSDK_EXAMPLE_CONFIG_KEY=functional
OPENSTACKSDK_FUNC_TEST_TIMEOUT_PROJECT_CLEANUP=1200
commands = stestr --test-path ./openstack/tests/functional/{env:OPENSTACKSDK_TESTS_SUBDIR:} run --serial {posargs}
stestr slowest
commands =
stestr --test-path ./openstack/tests/functional/{env:OPENSTACKSDK_TESTS_SUBDIR:} run --serial {posargs}
stestr slowest
[testenv:pep8]
deps =
@ -120,7 +118,7 @@ application-import-names = openstack
ignore = H238,H4,W503
import-order-style = pep8
show-source = True
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,openstack/_services_mixin.py
exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,openstack/_services_mixin.py
[flake8:local-plugins]
extension =
@ -129,4 +127,3 @@ paths = ./openstack
[doc8]
extensions = .rst, .yaml