add signal for Owner

Author: nora-shap

codecov_auth/signals.py

@@ -1,4 +1,5 @@
 import json
+import logging
 
 from django.conf import settings
 from django.db.models.signals import post_save
@@ -7,6 +8,8 @@
 
 from codecov_auth.models import OrganizationLevelToken, Owner, OwnerProfile
 
+log = logging.getLogger(__name__)
+
 
 @receiver(post_save, sender=Owner)
 def create_owner_profile_when_owner_is_created(
@@ -45,3 +48,38 @@ def update_org_token(sender, instance: OrganizationLevelToken, **kwargs):
                 }
             ).encode("utf-8"),
         )
+
+
+@receiver(post_save, sender=Owner, dispatch_uid="shelter_sync_owner")
+def update_owner(sender, instance: Owner, **kwargs):
+    """
+    Shelter tracks a limited set of Owner fields - only update if those fields have changed.
+    """
+    created = kwargs["created"]
+    tracked_fields = [
+        "upload_token_required_for_public_repos",
+        "username",
+        "service",
+    ]
+    if created or any(instance.tracker.has_changed(field) for field in tracked_fields):
+        pubsub_project_id = settings.SHELTER_PUBSUB_PROJECT_ID
+        topic_id = settings.SHELTER_PUBSUB_SYNC_REPO_TOPIC_ID
+        if pubsub_project_id and topic_id:
+            try:
+                publisher = _get_pubsub_publisher()
+                topic_path = publisher.topic_path(pubsub_project_id, topic_id)
+                publisher.publish(
+                    topic_path,
+                    json.dumps(
+                        {
+                            "type": "owner",
+                            "sync": "one",
+                            "id": instance.ownerid,
+                        }
+                    ).encode("utf-8"),
+                )
+            except Exception as e:
+                log.warning(
+                    "Failed to publish message for owner",
+                    extra=dict(owner_id=instance.pk, error=e),
+                )

codecov_auth/tests/test_signals.py

@@ -1,9 +1,13 @@
 import os
+from unittest import mock
+from unittest.mock import call
 
 import pytest
-from django.test import override_settings
+from django.test import TestCase, override_settings
+from shared.django_apps.codecov_auth.models import Service
 from shared.django_apps.codecov_auth.tests.factories import (
     OrganizationLevelTokenFactory,
+    OwnerFactory,
 )
 
 
@@ -19,9 +23,111 @@ def test_shelter_org_token_sync(mocker):
     publish = mocker.patch("google.cloud.pubsub_v1.PublisherClient.publish")
 
     # this triggers the publish via Django signals
-    OrganizationLevelTokenFactory(id=91728376)
+    OrganizationLevelTokenFactory(id=91728376, owner=OwnerFactory(ownerid=111))
 
