Add Common Controller Caching Infrastructure (hashicorp#19767)

* Add Common Controller Caching Infrastructure

Author: mkeeler

.grpcmocks.yaml

@@ -0,0 +1,20 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+with-expecter: true
+all: true
+recursive: true
+# We don't want the mocks within proto-public to prevent forcing a dependency
+# of the testify library on the modules usage. The mocks are only for
+# internal testing purposes. Other consumers can generated the mocks into
+# their own code base.
+dir: "grpcmocks/{{.InterfaceDirRelative}}"
+outpkg: "mock{{.PackageName}}"
+mockname: "{{.InterfaceName}}"
+packages:
+  github.com/hashicorp/consul/proto-public/pbacl:
+  github.com/hashicorp/consul/proto-public/pbconnectca:
+  github.com/hashicorp/consul/proto-public/pbdataplane:
+  github.com/hashicorp/consul/proto-public/pbserverdiscovery:
+  github.com/hashicorp/consul/proto-public/pbresource:
+  github.com/hashicorp/consul/proto-public/pbdns:

Makefile

@@ -11,7 +11,7 @@ GO_MODULES := $(shell find . -name go.mod -exec dirname {} \; | grep -v "proto-g
 # or the string @DEV to imply use what is currently installed locally.
 ###
 GOLANGCI_LINT_VERSION='v1.51.1'
-MOCKERY_VERSION='v2.20.0'
+MOCKERY_VERSION='v2.37.1'
 BUF_VERSION='v1.26.0'
 
 PROTOC_GEN_GO_GRPC_VERSION='v1.2.0'
@@ -562,11 +562,8 @@ proto-gen: proto-tools ## Regenerates all Go files from protobuf definitions
 
 .PHONY: proto-mocks
 proto-mocks: ## Proto mocks
-	for dir in $(MOCKED_PB_DIRS) ; do \
-		cd proto-public && \
-		rm -f $$dir/mock*.go && \
-		mockery --dir $$dir --inpackage --all --recursive --log-level trace ; \
-	done
+	@rm -rf grpcmocks/*
+	@mockery --config .grpcmocks.yaml
 
 .PHONY: proto-format
 proto-format: proto-tools ## Proto format

agent/grpc-external/services/resource/delete.go

@@ -189,7 +189,7 @@ func (s *Server) ensureDeleteRequestValid(req *pbresource.DeleteRequest) (*resou
 		return nil, err
 	}
 
-	if err := validateScopedTenancy(reg.Scope, reg.Type, req.Id.Tenancy); err != nil {
+	if err := validateScopedTenancy(reg.Scope, reg.Type, req.Id.Tenancy, false); err != nil {
 		return nil, err
 	}
 

agent/grpc-external/services/resource/list.go

@@ -109,7 +109,7 @@ func (s *Server) ensureListRequestValid(req *pbresource.ListRequest) (*resource.
 	}
 
 	// Error when partition scoped and namespace not empty.
-	if reg.Scope == resource.ScopePartition && req.Tenancy.Namespace != "" {
+	if reg.Scope == resource.ScopePartition && req.Tenancy.Namespace != "" && req.Tenancy.Namespace != storage.Wildcard {
 		return nil, status.Errorf(
 			codes.InvalidArgument,
 			"partition scoped type %s cannot have a namespace. got: %s",

agent/grpc-external/services/resource/list_by_owner.go

@@ -104,7 +104,7 @@ func (s *Server) ensureListByOwnerRequestValid(req *pbresource.ListByOwnerReques
 		return nil, err
 	}
 
-	if err = validateScopedTenancy(reg.Scope, reg.Type, req.Owner.Tenancy); err != nil {
+	if err = validateScopedTenancy(reg.Scope, reg.Type, req.Owner.Tenancy, true); err != nil {
 		return nil, err
 	}
 

agent/grpc-external/services/resource/list_test.go

@@ -220,17 +220,26 @@ func TestList_Tenancy_Defaults_And_Normalization(t *testing.T) {
 			artistRsp, err := client.Write(ctx, &pbresource.WriteRequest{Resource: artist})
 			require.NoError(t, err)
 
+			// Write a cluster scoped Executive
+			executive, err := demo.GenerateV1Executive("king-arthur", "CEO")
+			require.NoError(t, err)
+			executiveRsp, err := client.Write(ctx, &pbresource.WriteRequest{Resource: executive})
+			require.NoError(t, err)
+
 			// List and verify correct resource returned for empty tenancy units.
 			listRsp, err := client.List(ctx, &pbresource.ListRequest{
 				Type:    tc.typ,
 				Tenancy: tc.tenancy,
 			})
 			require.NoError(t, err)
 			require.Len(t, listRsp.Resources, 1)
-			if tc.typ == demo.TypeV1RecordLabel {
+			switch tc.typ {
+			case demo.TypeV1RecordLabel:
 				prototest.AssertDeepEqual(t, recordLabelRsp.Resource, listRsp.Resources[0])
-			} else {
+			case demo.TypeV1Artist:
 				prototest.AssertDeepEqual(t, artistRsp.Resource, listRsp.Resources[0])
+			case demo.TypeV1Executive:
+				prototest.AssertDeepEqual(t, executiveRsp.Resource, listRsp.Resources[0])
 			}
 		})
 	}

agent/grpc-external/services/resource/read.go

@@ -107,7 +107,7 @@ func (s *Server) ensureReadRequestValid(req *pbresource.ReadRequest) (*resource.
 	}
 
 	// Check scope
-	if err = validateScopedTenancy(reg.Scope, req.Id.Type, req.Id.Tenancy); err != nil {
+	if err = validateScopedTenancy(reg.Scope, req.Id.Type, req.Id.Tenancy, false); err != nil {
 		return nil, err
 	}
 

agent/grpc-external/services/resource/server.go

@@ -243,25 +243,26 @@ func tenancyExists(reg *resource.Registration, tenancyBridge TenancyBridge, tena
 	return nil
 }
 
-func validateScopedTenancy(scope resource.Scope, resourceType *pbresource.Type, tenancy *pbresource.Tenancy) error {
-	if scope == resource.ScopePartition && tenancy.Namespace != "" {
+func validateScopedTenancy(scope resource.Scope, resourceType *pbresource.Type, tenancy *pbresource.Tenancy, allowWildcards bool) error {
+	if scope == resource.ScopePartition && tenancy.Namespace != "" && (!allowWildcards || tenancy.Namespace != storage.Wildcard) {
 		return status.Errorf(
 			codes.InvalidArgument,
 			"partition scoped resource %s cannot have a namespace. got: %s",
 			resource.ToGVK(resourceType),
 			tenancy.Namespace,
 		)
 	}
+
 	if scope == resource.ScopeCluster {
-		if tenancy.Partition != "" {
+		if tenancy.Partition != "" && (!allowWildcards || tenancy.Partition != storage.Wildcard) {
 			return status.Errorf(
 				codes.InvalidArgument,
 				"cluster scoped resource %s cannot have a partition: %s",
 				resource.ToGVK(resourceType),
 				tenancy.Partition,
 			)
 		}
-		if tenancy.Namespace != "" {
+		if tenancy.Namespace != "" && (!allowWildcards || tenancy.Namespace != storage.Wildcard) {
 			return status.Errorf(
 				codes.InvalidArgument,
 				"cluster scoped resource %s cannot have a namespace: %s",

agent/grpc-external/services/resource/server_test.go

@@ -209,6 +209,31 @@ func wildcardTenancyCases() map[string]struct {
 				PeerName:  "local",
 			},
 		},
+		"partitioned type with wildcard partition and namespace": {
+			typ: demo.TypeV1RecordLabel,
+			tenancy: &pbresource.Tenancy{
+				Partition: "*",
+				Namespace: "*",
+				PeerName:  "local",
+			},
+		},
+		"cluster type with empty partition and namespace": {
+			typ: demo.TypeV1Executive,
+			tenancy: &pbresource.Tenancy{
+				Partition: "",
+				Namespace: "",
+				PeerName:  "local",
+			},
+		},
+
+		"cluster type with wildcard partition and namespace": {
+			typ: demo.TypeV1Executive,
+			tenancy: &pbresource.Tenancy{
+				Partition: "*",
+				Namespace: "*",
+				PeerName:  "local",
+			},
+		},
 	}
 }
 

agent/grpc-external/services/resource/watch.go

@@ -116,7 +116,7 @@ func (s *Server) ensureWatchListRequestValid(req *pbresource.WatchListRequest) (
 	}
 
 	// Check scope
-	if err = validateScopedTenancy(reg.Scope, req.Type, req.Tenancy); err != nil {
+	if err = validateScopedTenancy(reg.Scope, req.Type, req.Tenancy, true); err != nil {
 		return nil, err
 	}