Merge pull request #463 from onaio/444-extract-forms-from-archive

[WIP] 444 Extract forms from archive

Author: JohnMwashuma

.github/workflows/config.yml

@@ -3,8 +3,8 @@ name: Django CI
 on: [push]
 
 jobs:
-  container-job:
-    runs-on: ubuntu-20.04
+  build-amd64:
+    runs-on: ubuntu-latest
 
     services:
       # Label used to access the service container
@@ -28,10 +28,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.9.0
+      - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9.0
+          python-version: '3.9'
 
       - name: Cache Dependencies
         uses: actions/cache@v3
@@ -51,14 +51,18 @@ jobs:
       - name: Start Redis
         run: sudo service redis-server start
 
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        # Add uv to the PATH
+      - run: echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
       - name: Generate Report
         run: |
-          python3 -m venv venv
-            . venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install -r requirements/dev.pip
-          ruff check . --exit-non-zero-on-fix
-          pytest tally_ho --doctest-modules --junitxml=coverage.xml --cov=tally_ho --cov-report=xml --cov-report=html
+          uv venv
+          source .venv/bin/activate
+          uv pip install -r requirements/dev.pip
+          python -m ruff check . --exit-non-zero-on-fix
+          python -m pytest tally_ho --doctest-modules --junitxml=coverage.xml --cov=tally_ho --cov-report=xml --cov-report=html
           coverage xml
           ls -al
         env:

tally_ho/apps/tally/forms/workflow_request_forms.py

@@ -0,0 +1,36 @@
+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+from tally_ho.apps.tally.models import WorkflowRequest
+
+
+class RequestRecallForm(forms.ModelForm):
+    class Meta:
+        model = WorkflowRequest
+        fields = ['request_reason', 'request_comment']
+        widgets = {
+            'request_reason': forms.Select(attrs={'class': 'form-control'}),
+            'request_comment': forms.Textarea(
+                attrs={'rows': 3, 'class': 'form-control'}),
+        }
+        labels = {
+            'request_reason': _("Reason for Recall"),
+            'request_comment': _("Comment (Required)"),
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.fields['request_comment'].required = True
+
+
+class ApprovalForm(forms.ModelForm):
+    class Meta:
+        model = WorkflowRequest
+        fields = ['approval_comment']
+        widgets = {
+            'approval_comment': forms.Textarea(
+                attrs={'rows': 3, 'class': 'form-control'}),
+        }
+        labels = {
+            'approval_comment': _("Approval/Rejection Comment"),
+        }

tally_ho/apps/tally/migrations/0058_workflowrequest.py

@@ -0,0 +1,38 @@
+# Generated by Django 4.2.2 on 2025-04-15 14:20
+
+from django.db import migrations, models
+import django.db.models.deletion
+import enumfields.fields
+import tally_ho.libs.models.enums.request_reason
+import tally_ho.libs.models.enums.request_status
+import tally_ho.libs.models.enums.request_type
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tally', '0057_alter_reconciliationform_ballot_number_from_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='WorkflowRequest',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_date', models.DateTimeField(auto_now_add=True)),
+                ('modified_date', models.DateTimeField(auto_now=True)),
+                ('request_type', enumfields.fields.EnumIntegerField(enum=tally_ho.libs.models.enums.request_type.RequestType, verbose_name='Request Type')),
+                ('status', enumfields.fields.EnumIntegerField(default=0, enum=tally_ho.libs.models.enums.request_status.RequestStatus, verbose_name='Request Status')),
+                ('request_reason', enumfields.fields.EnumIntegerField(enum=tally_ho.libs.models.enums.request_reason.RequestReason, verbose_name='Reason')),
+                ('request_comment', models.TextField(verbose_name='Request Comment')),
+                ('approval_comment', models.TextField(blank=True, null=True, verbose_name='Approval/Rejection Comment')),
+                ('resolved_date', models.DateTimeField(blank=True, null=True)),
+                ('approver', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='approved_rejected_requests', to='tally.userprofile')),
+                ('requester', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, related_name='initiated_requests', to='tally.userprofile')),
+                ('result_form', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, related_name='workflow_requests', to='tally.resultform')),
+            ],
+            options={
+                'indexes': [models.Index(fields=['result_form', 'request_type', 'status'], name='tally_workf_result__92f4e2_idx')],
+            },
+        ),
+    ]

