Files
tasks/common/rpc/interceptor/rate_limit_test.go
Yichao YangandGitHub ae221a7806 Switch to uber gomock (#6493)
## What changed?
<!-- Describe what has changed in this PR -->
- Switch to uber gomock
- Generate workflowservice and operatorservice mock inside server repo,
instead of using imports from api-go to avoid making breaking changes
there.

## Why?
<!-- Tell your future self why have you made these changes -->
- google gomock is no longer maintained and doesn't support generics

## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->

## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->

## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->

## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
2024-09-09 14:44:20 -07:00

105 lines
3.6 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package interceptor
import (
"context"
"testing"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"go.temporal.io/server/common/quotas"
"go.uber.org/mock/gomock"
"google.golang.org/grpc"
)
type (
// rateLimitInterceptorSuite struct {
rateLimitInterceptorSuite struct {
suite.Suite
*require.Assertions
controller *gomock.Controller
mockRateLimiter *quotas.MockRequestRateLimiter
}
)
func TestRateLimitInterceptorSuite(t *testing.T) {
suite.Run(t, &rateLimitInterceptorSuite{})
}
func (s *rateLimitInterceptorSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.controller = gomock.NewController(s.T())
s.mockRateLimiter = quotas.NewMockRequestRateLimiter(s.controller)
}
func (s *rateLimitInterceptorSuite) TestInterceptWithTokenConfig() {
methodName := "TEST/METHOD"
interceptor := NewRateLimitInterceptor(s.mockRateLimiter, map[string]int{methodName: 0})
// mock rate limiter should not be called.
s.mockRateLimiter.EXPECT().Allow(gomock.Any(), gomock.Any()).MaxTimes(0).Return(false)
handlerCalled := false
handler := func(ctx context.Context, req any) (any, error) {
handlerCalled = true
return nil, nil
}
_, err := interceptor.Intercept(context.Background(), nil, &grpc.UnaryServerInfo{FullMethod: methodName}, handler)
s.NoError(err)
s.True(handlerCalled)
}
func (s *rateLimitInterceptorSuite) TestInterceptWithNoTokenConfig() {
interceptor := NewRateLimitInterceptor(s.mockRateLimiter, nil)
// mock rate limiter is set to blocking.
s.mockRateLimiter.EXPECT().Allow(gomock.Any(), gomock.Any()).MaxTimes(1).Return(false)
handlerCalled := false
handler := func(ctx context.Context, req any) (any, error) {
handlerCalled = true
return nil, nil
}
_, err := interceptor.Intercept(context.Background(), nil, &grpc.UnaryServerInfo{}, handler)
s.Error(err)
s.False(handlerCalled)
}
func (s *rateLimitInterceptorSuite) TestInterceptWithNonZeroTokenConfig() {
methodName := "TEST/METHOD"
interceptor := NewRateLimitInterceptor(s.mockRateLimiter, map[string]int{methodName: 100})
// mock rate limiter is set to non-blocking.
s.mockRateLimiter.EXPECT().Allow(gomock.Any(), gomock.Any()).MaxTimes(1).Return(true)
handlerCalled := false
handler := func(ctx context.Context, req any) (any, error) {
handlerCalled = true
return nil, nil
}
_, err := interceptor.Intercept(context.Background(), nil, &grpc.UnaryServerInfo{FullMethod: methodName}, handler)
s.NoError(err)
s.True(handlerCalled)
}