Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(approval): add appeal_statuses filter for list approvals API #25

Merged
merged 5 commits into from
May 2, 2023
Merged

feat(approval): add appeal_statuses filter for list approvals API #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5648175
feat(approval): add appeal_statuses filter for list approvals API
bsushmith Apr 27, 2023
1393a64
test: add test cases
bsushmith Apr 27, 2023
436e5c8
chore: update proton commit
bsushmith Apr 28, 2023
14544b2
refactor: update test case
bsushmith May 2, 2023
7f36d61
test: update test cases
bsushmith May 2, 2023
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: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ COMMIT := $(shell git rev-parse --short HEAD)
TAG := "$(shell git rev-list --tags --max-count=1)"
VERSION := "$(shell git describe --tags ${TAG})-next"
BUILD_DIR=dist
PROTON_COMMIT := "246242731323907ffc7fb7fe24723b5b932a186c"
PROTON_COMMIT := "894c7d7049c26c1d2070a2c73744f6d174224339"

.PHONY: all build clean test tidy vet proto setup format generate

Expand Down
26 changes: 14 additions & 12 deletions api/handler/v1beta1/approval.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,13 @@ func (s *GRPCServer) ListUserApprovals(ctx context.Context, req *guardianv1beta1
}

approvals, err := s.listApprovals(ctx, &domain.ListApprovalsFilter{
AccountID: req.GetAccountId(),
CreatedBy: user,
Statuses: req.GetStatuses(),
OrderBy: req.GetOrderBy(),
Size: int(req.GetSize()),
Offset: int(req.GetOffset()),
AccountID: req.GetAccountId(),
CreatedBy: user,
Statuses: req.GetStatuses(),
OrderBy: req.GetOrderBy(),
Size: int(req.GetSize()),
Offset: int(req.GetOffset()),
AppealStatuses: req.GetAppealStatuses(),
})
if err != nil {
return nil, err
Expand All @@ -36,12 +37,13 @@ func (s *GRPCServer) ListUserApprovals(ctx context.Context, req *guardianv1beta1

func (s *GRPCServer) ListApprovals(ctx context.Context, req *guardianv1beta1.ListApprovalsRequest) (*guardianv1beta1.ListApprovalsResponse, error) {
approvals, err := s.listApprovals(ctx, &domain.ListApprovalsFilter{
AccountID: req.GetAccountId(),
CreatedBy: req.GetCreatedBy(),
Statuses: req.GetStatuses(),
OrderBy: req.GetOrderBy(),
Size: int(req.GetSize()),
Offset: int(req.GetOffset()),
AccountID: req.GetAccountId(),
CreatedBy: req.GetCreatedBy(),
Statuses: req.GetStatuses(),
OrderBy: req.GetOrderBy(),
Size: int(req.GetSize()),
Offset: int(req.GetOffset()),
AppealStatuses: req.GetAppealStatuses(),
})
if err != nil {
return nil, err
Expand Down
1,992 changes: 1,007 additions & 985 deletions api/proto/gotocompany/guardian/v1beta1/guardian.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

13 changes: 7 additions & 6 deletions domain/approval.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,11 @@ func (a *Approval) IsManualApproval() bool {
}

type ListApprovalsFilter struct {
AccountID string `mapstructure:"account_id" validate:"omitempty,required"`
CreatedBy string `mapstructure:"created_by" validate:"omitempty,required"`
Statuses []string `mapstructure:"statuses" validate:"omitempty,min=1"`
OrderBy []string `mapstructure:"order_by" validate:"omitempty,min=1"`
Size int `mapstructure:"size" validate:"omitempty"`
Offset int `mapstructure:"offset" validate:"omitempty"`
AccountID string `mapstructure:"account_id" validate:"omitempty,required"`
CreatedBy string `mapstructure:"created_by" validate:"omitempty,required"`
Statuses []string `mapstructure:"statuses" validate:"omitempty,min=1"`
OrderBy []string `mapstructure:"order_by" validate:"omitempty,min=1"`
Size int `mapstructure:"size" validate:"omitempty"`
Offset int `mapstructure:"offset" validate:"omitempty"`
AppealStatuses []string `mapstructure:"appeal_statuses" validate:"omitempty,min=1"`
}
7 changes: 6 additions & 1 deletion internal/store/postgres/approval_repository.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,12 @@ func (r *ApprovalRepository) ListApprovals(ctx context.Context, conditions *doma
if conditions.AccountID != "" {
db = db.Where(`"Appeal"."account_id" = ?`, conditions.AccountID)
}
db = db.Where(`"Appeal"."status" != ?`, domain.AppealStatusCanceled)

if len(conditions.AppealStatuses) == 0 {
db = db.Where(`"Appeal"."status" != ?`, domain.AppealStatusCanceled)
} else {
db = db.Where(`"Appeal"."status" IN ?`, conditions.AppealStatuses)
}

if conditions.OrderBy != nil {
db = addOrderByClause(db, conditions.OrderBy, addOrderByClauseOptions{
Expand Down
95 changes: 89 additions & 6 deletions internal/store/postgres/approval_repository_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ import (

type ApprovalRepositoryTestSuite struct {
suite.Suite
store *postgres.Store
pool *dockertest.Pool
resource *dockertest.Resource
repository *postgres.ApprovalRepository
store *postgres.Store
pool *dockertest.Pool
resource *dockertest.Resource
repository *postgres.ApprovalRepository
appealRepository *postgres.AppealRepository

dummyProvider *domain.Provider
dummyPolicy *domain.Policy
Expand Down Expand Up @@ -93,8 +94,9 @@ func (s *ApprovalRepositoryTestSuite) SetupSuite() {
Permissions: []string{"permission_test"},
CreatedBy: "user@example.com",
}
appealRepository := postgres.NewAppealRepository(s.store.DB())
err = appealRepository.BulkUpsert(ctx, []*domain.Appeal{s.dummyAppeal})

s.appealRepository = postgres.NewAppealRepository(s.store.DB())
err = s.appealRepository.BulkUpsert(ctx, []*domain.Appeal{s.dummyAppeal})
s.Require().NoError(err)
}

Expand All @@ -116,6 +118,33 @@ func (s *ApprovalRepositoryTestSuite) TearDownSuite() {
}

func (s *ApprovalRepositoryTestSuite) TestListApprovals() {

appealA := &domain.Appeal{
ResourceID: s.dummyResource.ID,
PolicyID: s.dummyPolicy.ID,
PolicyVersion: s.dummyPolicy.Version,
AccountID: "abc-user@example.com",
AccountType: domain.DefaultAppealAccountType,
Role: "role_test_a",
Permissions: []string{"permission_test"},
CreatedBy: "abc-user@example.com",
Status: domain.AppealStatusPending,
}

appealB := &domain.Appeal{
ResourceID: s.dummyResource.ID,
PolicyID: s.dummyPolicy.ID,
PolicyVersion: s.dummyPolicy.Version,
AccountID: "abc-user@example.com",
AccountType: domain.DefaultAppealAccountType,
Role: "role_test_b",
Permissions: []string{"permission_test"},
CreatedBy: "abc-user@example.com",
Status: domain.AppealStatusCanceled,
}

s.appealRepository.BulkUpsert(context.Background(), []*domain.Appeal{appealA, appealB})

dummyApprovals := []*domain.Approval{
{
Name: "test-approval-name-1",
Expand Down Expand Up @@ -144,6 +173,24 @@ func (s *ApprovalRepositoryTestSuite) TestListApprovals() {
PolicyVersion: 1,
Appeal: s.dummyAppeal,
},
{
Name: "test-approval-name-4",
Index: 1,
AppealID: appealA.ID,
Status: "test-status-1",
PolicyID: "test-policy-id",
PolicyVersion: 1,
Appeal: appealA,
},
{
Name: "test-approval-name-5",
Index: 1,
AppealID: appealB.ID,
Status: "test-status-1",
PolicyID: "test-policy-id",
PolicyVersion: 1,
Appeal: appealB,
},
}

err := s.repository.BulkInsert(context.Background(), dummyApprovals)
Expand All @@ -165,6 +212,16 @@ func (s *ApprovalRepositoryTestSuite) TestListApprovals() {
AppealID: s.dummyAppeal.ID,
Email: "approver1@email.com",
},
{
ApprovalID: dummyApprovals[3].ID,
AppealID: appealA.ID,
Email: "approver3@email.com",
},
{
ApprovalID: dummyApprovals[4].ID,
AppealID: appealB.ID,
Email: "approver3@email.com",
},
}

ctx := context.Background()
Expand All @@ -188,6 +245,32 @@ func (s *ApprovalRepositoryTestSuite) TestListApprovals() {
s.Equal(dummyApprovals[0].ID, approvals[0].ID)
})

s.Run("should return list of approvals where appeal status is canceled", func() {
approvals, err := s.repository.ListApprovals(context.Background(), &domain.ListApprovalsFilter{
AccountID: appealB.AccountID,
CreatedBy: dummyApprover[3].Email,
AppealStatuses: []string{domain.AppealStatusCanceled},
OrderBy: []string{"status", "updated_at:desc", "created_at"},
})

s.NoError(err)
s.Len(approvals, 1)
s.Equal(dummyApprovals[4].ID, approvals[0].ID)
})

s.Run("should return list of approvals where appeal status is pending", func() {
approvals, err := s.repository.ListApprovals(context.Background(), &domain.ListApprovalsFilter{
AccountID: appealA.AccountID,
CreatedBy: dummyApprover[3].Email,
AppealStatuses: []string{domain.AppealStatusPending},
OrderBy: []string{"status", "updated_at:desc", "created_at"},
})

s.NoError(err)
s.Len(approvals, 1)
s.Equal(dummyApprovals[3].ID, approvals[0].ID)
})

s.Run("should return error if conditions invalid", func() {
approvals, err := s.repository.ListApprovals(context.Background(), &domain.ListApprovalsFilter{
AccountID: "",
Expand Down
20 changes: 20 additions & 0 deletions third_party/OpenAPI/gotocompany/guardian/v1beta1/guardian.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,6 +549,16 @@
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "appealStatuses",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
Expand Down Expand Up @@ -1017,6 +1027,16 @@
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "appealStatuses",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
Expand Down