1 files changed, 123 insertions, 0 deletions
diff --git a/autogpts/autogpt/tests/unit/test_s3_file_workspace.py b/autogpts/autogpt/tests/unit/test_s3_file_workspace.py
new file mode 100644
index 000000000..980d1e3b8
--- /dev/null
+++ b/autogpts/autogpt/tests/unit/test_s3_file_workspace.py
@@ -0,0 +1,123 @@
+import os
+import uuid
+from pathlib import Path
+
+import pytest
+import pytest_asyncio
+from botocore.exceptions import ClientError
+
+from autogpt.file_workspace.s3 import S3FileWorkspace, S3FileWorkspaceConfiguration
+
+if not os.getenv("S3_ENDPOINT_URL") and not os.getenv("AWS_ACCESS_KEY_ID"):
+    pytest.skip("S3 environment variables are not set", allow_module_level=True)
+
+
+@pytest.fixture
+def s3_bucket_name() -> str:
+    return f"test-bucket-{str(uuid.uuid4())[:8]}"
+
+
+@pytest.fixture
+def s3_workspace_uninitialized(s3_bucket_name: str) -> S3FileWorkspace:
+    os.environ["WORKSPACE_STORAGE_BUCKET"] = s3_bucket_name
+    ws_config = S3FileWorkspaceConfiguration.from_env()
+    ws_config.root = Path("/workspaces/AutoGPT-some-unique-task-id")
+    workspace = S3FileWorkspace(ws_config)
+    yield workspace  # type: ignore
+    del os.environ["WORKSPACE_STORAGE_BUCKET"]
+
+
+def test_initialize(s3_bucket_name: str, s3_workspace_uninitialized: S3FileWorkspace):
+    s3 = s3_workspace_uninitialized._s3
+
+    # test that the bucket doesn't exist yet
+    with pytest.raises(ClientError):
+        s3.meta.client.head_bucket(Bucket=s3_bucket_name)
+
+    s3_workspace_uninitialized.initialize()
+
+    # test that the bucket has been created
+    s3.meta.client.head_bucket(Bucket=s3_bucket_name)
+
+
+def test_workspace_bucket_name(
+    s3_workspace: S3FileWorkspace,
+    s3_bucket_name: str,
+):
+    assert s3_workspace._bucket.name == s3_bucket_name
+
+
+@pytest.fixture
+def s3_workspace(s3_workspace_uninitialized: S3FileWorkspace) -> S3FileWorkspace:
+    (s3_workspace := s3_workspace_uninitialized).initialize()
+    yield s3_workspace  # type: ignore
+
+    # Empty & delete the test bucket
+    s3_workspace._bucket.objects.all().delete()
+    s3_workspace._bucket.delete()
+
+
+NESTED_DIR = "existing/test/dir"
+TEST_FILES: list[tuple[str | Path, str]] = [
+    ("existing_test_file_1", "test content 1"),
+    ("existing_test_file_2.txt", "test content 2"),
+    (Path("existing_test_file_3"), "test content 3"),
+    (Path(f"{NESTED_DIR}/test/file/4"), "test content 4"),
+]
+
+
+@pytest_asyncio.fixture
+async def s3_workspace_with_files(s3_workspace: S3FileWorkspace) -> S3FileWorkspace:
+    for file_name, file_content in TEST_FILES:
+        s3_workspace._bucket.Object(str(s3_workspace.get_path(file_name))).put(
+            Body=file_content
+        )
+    yield s3_workspace  # type: ignore
+
+
+@pytest.mark.asyncio
+async def test_read_file(s3_workspace_with_files: S3FileWorkspace):
+    for file_name, file_content in TEST_FILES:
+        content = s3_workspace_with_files.read_file(file_name)
+        assert content == file_content
+
+    with pytest.raises(ClientError):
+        s3_workspace_with_files.read_file("non_existent_file")
+
+
+def test_list_files(s3_workspace_with_files: S3FileWorkspace):
+    # List at root level
+    assert (files := s3_workspace_with_files.list()) == s3_workspace_with_files.list()
+    assert len(files) > 0
+    assert set(files) == set(Path(file_name) for file_name, _ in TEST_FILES)
+
+    # List at nested path
+    assert (
+        nested_files := s3_workspace_with_files.list(NESTED_DIR)
+    ) == s3_workspace_with_files.list(NESTED_DIR)
+    assert len(nested_files) > 0
+    assert set(nested_files) == set(
+        p.relative_to(NESTED_DIR)
+        for file_name, _ in TEST_FILES
+        if (p := Path(file_name)).is_relative_to(NESTED_DIR)
+    )
+
+
+@pytest.mark.asyncio
+async def test_write_read_file(s3_workspace: S3FileWorkspace):
+    await s3_workspace.write_file("test_file", "test_content")
+    assert s3_workspace.read_file("test_file") == "test_content"
+
+
+@pytest.mark.asyncio
+async def test_overwrite_file(s3_workspace_with_files: S3FileWorkspace):
+    for file_name, _ in TEST_FILES:
+        await s3_workspace_with_files.write_file(file_name, "new content")
+        assert s3_workspace_with_files.read_file(file_name) == "new content"
+
+
+def test_delete_file(s3_workspace_with_files: S3FileWorkspace):
+    for file_to_delete, _ in TEST_FILES:
+        s3_workspace_with_files.delete_file(file_to_delete)
+        with pytest.raises(ClientError):
+            s3_workspace_with_files.read_file(file_to_delete)