tally_ho/apps/tally/migrations/0059_reconciliationform_deactivated_by_request_and_more.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.2.2 on 2025-04-16 12:13
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tally', '0058_workflowrequest'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='reconciliationform',
+            name='deactivated_by_request',
+            field=models.ForeignKey(blank=True, help_text='The workflow request that triggered the deactivation of this reconciliation record.', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='deactivated_recons', to='tally.workflowrequest'),
+        ),
+        migrations.AddField(
+            model_name='result',
+            name='deactivated_by_request',
+            field=models.ForeignKey(blank=True, help_text='The workflow request that triggered the deactivation of this result record.', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='deactivated_results', to='tally.workflowrequest'),
+        ),
+    ]

tally_ho/apps/tally/models/__init__.py

@@ -20,3 +20,4 @@
 from tally_ho.apps.tally.models.region import Region
 from tally_ho.apps.tally.models.constituency import Constituency
 from tally_ho.apps.tally.models.electrol_race import ElectrolRace
+from tally_ho.apps.tally.models.workflow_request import WorkflowRequest

tally_ho/apps/tally/models/reconciliation_form.py

@@ -9,6 +9,7 @@
 from tally_ho.apps.tally.models.user_profile import UserProfile
 from tally_ho.libs.models.base_model import BaseModel
 from tally_ho.libs.models.enums.entry_version import EntryVersion
+from tally_ho.apps.tally.models.workflow_request import WorkflowRequest
 
 
 class ReconciliationFormSet(models.QuerySet):
@@ -84,6 +85,15 @@ class Meta:
     signature_dated = models.BooleanField(_('Is the form dated?'))
     notes = models.TextField(null=True, blank=True)
     objects = ReconciliationFormSet.as_manager()
+    deactivated_by_request = models.ForeignKey(
+        WorkflowRequest,
+        null=True,
+        blank=True,
+        on_delete=models.SET_NULL,
+        related_name='deactivated_recons',
+        help_text=_(str("The workflow request that triggered the "
+                        "deactivation of this reconciliation record."))
+    )
 
     @property
     def number_ballots_used(self):

tally_ho/apps/tally/models/result.py

@@ -1,12 +1,14 @@
 from django.db import models
 from enumfields import EnumIntegerField
 import reversion
+from django.utils.translation import gettext_lazy as _
 
 from tally_ho.apps.tally.models.candidate import Candidate
 from tally_ho.apps.tally.models.result_form import ResultForm
 from tally_ho.apps.tally.models.user_profile import UserProfile
 from tally_ho.libs.models.base_model import BaseModel
 from tally_ho.libs.models.enums.entry_version import EntryVersion
+from tally_ho.apps.tally.models.workflow_request import WorkflowRequest
 
 
 class Result(BaseModel):
@@ -26,6 +28,15 @@ class Meta:
     active = models.BooleanField(default=True)
     entry_version = EnumIntegerField(EntryVersion)
     votes = models.PositiveIntegerField()
+    deactivated_by_request = models.ForeignKey(
+        WorkflowRequest,
+        null=True,
+        blank=True,
+        on_delete=models.SET_NULL,
+        related_name='deactivated_results',
+        help_text=_(str("The workflow request that triggered the "
+                        "deactivation of this result record."))
+    )
 
 
 reversion.register(Result)

tally_ho/apps/tally/models/result_form.py

@@ -389,18 +389,29 @@ def corrections_passed(self):
             (not self.reconciliationform_exists or
              self.reconciliation_match))
 
