Finalize sponsorships with existing contracts (#1845)

* Sponsorship approval should also log contract creation

* Fix test names to be more accurate

* Create use case to approve contract using existing file

* Sponsorship approval form must require all data

* Create new view to approve a sponsorship within a signed contract

* Add links to generate new contract or upload existing one when approving sponsorship

* Add links to easily navigate between sponsorships and contracts within admin

* Update Contract model to always use random names to signed documents

Author: berinhard

sponsors/admin.py

@@ -4,7 +4,7 @@
 from django.template import Context, Template
 from django.contrib import admin
 from django.contrib.humanize.templatetags.humanize import intcomma
-from django.urls import path
+from django.urls import path, reverse
 from django.utils.html import mark_safe
 
 from .models import (
@@ -217,6 +217,7 @@ class SponsorshipAdmin(admin.ModelAdmin):
                     "get_estimated_cost",
                     "start_date",
                     "end_date",
+                    "get_contract"
                 ),
             },
         ),
@@ -267,6 +268,7 @@ def get_readonly_fields(self, request, obj):
             "get_sponsor_primary_phone",
             "get_sponsor_mailing_address",
             "get_sponsor_contacts",
+            "get_contract",
         ]
 
         if obj and obj.status != Sponsorship.APPLIED:
@@ -287,9 +289,16 @@ def get_estimated_cost(self, obj):
             cost = intcomma(obj.estimated_cost)
             html = f"{cost} USD <br/><b>Important: </b> {msg}"
         return mark_safe(html)
-
     get_estimated_cost.short_description = "Estimated cost"
 
+    def get_contract(self, obj):
+        if not obj.contract:
+            return "---"
+        url = reverse("admin:sponsors_contract_change", args=[obj.contract.pk])
+        html = f"<a href='{url}' target='_blank'>{obj.contract}</a>"
+        return mark_safe(html)
+    get_contract.short_description = "Contract"
+
     def get_urls(self):
         urls = super().get_urls()
         my_urls = [
@@ -300,6 +309,11 @@ def get_urls(self):
                 self.admin_site.admin_view(self.reject_sponsorship_view),
                 name="sponsors_sponsorship_reject",
             ),
