wbcore 1.46.0__py2.py3-none-any.whl → 1.58.2__py2.py3-none-any.whl

wbcore/contrib/workflow/models/data.py

@@ -28,7 +28,10 @@ class Data(WBModel):
                 serializers.DateTimeField(),
                 serializers.BooleanField(),
             ]
-            return {data_type: serializer_field for data_type, serializer_field in zip(cls, serializer_fields)}
+            return {
+                data_type: serializer_field
+                for data_type, serializer_field in zip(cls, serializer_fields, strict=False)
+            }
 
         @classmethod
         def get_cast_mapping(cls) -> dict:
@@ -39,7 +42,7 @@ class Data(WBModel):
                 datetime.strptime,
                 bool,
             ]
-            return {data_type: cast_callable for data_type, cast_callable in zip(cls, cast_callables)}
+            return {data_type: cast_callable for data_type, cast_callable in zip(cls, cast_callables, strict=False)}
 
     workflow = models.ForeignKey(
         to="workflow.Workflow",
@@ -176,8 +179,8 @@ class Data(WBModel):
                 format_str = "%d.%m.%Y %H:%M:%S"
             try:
                 casted_object = data_object.strftime(format_str)
-            except AttributeError:
-                raise ValueError(gettext("Date(time) type selected but no date(time) object provided!"))
+            except AttributeError as e:
+                raise ValueError(gettext("Date(time) type selected but no date(time) object provided!")) from e
 
         elif data_type == cls.DataType.BOOL:
             if data_object is True:

wbcore/contrib/workflow/models/process.py

@@ -27,7 +27,7 @@ class Process(WBModel):
                 WBColor.GREEN_LIGHT.value,
                 WBColor.RED_LIGHT.value,
             ]
-            return [choice for choice in zip(cls, colors)]
+            return [choice for choice in zip(cls, colors, strict=False)]
 
     id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False, verbose_name=_("UUID"))
     workflow = models.ForeignKey(
@@ -124,7 +124,7 @@ class ProcessStep(WBModel):
                 WBColor.RED_LIGHT.value,
                 WBColor.GREY.value,
             ]
-            return [choice for choice in zip(cls, colors)]
+            return [choice for choice in zip(cls, colors, strict=False)]
 
     id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False, verbose_name=_("UUID"))
     process = models.ForeignKey(

wbcore/contrib/workflow/models/step.py

@@ -39,7 +39,10 @@ class Step(WBModel):
 
     name = models.CharField(max_length=128, verbose_name=_("Name"))
     workflow = models.ForeignKey(
-        to="workflow.Workflow", verbose_name=_("Workflow"), on_delete=models.CASCADE, related_name="associated_steps"
+        to="workflow.Workflow",
+        verbose_name=_("Workflow"),
+        on_delete=models.CASCADE,
+        related_name="associated_steps",
     )
     code = models.PositiveIntegerField(verbose_name=_("Code"))
     status = models.CharField(
@@ -62,6 +65,9 @@ class Step(WBModel):
         help_text=_("Define which permission is needed to be able to view this step being executed."),
     )
 
+    outgoing_transitions: models.QuerySet[Transition]
+    incoming_transitions: models.QuerySet[Transition]
+
     def get_outgoing_transitions(self) -> models.QuerySet[Transition]:
         return self.outgoing_transitions.all()
 
@@ -139,15 +145,24 @@ class Step(WBModel):
         if len(valid_transitions := self.get_all_valid_outgoing_transitions(process_step)) == 1:
             Step.start_next_step(process_step, valid_transitions[0])
         elif not valid_transitions:
-            self.set_failed(process_step, gettext("No valid outgoing transitions found for this step!"))
+            self.set_failed(
+                process_step,
+                gettext("No valid outgoing transitions found for this step!"),
+            )
         else:
-            self.set_failed(process_step, gettext("More than one possible outgoing transition found for this step!"))
+            self.set_failed(
+                process_step,
+                gettext("More than one possible outgoing transition found for this step!"),
+            )
 
     def run(self, process_step: ProcessStep):
         self.set_finished(process_step)
 
     def finish(self, process_step: ProcessStep):
-        if process_step.state in [ProcessStep.StepState.FINISHED, ProcessStep.StepState.CANCELED]:
+        if process_step.state in [
+            ProcessStep.StepState.FINISHED,
+            ProcessStep.StepState.CANCELED,
+        ]:
             # Set finished field
             process_step.finished = datetime.now()
             process_step.save()
@@ -281,7 +296,10 @@ class UserStep(Step):
                 else:
                     self.set_failed(process_step, gettext("No assignees selected!"))
             else:
-                self.set_failed(process_step, gettext("No valid outgoing transitions found for this step!"))
+                self.set_failed(
+                    process_step,
+                    gettext("No valid outgoing transitions found for this step!"),
+                )
 
     def set_failed(self, process_step: ProcessStep, error_message: str):
         process_step.state = ProcessStep.StepState.FAILED
@@ -314,7 +332,10 @@ class UserStep(Step):
                     title=title,
                     body=body,
                     user=user,
-                    endpoint=reverse(f"{process_step.get_endpoint_basename()}-detail", args=[process_step.id]),
+                    endpoint=reverse(
+                        f"{process_step.get_endpoint_basename()}-detail",
+                        args=[process_step.id],
+                    ),
                 )
 
     @classmethod
