Bugfix: enable to execute draft contracts (#1916)

* Update contrac't Execute use case to require the signed document as well

* Display an input for the user to upload the final signed document before executing it

* Change signed_document to readonly and display link to execute draft contract

* Remove broken import

Author: berinhard

sponsors/admin.py

@@ -536,6 +536,7 @@ def get_readonly_fields(self, request, obj):
             "revision",
             "document",
             "document_docx",
+            "signed_document",
             "get_sponsorship_url",
         ]
 

sponsors/models/contract.py

@@ -193,7 +193,7 @@ def awaiting_signature(self):
     @property
     def next_status(self):
         states_map = {
-            self.DRAFT: [self.AWAITING_SIGNATURE],
+            self.DRAFT: [self.AWAITING_SIGNATURE, self.EXECUTED],
             self.OUTDATED: [],
             self.AWAITING_SIGNATURE: [self.EXECUTED, self.NULLIFIED],
             self.EXECUTED: [],

sponsors/tests/test_models.py

@@ -485,7 +485,7 @@ def test_format_benefits_with_legal_clauses(self):
     def test_control_contract_next_status(self):
         SOW = Contract
         states_map = {
-            SOW.DRAFT: [SOW.AWAITING_SIGNATURE],
+            SOW.DRAFT: [SOW.AWAITING_SIGNATURE, SOW.EXECUTED],
             SOW.OUTDATED: [],
             SOW.AWAITING_SIGNATURE: [SOW.EXECUTED, SOW.NULLIFIED],
             SOW.EXECUTED: [],
@@ -547,7 +547,7 @@ def test_execute_contract(self):
 
     def test_raise_invalid_status_when_trying_to_execute_contract_if_not_awaiting_signature(self):
         contract = baker.make_recipe(
-            "sponsors.tests.empty_contract", status=Contract.DRAFT
+            "sponsors.tests.empty_contract", status=Contract.OUTDATED
         )
 
         with self.assertRaises(InvalidStatusException):

sponsors/tests/test_use_cases.py

@@ -168,12 +168,22 @@ def setUp(self):
         self.notifications = [Mock()]
         self.use_case = use_cases.ExecuteContractUseCase(self.notifications)
         self.user = baker.make(settings.AUTH_USER_MODEL)
-        self.contract = baker.make_recipe("sponsors.tests.empty_contract", status=Contract.AWAITING_SIGNATURE)
+        self.file = SimpleUploadedFile("contract.txt", b"Contract content")
+        self.contract = baker.make_recipe(
+            "sponsors.tests.empty_contract",
+            status=Contract.AWAITING_SIGNATURE,
+        )
+
+    def tearDown(self):
+        self.contract.refresh_from_db()
+        if self.contract.signed_document:
+            self.contract.signed_document.delete()
 
     def test_execute_and_update_database_object(self):
-        self.use_case.execute(self.contract)
+        self.use_case.execute(self.contract, self.file)
         self.contract.refresh_from_db()
         self.assertEqual(self.contract.status, Contract.EXECUTED)
+        self.assertTrue(self.contract.signed_document.url)
 
     def test_build_use_case_with_default_notificationss(self):
         uc = use_cases.ExecuteContractUseCase.build()

sponsors/tests/test_views_admin.py

@@ -1,5 +1,7 @@
 import io
 import json
+
+from django.core.files.uploadedfile import SimpleUploadedFile
 from model_bakery import baker
 from datetime import date, timedelta
 from unittest.mock import patch, PropertyMock, Mock
@@ -569,8 +571,17 @@ def setUp(self):
         )
         self.data = {
             "confirm": "yes",
+            "signed_document": SimpleUploadedFile("contract.txt", b"Contract content"),
         }
 
+    def tearDown(self):
+        try:
+            self.contract.refresh_from_db()
+            if self.contract.signed_document:
+                self.contract.signed_document.delete()
+        except Contract.DoesNotExist:
+            pass
+
     def test_display_confirmation_form_on_get(self):
         response = self.client.get(self.url)
         context = response.context
@@ -591,7 +602,7 @@ def test_execute_sponsorship_on_post(self):
         assertMessage(msg, "Contract was executed!", messages.SUCCESS)
 
     def test_display_error_message_to_user_if_invalid_status(self):
-        self.contract.status = Contract.DRAFT
+        self.contract.status = Contract.OUTDATED
         self.contract.save()
         expected_url = reverse(
             "admin:sponsors_contract_change", args=[self.contract.pk]
@@ -602,10 +613,10 @@ def test_display_error_message_to_user_if_invalid_status(self):
         msg = list(get_messages(response.wsgi_request))[0]
 
         self.assertRedirects(response, expected_url, fetch_redirect_response=True)
-        self.assertEqual(self.contract.status, Contract.DRAFT)
+        self.assertEqual(self.contract.status, Contract.OUTDATED)
         assertMessage(
             msg,
-            "Contract with status Draft can't be executed.",
+            "Contract with status Outdated can't be executed.",
             messages.ERROR,
         )
 
@@ -622,6 +633,15 @@ def test_do_not_execute_contract_if_no_confirmation_in_the_post(self):
         self.contract.refresh_from_db()
         self.assertEqual(self.contract.status, Contract.AWAITING_SIGNATURE)
 
+    def test_display_error_message_to_user_if_no_signed_document(self):
+        self.data.pop("signed_document")
+        response = self.client.post(self.url, data=self.data)
+        context = response.context
+
+        self.assertTemplateUsed(response, "sponsors/admin/execute_contract.html")
+        self.assertEqual(context["contract"], self.contract)
+        self.assertTrue(context["error_msg"])
+
     def test_404_if_contract_does_not_exist(self):
         self.contract.delete()
         response = self.client.get(self.url)

sponsors/use_cases.py

@@ -91,33 +91,28 @@ def execute(self, contract, **kwargs):
         )
 
 
-class ExecuteContractUseCase(BaseUseCaseWithNotifications):
-    notifications = [
-        notifications.ExecutedContractLogger(),
-    ]
-
-    def execute(self, contract, **kwargs):
-        contract.execute()
-        self.notify(
-            request=kwargs.get("request"),
-            contract=contract,
-        )
-
-
 class ExecuteExistingContractUseCase(BaseUseCaseWithNotifications):
     notifications = [
         notifications.ExecutedExistingContractLogger(),
     ]
+    force_execute = True
 
     def execute(self, contract, contract_file, **kwargs):
         contract.signed_document = contract_file
-        contract.execute(force=True)
+        contract.execute(force=self.force_execute)
         self.notify(
             request=kwargs.get("request"),
             contract=contract,
         )
 
 
+class ExecuteContractUseCase(ExecuteExistingContractUseCase):
+    notifications = [
+        notifications.ExecutedContractLogger(),
+    ]
+    force_execute = False
+
+
 class NullifyContractUseCase(BaseUseCaseWithNotifications):
     notifications = [
         notifications.NullifiedContractLogger(),

sponsors/views_admin.py

@@ -179,11 +179,13 @@ def rollback_to_editing_view(ModelAdmin, request, pk):
 def execute_contract_view(ModelAdmin, request, pk):
     contract = get_object_or_404(ModelAdmin.get_queryset(request), pk=pk)
 
-    if request.method.upper() == "POST" and request.POST.get("confirm") == "yes":
+    is_post = request.method.upper() == "POST"
+    signed_document = request.FILES.get("signed_document")
+    if is_post and request.POST.get("confirm") == "yes" and signed_document:
 
         use_case = use_cases.ExecuteContractUseCase.build()
         try:
-            use_case.execute(contract, request=request)
+            use_case.execute(contract, signed_document, request=request)
             ModelAdmin.message_user(
                 request, "Contract was executed!", messages.SUCCESS
             )
@@ -198,7 +200,11 @@ def execute_contract_view(ModelAdmin, request, pk):
         redirect_url = reverse("admin:sponsors_contract_change", args=[contract.pk])
         return redirect(redirect_url)
 
-    context = {"contract": contract}
+    error_msg = ""
+    if is_post and not signed_document:
+        error_msg = "You must submit the signed contract document to execute it."
+
+    context = {"contract": contract, "error_msg": error_msg}
     return render(request, "sponsors/admin/execute_contract.html", context=context)
 
 

templates/sponsors/admin/contract_change_form.html

@@ -14,10 +14,14 @@
     <li>
         <a href="{% url 'admin:sponsors_contract_send' contract.pk %}" style="background: #70bf2b">Send document</a>
     </li>
-    {% elif contract.status == contract.AWAITING_SIGNATURE %}
+    {% endif %}
+
+    {% if contract.EXECUTED in contract.next_status %}
     <li>
         <a href="{% url 'admin:sponsors_contract_execute' contract.pk %}" style="background: #70bf2b">Execute</a>
     </li>
+    {% endif %}
+    {% if contract.NULLIFY in contract.next_status %}
     <li>
         <a href="{% url 'admin:sponsors_contract_nullify' contract.pk %}" style="background: #ba2121" >Nullify</a>
     </li>

templates/sponsors/admin/execute_contract.html

@@ -20,10 +20,22 @@ <h1>Execute Contract</h1>
 
 <div id="content-main">
 <p><b>Important: </b>By executing this contract, the sponsor logo will be placed accordingly to the benefits linked to the sponsorship during the sponsorship period (from {{ contract.sponsorship.start_date|date }} until {{ contract.sponsorship.end_date|date }})</p>
+<p>To finalize and execute this contract, you have to upload the final signed document and update it.</p>
 
-<form action="" method="post">
+<form action="" method="post" enctype="multipart/form-data">
 {% csrf_token %}
 
+{% if error_msg %}
+  <p style="color: red">{{ error_msg }}</p>
+{% endif %}
+
+{% if not contract.signed_document %}
+  <p>
+    <p><b><label for="id_signed_document">Signed Contract</label></b></p>
+    <input type="file" id="id_signed_document" name="signed_document" required>
+  </p>
+{% endif %}
+
 <input name="confirm" value="yes" style="display:none">
 
 <div class="submit-row">