Provide the dynamic_payload field

go.mod

@@ -80,6 +80,8 @@ require (
 	golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd // indirect
 	golang.org/x/sys v0.0.0-20220114195835-da31bd327af9 // indirect
 	golang.org/x/text v0.3.7 // indirect
+	golang.org/x/tools v0.1.9-0.20211216111533-8d383106f7e7 // indirect
+	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/protobuf v1.26.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect

go.sum

@@ -881,6 +881,7 @@ golang.org/x/tools v0.1.2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.3/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
+golang.org/x/tools v0.1.9-0.20211216111533-8d383106f7e7 h1:M1gcVrIb2lSn2FIL19DG0+/b8nNVKJ7W7b4WcAGZAYM=
 golang.org/x/tools v0.1.9-0.20211216111533-8d383106f7e7/go.mod h1:nABZi5QlRsZVlzPpHl034qft6wpY4eDcsTt5AaioBiU=
 golang.org/x/xerrors v0.0.0-20190410155217-1f06c39b4373/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20190513163551-3ee3066db522/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

internal/interactor/deployment.go

@@ -71,31 +71,37 @@ type (
 // Deploy posts a new deployment to SCM with the payload.
 // But if it requires a review, it saves the payload on the store and waits until reviewed.
 // It returns an error for a undeployable payload.
-func (i *DeploymentInteractor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) (*ent.Deployment, error) {
+func (i *DeploymentInteractor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, t *ent.Deployment, env *extent.Env) (*ent.Deployment, error) {
 	number, err := i.store.GetNextDeploymentNumberOfRepo(ctx, r)
 	if err != nil {
 		return nil, e.NewError(e.ErrorCodeInternalError, err)
 	}
 
 	i.log.Debug("Get the next number, and build the deployment.")
-	d = &ent.Deployment{
+	d := &ent.Deployment{
 		Number:                number,
-		Type:                  d.Type,
-		Env:                   d.Env,
-		Ref:                   d.Ref,
+		Type:                  t.Type,
+		Env:                   t.Env,
+		Ref:                   t.Ref,
 		Status:                deployment.DefaultStatus,
 		ProductionEnvironment: env.IsProductionEnvironment(),
-		IsRollback:            d.IsRollback,
+		IsRollback:            t.IsRollback,
 		UserID:                u.ID,
 		RepoID:                r.ID,
 	}
 
+	if env.IsDynamicPayloadEnabled() {
+		i.log.Debug("Set the dynamic payload.")
+		d.DynamicPayload = t.DynamicPayload
+	}
+
 	i.log.Debug("Validate the deployment before a request.")
 	v := NewDeploymentValidator([]Validator{
 		&RefValidator{Env: env},
 		&FrozenWindowValidator{Env: env},
 		&LockValidator{Repo: r, Store: i.store},
 		&SerializationValidator{Env: env, Store: i.store},
+		&DynamicPayloadValidator{Env: env},
 	})
 	if err := v.Validate(d); err != nil {
 		return nil, err

internal/interactor/validator.go

@@ -168,3 +168,17 @@ func (v *SerializationValidator) Validate(d *ent.Deployment) error {
 
 	return err
 }
+
+// DynamicPayloadValidator validate the payload with
+// the specifications defined in the configuration file.
+type DynamicPayloadValidator struct {
+	Env *extent.Env
+}
+
+func (v *DynamicPayloadValidator) Validate(d *ent.Deployment) error {
+	if !v.Env.IsDynamicPayloadEnabled() {
+		return nil
+	}
+
+	return v.Env.ValidateDynamicPayload(d.DynamicPayload)
+}

internal/pkg/github/deployment.go

@@ -13,6 +13,12 @@ import (
 )
 
 func (g *Github) CreateRemoteDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) (*extent.RemoteDeployment, error) {
+	// If there is a dynamic payload, set it as the payload.
+	payload := env.Payload
+	if d.DynamicPayload != nil {
+		payload = d.DynamicPayload
+	}
+
 	gd, res, err := g.Client(ctx, u.Token).
 		Repositories.
 		CreateDeployment(ctx, r.Namespace, r.Name, &github.DeploymentRequest{
@@ -22,7 +28,7 @@ func (g *Github) CreateRemoteDeployment(ctx context.Context, u *ent.User, r *ent
 			Description:           env.Description,
 			AutoMerge:             env.AutoMerge,
 			RequiredContexts:      env.RequiredContexts,
-			Payload:               env.Payload,
+			Payload:               payload,
 			ProductionEnvironment: env.ProductionEnvironment,
 		})
 	if res.StatusCode == http.StatusConflict {

internal/pkg/store/deployment.go

@@ -265,6 +265,7 @@ func (s *Store) CreateDeployment(ctx context.Context, d *ent.Deployment) (*ent.D
 		SetType(d.Type).
 		SetRef(d.Ref).
 		SetEnv(d.Env).
+		SetDynamicPayload(d.DynamicPayload).
 		SetUID(d.UID).
 		SetSha(d.Sha).
 		SetHTMLURL(d.HTMLURL).
@@ -277,10 +278,7 @@ func (s *Store) CreateDeployment(ctx context.Context, d *ent.Deployment) (*ent.D
 	if ent.IsConstraintError(err) {
 		return nil, e.NewError(e.ErrorCodeDeploymentConflict, err)
 	} else if ent.IsValidationError(err) {
-		return nil, e.NewErrorWithMessage(
-			e.ErrorCodeEntityUnprocessable,
-			fmt.Sprintf("Failed to create a deployment. The value of \"%s\" field is invalid.", err.(*ent.ValidationError).Name),
-			err)
+		return nil, e.NewErrorWithMessage(e.ErrorCodeEntityUnprocessable, fmt.Sprintf("Failed to create a deployment. The value of \"%s\" field is invalid.", err.(*ent.ValidationError).Name), err)
 	} else if err != nil {
 		return nil, e.NewError(e.ErrorCodeInternalError, err)
 	}

internal/server/api/v1/repos/deployment_create.go

@@ -16,9 +16,10 @@ import (
 
 type (
 	DeploymentPostPayload struct {
-		Type string `json:"type"`
-		Ref  string `json:"ref"`
-		Env  string `json:"env"`
+		Type           string                 `json:"type"`
+		Ref            string                 `json:"ref"`
+		Env            string                 `json:"env"`
+		DynamicPayload map[string]interface{} `json:"dynamic_payload"`
 	}
 )
 
@@ -56,9 +57,10 @@ func (s *DeploymentAPI) Create(c *gin.Context) {
 
 	d, err := s.i.Deploy(ctx, u, re,
 		&ent.Deployment{
-			Type: deployment.Type(p.Type),
-			Env:  p.Env,
-			Ref:  p.Ref,
+			Type:           deployment.Type(p.Type),
+			Env:            p.Env,
+			Ref:            p.Ref,
+			DynamicPayload: p.DynamicPayload,
 		},
 		env)
 	if err != nil {