Keep track of current sponsorship year (python#2087)

* Add missing migration to the existing models (managers and meta info)

* New model to keep track of current sponsorship year

* Make sure the singleton object is populated by default via data migration

* Make sure the singleton logic is implemented at DB-level

* Make sure singleton object cannot be deleted

* Add singleton to admin with disabled permissions for adding or deleting

* Add django-extensions as a requirement to be able to use shell_plus

* Add application year field to sponsorship model

* Display new field and enable filter on sponsorship admin

* Populate application year when creating it

* Rename field to be just "year"

* Enable to filter contract by sponsorship year

* Refactoring to centralize year validators

* Add year field to configure sponsorship benefits and packages

* Initialize values for existing sponsorship benefits and packages with current year

* Year field should be required when creating/editing configured benefits

* Add filter by year to configured benefits and packages

* Refactor configured benefits and packages to build custom manager from queryset

* New manager methods to filter configured packages and benefits from current year

* Sponsorship application form now only lists pkg, benefits, add-ons and a la carte benefits from the current year

* Fix requirements organization

* Improve form unit tests to make sure we're filtering packages and benefits by the current year

* Refactor to encapsulate logic to get the current year within a class method

* Add cache to avoid querying the DB every time the system needs the current year

* Add db index to year fields so querying by them gets faster

* Add migration command to CI to check if it's running them

* Move fields definition to init so query for current year happens as execution time instead of interpretation's one

* Revert "Add migration command to CI to check if it's running them"

This reverts commit 17f7bed.

* add necessary fixtures

* Introduce clone method to benefit and related objects

* Add clone method to be able to copy a benefit configuration to a new benefit

* Make sure Tiered Quantity config can be copy using the same year's package

* Make sure required assets configurations can be cloned without violating db constraints and with valid due dates

* Add unit test to make sure the remaining configuration can be cloned

* Make sure benefit features configurations get cloned as well

* Upgrade model-bakery version to the most up to date with Django 2.2 support

* Implement use case to generate clone an sponsorship year configuration to a

* Introduce helper function to build admin base url name

* Create admin view to clone sponsorship configuration from one year to another

* Add form validation to enforce relations between from and target years

* Add workflow to django admin to enable staff users to clone configurations by year

* Reverse order so most recent years appear first

* Refactoring to introduce more generic function to create django log entries

* Update use case to add django admin log entries for new cloned packages and benefits

* Add parameter to be able to display form for a specific year

* Enable staff user to preview how the application form from a specific year will look like

* Display link to preview non active years sponsorship form in admin

* Only display links to already configured years if they exist

* Also display links to list configured year's packages and benefits from active year list

* Add column with links for the active year

* Disable submit button if preview for custom year

* update style for admin warning on application preview to be extra scary

Co-authored-by: Ee Durbin <[email protected]>

Author: berinhard

base-requirements.txt

@@ -48,3 +48,4 @@ django-polymorphic==3.0.0
 sorl-thumbnail==12.7.0
 docxtpl==0.12.0
 reportlab==3.6.6
+django-extensions==3.1.4

dev-requirements.txt

@@ -12,4 +12,4 @@ responses==0.13.3
 django-debug-toolbar==3.2.1
 coverage
 ddt
-model-bakery==1.3.2
+model-bakery==1.4.0

fixtures/boxes.json

@@ -0,0 +1,42 @@
+[
+{
+  "model": "waffle.flag",
+  "pk": 1,
+  "fields": {
+    "name": "psf_membership",
+    "everyone": null,
+    "percent": null,
+    "testing": true,
+    "superusers": true,
+    "staff": false,
+    "authenticated": false,
+    "languages": "",
+    "rollout": false,
+    "note": "This flag is used to show the PSF Basic and Advanced member registration process.",
+    "created": "2015-06-05T09:47:03Z",
+    "modified": "2017-03-22T01:45:42.077Z",
+    "groups": [],
+    "users": []
+  }
+},
+{
+  "model": "waffle.flag",
+  "pk": 2,
+  "fields": {
+    "name": "sponsorship-applications-open",
+    "everyone": true,
+    "percent": null,
+    "testing": false,
+    "superusers": false,
+    "staff": false,
+    "authenticated": false,
+    "languages": "",
+    "rollout": false,
+    "note": "Controls if the application form and benefits \"menu\" is visible at https://www.python.org/sponsors/application/\r\n\r\nThe contents of the page when applications are closed is modifiable at https://www.python.org/admin/boxes/box/106/change/",
+    "created": "2022-07-21T17:16:05Z",
+    "modified": "2022-07-21T17:24:06.747Z",
+    "groups": [],
+    "users": []
+  }
+}
+]

fixtures/flags.json

@@ -0,0 +1,74 @@
+[
+{
+  "model": "users.user",
+  "pk": 1,
+  "fields": {
+    "password": "pbkdf2_sha256$150000$TAqxQ4O0uzV2$3lgFMdRiaBnaUfXtjSRlA/9HzMwYa2ThD38AmTzGYEs=",
+    "last_login": "2022-08-01T18:52:54.206Z",
+    "is_superuser": true,
+    "username": "admin",
+    "first_name": "",
+    "last_name": "",
+    "email": "[email protected]",
+    "is_staff": true,
+    "is_active": true,
+    "date_joined": "2022-08-01T18:52:39.307Z",
+    "bio": "",
+    "bio_markup_type": "markdown",
+    "search_visibility": 1,
+    "_bio_rendered": "",
+    "email_privacy": 2,
+    "public_profile": true,
+    "groups": [],
+    "user_permissions": []
+  }
+},
+{
+  "model": "users.user",
+  "pk": 2,
+  "fields": {
+    "password": "pbkdf2_sha256$150000$TAqxQ4O0uzV2$3lgFMdRiaBnaUfXtjSRlA/9HzMwYa2ThD38AmTzGYEs=",
+    "last_login": "2022-08-01T18:54:51.727Z",
+    "is_superuser": false,
+    "username": "user",
+    "first_name": "",
+    "last_name": "",
+    "email": "[email protected]",
+    "is_staff": false,
+    "is_active": true,
+    "date_joined": "2022-08-01T18:54:10.023Z",
+    "bio": "",
+    "bio_markup_type": "markdown",
+    "search_visibility": 1,
+    "_bio_rendered": "",
+    "email_privacy": 2,
+    "public_profile": true,
+    "groups": [],
+    "user_permissions": []
+  }
+},
+{
+  "model": "account.emailaddress",
+  "pk": 1,
+  "fields": {
+    "user": [
+      "admin"
+    ],
+    "email": "[email protected]",
+    "verified": true,
+    "primary": true
+  }
+},
+{
+  "model": "account.emailaddress",
+  "pk": 2,
+  "fields": {
+    "user": [
+      "user"
+    ],
+    "email": "[email protected]",
+    "verified": true,
+    "primary": true
+  }
+}
+]

fixtures/sponsors.json

@@ -202,6 +202,7 @@
     'rest_framework.authtoken',
     'django_filters',
     'polymorphic',
+    'django_extensions',
 ]
 
 # Fixtures

