testcontainers-rustfs 1.0.0__py3-none-any.whl

testcontainers_rustfs/__init__.py

@@ -0,0 +1,124 @@
+"""Unofficial Testcontainers module for RustFS, an S3-compatible object store."""
+
+from typing import TYPE_CHECKING, Any
+
+from testcontainers.core.container import DockerContainer
+from testcontainers.core.wait_strategies import CompositeWaitStrategy, HttpWaitStrategy
+
+if TYPE_CHECKING:
+    from mypy_boto3_s3.client import S3Client
+
+__all__ = ["RustfsContainer"]
+
+_DEFAULT_IMAGE = "rustfs/rustfs:1.0.0-beta.12"
+_S3_HEALTH_PATH = "/health"
+_CONSOLE_HEALTH_PATH = "/rustfs/console/health"
+
+
+class RustfsContainer(DockerContainer):
+    """RustFS container exposing an S3-compatible API.
+
+    Example::
+
+        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")
+    """
+
+    def __init__(  # noqa: PLR0913
+        self,
+        image: str = _DEFAULT_IMAGE,
+        port: int = 9000,
+        access_key: str = "rustfsadmin",
+        secret_key: str = "rustfsadmin",  # noqa: S107
+        *,
+        console: bool = False,
+        console_port: int = 9001,
+        region_name: str = "us-east-1",
+        **kwargs: Any,  # noqa: ANN401
+    ) -> None:
+        """Create a RustFS container.
+
+        Args:
+            image: Docker image to run.
+            port: Container port serving the S3 API.
+            access_key: Access key for client connections.
+            secret_key: Secret key for client connections.
+            console: Whether to enable and expose the web console.
+            console_port: Container port serving the web console.
+            region_name: Region reported to S3 clients.
+            kwargs: Passed through to ``DockerContainer``.
+        """
+        wait_strategy = HttpWaitStrategy(port, _S3_HEALTH_PATH)
+        if console:
+            wait_strategy = CompositeWaitStrategy(
+                wait_strategy,
+                HttpWaitStrategy(console_port, _CONSOLE_HEALTH_PATH),
+            )
+        super().__init__(image, _wait_strategy=wait_strategy, **kwargs)
+
+        self.port = port
+        self.access_key = access_key
+        self.secret_key = secret_key
+        self.console = console
+        self.console_port = console_port
+        self.region_name = region_name
+
+        self.with_exposed_ports(self.port)
+        self.with_env("RUSTFS_ACCESS_KEY", self.access_key)
+        self.with_env("RUSTFS_SECRET_KEY", self.secret_key)
+        self.with_env("RUSTFS_ADDRESS", f":{self.port}")
+
+        if self.console:
+            self.with_exposed_ports(self.console_port)
+            self.with_env("RUSTFS_CONSOLE_ENABLE", "true")
+            self.with_env("RUSTFS_CONSOLE_ADDRESS", f":{self.console_port}")
+
+    def get_url(self) -> str:
+        """Return the S3 endpoint URL reachable from the host."""
+        return f"http://{self.get_container_host_ip()}:{self.get_exposed_port(self.port)}"
+
+    def get_console_url(self) -> str:
+        """Return the web console URL reachable from the host.
+
+        Raises:
+            RuntimeError: If the console was not enabled.
+        """
+        if not self.console:
+            msg = "The RustFS console is disabled; construct the container with RustfsContainer(console=True)."
+            raise RuntimeError(msg)
+        return f"http://{self.get_container_host_ip()}:{self.get_exposed_port(self.console_port)}"
+
+    def get_config(self) -> dict[str, str]:
+        """Return the connection settings for the container."""
+        host_ip = self.get_container_host_ip()
+        exposed_port = self.get_exposed_port(self.port)
+        return {
+            "endpoint": f"{host_ip}:{exposed_port}",
+            "endpoint_url": f"http://{host_ip}:{exposed_port}",
+            "access_key": self.access_key,
+            "secret_key": self.secret_key,
+            "region_name": self.region_name,
+        }
+
+    def get_client(self, **kwargs: Any) -> "S3Client":  # noqa: ANN401, UP037
+        """Return a boto3 S3 client bound to this container.
+
+        Raises:
+            RuntimeError: If the optional boto3 dependency is not installed.
+        """
+        try:
+            import boto3  # noqa: PLC0415
+        except ImportError as exc:
+            msg = "boto3 is required by get_client(); install it with: pip install 'testcontainers-rustfs[boto3]'"
+            raise RuntimeError(msg) from exc
+
+        return boto3.client(
+            "s3",
+            endpoint_url=self.get_url(),
+            aws_access_key_id=self.access_key,
+            aws_secret_access_key=self.secret_key,
+            region_name=self.region_name,
+            **kwargs,
+        )