-    publish.assert_called_once_with(
-        "projects/test-project-id/topics/test-topic-id",
-        b'{"type": "org_token", "sync": "one", "id": 91728376}',
+    publish.assert_has_calls(
+        [
+            call(
+                "projects/test-project-id/topics/test-topic-id",
+                b'{"type": "owner", "sync": "one", "id": 111}',
+            ),
+            call(
+                "projects/test-project-id/topics/test-topic-id",
+                b'{"type": "org_token", "sync": "one", "id": 91728376}',
+            ),
+        ]
     )
+
+
+@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(
+            "projects/test-project-id/topics/test-topic-id",
+            b'{"type": "owner", "sync": "one", "id": 12345}',
+        )
+
+    def test_sync_on_update_upload_token_required_for_public_repos(self, mock_publish):
+        owner = OwnerFactory(ownerid=12345, upload_token_required_for_public_repos=True)
+        owner.upload_token_required_for_public_repos = False
+        owner.save()
+        mock_publish.assert_has_calls(
+            [
+                call(
+                    "projects/test-project-id/topics/test-topic-id",
+                    b'{"type": "owner", "sync": "one", "id": 12345}',
+                ),
+                call(
+                    "projects/test-project-id/topics/test-topic-id",
+                    b'{"type": "owner", "sync": "one", "id": 12345}',
+                ),
+            ]
+        )
+
+    def test_sync_on_update_username(self, mock_publish):
+        owner = OwnerFactory(ownerid=12345, username="hello")
+        owner.username = "world"
+        owner.save()
+        mock_publish.assert_has_calls(
+            [
+                call(
+                    "projects/test-project-id/topics/test-topic-id",
+                    b'{"type": "owner", "sync": "one", "id": 12345}',
+                ),
+                call(
+                    "projects/test-project-id/topics/test-topic-id",
+                    b'{"type": "owner", "sync": "one", "id": 12345}',
+                ),
+            ]
+        )
+
+    def test_sync_on_update_service(self, mock_publish):
+        owner = OwnerFactory(ownerid=12345, service=Service.GITHUB.value)
+        owner.service = Service.BITBUCKET.value
+        owner.save()
+        mock_publish.assert_has_calls(
+            [
+                call(
+                    "projects/test-project-id/topics/test-topic-id",
+                    b'{"type": "owner", "sync": "one", "id": 12345}',
+                ),
+                call(
+                    "projects/test-project-id/topics/test-topic-id",
+                    b'{"type": "owner", "sync": "one", "id": 12345}',
+                ),
+            ]
+        )
+
+    def test_no_sync_on_update_other_fields(self, mock_publish):
+        owner = OwnerFactory(ownerid=12345, name="hello")
+        owner.name = "world"
+        owner.save()
+        mock_publish.assert_called_once_with(
+            "projects/test-project-id/topics/test-topic-id",
+            b'{"type": "owner", "sync": "one", "id": 12345}',
+        )
+
+    @mock.patch("logging.Logger.warning")
+    def test_sync_error(self, mock_log, mock_publish):
+        mock_publish.side_effect = Exception("publish error")
+
+        OwnerFactory(ownerid=12345)
+
+        # publish is still called, raises an Exception
+        mock_publish.assert_called_once_with(
+            "projects/test-project-id/topics/test-topic-id",
+            b'{"type": "owner", "sync": "one", "id": 12345}',
+        )
+
+        mock_log.assert_called_once_with(
+            "Failed to publish message for owner",
+            extra=dict(owner_id=12345, error=mock_publish.side_effect),
+        )

core/tests/test_signals.py

@@ -3,6 +3,7 @@
 
 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
 
 
@@ -18,22 +19,30 @@ def test_shelter_repo_sync(mocker):
     publish = mocker.patch("google.cloud.pubsub_v1.PublisherClient.publish")
 
     # this triggers the publish via Django signals
-    repo = RepositoryFactory(repoid=91728376)
+    repo = RepositoryFactory(repoid=91728376, author=OwnerFactory(ownerid=555))
 
     # triggers publish on create
-    publish.assert_called_once_with(
-        "projects/test-project-id/topics/test-topic-id",
-        b'{"type": "repo", "sync": "one", "id": 91728376}',
+    publish.assert_has_calls(
+        [
+            call(
+                "projects/test-project-id/topics/test-topic-id",
+                b'{"type": "owner", "sync": "one", "id": 555}',
+            ),
+            call(
+                "projects/test-project-id/topics/test-topic-id",
+                b'{"type": "repo", "sync": "one", "id": 91728376}',
+            ),
+        ]
     )
 
     repo.upload_token = "b69cf44c-89d8-48c2-80c9-5508610d3ced"
     repo.save()
 
     publish_calls = publish.call_args_list
-    assert len(publish_calls) == 2
+    assert len(publish_calls) == 3
 
     # triggers publish on update
-    assert publish_calls[1] == call(
+    assert publish_calls[2] == call(
         "projects/test-project-id/topics/test-topic-id",
         b'{"type": "repo", "sync": "one", "id": 91728376}',
     )
@@ -43,7 +52,7 @@ def test_shelter_repo_sync(mocker):
 
     publish_calls = publish.call_args_list
     # does not trigger another publish
-    assert len(publish_calls) == 2
+    assert len(publish_calls) == 3
 
 
 @override_settings(
@@ -57,15 +66,21 @@ def test_shelter_commit_sync(mocker):
     publish = mocker.patch("google.cloud.pubsub_v1.PublisherClient.publish")
 
     # this triggers the publish via Django signals - has to have this format
-    commit = CommitFactory(id=167829367, branch="random:branch")
+    owner = OwnerFactory(ownerid=555)
+    commit = CommitFactory(
+        id=167829367,
+        branch="random:branch",
+        author=owner,
+        repository=RepositoryFactory(author=owner),
+    )
 
     publish_calls = publish.call_args_list
-    # Twice cause there's a signal triggered when the commit factory creates a Repository
+    # 3x cause there's a signal triggered when the commit factory requires a Repository and Owner
     # which can't be null
-    assert len(publish_calls) == 2
+    assert len(publish_calls) == 3
 
     # triggers publish on update
-    assert publish_calls[1] == call(
+    assert publish_calls[2] == call(
         "projects/test-project-id/topics/test-topic-id",
         b'{"type": "commit", "sync": "one", "id": 167829367}',
     )
@@ -75,4 +90,4 @@ def test_shelter_commit_sync(mocker):
 
     publish_calls = publish.call_args_list
     # does not trigger another publish since unchanged length
-    assert len(publish_calls) == 2
+    assert len(publish_calls) == 3

requirements.in

@@ -20,7 +20,7 @@ factory-boy
 fakeredis
 freezegun
 https://github.com/codecov/opentelem-python/archive/refs/tags/v0.0.4a1.tar.gz#egg=codecovopentelem
-https://github.com/codecov/shared/archive/067b2e4ec72cdf1b3213306ea8aaaccbb374aecc.tar.gz#egg=shared
+https://github.com/codecov/shared/archive/b08713571df87aa2664e1b53857b27bfccff32a7.tar.gz#egg=shared
 google-cloud-pubsub
 gunicorn>=22.0.0
 https://github.com/photocrowd/django-cursor-pagination/archive/f560902696b0c8509e4d95c10ba0d62700181d84.tar.gz

requirements.txt

@@ -419,7 +419,7 @@ sentry-sdk[celery]==2.13.0
     #   shared
 setproctitle==1.1.10
     # via -r requirements.in
-shared @ https://github.com/codecov/shared/archive/067b2e4ec72cdf1b3213306ea8aaaccbb374aecc.tar.gz
+shared @ https://github.com/codecov/shared/archive/b08713571df87aa2664e1b53857b27bfccff32a7.tar.gz
     # via -r requirements.in
 simplejson==3.17.2
     # via -r requirements.in