test: use httpretty for retry test

Author: Daniel Bush

.github/workflows/build.yml

@@ -26,7 +26,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pytest coverage codecov
+        pip install pytest coverage codecov httpretty
         pip install .
         type python
         type pip

pytest.ini

@@ -1,13 +1,14 @@
+import json
 import unittest
 import warnings
 from datetime import datetime, timedelta
-from http.client import HTTPMessage
-from unittest.mock import ANY, Mock, call, patch
+from unittest.mock import Mock, patch
 from uuid import UUID, uuid4
 
-from sypht.client import SyphtClient
+import httpretty
+import pytest
 
-from .util.mock_http_server import MockRequestHandler, MockServerSession
+from sypht.client import SyphtClient
 
 
 def validate_uuid4(uuid_string):
@@ -45,11 +46,7 @@ def test_data_extraction_1(self):
             fid = self.sypht_client.upload(f, ["invoices:2"])
             self.assertTrue(validate_uuid4(fid))
 
-        import json
-
-        print("<< fid", fid)
         results = self.sypht_client.fetch_results(fid)
-        print("<< results", json.dumps(results, indent=2))
 
         self.assertTrue(isinstance(results, dict))
         self.assertIn("invoice.dueDate", results)
@@ -105,65 +102,70 @@ class RetryTest(unittest.TestCase):
 
     @patch.object(SyphtClient, "_authenticate_v2", return_value=("access_token", 100))
     @patch.object(SyphtClient, "_authenticate_v1", return_value=("access_token2", 100))
-    def test_it_should_eventually_fail_for_50x(self, auth_v1: Mock, auth_v2: Mock):
+    @httpretty.activate(verbose=True, allow_net_connect=False)
+    def test_it_should_retry_n_times(self, auth_v1: Mock, auth_v2: Mock):
         # arrange
-        requests = []
-
-        def create_request_handler(*args, **kwargs):
-            response_sequences = {
-                "/app/annotations?offset=0&fromDate=2021-01-01&toDate=2021-01-01": [
-                    (502, {}),
-                    # Retries start from here...
-                    # There should be n for where Retry(status=n).
-                    (503, {}),
-                    (504, {}),
-                    (502, {}),
-                ],
-            }
-            return MockRequestHandler(
-                *args, **kwargs, requests=requests, responses=response_sequences
-            )
-
-        with MockServerSession(create_request_handler) as address:
-            sypht_client = SyphtClient(base_endpoint=address)
-
-            # act / assert
-            with self.assertRaisesRegex(Exception, ".") as e:
-                sypht_client.get_annotations(
-                    from_date=datetime(
-                        year=2021, month=1, day=1, hour=0, minute=0, second=0
-                    ).strftime("%Y-%m-%d"),
-                    to_date=datetime(
-                        year=2021, month=1, day=1, hour=0, minute=0, second=0
-                    ).strftime("%Y-%m-%d"),
-                )
+        self.count = 0
+
+        def get_annotations(request, uri, response_headers):
+            self.count += 1
+            # 1 req + 3 retries = 4
+            if self.count == 4:
+                return [200, response_headers, json.dumps({"annotations": []})]
+            return [502, response_headers, json.dumps({})]
+
+        httpretty.register_uri(
+            httpretty.GET,
+            "https://api.sypht.com/app/annotations?offset=0&fromDate=2021-01-01&toDate=2021-01-01",
+            body=get_annotations,
+        )
+
+        sypht_client = SyphtClient(base_endpoint="https://api.sypht.com")
+
+        # act / assert
+        response = sypht_client.get_annotations(
+            from_date=datetime(
+                year=2021, month=1, day=1, hour=0, minute=0, second=0
+            ).strftime("%Y-%m-%d"),
+            to_date=datetime(
+                year=2021, month=1, day=1, hour=0, minute=0, second=0
+            ).strftime("%Y-%m-%d"),
+        )
+
+        assert response == {"annotations": []}
 
-            self.assertEqual(
-                [
-                    (
-                        "GET",
-                        "/app/annotations?offset=0&fromDate=2021-01-01&toDate=2021-01-01",
-                        {},
-                    ),
-                    (
-                        "GET",
-                        "/app/annotations?offset=0&fromDate=2021-01-01&toDate=2021-01-01",
-                        {},
-                    ),
-                    (
-                        "GET",
-                        "/app/annotations?offset=0&fromDate=2021-01-01&toDate=2021-01-01",
-                        {},
-                    ),
-                    (
-                        "GET",
-                        "/app/annotations?offset=0&fromDate=2021-01-01&toDate=2021-01-01",
-                        {},
-                    ),
-                ],
-                requests,
+    @patch.object(SyphtClient, "_authenticate_v2", return_value=("access_token", 100))
+    @patch.object(SyphtClient, "_authenticate_v1", return_value=("access_token2", 100))
+    @httpretty.activate(verbose=True, allow_net_connect=False)
+    def test_retry_should_eventually_fail_for_50x(self, auth_v1: Mock, auth_v2: Mock):
+        # arrange
+        self.count = 0
+
+        def get_annotations(request, uri, response_headers):
+            self.count += 1
+            return [502, response_headers, json.dumps({})]
+
+        httpretty.register_uri(
+            httpretty.GET,
+            "https://api.sypht.com/app/annotations?offset=0&fromDate=2021-01-01&toDate=2021-01-01",
+            body=get_annotations,
+        )
+
+        sypht_client = SyphtClient(base_endpoint="https://api.sypht.com")
+
+        # act / assert
+        with self.assertRaisesRegex(Exception, ".") as e:
+            sypht_client.get_annotations(
+                from_date=datetime(
+                    year=2021, month=1, day=1, hour=0, minute=0, second=0
+                ).strftime("%Y-%m-%d"),
+                to_date=datetime(
+                    year=2021, month=1, day=1, hour=0, minute=0, second=0
+                ).strftime("%Y-%m-%d"),
             )
 
+        assert self.count == 4, "should be 1 req + 3 retries"
+
 
 if __name__ == "__main__":
     unittest.main()