Refactoring the deployment interactor (#350)

* Add 'GetEvaluatedConfig' method

* Refactoring review method

* Create an event in the interactor

Author: Noah Lee

internal/interactor/_mock.sh

@@ -2,6 +2,7 @@ mockgen \
     -aux_files \
 github.com/gitploy-io/gitploy/internal/interactor=user.go\
 ,github.com/gitploy-io/gitploy/internal/interactor=repo.go\
+,github.com/gitploy-io/gitploy/internal/interactor=config.go\
 ,github.com/gitploy-io/gitploy/internal/interactor=deployment.go\
 ,github.com/gitploy-io/gitploy/internal/interactor=deploymentstatistics.go\
 ,github.com/gitploy-io/gitploy/internal/interactor=lock.go\

internal/interactor/config.go

@@ -0,0 +1,32 @@
+package interactor
+
+import (
+	"context"
+
+	"github.com/gitploy-io/gitploy/model/ent"
+	"github.com/gitploy-io/gitploy/model/extent"
+)
+
+type (
+	ConfigInteractor service
+
+	ConfigSCM interface {
+		GetConfig(ctx context.Context, u *ent.User, r *ent.Repo) (*extent.Config, error)
+		GetConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
+		GetNewConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
+	}
+)
+
+// GetEvaluatedConfig returns the config after evaluating the variables.
+func (i *ConfigInteractor) GetEvaluatedConfig(ctx context.Context, u *ent.User, r *ent.Repo, v *extent.EvalValues) (*extent.Config, error) {
+	config, err := i.scm.GetConfig(ctx, u, r)
+	if err != nil {
+		return nil, err
+	}
+
+	if err = config.Eval(v); err != nil {
+		return nil, err
+	}
+
+	return config, nil
+}

internal/interactor/config_test.go

@@ -0,0 +1,36 @@
+package interactor_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+
+	i "github.com/gitploy-io/gitploy/internal/interactor"
+	"github.com/gitploy-io/gitploy/internal/interactor/mock"
+	"github.com/gitploy-io/gitploy/model/ent"
+	"github.com/gitploy-io/gitploy/model/extent"
+)
+
+func TestConfigInteractor_GetEvaluatedConfig(t *testing.T) {
+	t.Run("Return the evaluated config", func(t *testing.T) {
+		t.Log("Start mocking: ")
+		ctrl := gomock.NewController(t)
+		scm := mock.NewMockSCM(ctrl)
+
+		t.Log("\tGet the config.")
+		scm.EXPECT().
+			GetConfig(gomock.Any(), gomock.AssignableToTypeOf(&ent.User{}), gomock.AssignableToTypeOf(&ent.Repo{})).
+			Return(&extent.Config{}, nil)
+
+		it := i.NewInteractor(&i.InteractorConfig{
+			Store: mock.NewMockStore(ctrl),
+			SCM:   scm,
+		})
+
+		_, err := it.GetEvaluatedConfig(context.Background(), &ent.User{}, &ent.Repo{}, &extent.EvalValues{})
+		if err != nil {
+			t.Fatalf("GetEvaluatedConfig returns an error: %v", err)
+		}
+	})
+}

internal/interactor/deployment.go

@@ -8,6 +8,7 @@ import (
 	"github.com/AlekSi/pointer"
 	"github.com/gitploy-io/gitploy/model/ent"
 	"github.com/gitploy-io/gitploy/model/ent/deployment"
+	"github.com/gitploy-io/gitploy/model/ent/event"
 	"github.com/gitploy-io/gitploy/model/extent"
 	"github.com/gitploy-io/gitploy/pkg/e"
 	"go.uber.org/zap"
@@ -63,10 +64,6 @@ type (
 		// SCM returns the deployment with UID and SHA.
 		CreateRemoteDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, e *extent.Env) (*extent.RemoteDeployment, error)
 		CancelDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, s *ent.DeploymentStatus) error
-
-		GetConfig(ctx context.Context, u *ent.User, r *ent.Repo) (*extent.Config, error)
-		GetConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
-		GetNewConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
 	}
 )
 
@@ -108,17 +105,20 @@ func (i *DeploymentInteractor) Deploy(ctx context.Context, u *ent.User, r *ent.R
 			return nil, err
 		}
 
