Refactor tests and add two using our mocked logger

apps/greencheck/tests/test_api_logger.py

@@ -1,32 +1,32 @@
+import time
+
 import pytest
 import requests
-import time
 from django.urls import reverse
-
 from drf_api_logger.models import APILogsModel
 
 
 @pytest.mark.django_db
 @pytest.mark.uses_separate_logging_thread
-def test_api_requests_are_logged(live_server, transactional_db):
+def test_api_requests_are_logged(live_server):
     """
-    Check that API requests are logged. We need a live server, because the 
-    api request logger runs in a separate thread that is spun up only when 
+    Check that API requests are logged. We need a live server, because the
+    api request logger runs in a separate thread that is spun up only when
     the live server itself is running.
     """
 
-    # when: a request has been made to our high traffic endpoint used for most greenchecks
-    res = requests.get(f"{live_server.url}{reverse('asn-list')}")
-    
-    # Note: django api request logger works by logging API requests outside the normal 
-    # request lifecycle. By default, it writes to the db every 10 seconds, but the 
+    # when: a request is made to our high traffic endpoint used for most greenchecks
+    requests.get(f"{live_server.url}{reverse('asn-list')}")
+
+    # Note: django api request logger works by logging API requests outside the normal
+    # request lifecycle. By default, it writes to the db every 10 seconds, but the
     # minimum we can set this to is 1 seconds in testing.DRF_LOGGER_INTERVAL
 
-    # and: our api request logging interval has elapsed
+    # and: our after api request logging interval has elapsed
     time.sleep(1)
 
-    # then we should see one request logged
-    assert APILogsModel.objects.count() is 1
+    # then: we should see one request logged
+    assert APILogsModel.objects.count() == 1
 
 
 @pytest.mark.django_db
@@ -38,14 +38,57 @@ def test_high_traffic_api_requests_are_not_logged(live_server):
     """
 
     # given: a request has been made to the high traffic endpoint use for most greenchecks
-    requests.get(f"{live_server.url}{reverse('green-domain-detail', args=['example.com'])}")
+    requests.get(
+        f"{live_server.url}{reverse('green-domain-detail', args=['example.com'])}"
+    )
+
+    # and: a request has been made to our endpoint for generating images -
+    # which also sees a lot of use
+    requests.get(
+        f"{live_server.url}{reverse('legacy-greencheck-image', args=['example.com'])}"
+    )
 
-    # and: a request has been made to our endpoint for generating images - which also sees a lot of use
-    requests.get(f"{live_server.url}{reverse('legacy-greencheck-image', args=['example.com'])}")
-
     # and: our API request logger's logging interval has had time to log the requests
     time.sleep(1)
-    
+
     # then: we should see no logged requests
-    assert APILogsModel.objects.count() is 0
+    assert APILogsModel.objects.count == 0
+
+
+@pytest.mark.django_db
+def test_request_for_valid_endpoint_is_logged(client, mocker):
+    """
+    Check that API requests we want to monitor are logged. We mock the logger that
+    DRF API middleware calls `put_log_data` on, and check that the method is called.
+    """
+
+    mocked_api_logger = mocker.patch(
+        "drf_api_logger.start_logger_when_server_starts.LOGGER_THREAD.put_log_data"
+    )
+
+    # given: a request has been made to an endpoint we want to log
+    client.get(reverse("asn-list"))
+
+    # then: we should see one attempt to log the request
+    assert mocked_api_logger.call_count == 1
+
+
+@pytest.mark.django_db
+def test_api_request_for_invalid_endpoint_not_logged(client, mocker):
+    """
+    Check that the for endpoints we do not want to log, no calls to
+    `put_log_data` are made to the logger thread
+    """
+
+    mocked_api_logger = mocker.patch(
+        "drf_api_logger.start_logger_when_server_starts.LOGGER_THREAD.put_log_data"
+    )
+
+    # when: a request is made to one high traffic endpoint use
+    client.get(reverse("green-domain-detail", args=["example.com"]))
+
+    # and: a request is made to second high traffic endpoint for generating images
+    client.get(reverse("legacy-greencheck-image", args=["example.com"]))
 
+    # then: we should see no attemps to log requests
+    assert mocked_api_logger.call_count == 0