Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Remove CreateEvent from the repo API #351

Merged
merged 1 commit into from
Feb 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions internal/interactor/interactor.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ type (
*LicenseInteractor
*LockInteractor
*RepoInteractor
*ReviewInteractor
*UserInteractor
}

Expand Down Expand Up @@ -86,6 +87,7 @@ func NewInteractor(c *InteractorConfig) *Interactor {
WebhookSSL: c.ServerProxyProto == "https",
WebhookSecret: c.WebhookSecret,
}
i.ReviewInteractor = (*ReviewInteractor)(i.common)
i.UserInteractor = &UserInteractor{
service: i.common,
admins: c.AdminUsers,
Expand Down
10 changes: 0 additions & 10 deletions internal/interactor/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,6 @@ type (
SyncDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
}

// ReviewStore defines operations for working with reviews.
ReviewStore interface {
SearchReviews(ctx context.Context, u *ent.User) ([]*ent.Review, error)
ListReviews(ctx context.Context, d *ent.Deployment) ([]*ent.Review, error)
FindReviewOfUser(ctx context.Context, u *ent.User, d *ent.Deployment) (*ent.Review, error)
FindReviewByID(ctx context.Context, id int) (*ent.Review, error)
CreateReview(ctx context.Context, rv *ent.Review) (*ent.Review, error)
UpdateReview(ctx context.Context, rv *ent.Review) (*ent.Review, error)
}

SCM interface {
UserSCM
RepoSCM
Expand Down
44 changes: 44 additions & 0 deletions internal/interactor/review.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package interactor

import (
"context"

"go.uber.org/zap"

"github.com/gitploy-io/gitploy/model/ent"
"github.com/gitploy-io/gitploy/model/ent/event"
)

type (
ReviewInteractor service

// ReviewStore defines operations for working with reviews.
ReviewStore interface {
SearchReviews(ctx context.Context, u *ent.User) ([]*ent.Review, error)
ListReviews(ctx context.Context, d *ent.Deployment) ([]*ent.Review, error)
FindReviewOfUser(ctx context.Context, u *ent.User, d *ent.Deployment) (*ent.Review, error)
FindReviewByID(ctx context.Context, id int) (*ent.Review, error)
// CreateReview creates a review of which status is pending.
CreateReview(ctx context.Context, rv *ent.Review) (*ent.Review, error)
// UpdateReview update the status and comment of the review.
UpdateReview(ctx context.Context, rv *ent.Review) (*ent.Review, error)
}
)

// RespondReview update the status of review.
func (i *ReviewInteractor) RespondReview(ctx context.Context, rv *ent.Review) (*ent.Review, error) {
rv, err := i.store.UpdateReview(ctx, rv)
if err != nil {
return nil, err
}

if _, err := i.store.CreateEvent(ctx, &ent.Event{
Kind: event.KindReview,
Type: event.TypeCreated,
ReviewID: rv.ID,
}); err != nil {
i.log.Error("Failed to create a review event.", zap.Error(err))
}

return rv, nil
}
38 changes: 38 additions & 0 deletions internal/interactor/review_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package interactor_test

import (
"context"
"testing"

gm "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"
)

func TestInteractor_RespondReview(t *testing.T) {
t.Run("Return the review.", func(t *testing.T) {
t.Log("Start mocking:")
ctrl := gm.NewController(t)
store := mock.NewMockStore(ctrl)

t.Log("\tUpdates the review and dispatches a event.")
store.EXPECT().
UpdateReview(gm.Any(), gm.AssignableToTypeOf(&ent.Review{})).
Return(&ent.Review{}, nil)

store.EXPECT().
CreateEvent(gm.Any(), gm.AssignableToTypeOf(&ent.Event{})).
Return(&ent.Event{}, nil)

it := i.NewInteractor(&i.InteractorConfig{
Store: store,
})
_, err := it.RespondReview(context.Background(), &ent.Review{})
if err != nil {
t.Fatalf("RespondReview returns an error: %v", err)
}
})

}
1 change: 1 addition & 0 deletions internal/server/api/v1/repos/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ type (
ListReviews(ctx context.Context, d *ent.Deployment) ([]*ent.Review, error)
FindReviewOfUser(ctx context.Context, u *ent.User, d *ent.Deployment) (*ent.Review, error)
UpdateReview(ctx context.Context, rv *ent.Review) (*ent.Review, error)
RespondReview(ctx context.Context, rv *ent.Review) (*ent.Review, error)

ListLocksOfRepo(ctx context.Context, r *ent.Repo) ([]*ent.Lock, error)
HasLockOfRepoForEnv(ctx context.Context, r *ent.Repo, env string) (bool, error)
Expand Down
15 changes: 15 additions & 0 deletions internal/server/api/v1/repos/mock/interactor.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 2 additions & 10 deletions internal/server/api/v1/repos/review_update.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import (

gb "github.com/gitploy-io/gitploy/internal/server/global"
"github.com/gitploy-io/gitploy/model/ent"
"github.com/gitploy-io/gitploy/model/ent/event"
"github.com/gitploy-io/gitploy/model/ent/review"
"github.com/gitploy-io/gitploy/pkg/e"
)
Expand Down Expand Up @@ -80,19 +79,12 @@ func (s *ReviewAPI) UpdateMine(c *gin.Context) {
rv.Comment = *p.Comment
}

if rv, err = s.i.UpdateReview(ctx, rv); err != nil {
if rv, err = s.i.RespondReview(ctx, rv); err != nil {
s.log.Check(gb.GetZapLogLevel(err), "Failed to update the review.").Write(zap.Error(err))
gb.ResponseWithError(c, err)
return
}

if _, err := s.i.CreateEvent(ctx, &ent.Event{
Kind: event.KindReview,
Type: event.TypeUpdated,
ReviewID: rv.ID,
}); err != nil {
s.log.Error("Failed to create the event.", zap.Error(err))
}

s.log.Info("Respond the review successfully.", zap.Int("review_id", rv.ID))
gb.Response(c, http.StatusOK, rv)
}
61 changes: 46 additions & 15 deletions internal/server/api/v1/repos/review_update_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ import (
"go.uber.org/zap"

"github.com/gitploy-io/gitploy/internal/server/api/v1/repos/mock"
"github.com/golang/mock/gomock"
"github.com/gitploy-io/gitploy/internal/server/global"
"github.com/gitploy-io/gitploy/model/ent"
gm "github.com/golang/mock/gomock"
)

func init() {
Expand All @@ -26,30 +28,59 @@ func init() {

func TestReviewAPI_UpdateMine(t *testing.T) {
t.Run("Return 400 code when the status is invalid", func(t *testing.T) {
input := struct {
payload *ReviewPatchPayload
}{
payload: &ReviewPatchPayload{
Status: "INVALID",
},
}

ctrl := gomock.NewController(t)
m := mock.NewMockInteractor(ctrl)
ctrl := gm.NewController(t)
s := &ReviewAPI{i: mock.NewMockInteractor(ctrl), log: zap.L()}

router := gin.New()

s := &ReviewAPI{i: m, log: zap.L()}
router.PATCH("/deployments/:number/review", s.UpdateMine)

p, _ := json.Marshal(input.payload)
p, _ := json.Marshal(&ReviewPatchPayload{
Status: "INVALID",
})
req, _ := http.NewRequest("PATCH", "/deployments/1/review", bytes.NewBuffer(p))
w := httptest.NewRecorder()

router.ServeHTTP(w, req)

if w.Code != http.StatusBadRequest {
t.Fatalf("Code = %v, wanted %v", w.Code, http.StatusBadRequest)
}
})

t.Run("Return 200 when the update has succeeded.", func(t *testing.T) {
t.Log("Start mocking:")
ctrl := gm.NewController(t)
i := mock.NewMockInteractor(ctrl)

t.Log("\tFind the user's review.")
i.EXPECT().
FindDeploymentOfRepoByNumber(gm.Any(), gm.AssignableToTypeOf(&ent.Repo{}), gm.AssignableToTypeOf(1)).
Return(&ent.Deployment{}, nil)

i.EXPECT().
FindReviewOfUser(gm.Any(), gm.Any(), gm.AssignableToTypeOf(&ent.Deployment{})).
Return(&ent.Review{}, nil)

t.Log("\tRespond the review.")
i.EXPECT().
RespondReview(gm.Any(), gm.AssignableToTypeOf(&ent.Review{})).
Return(&ent.Review{}, nil)

s := &ReviewAPI{i: i, log: zap.L()}
router := gin.New()
router.PATCH("/deployments/:number/review", func(c *gin.Context) {
c.Set(global.KeyUser, &ent.User{})
c.Set(KeyRepo, &ent.Repo{})
}, s.UpdateMine)

p, _ := json.Marshal(&ReviewPatchPayload{
Status: "approved",
})
req, _ := http.NewRequest("PATCH", "/deployments/1/review", bytes.NewBuffer(p))
w := httptest.NewRecorder()
router.ServeHTTP(w, req)

if w.Code != http.StatusOK {
t.Fatalf("Code = %v, wanted %v", w.Code, http.StatusOK)
}
})
}