Rewrite tests to use the new-style API

Author: mvantellingen

src/commercetools/base_client.py

@@ -52,7 +52,7 @@ def __init__(
     ) -> None:
         # Use environment variables as fallback
         config = {
-            "project_key": project_key,
+            "project_key": project_key or "example-project",
             "client_id": client_id,
             "client_secret": client_secret,
             "url": url,
@@ -230,9 +230,3 @@ def _get_user_agent(self):
             sys.platform,
             arch,
         )
-
-
-class Client(BaseClient):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self._base_url = f"{self._config['url']}/{self._config['project_key']}/"

src/commercetools/contrib/pytest.py

@@ -5,7 +5,6 @@
 import pytest
 import requests
 
-from commercetools import Client
 from commercetools.platform.client import Client as PlatformClient
 from commercetools.testing import backend_mocker
 from commercetools.testing.server import Server
@@ -25,7 +24,9 @@ def commercetools_api():
 
 
 @pytest.fixture
-def ct_platform_client(commercetools_api) -> typing.Generator[Client, None, None]:
+def ct_platform_client(
+    commercetools_api,
+) -> typing.Generator[PlatformClient, None, None]:
     yield PlatformClient(
         client_id="client-id",
         client_secret="client-secret",
@@ -35,18 +36,6 @@ def ct_platform_client(commercetools_api) -> typing.Generator[Client, None, None
     )
 
 
-@pytest.fixture
-def commercetools_client(commercetools_api) -> typing.Generator[Client, None, None]:
-    yield Client(
-        project_key="unittest",
-        client_id="client-id",
-        client_secret="client-secret",
-        scope=[],
-        url="https://api.europe-west1.gcp.commercetools.com",
-        token_url="https://auth.europe-west1.gcp.commercetools.com/oauth/token",
-    )
-
-
 @pytest.fixture()
 def commercetools_http_server(commercetools_api):
     is_running = threading.Event()

src/commercetools/testing/auth.py

@@ -91,7 +91,7 @@ def introspect(self, request):
             if token in stored_tokens:
                 status = {
                     "active": True,
-                    "scope": "manage_project:todo",
+                    "scope": "manage_project:example-project",
                     "exp": self._expire_time,
                 }
             else:

src/commercetools/testing/product_projections.py

@@ -1,6 +1,7 @@
 import typing
 
 from marshmallow import fields
+
 from commercetools.platform import models
 from commercetools.platform.models._schemas.product import (
     ProductProjectionPagedQueryResponseSchema,
@@ -11,6 +12,7 @@
 from commercetools.testing.abstract import ServiceBackend
 from commercetools.testing.utils import create_commercetools_response
 
+
 class _ProductProjectionQuerySchema(
     traits.ExpandableSchema,
     traits.SortableSchema,
@@ -21,7 +23,6 @@ class _ProductProjectionQuerySchema(
     staged = fields.Bool(required=False, missing=False)
 
 
-
 class ProductProjectionsBackend(ServiceBackend):
     service_path = "product-projections"
     _schema_query_params = _ProductProjectionQuerySchema

tests/platform/test_client.py

@@ -5,8 +5,8 @@
 from requests_mock.adapter import Adapter
 
 from commercetools import CommercetoolsError
-from commercetools.client import Client
 from commercetools.platform import models
+from commercetools.platform.client import Client
 
 
 @pytest.fixture()
@@ -34,14 +34,13 @@ def test_auto_refresh(commercetools_api):
     client = Client(
         client_id="unittest",
         client_secret="mysecret",
-        project_key="test",
         url="https://api.europe-west1.gcp.commercetools.com",
         token_url="https://auth.europe-west1.gcp.commercetools.com/oauth/token",
-    )
-    client.products.query()
+    ).with_project_key("unittest")
+    client.products().get()
     time.sleep(1)
-    client.products.query()
-    client.products.query()
+    client.products().get()
+    client.products().get()
 
     auth_headers = set()
     for request in commercetools_api.requests_mock.request_history:
@@ -56,7 +55,7 @@ def test_cache_token(commercetools_api):
     Client(
         client_id="unittest",
         client_secret="none",
-        project_key="test",
+        scope=["manage_project:test"],
         url="https://api.europe-west1.gcp.commercetools.com",
         token_url="https://auth.europe-west1.gcp.commercetools.com/oauth/token",
     )
@@ -90,90 +89,135 @@ def test_allows_passing_custom_http_adapter():
     assert len(my_adapter.request_history) == 1
 
 
-def test_resource_update_conflict(old_client):
+def test_resource_update_conflict(ct_platform_client: Client):
     """Test the return value of the update methods.
 
     It doesn't test the actual update itself.
     TODO: See if this is worth testing since we're using a mocking backend
     """
-    product = old_client.products.create(
-        models.ProductDraft(
-            key="test-product",
-            product_type=models.ProductTypeResourceIdentifier(key="dummy"),
-            name={"en": "my-product"},
-            slug={"en": "foo-bar"},
+    product = (
+        ct_platform_client.with_project_key("unittest")
+        .products()
+        .post(
+            models.ProductDraft(
+                key="test-product",
+                product_type=models.ProductTypeResourceIdentifier(key="dummy"),
+                name={"en": "my-product"},
+                slug={"en": "foo-bar"},
+            )
         )
     )
 
     assert product.version == 1
     assert uuid.UUID(product.id)
     assert product.key == "test-product"
 
-    product = old_client.products.update_by_id(
-        id=product.id,
-        version=product.version,
-        actions=[
-            models.ProductChangeSlugAction(slug=models.LocalizedString(nl="nl-slug2"))
-        ],
+    product = (
+        ct_platform_client.with_project_key("unittest")
+        .products()
+        .with_id(product.id)
+        .post(
+            models.ProductUpdate(
+                version=product.version,
+                actions=[
+                    models.ProductChangeSlugAction(
+                        slug=models.LocalizedString(nl="nl-slug2")
+                    )
+                ],
+            )
+        )
     )
     assert product.key == "test-product"
     assert product.version == 2
 
     # This should raise a version conflict error
     with pytest.raises(CommercetoolsError) as exc:
-        product = old_client.products.update_by_id(
-            id=product.id,
-            version=1,
-            actions=[
-                models.ProductChangeSlugAction(
-                    slug=models.LocalizedString(nl="nl-slug3")
+        product = (
+            ct_platform_client.with_project_key("unittest")
+            .products()
+            .with_id(product.id)
+            .post(
+                models.ProductUpdate(
+                    version=1,
+                    actions=[
+                        models.ProductChangeSlugAction(
+                            slug=models.LocalizedString(nl="nl-slug3")
+                        )
+                    ],
                 )
-            ],
+            )
         )
     assert exc.value.response.status_code == 409
     assert exc.value.response.errors[0].current_version == 2
 
     # Force it
-    product = old_client.products.update_by_id(
-        id=product.id,
-        version=1,
-        actions=[
-            models.ProductChangeSlugAction(slug=models.LocalizedString(nl="nl-slug2"))
-        ],
-        force_update=True,
+    product = (
+        ct_platform_client.with_project_key("unittest")
+        .products()
+        .with_id(product.id)
+        .post(
+            models.ProductUpdate(
+                version=1,
+                actions=[
+                    models.ProductChangeSlugAction(
+                        slug=models.LocalizedString(nl="nl-slug2")
+                    )
+                ],
+            ),
+            options={"force_version": True},
+        )
     )
 
 
-def test_resource_delete_conflict(old_client):
+def test_resource_delete_conflict(ct_platform_client: Client):
     """Test the return value of the delete methods.
 
     It doesn't test the actual delete itself.
     TODO: See if this is worth testing since we're using a mocking backend
     """
-    product = old_client.products.create(
-        models.ProductDraft(
-            key="test-product",
-            product_type=models.ProductTypeResourceIdentifier(key="dummy"),
-            name={"en": "my-product"},
-            slug={"en": "foo-bar"},
+    product = (
+        ct_platform_client.with_project_key("unittest")
+        .products()
+        .post(
+            models.ProductDraft(
+                key="test-product",
+                product_type=models.ProductTypeResourceIdentifier(key="dummy"),
+                name={"en": "my-product"},
+                slug={"en": "foo-bar"},
+            )
         )
     )
 
-    product = old_client.products.update_by_id(
-        id=product.id,
-        version=product.version,
-        actions=[
-            models.ProductChangeSlugAction(slug=models.LocalizedString(nl="nl-slug2"))
-        ],
+    product = (
+        ct_platform_client.with_project_key("unittest")
+        .products()
+        .with_id(product.id)
+        .post(
+            models.ProductUpdate(
+                version=product.version,
+                actions=[
+                    models.ProductChangeSlugAction(
+                        slug=models.LocalizedString(nl="nl-slug2")
+                    )
+                ],
+            ),
+        )
     )
     assert product.version == 2
 
     # This should raise a version conflict error
     with pytest.raises(CommercetoolsError) as exc:
-        product = old_client.products.delete_by_id(id=product.id, version=1)
+        product = (
+            ct_platform_client.with_project_key("unittest")
+            .products()
+            .with_id(product.id)
+            .delete(version=1)
+        )
 
     assert exc.value.response.status_code == 409
     assert exc.value.response.errors[0].current_version == 2
 
     # Force it
-    old_client.products.delete_by_id(id=product.id, version=1, force_delete=True)
+    ct_platform_client.with_project_key("unittest").products().with_id(
+        product.id
+    ).delete(version=1, options={"force_version": True})