fixtures/users.json

@@ -64,7 +64,8 @@
 
 CACHES = {
     'default': {
-        'BACKEND': 'django.core.cache.backends.dummy.DummyCache',
+        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+        'LOCATION': 'pythondotorg-local-cache',
     }
 }
 

pydotorg/settings/base.py

@@ -18,10 +18,14 @@
 from sponsors.models.benefits import RequiredAssetMixin
 from sponsors import views_admin
 from sponsors.forms import SponsorshipReviewAdminForm, SponsorBenefitAdminInlineForm, RequiredImgAssetConfigurationForm, \
-    SponsorshipBenefitAdminForm
+    SponsorshipBenefitAdminForm, CloneApplicationConfigForm
 from cms.admin import ContentManageableModelAdmin
 
 
+def get_url_base_name(Model):
+    return f"{Model._meta.app_label}_{Model._meta.model_name}"
+
+
 class AssetsInline(GenericTabularInline):
     model = GenericAsset
     extra = 0
@@ -113,7 +117,7 @@ class SponsorshipBenefitAdmin(PolymorphicInlineSupportMixin, OrderedModelAdmin):
         "internal_value",
         "move_up_down_links",
     ]
-    list_filter = ["program", "package_only", "packages", "new", "a_la_carte", "unavailable"]
+    list_filter = ["program", "year", "package_only", "packages", "new", "a_la_carte", "unavailable"]
     search_fields = ["name"]
     form = SponsorshipBenefitAdminForm
 
@@ -150,11 +154,12 @@ class SponsorshipBenefitAdmin(PolymorphicInlineSupportMixin, OrderedModelAdmin):
 
     def get_urls(self):
         urls = super().get_urls()
