CyberCoveLLC/threshold
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(handlers): utilize service func for scope service

Browse Source
This commit is contained in:
Damian Debkowski authored and Louis Ruch committed 2024-01-16 13:53:44 -08:00
1 parent 1be1636883
commit 6ca1bc3c3f
4 files changed
+71 -31
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

globals/fields.go
+1
View File
@@ -115,4 +115,5 @@ const (
ConnectionRecordingsField = "connection_recordings"
CreateTimeValues = "create_time_values"
DefaultPortField = "default_port"
StoragePolicyIdField = "storage_policy_id"
)
internal/daemon/controller/handler.go
+1 -1
View File
@@ -197,7 +197,7 @@ func (c *Controller) registerGrpcServices(s *grpc.Server) error {
services.RegisterAuthTokenServiceServer(s, authtoks)
}
if _, ok := currentServices[services.ScopeService_ServiceDesc.ServiceName]; !ok {
os, err := scopes.NewService(c.baseContext, c.IamRepoFn, c.kms, c.conf.RawConfig.Controller.MaxPageSize)
os, err := scopes.NewServiceFn(c.baseContext, c.IamRepoFn, c.kms, c.conf.RawConfig.Controller.MaxPageSize)
if err != nil {
return fmt.Errorf("failed to create scope handler service: %w", err)
}
internal/daemon/controller/handlers/scopes/scope_service.go
+32 -18
View File
@@ -43,6 +43,7 @@ import (
pb "github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/scopes"
wrappingKms "github.com/hashicorp/go-kms-wrapping/extras/kms/v2"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/types/known/timestamppb"
"google.golang.org/protobuf/types/known/wrapperspb"
)
@@ -139,23 +140,23 @@ type Service struct {
var _ pbs.ScopeServiceServer = (*Service)(nil)
// NewService returns a project service which handles project related requests to boundary.
func NewService(ctx context.Context, repo common.IamRepoFactory, kmsRepo *kms.Kms, maxPageSize uint) (Service, error) {
// NewServiceFn returns a service which handles scope related requests to boundary.
var NewServiceFn = func(ctx context.Context, repo common.IamRepoFactory, kmsRepo *kms.Kms, maxPageSize uint) (pbs.ScopeServiceServer, error) {
const op = "scopes.(Service).NewService"
if util.IsNil(repo) {
return Service{}, errors.New(ctx, errors.InvalidParameter, op, "missing iam repository")
return &Service{}, errors.New(ctx, errors.InvalidParameter, op, "missing iam repository")
}
if kmsRepo == nil {
return Service{}, errors.New(ctx, errors.InvalidParameter, op, "missing kms")
return &Service{}, errors.New(ctx, errors.InvalidParameter, op, "missing kms")
}
if maxPageSize == 0 {
maxPageSize = uint(globals.DefaultMaxPageSize)
}
return Service{repoFn: repo, kmsRepo: kmsRepo, maxPageSize: maxPageSize}, nil
return &Service{repoFn: repo, kmsRepo: kmsRepo, maxPageSize: maxPageSize}, nil
}
// ListScopes implements the interface pbs.ScopeServiceServer.
func (s Service) ListScopes(ctx context.Context, req *pbs.ListScopesRequest) (*pbs.ListScopesResponse, error) {
func (s *Service) ListScopes(ctx context.Context, req *pbs.ListScopesRequest) (*pbs.ListScopesResponse, error) {
const op = "scopes.(Service).ListScopes"
if req.GetScopeId() == "" {
req.ScopeId = scope.Global.String()
@@ -307,7 +308,7 @@ func (s Service) ListScopes(ctx context.Context, req *pbs.ListScopesRequest) (*p
}
// GetScopes implements the interface pbs.ScopeServiceServer.
func (s Service) GetScope(ctx context.Context, req *pbs.GetScopeRequest) (*pbs.GetScopeResponse, error) {
func (s *Service) GetScope(ctx context.Context, req *pbs.GetScopeRequest) (*pbs.GetScopeResponse, error) {
const op = "scopes.(Service).GetScope"
if err := validateGetRequest(req); err != nil {
@@ -357,7 +358,7 @@ func (s Service) GetScope(ctx context.Context, req *pbs.GetScopeRequest) (*pbs.G
}
// CreateScope implements the interface pbs.ScopeServiceServer.
func (s Service) CreateScope(ctx context.Context, req *pbs.CreateScopeRequest) (*pbs.CreateScopeResponse, error) {
func (s *Service) CreateScope(ctx context.Context, req *pbs.CreateScopeRequest) (*pbs.CreateScopeResponse, error) {
const op = "scopes.(Service).CreateScope"
if err := validateCreateRequest(req); err != nil {
@@ -402,7 +403,7 @@ func (s Service) CreateScope(ctx context.Context, req *pbs.CreateScopeRequest) (
}
// UpdateScope implements the interface pbs.ScopeServiceServer.
func (s Service) UpdateScope(ctx context.Context, req *pbs.UpdateScopeRequest) (*pbs.UpdateScopeResponse, error) {
func (s *Service) UpdateScope(ctx context.Context, req *pbs.UpdateScopeRequest) (*pbs.UpdateScopeResponse, error) {
const op = "scopes.(Service).UpdateScope"
if err := validateUpdateRequest(req); err != nil {
@@ -447,7 +448,7 @@ func (s Service) UpdateScope(ctx context.Context, req *pbs.UpdateScopeRequest) (
}
// DeleteScope implements the interface pbs.ScopeServiceServer.
func (s Service) DeleteScope(ctx context.Context, req *pbs.DeleteScopeRequest) (*pbs.DeleteScopeResponse, error) {
func (s *Service) DeleteScope(ctx context.Context, req *pbs.DeleteScopeRequest) (*pbs.DeleteScopeResponse, error) {
if err := validateDeleteRequest(req); err != nil {
return nil, err
}
@@ -463,7 +464,7 @@ func (s Service) DeleteScope(ctx context.Context, req *pbs.DeleteScopeRequest) (
}
// ListKeys implements the interface pbs.ScopeServiceServer.
func (s Service) ListKeys(ctx context.Context, req *pbs.ListKeysRequest) (*pbs.ListKeysResponse, error) {
func (s *Service) ListKeys(ctx context.Context, req *pbs.ListKeysRequest) (*pbs.ListKeysResponse, error) {
if req.GetId() == "" {
req.Id = scope.Global.String()
}
@@ -509,7 +510,7 @@ func (s Service) ListKeys(ctx context.Context, req *pbs.ListKeysRequest) (*pbs.L
}
// RotateKeys implements the interface pbs.ScopeServiceServer.
func (s Service) RotateKeys(ctx context.Context, req *pbs.RotateKeysRequest) (*pbs.RotateKeysResponse, error) {
func (s *Service) RotateKeys(ctx context.Context, req *pbs.RotateKeysRequest) (*pbs.RotateKeysResponse, error) {
if req.GetScopeId() == "" {
req.ScopeId = scope.Global.String()
}
@@ -529,7 +530,7 @@ func (s Service) RotateKeys(ctx context.Context, req *pbs.RotateKeysRequest) (*p
}
// ListKeyVersionDestructionJobs implements the interface pbs.ScopeServiceServer.
func (s Service) ListKeyVersionDestructionJobs(ctx context.Context, req *pbs.ListKeyVersionDestructionJobsRequest) (*pbs.ListKeyVersionDestructionJobsResponse, error) {
func (s *Service) ListKeyVersionDestructionJobs(ctx context.Context, req *pbs.ListKeyVersionDestructionJobsRequest) (*pbs.ListKeyVersionDestructionJobsResponse, error) {
if req.GetScopeId() == "" {
req.ScopeId = scope.Global.String()
}
@@ -571,7 +572,7 @@ func (s Service) ListKeyVersionDestructionJobs(ctx context.Context, req *pbs.Lis
}
// DestroyKeyVersion implements the interface pbs.ScopeServiceServer.
func (s Service) DestroyKeyVersion(ctx context.Context, req *pbs.DestroyKeyVersionRequest) (*pbs.DestroyKeyVersionResponse, error) {
func (s *Service) DestroyKeyVersion(ctx context.Context, req *pbs.DestroyKeyVersionRequest) (*pbs.DestroyKeyVersionResponse, error) {
if req.GetScopeId() == "" {
req.ScopeId = scope.Global.String()
}
@@ -598,7 +599,17 @@ func (s Service) DestroyKeyVersion(ctx context.Context, req *pbs.DestroyKeyVersi
}, nil
}
func (s Service) getFromRepo(ctx context.Context, id string) (*iam.Scope, error) {
// AttachStoragePolicy implements the interface pbs.ScopeServiceServer.
func (s *Service) AttachStoragePolicy(ctx context.Context, req *pbs.AttachStoragePolicyRequest) (*pbs.AttachStoragePolicyResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "Policies are an Enterprise-only feature")
}
// DetachStoragePolicy implements the interface pbs.ScopeServiceServer.
func (s *Service) DetachStoragePolicy(ctx context.Context, req *pbs.DetachStoragePolicyRequest) (*pbs.DetachStoragePolicyResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "Policies are an Enterprise-only feature")
}
func (s *Service) getFromRepo(ctx context.Context, id string) (*iam.Scope, error) {
repo, err := s.repoFn()
if err != nil {
return nil, err
@@ -613,7 +624,7 @@ func (s Service) getFromRepo(ctx context.Context, id string) (*iam.Scope, error)
return out, nil
}
func (s Service) createInRepo(ctx context.Context, authResults auth.VerifyResults, req *pbs.CreateScopeRequest) (*iam.Scope, error) {
func (s *Service) createInRepo(ctx context.Context, authResults auth.VerifyResults, req *pbs.CreateScopeRequest) (*iam.Scope, error) {
const op = "scopes.(Service).createInRepo"
item := req.GetItem()
var opts []iam.Option
@@ -652,7 +663,7 @@ func (s Service) createInRepo(ctx context.Context, authResults auth.VerifyResult
return out, nil
}
func (s Service) updateInRepo(ctx context.Context, parentScope *pb.ScopeInfo, scopeId string, mask []string, item *pb.Scope) (*iam.Scope, error) {
func (s *Service) updateInRepo(ctx context.Context, parentScope *pb.ScopeInfo, scopeId string, mask []string, item *pb.Scope) (*iam.Scope, error) {
const op = "scope.(Service).updateInRepo"
var opts []iam.Option
var scopeDesc, scopeName, scopePrimaryAuthMethodId string
@@ -712,7 +723,7 @@ func (s Service) updateInRepo(ctx context.Context, parentScope *pb.ScopeInfo, sc
return out, nil
}
func (s Service) deleteFromRepo(ctx context.Context, scopeId string) (bool, error) {
func (s *Service) deleteFromRepo(ctx context.Context, scopeId string) (bool, error) {
const op = "scope.(Service).deleteFromRepo"
repo, err := s.repoFn()
if err != nil {
@@ -823,6 +834,9 @@ func ToProto(ctx context.Context, in *iam.Scope, opt ...handlers.Option) (*pb.Sc
if outputFields.Has(globals.PrimaryAuthMethodIdField) && in.GetPrimaryAuthMethodId() != "" {
out.PrimaryAuthMethodId = &wrapperspb.StringValue{Value: in.GetPrimaryAuthMethodId()}
}
if outputFields.Has(globals.StoragePolicyIdField) {
out.StoragePolicyId = in.GetStoragePolicyId()
}
return &out, nil
}
internal/daemon/controller/handlers/scopes/scope_service_test.go
+37 -12
View File
@@ -38,6 +38,7 @@ import (
"github.com/stretchr/testify/require"
"google.golang.org/genproto/protobuf/field_mask"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/testing/protocmp"
"google.golang.org/protobuf/types/known/structpb"
@@ -337,7 +338,7 @@ func TestGet(t *testing.T) {
req := proto.Clone(toMerge).(*pbs.GetScopeRequest)
proto.Merge(req, tc.req)
s, err := scopes.NewService(context.Background(), repoFn, kms, 1000)
s, err := scopes.NewServiceFn(context.Background(), repoFn, kms, 1000)
require.NoError(err, "Couldn't create new project service.")
got, gErr := s.GetScope(auth.DisabledAuthTestContext(repoFn, tc.scopeId), req)
@@ -448,7 +449,7 @@ func TestList(t *testing.T) {
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
assert, require := assert.New(t), require.New(t)
s, err := scopes.NewService(context.Background(), repoFn, kms, 1000)
s, err := scopes.NewServiceFn(context.Background(), repoFn, kms, 1000)
require.NoError(err, "Couldn't create new role service.")
// Test with non-anonymous listing first
@@ -609,7 +610,7 @@ func TestList(t *testing.T) {
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
assert, require := assert.New(t), require.New(t)
s, err := scopes.NewService(context.Background(), repoFn, kms, 1000)
s, err := scopes.NewServiceFn(context.Background(), repoFn, kms, 1000)
require.NoError(err, "Couldn't create new scope service.")
// Test with non-anonymous listing first
@@ -756,7 +757,7 @@ func TestListPagination(t *testing.T) {
PageSize: 2,
}
s, err := scopes.NewService(ctx, repoFn, kms, 1000)
s, err := scopes.NewServiceFn(ctx, repoFn, kms, 1000)
require.NoError(t, err)
got, err := s.ListScopes(ctx, req)
@@ -974,7 +975,7 @@ func TestListPagination(t *testing.T) {
func TestDelete(t *testing.T) {
org, proj, repoFn, kms := createDefaultScopesRepoAndKms(t)
s, err := scopes.NewService(context.Background(), repoFn, kms, 1000)
s, err := scopes.NewServiceFn(context.Background(), repoFn, kms, 1000)
require.NoError(t, err, "Error when getting new project service.")
cases := []struct {
@@ -1048,7 +1049,7 @@ func TestDelete_twice(t *testing.T) {
assert, require := assert.New(t), require.New(t)
org, proj, repoFn, kms := createDefaultScopesRepoAndKms(t)
s, err := scopes.NewService(context.Background(), repoFn, kms, 1000)
s, err := scopes.NewServiceFn(context.Background(), repoFn, kms, 1000)
require.NoError(err, "Error when getting new scopes service")
ctx := auth.DisabledAuthTestContext(repoFn, org.GetPublicId())
req := &pbs.DeleteScopeRequest{
@@ -1306,7 +1307,7 @@ func TestCreate(t *testing.T) {
req := proto.Clone(toMerge).(*pbs.CreateScopeRequest)
proto.Merge(req, tc.req)
s, err := scopes.NewService(context.Background(), repoFn, kms, 1000)
s, err := scopes.NewServiceFn(context.Background(), repoFn, kms, 1000)
require.NoError(err, "Error when getting new project service.")
if name != "" {
@@ -1413,7 +1414,7 @@ func TestCreate(t *testing.T) {
func TestUpdate(t *testing.T) {
org, proj, repoFn, kms := createDefaultScopesRepoAndKms(t)
tested, err := scopes.NewService(context.Background(), repoFn, kms, 1000)
tested, err := scopes.NewServiceFn(context.Background(), repoFn, kms, 1000)
require.NoError(t, err, "Error when getting new project service.")
iamRepo, err := repoFn()
@@ -2458,7 +2459,7 @@ func TestListKeys(t *testing.T) {
t.Run(tt.name, func(t *testing.T) {
assert, require := assert.New(t), require.New(t)
s, err := scopes.NewService(context.Background(), iamRepoFn, tc.Kms(), 1000)
s, err := scopes.NewServiceFn(context.Background(), iamRepoFn, tc.Kms(), 1000)
require.NoError(err, "Couldn't create new project service.")
got, gErr := s.ListKeys(tt.authCtx, tt.req)
@@ -2583,7 +2584,7 @@ func TestRotateKeys(t *testing.T) {
t.Run(tt.name, func(t *testing.T) {
assert, require := assert.New(t), require.New(t)
s, err := scopes.NewService(context.Background(), iamRepoFn, tc.Kms(), 1000)
s, err := scopes.NewServiceFn(context.Background(), iamRepoFn, tc.Kms(), 1000)
require.NoError(err, "Couldn't create new project service.")
prevKeyVersions := map[uint32]int{}
@@ -2844,7 +2845,7 @@ func TestListKeyVersionDestructionJobs(t *testing.T) {
t.Run(tt.name, func(t *testing.T) {
assert, require := assert.New(t), require.New(t)
s, err := scopes.NewService(context.Background(), iamRepoFn, tc.Kms(), 1000)
s, err := scopes.NewServiceFn(context.Background(), iamRepoFn, tc.Kms(), 1000)
require.NoError(err, "Couldn't create new project service.")
got, gErr := s.ListKeyVersionDestructionJobs(tt.authCtx, tt.req)
@@ -3106,7 +3107,7 @@ func TestDestroyKeyVersion(t *testing.T) {
t.Run(tt.name, func(t *testing.T) {
assert, require := assert.New(t), require.New(t)
s, err := scopes.NewService(context.Background(), iamRepoFn, tc.Kms(), 1000)
s, err := scopes.NewServiceFn(context.Background(), iamRepoFn, tc.Kms(), 1000)
require.NoError(err, "Couldn't create new project service.")
got, gErr := s.DestroyKeyVersion(tt.authCtx, tt.req)
@@ -3131,3 +3132,27 @@ func TestDestroyKeyVersion(t *testing.T) {
})
}
}
func TestAttachStoragePolicy(t *testing.T) {
t.Run("unimplemented", func(t *testing.T) {
service := &scopes.Service{}
_, err := service.AttachStoragePolicy(context.Background(), &pbs.AttachStoragePolicyRequest{})
require.Error(t, err)
gotStatus, ok := status.FromError(err)
require.True(t, ok)
assert.Equal(t, gotStatus.Code(), codes.Unimplemented)
assert.Equal(t, gotStatus.Message(), "Policies are an Enterprise-only feature")
})
}
func TestDetachStoragePolicy(t *testing.T) {
t.Run("unimplemented", func(t *testing.T) {
service := &scopes.Service{}
_, err := service.DetachStoragePolicy(context.Background(), &pbs.DetachStoragePolicyRequest{})
require.Error(t, err)
gotStatus, ok := status.FromError(err)
require.True(t, ok)
assert.Equal(t, gotStatus.Code(), codes.Unimplemented)
assert.Equal(t, gotStatus.Message(), "Policies are an Enterprise-only feature")
})
}