Ratelimit integration test (#5773)

What changed?
Adds integration test for the workflowID specific ratelimits

Why?
We need to make sure the requests and errors are passed correctly all the way to and from the client.

How did you test it?
N/A

Potential risks

Release notes

Documentation Changes

host/test_suites.go

@@ -60,4 +60,9 @@ type (
 		*require.Assertions
 		*IntegrationBase
 	}
+
+	WorkflowIDRateLimitIntegrationSuite struct {
+		*require.Assertions
+		*IntegrationBase
+	}
 )

host/testdata/integration_wfidratelimit_cluster.yaml

@@ -0,0 +1,11 @@
+enablearchival: true
+clusterno: 2
+messagingclientconfig:
+  usemock: true
+historyconfig:
+  numhistoryshards: 4
+  numhistoryhosts: 1
+workerconfig:
+  enablearchiver: false
+  enablereplicator: false
+  enableindexer: false

host/workflowidratelimit_test.go

@@ -0,0 +1,148 @@
+// The MIT License (MIT)
+
+// Copyright (c) 2017-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 host
+
+import (
+	"flag"
+	"testing"
+	"time"
+
+	"github.com/pborman/uuid"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"github.com/stretchr/testify/suite"
+
+	"github.com/uber/cadence/common"
+	"github.com/uber/cadence/common/clock"
+	"github.com/uber/cadence/common/dynamicconfig"
+	"github.com/uber/cadence/common/persistence"
+	pt "github.com/uber/cadence/common/persistence/persistence-tests"
+	"github.com/uber/cadence/common/types"
+)
+
+func TestWorkflowIDRateLimitIntegrationSuite(t *testing.T) {
+	// Loads the flags for persistence etc., if none are given they are set in ./flag.go
+	flag.Parse()
+
+	clusterConfig, err := GetTestClusterConfig("testdata/integration_wfidratelimit_cluster.yaml")
+	require.NoError(t, err)
+
+	clusterConfig.TimeSource = clock.NewMockedTimeSource()
+	clusterConfig.HistoryDynamicConfigOverrides = map[dynamicconfig.Key]interface{}{
+		dynamicconfig.WorkflowIDCacheExternalEnabled:     true,
+		dynamicconfig.WorkflowIDExternalRPS:              5,
+		dynamicconfig.WorkflowIDExternalRateLimitEnabled: true,
+	}
+
+	testCluster := NewPersistenceTestCluster(t, clusterConfig)
+
+	s := new(WorkflowIDRateLimitIntegrationSuite)
+	params := IntegrationBaseParams{
+		DefaultTestCluster:    testCluster,
+		VisibilityTestCluster: testCluster,
+		TestClusterConfig:     clusterConfig,
+	}
+	s.IntegrationBase = NewIntegrationBase(params)
+	suite.Run(t, s)
+}
+
+func (s *WorkflowIDRateLimitIntegrationSuite) SetupSuite() {
+	s.setupLogger()
+
+	s.Logger.Info("Running integration test against test cluster")
+	clusterMetadata := NewClusterMetadata(s.T(), s.testClusterConfig)
+	dc := persistence.DynamicConfiguration{
+		EnableCassandraAllConsistencyLevelDelete: dynamicconfig.GetBoolPropertyFn(true),
+		PersistenceSampleLoggingRate:             dynamicconfig.GetIntPropertyFn(100),
+		EnableShardIDMetrics:                     dynamicconfig.GetBoolPropertyFn(true),
+	}
+	params := pt.TestBaseParams{
+		DefaultTestCluster:    s.defaultTestCluster,
+		VisibilityTestCluster: s.visibilityTestCluster,
+		ClusterMetadata:       clusterMetadata,
+		DynamicConfiguration:  dc,
+	}
+	cluster, err := NewCluster(s.T(), s.testClusterConfig, s.Logger, params)
+	s.Require().NoError(err)
+	s.testCluster = cluster
+	s.engine = s.testCluster.GetFrontendClient()
+	s.adminClient = s.testCluster.GetAdminClient()
+
+	s.domainName = s.randomizeStr("integration-test-domain")
+	s.Require().NoError(s.registerDomain(s.domainName, 1, types.ArchivalStatusDisabled, "", types.ArchivalStatusDisabled, ""))
+
+	s.domainCacheRefresh()
+}
+
+func (s *WorkflowIDRateLimitIntegrationSuite) SetupTest() {
+	s.Assertions = require.New(s.T())
+}
+
+func (s *WorkflowIDRateLimitIntegrationSuite) TearDownSuite() {
+	s.tearDownSuite()
+}
+
+func (s *WorkflowIDRateLimitIntegrationSuite) TestWorkflowIDSpecificRateLimits() {
+	const (
+		testWorkflowID   = "integration-workflow-specific-rate-limit-test"
+		testWorkflowType = "integration-workflow-specific-rate-limit-test-type"
+		testTaskListName = "integration-workflow-specific-rate-limit-test-taskList"
+		testIdentity     = "worker1"
+	)
+
+	request := &types.StartWorkflowExecutionRequest{
+		RequestID:                           uuid.New(),
+		Domain:                              s.domainName,
+		WorkflowID:                          testWorkflowID,
+		WorkflowType:                        &types.WorkflowType{Name: testWorkflowType},
+		TaskList:                            &types.TaskList{Name: testTaskListName},
+		Input:                               nil,
+		ExecutionStartToCloseTimeoutSeconds: common.Int32Ptr(100),
+		TaskStartToCloseTimeoutSeconds:      common.Int32Ptr(1),
+		Identity:                            testIdentity,
+
+		WorkflowIDReusePolicy: types.WorkflowIDReusePolicyTerminateIfRunning.Ptr(),
+	}
+
+	ctx, cancel := createContext()
+	defer cancel()
+
+	// The ratelimit is 5 per second, so we should be able to start 5 workflows without any error
+	for i := 0; i < 5; i++ {
+		_, err := s.engine.StartWorkflowExecution(ctx, request)
+		assert.NoError(s.T(), err)
+	}
+
+	// Now we should get a rate limit error
+	for i := 0; i < 5; i++ {
+		_, err := s.engine.StartWorkflowExecution(ctx, request)
+		var busyErr *types.ServiceBusyError
+		assert.ErrorAs(s.T(), err, &busyErr)
+		assert.Equal(s.T(), common.WorkflowIDRateLimitReason, busyErr.Reason)
+	}
+
+	// After 1 second we should be able to start another workflow
+	time.Sleep(1 * time.Second)
+	_, err := s.engine.StartWorkflowExecution(ctx, request)
+	assert.NoError(s.T(), err)
+}