reorganization, cleanup and use settings_test

Author: nora-shap

codecov/settings_test.py

@@ -1,22 +1,12 @@
-from .settings_base import *
+import os
+
+from .settings_dev import *
 
-DEBUG = False
 ALLOWED_HOSTS = ["localhost"]
-WEBHOOK_URL = ""  # NGROK TUNNEL HERE
-STRIPE_API_KEY = ""
 CORS_ALLOWED_ORIGINS = ["http://localhost:9000", "http://localhost"]
-CORS_ALLOW_CREDENTIALS = True
-CODECOV_URL = "localhost"
-CODECOV_API_URL = get_config("setup", "codecov_api_url", default=CODECOV_URL)
-DATABASE_HOST = "postgres"
+SHELTER_PUBSUB_PROJECT_ID = "test-project-id"
+SHELTER_PUBSUB_SYNC_REPO_TOPIC_ID = "test-topic-id"
 
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.postgresql",
-        "NAME": DATABASE_NAME,
-        "USER": DATABASE_USER,
-        "PASSWORD": DATABASE_PASSWORD,
-        "HOST": DATABASE_HOST,
-        "PORT": "5432",
-    }
-}
+# Mock the Pub/Sub host for testing
+# this prevents the pubsub SDK from trying to load credentials
+os.environ["PUBSUB_EMULATOR_HOST"] = "localhost"

codecov_auth/signals.py

@@ -1,15 +1,10 @@
-import json
-import logging
 from typing import Any, Dict, Optional, Type
 
-from django.conf import settings
 from django.db.models.signals import post_save
 from django.dispatch import receiver
-from google.cloud import pubsub_v1
 
 from codecov_auth.models import OrganizationLevelToken, Owner, OwnerProfile
-
-log = logging.getLogger(__name__)
+from utils.shelter import ShelterPubsub
 
 
 @receiver(post_save, sender=Owner)
@@ -20,42 +15,6 @@ def create_owner_profile_when_owner_is_created(
         return OwnerProfile.objects.create(owner_id=instance.ownerid)
 
 
-class ShelterPubsub:
-    pubsub_publisher = None
-    _instance = None
-
-    @classmethod
-    def get_instance(cls) -> "ShelterPubsub":
-        """
-        This class needs the Django settings to be fully loaded before it can be instantiated,
-        therefore use this method to get an instance rather than instantiating directly.
-        """
-        if cls._instance is None:
-            cls._instance = cls()
-        return cls._instance
-
-    def __init__(self) -> None:
-        if not self.pubsub_publisher:
-            self.pubsub_publisher = pubsub_v1.PublisherClient()
-        pubsub_project_id: str = settings.SHELTER_PUBSUB_PROJECT_ID
-
-        # topic_id has REPO in the name but it is used for all types of objects
-        topic_id: str = settings.SHELTER_PUBSUB_SYNC_REPO_TOPIC_ID
-        self.topic_path = self.pubsub_publisher.topic_path(pubsub_project_id, topic_id)
-
-    def publish(self, data: Dict[str, Any]) -> None:
-        try:
-            self.pubsub_publisher.publish(
-                self.topic_path,
-                json.dumps(data).encode("utf-8"),
-            )
-        except Exception as e:
-            log.warning(
-                "Failed to publish a message",
-                extra=dict(data_to_publish=data, error=e),
-            )
-
-
 @receiver(
     post_save, sender=OrganizationLevelToken, dispatch_uid="shelter_sync_org_token"
 )

codecov_auth/tests/test_signals.py

@@ -1,25 +1,17 @@
-import os
 from unittest import mock
 from unittest.mock import call
 
 import pytest
-from django.test import TestCase, override_settings
+from django.test import TestCase
 from shared.django_apps.codecov_auth.models import Service
 from shared.django_apps.codecov_auth.tests.factories import (
     OrganizationLevelTokenFactory,
     OwnerFactory,
 )
 
 
-@override_settings(
-    SHELTER_PUBSUB_PROJECT_ID="test-project-id",
-    SHELTER_PUBSUB_SYNC_REPO_TOPIC_ID="test-topic-id",
-)
 @pytest.mark.django_db
 def test_shelter_org_token_sync(mocker):
-    # this prevents the pubsub SDK from trying to load credentials
-    os.environ["PUBSUB_EMULATOR_HOST"] = "localhost"
-
     publish = mocker.patch("google.cloud.pubsub_v1.PublisherClient.publish")
 
     # this triggers the publish via Django signals
@@ -39,15 +31,8 @@ def test_shelter_org_token_sync(mocker):
     )
 
 
