[extensionauthtest] Remove extensionauthtest.MockClient

Author: mx-psi

.chloggen/mx-psi_seal-them-all.yaml

@@ -0,0 +1,26 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: extensionauthtest
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Remove the `extensionauthtest.MockClient` struct.
+
+# One or more tracking issues or pull requests related to the change
+issues: [12567]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: |
+  Use the standard `extensionauth.NewClient` constructor to create a client with a specific mock implementation. Use `extensionauthtest.NewErrorClient` to create a client that always returns an error.
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

config/configgrpc/configgrpc_test.go

@@ -30,7 +30,6 @@ import (
 	"go.opentelemetry.io/collector/config/configopaque"
 	"go.opentelemetry.io/collector/config/configtls"
 	"go.opentelemetry.io/collector/extension/extensionauth"
-	"go.opentelemetry.io/collector/extension/extensionauth/extensionauthtest"
 	"go.opentelemetry.io/collector/pdata/ptrace/ptraceotlp"
 )
 
@@ -41,6 +40,13 @@ func mustNewServerAuth(t *testing.T, opts ...extensionauth.ServerOption) extensi
 	return srv
 }
 
+func mustNewClientAuth(t *testing.T, opts ...extensionauth.ClientOption) extensionauth.Client {
+	t.Helper()
+	client, err := extensionauth.NewClient(opts...)
+	require.NoError(t, err)
+	return client
+}
+
 func TestNewDefaultKeepaliveClientConfig(t *testing.T) {
 	expectedKeepaliveClientConfig := &KeepaliveClientConfig{
 		Time:    time.Second * 10,
@@ -171,7 +177,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
 			},
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					testAuthID: &extensionauthtest.MockClient{},
+					testAuthID: mustNewClientAuth(t),
 				},
 			},
 		},
@@ -200,7 +206,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
 			},
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					testAuthID: &extensionauthtest.MockClient{},
+					testAuthID: mustNewClientAuth(t),
 				},
 			},
 		},
@@ -229,7 +235,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
 			},
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					testAuthID: &extensionauthtest.MockClient{},
+					testAuthID: mustNewClientAuth(t),
 				},
 			},
 		},

config/confighttp/confighttp_test.go

@@ -34,19 +34,11 @@ import (
 	"go.opentelemetry.io/collector/extension/extensionauth/extensionauthtest"
 )
 
-type customRoundTripper struct{}
-
-var _ http.RoundTripper = (*customRoundTripper)(nil)
-
-func (c *customRoundTripper) RoundTrip(*http.Request) (*http.Response, error) {
-	return nil, nil
-}
-
-func mustNewServerAuth(t *testing.T, opts ...extensionauth.ServerOption) extensionauth.Server {
+func build[T any, O any](t *testing.T, builder func(...O) (T, error), opts ...O) T {
 	t.Helper()
-	srv, err := extensionauth.NewServer(opts...)
+	obj, err := builder(opts...)
 	require.NoError(t, err)
-	return srv
+	return obj
 }
 
 var (
@@ -61,7 +53,7 @@ var (
 func TestAllHTTPClientSettings(t *testing.T) {
 	host := &mockHost{
 		ext: map[component.ID]component.Component{
-			testAuthID: &extensionauthtest.MockClient{ResultRoundTripper: &customRoundTripper{}},
+			testAuthID: build(t, extensionauth.NewClient),
 		},
 	}
 
@@ -187,7 +179,7 @@ func TestAllHTTPClientSettings(t *testing.T) {
 func TestPartialHTTPClientSettings(t *testing.T) {
 	host := &mockHost{
 		ext: map[component.ID]component.Component{
-			testAuthID: &extensionauthtest.MockClient{ResultRoundTripper: &customRoundTripper{}},
+			testAuthID: build(t, extensionauth.NewClient),
 		},
 	}
 
@@ -339,7 +331,21 @@ func TestHTTPClientSettingsError(t *testing.T) {
 	}
 }
 
+var _ http.RoundTripper = &customRoundTripper{}
+
+type customRoundTripper struct{}
+
+func (c *customRoundTripper) RoundTrip(*http.Request) (*http.Response, error) {
+	return nil, nil
+}
+
 func TestHTTPClientSettingWithAuthConfig(t *testing.T) {
+
+	customRoundTripperOpt := extensionauth.WithClientRoundTripper(
+		func(http.RoundTripper) (http.RoundTripper, error) {
+			return &customRoundTripper{}, nil
+		})
+
 	tests := []struct {
 		name      string
 		shouldErr bool
@@ -355,9 +361,7 @@ func TestHTTPClientSettingWithAuthConfig(t *testing.T) {
 			shouldErr: false,
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					mockID: &extensionauthtest.MockClient{
-						ResultRoundTripper: &customRoundTripper{},
-					},
+					mockID: build(t, extensionauth.NewClient),
 				},
 			},
 		},
@@ -370,7 +374,7 @@ func TestHTTPClientSettingWithAuthConfig(t *testing.T) {
 			shouldErr: true,
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					mockID: &extensionauthtest.MockClient{ResultRoundTripper: &customRoundTripper{}},
+					mockID: build(t, extensionauth.NewClient),
 				},
 			},
 		},
@@ -392,7 +396,7 @@ func TestHTTPClientSettingWithAuthConfig(t *testing.T) {
 			shouldErr: false,
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					mockID: &extensionauthtest.MockClient{ResultRoundTripper: &customRoundTripper{}},
+					mockID: build(t, extensionauth.NewClient, customRoundTripperOpt),
 				},
 			},
 		},
@@ -406,7 +410,7 @@ func TestHTTPClientSettingWithAuthConfig(t *testing.T) {
 			shouldErr: false,
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					mockID: &extensionauthtest.MockClient{ResultRoundTripper: &customRoundTripper{}},
+					mockID: build(t, extensionauth.NewClient, customRoundTripperOpt),
 				},
 			},
 		},
