go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/auth_service/internal/gs/testutils.go (about)

     1  // Copyright 2024 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package gs
    16  
    17  import (
    18  	"context"
    19  
    20  	"github.com/golang/mock/gomock"
    21  )
    22  
    23  // MockedClient is a mocked Google Storage client for testing.
    24  // It wraps a MockClient and a context with the mocked client
    25  type MockedClient struct {
    26  	Client *MockClient
    27  	Ctx    context.Context
    28  }
    29  
    30  // NewMockedClient returns a new MockedClient for testing.
    31  func NewMockedClient(ctx context.Context, ctl *gomock.Controller) *MockedClient {
    32  	mockClient := NewMockClient(ctl)
    33  	return &MockedClient{
    34  		Client: mockClient,
    35  		Ctx:    context.WithValue(ctx, &mockedGSClientKey, mockClient),
    36  	}
    37  }