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.

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

Add ServiceEndpoints Mutation hook tests #18404

Merged
merged 2 commits into from
Aug 8, 2023
Merged
Changes from 1 commit
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
1 change: 1 addition & 0 deletions internal/catalog/internal/types/service_endpoints.go
Original file line number Diff line number Diff line change
@@ -54,6 +54,7 @@ func MutateServiceEndpoints(res *pbresource.Resource) error {

if !resource.EqualTenancy(res.Owner.Tenancy, res.Id.Tenancy) {
err = multierror.Append(err, resource.ErrOwnerTenantInvalid{
ResourceType: ServiceEndpointsV1Alpha1Type,
ResourceTenancy: res.Id.Tenancy,
OwnerTenancy: res.Owner.Tenancy,
})
70 changes: 46 additions & 24 deletions internal/catalog/internal/types/service_endpoints_test.go
Original file line number Diff line number Diff line change
@@ -7,11 +7,10 @@ import (
"testing"

"github.com/hashicorp/consul/internal/resource"
"github.com/hashicorp/consul/internal/resource/resourcetest"
pbcatalog "github.com/hashicorp/consul/proto-public/pbcatalog/v1alpha1"
"github.com/hashicorp/consul/proto-public/pbresource"
"github.com/stretchr/testify/require"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/types/known/anypb"
)

var (
@@ -22,21 +21,6 @@ var (
}
)

func createServiceEndpointsResource(t *testing.T, data protoreflect.ProtoMessage) *pbresource.Resource {
res := &pbresource.Resource{
Id: &pbresource.ID{
Type: ServiceEndpointsType,
Tenancy: defaultEndpointTenancy,
Name: "test-service",
},
}

var err error
res.Data, err = anypb.New(data)
require.NoError(t, err)
return res
}

func TestValidateServiceEndpoints_Ok(t *testing.T) {
data := &pbcatalog.ServiceEndpoints{
Endpoints: []*pbcatalog.Endpoint{
@@ -62,7 +46,7 @@ func TestValidateServiceEndpoints_Ok(t *testing.T) {
},
}

res := createServiceEndpointsResource(t, data)
res := resourcetest.Resource(ServiceEndpointsType, "test-service").WithData(t, data).Build()

err := ValidateServiceEndpoints(res)
require.NoError(t, err)
@@ -73,7 +57,7 @@ func TestValidateServiceEndpoints_ParseError(t *testing.T) {
// to cause the error we are expecting
data := &pbcatalog.IP{Address: "198.18.0.1"}

res := createServiceEndpointsResource(t, data)
res := resourcetest.Resource(ServiceEndpointsType, "test-service").WithData(t, data).Build()

err := ValidateServiceEndpoints(res)
require.Error(t, err)
@@ -167,18 +151,56 @@ func TestValidateServiceEndpoints_EndpointInvalid(t *testing.T) {

for name, tcase := range cases {
t.Run(name, func(t *testing.T) {
data := genData()
tcase.modify(data)
endpoint := genData()
tcase.modify(endpoint)

res := createServiceEndpointsResource(t, &pbcatalog.ServiceEndpoints{
data := &pbcatalog.ServiceEndpoints{
Endpoints: []*pbcatalog.Endpoint{
data,
endpoint,
},
})
}
res := resourcetest.Resource(ServiceEndpointsType, "test-service").WithData(t, data).Build()

err := ValidateServiceEndpoints(res)
require.Error(t, err)
tcase.validateErr(t, err)
})
}
}

func TestMutateServiceEndpoints_PopulateOwner(t *testing.T) {
res := resourcetest.Resource(ServiceEndpointsType, "test-service").Build()

require.NoError(t, MutateServiceEndpoints(res))
require.NotNil(t, res.Owner)
require.True(t, resource.EqualType(res.Owner.Type, ServiceType))
require.True(t, resource.EqualTenancy(res.Owner.Tenancy, defaultEndpointTenancy))
require.Equal(t, res.Owner.Name, res.Id.Name)
}

func TestMutateServiceEndpoints_InvalidOwner(t *testing.T) {
badTenancy := &pbresource.Tenancy{Partition: "default", Namespace: "other", PeerName: "local"}
res := resourcetest.Resource(ServiceEndpointsType, "test-service").
WithTenancy(defaultEndpointTenancy).
WithOwner(&pbresource.ID{
Type: DNSPolicyType,
Tenancy: badTenancy,
Name: "wrong"}).
Build()

err := MutateServiceEndpoints(res)
require.Error(t, err)

resourcetest.RequireError(t, err, resource.ErrOwnerTypeInvalid{ResourceType: ServiceEndpointsType, OwnerType: DNSPolicyType})
resourcetest.RequireError(t, err, resource.ErrOwnerTenantInvalid{
ResourceType: ServiceEndpointsType,
ResourceTenancy: defaultEndpointTenancy,
OwnerTenancy: badTenancy,
})
resourcetest.RequireError(t, err, resource.ErrInvalidField{
Name: "name",
Wrapped: errInvalidEndpointsOwnerName{
Name: "test-service",
OwnerName: "wrong"},
})
}
5 changes: 5 additions & 0 deletions internal/resource/resourcetest/builder.go
Original file line number Diff line number Diff line change
@@ -55,6 +55,11 @@ func ResourceID(id *pbresource.ID) *resourceBuilder {
}
}

func (b *resourceBuilder) WithTenancy(tenant *pbresource.Tenancy) *resourceBuilder {
b.resource.Id.Tenancy = tenant
return b
}

func (b *resourceBuilder) WithData(t T, data protoreflect.ProtoMessage) *resourceBuilder {
t.Helper()

9 changes: 9 additions & 0 deletions internal/resource/resourcetest/require.go
Original file line number Diff line number Diff line change
@@ -8,6 +8,15 @@ import (
"google.golang.org/protobuf/testing/protocmp"
)

// RequireError is useful for asserting that some chained multierror contains a specific error.
func RequireError[E error](t T, err error, expected E) {
t.Helper()

var actual E
require.ErrorAs(t, err, &actual)
prototest.AssertDeepEqual(t, expected, actual)
}

func RequireVersionUnchanged(t T, res *pbresource.Resource, version string) {
t.Helper()
require.Equal(t, version, res.Version)