Add check to detect invalid char in key (incuna#319)

pgcrypto/checks.py

@@ -72,3 +72,22 @@ def _contains_pgp_public_key_field(models):
             if isinstance(field, PGPPublicKeyFieldMixin):
                 return True
     return False
+
+
+@register()
+def check_pgcrypto_key_is_valid(app_configs, **kwargs):
+    """Make sure PGCRYPTO_KEY does not contain not supported chars."""
+    PGCRYPTO_KEY = getattr(settings, "PGCRYPTO_KEY", None)
+    if not PGCRYPTO_KEY:
+        return []
+
+    if "'" in PGCRYPTO_KEY:
+        return [
+            Error(
+                "Invalid char in PGCRYPTO_KEY setting",
+                hint="Remove the ' char from key",
+                id="pgcrypto.E002",
+            ),
+        ]
+
+    return []

tests/test_check.py

@@ -2,11 +2,13 @@
 from django.conf import settings
 from django.test import override_settings, TestCase
 
-from pgcrypto.checks import check_required_settings_exist
+from pgcrypto.checks import (
+    check_pgcrypto_key_is_valid,
+    check_required_settings_exist,
+)
 
 
-class TestChecks(TestCase):
-    # noqa: D103
+class TestChecksRequiredSettings(TestCase):
     def test_pgcrypto_key_exist(self):
         errors = check_required_settings_exist(None)
         self.assertEqual(len(errors), 0)
@@ -70,3 +72,16 @@ def test_missing_private_pgp_key_raises_error(self):
         self.assertEqual(errors[0].id, "pgcrypto.E001")
 
         settings.DATABASES["diff_keys"]["PRIVATE_PGP_KEY"] = key_value
+
+
+class TestInvalidCharInPgcryptoKey(TestCase):
+    @override_settings(PGCRYPTO_KEY="random123")
+    def test_pgcrypto_key_exist(self):
+        errors = check_pgcrypto_key_is_valid(None)
+        self.assertEqual(len(errors), 0)
+
+    @override_settings(PGCRYPTO_KEY="rando'm123")
+    def test_pgcrypto_key_exist(self):
+        errors = check_pgcrypto_key_is_valid(None)
+        self.assertEqual(len(errors), 1)
+        self.assertEqual(errors[0].id, "pgcrypto.E002")