-		for _, rvr := range env.Review.Reviewers {
-			if rvr == u.Login {
-				continue
-			}
-
-			i.log.Debug(fmt.Sprintf("Request a review to %s.", rvr))
-			if _, err := i.requestReviewByLogin(ctx, d, rvr); err != nil {
-				i.log.Error("Failed to request the review.", zap.Error(err))
-			}
+		i.log.Debug("Request reviews.")
+		errs := i.requestReviews(ctx, u, d, env)
+		if len(errs) != 0 {
+			i.log.Error("Failed to request a review.", zap.Errors("errs", errs))
 		}
 
+		i.log.Debug("Dispatch a event.")
+		if _, err := i.store.CreateEvent(ctx, &ent.Event{
+			Kind:         event.KindDeployment,
+			Type:         event.TypeCreated,
+			DeploymentID: d.ID,
+		}); err != nil {
+			i.log.Error("Failed to create the event.", zap.Error(err))
+		}
 		return d, nil
 	}
 
@@ -145,9 +145,56 @@ func (i *DeploymentInteractor) Deploy(ctx context.Context, u *ent.User, r *ent.R
 		DeploymentID: d.ID,
 	})
 
+	i.log.Debug("Dispatch a event.")
+	if _, err := i.store.CreateEvent(ctx, &ent.Event{
+		Kind:         event.KindDeployment,
+		Type:         event.TypeCreated,
+		DeploymentID: d.ID,
+	}); err != nil {
+		i.log.Error("Failed to create the event.", zap.Error(err))
+	}
 	return d, nil
 }
 
+func (i *DeploymentInteractor) requestReviews(ctx context.Context, u *ent.User, d *ent.Deployment, env *extent.Env) []error {
+	errs := make([]error, 0)
+
+	for _, login := range env.Review.Reviewers {
+		if login == u.Login {
+			i.log.Debug("Skip the deployer.")
+			continue
+		}
+
+		reviewer, err := i.store.FindUserByLogin(ctx, login)
+		if err != nil {
+			i.log.Error("Failed to find the reviewer.", zap.Error(err))
+			errs = append(errs, err)
+			continue
+		}
+
+		r, err := i.store.CreateReview(ctx, &ent.Review{
+			DeploymentID: d.ID,
+			UserID:       reviewer.ID,
+		})
+		if err != nil {
+			i.log.Error("Failed to create a review.", zap.Error(err))
+			errs = append(errs, err)
+			continue
+		}
+
+		if _, err := i.store.CreateEvent(ctx, &ent.Event{
+			Kind:     event.KindReview,
+			Type:     event.TypeCreated,
+			ReviewID: r.ID,
+		}); err != nil {
+			i.log.Error("Failed to create a review event.", zap.Error(err))
+			errs = append(errs, err)
+		}
+	}
+
+	return errs
+}
+
 // DeployToRemote posts a new deployment to SCM with the saved payload
 // after review has finished.
 // It returns an error for a undeployable payload.

internal/interactor/deployment_test.go

@@ -50,6 +50,11 @@ func TestInteractor_Deploy(t *testing.T) {
 				return d, nil
 			})
 
+		store.
+			EXPECT().
+			CreateEvent(gomock.Any(), gomock.AssignableToTypeOf(&ent.Event{})).
+			Return(&ent.Event{}, nil)
+
 		store.
 			EXPECT().
 			CreateDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{}))
@@ -94,6 +99,11 @@ func TestInteractor_Deploy(t *testing.T) {
 				return d, nil
 			})
 
+		store.
+			EXPECT().
+			CreateEvent(gomock.Any(), gomock.AssignableToTypeOf(&ent.Event{})).
+			Return(&ent.Event{}, nil)
+
 		it := i.NewInteractor(&i.InteractorConfig{
 			Store: store,
 			SCM:   scm,

internal/interactor/interactor.go

@@ -18,6 +18,7 @@ type (
 		common *service
 
 		// services used for talking to different parts of the entities.
+		*ConfigInteractor
 		*DeploymentInteractor
 		*DeploymentStatisticsInteractor
 		*EventInteractor
@@ -67,6 +68,7 @@ func NewInteractor(c *InteractorConfig) *Interactor {
 		log:   log,
 	}
 
+	i.ConfigInteractor = (*ConfigInteractor)(i.common)
 	i.DeploymentInteractor = (*DeploymentInteractor)(i.common)
 	i.DeploymentStatisticsInteractor = (*DeploymentStatisticsInteractor)(i.common)
 	i.EventInteractor = &EventInteractor{

internal/interactor/interface.go

@@ -62,6 +62,7 @@ type (
 		RepoSCM
 		DeploymentSCM
 		DeploymentStatusSCM
+		ConfigSCM
 		CommitSCM
 		BranchSCM
 		TagSCM