From 9296d950842d1987273d2b62804b6ae55118cb2a Mon Sep 17 00:00:00 2001 From: Joshua Casey Date: Tue, 11 Jun 2024 13:09:59 -0500 Subject: [PATCH] No need for calling code to use deprecated options --- cmd/pinniped/cmd/oidc_client_options.go | 8 +------- .../mockoidcclientoptions.go | 15 --------------- 2 files changed, 1 insertion(+), 22 deletions(-) diff --git a/cmd/pinniped/cmd/oidc_client_options.go b/cmd/pinniped/cmd/oidc_client_options.go index 2892dbeb1..bcb5d8d96 100644 --- a/cmd/pinniped/cmd/oidc_client_options.go +++ b/cmd/pinniped/cmd/oidc_client_options.go @@ -7,8 +7,6 @@ import ( "context" "net/http" - "github.com/go-logr/logr" - "go.pinniped.dev/generated/latest/apis/supervisor/idpdiscovery/v1alpha1" "go.pinniped.dev/pkg/oidcclient" ) @@ -16,9 +14,9 @@ import ( // OIDCClientOptions is an interface that wraps the creation of Options for the purpose of making them // more friendly to unit tests. Because the Option type refers to a private struct type, it is hard // to create mocks for them in tests of other packages. This provides a seam that can be mocked. +// No need for this interface to include deprecated options (such as WithLogger), since those should never be invoked. type OIDCClientOptions interface { WithContext(ctx context.Context) oidcclient.Option - WithLogger(logger logr.Logger) oidcclient.Option WithLoginLogger(logger oidcclient.Logger) oidcclient.Option WithListenPort(port uint16) oidcclient.Option WithSkipBrowserOpen() oidcclient.Option @@ -41,10 +39,6 @@ func (o *clientOptions) WithContext(ctx context.Context) oidcclient.Option { return oidcclient.WithContext(ctx) } -func (o *clientOptions) WithLogger(logger logr.Logger) oidcclient.Option { - return oidcclient.WithLogger(logger) //nolint:staticcheck // this is a shim for the deprecated code -} - func (o *clientOptions) WithLoginLogger(logger oidcclient.Logger) oidcclient.Option { return oidcclient.WithLoginLogger(logger) } diff --git a/internal/mocks/mockoidcclientoptions/mockoidcclientoptions.go b/internal/mocks/mockoidcclientoptions/mockoidcclientoptions.go index 5e30aa131..2dcc3be3b 100644 --- a/internal/mocks/mockoidcclientoptions/mockoidcclientoptions.go +++ b/internal/mocks/mockoidcclientoptions/mockoidcclientoptions.go @@ -18,7 +18,6 @@ import ( http "net/http" reflect "reflect" - logr "github.com/go-logr/logr" v1alpha1 "go.pinniped.dev/generated/latest/apis/supervisor/idpdiscovery/v1alpha1" oidcclient "go.pinniped.dev/pkg/oidcclient" gomock "go.uber.org/mock/gomock" @@ -89,20 +88,6 @@ func (mr *MockOIDCClientOptionsMockRecorder) WithListenPort(arg0 any) *gomock.Ca return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "WithListenPort", reflect.TypeOf((*MockOIDCClientOptions)(nil).WithListenPort), arg0) } -// WithLogger mocks base method. -func (m *MockOIDCClientOptions) WithLogger(arg0 logr.Logger) oidcclient.Option { - m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "WithLogger", arg0) - ret0, _ := ret[0].(oidcclient.Option) - return ret0 -} - -// WithLogger indicates an expected call of WithLogger. -func (mr *MockOIDCClientOptionsMockRecorder) WithLogger(arg0 any) *gomock.Call { - mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "WithLogger", reflect.TypeOf((*MockOIDCClientOptions)(nil).WithLogger), arg0) -} - // WithLoginFlow mocks base method. func (m *MockOIDCClientOptions) WithLoginFlow(arg0 v1alpha1.IDPFlow, arg1 string) oidcclient.Option { m.ctrl.T.Helper()