-    def reject(self, new_state=FormState.DATA_ENTRY_1, reject_reason=None):
+    def reject(
+            self,
+            new_state=FormState.DATA_ENTRY_1,
+            reject_reason=None,
+            workflow_request=None):
         """Deactivate existing results and reconciliation forms for this result
         form, change the state, and increment the rejected count.
 
         :param new_state: The state to set the form to.
+        :param reject_reason: Optional reason text for the rejection.
+        :param workflow_request: Optional WorkflowRequest instance that
+            triggered this rejection.
         """
         for result in self.results.all():
             result.active = False
+            if workflow_request:
+                result.deactivated_by_request = workflow_request
             result.save()
 
         for recon in self.reconciliationform_set.all():
             recon.active = False
+            if workflow_request:
+                recon.deactivated_by_request = workflow_request
             recon.save()
 
         self.rejected_count += 1

tally_ho/apps/tally/models/workflow_request.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+from enumfields import EnumIntegerField
+import reversion
+
+from tally_ho.apps.tally.models.result_form import ResultForm
+from tally_ho.apps.tally.models.user_profile import UserProfile
+from tally_ho.libs.models.base_model import BaseModel
+from tally_ho.libs.models.enums.request_reason import RequestReason
+from tally_ho.libs.models.enums.request_status import RequestStatus
+from tally_ho.libs.models.enums.request_type import RequestType
+
+
+@reversion.register()
+class WorkflowRequest(BaseModel):
+    class Meta:
+        app_label = 'tally'
+        indexes = [
+            models.Index(fields=['result_form', 'request_type', 'status'])
+        ]
+
+    request_type = EnumIntegerField(
+        RequestType, verbose_name=_("Request Type"))
+    status = EnumIntegerField(
+        RequestStatus,
+        default=RequestStatus.PENDING,
+        verbose_name=_("Request Status"))
+    result_form = models.ForeignKey(
+        ResultForm,
+        on_delete=models.PROTECT,
+        related_name='workflow_requests')
+    requester = models.ForeignKey(
+        UserProfile,
+        on_delete=models.PROTECT,
+        related_name='initiated_requests')
+    request_reason = EnumIntegerField(RequestReason, verbose_name=_("Reason"))
+    request_comment = models.TextField(verbose_name=_("Request Comment"))
+    approver = models.ForeignKey(
+        UserProfile,
+        on_delete=models.PROTECT,
+        related_name='approved_rejected_requests',
+        null=True,
+        blank=True)
+    approval_comment = models.TextField(
+        verbose_name=_("Approval/Rejection Comment"), null=True, blank=True)
+    resolved_date = models.DateTimeField(null=True, blank=True)
+
+    def __str__(self):
+        return str(
+            f"{self.get_request_type_display()} request for "
+            f"{self.result_form.barcode} - Status: "
+            f"{self.get_status_display()}")
+
+    def is_pending(self):
+        return self.status == RequestStatus.PENDING
+
+    def is_approved(self):
+        return self.status == RequestStatus.APPROVED
+
+    def is_rejected(self):
+        return self.status == RequestStatus.REJECTED
+
+    def can_be_actioned_by(self, user):
+        """
+        Logic to determine if the user (Tally Manager/Super Admin)
+        can approve/reject
+        :param user: Logged in user
+        :return: bool
+        """
+        from tally_ho.libs.permissions import groups
+        return user.is_authenticated and\
+            groups.is_tally_manager(user) or\
+                groups.is_super_administrator(user)
+
+    def can_be_viewed_by(self, user):
+        """
+        Logic to determine who can view the request
+        Audit Clerks/Supervisors, or any
+        Tally Manager/Super Admin
+        :param user: Logged in user
+        :return: bool
+        """
+        from tally_ho.libs.permissions import groups
+        return (
+            user.is_authenticated and (
+                groups.is_audit_clerk(user) or
+                groups.is_audit_supervisor(user) or
+                groups.is_tally_manager(user) or
+                groups.is_super_administrator(user)
+            )
+        )