+        base_name = get_url_base_name(self.model)
         my_urls = [
             path(
                 "<int:pk>/update-related-sponsorships",
                 self.admin_site.admin_view(self.update_related_sponsorships),
-                name="sponsors_sponsorshipbenefit_update_related",
+                name=f"{base_name}_update_related",
             ),
         ]
         return my_urls + urls
@@ -166,8 +171,8 @@ def update_related_sponsorships(self, *args, **kwargs):
 @admin.register(SponsorshipPackage)
 class SponsorshipPackageAdmin(OrderedModelAdmin):
     ordering = ("order",)
-    list_display = ["name", "advertise", "move_up_down_links"]
-    list_filter = ["advertise"]
+    list_display = ["name", "year", "advertise", "move_up_down_links"]
+    list_filter = ["advertise", "year"]
     search_fields = ["name"]
 
     def get_readonly_fields(self, request, obj=None):
@@ -294,12 +299,13 @@ class SponsorshipAdmin(admin.ModelAdmin):
         "sponsor",
         "status",
         "package",
+        "year",
         "applied_on",
         "approved_on",
         "start_date",
         "end_date",
     ]
-    list_filter = [SponsorshipStatusListFilter, "package", TargetableEmailBenefitsFilter]
+    list_filter = [SponsorshipStatusListFilter, "package", "year", TargetableEmailBenefitsFilter]
     actions = ["send_notifications"]
     fieldsets = [
         (
@@ -311,6 +317,7 @@ class SponsorshipAdmin(admin.ModelAdmin):
                     "status",
                     "package",
                     "sponsorship_fee",
+                    "year",
                     "get_estimated_cost",
                     "start_date",
                     "end_date",
@@ -407,6 +414,9 @@ def get_readonly_fields(self, request, obj):
             extra = ["start_date", "end_date", "package", "level_name", "sponsorship_fee"]
             readonly_fields.extend(extra)
 
+        if obj.year:
+            readonly_fields.append("year")
+
         return readonly_fields
 
     def sponsor_link(self, obj):
@@ -436,33 +446,34 @@ def get_contract(self, obj):
 
     def get_urls(self):
         urls = super().get_urls()
+        base_name = get_url_base_name(self.model)
         my_urls = [
             path(
                 "<int:pk>/reject",
                 # TODO: maybe it would be better to create a specific
                 # group or permission to review sponsorship applications
                 self.admin_site.admin_view(self.reject_sponsorship_view),
-                name="sponsors_sponsorship_reject",
+                name=f"{base_name}_reject",
             ),
             path(
                 "<int:pk>/approve-existing",
                 self.admin_site.admin_view(self.approve_signed_sponsorship_view),
-                name="sponsors_sponsorship_approve_existing_contract",
+                name=f"{base_name}_approve_existing_contract",
             ),
             path(
                 "<int:pk>/approve",
                 self.admin_site.admin_view(self.approve_sponsorship_view),
-                name="sponsors_sponsorship_approve",
+                name=f"{base_name}_approve",
             ),
             path(
                 "<int:pk>/enable-edit",
                 self.admin_site.admin_view(self.rollback_to_editing_view),
-                name="sponsors_sponsorship_rollback_to_edit",
+                name=f"{base_name}_rollback_to_edit",
             ),
             path(
                 "<int:pk>/list-assets",
                 self.admin_site.admin_view(self.list_uploaded_assets_view),
-                name="sponsors_sponsorship_list_uploaded_assets",
+                name=f"{base_name}_list_uploaded_assets",
             ),
         ]
         return my_urls + urls
@@ -588,6 +599,87 @@ def list_uploaded_assets_view(self, request, pk):
         return views_admin.list_uploaded_assets(self, request, pk)
 
 
+@admin.register(SponsorshipCurrentYear)
+class SponsorshipCurrentYearAdmin(admin.ModelAdmin):
+    list_display = ["year", "links", "other_years"]
+    change_list_template = "sponsors/admin/sponsors_sponsorshipcurrentyear_changelist.html"
+
+    def has_add_permission(self, *args, **kwargs):
+        return False
+
+    def has_delete_permission(self, *args, **kwargs):
+        return False
+
+    def get_urls(self):
+        urls = super().get_urls()
+        base_name = get_url_base_name(self.model)
+        my_urls = [
+            path(
+                "clone-year-config",
+                self.admin_site.admin_view(self.clone_application_config),
+                name=f"{base_name}_clone",
+            ),
+        ]
+        return my_urls + urls
+
+    def links(self, obj):
+        clone_form = CloneApplicationConfigForm()
+        configured_years = clone_form.configured_years
+
+        application_url = reverse("select_sponsorship_application_benefits")
+        benefits_url = reverse("admin:sponsors_sponsorshipbenefit_changelist")
+        packages_url = reverse("admin:sponsors_sponsorshippackage_changelist")
+        preview_label = 'View sponsorship application'
+        year = obj.year
+        html = "<ul>"
+        preview_querystring = f"config_year={year}"
+        preview_url = f"{application_url}?{preview_querystring}"
+        filter_querystring = f"year={year}"
+        year_benefits_url = f"{benefits_url}?{filter_querystring}"
+        year_packages_url = f"{benefits_url}?{filter_querystring}"
+
+        html += f"<li><a target='_blank' href='{year_packages_url}'>List packages</a>"
+        html += f"<li><a target='_blank' href='{year_benefits_url}'>List benefits</a>"
+        html += f"<li><a target='_blank' href='{preview_url}'>{preview_label}</a>"
+        html += "</ul>"
+        return mark_safe(html)
+    links.short_description = "Links"
+
+    def other_years(self, obj):
+        clone_form = CloneApplicationConfigForm()
+        configured_years = clone_form.configured_years
+        try:
+            configured_years.remove(obj.year)
+        except ValueError:
+            pass
+        if not configured_years:
+            return "---"
+
+        application_url = reverse("select_sponsorship_application_benefits")
+        benefits_url = reverse("admin:sponsors_sponsorshipbenefit_changelist")
+        packages_url = reverse("admin:sponsors_sponsorshippackage_changelist")
+        preview_label = 'View sponsorship application form for this year'
+        html = "<ul>"
+        for year in configured_years:
+            preview_querystring = f"config_year={year}"
+            preview_url = f"{application_url}?{preview_querystring}"
+            filter_querystring = f"year={year}"
+            year_benefits_url = f"{benefits_url}?{filter_querystring}"
+            year_packages_url = f"{benefits_url}?{filter_querystring}"
+
+            html += f"<li><b>{year}</b>:"
+            html += "<ul>"
+            html += f"<li><a target='_blank' href='{year_packages_url}'>List packages</a>"
+            html += f"<li><a target='_blank' href='{year_benefits_url}'>List benefits</a>"
+            html += f"<li><a target='_blank' href='{preview_url}'>{preview_label}</a>"
+            html += "</ul></li>"
+        html += "</ul>"
+        return mark_safe(html)
+    other_years.short_description = "Other configured years"
+
+    def clone_application_config(self, request):
+        return views_admin.clone_application_config(self, request)
+
 @admin.register(LegalClause)
 class LegalClauseModelAdmin(OrderedModelAdmin):
     list_display = ["internal_name"]
@@ -596,6 +688,7 @@ class LegalClauseModelAdmin(OrderedModelAdmin):
 @admin.register(Contract)
 class ContractModelAdmin(admin.ModelAdmin):
     change_form_template = "sponsors/admin/contract_change_form.html"
+    list_filter = ["sponsorship__year"]
     list_display = [
         "id",
         "sponsorship",
@@ -711,26 +804,27 @@ def get_sponsorship_url(self, obj):
 
     def get_urls(self):
         urls = super().get_urls()
+        base_name = get_url_base_name(self.model)
         my_urls = [
             path(
                 "<int:pk>/preview",
                 self.admin_site.admin_view(self.preview_contract_view),
-                name="sponsors_contract_preview",
+                name=f"{base_name}_preview",
             ),
             path(
                 "<int:pk>/send",
                 self.admin_site.admin_view(self.send_contract_view),
-                name="sponsors_contract_send",
+                name=f"{base_name}_send",
             ),
             path(
                 "<int:pk>/execute",
                 self.admin_site.admin_view(self.execute_contract_view),
-                name="sponsors_contract_execute",
+                name=f"{base_name}_execute",
             ),
             path(
                 "<int:pk>/nullify",
                 self.admin_site.admin_view(self.nullify_contract_view),
-                name="sponsors_contract_nullify",
+                name=f"{base_name}_nullify",
             ),
         ]
         return my_urls + urls