NEXUS-817: add tests for retry on 5xx

Makefile

@@ -73,16 +73,20 @@ download-openapi-specs:
 client-merge-serverless-platform:
 	speakeasy merge -s ./openapi_platform_api.json -s ./openapi_serverless.json -o ./openapi_merged.yaml
 
-## client-generate-unified-sdk-local:		Generate the SDK using merged schemas
-.PHONY: client-generate-unified-sdk-local
-client-generate-unified-sdk-local:
+## client-apply-overlay:		            Apply overlay on the merged schema
+.PHONY: client-apply-overlay
+client-apply-overlay:
 	speakeasy overlay validate -o ./overlay_client.yaml
 	speakeasy overlay apply -s ./openapi_merged.yaml -o ./overlay_client.yaml > ./openapi_platform_serverless_client.yaml
+
+## client-generate-unified-sdk-local:		Generate the SDK from the merged schema
+.PHONY: client-generate-unified-sdk-local
+client-generate-unified-sdk-local:
 	speakeasy generate sdk -s ./openapi_platform_serverless_client.yaml -o ./ -l python
 
 ## client-generate-sdk:			             Do all the steps to generate the SDK
 .PHONY: client-generate-sdk
-client-generate-sdk: download-openapi-specs client-merge-serverless-platform client-generate-unified-sdk-local
+client-generate-sdk: download-openapi-specs client-merge-serverless-platform client-apply-overlay client-generate-unified-sdk-local
 
 
 .PHONY: publish

_test_contract/conftest.py

@@ -0,0 +1,125 @@
+import os
+from datetime import timedelta
+from pathlib import Path
+
+from freezegun import freeze_time
+import pytest
+
+from unstructured_client import UnstructuredClient, utils
+
+FAKE_API_KEY = "91pmLBeETAbXCpNylRsLq11FdiZPTk"
+
+
+@pytest.fixture(scope="module")
+def platform_client(platform_api_url) -> UnstructuredClient:
+    # settings the retry config to always try 3 times after a fail = 4 requests sent
+    _client = UnstructuredClient(
+        api_key_auth=FAKE_API_KEY,
+        server_url=platform_api_url,
+        retry_config=utils.RetryConfig(
+            "backoff", utils.BackoffStrategy(
+                initial_interval=3000,
+                max_interval=3000,
+                exponent=1.0,
+                max_elapsed_time=8000
+            ),
+            retry_connection_errors=True
+        )
+    )
+    yield _client
+
+
+@pytest.fixture(scope="module")
+def serverless_client(serverless_api_url) -> UnstructuredClient:
+    # settings the retry config to always try 3 times after a fail = 4 requests sent
+    _client = UnstructuredClient(
+        api_key_auth=FAKE_API_KEY,
+        server_url=serverless_api_url,
+        retry_config = utils.RetryConfig(
+        "backoff", utils.BackoffStrategy(
+            initial_interval=3000,
+            max_interval=3000,
+            exponent=1.0,
+            max_elapsed_time=8000
+        ),
+        retry_connection_errors=True
+    )
+    )
+    yield _client
+
+
+@pytest.fixture()
+def freezer():
+    ignore = ['_pytest.terminal', '_pytest.runner']
+    freezer = freeze_time(ignore=ignore)
+    frozen_time = freezer.start()
+    yield frozen_time
+    freezer.stop()
+
+@pytest.fixture(autouse=True)
+def mock_sleep(mocker, freezer):
+    sleep_mock = mocker.patch("time.sleep")
+    sleep_mock.side_effect = lambda seconds: freezer.tick(timedelta(seconds=seconds))
+    yield sleep_mock
+
+
+@pytest.fixture(scope="module")
+def platform_api_url():
+    return "https://platform.unstructuredapp.io"
+
+
+@pytest.fixture(scope="module")
+def serverless_api_url():
+    return "https://api.unstructuredapp.io"
+
+
+@pytest.fixture(scope="module")
+def dummy_partitioned_text():
+    return """[
+  {
+    "type": "NarrativeText",
+    "element_id": "b7dca0363a83468b9e7326c0c1caf93e",
+    "text": "March 17, 2022",
+    "metadata": {
+      "detection_class_prob": 0.35799261927604675,
+      "coordinates": {
+        "points": [
+          [
+            1447.871337890625,
+            301.74810791015625
+          ],
+          [
+            1447.871337890625,
+            326.5603332519531
+          ],
+          [
+            1616.6922607421875,
+            326.5603332519531
+          ],
+          [
+            1616.6922607421875,
+            301.74810791015625
+          ]
+        ],
+        "system": "PixelSpace",
+        "layout_width": 1700,
+        "layout_height": 2200
+      },
+      "last_modified": "2024-02-07T14:23:29",
+      "filetype": "application/pdf",
+      "languages": [
+        "eng"
+      ],
+      "page_number": 1,
+      "file_directory": "data",
+      "filename": "MyDocument.pdf"
+    }
+  }
+]"""
+
+
+@pytest.fixture(scope="module")
+def doc_path() -> Path:
+    samples_path = Path(__file__).resolve().parents[1] / "_sample_docs"
+    assert samples_path.exists()
+    return samples_path

_test_contract/platform_api/test_destinations.py

@@ -8,7 +8,7 @@
 
 
 def test_list_destinations(
-    httpx_mock, client: UnstructuredClient, platform_api_url: str
+    httpx_mock, platform_client: UnstructuredClient, platform_api_url: str
 ):
     url = f"{platform_api_url}/api/v1/destinations/"
 
