Move test helpers and fixtures to the project's testing module

Author: kacper-wolkiewicz-reef

.gitignore

@@ -13,4 +13,5 @@ venv
 .venv
 .vscode
 .pdm-build/
-.pdm-python
+.pdm-python
+.env

b2sdk/_internal/testing/__init__.py

@@ -11,12 +11,12 @@
 
 from test.integration.helpers import authorize
 
-from . import get_b2_auth_data
-from .bucket_cleaner import BucketCleaner
-from .test_raw_api import cleanup_old_buckets
+from b2sdk._internal.testing.helpers.api import get_b2_auth_data
+from b2sdk._internal.testing.helpers.bucket_cleaner import BucketCleaner
+# from .test_raw_api import cleanup_old_buckets
 
 if __name__ == '__main__':
-    cleanup_old_buckets()
+    # cleanup_old_buckets()
     BucketCleaner(
         dont_cleanup_old_buckets=False, b2_api=authorize(get_b2_auth_data())[0]
     ).cleanup_buckets()

test/integration/cleanup_buckets.py …sdk/_internal/testing/cleanup_buckets.pytest/integration/cleanup_buckets.py renamed to b2sdk/_internal/testing/cleanup_buckets.py test/integration/cleanup_buckets.py renamed to b2sdk/_internal/testing/cleanup_buckets.py

@@ -0,0 +1,44 @@
+
+######################################################################
+#
+# File: test/integration/conftest.py
+#
+# Copyright 2021 Backblaze Inc. All Rights Reserved.
+#
+# License https://www.backblaze.com/using_b2_code.html
+#
+######################################################################
+from __future__ import annotations
+
+import http
+import http.client
+import os
+
+import pytest
+
+from b2sdk._internal.testing.helpers.api import get_b2_auth_data, authorize
+
+
+@pytest.fixture(autouse=True, scope='session')
+def set_http_debug():
+    if os.environ.get('B2_DEBUG_HTTP'):
+        http.client.HTTPConnection.debuglevel = 1
+
+
+@pytest.fixture(scope='session')
+def b2_auth_data():
+    try:
+        return get_b2_auth_data()
+    except ValueError as ex:
+        pytest.fail(ex.args[0])
+
+
+@pytest.fixture(scope='session')
+def _b2_api(b2_auth_data):
+    b2_api, _ = authorize(b2_auth_data)
+    return b2_api
+
+
+@pytest.fixture(scope='session')
+def b2_api(_b2_api, bucket_cleaner):
+    return _b2_api

b2sdk/_internal/testing/fixtures/__init__.py

@@ -0,0 +1,71 @@
+######################################################################
+#
+# File: test/integration/conftest.py
+#
+# Copyright 2021 Backblaze Inc. All Rights Reserved.
+#
+# License https://www.backblaze.com/using_b2_code.html
+#
+######################################################################
+from __future__ import annotations
+import secrets
+
+import pytest
+
+from b2sdk._internal.utils import current_time_millis
+from b2sdk._internal.testing.helpers.bucket_cleaner import BucketCleaner
+from b2sdk._internal.testing.helpers.buckets import (
+    BUCKET_CREATED_AT_MILLIS,
+    get_bucket_name_prefix,
+    random_bucket_name,
+)
+
+
+def pytest_addoption(parser):
+    """Add a flag for not cleaning up old buckets"""
+    parser.addoption(
+        '--dont-cleanup-old-buckets',
+        action='store_true',
+        default=False,
+    )
+
+
+@pytest.fixture(scope='session')
+def dont_cleanup_old_buckets(request):
+    return request.config.getoption('--dont-cleanup-old-buckets')
+
+
+@pytest.fixture(scope='session')
+def bucket_name_prefix():
+    return get_bucket_name_prefix(8)
+
+
+@pytest.fixture(scope='session')
+def bucket_cleaner(bucket_name_prefix, dont_cleanup_old_buckets, _b2_api):
+    cleaner = BucketCleaner(
+        dont_cleanup_old_buckets,
+        _b2_api,
+        current_run_prefix=bucket_name_prefix,
+    )
+    yield cleaner
+    cleaner.cleanup_buckets()
+
+
+@pytest.fixture
+def bucket(b2_api, bucket_name_prefix, bucket_cleaner):
+    bucket = b2_api.create_bucket(
+        random_bucket_name(bucket_name_prefix),
+        'allPrivate',
+        bucket_info={
+            'created_by': 'b2-sdk integration test',
+            BUCKET_CREATED_AT_MILLIS: str(current_time_millis()),
+        },
+    )
+    yield bucket
+    bucket_cleaner.cleanup_bucket(bucket)
+
+
+@pytest.fixture
+def b2_subfolder(bucket, request):
+    subfolder_name = f'{request.node.name}_{secrets.token_urlsafe(4)}'
+    return f'b2://{bucket.name}/{subfolder_name}'

b2sdk/_internal/testing/fixtures/api.py

@@ -0,0 +1,37 @@
+######################################################################
+#
+# File: test/integration/helpers.py
+#
+# Copyright 2022 Backblaze Inc. All Rights Reserved.
+#
+# License https://www.backblaze.com/using_b2_code.html
+#
+######################################################################
+from __future__ import annotations
+
+import os
+
+from b2sdk.v3 import (
+    DEFAULT_HTTP_API_CONFIG,
+    B2Api,
+    InMemoryAccountInfo,
+)
+
+
+def get_b2_auth_data():
+    application_key_id = os.environ.get('B2_TEST_APPLICATION_KEY_ID')
+    if application_key_id is None:
+        raise ValueError('B2_TEST_APPLICATION_KEY_ID is not set.')
+
+    application_key = os.environ.get('B2_TEST_APPLICATION_KEY')
+    if application_key is None:
+        raise ValueError('B2_TEST_APPLICATION_KEY is not set.')
+    return application_key_id, application_key
+
+
+def authorize(b2_auth_data, api_config=DEFAULT_HTTP_API_CONFIG):
+    info = InMemoryAccountInfo()
+    b2_api = B2Api(info, api_config=api_config)
+    realm = os.environ.get('B2_TEST_ENVIRONMENT', 'production')
+    b2_api.authorize_account(*b2_auth_data, realm=realm)
+    return b2_api, info

b2sdk/_internal/testing/fixtures/buckets.py

@@ -13,8 +13,8 @@
 
 from b2sdk.v2 import B2Api, current_time_millis
 from b2sdk.v2.exception import DuplicateBucketName
-from test.integration.bucket_cleaner import BucketCleaner
-from test.integration.helpers import (
+from b2sdk._internal.testing.helpers.bucket_cleaner import BucketCleaner
+from b2sdk._internal.testing.helpers.buckets import (
     BUCKET_CREATED_AT_MILLIS,
     random_bucket_name,
 )
@@ -58,7 +58,7 @@ def create_bucket(self):
         try:
             bucket = self.b2_api.create_bucket(
                 bucket_name,
-                'allPublic',
+                'allPrivate',
                 bucket_info={BUCKET_CREATED_AT_MILLIS: str(current_time_millis())},
             )
         except DuplicateBucketName:

b2sdk/_internal/testing/helpers/__init__.py

@@ -20,8 +20,8 @@
     current_time_millis,
 )
 from b2sdk.v3.exception import BadRequest
+from b2sdk._internal.testing.helpers.buckets import BUCKET_CREATED_AT_MILLIS, GENERAL_BUCKET_NAME_PREFIX
 
-from .helpers import BUCKET_CREATED_AT_MILLIS, GENERAL_BUCKET_NAME_PREFIX
 
 ONE_HOUR_MILLIS = 60 * 60 * 1000