Fix to evaluation to avoid an escape character error (#250)

* Add a method Eval to Config * Fix to evaluate the configuration in the server
gitploy-io · Nov 23, 2021 · 27656de · 27656de
1 parent 07a24b4
commit 27656de
Show file tree

Hide file tree

Showing 14 changed files with 212 additions and 278 deletions.
diff --git a/internal/interactor/config.go b/internal/interactor/config.go
diff --git a/internal/interactor/config_test.go b/internal/interactor/config_test.go
diff --git a/internal/interactor/deployment.go b/internal/interactor/deployment.go
@@ -37,10 +37,6 @@ func (i *Interactor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *en
 		return nil, err
 	}
 
-	if err := env.Eval(&vo.EvalValues{IsRollback: d.IsRollback}); err != nil {
-		return nil, err
-	}
-
 	number, err := i.Store.GetNextDeploymentNumberOfRepo(ctx, r)
 	if err != nil {
 		return nil, e.NewError(
@@ -139,10 +135,6 @@ func (i *Interactor) DeployToRemote(ctx context.Context, u *ent.User, r *ent.Rep
 		)
 	}
 
-	if err := env.Eval(&vo.EvalValues{IsRollback: d.IsRollback}); err != nil {
-		return nil, err
-	}
-
 	rd, err := i.createRemoteDeployment(ctx, u, r, d, env)
 	if err != nil {
 		return nil, err

diff --git a/internal/interactor/deployment_test.go b/internal/interactor/deployment_test.go
@@ -289,7 +289,7 @@ func TestInteractor_DeployToRemote(t *testing.T) {
 		}
 	})
 
-	t.Run("create a new remote deployment and update the deployment.", func(t *testing.T) {
+	t.Run("Create a new remote deployment and update the deployment.", func(t *testing.T) {
 		input := struct {
 			d *ent.Deployment
 			e *vo.Env

diff --git a/internal/server/api/v1/repos/deployment.go b/internal/server/api/v1/repos/deployment.go
@@ -85,15 +85,23 @@ func (r *Repo) CreateDeployment(c *gin.Context) {
 	vr, _ := c.Get(KeyRepo)
 	re := vr.(*ent.Repo)
 
-	env, err := r.i.GetEnv(ctx, u, re, p.Env)
+	config, err := r.i.GetConfig(ctx, u, re)
 	if e.HasErrorCode(err, e.ErrorCodeEntityNotFound) {
-		r.log.Check(gb.GetZapLogLevel(err), "The configuration file is not found.").Write(zap.Error(err))
-		// To override the HTTP status 422.
+		r.log.Check(gb.GetZapLogLevel(err), "Failed to get the configuration.").Write(zap.Error(err))
 		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
 		return
-	} else if err != nil {
-		r.log.Check(gb.GetZapLogLevel(err), "It has failed to get the configuration.").Write(zap.Error(err))
-		gb.ResponseWithError(c, err)
+	}
+
+	if err := config.Eval(&vo.EvalValues{}); err != nil {
+		r.log.Check(gb.GetZapLogLevel(err), "Failed to evaluate the configuration.").Write(zap.Error(err))
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
+		return
+	}
+
+	var env *vo.Env
+	if env = config.GetEnv(p.Env); env == nil {
+		r.log.Warn("The environment is not found.", zap.String("env", p.Env))
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, e.NewError(e.ErrorCodeConfigUndefinedEnv, nil))
 		return
 	}
 
@@ -110,7 +118,6 @@ func (r *Repo) CreateDeployment(c *gin.Context) {
 		return
 	}
 
-	// TODO: Migrate the event logic into the interactor.
 	if _, err := r.i.CreateEvent(ctx, &ent.Event{
 		Kind:         event.KindDeployment,
 		Type:         event.TypeCreated,
@@ -124,6 +131,7 @@ func (r *Repo) CreateDeployment(c *gin.Context) {
 		d = de
 	}
 
+	r.log.Info("Start to deploy.", zap.String("repo", re.GetFullName()), zap.String("env", p.Env))
 	gb.Response(c, http.StatusCreated, d)
 }
 
@@ -149,15 +157,23 @@ func (r *Repo) UpdateDeployment(c *gin.Context) {
 		return
 	}
 
-	env, err := r.i.GetEnv(ctx, u, re, d.Env)
+	config, err := r.i.GetConfig(ctx, u, re)
 	if e.HasErrorCode(err, e.ErrorCodeEntityNotFound) {
-		r.log.Check(gb.GetZapLogLevel(err), "The configuration file is not found.").Write(zap.Error(err))
-		// To override the HTTP status 422.
+		r.log.Check(gb.GetZapLogLevel(err), "Failed to get the configuration.").Write(zap.Error(err))
 		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
 		return
-	} else if err != nil {
-		r.log.Check(gb.GetZapLogLevel(err), "It has failed to get the configuration.").Write(zap.Error(err))
-		gb.ResponseWithError(c, err)
+	}
+
+	if err := config.Eval(&vo.EvalValues{IsRollback: d.IsRollback}); err != nil {
+		r.log.Check(gb.GetZapLogLevel(err), "Failed to evaludate the configuration.").Write(zap.Error(err))
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
+		return
+	}
+
+	var env *vo.Env
+	if env = config.GetEnv(d.Env); env == nil {
+		r.log.Warn("The environment is not found.", zap.String("env", d.Env))
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, e.NewError(e.ErrorCodeConfigUndefinedEnv, nil))
 		return
 	}
 
@@ -180,6 +196,7 @@ func (r *Repo) UpdateDeployment(c *gin.Context) {
 		d = de
 	}
 
+	r.log.Info("Start to deploy.", zap.String("repo", re.GetFullName()), zap.Int("number", d.Number))
 	gb.Response(c, http.StatusOK, d)
 }
 
@@ -203,15 +220,23 @@ func (r *Repo) RollbackDeployment(c *gin.Context) {
 		return
 	}
 
-	env, err := r.i.GetEnv(ctx, u, re, d.Env)
+	config, err := r.i.GetConfig(ctx, u, re)
 	if e.HasErrorCode(err, e.ErrorCodeEntityNotFound) {
-		r.log.Check(gb.GetZapLogLevel(err), "The configuration file is not found.").Write(zap.Error(err))
-		// To override the HTTP status 422.
+		r.log.Check(gb.GetZapLogLevel(err), "Failed to get the configuration.").Write(zap.Error(err))
 		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
 		return
-	} else if err != nil {
-		r.log.Check(gb.GetZapLogLevel(err), "It has failed to get the configuration.").Write(zap.Error(err))
-		gb.ResponseWithError(c, err)
+	}
+
+	if err := config.Eval(&vo.EvalValues{IsRollback: true}); err != nil {
+		r.log.Check(gb.GetZapLogLevel(err), "Failed to evaludate the configuration.").Write(zap.Error(err))
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
+		return
+	}
+
+	var env *vo.Env
+	if env = config.GetEnv(d.Env); env == nil {
+		r.log.Warn("The environment is not found.", zap.String("env", d.Env))
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, e.NewError(e.ErrorCodeConfigUndefinedEnv, nil))
 		return
 	}
 
@@ -242,6 +267,7 @@ func (r *Repo) RollbackDeployment(c *gin.Context) {
 		d = de
 	}
 
+	r.log.Info("Start to rollback.", zap.String("repo", re.GetFullName()), zap.Int("number", d.Number))
 	gb.Response(c, http.StatusCreated, d)
 }
 

diff --git a/internal/server/api/v1/repos/deployment_test.go b/internal/server/api/v1/repos/deployment_test.go
@@ -120,13 +120,15 @@ func TestRepo_CreateDeployment(t *testing.T) {
 		ctrl := gomock.NewController(t)
 		m := mock.NewMockInteractor(ctrl)
 
-		t.Log("Read the config file.")
 		m.
 			EXPECT().
-			GetEnv(gomock.Any(), gomock.AssignableToTypeOf(&ent.User{}), gomock.AssignableToTypeOf(&ent.Repo{}), gomock.Any()).
-			Return(&vo.Env{
-				Name: "prod",
-			}, nil)
+			GetConfig(gomock.Any(), gomock.AssignableToTypeOf(&ent.User{}), gomock.AssignableToTypeOf(&ent.Repo{})).
+			Return(&vo.Config{
+				Envs: []*vo.Env{
+					{
+						Name: "prod",
+					},
+				}}, nil)
 
 		t.Log("Deploy with the payload successfully.")
 		m.

diff --git a/internal/server/api/v1/repos/interface.go b/internal/server/api/v1/repos/interface.go
@@ -31,7 +31,6 @@ type (
 		Deploy(ctx context.Context, u *ent.User, re *ent.Repo, d *ent.Deployment, env *vo.Env) (*ent.Deployment, error)
 		DeployToRemote(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *vo.Env) (*ent.Deployment, error)
 		GetConfig(ctx context.Context, u *ent.User, r *ent.Repo) (*vo.Config, error)
-		GetEnv(ctx context.Context, u *ent.User, r *ent.Repo, env string) (*vo.Env, error)
 
 		ListReviews(ctx context.Context, d *ent.Deployment) ([]*ent.Review, error)
 		FindReviewOfUser(ctx context.Context, u *ent.User, d *ent.Deployment) (*ent.Review, error)

diff --git a/internal/server/api/v1/repos/lock.go b/internal/server/api/v1/repos/lock.go
@@ -20,6 +20,7 @@ import (
 	"github.com/gitploy-io/gitploy/internal/server/global"
 	gb "github.com/gitploy-io/gitploy/internal/server/global"
 	"github.com/gitploy-io/gitploy/pkg/e"
+	"github.com/gitploy-io/gitploy/vo"
 )
 
 type (
@@ -84,15 +85,17 @@ func (r *Repo) CreateLock(c *gin.Context) {
 	vu, _ := c.Get(global.KeyUser)
 	u := vu.(*ent.User)
 
-	env, err := r.i.GetEnv(ctx, u, re, p.Env)
+	config, err := r.i.GetConfig(ctx, u, re)
 	if e.HasErrorCode(err, e.ErrorCodeEntityNotFound) {
-		r.log.Check(gb.GetZapLogLevel(err), "The configuration file is not found.").Write(zap.Error(err))
-		// To override the HTTP status 422.
+		r.log.Check(gb.GetZapLogLevel(err), "Failed to get the configuration.").Write(zap.Error(err))
 		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
 		return
-	} else if err != nil {
-		r.log.Check(gb.GetZapLogLevel(err), "It has failed to get the configuration.").Write(zap.Error(err))
-		gb.ResponseWithError(c, err)
+	}
+
+	var env *vo.Env
+	if env = config.GetEnv(p.Env); env == nil {
+		r.log.Warn("The environment is not found.", zap.String("env", p.Env))
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, e.NewError(e.ErrorCodeConfigUndefinedEnv, nil))
 		return
 	}
 

diff --git a/internal/server/api/v1/repos/lock_test.go b/internal/server/api/v1/repos/lock_test.go
@@ -17,7 +17,6 @@ import (
 	"github.com/gitploy-io/gitploy/ent"
 	"github.com/gitploy-io/gitploy/internal/server/api/v1/repos/mock"
 	"github.com/gitploy-io/gitploy/internal/server/global"
-	"github.com/gitploy-io/gitploy/pkg/e"
 	"github.com/gitploy-io/gitploy/vo"
 )
 
@@ -34,11 +33,15 @@ func TestRepo_CreateLock(t *testing.T) {
 		ctrl := gomock.NewController(t)
 		m := mock.NewMockInteractor(ctrl)
 
-		t.Log("Read deploy.yml and check the env.")
 		m.
 			EXPECT().
-			GetEnv(gomock.Any(), gomock.AssignableToTypeOf(&ent.User{}), gomock.AssignableToTypeOf(&ent.Repo{}), gomock.Any()).
-			Return(nil, e.NewError(e.ErrorCodeConfigUndefinedEnv, nil))
+			GetConfig(gomock.Any(), gomock.AssignableToTypeOf(&ent.User{}), gomock.AssignableToTypeOf(&ent.Repo{})).
+			Return(&vo.Config{
+				Envs: []*vo.Env{
+					{
+						Name: "dev",
+					},
+				}}, nil)
 
 		r := NewRepo(RepoConfig{}, m)
 
@@ -72,13 +75,15 @@ func TestRepo_CreateLock(t *testing.T) {
 		ctrl := gomock.NewController(t)
 		m := mock.NewMockInteractor(ctrl)
 
-		t.Log("Read deploy.yml and check the env.")
 		m.
 			EXPECT().
-			GetEnv(gomock.Any(), gomock.AssignableToTypeOf(&ent.User{}), gomock.AssignableToTypeOf(&ent.Repo{}), gomock.Any()).
-			Return(&vo.Env{
-				Name: "production",
-			}, nil)
+			GetConfig(gomock.Any(), gomock.AssignableToTypeOf(&ent.User{}), gomock.AssignableToTypeOf(&ent.Repo{})).
+			Return(&vo.Config{
+				Envs: []*vo.Env{
+					{
+						Name: "production",
+					},
+				}}, nil)
 
 		t.Log("Lock the env.")
 		m.

diff --git a/internal/server/api/v1/repos/mock/interactor.go b/internal/server/api/v1/repos/mock/interactor.go
diff --git a/internal/server/slack/deploy.go b/internal/server/slack/deploy.go
@@ -273,15 +273,21 @@ func (s *Slack) interactDeploy(c *gin.Context) {
 		return
 	}
 
-	cfg, err := s.i.GetConfig(ctx, cu.Edges.User, cb.Edges.Repo)
+	config, err := s.i.GetConfig(ctx, cu.Edges.User, cb.Edges.Repo)
 	if err != nil {
 		postMessageWithError(cu, err)
 		c.Status(http.StatusOK)
 		return
 	}
 
+	if err := config.Eval(&vo.EvalValues{}); err != nil {
+		postMessageWithError(cu, err)
+		c.Status(http.StatusOK)
+		return
+	}
+
 	var env *vo.Env
-	if env = cfg.GetEnv(sm.Env); env == nil {
+	if env = config.GetEnv(sm.Env); env == nil {
 		postBotMessage(cu, "The env is not defined in the config.")
 		c.Status(http.StatusOK)
 		return