feat(workflows): u#2860 t#4028 update workflow endpoint

kaleidos-ventures · Sep 26, 2023 · 55a86ff · 55a86ff · github-actions · Sep 26, 2023
1 parent a6d8241
commit 55a86ff
Show file tree

Hide file tree

Showing 13 changed files with 336 additions and 11 deletions.
diff --git a/python/apps/taiga/src/taiga/workflows/api/__init__.py b/python/apps/taiga/src/taiga/workflows/api/__init__.py
@@ -12,7 +12,7 @@
 from taiga.base.api.permissions import check_permissions
 from taiga.base.validators import B64UUID
 from taiga.exceptions import api as ex
-from taiga.exceptions.api.errors import ERROR_403, ERROR_404, ERROR_422
+from taiga.exceptions.api.errors import ERROR_400, ERROR_403, ERROR_404, ERROR_422
 from taiga.permissions import HasPerm, IsProjectAdmin
 from taiga.projects.projects.api import get_project_or_404
 from taiga.routers import routes
@@ -23,6 +23,7 @@
     DeleteWorkflowStatusQuery,
     ReorderWorkflowStatusesValidator,
     UpdateWorkflowStatusValidator,
+    UpdateWorkflowValidator,
 )
 from taiga.workflows.models import Workflow, WorkflowStatus
 from taiga.workflows.serializers import ReorderWorkflowStatusesSerializer, WorkflowSerializer, WorkflowStatusSerializer
@@ -31,6 +32,7 @@
 CREATE_WORKFLOW = IsProjectAdmin()
 LIST_WORKFLOWS = HasPerm("view_story")
 GET_WORKFLOW = HasPerm("view_story")
+UPDATE_WORKFLOW = IsProjectAdmin()
 CREATE_WORKFLOW_STATUS = IsProjectAdmin()
 UPDATE_WORKFLOW_STATUS = IsProjectAdmin()
 DELETE_WORKFLOW_STATUS = IsProjectAdmin()
@@ -117,6 +119,34 @@ async def get_workflow(
     return await workflows_services.get_workflow_detail(project_id=project_id, workflow_slug=workflow_slug)
 
 
+##########################################################
+# update workflow
+##########################################################
+
+
+@routes.workflows.patch(
+    "/projects/{project_id}/workflows/{workflow_slug}",
+    name="project.workflow.update",
+    summary="Update workflow",
+    responses=GET_WORKFLOW_200 | ERROR_400 | ERROR_403 | ERROR_404 | ERROR_422,
+    response_model=None,
+)
+async def update_workflow(
+    project_id: B64UUID,
+    workflow_slug: str,
+    request: AuthRequest,
+    form: UpdateWorkflowValidator,
+) -> WorkflowSerializer:
+    """
+    Update workflow
+    """
+    workflow = await get_workflow_or_404(project_id=project_id, workflow_slug=workflow_slug)
+    await check_permissions(permissions=UPDATE_WORKFLOW, user=request.user, obj=workflow)
+
+    values = form.dict(exclude_unset=True)
+    return await workflows_services.update_workflow(project_id=project_id, workflow=workflow, values=values)
+
+
 ################################################
 # misc
 ################################################

diff --git a/python/apps/taiga/src/taiga/workflows/api/validators.py b/python/apps/taiga/src/taiga/workflows/api/validators.py
@@ -36,6 +36,10 @@ class CreateWorkflowStatusValidator(BaseModel):
     color: conint(gt=0, lt=9)  # type: ignore
 
 
+class UpdateWorkflowValidator(BaseModel):
+    name: WorkflowName
+
+
 class UpdateWorkflowStatusValidator(BaseModel):
     name: WorkflowStatusName | None
 

diff --git a/python/apps/taiga/src/taiga/workflows/events/__init__.py b/python/apps/taiga/src/taiga/workflows/events/__init__.py
@@ -12,12 +12,14 @@
     CreateWorkflowStatusContent,
     DeleteWorkflowStatusContent,
     ReorderWorkflowStatusesContent,
+    UpdateWorkflowContent,
     UpdateWorkflowStatusContent,
 )
 from taiga.workflows.models import WorkflowStatus
 from taiga.workflows.serializers import ReorderWorkflowStatusesSerializer, WorkflowSerializer
 
 CREATE_WORKFLOW = "workflows.create"
