From 35e81a2845d5c5800580d8d193ad7c265439d20f Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Sun, 7 Jan 2024 12:13:12 -0800
Subject: [PATCH] Better document workflow existing custom field test

---
 src/documents/tests/test_workflows.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/documents/tests/test_workflows.py b/src/documents/tests/test_workflows.py
index de6e07552..b4ad4aa57 100644
--- a/src/documents/tests/test_workflows.py
+++ b/src/documents/tests/test_workflows.py
@@ -999,6 +999,14 @@ class TestWorkflows(DirectoriesMixin, FileSystemAssertsMixin, APITestCase):
         self.assertEqual(doc.custom_fields.all().count(), 1)
 
     def test_document_updated_workflow_existing_custom_field(self):
+        """
+        GIVEN:
+            - Existing workflow with UPDATED trigger and action that adds a custom field
+        WHEN:
+            - Document is updated that already contains the field
+        THEN:
+            - Document update succeeds without trying to re-create the field
+        """
         trigger = WorkflowTrigger.objects.create(
             type=WorkflowTrigger.WorkflowTriggerType.DOCUMENT_UPDATED,
             filter_has_document_type=self.dt,