forked from TrueCloudLab/s3-tests
6dbdf39037
c4d30d7 Ravindra Choudhari Mon, 27 Jun 2022 removing region name
4a13f58 Ravindra Choudhari Thu, 16 Jun 2022 Updating readme file (#15)
18bc152 Ravindra Choudhari Tue, 14 Jun 2022 Adding attr test_of_iam to all user policy tests (#13)
03f520a Ravindra Choudhari Tue, 14 Jun 2022 resolving review comments (#12)
7cf2823 Ravindra Choudhari Mon, 13 Jun 2022 added IAM policy test section in README.rst (#11)
563f3ea Ravindra Choudhari Fri, 10 Jun 2022 adding failing three tests back with attr @fails_on_rgw (#10)
696dd2e Ravindra Choudhari Mon, 6 Jun 2022 changes as per review comments
3d63dfd Ravindra Choudhari Mon, 6 Jun 2022 Fixed review comments (#8)
9492f69 Ravindra Choudhari Fri, 3 Jun 2022 Fixed review comments (#7)
74095dc Ketan Arlulkar Wed, 1 Jun 2022 Fixed review comments (#6)
942fb4f Ketan Arlulkar Wed, 1 Jun 2022 Added Tests for conflicting policies and IAM actions (#4)
ad5b5ae Ravindra Choudhari Tue, 31 May 2022 IAM policies s3 actions (#5)
6515ec6 Ketan Arlulkar Fri, 27 May 2022 Corrected eq import
40a2841 Ravindra Choudhari Tue, 17 May 2022 resolving conflicts
f53a5c1 Ravindra Choudhari Tue, 17 May 2022 added cleanup
747d563 Ketan Arlulkar Tue, 17 May 2022 Added cleanup/Delete Policy
d1cc1d8 Ketan Arlulkar Mon, 16 May 2022 Fixed review comments
1ec43a2 Ravindra Choudhari Mon, 16 May 2022 delete user policy tests
a01722e Ravindra Choudhari Mon, 16 May 2022 get user policy tests
ff9d676 Ketan Arlulkar Fri, 13 May 2022 Removed TEST IDs
d261400 Ketan Arlulkar Tue, 10 May 2022 Put User Policy & List User Policy Tests
Signed-off-by: Ravindra Choudhari <ravindra.choudhari@seagate.com>
(cherry picked from commit bf889041c9)
101 lines
4.4 KiB
ReStructuredText
101 lines
4.4 KiB
ReStructuredText
========================
|
|
S3 compatibility tests
|
|
========================
|
|
|
|
This is a set of unofficial Amazon AWS S3 compatibility
|
|
tests, that can be useful to people implementing software
|
|
that exposes an S3-like API. The tests use the Boto2 and Boto3 libraries.
|
|
|
|
The tests use the Nose test framework. To get started, ensure you have
|
|
the ``virtualenv`` software installed; e.g. on Debian/Ubuntu::
|
|
|
|
sudo apt-get install python-virtualenv
|
|
|
|
and then run::
|
|
|
|
./bootstrap
|
|
|
|
You will need to create a configuration file with the location of the
|
|
service and two different credentials. A sample configuration file named
|
|
``s3tests.conf.SAMPLE`` has been provided in this repo. This file can be
|
|
used to run the s3 tests on a Ceph cluster started with vstart.
|
|
|
|
Once you have that file copied and edited, you can run the tests with::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests
|
|
|
|
You can specify which directory of tests to run::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests s3tests_boto3.functional
|
|
|
|
You can specify which file of tests to run::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests s3tests_boto3.functional.test_s3
|
|
|
|
You can specify which test to run::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests s3tests_boto3.functional.test_s3:test_bucket_list_empty
|
|
|
|
To gather a list of tests being run, use the flags::
|
|
|
|
-v --collect-only
|
|
|
|
Some tests have attributes set based on their current reliability and
|
|
things like AWS not enforcing their spec stricly. You can filter tests
|
|
based on their attributes::
|
|
|
|
S3TEST_CONF=aws.conf ./virtualenv/bin/nosetests -a '!fails_on_aws'
|
|
|
|
Most of the tests have both Boto3 and Boto2 versions. Tests written in
|
|
Boto2 are in the ``s3tests`` directory. Tests written in Boto3 are
|
|
located in the ``s3test_boto3`` directory.
|
|
|
|
You can run only the boto3 tests with::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests -v -s -A 'not fails_on_rgw' s3tests_boto3.functional
|
|
|
|
========================
|
|
STS compatibility tests
|
|
========================
|
|
|
|
This section contains some basic tests for the AssumeRole, GetSessionToken and AssumeRoleWithWebIdentity API's. The test file is located under ``s3tests_boto3/functional``.
|
|
|
|
You can run only the sts tests (all the three API's) with::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests s3tests_boto3.functional.test_sts
|
|
|
|
You can filter tests based on the attributes. There is a attribute named ``test_of_sts`` to run AssumeRole and GetSessionToken tests and ``webidentity_test`` to run the AssumeRoleWithWebIdentity tests. If you want to execute only ``test_of_sts`` tests you can apply that filter as below::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests -v -s -A 'test_of_sts' s3tests_boto3.functional.test_sts
|
|
|
|
For running ``webidentity_test`` you'll need have Keycloak running.
|
|
|
|
In order to run any STS test you'll need to add "iam" section to the config file. For further reference on how your config file should look check ``s3tests.conf.SAMPLE``.
|
|
|
|
========================
|
|
IAM policy tests
|
|
========================
|
|
|
|
This is a set of IAM policy tests.
|
|
This section covers tests for user policies such as Put, Get, List, Delete, user policies with s3 actions, conflicting user policies etc
|
|
These tests uses Boto3 libraries. Tests are written in the ``s3test_boto3`` directory.
|
|
|
|
These iam policy tests uses two users with profile name "iam" and "s3 alt" as mentioned in s3tests.conf.SAMPLE.
|
|
If Ceph cluster is started with vstart, then above two users will get created as part of vstart with same access key, secrete key etc as mentioned in s3tests.conf.SAMPLE.
|
|
Out of those two users, "iam" user is with capabilities --caps=user-policy=* and "s3 alt" user is without capabilities.
|
|
Adding above capabilities to "iam" user is also taken care by vstart (If Ceph cluster is started with vstart).
|
|
|
|
To run these tests, create configuration file with section "iam" and "s3 alt" refer s3tests.conf.SAMPLE.
|
|
Once you have that configuration file copied and edited, you can run all the tests with::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests s3tests_boto3.functional.test_iam
|
|
|
|
You can also specify specific test to run::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests s3tests_boto3.functional.test_iam:test_put_user_policy
|
|
|
|
Some tests have attributes set such as "fails_on_rgw".
|
|
You can filter tests based on their attributes::
|
|
|
|
S3TEST_CONF=your.conf ./virtualenv/bin/nosetests s3tests_boto3.functional.test_iam -a '!fails_on_rgw'
|
|
|