+UPDATE_WORKFLOW = "workflows.update"
 CREATE_WORKFLOW_STATUS = "workflowstatuses.create"
 UPDATE_WORKFLOW_STATUS = "workflowstatuses.update"
 REORDER_WORKFLOW_STATUS = "workflowstatuses.reorder"
@@ -32,6 +34,16 @@ async def emit_event_when_workflow_is_created(project: Project, workflow: Workfl
     )
 
 
+async def emit_event_when_workflow_is_updated(project: Project, workflow: WorkflowSerializer) -> None:
+    await events_manager.publish_on_project_channel(
+        project=project,
+        type=UPDATE_WORKFLOW,
+        content=UpdateWorkflowContent(
+            workflow=workflow,
+        ),
+    )
+
+
 async def emit_event_when_workflow_status_is_created(project: Project, workflow_status: WorkflowStatus) -> None:
     await events_manager.publish_on_project_channel(
         project=project,

diff --git a/python/apps/taiga/src/taiga/workflows/events/content.py b/python/apps/taiga/src/taiga/workflows/events/content.py
@@ -13,6 +13,10 @@ class CreateWorkflowContent(BaseModel):
     workflow: WorkflowSerializer
 
 
+class UpdateWorkflowContent(BaseModel):
+    workflow: WorkflowSerializer
+
+
 class CreateWorkflowStatusContent(BaseModel):
     workflow_status: WorkflowStatusSerializer
 

diff --git a/python/apps/taiga/src/taiga/workflows/models.py b/python/apps/taiga/src/taiga/workflows/models.py
@@ -45,13 +45,12 @@ def __repr__(self) -> str:
         return f"<Workflow {self.name}>"
 
     def save(self, *args: Any, **kwargs: Any) -> None:
-        if not self.slug:
-            self.slug = slugify_uniquely_for_queryset(
-                value=self.name,
-                queryset=self.project.workflows.all(),
-                generate_suffix=generate_incremental_int_suffix(),
-                use_always_suffix=False,
-            )
+        self.slug = slugify_uniquely_for_queryset(
+            value=self.name,
+            queryset=self.project.workflows.all(),
+            generate_suffix=generate_incremental_int_suffix(),
+            use_always_suffix=False,
+        )
 
         super().save(*args, **kwargs)
 

diff --git a/python/apps/taiga/src/taiga/workflows/repositories.py b/python/apps/taiga/src/taiga/workflows/repositories.py
@@ -148,6 +148,20 @@ def get_workflow(
         return None
 
 
+##########################################################
+# update workflow
+##########################################################
+
+
+@sync_to_async
+def update_workflow(workflow: Workflow, values: dict[str, Any] = {}) -> Workflow:
+    for attr, value in values.items():
+        setattr(workflow, attr, value)
+
+    workflow.save()
+    return workflow
+
+
 ##########################################################
 # WorkflowStatus - filters and querysets
 ##########################################################

diff --git a/python/apps/taiga/src/taiga/workflows/services/__init__.py b/python/apps/taiga/src/taiga/workflows/services/__init__.py
@@ -118,6 +118,24 @@ async def get_workflow_detail(project_id: UUID, workflow_slug: str) -> WorkflowS
     return serializers_services.serialize_workflow(workflow=workflow, workflow_statuses=workflow_statuses)
 
 
+##########################################################
+# update workflow
+##########################################################
+
+
+async def update_workflow(project_id: UUID, workflow: Workflow, values: dict[str, Any] = {}) -> WorkflowSerializer:
+    updated_workflow = await workflows_repositories.update_workflow(workflow=workflow, values=values)
+    updated_workflow_detail = await get_workflow_detail(project_id=project_id, workflow_slug=updated_workflow.slug)
+
+    # Emit event
+    await workflows_events.emit_event_when_workflow_is_updated(
+        project=workflow.project,
+        workflow=updated_workflow_detail,
+    )
+
+    return updated_workflow_detail
+
+
 ##########################################################
 # create workflow status
 ##########################################################

diff --git a/python/apps/taiga/tests/integration/taiga/workflows/test_api.py b/python/apps/taiga/tests/integration/taiga/workflows/test_api.py
@@ -143,6 +143,61 @@ async def test_get_workflow_422_unprocessable_project_b64id(client):
     assert response.status_code == status.HTTP_422_UNPROCESSABLE_ENTITY, response.text
 
 
+#################################################################
+# Workflow PATCH /projects/<pj_b64id>/workflows/{wf_slug}
+#################################################################
+
+
+async def test_update_workflow_200_ok(client):
+    project = await f.create_project()
+    workflow = await f.create_workflow(project=project)
+    data = {"name": "updated name"}
+
+    client.login(project.created_by)
+    response = client.patch(f"/projects/{project.b64id}/workflows/{workflow.slug}", json=data)
+    assert response.status_code == status.HTTP_200_OK, response.text
+
+
+async def test_update_workflow_403_forbidden_permissions(client):
+    project = await f.create_project()
+    workflow = await f.create_workflow(project=project)
+    user = await f.create_user()
+    data = {"name": "updated name"}
+
+    client.login(user)
+    response = client.patch(f"/projects/{project.b64id}/workflows/{workflow.slug}", json=data)
+    assert response.status_code == status.HTTP_403_FORBIDDEN, response.text
+
+
+async def test_update_workflow_404_not_found_project_b64id(client):
+    project = await f.create_project()
+    workflow = await f.create_workflow(project=project)
+    data = {"name": "updated name"}
+
+    client.login(project.created_by)
+    response = client.patch(f"/projects/{NOT_EXISTING_B64ID}/workflows/{workflow.slug}", json=data)
+    assert response.status_code == status.HTTP_404_NOT_FOUND, response.text
+
+
+async def test_update_workflow_404_workflow_slug(client):
+    project = await f.create_project()
+    data = {"name": "updated name"}
+
+    client.login(project.created_by)
+    response = client.patch(f"/projects/{project.b64id}/workflows/{NOT_EXISTING_SLUG}", json=data)
+    assert response.status_code == status.HTTP_404_NOT_FOUND, response.text
+
+
+async def test_update_workflow_422_unprocessable_project_b64id(client):
+    project = await f.create_project()
+    workflow = await f.create_workflow(project=project)
+    data = {"name": "updated name"}
+
+    client.login(project.created_by)
+    response = client.patch(f"/projects/{INVALID_B64ID}/workflows/{workflow.slug}", json=data)
+    assert response.status_code == status.HTTP_422_UNPROCESSABLE_ENTITY, response.text
+
+
 ################################################################################
 # WorkflowStatus POST /projects/<pj_b64id>/workflows/<wf_slug>/statuses
 ################################################################################

diff --git a/python/apps/taiga/tests/integration/taiga/workflows/test_repositories.py b/python/apps/taiga/tests/integration/taiga/workflows/test_repositories.py
@@ -73,6 +73,20 @@ async def test_get_project_without_workflow_ok() -> None:
     assert workflow is None
 
 
+##########################################################
+# update_workflow
+##########################################################
+
+
+async def test_update_workflow():
+    workflow = await f.create_workflow()
+    updated_workflow = await repositories.update_workflow(
+        workflow=workflow,
+        values={"name": "Updated name"},
+    )
+    assert updated_workflow.name == "Updated name"
+
+
 ##########################################################
 # create_workflow_status
 ##########################################################

diff --git a/python/apps/taiga/tests/unit/taiga/workflows/test_services.py b/python/apps/taiga/tests/unit/taiga/workflows/test_services.py
@@ -116,6 +116,29 @@ async def test_get_detailed_workflow_ok():
         fake_workflows_repo.get_workflow.assert_awaited_once()
 
 
+#######################################################
+# update_workflow
+#######################################################
+
+
+async def test_update_workflow_ok():
+    project = f.build_project()
+    workflow = f.build_workflow(project=project)
+    values = {"name": "updated name"}
+
+    with (
+        patch("taiga.workflows.services.workflows_repositories", autospec=True) as fake_workflows_repo,
+        patch("taiga.workflows.services.get_workflow_detail", autospec=True),
+        patch("taiga.workflows.services.workflows_events", autospec=True) as fake_workflows_events,
+    ):
+        updated_workflow = await services.update_workflow(project_id=project.id, workflow=workflow, values=values)
+        fake_workflows_repo.update_workflow.assert_awaited_once_with(workflow=workflow, values=values)
+        fake_workflows_events.emit_event_when_workflow_is_updated.assert_awaited_once_with(
+            project=project,
+            workflow=updated_workflow,
+        )
+
+
 #######################################################
 # create_workflow_status
 #######################################################

diff --git a/python/docs/events.md b/python/docs/events.md
@@ -669,6 +669,19 @@ Content for:
   ```
 
 
+#### `workflows.update`
+
+It happens when a workflow has been updated.
+
+Content for:
+- project channel:
+  ```
+  {
+      "workflow": {... "workflow object" ...}
+  }
+  ```
+
+
 #### `workflowstatuses.create`
 
 It happens when a new workflow status has been created.

diff --git a/python/docs/postman/taiga.postman_collection.json b/python/docs/postman/taiga.postman_collection.json
@@ -1,6 +1,6 @@
 {
 	"info": {
-		"_postman_id": "302d4e8d-fe62-488f-a80e-cf3520c18277",
+		"_postman_id": "a9dc834f-1ba0-4cc9-907f-f5eac02b8f85",
 		"name": "taiga-next",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
 		"_exporter_id": "9835734"
@@ -2356,7 +2356,9 @@
 							"script": {
 								"exec": [
 									"// Post-request execution tasks",
-									""
+									"pm.test(\"Environment variable settings\", function () {",
+									"    pm.environment.set(\"wf-slug\", pm.response.json().slug);",
+									"});"
 								],
 								"type": "text/javascript"
 							}
@@ -2501,6 +2503,64 @@
 					},
 					"response": []
 				},
+				{
+					"name": "update workflow",
+					"event": [
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"// Post-request execution tasks",
+									"pm.test(\"Environment variable settings\", function () {",
+									"       pm.environment.set(\"ref1\", pm.response.json().ref);",
+									"       pm.environment.set(\"story_ref\", pm.response.json().ref);",
+									"});"
+								],
+								"type": "text/javascript"
+							}
+						}
+					],
+					"protocolProfileBehavior": {
+						"disabledSystemHeaders": {}
+					},
+					"request": {
+						"auth": {
+							"type": "bearer",
+							"bearer": [
+								{
+									"key": "token",
+									"value": "{{auth_token}}",
+									"type": "string"
+								}
+							]
+						},
+						"method": "PATCH",
+						"header": [],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"name\": \"updated workflow\"\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "{{protocol}}://{{domain}}{{port}}{{api_url}}/projects/{{pj-id}}/workflows/{{wf-slug}}",
+							"protocol": "{{protocol}}",
+							"host": [
+								"{{domain}}{{port}}{{api_url}}"
+							],
+							"path": [
+								"projects",
+								"{{pj-id}}",
+								"workflows",
+								"{{wf-slug}}"
+							]
+						}
+					},
+					"response": []
+				},
 				{
 					"name": "create workflow status",
 					"event": [
File	Stmts	Miss	Cover	Missing
src/taiga
__main__.py	71	71	0%	17–155
src/taiga/attachments
admin.py	27	3	90%	25, 28, 70
events.py	8	2	75%	15, 20
models.py	19	2	89%	61, 64
repositories.py	49	1	97%	62
src/taiga/auth/services
__init__.py	47	0	98%	90–>93
src/taiga/base
mocks.py	74	12	80%	93–94, 107–118, 143–>exit
src/taiga/base/api
permissions.py	49	1	99%	22
requests.py	11	3	80%	15, 21–23
src/taiga/base/db
__init__.py	4	1	75%	15
commands.py	54	54	0%	8–271
sequences.py	45	2	97%	91–92
src/taiga/base/db/admin
forms.py	14	8	38%	17–25
utils.py	11	7	36%	17–23
src/taiga/base/db/models
fields.py	15	1	88%	20
src/taiga/base/django
__init__.py	5	2	60%	17–19
settings.py	30	2	93%	16–17
urls.py	3	3	0%	8–11
src/taiga/base/i18n
__init__.py	102	9	88%	171–>170, 173–>170, 192–193, 203–205, 215, 268, 279, 283
choices.py	34	2	91%	80, 87
commands.py	74	74	0%	8–108
src/taiga/base/logging
formatters.py	24	10	50%	22–>exit, 38, 44–45, 51–60
middlewares.py	23	1	96%	20
src/taiga/base/repositories
neighbors.py	39	3	91%	43–44, 65
src/taiga/base/sampledata
commands.py	11	11	0%	8–40
constants.py	15	15	0%	14–51
demo_data.py	273	273	0%	8–529
factories.py	122	122	0%	9–353
test_data.py	290	290	0%	8–634
src/taiga/base/serializers
fields.py	20	1	96%	21
src/taiga/base/utils
commands.py	31	31	0%	8–60
datetime.py	44	18	60%	54, 67, 126–147
enum.py	14	1	92%	43
images.py	26	3	87%	21–22, 30
json.py	33	15	45%	30–35, 37, 39–44, 46, 50
pprint.py	6	6	0%	8–17
slug.py	23	4	85%	22–25
src/taiga/base/validators/fields
i18n.py	16	2	91%	19–20
uuid.py	15	2	90%	19–20
src/taiga/comments
admin.py	29	3	92%	16, 20, 24
events.py	11	3	73%	15, 20, 25
models.py	20	2	91%	43, 46
src/taiga/commons/storage
commands.py	13	13	0%	8–40
models.py	16	2	88%	38, 41
services.py	9	0	92%	17–>16
tasks.py	9	9	0%	8–19
src/taiga/conf
__init__.py	94	3	95%	112, 128–129
tokens.py	17	1	90%	34
src/taiga/emails
commands.py	35	35	0%	9–68
sender.py	18	5	71%	48–50, 54–73
tasks.py	39	4	90%	44–45, 53–54
src/taiga/events
app.py	18	1	92%	21
events.py	16	2	88%	31–32
logging.py	39	23	31%	18–>exit, 32–48, 51–60
manager.py	117	11	90%	78–79, 223–233, 239–242
responses.py	33	6	84%	33, 37–41
subscriber.py	80	4	95%	51, 55, 88, 91, 108–>120
src/taiga/events/actions
auth.py	23	11	44%	27–32, 39–45
event_handlers.py	9	4	56%	18–20, 28–30
projects.py	55	30	38%	36–40, 48–64, 72–80, 88–96
workspaces.py	55	30	38%	36–40, 48–64, 72–80, 88–96
src/taiga/events/pubsub/backends
base.py	30	1	98%	53
redis.py	66	5	94%	41–43, 85–86
src/taiga/exceptions/api
__init__.py	27	0	97%	28–>30
handlers.py	27	2	90%	27–28
middlewares.py	26	2	87%	37, 41
src/taiga/integrations/auth
services.py	39	7	82%	50–56
src/taiga/integrations/github
services.py	40	0	98%	63–>68
src/taiga/mediafiles
admin.py	20	2	91%	24, 27
models.py	26	2	92%	84, 87
src/taiga/permissions
services.py	103	1	98%	28, 106–>109
src/taiga/permissions/validators
fields.py	24	3	88%	18–19, 45
src/taiga/projects/invitations
models.py	25	2	92%	89, 92
repositories.py	84	1	98%	135
src/taiga/projects/invitations/api
validators.py	65	7	89%	38–40, 65–66, 84–85
src/taiga/projects/invitations/events
__init__.py	33	1	91%	37–>exit, 49–>exit, 74–>exit, 102
src/taiga/projects/invitations/services
__init__.py	183	1	99%	58–>53, 286
src/taiga/projects/memberships
models.py	16	2	88%	51, 54
repositories.py	86	2	97%	91, 124
src/taiga/projects/memberships/events
__init__.py	16	2	88%	18–24
src/taiga/projects/memberships/services
__init__.py	45	1	95%	64–>69, 111
src/taiga/projects/projects
admin.py	53	12	75%	33–34, 39–42, 50–51, 56–59, 90, 94
models.py	61	8	86%	64, 67, 78, 113, 116, 119–121
repositories.py	115	4	96%	125, 126–>129, 155, 254–255
tasks.py	6	1	88%	17
src/taiga/projects/projects/services
__init__.py	107	5	92%	78, 87, 199, 205–>208, 213, 235
src/taiga/projects/references
mixins.py	13	0	93%	25–>28
src/taiga/projects/roles
api.py	35	3	93%	46–48
models.py	26	3	86%	50, 53, 57
repositories.py	44	1	96%	92
src/taiga/projects/roles/services
__init__.py	25	1	94%	24, 57–>62
src/taiga/stories/assignments
models.py	15	2	87%	42, 45
repositories.py	52	1	97%	49
src/taiga/stories/attachments
api.py	51	1	97%	159
serializers.py	11	0	93%	20–>28
src/taiga/stories/comments
api.py	58	1	97%	177
src/taiga/stories/stories
admin.py	25	5	84%	76–81, 85, 89
models.py	25	2	92%	73, 76
src/taiga/stories/stories/services
__init__.py	113	2	97%	233, 256
src/taiga/tasksqueue
app.py	20	2	86%	29–30
commands.py	65	65	0%	8–122
logging.py	33	17	40%	18–>exit, 29–39, 42–51
manager.py	56	13	77%	37, 41, 45, 49, 94, 163, 177, 186, 191, 198, 202, 209, 213
task.py	12	1	92%	23
src/taiga/tokens
admin.py	44	10	81%	67, 70, 73, 76, 104, 108, 112, 116, 120, 124
models.py	30	4	87%	59, 62, 78, 81
src/taiga/users
admin.py	51	7	81%	32, 41, 50, 87–95
commands.py	9	9	0%	8–26
models.py	65	10	86%	71, 74, 90, 93, 97, 100, 103, 106, 127, 130
repositories.py	204	3	98%	209–>212, 335, 428–429
src/taiga/users/api
__init__.py	66	2	96%	216, 304
src/taiga/users/api/validators
__init__.py	42	3	92%	39–41
src/taiga/users/services
__init__.py	244	7	95%	75, 259, 262–>257, 297–>280, 306–>280, 322–>318, 345–>341, 366, 494–>499, 513–520, 521–>526, 524–525
src/taiga/workflows
models.py	40	4	90%	42, 45, 85, 88
src/taiga/workflows/services
__init__.py	113	4	94%	53, 232, 259, 330–>338, 345
src/taiga/workspaces/invitations
models.py	24	2	92%	84, 87
permissions.py	9	1	82%	19
repositories.py	77	1	98%	123
src/taiga/workspaces/invitations/api
validators.py	18	2	88%	24–25
src/taiga/workspaces/invitations/events
__init__.py	25	1	91%	36–>exit, 60–>exit, 71
src/taiga/workspaces/invitations/services
__init__.py	123	1	99%	222
src/taiga/workspaces/memberships
api.py	43	1	96%	126
models.py	15	2	87%	43, 46
repositories.py	63	2	95%	72, 105
src/taiga/workspaces/memberships/services
__init__.py	46	1	97%	117
src/taiga/workspaces/workspaces
admin.py	57	19	62%	25–26, 31–34, 49, 52–57, 61, 65, 73–74, 79–82
models.py	18	2	90%	32, 35
repositories.py	127	2	99%	232–233
src/taiga/workspaces/workspaces/services
__init__.py	54	2	94%	113, 116
TOTAL	9887	1566	83%