wbcompliance 1.54.17__tar.gz → 1.58.2__tar.gz

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wbcompliance
-Version: 1.54.17
+Version: 1.58.2
 Summary: A workbench module for managing compliance.
 Author-email: Christopher Wittlinger <c.wittlinger@stainly.com>
 Requires-Dist: wbcore

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/filters/risk_management/checks.py

@@ -12,6 +12,14 @@ class RiskCheckFilterSet(wb_filters.FilterSet):
         distinct=True,
         hidden=True,
     )
+    activators = wb_filters.MultipleChoiceContentTypeFilter(
+        label="Activators",
+        field_name="activators",
+        object_id_label="activator_id",
+        content_type_label="activator_content_type",
+        distinct=True,
+        hidden=True,
+    )
     passive_check = wb_filters.BooleanFilter(initial=True, required=True, label="Passive")
 
     class Meta:

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/models/compliance_task.py

@@ -75,7 +75,7 @@ class ComplianceTask(WBModel):
         @classmethod
         def get_color_map(cls) -> list:
             colors = [WBColor.GREEN_LIGHT.value, WBColor.YELLOW_LIGHT.value, WBColor.RED_LIGHT.value]
-            return [choice for choice in zip(cls, colors)]
+            return [choice for choice in zip(cls, colors, strict=False)]
 
     title = models.CharField(max_length=255, verbose_name=_("Title"))
     description = models.TextField(default="", blank=True, verbose_name=_("Description"))
@@ -171,7 +171,7 @@ class ComplianceTaskInstance(models.Model):
                 WBColor.BLUE_LIGHT.value,
                 WBColor.RED_LIGHT.value,
             ]
