Feature: Workflows

Allow basic CRUD of workflows and stages, linking to projects and moving tasks
around. Only a minimum set of fields are exposed since the API is not public
available yet.

Author: rafaeljusto

projects/main_test.go

@@ -27,6 +27,8 @@ var testResources struct {
 	MilestoneID       int64
 	TagID             int64
 	MessageID         int64
+	WorkflowID        int64
+	WorkflowStageID   int64
 }
 
 func TestMain(m *testing.M) {
@@ -154,6 +156,41 @@ func TestMain(m *testing.M) {
 	defer messageCleanup()
 	testResources.MessageID = messageID
 
+	workflowID, workflowCleanup, err := createWorkflow(testEngine)
+	if err != nil {
+		logger.Error("Failed to create workflow for tests",
+			slog.String("error", err.Error()),
+		)
+		exitCode = 1
+		return
+	}
+	defer workflowCleanup()
+	testResources.WorkflowID = workflowID
+
+	_, err = projects.WorkflowProjectLink(
+		testEngine.Context(),
+		engine,
+		projects.NewWorkflowProjectLinkRequest(workflowID, projectID),
+	)
+	if err != nil {
+		logger.Error("Failed to link project to workflow for tests",
+			slog.String("error", err.Error()),
+		)
+		exitCode = 1
+		return
+	}
+
+	workflowStageID, workflowStageCleanup, err := createWorkflowStage(testEngine, workflowID)
+	if err != nil {
+		logger.Error("Failed to create workflow stage for tests",
+			slog.String("error", err.Error()),
+		)
+		exitCode = 1
+		return
+	}
+	defer workflowStageCleanup()
+	testResources.WorkflowStageID = workflowStageID
+
 	exitCode = m.Run()
 }
 
@@ -570,6 +607,41 @@ func createMessageReply(t testEngine, messageID int64) (int64, func(), error) {
 	}, nil
 }
 
+func createWorkflow(t testEngine) (int64, func(), error) {
+	workflow, err := projects.WorkflowCreate(t.Context(), engine, projects.NewWorkflowCreateRequest(
+		fmt.Sprintf("test%d%d", time.Now().UnixNano(), rand.Intn(100)),
+	))
+	if err != nil {
+		return 0, nil, fmt.Errorf("failed to create workflow for test: %w", err)
+	}
+	id := workflow.Workflow.ID
+	return id, func() {
+		ctx := context.Background() // t.Context is always canceled in cleanup
+		_, err := projects.WorkflowDelete(ctx, engine, projects.NewWorkflowDeleteRequest(id))
+		if err != nil {
+			t.Errorf("failed to delete workflow after test: %s", err)
+		}
+	}, nil
+}
+
+func createWorkflowStage(t testEngine, workflowID int64) (int64, func(), error) {
+	stage, err := projects.WorkflowStageCreate(t.Context(), engine, projects.NewWorkflowStageCreateRequest(
+		workflowID,
+		fmt.Sprintf("test%d%d", time.Now().UnixNano(), rand.Intn(100)),
+	))
+	if err != nil {
+		return 0, nil, fmt.Errorf("failed to create workflow stage for test: %w", err)
+	}
+	id := stage.Stage.ID
+	return id, func() {
+		ctx := context.Background() // t.Context is always canceled in cleanup
+		_, err := projects.WorkflowStageDelete(ctx, engine, projects.NewWorkflowStageDeleteRequest(workflowID, id))
+		if err != nil {
+			t.Errorf("failed to delete workflow stage after test: %s", err)
+		}
+	}, nil
+}
+
 type testEngine interface {
 	Context() context.Context
 	Errorf(string, ...any)

projects/task.go

@@ -85,6 +85,9 @@ type Task struct {
 	// can be started or completed.
 	Predecessors []twapi.Relationship `json:"predecessors"`
 
+	// WorkflowStages is the list of workflow stages associated with this task.
+	WorkflowStages []TaskWorkflowStage `json:"workflowStages"`
+
 	// CreatedBy is the ID of the user who created the task.
 	CreatedBy *int64 `json:"createdBy"`
 
@@ -146,6 +149,19 @@ type TaskPredecessor struct {
 	Type TaskPredecessorType `json:"type"`
 }
 
+// TaskWorkflowStage represents the workflow stage associated with a task. This
+// is used when creating or updating a task to set the workflow stage of the
+// task.
+type TaskWorkflowStage struct {
+	// WorkflowID is the unique identifier of the workflow associated with the
+	// task.
+	WorkflowID *int64 `json:"workflowId"`
+
+	// StageID is the unique identifier of the workflow stage associated with the
+	// task.
+	StageID *int64 `json:"stageId"`
+}
+
 // TaskUpdateRequestPath contains the path parameters for creating a
 // task.
 type TaskCreateRequestPath struct {