Fix failing tests, due to unset webhook key, correct warning message

Author: paul-oms

anymail/webhooks/mailpace.py

@@ -52,7 +52,7 @@ class MailPaceTrackingWebhookView(MailPaceBaseWebhookView):
 
     def __init__(self, **kwargs):
         try:
-            get_anymail_setting(
+            self.webhook_key = get_anymail_setting(
                 "webhook_key", esp_name=self.esp_name, kwargs=kwargs, allow_bare=True
             )
         except AnymailConfigurationError:
@@ -75,26 +75,30 @@ def __init__(self, **kwargs):
     # MailPace doesn't send a signature for inbound webhooks, yet
     # When/if MailPace does this, move this to the parent class
     def validate_request(self, request):
-        try:
-            signature_base64 = request.headers["X-MailPace-Signature"]
-            signature = base64.b64decode(signature_base64)
-        except (KeyError, binascii.Error):
-            raise AnymailWebhookValidationFailure(
-                "MailPace webhook called with invalid or missing signature"
-            )
-
-        verify_key_base64 = self.webhook_key
-
-        verify_key = VerifyKey(base64.b64decode(verify_key_base64))
-
-        message = request.body
-
-        try:
-            verify_key.verify(message, signature)
-        except (CryptoError, ValueError):
-            raise AnymailWebhookValidationFailure(
-                "MailPace webhook called with incorrect signature"
-            )
+        if self.webhook_key:
+            try:
+                signature_base64 = request.headers["X-MailPace-Signature"]
+                signature = base64.b64decode(signature_base64)
+            except (KeyError, binascii.Error):
+                raise AnymailWebhookValidationFailure(
+                    "MailPace webhook called with invalid or missing signature"
+                )
+
+            verify_key_base64 = self.webhook_key
+
+            verify_key = VerifyKey(base64.b64decode(verify_key_base64))
+
+            message = request.body
+
+            try:
+                verify_key.verify(message, signature)
+            except (CryptoError, ValueError):
+                raise AnymailWebhookValidationFailure(
+                    "MailPace webhook called with incorrect signature"
+                )
+        else:
+            return True
+            # No webhook key set
 
     def esp_to_anymail_event(self, esp_event):
         event_type = self.event_record_types.get(esp_event["event"], EventType.UNKNOWN)

tests/test_mailpace_webhooks.py

@@ -23,13 +23,12 @@
 
 
 @tag("mailpace")
-@unittest.skipUnless(PYNACL_INSTALLED, "pynacl is not installed")
+@unittest.skipUnless(PYNACL_INSTALLED, "Install Pynacl to run MailPace Webhook Tests")
 class MailPaceWebhookSecurityTestCase(WebhookTestCase):
     client_class = ClientWithMailPaceSignature
 
     def setUp(self):
         super().setUp()
-        self.clear_basic_auth()
         self.client.set_private_key(make_key())
 
     def test_failed_signature_check(self):
@@ -59,13 +58,12 @@ def test_failed_signature_check(self):
 
 
 @tag("mailpace")
-@unittest.skipUnless(PYNACL_INSTALLED, "pynacl is not installed")
+@unittest.skipUnless(PYNACL_INSTALLED, "Install Pynacl to run MailPace Webhook Tests")
 class MailPaceDeliveryTestCase(WebhookTestCase):
     client_class = ClientWithMailPaceSignature
 
     def setUp(self):
         super().setUp()
-        self.clear_basic_auth()
         self.client.set_private_key(make_key())
 
     def test_queued_event(self):

tests/utils_mailpace.py

@@ -49,7 +49,12 @@ def post(self, *args, **kwargs):
             headers["X-MailPace-Signature"] = signature
 
         webhook_key = derive_public_webhook_key(self.private_key)
-        with override_settings(ANYMAIL={"MAILPACE_WEBHOOK_KEY": webhook_key}):
+        with override_settings(
+            ANYMAIL={
+                "MAILPACE_WEBHOOK_KEY": webhook_key,
+                "WEBHOOK_SECRET": "username:password",
+            }
+        ):
             # Django 4.2+ test Client allows headers=headers;
             # before that, must convert to HTTP_ args:
             return super().post(