feat: add before_action and after_action for blueprint

models/blueprint.go

@@ -47,6 +47,8 @@ func (Blueprint) TableName() string {
 type BlueprintSettings struct {
 	Version     string          `json:"version" validate:"required,semver,oneof=1.0.0"`
 	Connections json.RawMessage `json:"connections" validate:"required"`
+	BeforePlan  json.RawMessage `json:"before_plan"`
+	AfterPlan   json.RawMessage `json:"after_plan"`
 }
 
 // UnmarshalPlan unmarshals Plan in JSON to strong-typed core.PipelinePlan

services/blueprint.go

@@ -280,7 +280,34 @@ func GeneratePlanJsonV100(settings *models.BlueprintSettings) (core.PipelinePlan
 			return nil, fmt.Errorf("plugin %s does not support blueprint protocol version 1.0.0", connection.Plugin)
 		}
 	}
-	return MergePipelinePlans(plans...), nil
+
+	mergedPipelinePlan := MergePipelinePlans(plans...)
+	return FormatPipelinePlans(settings.BeforePlan, mergedPipelinePlan, settings.AfterPlan)
+}
+
+// FormatPipelinePlans merges multiple pipelines and append before and after pipeline
+func FormatPipelinePlans(beforePlanJson json.RawMessage, mainPlan core.PipelinePlan, afterPlanJson json.RawMessage) (core.PipelinePlan, error) {
+	newPipelinePlan := core.PipelinePlan{}
+	if beforePlanJson != nil {
+		beforePipelinePlan := core.PipelinePlan{}
+		err := json.Unmarshal(beforePlanJson, &beforePipelinePlan)
+		if err != nil {
+			return nil, err
+		}
+		newPipelinePlan = append(newPipelinePlan, beforePipelinePlan...)
+	}
+
+	newPipelinePlan = append(newPipelinePlan, mainPlan...)
+
+	if afterPlanJson != nil {
+		afterPipelinePlan := core.PipelinePlan{}
+		err := json.Unmarshal(afterPlanJson, &afterPipelinePlan)
+		if err != nil {
+			return nil, err
+		}
+		newPipelinePlan = append(newPipelinePlan, afterPipelinePlan...)
+	}
+	return newPipelinePlan, nil
 }
 
 // MergePipelinePlans merges multiple pipelines into one unified pipeline

services/blueprint_test.go

@@ -18,6 +18,7 @@ limitations under the License.
 package services
 
 import (
+	"encoding/json"
 	"testing"
 
 	"github.com/apache/incubator-devlake/plugins/core"
@@ -92,3 +93,45 @@ func TestMergePipelineTasks(t *testing.T) {
 		MergePipelinePlans(plan1, plan2, plan3),
 	)
 }
+
+func TestFormatPipelinePlans(t *testing.T) {
+	beforePlan2 := json.RawMessage(`[[{"plugin":"github"},{"plugin":"gitlab"}],[{"plugin":"gitextractor1"},{"plugin":"gitextractor2"}]]`)
+
+	mainPlan := core.PipelinePlan{
+		{
+			{Plugin: "jira"},
+		},
+	}
+
+	afterPlan2 := json.RawMessage(`[[{"plugin":"jenkins"}],[{"plugin":"jenkins"}]]`)
+
+	result1, err1 := FormatPipelinePlans(nil, mainPlan, nil)
+	assert.Nil(t, err1)
+	assert.Equal(t, mainPlan, result1)
+
+	result2, err2 := FormatPipelinePlans(beforePlan2, mainPlan, afterPlan2)
+	assert.Nil(t, err2)
+	assert.Equal(t, core.PipelinePlan{
+		{
+			{Plugin: "github"},
+			{Plugin: "gitlab"},
+		},
+		{
+			{Plugin: "gitextractor1"},
+			{Plugin: "gitextractor2"},
+		},
+		{
+			{Plugin: "jira"},
+		},
+		{
+			{Plugin: "jenkins"},
+		},
+		{
+			{Plugin: "jenkins"},
+		},
+	}, result2)
+
+	result3, err3 := FormatPipelinePlans(json.RawMessage("[]"), mainPlan, json.RawMessage("[]"))
+	assert.Nil(t, err3)
+	assert.Equal(t, mainPlan, result3)
+}