+            path(
+                "<int:pk>/approve-existing",
+                self.admin_site.admin_view(self.approve_signed_sponsorship_view),
+                name="sponsors_sponsorship_approve_existing_contract",
+            ),
             path(
                 "<int:pk>/approve",
                 self.admin_site.admin_view(self.approve_sponsorship_view),
@@ -403,6 +417,9 @@ def reject_sponsorship_view(self, request, pk):
     def approve_sponsorship_view(self, request, pk):
         return views_admin.approve_sponsorship_view(self, request, pk)
 
+    def approve_signed_sponsorship_view(self, request, pk):
+        return views_admin.approve_signed_sponsorship_view(self, request, pk)
+
 
 @admin.register(LegalClause)
 class LegalClauseModelAdmin(OrderedModelAdmin):
@@ -435,7 +452,7 @@ def get_revision(self, obj):
         (
             "Info",
             {
-                "fields": ("sponsorship", "status", "revision"),
+                "fields": ("get_sponsorship_url", "status", "revision"),
             },
         ),
         (
@@ -480,6 +497,7 @@ def get_readonly_fields(self, request, obj):
             "sponsorship",
             "revision",
             "document",
+            "get_sponsorship_url",
         ]
 
         if obj and not obj.is_draft:
@@ -509,9 +527,17 @@ def document_link(self, obj):
         if url and msg:
             html = f'<a href="{url}" target="_blank">{msg}</a>'
         return mark_safe(html)
-
     document_link.short_description = "Contract document"
 
+
+    def get_sponsorship_url(self, obj):
+        if not obj.sponsorship:
+            return "---"
+        url = reverse("admin:sponsors_sponsorship_change", args=[obj.sponsorship.pk])
+        html = f"<a href='{url}' target='_blank'>{obj.sponsorship}</a>"
+        return mark_safe(html)
+    get_sponsorship_url.short_description = "Sponsorship"
+
     def get_urls(self):
         urls = super().get_urls()
         my_urls = [

sponsors/forms.py

@@ -361,6 +361,13 @@ def clean(self):
         return cleaned_data
 
 
+class SignedSponsorshipReviewAdminForm(SponsorshipReviewAdminForm):
+    """
+    Form to approve sponsorships that already have a signed contract
+    """
+    signed_contract = forms.FileField(help_text="Please upload the final version of the signed contract.")
+
+
 class SponsorBenefitAdminInlineForm(forms.ModelForm):
     sponsorship_benefit = forms.ModelChoiceField(
         queryset=SponsorshipBenefit.objects.order_by('program', 'order').select_related("program"),

sponsors/models.py

@@ -1,3 +1,4 @@
+import uuid
 from abc import ABC
 from pathlib import Path
 from itertools import chain
@@ -697,6 +698,16 @@ class Meta(OrderedModel.Meta):
         pass
 
 
+def signed_contract_random_path(instance, filename):
+    """
+    Use random UUID to name signed contracts
+    """
+    dir = instance.SIGNED_PDF_DIR
+    ext = "".join(Path(filename).suffixes)
+    name = uuid.uuid4()
+    return f"{dir}{name}{ext}"
+
+
 class Contract(models.Model):
     """
     Contract model to oficialize a Sponsorship
@@ -729,7 +740,7 @@ class Contract(models.Model):
         verbose_name="Unsigned PDF",
     )
     signed_document = models.FileField(
-        upload_to=SIGNED_PDF_DIR,
+        upload_to=signed_contract_random_path,
         blank=True,
         verbose_name="Signed PDF",
     )
@@ -872,8 +883,8 @@ def set_final_version(self, pdf_file):
         self.status = self.AWAITING_SIGNATURE
         self.save()
 
-    def execute(self, commit=True):
-        if self.EXECUTED not in self.next_status:
+    def execute(self, commit=True, force=False):
+        if not force and self.EXECUTED not in self.next_status:
             msg = f"Can't execute a {self.get_status_display()} contract."
             raise InvalidStatusException(msg)
 

sponsors/notifications.py

@@ -1,7 +1,7 @@
 from django.core.mail import EmailMessage
 from django.template.loader import render_to_string
 from django.conf import settings
-from django.contrib.admin.models import LogEntry, CHANGE
+from django.contrib.admin.models import LogEntry, CHANGE, ADDITION
 from django.contrib.contenttypes.models import ContentType
 
 from sponsors.models import Sponsorship, Contract
@@ -110,7 +110,7 @@ def get_attachments(self, context):
 
 class SponsorshipApprovalLogger():
 
-    def notify(self, request, sponsorship, **kwargs):
+    def notify(self, request, sponsorship, contract, **kwargs):
         LogEntry.objects.log_action(
             user_id=request.user.id,
             content_type_id=ContentType.objects.get_for_model(Sponsorship).pk,
@@ -119,6 +119,14 @@ def notify(self, request, sponsorship, **kwargs):
             action_flag=CHANGE,
             change_message="Sponsorship Approval"
         )
+        LogEntry.objects.log_action(
+            user_id=request.user.id,
+            content_type_id=ContentType.objects.get_for_model(Contract).pk,
+            object_id=contract.pk,
+            object_repr=str(contract),
+            action_flag=ADDITION,
+            change_message="Created After Sponsorship Approval"
+        )
 
 
 class SentContractLogger():
@@ -147,6 +155,19 @@ def notify(self, request, contract, **kwargs):
         )
 
 
+class ExecutedExistingContractLogger():
+
+    def notify(self, request, contract, **kwargs):
+        LogEntry.objects.log_action(
+            user_id=request.user.id,
+            content_type_id=ContentType.objects.get_for_model(Contract).pk,
+            object_id=contract.pk,
+            object_repr=str(contract),
+            action_flag=CHANGE,
+            change_message="Existing Contract Uploaded and Executed"
+        )
+
+
 class NullifiedContractLogger():
 
     def notify(self, request, contract, **kwargs):

sponsors/tests/test_notifications.py

@@ -5,7 +5,8 @@
 from django.core import mail
 from django.template.loader import render_to_string
 from django.test import TestCase, RequestFactory
-from django.contrib.admin.models import LogEntry, CHANGE
+from django.contrib.admin.models import LogEntry, CHANGE, ADDITION
+from django.contrib.contenttypes.models import ContentType
 
 from sponsors import notifications
 from sponsors.models import Sponsorship, Contract
@@ -233,24 +234,34 @@ def setUp(self):
         self.request = RequestFactory().get('/')
         self.request.user = baker.make(settings.AUTH_USER_MODEL)
         self.sponsorship = baker.make(Sponsorship, status=Sponsorship.APPROVED, sponsor__name='foo', _fill_optional=True)
+        self.contract = baker.make_recipe("sponsors.tests.empty_contract", sponsorship=self.sponsorship)
         self.kwargs = {
             "request": self.request,
             "sponsorship": self.sponsorship,
+            "contract": self.contract
         }
         self.logger = notifications.SponsorshipApprovalLogger()
 
     def test_create_log_entry_for_change_operation_with_approval_message(self):
         self.assertEqual(LogEntry.objects.count(), 0)
+        sponsorship_content_id = ContentType.objects.get_for_model(Sponsorship).pk
+        contract_id = ContentType.objects.get_for_model(Contract).pk
 
         self.logger.notify(**self.kwargs)
 
-        self.assertEqual(LogEntry.objects.count(), 1)
-        log_entry = LogEntry.objects.get()
+        self.assertEqual(LogEntry.objects.count(), 2)
+        log_entry = LogEntry.objects.get(content_type_id=sponsorship_content_id)
         self.assertEqual(log_entry.user, self.request.user)
         self.assertEqual(log_entry.object_id, str(self.sponsorship.pk))
         self.assertEqual(str(self.sponsorship), log_entry.object_repr)
         self.assertEqual(log_entry.action_flag, CHANGE)
         self.assertEqual(log_entry.change_message, "Sponsorship Approval")
+        log_entry = LogEntry.objects.get(content_type_id=contract_id)
+        self.assertEqual(log_entry.user, self.request.user)
+        self.assertEqual(log_entry.object_id, str(self.contract.pk))
+        self.assertEqual(str(self.contract), log_entry.object_repr)
+        self.assertEqual(log_entry.action_flag, ADDITION)
+        self.assertEqual(log_entry.change_message, "Created After Sponsorship Approval")
 
 
 class SentContractLoggerTests(TestCase):
@@ -305,6 +316,32 @@ def test_create_log_entry_for_change_operation_with_approval_message(self):
         self.assertEqual(log_entry.change_message, "Contract Executed")
 
 
+class ExecutedExistingContractLoggerTests(TestCase):
+
+    def setUp(self):
+        self.request = RequestFactory().get('/')
+        self.request.user = baker.make(settings.AUTH_USER_MODEL)
+        self.contract = baker.make_recipe('sponsors.tests.empty_contract')
+        self.kwargs = {
+            "request": self.request,
+            "contract": self.contract,
+        }
+        self.logger = notifications.ExecutedExistingContractLogger()
+
+    def test_create_log_entry_for_change_operation_with_approval_message(self):
+        self.assertEqual(LogEntry.objects.count(), 0)
+
+        self.logger.notify(**self.kwargs)
+
+        self.assertEqual(LogEntry.objects.count(), 1)
+        log_entry = LogEntry.objects.get()
+        self.assertEqual(log_entry.user, self.request.user)
+        self.assertEqual(log_entry.object_id, str(self.contract.pk))
+        self.assertEqual(str(self.contract), log_entry.object_repr)
+        self.assertEqual(log_entry.action_flag, CHANGE)
+        self.assertEqual(log_entry.change_message, "Existing Contract Uploaded and Executed")
+
+
 class NullifiedContractLoggerTests(TestCase):
 
     def setUp(self):

sponsors/tests/test_use_cases.py

@@ -1,10 +1,11 @@
-from unittest.mock import Mock
+from unittest.mock import Mock, patch
 from model_bakery import baker
 from datetime import timedelta, date
 
 from django.conf import settings
 from django.test import TestCase
 from django.utils import timezone
+from django.core.files.uploadedfile import SimpleUploadedFile
 
 from sponsors import use_cases
 from sponsors.notifications import *
@@ -122,7 +123,7 @@ def test_send_notifications_using_sponsorship(self):
                 contract=self.sponsorship.contract,
             )
 
-    def test_build_use_case_without_notificationss(self):
+    def test_build_use_case_with_default_notificationss(self):
         uc = use_cases.ApproveSponsorshipApplicationUseCase.build()
         self.assertEqual(len(uc.notifications), 1)
         self.assertIsInstance(uc.notifications[0], SponsorshipApprovalLogger)
@@ -147,7 +148,7 @@ def test_send_and_update_contract_with_document(self):
                 contract=self.contract,
             )
 
-    def test_build_use_case_without_notificationss(self):
+    def test_build_use_case_with_default_notificationss(self):
         uc = use_cases.SendContractUseCase.build()
         self.assertEqual(len(uc.notifications), 2)
         self.assertIsInstance(uc.notifications[0], ContractNotificationToPSF)
@@ -168,14 +169,38 @@ def test_execute_and_update_database_object(self):
         self.contract.refresh_from_db()
         self.assertEqual(self.contract.status, Contract.EXECUTED)
 
-    def test_build_use_case_without_notificationss(self):
+    def test_build_use_case_with_default_notificationss(self):
         uc = use_cases.ExecuteContractUseCase.build()
         self.assertEqual(len(uc.notifications), 1)
         self.assertIsInstance(
             uc.notifications[0], ExecutedContractLogger
         )
 
 
+class ExecuteExistingContractUseCaseTests(TestCase):
+    def setUp(self):
+        self.notifications = [Mock()]
+        self.use_case = use_cases.ExecuteExistingContractUseCase(self.notifications)
+        self.user = baker.make(settings.AUTH_USER_MODEL)
+        self.file = SimpleUploadedFile("contract.txt", b"Contract content")
+        self.contract = baker.make_recipe("sponsors.tests.empty_contract", status=Contract.DRAFT)
+
+    @patch("sponsors.models.uuid.uuid4", Mock(return_value="1234"))
+    def test_execute_and_update_database_object(self):
+        self.use_case.execute(self.contract, self.file)
+        self.contract.refresh_from_db()
+        self.assertEqual(self.contract.status, Contract.EXECUTED)
+        self.assertEqual(b"Contract content", self.contract.signed_document.read())
+        self.assertEqual(f"{Contract.SIGNED_PDF_DIR}1234.txt", self.contract.signed_document.name)
+
+    def test_build_use_case_with_default_notificationss(self):
+        uc = use_cases.ExecuteExistingContractUseCase.build()
+        self.assertEqual(len(uc.notifications), 1)
+        self.assertIsInstance(
+            uc.notifications[0], ExecutedExistingContractLogger
+        )
+
+
 class NullifyContractUseCaseTests(TestCase):
     def setUp(self):
         self.notifications = [Mock()]
@@ -188,7 +213,7 @@ def test_nullify_and_update_database_object(self):
         self.contract.refresh_from_db()
         self.assertEqual(self.contract.status, Contract.NULLIFIED)
 
-    def test_build_use_case_without_notificationss(self):
+    def test_build_use_case_with_default_notificationss(self):
         uc = use_cases.NullifyContractUseCase.build()
         self.assertEqual(len(uc.notifications), 1)
         self.assertIsInstance(