@@ -420,7 +424,7 @@ func TestHTTPClientSettingWithAuthConfig(t *testing.T) {
 			shouldErr: false,
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					mockID: &extensionauthtest.MockClient{ResultRoundTripper: &customRoundTripper{}},
+					mockID: build(t, extensionauth.NewClient, customRoundTripperOpt),
 				},
 			},
 		},
@@ -433,9 +437,7 @@ func TestHTTPClientSettingWithAuthConfig(t *testing.T) {
 			shouldErr: true,
 			host: &mockHost{
 				ext: map[component.ID]component.Component{
-					mockID: &extensionauthtest.MockClient{
-						ResultRoundTripper: &customRoundTripper{}, MustError: true,
-					},
+					mockID: build(t, extensionauthtest.NewErrorClient),
 				},
 			},
 		},
@@ -832,7 +834,7 @@ func TestHttpCorsWithSettings(t *testing.T) {
 
 	host := &mockHost{
 		ext: map[component.ID]component.Component{
-			mockID: mustNewServerAuth(t,
+			mockID: build(t, extensionauth.NewServer,
 				extensionauth.WithServerAuthenticate(func(ctx context.Context, _ map[string][]string) (context.Context, error) {
 					return ctx, errors.New("Settings failed")
 				}),
@@ -1144,7 +1146,7 @@ func TestServerAuth(t *testing.T) {
 
 	host := &mockHost{
 		ext: map[component.ID]component.Component{
-			mockID: mustNewServerAuth(t,
+			mockID: build(t, extensionauth.NewServer,
 				extensionauth.WithServerAuthenticate(func(ctx context.Context, _ map[string][]string) (context.Context, error) {
 					authCalled = true
 					return ctx, nil
@@ -1195,7 +1197,7 @@ func TestFailedServerAuth(t *testing.T) {
 	}
 	host := &mockHost{
 		ext: map[component.ID]component.Component{
-			mockID: mustNewServerAuth(t,
+			mockID: build(t, extensionauth.NewServer,
 				extensionauth.WithServerAuthenticate(func(ctx context.Context, _ map[string][]string) (context.Context, error) {
 					return ctx, errors.New("Settings failed")
 				}),
@@ -1376,7 +1378,7 @@ func TestAuthWithQueryParams(t *testing.T) {
 
 	host := &mockHost{
 		ext: map[component.ID]component.Component{
-			mockID: mustNewServerAuth(t,
+			mockID: build(t, extensionauth.NewServer,
 				extensionauth.WithServerAuthenticate(func(ctx context.Context, sources map[string][]string) (context.Context, error) {
 					require.Len(t, sources, 1)
 					assert.Equal(t, "1", sources["auth"][0])

extension/extensionauth/extensionauthtest/mock_clientauth.go

@@ -4,52 +4,25 @@
 package extensionauthtest // import "go.opentelemetry.io/collector/extension/extensionauth/extensionauthtest"
 
 import (
-	"context"
 	"errors"
 	"net/http"
 
 	"google.golang.org/grpc/credentials"
 
-	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/extension/extensionauth"
 )
 
-var (
-	_            extensionauth.Client = (*MockClient)(nil)
-	errMockError                      = errors.New("mock Error")
-)
-
-// MockClient provides a mock implementation of GRPCClient and HTTPClient interfaces
-type MockClient struct {
-	ResultRoundTripper      http.RoundTripper
-	ResultPerRPCCredentials credentials.PerRPCCredentials
-	MustError               bool
-}
-
-// Start for the MockClient does nothing
-func (m *MockClient) Start(context.Context, component.Host) error {
-	return nil
-}
-
-// Shutdown for the MockClient does nothing
-func (m *MockClient) Shutdown(context.Context) error {
-	return nil
-}
-
-// RoundTripper for the MockClient either returns error if the mock authenticator is forced to or
-// returns the supplied resultRoundTripper.
-func (m *MockClient) RoundTripper(http.RoundTripper) (http.RoundTripper, error) {
-	if m.MustError {
-		return nil, errMockError
-	}
-	return m.ResultRoundTripper, nil
-}
-
-// PerRPCCredentials for the MockClient either returns error if the mock authenticator is forced to or
-// returns the supplied resultPerRPCCredentials.
-func (m *MockClient) PerRPCCredentials() (credentials.PerRPCCredentials, error) {
-	if m.MustError {
-		return nil, errMockError
+var errMockError = errors.New("mock Error")
+
+// NewErrorClient returns a new extensionauth.Client that always returns an error on any of the client methods.
+func NewErrorClient(opts ...extensionauth.ClientOption) (extensionauth.Client, error) {
+	errorOpts := []extensionauth.ClientOption{
+		extensionauth.WithClientRoundTripper(func(base http.RoundTripper) (http.RoundTripper, error) {
+			return nil, errMockError
+		}),
+		extensionauth.WithClientPerRPCCredentials(func() (credentials.PerRPCCredentials, error) {
+			return nil, errMockError
+		}),
 	}
-	return m.ResultPerRPCCredentials, nil
+	return extensionauth.NewClient(append(errorOpts, opts...)...)
 }