-            return [choice for choice in zip(cls, colors)]
+            return [choice for choice in zip(cls, colors, strict=False)]
 
     task = models.ForeignKey(
         on_delete=models.CASCADE,
@@ -235,7 +235,7 @@ class ComplianceAction(models.Model):
         @classmethod
         def get_color_map(cls) -> list:
             colors = [WBColor.GREY.value, WBColor.YELLOW_LIGHT.value, WBColor.GREEN_LIGHT.value]
-            return [choice for choice in zip(cls, colors)]
+            return [choice for choice in zip(cls, colors, strict=False)]
 
     title = models.CharField(max_length=255, verbose_name=_("Title"))
     description = models.TextField(
@@ -310,7 +310,7 @@ class ComplianceEvent(models.Model):
         @classmethod
         def get_color_map(cls) -> list:
             colors = [WBColor.GREY.value, WBColor.BLUE_LIGHT.value]
-            return [choice for choice in zip(cls, colors)]
+            return [choice for choice in zip(cls, colors, strict=False)]
 
     type_event = models.CharField(
         max_length=32,
@@ -414,7 +414,7 @@ class ReviewComplianceTask(ComplianceDocumentMixin, ComplexToStringMixin, WBMode
                 WBColor.YELLOW_LIGHT.value,
                 WBColor.GREEN_LIGHT.value,
             ]
-            return [choice for choice in zip(cls, colors)]
+            return [choice for choice in zip(cls, colors, strict=False)]
 
     class Meta:
         verbose_name = "Review Compliance Task"

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/models/enums.py

@@ -10,4 +10,4 @@ class IncidentSeverity(models.TextChoices):
     @classmethod
     def get_color_map(cls) -> list:
         colors = [WBColor.GREEN_LIGHT.value, WBColor.YELLOW_LIGHT.value, WBColor.RED_LIGHT.value]
-        return [choice for choice in zip(cls, colors)]
+        return [choice for choice in zip(cls, colors, strict=False)]

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/models/risk_management/checks.py

@@ -99,9 +99,12 @@ class RiskCheck(ComplexToStringMixin, WBModel):
     @property
     def needs_incident(self) -> bool:
         # if the there is a similar checked object relationship, we needs to create a general incident if the check evaluates to a breach
-        return self.rule.checked_object_relationships.filter(
-            checked_object_content_type=self.checked_object_content_type, checked_object_id=self.checked_object_id
-        ).exists()
+        return (
+            self.rule.checked_object_relationships.filter(
+                checked_object_content_type=self.checked_object_content_type, checked_object_id=self.checked_object_id
+            ).exists()
+            or self.activator_id is not None
+        )
 
     @property
     def previous_check(self) -> Self | None:

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/models/risk_management/incidents.py

@@ -29,7 +29,6 @@ from wbcore.metadata.configs.buttons import ActionButton, ButtonDefaultColor
 from wbcore.metadata.configs.display.instance_display.shortcuts import (
     create_simple_display,
 )
-from wbcore.models import WBModel
 from wbcore.utils.models import ComplexToStringMixin
 
 User: BaseUser = get_user_model()
@@ -109,7 +108,7 @@ class RiskIncidentMixin(models.Model):
         abstract = True
 
 
-class CheckedObjectIncidentRelationship(ComplexToStringMixin, RiskIncidentMixin, WBModel):
+class CheckedObjectIncidentRelationship(ComplexToStringMixin, RiskIncidentMixin):
     incident = models.ForeignKey(
         to="wbcompliance.RiskIncident",
         related_name="checked_object_relationships",
@@ -229,6 +228,9 @@ class CheckedObjectIncidentRelationship(ComplexToStringMixin, RiskIncidentMixin,
             models.Index(fields=["incident", "rule_check"]),
         ]
 
+    def __str__(self) -> str:
+        return super().__str__()
+
     def compute_str(self) -> str:
         return _("{} {} Sub Incident for checked_object {}").format(self.status, self.severity, self.rule_check)
 
@@ -259,7 +261,7 @@ class RiskIncidentDefaultManager(models.Manager):
         )
 
 
-class RiskIncident(ComplexToStringMixin, RiskIncidentMixin, WBModel):
+class RiskIncident(ComplexToStringMixin, RiskIncidentMixin):
     """
     Instance defining the incident that has happened during a check initiated by a certain rule
     """
@@ -382,6 +384,9 @@ class RiskIncident(ComplexToStringMixin, RiskIncidentMixin, WBModel):
             )
         ]
 
+    def __str__(self) -> str:
+        return super().__str__()
+
     def save(self, *args, **kwargs):
         if not self.breached_object_repr:
             self.breached_object_repr = str(self.breached_content_object)

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/models/risk_management/mixins.py

@@ -97,8 +97,8 @@ class RiskCheckMixin(models.Model):
             )[0]
             if asynchronously:
                 transaction.on_commit(
-                    lambda: evaluate_as_task.delay(
-                        check.id, *dto, override_incident=True, ignore_informational_threshold=True
+                    lambda check_id=check.id: evaluate_as_task.delay(
+                        check_id, *dto, override_incident=True, ignore_informational_threshold=True
                     )
                 )
             else:

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/models/risk_management/rules.py

@@ -47,6 +47,9 @@ class RuleGroup(models.Model):
             self.name = self.key.title()
         super().save(*args, **kwargs)
 
+    def __str__(self) -> str:
+        return self.name
+
     @classmethod
     def get_representation_endpoint(cls) -> str:
         return "wbcompliance:rulegrouprepresentation-list"
@@ -60,7 +63,7 @@ class RuleGroup(models.Model):
         return "{{name}}"
 
 
-class RuleCheckedObjectRelationship(ComplexToStringMixin, models.Model):
+class RuleCheckedObjectRelationship(ComplexToStringMixin):
     rule = models.ForeignKey(
         to="wbcompliance.RiskRule", related_name="checked_object_relationships", on_delete=models.CASCADE
     )
@@ -261,7 +264,7 @@ class RuleBackend(models.Model):
         return "{{name}}"
 
 
-class RuleThreshold(ComplexToStringMixin, models.Model):
+class RuleThreshold(ComplexToStringMixin):
     """
     Represent the list of threshold and its associated severity link to a certain rule
     """
@@ -447,7 +450,7 @@ class RiskRule(PermissionObjectModelMixin, WBModel):
     def checked_object_representation(self) -> str:
         try:
             backend_class = self.rule_backend.backend_class
-            checked_object_repr = getattr(backend_class, "OBJECT_FIELD_NAME").title()
+            checked_object_repr = backend_class.OBJECT_FIELD_NAME.title()
         except AttributeError:
             checked_object_repr = "Object"
         return checked_object_repr

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/serializers/risk_management/checks.py

@@ -17,7 +17,7 @@ class RiskCheckModelSerializer(wb_serializers.ModelSerializer):
     _rule = RiskRuleRepresentationSerializer(source="rule")
     _checked_object_content_type = ContentTypeRepresentationSerializer(source="checked_object_content_type")
 
-    incident_reports = wb_serializers.TextField()
+    incident_reports = wb_serializers.TextField(read_only=True)
     status_icon = IconSelectField(read_only=True)
 
     @wb_serializers.register_resource()

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/tests/disable_signals.py

@@ -1,6 +1,15 @@
 from collections import defaultdict
 
-from django.db.models.signals import *
+from django.db.models.signals import (
+    post_delete,
+    post_init,
+    post_migrate,
+    post_save,
+    pre_delete,
+    pre_init,
+    pre_migrate,
+    pre_save,
+)
 
 
 class DisableSignals(object):
@@ -50,7 +59,7 @@ class DisableSignals(object):
 #                     self.disconnect(signal)
 
 
-class temp_disconnect_signal:
+class TempDisconnectSignal:
     """Temporarily disconnect a model from a signal"""
 
     def __init__(self, signal, receiver, sender, dispatch_uid=None):
@@ -72,11 +81,3 @@ class temp_disconnect_signal:
             sender=self.sender,
             dispatch_uid=self.dispatch_uid,
         )
