Better organization of unit & integration tests

Author: vdusek

tests/integration/conftest.py

@@ -8,12 +8,14 @@
 import asyncio
 import json
 import os
+import secrets
+import string
 import time
+from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, TypeVar, overload
 
 import pytest
 
-from .utils import DatasetFixture, KvsFixture, get_crypto_random_object_id
 from apify_client import ApifyClient, ApifyClientAsync
 from apify_client._utils import create_hmac_signature, create_storage_content_signature
 
@@ -29,10 +31,54 @@
 
 
 # ============================================================================
-# Helper functions for sync/async test compatibility
+# Data classes for test fixtures
 # ============================================================================
 
 
+@dataclass
+class StorageFixture:
+    """Base storage fixture with ID and signature."""
+
+    id: str
+    signature: str
+
+
+@dataclass
+class DatasetFixture(StorageFixture):
+    """Dataset fixture with expected content."""
+
+    expected_content: list
+
+
+@dataclass
+class KvsFixture(StorageFixture):
+    """Key-value store fixture with expected content and key signatures."""
+
+    expected_content: dict[str, Any]
+    keys_signature: dict[str, str]
+
+
+# ============================================================================
+# Helper functions
+# ============================================================================
+
+
+def get_crypto_random_object_id(length: int = 17) -> str:
+    """Generate a cryptographically secure random object ID."""
+    chars = 'abcdefghijklmnopqrstuvwxyzABCEDFGHIJKLMNOPQRSTUVWXYZ0123456789'
+    return ''.join(secrets.choice(chars) for _ in range(length))
+
+
+def get_random_string(length: int = 10) -> str:
+    """Generate a random alphabetic string."""
+    return ''.join(secrets.choice(string.ascii_letters) for _ in range(length))
+
+
+def get_random_resource_name(resource: str) -> str:
+    """Generate a random resource name for test resources."""
+    return f'python-client-test-{resource}-{get_random_string(5)}'
+
+
 @overload
 async def maybe_await(value: Coroutine[Any, Any, T]) -> T: ...
 
@@ -60,6 +106,24 @@ async def maybe_sleep(seconds: float, *, is_async: bool) -> None:
         time.sleep(seconds)  # noqa: ASYNC251
 
 
+# ============================================================================
+# Pytest markers and parametrization
+# ============================================================================
+
+parametrized_api_urls = pytest.mark.parametrize(
+    ('api_url', 'api_public_url'),
+    [
+        ('https://api.apify.com', 'https://api.apify.com'),
+        ('https://api.apify.com', None),
+        ('https://api.apify.com', 'https://custom-public-url.com'),
+        ('https://api.apify.com', 'https://custom-public-url.com/with/custom/path'),
+        ('https://api.apify.com', 'https://custom-public-url.com/with/custom/path/'),
+        ('http://10.0.88.214:8010', 'https://api.apify.com'),
+        ('http://10.0.88.214:8010', None),
+    ],
+)
+"""Parametrize decorator for testing various API URL and public URL combinations."""
+
 # ============================================================================
 # Session-scoped fixtures (created once per test session)
 # ============================================================================

tests/integration/test_actor.py

@@ -4,8 +4,7 @@
 
 from typing import TYPE_CHECKING, cast
 
-from .conftest import maybe_await
-from .utils import get_random_resource_name
+from .conftest import get_random_resource_name, maybe_await
 
 if TYPE_CHECKING:
     from apify_client import ApifyClient, ApifyClientAsync

tests/integration/test_actor_env_var.py

@@ -9,8 +9,7 @@
     from apify_client._models import Actor, EnvVar, ListOfEnvVars
 
 
-from .conftest import maybe_await
-from .utils import get_random_resource_name
+from .conftest import get_random_resource_name, maybe_await
 
 
 async def test_actor_env_var_list(client: ApifyClient | ApifyClientAsync) -> None:

tests/integration/test_actor_version.py

@@ -9,8 +9,7 @@
     from apify_client._models import Actor, ListOfVersions, Version
 
 
-from .conftest import maybe_await
-from .utils import get_random_resource_name
+from .conftest import get_random_resource_name, maybe_await
 from apify_client._models import VersionSourceType
 
 

tests/integration/test_build.py

@@ -9,8 +9,7 @@
     from apify_client._models import Actor, Build, ListOfBuilds
 
 
-from .conftest import maybe_await
-from .utils import get_random_resource_name
+from .conftest import get_random_resource_name, maybe_await
 
 # Use a public actor that has builds available
 HELLO_WORLD_ACTOR = 'apify/hello-world'

tests/integration/test_dataset.py

@@ -10,54 +10,18 @@
 
     from impit import Response
 
+    from apify_client import ApifyClient, ApifyClientAsync
     from apify_client._models import Dataset
     from apify_client._resource_clients.dataset import DatasetItemsPage
 
 import json
