openstack/swift
Code Issues Proposed changes

Bring docs inline with changes to tox envs

Browse Source 
Make development guidelines consistent with recent
changes to tox envs, specifically the removal of
"-in-process" from some test env names [1] and the
removal of the "func-fast-post" test env [2].

[1] Related-Change: I02477d81b836df71780942189d37d616944c4dce
[2] Related-Change: I6faf8fcfa0a1d96aaf0f5e0ad2106b2b416da22f

Change-Id: I08b92c005ee50beff09a92b4331dd7dbeed79bde
This commit is contained in:
Alistair Coles 2017-01-25 17:29:56 +00:00
parent 98e9554291
commit b5530f4620
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/development_guidelines.rst
View File

@ -121,24 +121,23 @@ set using environment variables:
- encryption may be added to the proxy pipeline by setting the
environment variable ``SWIFT_TEST_IN_PROCESS_CONF_LOADER`` to
``encryption``. Or when using ``tox``, specify the ``tox`` environment
``func-in-process-encryption``
``encryption``.
- the proxy-server ``object_post_as_copy`` option may be set using the
environment variable ``SWIFT_TEST_IN_PROCESS_OBJECT_POST_AS_COPY``.
- the deprecated proxy-server ``object_post_as_copy`` option may be set using
the environment variable ``SWIFT_TEST_IN_PROCESS_OBJECT_POST_AS_COPY``.
- logging to stdout may be enabled by setting ``SWIFT_TEST_DEBUG_LOGS``.
For example, this command would run the in-process mode functional tests with
the proxy-server using object_post_as_copy=False (the 'fast-POST' mode)::
encryption enabled in the proxy-server::
SWIFT_TEST_IN_PROCESS=1 SWIFT_TEST_IN_PROCESS_OBJECT_POST_AS_COPY=False \
SWIFT_TEST_IN_PROCESS=1 SWIFT_TEST_IN_PROCESS_CONF_LOADER=encryption \
tox -e func
This particular example may also be run using the ``func-in-process-fast-post``
This particular example may also be run using the ``func-encryption``
tox environment::
tox -e func-in-process-fast-post
tox -e func-encryption
To debug the functional tests, use the 'in-process test' mode and pass the
``--pdb`` flag to ``tox``::