Merge pull request #140 from supabase-community/fix-storage-tests

tests: ignore 404 when double-checking bucket deletion

Author: dreinon

supabase/__init__.py

@@ -4,4 +4,5 @@
 from supabase.client import Client, create_client
 from supabase.lib.auth_client import SupabaseAuthClient
 from supabase.lib.realtime_client import SupabaseRealtimeClient
-from supabase.lib.storage_client import StorageFileAPI, SupabaseStorageClient
+from supabase.lib.storage import StorageException, StorageFileAPI
+from supabase.lib.storage_client import SupabaseStorageClient

supabase/lib/__init__.py

@@ -1,3 +1,3 @@
-from supabase.lib import auth_client, realtime_client, storage_client
+from supabase.lib import auth_client, realtime_client, storage, storage_client
 
-__all__ = ["auth_client", "realtime_client", "storage_client"]
+__all__ = ["auth_client", "realtime_client", "storage_client", "storage"]

supabase/lib/storage/__init__.py

@@ -0,0 +1,2 @@
+from .storage_bucket_api import StorageBucketAPI, StorageException
+from .storage_file_api import StorageFileAPI

supabase/lib/storage/storage_bucket_api.py

@@ -7,7 +7,7 @@
 
 from httpx import AsyncClient, Client, HTTPError
 
-__all__ = ["Bucket", "StorageBucketAPI"]
+__all__ = ["Bucket", "StorageBucketAPI", "StorageException"]
 
 _RequestMethod = str
 

test.ps1

@@ -1,6 +1,4 @@
 powershell -Command {
-    $env:SUPABASE_TEST_KEY = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYW5vbiIsImlhdCI6MTYzNTAwODQ4NywiZXhwIjoxOTUwNTg0NDg3fQ.l8IgkO7TQokGSc9OJoobXIVXsOXkilXl4Ak6SCX5qI8";
-    $env:SUPABASE_TEST_URL = "https://ibrydvrsxoapzgtnhpso.supabase.co";
     poetry install;
     poetry run pytest --cov=./ --cov-report=xml --cov-report=html -vv;
     poetry run pre-commit run --all-files;

tests/test_storage.py

@@ -1,27 +1,28 @@
 from __future__ import annotations
 
-from time import sleep
 from typing import TYPE_CHECKING
 from uuid import uuid4
 
 import pytest
 
+from supabase import StorageException
+
 if TYPE_CHECKING:
     from pathlib import Path
     from typing import Any, Callable, Dict, List
 
     from supabase import Client, StorageFileAPI, SupabaseStorageClient
 
 
-UUID_PREFIX = "pytest-"
+# Global variable to track the ids from the buckets created in the tests run
+temp_test_buckets_ids = []
 
 
 @pytest.fixture(scope="module")
 def uuid_factory() -> Callable[[], str]:
     def method() -> str:
-        """Generate a UUID"""
-        uuid = uuid4().hex[:8]  # Get the first 8 digits part to make it shorter
-        return f"{UUID_PREFIX}{uuid}"
+        """Generate a 8 digits long UUID"""
+        return uuid4().hex[:8]
 
     return method
 
@@ -36,19 +37,19 @@ def storage_client(supabase: Client) -> SupabaseStorageClient:
 def delete_left_buckets(
     request: pytest.FixtureRequest, storage_client: SupabaseStorageClient
 ):
-    """Ensures no test buckets are left"""
+    """Ensures no test buckets are left when a test that created a bucket fails"""
 
     def finalizer():
-        # Sleep 15 seconds in order to let buckets be deleted before the double-check
-        sleep(15)
-        buckets_list = storage_client.list_buckets()
-        if not buckets_list:
-            return
-
-        for bucket in buckets_list:
-            if bucket.id.startswith(UUID_PREFIX):
+        for bucket in temp_test_buckets_ids:
+            try:
                 storage_client.empty_bucket(bucket.id)
                 storage_client.delete_bucket(bucket.id)
+            except StorageException as e:
+                # Ignore 404 responses since they mean the bucket was already deleted
+                response = e.args[0]
+                if response["statusCode"] != 404:
+                    raise e
+                continue
 
     request.addfinalizer(finalizer)
 
@@ -59,13 +60,20 @@ def bucket(
 ) -> str:
     """Creates a test bucket which will be used in the whole storage tests run and deleted at the end"""
     bucket_id = uuid_factory()
+
+    # Store bucket_id in global list
+    global temp_test_buckets_ids
+    temp_test_buckets_ids.append(bucket_id)
+
     storage_client.create_bucket(id=bucket_id)
 
     yield bucket_id
 
     storage_client.empty_bucket(bucket_id)
     storage_client.delete_bucket(bucket_id)
 
+    temp_test_buckets_ids.remove(bucket_id)
+
 
 @pytest.fixture(scope="module")
 def storage_file_client(