-@override_settings(
-    SHELTER_PUBSUB_PROJECT_ID="test-project-id",
-    SHELTER_PUBSUB_SYNC_REPO_TOPIC_ID="test-topic-id",
-)
 @mock.patch("google.cloud.pubsub_v1.PublisherClient.publish")
 class TestCodecovAuthSignals(TestCase):
-    def setUp(self):
-        os.environ["PUBSUB_EMULATOR_HOST"] = "localhost"
-
     def test_sync_on_create(self, mock_publish):
         OwnerFactory(ownerid=12345)
         mock_publish.assert_called_once_with(

core/signals.py

@@ -5,8 +5,8 @@
 from django.dispatch import receiver
 from shared.django_apps.core.models import Commit
 
-from codecov_auth.signals import ShelterPubsub
 from core.models import Repository
+from utils.shelter import ShelterPubsub
 
 log = logging.getLogger(__name__)
 

core/tests/test_signals.py

@@ -1,21 +1,12 @@
-import os
 from unittest.mock import call
 
 import pytest
-from django.test import override_settings
 from shared.django_apps.codecov_auth.tests.factories import OwnerFactory
 from shared.django_apps.core.tests.factories import CommitFactory, RepositoryFactory
 
 
-@override_settings(
-    SHELTER_PUBSUB_PROJECT_ID="test-project-id",
-    SHELTER_PUBSUB_SYNC_REPO_TOPIC_ID="test-topic-id",
-)
 @pytest.mark.django_db
 def test_shelter_repo_sync(mocker):
-    # this prevents the pubsub SDK from trying to load credentials
-    os.environ["PUBSUB_EMULATOR_HOST"] = "localhost"
-
     publish = mocker.patch("google.cloud.pubsub_v1.PublisherClient.publish")
 
     # this triggers the publish via Django signals
@@ -55,14 +46,8 @@ def test_shelter_repo_sync(mocker):
     assert len(publish_calls) == 3
 
 
-@override_settings(
-    SHELTER_PUBSUB_PROJECT_ID="test-project-id",
-    SHELTER_PUBSUB_SYNC_REPO_TOPIC_ID="test-topic-id",
-)
 @pytest.mark.django_db
 def test_shelter_commit_sync(mocker):
-    # this prevents the pubsub SDK from trying to load credentials
-    os.environ["PUBSUB_EMULATOR_HOST"] = "localhost"
     publish = mocker.patch("google.cloud.pubsub_v1.PublisherClient.publish")
 
     # this triggers the publish via Django signals - has to have this format

pytest.ini

@@ -1,3 +1,3 @@
 [pytest]
-DJANGO_SETTINGS_MODULE = codecov.settings_dev
+DJANGO_SETTINGS_MODULE = codecov.settings_test
 addopts = -p no:warnings --ignore=shared --ignore-glob=**/test_results*

utils/shelter.py

@@ -0,0 +1,44 @@
+import json
+import logging
+from typing import Any, Dict
+
+from django.conf import settings
+from google.cloud import pubsub_v1
+
+log = logging.getLogger(__name__)
+
+
+class ShelterPubsub:
+    pubsub_publisher = None
+    _instance = None
+
+    @classmethod
+    def get_instance(cls) -> "ShelterPubsub":
+        """
+        This class needs the Django settings to be fully loaded before it can be instantiated,
+        therefore use this method to get an instance rather than instantiating directly.
+        """
+        if cls._instance is None:
+            cls._instance = cls()
+        return cls._instance
+
+    def __init__(self) -> None:
+        if not self.pubsub_publisher:
+            self.pubsub_publisher = pubsub_v1.PublisherClient()
+        pubsub_project_id: str = settings.SHELTER_PUBSUB_PROJECT_ID
+
+        # topic_id has REPO in the name but it is used for all types of objects
+        topic_id: str = settings.SHELTER_PUBSUB_SYNC_REPO_TOPIC_ID
+        self.topic_path = self.pubsub_publisher.topic_path(pubsub_project_id, topic_id)
+
+    def publish(self, data: Dict[str, Any]) -> None:
+        try:
+            self.pubsub_publisher.publish(
+                self.topic_path,
+                json.dumps(data).encode("utf-8"),
+            )
+        except Exception as e:
+            log.warning(
+                "Failed to publish a message",
+                extra=dict(data_to_publish=data, error=e),
+            )