Add DynamicPayload field to env

Author: noah

Diff for: model/extent/env.go

@@ -1,54 +1,55 @@
 package extent
 
 import (
+	"fmt"
 	"regexp"
 	"strings"
 	"time"
 
 	"github.com/gitploy-io/cronexpr"
+	"github.com/gitploy-io/gitploy/pkg/e"
 	eutil "github.com/gitploy-io/gitploy/pkg/e"
 )
 
-type (
-	Env struct {
-		Name string `json:"name" yaml:"name"`
+type Env struct {
+	Name string `json:"name" yaml:"name"`
 
-		// GitHub parameters of deployment.
-		Task                  *string     `json:"task" yaml:"task"`
-		Description           *string     `json:"description" yaml:"description"`
-		AutoMerge             *bool       `json:"auto_merge" yaml:"auto_merge"`
-		RequiredContexts      *[]string   `json:"required_contexts,omitempty" yaml:"required_contexts"`
-		Payload               interface{} `json:"payload" yaml:"payload"`
-		ProductionEnvironment *bool       `json:"production_environment" yaml:"production_environment"`
+	// GitHub parameters of deployment.
+	Task                  *string         `json:"task" yaml:"task"`
+	Description           *string         `json:"description" yaml:"description"`
+	AutoMerge             *bool           `json:"auto_merge" yaml:"auto_merge"`
+	RequiredContexts      *[]string       `json:"required_contexts,omitempty" yaml:"required_contexts"`
+	Payload               interface{}     `json:"payload" yaml:"payload"`
+	DynamicPayload        *DynamicPayload `json:"dynamic_payload" yaml:"dynamic_payload"`
+	ProductionEnvironment *bool           `json:"production_environment" yaml:"production_environment"`
 
-		// DeployableRef validates the ref is deployable or not.
-		DeployableRef *string `json:"deployable_ref" yaml:"deployable_ref"`
+	// DeployableRef validates the ref is deployable or not.
+	DeployableRef *string `json:"deployable_ref" yaml:"deployable_ref"`
 
-		// AutoDeployOn deploys automatically when the pattern is matched.
-		AutoDeployOn *string `json:"auto_deploy_on" yaml:"auto_deploy_on"`
+	// AutoDeployOn deploys automatically when the pattern is matched.
+	AutoDeployOn *string `json:"auto_deploy_on" yaml:"auto_deploy_on"`
 
-		// Serialization verify if there is a running deployment.
-		Serialization *bool `json:"serialization" yaml:"serialization"`
+	// Serialization verify if there is a running deployment.
+	Serialization *bool `json:"serialization" yaml:"serialization"`
 
-		// Review is the configuration of Review,
-		// It is disabled when it is empty.
-		Review *Review `json:"review,omitempty" yaml:"review"`
+	// Review is the configuration of Review,
+	// It is disabled when it is empty.
+	Review *Review `json:"review,omitempty" yaml:"review"`
 
-		// FrozenWindows is the list of windows to freeze deployments.
-		FrozenWindows []FrozenWindow `json:"frozen_windows" yaml:"frozen_windows"`
-	}
+	// FrozenWindows is the list of windows to freeze deployments.
+	FrozenWindows []FrozenWindow `json:"frozen_windows" yaml:"frozen_windows"`
+}
 
-	Review struct {
-		Enabled   bool     `json:"enabled" yaml:"enabled"`
-		Reviewers []string `json:"reviewers" yaml:"reviewers"`
-	}
+type Review struct {
+	Enabled   bool     `json:"enabled" yaml:"enabled"`
+	Reviewers []string `json:"reviewers" yaml:"reviewers"`
+}
 
-	FrozenWindow struct {
-		Start    string `json:"start" yaml:"start"`
-		Duration string `json:"duration" yaml:"duration"`
-		Location string `json:"location" yaml:"location"`
-	}
-)
+type FrozenWindow struct {
+	Start    string `json:"start" yaml:"start"`
+	Duration string `json:"duration" yaml:"duration"`
+	Location string `json:"location" yaml:"location"`
+}
 
 // IsProductionEnvironment verifies whether the environment is production or not.
 func (e *Env) IsProductionEnvironment() bool {
@@ -124,3 +125,100 @@ func (e *Env) IsFreezed(t time.Time) (bool, error) {
 
 	return false, nil
 }
+
+func (e *Env) EvaluateDynamicPayload(values map[string]interface{}) (map[string]interface{}, error) {
+	return e.DynamicPayload.Evaluate(values)
+}
+
+// DynamicPayload can be set to dynamically fill in the payload.
+type DynamicPayload struct {
+	Enabled bool             `json:"enabled" yaml:"enabled"`
+	Inputs  map[string]Input `json:"inputs" yaml:"inputs"`
+}
+
+// Evaluate validates the payload. After that,
+// an object containing only the value of the defined field is returned.
+func (dp *DynamicPayload) Evaluate(values map[string]interface{}) (output map[string]interface{}, err error) {
+	for key, input := range dp.Inputs {
+		// If it is a required field, check if the value exists.
+		value, ok := values[key]
+		if !ok {
+			if optional := !(input.Required != nil && *input.Required); optional {
+				continue
+			}
+
+			return nil, e.NewErrorWithMessage(e.ErrorCodeDeploymentInvalid, fmt.Sprintf("The '%s' field is required.", key), nil)
+		}
+
+		eval, err := dp.validate(input, value)
+		if err != nil {
+			return nil, err
+		}
+
+		output[key] = eval
+	}
+
+	return output, nil
+}
+
+func (dp *DynamicPayload) validate(input Input, value interface{}) (interface{}, error) {
+	switch input.Type {
+	case InputTypeSelect:
+		// Checks if the selected value matches the option,
+		// and returns the value if it is.
+		sv, ok := value.(string)
+		if !ok {
+			return nil, e.NewErrorWithMessage(e.ErrorCodeDeploymentInvalid, fmt.Sprintf("The '%v' is not string type.", value), nil)
+		}
+
+		for _, option := range *input.Options {
+			if sv == option {
+				return sv, nil
+			}
+		}
+
+		return nil, e.NewErrorWithMessage(e.ErrorCodeDeploymentInvalid, "The '%s' is not matched with the options.", nil)
+	case InputTypeNumber:
+		nv, ok := value.(float64)
+		if !ok {
+			return nil, e.NewErrorWithMessage(e.ErrorCodeDeploymentInvalid, fmt.Sprintf("The '%v' is not string type.", value), nil)
+		}
+
+		return nv, nil
+	case InputTypeString:
+		sv, ok := value.(string)
+		if !ok {
+			return nil, e.NewErrorWithMessage(e.ErrorCodeDeploymentInvalid, fmt.Sprintf("The '%v' is not string type.", value), nil)
+		}
+
+		return sv, nil
+	case InputTypeBoolean:
+		bv, ok := value.(bool)
+		if !ok {
+			return nil, e.NewErrorWithMessage(e.ErrorCodeDeploymentInvalid, fmt.Sprintf("The '%v' is not string type.", value), nil)
+		}
+
+		return bv, nil
+	default:
+		return nil, e.NewErrorWithMessage(e.ErrorCodeDeploymentInvalid, "The type must be 'select', 'number', 'string', or 'boolean'.", nil)
+	}
+}
+
+// Input defines specifications for input values.
+type Input struct {
+	Type        InputType    `json:"type" yaml:"type"`
+	Required    *bool        `json:"required" yaml:"required"`
+	Default     *interface{} `json:"default" yaml:"default"`
+	Description *string      `json:"description" yaml:"description"`
+	Options     *[]string    `json:"options" yaml:"options"`
+}
+
+// InputType is the type for input.
+type InputType string
+
+const (
+	InputTypeSelect  InputType = "select"
+	InputTypeNumber  InputType = "number"
+	InputTypeString  InputType = "string"
+	InputTypeBoolean InputType = "boolean"
+)

Diff for: pkg/e/code.go

@@ -14,7 +14,7 @@ const (
 
 	// ErrorCodeDeploymentConflict is the deployment number is conflicted.
 	ErrorCodeDeploymentConflict ErrorCode = "deployment_conflict"
-	// ErrorCodeDeploymentInvalid is the payload is invalid when it posts a remote deployment.
+	// ErrorCodeDeploymentInvalid is the payload is invalid.
 	ErrorCodeDeploymentInvalid ErrorCode = "deployment_invalid"
 	// ErrorCodeDeploymentLocked is when the environment is locked.
 	ErrorCodeDeploymentLocked ErrorCode = "deployment_locked"