diff options
| author | Zuul <zuul@review.opendev.org> | 2022-06-02 07:53:05 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2022-06-02 07:53:05 +0000 |
| commit | 2ed6e08f982f09e27ffc24276c6066bd5c43d0d4 (patch) | |
| tree | b825185c9a8150817a27479799b0642f412d2ca2 /doc | |
| parent | 22ef39386021eed56ff1d5b0af337d973d429905 (diff) | |
| parent | 5d9f1f009c96e3049941d804b848f3166caac747 (diff) | |
| download | swift-2ed6e08f982f09e27ffc24276c6066bd5c43d0d4.tar.gz | |
Merge "s3api tests: allow AWS credential file loading"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/development_guidelines.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/source/development_guidelines.rst b/doc/source/development_guidelines.rst index d6cc90b55..979a728e0 100644 --- a/doc/source/development_guidelines.rst +++ b/doc/source/development_guidelines.rst @@ -184,6 +184,26 @@ using config files found in ``$HOME/my_tests`` and policy 'silver':: SWIFT_TEST_POLICY=silver tox -e func +S3 API cross-compatibility tests +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The cross-compatibility tests in directory `test/s3api` are intended to verify +that the Swift S3 API behaves in the same way as the AWS S3 API. They should +pass when run against either a Swift endpoint (with S3 API enabled) or an AWS +S3 endpoint. + +To run against an AWS S3 endpoint, the `/etc/swift/test.conf` file must be +edited to provide AWS key IDs and secrets. Alternatively, an AWS CLI style +credentials file can be loaded by setting the ``SWIFT_TEST_AWS_CONFIG_FILE`` +environment variable, e.g.:: + + SWIFT_TEST_AWS_CONFIG_FILE=~/.aws/credentials nosetests ./test/s3api + +.. note:: + When using ``SWIFT_TEST_AWS_CONFIG_FILE``, the region defaults to + ``us-east-1`` and only the default credentials are loaded. + + ------------ Coding Style ------------ |