Update github actions workflow and tests (#36)

Author: Yuyuutsu

.github/workflows/pull_request.yaml

@@ -8,6 +8,8 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    env:
+      NOTIFY_API_KEY: ${{ secrets.DEV_NOTIFY_API_KEY }}
     steps:
       - uses: actions/checkout@v4
       - run: |
@@ -27,3 +29,5 @@ jobs:
         run: make install-dev
       - name: Running lint tests
         run: make lint
+      - name: Running unit tests
+        run: make test

Makefile

@@ -33,5 +33,6 @@ lint:
 test:
 	poetry run ./scripts/run_tests.sh
 
+
 run-debug:
 	poetry run functions-framework --target=send_email --debug

main.py

@@ -179,9 +179,11 @@ def send_email(request: Request) -> Union[Tuple[str, int], Tuple[str, None]]:
         )
         return message, status_code
     except RequestException as error:
-        # Type ignore: To be fixed, error may not have a response
-        notify_error = error.response.json()["errors"][0]  # type: ignore
-        status_code = error.response.status_code  # type: ignore
+        notify_error = "Unknown Error"
+        status_code = 500
+        if error.response is not None:
+            notify_error = error.response.json().get("errors", [{}])[0]
+            status_code = error.response.status_code
         message = "notify request failed"
         log_error(
             message,
@@ -190,7 +192,6 @@ def send_email(request: Request) -> Union[Tuple[str, int], Tuple[str, None]]:
             status_code=status_code,
         )
         return message, status_code
-
     if response.status_code == 204:
         return "no content", 204
 

scripts/run_tests.sh

@@ -22,5 +22,5 @@ function display_result {
 
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
-pytest --cov=main --cov-report html --cov-fail-under=100 "$@"
+pytest --cov=main --cov-report html --cov-fail-under=100 "$@" --ignore=tests/test_integration.py
 display_result $? 3 "Unit tests"

tests/test_integration.py

@@ -15,6 +15,8 @@ class TestNotify:
         }
     }
 
+    # The following tests will not work as the Notify API key has been removed until a mock service can be introduced
+    # (see https://github.com/ONSdigital/eq-submission-confirmation-consumer/pull/12)
     def test_successful(self, base_url, requests_session):
         res = requests_session.post(base_url, json=self.payload)
         assert res.status_code == 201

tests/test_main.py

@@ -64,7 +64,7 @@ def test_notify_response_connection_error(mock_request):
 
 @responses.activate
 def test_notify_response_no_content_204(mock_request):
-    responses.add(responses.POST, url, json={}, status=204)
+    responses.add(responses.POST, url, status=204)
     response = send_email(mock_request)
     assert response == ("no content", 204)