@@ -365,7 +386,10 @@ class DecisionStep(Step):
         if transition := self.get_first_valid_transition(process_step):
             Step.start_next_step(process_step, transition)
         else:
-            self.set_failed(process_step, gettext("No valid outgoing transition found for this step!"))
+            self.set_failed(
+                process_step,
+                gettext("No valid outgoing transition found for this step!"),
+            )
 
     @classmethod
     def get_endpoint_basename(cls):
@@ -390,7 +414,10 @@ class SplitStep(Step):
                 next_step: Step = transition.to_step
                 activate_step.delay(next_step.pk, process_step.process.pk)
         else:
-            self.set_failed(process_step, gettext("No valid outgoing transitions found for this step!"))
+            self.set_failed(
+                process_step,
+                gettext("No valid outgoing transitions found for this step!"),
+            )
 
     @classmethod
     def get_endpoint_basename(cls):
@@ -407,7 +434,8 @@ class SplitStep(Step):
 
 class JoinStep(Step):
     """A background step that joins multiple steps into one. Waits until all incoming transitions are done by default.
-    If wait_for_all is False the first incoming transition cancels all other active incoming transitions."""
+    If wait_for_all is False the first incoming transition cancels all other active incoming transitions.
+    """
 
     wait_for_all = models.BooleanField(
         default=True,
@@ -466,7 +494,6 @@ class JoinStep(Step):
                 )
             ):
                 self.cancel_if_leading_to_self(unfinished_process_step.step, unfinished_process_step)
-
             self.execute_single_next_step(process_step)
 
     @classmethod
@@ -528,10 +555,16 @@ class EmailStep(Step):
         verbose_name=pgettext_lazy("Email context", "To"),
     )
     cc = models.ManyToManyField(
-        "directory.EmailContact", related_name="workflow_steps_cc", verbose_name=_("CC"), blank=True
+        "directory.EmailContact",
+        related_name="workflow_steps_cc",
+        verbose_name=_("CC"),
+        blank=True,
     )
     bcc = models.ManyToManyField(
-        "directory.EmailContact", related_name="workflow_steps_bcc", verbose_name=_("BCC"), blank=True
+        "directory.EmailContact",
+        related_name="workflow_steps_bcc",
+        verbose_name=_("BCC"),
+        blank=True,
     )
 
     def run(self, process_step: ProcessStep):
@@ -584,12 +617,16 @@ class FinishStep(Step):
         # Finish if there are no running process steps for this process
         if (
             ProcessStep.objects.filter(
-                process=process_step.process, state__in=[ProcessStep.StepState.WAITING, ProcessStep.StepState.ACTIVE]
+                process=process_step.process,
+                state__in=[ProcessStep.StepState.WAITING, ProcessStep.StepState.ACTIVE],
             )
             .exclude(id=process_step.pk)
             .exists()
         ):
-            self.set_failed(process_step, gettext("There are process steps still running for this workflow!"))
+            self.set_failed(
+                process_step,
+                gettext("There are process steps still running for this workflow!"),
+            )
         else:
             self.set_finished(process_step)
 
@@ -726,7 +763,12 @@ def process_can_finish(process_id: UUID):
             & Q(
                 Q(process_steps__isnull=True)
                 | Q(
-                    Q(process_steps__state__in=[ProcessStep.StepState.ACTIVE, ProcessStep.StepState.WAITING])
+                    Q(
+                        process_steps__state__in=[
+                            ProcessStep.StepState.ACTIVE,
+                            ProcessStep.StepState.WAITING,
+                        ]
+                    )
                     & Q(process_steps__process=process)
                 )
             )

wbcore/contrib/workflow/serializers/data.py

@@ -43,7 +43,7 @@ class DataModelSerializer(wb_serializers.ModelSerializer):
             if data_type:
                 try:
                     Data.cast_value_to_datatype(data_type, default)
-                except ValueError:
+                except ValueError as e:
                     if data_type == Data.DataType.DATE:
                         raise ValidationError(
                             {
@@ -51,7 +51,7 @@ class DataModelSerializer(wb_serializers.ModelSerializer):
                                     "Invalid default value for this data type. Please use a date formatted to 'day.month.year'."
                                 )
                             }
-                        )
+                        ) from None
                     elif data_type == Data.DataType.DATETIME:
                         raise ValidationError(
                             {
@@ -59,8 +59,8 @@ class DataModelSerializer(wb_serializers.ModelSerializer):
                                     "Invalid default value for this data type. Please use a datetime formatted to 'day.month.year hour:minute:second' in the 24h format."
                                 )
                             }
-                        )
-                    raise ValidationError({"default": _("Invalid default value for this data type.")})
+                        ) from None
+                    raise ValidationError({"default": _("Invalid default value for this data type.")}) from e
 
         return data
 
@@ -99,7 +99,7 @@ class DataValueModelSerializer(wb_serializers.ModelSerializer):
         if data_obj and value:
             try:
                 Data.cast_value_to_datatype(data_obj.data_type, value)
-            except ValueError:
+            except ValueError as e:
                 if data_obj.data_type == Data.DataType.DATE:
                     raise ValidationError(
                         {
@@ -107,7 +107,7 @@ class DataValueModelSerializer(wb_serializers.ModelSerializer):
                                 "Invalid value for this data type. Please use a date formatted to 'day.month.year'."
                             )
                         }
-                    )
+                    ) from None
                 elif data_obj.data_type == Data.DataType.DATETIME:
                     raise ValidationError(
                         {
@@ -115,8 +115,8 @@ class DataValueModelSerializer(wb_serializers.ModelSerializer):
                                 "Invalid value for this data type. Please use a datetime formatted to 'day.month.year hour:minute:second' in the 24h format."
                             )
                         }
-                    )
-                raise ValidationError({"value": _("Invalid value for this data type.")})
+                    ) from None
+                raise ValidationError({"value": _("Invalid value for this data type.")}) from e
 
         return data
 

wbcore/contrib/workflow/serializers/process.py

@@ -35,7 +35,9 @@ class ProcessModelSerializer(wb_serializers.ModelSerializer):
             return {}
         return {
             "process_steps": reverse(
-                "wbcore:workflow:processstep-process-list", args=[instance.pk], request=self.context["request"]
+                "wbcore:workflow:processstep-process-list",
+                args=[instance.pk],
+                request=self.context["request"],
             )
         }
 
@@ -154,7 +156,6 @@ class AssignedProcessStepSerializer(wb_serializers.ModelSerializer):
 
         if not self.context.get("request"):
             return ""
-
         instance_object = obj.process.instance if obj.process.instance else obj
         return reverse(
             f"{instance_object.get_endpoint_basename()}-detail",

wbcore/contrib/workflow/tests/conftest.py

@@ -1,6 +1,8 @@
 import pytest
 from django.apps import apps
 from django.db.backends.base.base import BaseDatabaseWrapper
+from pytest_mock import MockerFixture
+from rest_framework.test import APIRequestFactory, APIClient
 from django.db.models.signals import pre_migrate
 from pytest_factoryboy import register
 from wbcore.contrib.geography.tests.signals import app_pre_migration
@@ -23,6 +25,24 @@ from wbcore.contrib.workflow.factories import (
     UserStepFactory,
     WorkflowFactory,
 )
+from wbcore.contrib.authentication.factories import PermissionFactory
+
+from wbcore.contrib.workflow.models import (
+    ProcessStep,
+    Step,
+)
+
+from wbcore.contrib.workflow.serializers import (
+    AssignedProcessStepSerializer,
+    ConditionModelSerializer,
+    DataModelSerializer,
+    DecisionStepModelSerializer,
+    ProcessModelSerializer,
+    ProcessStepModelSerializer,
+    TransitionModelSerializer,
+    WorkflowModelSerializer,
+)
+
 from wbcore.tests.conftest import *
 
 register(WorkflowFactory)
@@ -44,6 +64,210 @@ register(DataValueFactory)
 register(StartStepFactory)
 
 
+# ============================== General Fixtures ==============================
+
+
+@pytest.fixture
+def api_client(super_user):
+    client = APIClient()
+    client.force_authenticate(user=super_user)
+    return client
+
+
+@pytest.fixture
+def request_factory():
+    return APIRequestFactory()
+
+
+@pytest.fixture
+def super_user(django_db_setup, django_db_blocker):
+    return UserFactory(is_superuser=True)
+
+
+@pytest.fixture
+def user(django_db_setup, django_db_blocker):
+    with django_db_blocker.unblock():
+        return UserFactory(is_superuser=False)
+
+
+@pytest.fixture()
+def user_step():
+    return UserStepFactory(step_type=Step.StepType.USERSTEP)
+
+
+@pytest.fixture
+def permission(django_db_setup, django_db_blocker):
+    with django_db_blocker.unblock():
+        return PermissionFactory()
+
+
+# ============================== Condition Fixtures ==============================
+
+
+@pytest.fixture
+def condition(conditions):
+    return conditions[0]
+
+
+@pytest.fixture
+def condition_build():
+    transition = TransitionFactory()
+    instance = ConditionFactory.build(transition=transition)
+    return ConditionModelSerializer(instance).data
+
+
+@pytest.fixture
+def conditions():
+    return ConditionFactory.create_batch(3)
+
+
+# ============================== Data Fixtures ==============================
+
+
+@pytest.fixture
+def data():
+    return DataFactory.create_batch(3)
+
+
+@pytest.fixture
+def data_build(workflow):
+    instance = DataFactory.build(workflow=workflow)
+    return DataModelSerializer(instance).data
+
+
+@pytest.fixture
+def singular_data(data):
+    return data[0]
+
+
+# ============================== Decision Step Fixtures ==============================
+
+
+@pytest.fixture
+def decision_step(decision_steps):
+    return decision_steps[0]
+
+
+@pytest.fixture
+def decision_step_build(workflow):
+    instance = DecisionStepFactory.build(workflow=workflow)
+    return DecisionStepModelSerializer(instance).data
+
+
+@pytest.fixture
+def decision_steps():
+    return DecisionStepFactory.create_batch(3)
+
+
+# ============================== Process Fixtures ==============================
+
+
+@pytest.fixture
+def process(processes):
+    return processes[0]
+
+
+@pytest.fixture
+def process_build():
+    instance = ProcessFactory.build()
+    return ProcessModelSerializer(instance).data
+
+
+@pytest.fixture
+def processes():
+    return ProcessFactory.create_batch(3)
+
+
+# ============================== Process Step Fixtures ==============================
+
+
+@pytest.fixture
+def process_step(process_steps):
+    return process_steps[0]
+
+
+@pytest.fixture
+def process_steps():
+    return ProcessStepFactory.create_batch(3)
+
+
+@pytest.fixture
+def process_steps_build():
+    instance = ProcessStepFactory.build()
+    return ProcessStepModelSerializer(instance).data
+
+
+@pytest.fixture
+def mocked_process_step(mocker: MockerFixture):
+    return mocker.MagicMock(spec=ProcessStep)
+
+
+# ============================== Assigned Process Step Fixtures ==============================
+
+
+@pytest.fixture
+def assigned_process_step(assigned_process_steps):
+    return assigned_process_steps[0]
+
+
+@pytest.fixture
+def assigned_process_steps(super_user, user_step):
+    return ProcessStepFactory.create_batch(
+        3,
+        step=user_step,
+        state=ProcessStep.StepState.ACTIVE,
+        assignee=super_user,
+    )
+
+
+@pytest.fixture
+def assigned_process_steps_build(super_user, user_step):
+    instance = ProcessStepFactory.build(
+        step=user_step, state=ProcessStep.StepState.ACTIVE, assignee=super_user
+    )
+    return AssignedProcessStepSerializer(instance).data
+
+
+# ============================== Transition Fixtures ==============================
+
+
+@pytest.fixture
+def transition(transitions):
+    return transitions[0]
+
+
+@pytest.fixture
+def transition_build():
+    to_step = FinishStepFactory()
+    from_step = StartStepFactory(workflow=to_step.workflow)
+    instance = TransitionFactory.build(to_step=to_step, from_step=from_step)
+    return TransitionModelSerializer(instance).data
+
+
+@pytest.fixture
+def transitions():
+    return TransitionFactory.create_batch(3)
+
+
+# ============================== Workflow Fixtures ==============================
+
+
+@pytest.fixture
+def workflow(workflows):
+    return workflows[0]
+
+
+@pytest.fixture
+def workflow_build():
+    instance = WorkflowFactory.build()
+    return WorkflowModelSerializer(instance).data
+
+
+@pytest.fixture
+def workflows():
+    return WorkflowFactory.create_batch(3)
+
+
 @pytest.fixture(autouse=True, scope="session")
 def django_test_environment(django_test_environment):
     from django.apps import apps