testcontainers_rustfs-1.0.0.dist-info/METADATA

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: testcontainers-rustfs
+Version: 1.0.0
+Summary: Unofficial Testcontainers Python module for RustFS
+Author: Bence Molnár
+Author-email: Bence Molnár <developer@molnarbence.dev>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Dist: testcontainers>=4.15.0
+Requires-Dist: boto3>=1.34 ; extra == 'boto3'
+Requires-Python: >=3.14
+Project-URL: Homepage, https://github.com/mb-dot-dev/testcontainers-rustfs
+Project-URL: Repository, https://github.com/mb-dot-dev/testcontainers-rustfs
+Project-URL: Issues, https://github.com/mb-dot-dev/testcontainers-rustfs/issues
+Provides-Extra: boto3
+Description-Content-Type: text/markdown
+
+# testcontainers-rustfs
+
+Unofficial [Testcontainers](https://testcontainers.com/) Python module for
+[RustFS](https://github.com/rustfs/rustfs), an S3-compatible object store.
+
+Not affiliated with or endorsed by the RustFS or Testcontainers projects.
+
+## Install
+
+Requires Python 3.14 or newer.
+
+```bash
+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
+
+```python
+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
+
+```python
+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:
+
+```python
+with RustfsContainer(console=True) as rustfs:
+    print(rustfs.get_console_url())
+```
+
+`get_console_url()` raises `RuntimeError` if the console was not enabled.
+
+## Configuration
+
+| Parameter | Default | Description |
+|---|---|---|
+| `image` | `rustfs/rustfs:1.0.0-beta.12` | Docker image. Pinned deliberately — RustFS is pre-1.0 and `:latest` moves often |
+| `port` | `9000` | Container port serving the S3 API |
+| `access_key` | `rustfsadmin` | Access key for client connections |
+| `secret_key` | `rustfsadmin` | Secret key for client connections |
+| `console` | `False` | Enable and expose the web console (keyword-only) |
+| `console_port` | `9001` | Container port serving the console (keyword-only) |
+| `region_name` | `us-east-1` | Region reported to S3 clients (keyword-only) |
+
+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
+
+```bash
+make install-dev
+make test      # lint + unit
+make coverage
+```
+
+Tests require a running Docker daemon.

testcontainers_rustfs-1.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+testcontainers_rustfs/__init__.py,sha256=XWC95p33jPQ7YY_txyCmWZp_ojZeilCyaOpRg4Ktf_k,4607
+testcontainers_rustfs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+testcontainers_rustfs-1.0.0.dist-info/licenses/LICENSE,sha256=enDLkoEGO6lxkkX0_DJT385bmEoAHwMTBo938cHeRgo,1072
+testcontainers_rustfs-1.0.0.dist-info/WHEEL,sha256=oy45bIW3ehK02fnLDUKD-FzeaR3VpJxY5Jdblkktnpw,80
+testcontainers_rustfs-1.0.0.dist-info/METADATA,sha256=yG5ewaJe3AutBxQdUAB4Xq9B7AoQzhLOweiJmqe8IxA,3520
+testcontainers_rustfs-1.0.0.dist-info/RECORD,,

testcontainers_rustfs-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.12.0
+Root-Is-Purelib: true
+Tag: py3-none-any

testcontainers_rustfs-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 molnarbence.dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.