@@ -34,7 +34,7 @@ def test_list_destinations(
         url=url,
     )
 
-    destinations_response = client.destinations.list_destinations(
+    destinations_response = platform_client.destinations.list_destinations(
         request=operations.ListDestinationsRequest()
     )
     assert destinations_response.status_code == 200
@@ -57,7 +57,7 @@ def test_list_destinations(
 
 
 def test_list_destinations_empty(
-    httpx_mock, client: UnstructuredClient, platform_api_url: str
+    httpx_mock, platform_client: UnstructuredClient, platform_api_url: str
 ):
     url = f"{platform_api_url}/api/v1/destinations/"
 
@@ -68,7 +68,7 @@ def test_list_destinations_empty(
         url=url,
     )
 
-    destinations_response = client.destinations.list_destinations(
+    destinations_response = platform_client.destinations.list_destinations(
         request=operations.ListDestinationsRequest()
     )
     assert destinations_response.status_code == 200
@@ -89,7 +89,7 @@ def test_list_destinations_empty(
 @pytest.mark.httpx_mock(can_send_already_matched_responses=True)  # in case of retries
 def test_list_destinations_5xx_code(
     httpx_mock,
-    client: UnstructuredClient,
+    platform_client: UnstructuredClient,
     platform_api_url: str,
     error_status_code: int,
 ):
@@ -103,7 +103,7 @@ def test_list_destinations_5xx_code(
     )
 
     with pytest.raises(SDKError) as excinfo:
-        client.destinations.list_destinations(
+        platform_client.destinations.list_destinations(
             request=operations.ListDestinationsRequest()
         )
     requests = httpx_mock.get_requests()
@@ -112,7 +112,7 @@ def test_list_destinations_5xx_code(
     assert excinfo.value.status_code == error_status_code
 
 
-def test_get_destination(httpx_mock, client: UnstructuredClient, platform_api_url: str):
+def test_get_destination(httpx_mock, platform_client: UnstructuredClient, platform_api_url: str):
     dest_id = "0c363dec-3c70-45ee-8041-481044a6e1cc"
     url = f"{platform_api_url}/api/v1/destinations/{dest_id}"
 
@@ -136,7 +136,7 @@ def test_get_destination(httpx_mock, client: UnstructuredClient, platform_api_ur
         url=url,
     )
 
-    destination_response = client.destinations.get_destination(
+    destination_response = platform_client.destinations.get_destination(
         request=operations.GetDestinationRequest(destination_id=dest_id)
     )
     assert destination_response.status_code == 200
@@ -158,7 +158,7 @@ def test_get_destination(httpx_mock, client: UnstructuredClient, platform_api_ur
 
 
 def test_get_destination_not_found(
-    httpx_mock, client: UnstructuredClient, platform_api_url: str
+    httpx_mock, platform_client: UnstructuredClient, platform_api_url: str
 ):
     dest_id = "0c363dec-3c70-45ee-8041-481044a6e1cc"
     url = f"{platform_api_url}/api/v1/destinations/{dest_id}"
@@ -171,7 +171,7 @@ def test_get_destination_not_found(
     )
 
     with pytest.raises(SDKError) as excinfo:
-        client.destinations.get_destination(
+        platform_client.destinations.get_destination(
             request=operations.GetDestinationRequest(destination_id=dest_id)
         )
 
@@ -182,7 +182,7 @@ def test_get_destination_not_found(
 
 
 def test_create_destination(
-    httpx_mock, client: UnstructuredClient, platform_api_url: str
+    httpx_mock, platform_client: UnstructuredClient, platform_api_url: str
 ):
     url = f"{platform_api_url}/api/v1/destinations/"
 
@@ -204,7 +204,7 @@ def test_create_destination(
         url=url,
     )
 
-    destination_response = client.destinations.create_destination(
+    destination_response = platform_client.destinations.create_destination(
         request=operations.CreateDestinationRequest(
             create_destination_connector=shared.CreateDestinationConnector(
                 name="test_destination_name",
@@ -236,7 +236,7 @@ def test_create_destination(
 
 
 def test_update_destination(
-    httpx_mock, client: UnstructuredClient, platform_api_url: str
+    httpx_mock, platform_client: UnstructuredClient, platform_api_url: str
 ):
     dest_id = "b25d4161-77a0-4e08-b65e-86f398ce15ad"
     url = f"{platform_api_url}/api/v1/destinations/{dest_id}"
@@ -259,7 +259,7 @@ def test_update_destination(
         url=url,
     )
 
-    destination_update_response = client.destinations.update_destination(
+    destination_update_response = platform_client.destinations.update_destination(
         request=operations.UpdateDestinationRequest(
             destination_id=dest_id,
             update_destination_connector=shared.UpdateDestinationConnector(
@@ -291,7 +291,7 @@ def test_update_destination(
 
 
 def test_delete_destination(
-    httpx_mock, client: UnstructuredClient, platform_api_url: str
+    httpx_mock, platform_client: UnstructuredClient, platform_api_url: str
 ):
     dest_id = "b25d4161-77a0-4e08-b65e-86f398ce15ad"
     url = f"{platform_api_url}/api/v1/destinations/{dest_id}"
@@ -304,7 +304,7 @@ def test_delete_destination(
         url=url,
     )
 
-    response = client.destinations.delete_destination(
+    response = platform_client.destinations.delete_destination(
         request=operations.DeleteDestinationRequest(destination_id=dest_id)
     )
     assert response.status_code == 200