samredai commented on code in PR #4792:
URL: https://github.com/apache/iceberg/pull/4792#discussion_r885201363


##########
python/README.md:
##########
@@ -38,6 +38,28 @@ Testing is done using tox. The config can be found in 
`tox.ini` within the pytho
 tox
 ```
 
+#### `s3` Tests
+
+A subset of tests are decorated using `@pytest.mark.s3` and require an S3 
protocol compliant object storage to use for testing. For the python CI, a 
local MinIO container is used. To run these tests, you can provide a 
pass-through argument to tox (using `--`) that will be passed to the `pytest` 
command.
+
+```
+tox -- -m "s3"
+```
+
+Additional arguments can be passed to configure the object storage.
+
+| Argument                | Default               | Description                
                         |
+|-------------------------|-----------------------|-----------------------------------------------------|
+| --endpoint-url          | http://localhost:9000 | The S3 endpoint URL for 
tests marked as s3          |
+| --aws-access-key-id     | admin                 | The AWS access key ID for 
tests marked as s3        |
+| --aws-secret-access-key | password              | The AWS secret access key 
ID for tests marked as s3 |
+
+For example, to run `s3` tests against an object store running locally on port 
4000 with an access key ID of `foo` and an secret access key as `bar`, you 
would use the following command.
+
+```
+tox -- -m "s3" --endpoint-url=http://localhost:4000 --aws-access-key-id=foo 
--aws-secret-access-key=bar

Review Comment:
   Using this, you could run a minio instance locally (or use an aws s3 bucket) 
and run the tests marked as `s3` against that.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to