s3-testing 0.0.1__tar.gz

s3_testing-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Oliver Russell
+
+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.

s3_testing-0.0.1/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.3
+Name: s3-testing
+Version: 0.0.1
+Summary: S3 testing helpers
+Author: Oliver Russell
+Author-email: Oliver Russell <mrxoliver@gmail.com>
+License: MIT License
+         
+         Copyright (c) 2023 Oliver Russell
+         
+         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.
+Requires-Dist: rclone-binaries
+Requires-Python: >=3.12
+Project-URL: homepage, https://github.com/leontrolski/s3-testing
+Project-URL: documentation, https://github.com/leontrolski/s3-testing
+Project-URL: repository, https://github.com/leontrolski/s3-testing.git
+Description-Content-Type: text/markdown
+
+# S3 testing
+
+Simple S3 helper for testing with Python - no docker, brew, apt, etc - uses [rclone-binaries](https://github.com/leontrolski/rclone-binaries) (turns out [rclone has an S3 server baked in](https://rclone.org/commands/rclone_serve_s3/)). Pairs nicely with [postgresql-testing](https://github.com/leontrolski/postgresql-testing).
+
+It's super dumb, just:
+
+```shell
+pip install s3-testing
+```
+
+```python
+import s3_testing
+
+with s3_testing.serve() as config:
+    s3 = boto3.client(**config.as_boto_kwargs)
+
+    s3.create_bucket(Bucket="my-bucket")
+    s3.put_object(
+        Bucket="my-bucket",
+        Key="hello.txt",
+        Body=b"Hello from Python!",
+    )
+```
+
+The default config puts all the data in `.s3-testing` - pop this in your `.gitignore`.
+
+If you want a `pytest` fixture that gives you empty buckets, just [`shutil.rmtree(config.dir)`](test.py) between tests.
+
+It has no auth, pass in whatever creds.
+
+On my machine:
+
+- Spinning up the server til it responds takes 700ms.
+- Creating a bucket takes 1ms.
+- Writing then reading a small object takes 3ms.

s3_testing-0.0.1/README.md

@@ -0,0 +1,35 @@
+# S3 testing
+
+Simple S3 helper for testing with Python - no docker, brew, apt, etc - uses [rclone-binaries](https://github.com/leontrolski/rclone-binaries) (turns out [rclone has an S3 server baked in](https://rclone.org/commands/rclone_serve_s3/)). Pairs nicely with [postgresql-testing](https://github.com/leontrolski/postgresql-testing).
+
+It's super dumb, just:
+
+```shell
+pip install s3-testing
+```
+
+```python
+import s3_testing
+
+with s3_testing.serve() as config:
+    s3 = boto3.client(**config.as_boto_kwargs)
+
+    s3.create_bucket(Bucket="my-bucket")
+    s3.put_object(
+        Bucket="my-bucket",
+        Key="hello.txt",
+        Body=b"Hello from Python!",
+    )
+```
+
+The default config puts all the data in `.s3-testing` - pop this in your `.gitignore`.
+
+If you want a `pytest` fixture that gives you empty buckets, just [`shutil.rmtree(config.dir)`](test.py) between tests.
+
+It has no auth, pass in whatever creds.
+
+On my machine:
+
+- Spinning up the server til it responds takes 700ms.
+- Creating a bucket takes 1ms.
+- Writing then reading a small object takes 3ms.

s3_testing-0.0.1/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "s3-testing"
+version = "0.0.1"
+description = "S3 testing helpers"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = ["rclone-binaries"]
+
+[[project.authors]]
+name = "Oliver Russell"
+email = "mrxoliver@gmail.com"
+
+[project.license]
+file = "LICENSE"
+
+[project.urls]
+homepage = "https://github.com/leontrolski/s3-testing"
+documentation = "https://github.com/leontrolski/s3-testing"
+repository = "https://github.com/leontrolski/s3-testing.git"
+
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"

s3_testing-0.0.1/pyproject.toml.orig

@@ -0,0 +1,22 @@
+[project]
+name = "s3-testing"
+version = "0.0.1"
+description = "S3 testing helpers"
+readme = "README.md"
+authors = [
+    { name = "Oliver Russell", email = "mrxoliver@gmail.com" }
+]
+requires-python = ">=3.12"
+license = { file = "LICENSE" }
+dependencies = [
+    "rclone-binaries"
+]
+
+[project.urls]
+homepage = "https://github.com/leontrolski/s3-testing"
+documentation = "https://github.com/leontrolski/s3-testing"
+repository = "https://github.com/leontrolski/s3-testing.git"
+
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"

s3_testing-0.0.1/src/s3_testing/__init__.py

@@ -0,0 +1,69 @@
+import shutil
+import subprocess
+from collections.abc import Iterator
+from contextlib import contextmanager
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Literal, TypedDict
+
+import rclone_binaries
+
+
+class BotoKwargs(TypedDict):
+    service_name: str
+    endpoint_url: str
+    aws_access_key_id: str
+    aws_secret_access_key: str
+
+
+@dataclass(frozen=True, kw_only=True)
+class Config:
+    on_existing: Literal["use", "replace"] = "use"
+    dir: Path = Path(".s3-testing")
+    host: str = "localhost"
+    port: int = 9000
+
+    @property
+    def as_boto_kwargs(self) -> BotoKwargs:
+        return BotoKwargs(
+            service_name="s3",
+            endpoint_url=f"http://{self.host}:{self.port}",
+            aws_access_key_id="dummy",
+            aws_secret_access_key="dummy",
+        )
+
+
+@contextmanager
+def serve(c: Config = Config()) -> Iterator[Config]:
+    if c.on_existing == "replace":
+        shutil.rmtree(c.dir)
+    c.dir.mkdir(parents=True, exist_ok=True)
+    with (
+        open(c.dir / "stdout.log", "wb") as stdout_f,
+        open(c.dir / "stderr.log", "wb") as stderr_f,
+    ):
+        cmd = [
+            str(rclone_binaries.bin()),
+            "serve",
+            "s3",
+            *("--addr", f"{c.host}:{c.port}"),
+            # Make sure the FS matches the VFS
+            *("--dir-cache-time", "0"),
+            *("--poll-interval", "0"),
+            str(c.dir),
+        ]
+        process = subprocess.Popen(
+            cmd,
+            stdout=stdout_f,
+            stderr=stderr_f,
+        )
+        try:
+            yield c
+        finally:
+            # Shutdown
+            process.terminate()
+            try:
+                process.wait(timeout=1)
+            except subprocess.TimeoutExpired:
+                process.kill()
+                process.wait(timeout=5)