-from unittest import mock
-from unittest.mock import Mock
 
 import impit
 import pytest
 
-from .conftest import maybe_await, maybe_sleep
-from .utils import DatasetFixture, get_random_resource_name, parametrized_api_urls
-from apify_client import ApifyClient, ApifyClientAsync
-from apify_client._config import DEFAULT_API_URL
+from .conftest import DatasetFixture, get_random_resource_name, maybe_await, maybe_sleep
 from apify_client.errors import ApifyApiError
 
-##################################################
-# OLD TESTS - Tests with mocks and signed URLs
-##################################################
-
-MOCKED_API_DATASET_RESPONSE = """{
-  "data": {
-    "id": "someID",
-    "name": "name",
-    "userId": "userId",
-    "createdAt": "2025-09-11T08:48:51.806Z",
-    "modifiedAt": "2025-09-11T08:48:51.806Z",
-    "accessedAt": "2025-09-11T08:48:51.806Z",
-    "itemCount": 0,
-    "cleanItemCount": 0,
-    "actId": null,
-    "actRunId": null,
-    "schema": null,
-    "stats": {
-      "readCount": 0,
-      "writeCount": 0,
-      "deleteCount": 0,
-      "listCount": 0,
-      "storageBytes": 0
-    },
-    "fields": [],
-    "consoleUrl": "https://console.apify.com/storage/datasets/someID",
-    "itemsPublicUrl": "https://api.apify.com/v2/datasets/someID/items",
-    "generalAccess": "FOLLOW_USER_SETTING",
-    "urlSigningSecretKey": "urlSigningSecretKey"
-  }
-}"""
-
 
 async def test_dataset_should_create_public_items_expiring_url_with_params(
     client: ApifyClient | ApifyClientAsync,
@@ -111,38 +75,6 @@ async def test_dataset_should_create_public_items_non_expiring_url(
     assert result is None
 
 
-# Parametrized test remains sync-only as it tests URL generation with mocks
-@parametrized_api_urls
-async def test_public_url(
-    client: ApifyClient | ApifyClientAsync,
-    api_token: str,
-    api_url: str,
-    api_public_url: str,
-) -> None:
-    """Test public URL generation for datasets (runs for both sync and async clients)."""
-    # Create a fresh client with the parametrized URL settings
-    test_client = (
-        ApifyClientAsync(token=api_token, api_url=api_url, api_public_url=api_public_url)
-        if isinstance(client, ApifyClientAsync)
-        else ApifyClient(token=api_token, api_url=api_url, api_public_url=api_public_url)
-    )
-
-    dataset = test_client.dataset('someID')
-
-    # Mock the API call to return predefined response
-    mock_response = Mock()
-    mock_response.json.return_value = json.loads(MOCKED_API_DATASET_RESPONSE)
-
-    with mock.patch.object(test_client._http_client, 'call', return_value=mock_response):
-        result = await maybe_await(dataset.create_items_public_url())
-        public_url = cast('str', result)
-
-        assert public_url == (
-            f'{(api_public_url or DEFAULT_API_URL).strip("/")}/v2/datasets/'
-            f'someID/items?signature={public_url.split("signature=")[1]}'
-        )
-
-
 async def test_list_items_signature(
     client: ApifyClient | ApifyClientAsync, test_dataset_of_another_user: DatasetFixture
 ) -> None:
@@ -214,11 +146,6 @@ async def test_get_items_as_bytes_signature(
     assert test_dataset_of_another_user.expected_content == json.loads(raw_data.decode('utf-8'))
 
 
-#############
-# NEW TESTS #
-#############
-
-
 async def test_dataset_get_or_create_and_get(client: ApifyClient | ApifyClientAsync) -> None:
     """Test creating a dataset and retrieving it."""
     dataset_name = get_random_resource_name('dataset')

tests/integration/test_key_value_store.py

@@ -5,54 +5,17 @@
 from typing import TYPE_CHECKING, cast
 
 if TYPE_CHECKING:
+    from apify_client import ApifyClient, ApifyClientAsync
     from apify_client._models import KeyValueStore, ListOfKeys
 
 import json
-from unittest import mock
-from unittest.mock import Mock
 
 import impit
 import pytest
 
-from .conftest import maybe_await, maybe_sleep
-from .utils import KvsFixture, get_random_resource_name, parametrized_api_urls
-from apify_client import ApifyClient, ApifyClientAsync
-from apify_client._config import DEFAULT_API_URL
-from apify_client._utils import create_hmac_signature, create_storage_content_signature
+from .conftest import KvsFixture, get_random_resource_name, maybe_await, maybe_sleep
 from apify_client.errors import ApifyApiError
 
-##################################################
-# OLD TESTS - Tests with mocks and signed URLs
-##################################################
-
-MOCKED_ID = 'someID'
-
-
-def _get_mocked_api_kvs_response(signing_key: str | None = None) -> Mock:
-    response_data = {
-        'data': {
-            'id': MOCKED_ID,
-            'name': 'name',
-            'userId': 'userId',
-            'createdAt': '2025-09-11T08:48:51.806Z',
-            'modifiedAt': '2025-09-11T08:48:51.806Z',
-            'accessedAt': '2025-09-11T08:48:51.806Z',
-            'actId': None,
-            'actRunId': None,
-            'schema': None,
-            'stats': {'readCount': 0, 'writeCount': 0, 'deleteCount': 0, 'listCount': 0, 'storageBytes': 0},
-            'consoleUrl': 'https://console.apify.com/storage/key-value-stores/someID',
-            'keysPublicUrl': 'https://api.apify.com/v2/key-value-stores/someID/keys',
-            'generalAccess': 'FOLLOW_USER_SETTING',
-        }
-    }
-    if signing_key:
-        response_data['data']['urlSigningSecretKey'] = signing_key
-
-    mock_response = Mock()
-    mock_response.json.return_value = response_data
-    return mock_response
-
 
 async def test_key_value_store_should_create_expiring_keys_public_url_with_params(
     client: ApifyClient | ApifyClientAsync,
@@ -104,72 +67,6 @@ async def test_key_value_store_should_create_public_keys_non_expiring_url(
     assert result is None
 
 
-@pytest.mark.parametrize('signing_key', [None, 'custom-signing-key'])
-@parametrized_api_urls
-async def test_public_url(
-    client: ApifyClient | ApifyClientAsync, api_token: str, api_url: str, api_public_url: str, signing_key: str
-) -> None:
-    """Test public URL generation for key-value stores (runs for both sync and async clients)."""
-    # Create a fresh client with the parametrized URL settings
-    if isinstance(client, ApifyClientAsync):
-        test_client: ApifyClient | ApifyClientAsync = ApifyClientAsync(
-            token=api_token, api_url=api_url, api_public_url=api_public_url
-        )
-    else:
-        test_client = ApifyClient(token=api_token, api_url=api_url, api_public_url=api_public_url)
-
-    kvs = test_client.key_value_store(MOCKED_ID)
-
-    # Mock the API call to return predefined response
-    with mock.patch.object(
-        test_client._http_client,
-        'call',
-        return_value=_get_mocked_api_kvs_response(signing_key=signing_key),
-    ):
-        public_url = await maybe_await(kvs.create_keys_public_url())
-        if signing_key:
-            signature_value = create_storage_content_signature(
-                resource_id=MOCKED_ID, url_signing_secret_key=signing_key
-            )
-            expected_signature = f'?signature={signature_value}'
-        else:
-            expected_signature = ''
-        assert public_url == (
-            f'{(api_public_url or DEFAULT_API_URL).strip("/")}/v2/key-value-stores/someID/keys{expected_signature}'
-        )
-
-
-@pytest.mark.parametrize('signing_key', [None, 'custom-signing-key'])
-@parametrized_api_urls
-async def test_record_public_url(
-    client: ApifyClient | ApifyClientAsync, api_token: str, api_url: str, api_public_url: str, signing_key: str
-) -> None:
-    """Test record public URL generation for key-value stores (runs for both sync and async clients)."""
-    # Create a fresh client with the parametrized URL settings
-    if isinstance(client, ApifyClientAsync):
-        test_client: ApifyClient | ApifyClientAsync = ApifyClientAsync(
-            token=api_token, api_url=api_url, api_public_url=api_public_url
-        )
-    else:
-        test_client = ApifyClient(token=api_token, api_url=api_url, api_public_url=api_public_url)
-
-    key = 'some_key'
-    kvs = test_client.key_value_store(MOCKED_ID)
-
-    # Mock the API call to return predefined response
-    with mock.patch.object(
-        test_client._http_client,
-        'call',
-        return_value=_get_mocked_api_kvs_response(signing_key=signing_key),
-    ):
-        public_url = await maybe_await(kvs.get_record_public_url(key=key))
-        expected_signature = f'?signature={create_hmac_signature(signing_key, key)}' if signing_key else ''
-        assert public_url == (
-            f'{(api_public_url or DEFAULT_API_URL).strip("/")}/v2/key-value-stores/someID/'
-            f'records/{key}{expected_signature}'
-        )
-
-
 async def test_list_keys_signature(
     client: ApifyClient | ApifyClientAsync, test_kvs_of_another_user: KvsFixture
 ) -> None:
@@ -271,11 +168,6 @@ async def test_stream_record_signature(
     assert test_kvs_of_another_user.expected_content[key] == value
 
 
-#############
-# NEW TESTS #
-#############
-
-
 async def test_key_value_store_get_or_create_and_get(client: ApifyClient | ApifyClientAsync) -> None:
     """Test creating a key-value store and retrieving it."""
     store_name = get_random_resource_name('kvs')