go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/auth_service/internal/pubsub/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 pubsub
    16  
    17  import (
    18  	"context"
    19  
    20  	"cloud.google.com/go/iam"
    21  	"github.com/golang/mock/gomock"
    22  )
    23  
    24  // MockedPubsubClient is a mocked Pubsub client for testing.
    25  // It wraps a MockPubsubClient and a context with the mocked client.
    26  type MockedPubsubClient struct {
    27  	Client *MockPubsubClient
    28  	Ctx    context.Context
    29  }
    30  
    31  // NewMockedClient returns a new MockedPubsubClient for testing.
    32  func NewMockedClient(ctx context.Context, ctl *gomock.Controller) *MockedPubsubClient {
    33  	mockClient := NewMockPubsubClient(ctl)
    34  	return &MockedPubsubClient{
    35  		Client: mockClient,
    36  		Ctx:    context.WithValue(ctx, &mockedPubsubClientKey, mockClient),
    37  	}
    38  }
    39  
    40  // StubPolicy returns a stub IAM policy, where only the given emails
    41  // have been granted the subscriber role. The stub policy can be used as
    42  // the return value of mocks in tests.
    43  func StubPolicy(emails ...string) *iam.Policy {
    44  	p := &iam.Policy{}
    45  	for _, email := range emails {
    46  		p.Add(emailToIAMIdentity(email), subscriberRole)
    47  	}
    48  
    49  	return p
    50  }