Added ability to set initial status when creating a project (#4390)

Closes #4388. Adds a new field to the "Create Project" modal that allows
for setting the initial status of the project. The default for this
field can be set with the `PROJECTS_DEFAULT_STATUS` environment setting,
which would also set the initial status when `PROJECTS_AUTO_CREATE` is
enabled. This settings needs to match one of the string literals here:

https://github.com/HyphaApp/hypha/blob/cc174b61b6af7dfd9403cdb2fe3a13a9364e37f7/hypha/apply/projects/models/project.py#L75-L80

In the modal the statuses of `INTERNAL_APPROVAL` and `COMPLETE` were
removed as choices as I didn't see them being useful statuses to be
manually set (internal approval would only be approving the items
created in the `DRAFT` step)

Also updated the activity message to reflect what status the project was
created with

Author: wes-otf

docs/setup/administrators/configuration.md

@@ -157,6 +157,14 @@ Auto create projects for approved applications.
 
 ----
 
+Default status for projects, must be a string literal of "draft" (default), "contracting", "invoicing_and_reporting" or "closing".
+
+Will be used for auto-create or be the default selection in the project creation form.
+    
+    PROJECTS_DEFAULT_STATUS = env.str('PROJECTS_DEFAULT_STATUS', 'draft')
+
+----
+
 Send out e-mail, slack messages etc. from Hypha. Set to true for production.
 
     SEND_MESSAGES = env.bool('SEND_MESSAGES', False)

hypha/apply/activity/adapters/activity_feed.py

@@ -48,7 +48,9 @@ class ActivityAdapter(AdapterBase):
         MESSAGES.DELETE_REVIEW_OPINION: _(
             "deleted the opinion for review: {review_opinion.review}"
         ),
-        MESSAGES.CREATED_PROJECT: _("Created project"),
+        MESSAGES.CREATED_PROJECT: _(
+            'Created project with initial status of "{status}"'
+        ),
         MESSAGES.PROJECT_TRANSITION: "handle_project_transition",
         MESSAGES.UPDATE_PROJECT_TITLE: _(
             "updated the project title from {old_title} to {source.title}"

hypha/apply/activity/tests/test_messaging.py

@@ -223,7 +223,11 @@ def test_activity_created(self):
         submission = ApplicationSubmissionFactory()
 
         self.adapter.send_message(
-            message, user=user, source=submission, sources=[], related=None
+            message,
+            user=user,
+            source=submission,
+            sources=[],
+            related=None,
         )
 
         self.assertEqual(Activity.objects.count(), 1)
@@ -786,6 +790,7 @@ def test_activity_created(self):
             adapter=self.activity(),
             source=project,
             related=project.submission,
+            status="Draft",
         )
         self.assertEqual(Activity.objects.count(), 1)
         activity = Activity.objects.first()

hypha/apply/determinations/tests/test_views.py

@@ -9,6 +9,7 @@
 from hypha.apply.determinations.options import ACCEPTED, NEEDS_MORE_INFO, REJECTED
 from hypha.apply.determinations.views import BatchDeterminationCreateView
 from hypha.apply.funds.tests.factories import ApplicationSubmissionFactory
+from hypha.apply.projects.models.project import CONTRACTING, DRAFT
 from hypha.apply.users.tests.factories import StaffFactory, UserFactory
 from hypha.apply.utils.testing import BaseViewTestCase
 
@@ -337,6 +338,50 @@ def test_single_stage_rejected_determination_does_not_create_project(self):
         self.assertIsNone(submission_next)
         self.assertFalse(hasattr(submission_original, "project"))
 
+    @override_settings(PROJECTS_DEFAULT_STATUS="contracting")
+    def test_auto_creation_uses_status_settings(self):
+        submission = ApplicationSubmissionFactory(
+            status="post_review_discussion",
+            workflow_stages=1,
+            lead=self.user,
+        )
+
+        self.post_page(
+            submission,
+            {
+                "data": "value",
+                "outcome": ACCEPTED,
+                "message": "You are invited to submit a proposal",
+            },
+            "form",
+        )
+
+        submission_original = self.refresh(submission)
+        self.assertTrue(hasattr(submission_original, "project"))
+        self.assertEqual(submission.project.status, CONTRACTING)
+
+    @override_settings(PROJECTS_DEFAULT_STATUS="garbage")
+    def test_auto_creation_uses_draft_when_invalid_status_settings(self):
+        submission = ApplicationSubmissionFactory(
+            status="post_review_discussion",
+            workflow_stages=1,
+            lead=self.user,
+        )
+
+        self.post_page(
+            submission,
+            {
+                "data": "value",
+                "outcome": ACCEPTED,
+                "message": "You are invited to submit a proposal",
+            },
+            "form",
+        )
+
+        submission_original = self.refresh(submission)
+        self.assertTrue(hasattr(submission_original, "project"))
+        self.assertEqual(submission.project.status, DRAFT)
+
     @override_settings(PROJECTS_AUTO_CREATE=False)
     def test_disabling_project_auto_creation_stops_projects_being_created(self):
         submission = ApplicationSubmissionFactory(

hypha/apply/funds/tests/test_views.py

@@ -28,6 +28,7 @@
 from hypha.apply.funds.views.submission_detail import SubmissionDetailView
 from hypha.apply.funds.workflows import INITIAL_STATE
 from hypha.apply.projects.models import Project
+from hypha.apply.projects.models.project import CONTRACTING
 from hypha.apply.projects.tests.factories import ProjectFactory
 from hypha.apply.review.tests.factories import ReviewFactory
 from hypha.apply.users.tests.factories import (
@@ -327,6 +328,7 @@ def test_can_create_project(self):
             {
                 "project_create_form": "",
                 "project_lead": self.user.id,
+                "project_initial_status": CONTRACTING,
                 "submission": self.submission.id,
             },
             view_name="create_project",
@@ -337,6 +339,7 @@ def test_can_create_project(self):
 
         self.assertTrue(hasattr(submission, "project"))
         self.assertEqual(submission.project.id, project.id)
+        self.assertEqual(submission.project.status, CONTRACTING)
 
     def test_can_see_add_determination_primary_action(self):
         def assert_add_determination_displayed(submission, button_text):

hypha/apply/funds/views/submission_edit.py

@@ -37,6 +37,7 @@
     DeterminationCreateOrUpdateView,
 )
 from hypha.apply.projects.forms import ProjectCreateForm
+from hypha.apply.projects.models.project import PROJECT_STATUS_CHOICES
 from hypha.apply.stream_forms.blocks import GroupToggleBlock
 from hypha.apply.todo.options import PROJECT_WAITING_PF, PROJECT_WAITING_SOW
 from hypha.apply.todo.views import add_task_to_user
@@ -434,11 +435,19 @@ def post(self, *args, **kwargs):
         form = ProjectCreateForm(self.request.POST, instance=self.submission)
         if form.is_valid():
             project = form.save()
+
+            readable_project_status = next(
+                status[1]
+                for status in PROJECT_STATUS_CHOICES
+                if status[0] == project.status
+            )
+
             # Record activity
             messenger(
                 MESSAGES.CREATED_PROJECT,
                 request=self.request,
                 user=self.request.user,
+                status=readable_project_status,
                 source=project,
                 related=project.submission,
             )

hypha/apply/projects/forms/project.py

@@ -6,6 +6,10 @@
 from django_file_form.forms import FileFormMixin
 
 from hypha.apply.funds.models import ApplicationSubmission
+from hypha.apply.projects.forms.utils import (
+    get_project_default_status,
+    get_project_status_options,
+)
 from hypha.apply.stream_forms.fields import SingleFileField
 from hypha.apply.stream_forms.forms import StreamBaseForm
 from hypha.apply.users.roles import STAFF_GROUP_NAME
@@ -85,6 +89,13 @@ class ProjectCreateForm(forms.Form):
         label=_("Select Project Lead"), queryset=User.objects.all()
     )
 
+    # Set the initial value to the settings default if valid, otherwise fall back to draft
+    project_initial_status = forms.ChoiceField(
+        label=_("Initial Project Status"),
+        choices=get_project_status_options(),
+        initial=get_project_default_status(),
+    )
+
     def __init__(self, *args, instance=None, **kwargs):
         super().__init__(*args, **kwargs)
 
@@ -107,7 +118,8 @@ def clean_project_lead(self):
     def save(self, *args, **kwargs):
         submission = self.cleaned_data["submission"]
         lead = self.cleaned_data["project_lead"]
-        return Project.create_from_submission(submission, lead=lead)
+        status = self.cleaned_data["project_initial_status"]
+        return Project.create_from_submission(submission, lead=lead, status=status)
 
 
 class MixedMetaClass(type(StreamBaseForm), type(forms.ModelForm)):

hypha/apply/projects/forms/utils.py

@@ -0,0 +1,38 @@
+from typing import List, Tuple
+
+from django.conf import settings
+
+from hypha.apply.projects.models.project import (
+    COMPLETE,
+    INTERNAL_APPROVAL,
+    PROJECT_STATUS_CHOICES,
+)
+
+
+def get_project_status_options() -> List[Tuple[str, str]]:
+    """Gets settable project status options
+
+    Filters out complete & internal approval statuses as there isn't value in
+    being able to set these
+    """
+    return [
+        status
+        for status in PROJECT_STATUS_CHOICES
+        if status[0] not in [COMPLETE, INTERNAL_APPROVAL]
+    ]
+
+
+def get_project_default_status() -> Tuple[str, str]:
+    """Gets the default project status based off the settings
+
+    If the `PROJECTS_DEFAULT_STATUS` setting is invalid, status will fall back
+    to draft
+    """
+    return next(
+        (
+            status
+            for status in PROJECT_STATUS_CHOICES
+            if status[0] == settings.PROJECTS_DEFAULT_STATUS
+        ),
+        PROJECT_STATUS_CHOICES[0],
+    )

hypha/apply/projects/models/project.py

@@ -312,7 +312,7 @@ def get_address_display(self):
         return ""  # todo: need to figure out
 
     @classmethod
-    def create_from_submission(cls, submission, lead=None):
+    def create_from_submission(cls, submission, lead=None, status=None):
         """
         Create a Project from the given submission.
 
@@ -331,10 +331,22 @@ def create_from_submission(cls, submission, lead=None):
         if hasattr(submission, "project"):
             return submission.project
 
+        # If default status is valid and status arg is None, use it otherwise fallback to draft
+        if status is None:
+            status = next(
+                (
+                    x[0]
+                    for x in PROJECT_STATUS_CHOICES
+                    if x[0] == settings.PROJECTS_DEFAULT_STATUS
+                ),
+                DRAFT,
+            )
+
         return Project.objects.create(
             submission=submission,
             user=submission.user,
             title=submission.title,
+            status=status,
             lead=lead if lead else None,
             value=submission.form_data.get("value", 0),
         )

hypha/apply/projects/utils.py

@@ -1,4 +1,3 @@
-from django.conf import settings
 from django.utils.translation import gettext_lazy as _
 from django_file_form.uploaded_file import PlaceholderUploadedFile
 
@@ -60,18 +59,6 @@ def save_project_details(project_id, data):
     project.save()
 
 
-def create_invoice(invoice):
-    """
-    Creates invoice at enabled payment service.
-    """
-    if settings.INTACCT_ENABLED:
-        from hypha.apply.projects.services.sageintacct.utils import (
-            create_intacct_invoice,
-        )
-
-        create_intacct_invoice(invoice)
-
-
 def get_paf_status_display(paf_status):
     return dict(PAF_STATUS_CHOICES)[paf_status]