Migrate the logic of DeployToRemote into the interactor package (#191)

* Fix to handle errors of 'GetConfig'

* Migrate validation into the interactor package

Author: Noah Hanjun Lee

internal/interactor/deployment.go

@@ -14,8 +14,9 @@ import (
 	"go.uber.org/zap"
 )
 
+// Deploy creates a new remote deployment basically.
+// But if the approval flag is enabled, it saves the deployment only.
 func (i *Interactor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *vo.Env) (*ent.Deployment, error) {
-	// Verify the payload is deployable.
 	if locked, err := i.Store.HasLockOfRepoForEnv(ctx, r, d.Env); locked {
 		return nil, e.NewError(
 			e.ErrorCodeDeploymentLocked,
@@ -53,7 +54,7 @@ func (i *Interactor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *en
 	}
 
 	i.log.Debug("Create a new remote deployment.")
-	rd, err := i.SCM.CreateRemoteDeployment(ctx, u, r, d, env)
+	rd, err := i.createRemoteDeployment(ctx, u, r, d, env)
 	if err != nil {
 		return nil, err
 	}
@@ -103,16 +104,25 @@ func (i *Interactor) IsApproved(ctx context.Context, d *ent.Deployment) bool {
 	return approved >= d.RequiredApprovalCount
 }
 
-func (i *Interactor) CreateRemoteDeployment(ctx context.Context, u *ent.User, re *ent.Repo, d *ent.Deployment, e *vo.Env) (*ent.Deployment, error) {
-	// Rollback configures it can deploy the ref without any constraints.
-	// 1) Set auto_merge false to avoid the merge conflict.
-	// 2) Set required_contexts empty to skip the verfication.
-	if d.IsRollback {
-		e.AutoMerge = pointer.ToBool(false)
-		e.RequiredContexts = &[]string{}
+// DeployToRemote create a new remote deployment after the deployment was approved.
+func (i *Interactor) DeployToRemote(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *vo.Env) (*ent.Deployment, error) {
+	if locked, err := i.Store.HasLockOfRepoForEnv(ctx, r, d.Env); locked {
+		return nil, e.NewError(
+			e.ErrorCodeDeploymentLocked,
+			err,
+		)
+	} else if err != nil {
+		return nil, err
 	}
 
-	rd, err := i.SCM.CreateRemoteDeployment(ctx, u, re, d, e)
+	if d.IsApprovalEnabled && !i.IsApproved(ctx, d) {
+		return nil, e.NewError(
+			e.ErrorCodeDeploymentUnapproved,
+			nil,
+		)
+	}
+
+	rd, err := i.createRemoteDeployment(ctx, u, r, d, env)
 	if err != nil {
 		return nil, err
 	}
@@ -136,6 +146,18 @@ func (i *Interactor) CreateRemoteDeployment(ctx context.Context, u *ent.User, re
 	return d, nil
 }
 
+func (i *Interactor) createRemoteDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *vo.Env) (*vo.RemoteDeployment, error) {
+	// Rollback configures it can deploy the ref without any constraints.
+	// 1) Set auto_merge false to avoid the merge conflict.
+	// 2) Set required_contexts empty to skip the verfication.
+	if d.IsRollback {
+		env.AutoMerge = pointer.ToBool(false)
+		env.RequiredContexts = &[]string{}
+	}
+
+	return i.SCM.CreateRemoteDeployment(ctx, u, r, d, env)
+}
+
 func (i *Interactor) runClosingInactiveDeployment(stop <-chan struct{}) {
 	ctx := context.Background()
 

internal/interactor/deployment_test.go

@@ -212,7 +212,7 @@ func TestInteractor_Deploy(t *testing.T) {
 	})
 }
 
-func TestInteractor_CreateRemoteDeployment(t *testing.T) {
+func TestInteractor_DeployToRemote(t *testing.T) {
 	ctx := gomock.Any()
 
 	t.Run("create a new remote deployment and update the deployment.", func(t *testing.T) {
@@ -238,19 +238,26 @@ func TestInteractor_CreateRemoteDeployment(t *testing.T) {
 			UID = 1000
 		)
 
-		t.Logf("Returns a new remote deployment with UID = %d", UID)
+		t.Log("MOCK - Check the environment is locked.")
+		store.
+			EXPECT().
+			HasLockOfRepoForEnv(ctx, gomock.AssignableToTypeOf(&ent.Repo{}), gomock.AssignableToTypeOf("")).
+			Return(false, nil)
+
+		t.Logf("MOCK - Returns a new remote deployment with UID = %d", UID)
 		scm.
 			EXPECT().
 			CreateRemoteDeployment(ctx, gomock.Eq(input.u), gomock.Eq(input.r), gomock.Eq(input.d), gomock.Eq(input.e)).
 			Return(&vo.RemoteDeployment{
 				UID: UID,
 			}, nil)
 
-		t.Logf("Check the deployment input has UID")
+		t.Logf("MOCK - Check the deployment input has UID")
 		store.
 			EXPECT().
 			UpdateDeployment(ctx, gomock.Eq(&ent.Deployment{
 				ID:     input.d.ID,
+				Env:    input.d.Env,
 				UID:    UID,
 				Status: deployment.StatusCreated,
 			})).
@@ -264,7 +271,7 @@ func TestInteractor_CreateRemoteDeployment(t *testing.T) {
 
 		i := newMockInteractor(store, scm)
 
-		d, err := i.CreateRemoteDeployment(context.Background(), input.u, input.r, input.d, input.e)
+		d, err := i.DeployToRemote(context.Background(), input.u, input.r, input.d, input.e)
 		if err != nil {
 			t.Errorf("CreateRemoteDeployment returns a error: %s", err)
 			t.FailNow()

internal/pkg/github/deployment.go

@@ -75,9 +75,10 @@ func (g *Github) GetConfig(ctx context.Context, u *ent.User, r *ent.Repo) (*vo.C
 		Repositories.
 		GetContents(ctx, r.Namespace, r.Name, r.ConfigPath, &github.RepositoryContentGetOptions{})
 	if res.StatusCode == http.StatusNotFound {
-		return nil, &vo.ConfigNotFoundError{
-			RepoName: r.Name,
-		}
+		return nil, e.NewError(
+			e.ErrorCodeConfigNotFound,
+			err,
+		)
 	} else if err != nil {
 		return nil, err
 	}
@@ -89,10 +90,10 @@ func (g *Github) GetConfig(ctx context.Context, u *ent.User, r *ent.Repo) (*vo.C
 
 	c := &vo.Config{}
 	if err := vo.UnmarshalYAML([]byte(content), c); err != nil {
-		return nil, &vo.ConfigParseError{
-			RepoName: r.Name,
-			Err:      err,
-		}
+		return nil, e.NewError(
+			e.ErrorCodeConfigParseError,
+			err,
+		)
 	}
 
 	return c, nil

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

@@ -13,6 +13,7 @@ import (
 	"github.com/gitploy-io/gitploy/ent/deployment"
 	"github.com/gitploy-io/gitploy/ent/event"
 	gb "github.com/gitploy-io/gitploy/internal/server/global"
+	"github.com/gitploy-io/gitploy/pkg/e"
 	"github.com/gitploy-io/gitploy/vo"
 )
 
@@ -88,23 +89,25 @@ func (r *Repo) CreateDeployment(c *gin.Context) {
 	re := vr.(*ent.Repo)
 
 	cf, err := r.i.GetConfig(ctx, u, re)
-	if vo.IsConfigNotFoundError(err) || vo.IsConfigParseError(err) {
-		r.log.Warn("The configuration is invalid.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "The configuration is invalid.")
+	if e.HasErrorCode(err, e.ErrorCodeConfigNotFound) {
+		r.log.Error("The configuration file is not found.", zap.Error(err))
+		// To override the HTTP status 422.
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
 		return
 	} else if err != nil {
-		r.log.Error("failed to get the configuration file.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the configuraton file.")
+		r.log.Error("It has failed to get the configuration.")
+		gb.ResponseWithError(c, err)
 		return
 	}
 
-	if !cf.HasEnv(p.Env) {
-		r.log.Warn("The environment is not defined in the config.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "The environment is not defined in the config.")
+	var env *vo.Env
+	if env = cf.GetEnv(p.Env); env == nil {
+		r.log.Warn("The environment is not defined in the configuration.", zap.Error(err))
+		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "The environment is not defined in the configuration.")
 		return
 	}
 
-	if err := cf.GetEnv(p.Env).Eval(&vo.EvalValues{}); err != nil {
+	if err := env.Eval(&vo.EvalValues{}); err != nil {
 		r.log.Warn("It has failed to eval variables in the config.", zap.Error(err))
 		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "It has failed to eval variables in the config.")
 		return
@@ -124,7 +127,6 @@ func (r *Repo) CreateDeployment(c *gin.Context) {
 		return
 	}
 
-	// Dispatch the event.
 	if _, err := r.i.CreateEvent(ctx, &ent.Event{
 		Kind:         event.KindDeployment,
 		Type:         event.TypeCreated,
@@ -169,54 +171,34 @@ func (r *Repo) UpdateDeployment(c *gin.Context) {
 	}
 
 	cf, err := r.i.GetConfig(ctx, u, re)
-	if vo.IsConfigNotFoundError(err) || vo.IsConfigParseError(err) {
-		r.log.Warn("The configuration is invalid.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "The configuration is invalid.")
+	if e.HasErrorCode(err, e.ErrorCodeConfigNotFound) {
+		r.log.Error("The configuration file is not found.", zap.Error(err))
+		// To override the HTTP status 422.
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
 		return
 	} else if err != nil {
-		r.log.Error("failed to get the configuration file.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the configuraton file.")
+		r.log.Error("It has failed to get the configuration.")
+		gb.ResponseWithError(c, err)
 		return
 	}
 
-	if !cf.HasEnv(d.Env) {
+	var env *vo.Env
+	if env = cf.GetEnv(d.Env); env == nil {
 		r.log.Warn("The environment is not defined in the config.", zap.Error(err))
 		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "The environment is not defined in the config.")
 		return
 	}
 
-	if err := cf.GetEnv(d.Env).Eval(&vo.EvalValues{IsRollback: d.IsRollback}); err != nil {
+	if err := env.Eval(&vo.EvalValues{IsRollback: d.IsRollback}); err != nil {
 		r.log.Warn("It has failed to eval variables in the config.", zap.Error(err))
 		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "It has failed to eval variables in the config.")
 		return
 	}
 
-	if locked, err := r.i.HasLockOfRepoForEnv(ctx, re, d.Env); locked {
-		r.log.Info("The environment is locked.", zap.String("env", d.Env))
-		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "The environment is locked.")
-		return
-	} else if err != nil {
-		r.log.Error("It has failed to check the lock.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to check the lock.")
-		return
-	}
-
 	if p.Status == string(deployment.StatusCreated) && d.Status == deployment.StatusWaiting {
-		// Check the deployment is approved:
-		// Approved >= Required Approval Count
-		if !r.i.IsApproved(ctx, d) {
-			r.log.Warn("The deployment is not approved yet.", zap.Int("deployment_id", d.ID))
-			gb.ErrorResponse(c, http.StatusUnprocessableEntity, "It is not approved yet.")
-			return
-		}
-
-		if d, err = r.i.CreateRemoteDeployment(ctx, u, re, d, cf.GetEnv(d.Env)); vo.IsUnprocessibleDeploymentError(err) {
-			r.log.Warn("It is unprocessible entity.", zap.Error(err))
-			gb.ErrorResponse(c, http.StatusUnprocessableEntity, "There is a merge conflict or the commit's status checks failed.")
-			return
-		} else if err != nil {
-			r.log.Error("It has failed to create the remote deployment.", zap.Error(err))
-			gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to create the remote deployment.")
+		if d, err = r.i.DeployToRemote(ctx, u, re, d, env); err != nil {
+			r.log.Error("It has failed to deploy to the remote.", zap.Error(err))
+			gb.ResponseWithError(c, err)
 			return
 		}
 
@@ -258,23 +240,25 @@ func (r *Repo) RollbackDeployment(c *gin.Context) {
 	}
 
 	cf, err := r.i.GetConfig(ctx, u, re)
-	if vo.IsConfigNotFoundError(err) || vo.IsConfigParseError(err) {
-		r.log.Warn("The configuration is invalid.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "The configuration is invalid.")
+	if e.HasErrorCode(err, e.ErrorCodeConfigNotFound) {
+		r.log.Error("The configuration file is not found.", zap.Error(err))
+		// To override the HTTP status 422.
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
 		return
 	} else if err != nil {
-		r.log.Error("failed to get the configuration file.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the configuraton file.")
+		r.log.Error("It has failed to get the configuration.")
+		gb.ResponseWithError(c, err)
 		return
 	}
 
-	if !cf.HasEnv(d.Env) {
+	var env *vo.Env
+	if env = cf.GetEnv(d.Env); env == nil {
 		r.log.Warn("The environment is not defined in the configuration.", zap.Error(err))
 		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "The environment is not defined in the configuration.")
 		return
 	}
 
-	if err := cf.GetEnv(d.Env).Eval(&vo.EvalValues{IsRollback: true}); err != nil {
+	if err := env.Eval(&vo.EvalValues{IsRollback: true}); err != nil {
 		r.log.Warn("It has failed to eval variables in the config.", zap.Error(err))
 		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "It has failed to eval variables in the config.")
 		return
@@ -410,17 +394,9 @@ func (r *Repo) GetConfig(c *gin.Context) {
 	ctx := c.Request.Context()
 
 	config, err := r.i.GetConfig(ctx, u, re)
-	if vo.IsConfigNotFoundError(err) {
-		r.log.Warn("failed to find the config file.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusNotFound, "It has failed to find the configuraton file.")
-		return
-	} else if vo.IsConfigParseError(err) {
-		r.log.Warn("failed to parse the config.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "It has failed to parse the configuraton file.")
-		return
-	} else if err != nil {
-		r.log.Error("failed to get the config file.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the config file.")
+	if err != nil {
+		r.log.Error("It has failed to get the configuration.", zap.Error(err))
+		gb.ResponseWithError(c, err)
 		return
 	}
 

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

@@ -29,7 +29,7 @@ type (
 		FindPrevSuccessDeployment(ctx context.Context, d *ent.Deployment) (*ent.Deployment, error)
 		IsApproved(ctx context.Context, d *ent.Deployment) bool
 		Deploy(ctx context.Context, u *ent.User, re *ent.Repo, d *ent.Deployment, env *vo.Env) (*ent.Deployment, error)
-		CreateRemoteDeployment(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)
 
 		ListApprovals(ctx context.Context, d *ent.Deployment) ([]*ent.Approval, error)

internal/server/api/v1/repos/mock/interactor.go

@@ -21,7 +21,23 @@ func ResponseWithError(c *gin.Context, err error) {
 	if ge, ok := err.(*e.Error); ok {
 		c.JSON(e.GetHttpCode(ge.Code), map[string]string{
 			"code":    string(ge.Code),
-			"message": e.GetMessage(ge.Code),
+			"message": ge.Message,
+		})
+		return
+	}
+
+	c.JSON(http.StatusInternalServerError, map[string]string{
+		"code":    string(e.ErrorCodeInternalError),
+		"message": err.Error(),
+	})
+}
+
+// ResponseWithStatusAndError
+func ResponseWithStatusAndError(c *gin.Context, status int, err error) {
+	if ge, ok := err.(*e.Error); ok {
+		c.JSON(status, map[string]string{
+			"code":    string(ge.Code),
+			"message": ge.Message,
 		})
 		return
 	}