-
-
-class DisableSignalsNotification(temp_disconnect_signal):
-    def __init__(self, dispatch_uid=None):
-        self.signal = post_save
-        self.receiver = post_create_notification
-        self.sender = Notification
-        self.dispatch_uid = dispatch_uid

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/tests/test_views.py

@@ -342,7 +342,7 @@ class TestSpecificViewsets(UserTestMixin):
         assert response.data.get("results")
 
     @pytest.mark.parametrize("mvs", [ComplianceTaskMatrixPandasViewSet])
-    def test_PandasAPIView(self, mvs, compliance_task_factory, compliance_task_instance_factory):
+    def test_pandasapiview(self, mvs, compliance_task_factory, compliance_task_instance_factory):
         request = APIRequestFactory().get("")
         request.user = get_or_create_superuser()
 

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/viewsets/buttons/compliance_form.py

@@ -20,9 +20,9 @@ class AbstractComplianceDocumentButtonConfig:
         return bt.ActionButton(
             method=RequestType.PATCH,
             key="regenerate_document",
-            action_label=_("Regenerate Document"),
-            title=_("Regenerate Document"),
-            label=_("Regenerate Document"),
+            action_label=_("PDF Document is being generated"),
+            title=_("Generate PDF Document"),
+            label=_("Generate PDF Document"),
             icon=WBIcon.DOCUMENT.icon,
             serializer=ComplianceDocumentSerializer,
             instance_display=create_simple_display([["send_email"]]),

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/viewsets/buttons/compliance_task.py

@@ -22,12 +22,12 @@ def get_custom_report(_request, review: ReviewComplianceTask):
     try:
         content_type = ContentType.objects.get(app_label="wbcompliance", model="reviewcompliancetask")
         ReportVersion = apps.get_model("wbreport", "ReportVersion")
-        BUTTTONS = []
+        buttons = []
         versions = ReportVersion.objects.filter(
             version_date=review.to_date, report__content_type=content_type, report__is_active=True
         ).filter(Q(parameters__type=review.type.name) | Q(parameters__type=review.type.id))
         for version in versions:
-            BUTTTONS.append(
+            buttons.append(
                 bt.HyperlinkButton(
                     endpoint=reverse("report:reportversion-html", args=[version.id], request=_request),
                     label=_("Show {}").format(version.title),
@@ -35,7 +35,7 @@ def get_custom_report(_request, review: ReviewComplianceTask):
                 )
             )
             if not version.lock:
-                BUTTTONS.append(
+                buttons.append(
                     bt.ActionButton(
                         method=RequestType.GET,
                         identifiers=("wbreport:reportversion",),
@@ -51,12 +51,12 @@ def get_custom_report(_request, review: ReviewComplianceTask):
                         title=_("Update {}").format(version.title),
                     ),
                 )
-        if BUTTTONS:
+        if buttons:
             return {
                 bt.DropDownButton(
                     label=_("Report"),
                     icon=WBIcon.UNFOLD.icon,
-                    buttons=tuple(BUTTTONS),
+                    buttons=tuple(buttons),
                 ),
             }
     except LookupError:
@@ -70,11 +70,11 @@ class ComplianceTaskButtonConfig(ButtonViewConfig):
         class OccuredSerializer(wb_serializers.Serializer):
             occured = wb_serializers.DateField(required=True)
 
-        BUTTONS = []
+        buttons = []
         if self.view.kwargs.get("pk", None) and self.request.user.is_superuser:
             review = self.view.get_object()
             if review.active:
-                BUTTONS += [
+                buttons += [
                     bt.ActionButton(
                         method=RequestType.PATCH,
                         identifiers=("wbcompliance:compliancetask",),
@@ -87,7 +87,7 @@ class ComplianceTaskButtonConfig(ButtonViewConfig):
                         instance_display=create_simple_display([["occured"]]),
                     )
                 ]
-        return {*BUTTONS}
+        return {*buttons}
 
 
 class ReviewComplianceTaskButtonConfig(ButtonViewConfig):
@@ -100,17 +100,17 @@ class ReviewComplianceTaskButtonConfig(ButtonViewConfig):
                 choices=[("ADD", "Add existing indicators"), ("REMOVE", "Remove existing Indicators")],
             )
 
-        BUTTONS = []
+        buttons = []
         if self.view.kwargs.get("pk", None) and self.request.user.has_perm("wbcompliance.administrate_compliance"):
             review = self.view.get_object()
             if review.is_instance:
-                BUTTONS = get_custom_report(_request=self.request, review=review)
+                buttons = get_custom_report(_request=self.request, review=review)
             else:
                 if review.status == ReviewComplianceTask.Status.VALIDATED:
-                    BUTTONS += [AbstractComplianceDocumentButtonConfig._get_compliance_document_button()]
+                    buttons += [AbstractComplianceDocumentButtonConfig._get_compliance_document_button()]
 
                     if self.request.user.has_perm("wbcompliance.administrate_compliance"):
-                        BUTTONS += [
+                        buttons += [
                             bt.ActionButton(
                                 method=RequestType.PATCH,
                                 identifiers=("wbcompliance:reviewcompliancetask",),
@@ -125,7 +125,7 @@ class ReviewComplianceTaskButtonConfig(ButtonViewConfig):
                         ]
 
                 if review.status == ReviewComplianceTask.Status.DRAFT and self.request.user.is_superuser:
-                    BUTTONS += [
+                    buttons += [
                         bt.ActionButton(
                             method=RequestType.PATCH,
                             identifiers=("wbcompliance:reviewcompliancetask",),
@@ -147,4 +147,4 @@ class ReviewComplianceTaskButtonConfig(ButtonViewConfig):
                         ),
                     ]
 
-        return {*BUTTONS}
+        return {*buttons}

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/viewsets/risk_management/checks.py

@@ -1,10 +1,12 @@
 from django.contrib.auth import get_user_model
 from django.contrib.postgres.aggregates import StringAgg
 from django.db import models
-from django.db.models import F
+from django.db.models import F, OuterRef, Subquery, Value
+from django.db.models.functions import Concat
 from wbcore import viewsets
 
 from wbcompliance.filters.risk_management.checks import RiskCheckFilterSet
+from wbcompliance.models import CheckedObjectIncidentRelationship
 from wbcompliance.models.risk_management import RiskCheck
 from wbcompliance.serializers import (
     RiskCheckModelSerializer,
@@ -35,8 +37,17 @@ class RiskCheckModelViewSet(viewsets.ModelViewSet):
     filterset_class = RiskCheckFilterSet
 
     def get_queryset(self):
+        rel = (
+            CheckedObjectIncidentRelationship.objects.filter(rule_check=OuterRef("id"))
+            .annotate(
+                title=Concat(F("incident__breached_object_repr"), Value(" ( "), F("breached_value"), Value(" ) "))
+            )
+            .values("rule_check")
+            .annotate(incident_reports=StringAgg("title", delimiter="<br>"))
+            .values("incident_reports")
+        )
         return (
-            RiskCheck.objects.annotate(
+            RiskCheck.all_objects.annotate(
                 status_icon=models.Case(
                     *[
                         models.When(status=value, then=models.Value(RiskCheck.CheckStatus[value].icon))
@@ -44,7 +55,7 @@ class RiskCheckModelViewSet(viewsets.ModelViewSet):
                     ],
                     default=models.Value("none"),
                 ),
-                incident_reports=StringAgg(F("incidents__report"), delimiter="<br>"),
+                incident_reports=Subquery(rel),
             )
             .select_related(
                 "rule",

{wbcompliance-1.54.17 → wbcompliance-1.58.2}/wbcompliance/viewsets/risk_management/mixins.py

@@ -18,7 +18,7 @@ class RiskCheckViewSetMixin:
                 icon = RiskCheck.CheckStatus[instance.get_worst_check_status()].icon
                 if instance.checks.exists():
                     return bt.WidgetButton(
-                        endpoint=f'{reverse("wbcompliance:riskcheck-list", args=[], request=self.request)}?checked_objects=[[{instance.checked_object_content_type.id},{instance.checked_object.id}]]',
+                        endpoint=f'{reverse("wbcompliance:riskcheck-list", args=[], request=self.request)}?checked_objects=[[{instance.checked_object_content_type.id},{instance.checked_object.id}]]&evaluation_date={instance.check_evaluation_date}&activators=[[{instance.activator_content_type.id},{instance.activator_id}]]&passive_check=False',
                         label=self._get_risk_checks_button_title(),
                         icon=icon,
                     )