testcontainers-rustfs

Unofficial Testcontainers Python module for RustFS, an S3-compatible object store.

Not affiliated with or endorsed by the RustFS or Testcontainers projects.

Install

Requires Python 3.14 or newer.

pip install 'testcontainers-rustfs[boto3]'

The boto3 extra is optional. Without it the container still starts and get_config() / get_url() work; only get_client() requires boto3.

Usage

from testcontainers_rustfs import RustfsContainer

with RustfsContainer() as rustfs:
    client = rustfs.get_client()
    client.create_bucket(Bucket="testbucket")
    client.put_object(Bucket="testbucket", Key="hello.txt", Body=b"Hello RustFS")

    stored = client.get_object(Bucket="testbucket", Key="hello.txt")["Body"].read()

Bucket names must be 3–63 characters — RustFS rejects shorter names with InvalidBucketName.

Bringing your own client

with RustfsContainer() as rustfs:
    config = rustfs.get_config()
    # {'endpoint': 'localhost:32768', 'endpoint_url': 'http://localhost:32768',
    #  'access_key': 'rustfsadmin', 'secret_key': 'rustfsadmin', 'region_name': 'us-east-1'}

endpoint is the host:port form some SDKs expect; endpoint_url is the full URL boto3 wants.

Web console

Disabled by default. Enable it to inspect a failing test's data by eye:

with RustfsContainer(console=True) as rustfs:
    print(rustfs.get_console_url())

get_console_url() raises RuntimeError if the console was not enabled.

Configuration

Any further keyword arguments are passed through to DockerContainer.

Credentials and region are always passed explicitly to the boto3 client, so your ~/.aws/config never influences test behaviour.

Development

make install-dev
make test      # lint + unit
make coverage

Tests require a running Docker daemon.