Added tests for request rate limiting

Author: Harvey Lowndes

pkg/oci/ccm.go

@@ -45,8 +45,8 @@ import (
 )
 
 const (
-	RateLimitQPSDefault    = 1.0
-	RateLimitBucketDefault = 5
+	rateLimitQPSDefault    = 1.0
+	rateLimitBucketDefault = 5
 )
 
 // ProviderName uniquely identifies the Oracle Bare Metal Cloud Services (OCI)
@@ -232,16 +232,16 @@ func buildConfigurationProvider(config *Config) (common.ConfigurationProvider, e
 func buildNewRateLimiter(config *RateLimiterConfig) client.RateLimiter {
 	// Set to default values if configuration not declared
 	if config.RateLimitQPSRead == 0 {
-		config.RateLimitQPSRead = RateLimitQPSDefault
+		config.RateLimitQPSRead = rateLimitQPSDefault
 	}
 	if config.RateLimitBucketRead == 0 {
-		config.RateLimitBucketRead = RateLimitBucketDefault
+		config.RateLimitBucketRead = rateLimitBucketDefault
 	}
 	if config.RateLimitQPSWrite == 0 {
-		config.RateLimitQPSWrite = RateLimitQPSDefault
+		config.RateLimitQPSWrite = rateLimitQPSDefault
 	}
 	if config.RateLimitBucketWrite == 0 {
-		config.RateLimitBucketWrite = RateLimitBucketDefault
+		config.RateLimitBucketWrite = rateLimitBucketDefault
 	}
 
 	rateLimiter := client.RateLimiter{

pkg/oci/ccm_test.go

@@ -0,0 +1,57 @@
+// Copyright 2017 Oracle and/or its affiliates. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package oci
+
+import (
+	"testing"
+)
+
+func TestBuildRateLimiterWithConfig(t *testing.T) {
+	var qpsRead float32 = 6.0
+	bucketRead := 20
+	var qpsWrite float32 = 8.0
+	bucketWrite := 20
+
+	rateLimiterConfig := &RateLimiterConfig{
+		RateLimitQPSRead:     qpsRead,
+		RateLimitBucketRead:  bucketRead,
+		RateLimitQPSWrite:    qpsWrite,
+		RateLimitBucketWrite: bucketWrite,
+	}
+
+	rateLimiter := buildNewRateLimiter(rateLimiterConfig)
+
+	if rateLimiter.Reader.QPS() != qpsRead {
+		t.Errorf("unexpected QPS (read) value: expected %f but found %f", qpsRead, rateLimiter.Reader.QPS())
+	}
+
+	if rateLimiter.Writer.QPS() != qpsWrite {
+		t.Errorf("unexpected QPS (write) value: expected %f but found %f", qpsWrite, rateLimiter.Writer.QPS())
+	}
+}
+
+func TestBuildRateLimiterWithDefaults(t *testing.T) {
+	rateLimiterConfig := &RateLimiterConfig{}
+
+	rateLimiter := buildNewRateLimiter(rateLimiterConfig)
+
+	if rateLimiter.Reader.QPS() != RateLimitQPSDefault {
+		t.Errorf("unexpected QPS (read) value: expected %f but found %f", RateLimitQPSDefault, rateLimiter.Reader.QPS())
+	}
+
+	if rateLimiter.Writer.QPS() != RateLimitQPSDefault {
+		t.Errorf("unexpected QPS (write) value: expected %f but found %f", RateLimitQPSDefault, rateLimiter.Writer.QPS())
+	}
+}

pkg/oci/client/client_test.go

@@ -15,9 +15,11 @@
 package client
 
 import (
+	"context"
 	"testing"
 
 	"github.com/oracle/oci-go-sdk/core"
+	"k8s.io/client-go/util/flowcontrol"
 )
 
 func TestInstanceTerminalState(t *testing.T) {
@@ -54,3 +56,90 @@ func TestInstanceTerminalState(t *testing.T) {
 		})
 	}
 }
+
+type mockComputeClient struct{}
+
+type mockVirtualNetworkClient struct{}
+
+type mockLoadBalancerClient struct{}
+
+func TestRateLimiting(t *testing.T) {
+	var qpsRead float32 = 5
+	bucketRead := 5
+	var qpsWrite float32 = 10
+	bucketWrite := 5
+
+	rateLimiter := RateLimiter{
+		Reader: flowcontrol.NewTokenBucketRateLimiter(
+			qpsRead,
+			bucketRead),
+		Writer: flowcontrol.NewTokenBucketRateLimiter(
+			qpsWrite,
+			bucketWrite),
+	}
+
+	client := newClient(rateLimiter)
+
+	// Read requests up to qpsRead should pass and the others fail
+	for i := 0; i < int(qpsRead)*2; i++ {
+		_, err := client.Compute().GetInstance(context.Background(), "123345")
+		p := (err == nil)
+
+		if (i < int(qpsRead) && !p) || (i >= int(qpsRead) && p) {
+			t.Errorf("unexpected result from request %d: %v", i, err)
+		}
+	}
+
+	// Write requests up to qpsWrite should pass and the others fail
+	ids := [2]string{"12334"}
+	for i := 0; i < int(qpsWrite)*2; i++ {
+		req := core.UpdateSecurityListRequest{
+			SecurityListId: &ids[0],
+		}
+
+		_, err := client.Networking().UpdateSecurityList(context.Background(), req)
+		p := (err == nil)
+
+		if (i < int(qpsRead) && !p) || (i >= int(qpsRead) && p) {
+			t.Errorf("unexpected result from request %d: %v", i, err)
+		}
+	}
+}
+
+func newClient(rateLimiter RateLimiter) Interface {
+	return &client{
+		compute:     &mockComputeClient{},
+		network:     &mockVirtualNetworkClient{},
+		rateLimiter: rateLimiter,
+	}
+}
+
+/* Mock ComputeClient interface implementations */
+func (c *mockComputeClient) GetInstance(ctx context.Context, request core.GetInstanceRequest) (response core.GetInstanceResponse, err error) {
+	return core.GetInstanceResponse{}, nil
+}
+
+func (c *mockComputeClient) ListInstances(ctx context.Context, request core.ListInstancesRequest) (response core.ListInstancesResponse, err error) {
+	return core.ListInstancesResponse{}, nil
+}
+
+func (c *mockComputeClient) ListVnicAttachments(ctx context.Context, request core.ListVnicAttachmentsRequest) (response core.ListVnicAttachmentsResponse, err error) {
+	return core.ListVnicAttachmentsResponse{}, nil
+}
+
+/* Mock NetworkClient interface implementations */
+func (c *mockVirtualNetworkClient) GetVnic(ctx context.Context, request core.GetVnicRequest) (response core.GetVnicResponse, err error) {
+	return core.GetVnicResponse{}, nil
+}
+
+func (c *mockVirtualNetworkClient) GetSubnet(ctx context.Context, request core.GetSubnetRequest) (response core.GetSubnetResponse, err error) {
+	return core.GetSubnetResponse{}, nil
+}
+
+func (c *mockVirtualNetworkClient) GetSecurityList(ctx context.Context, request core.GetSecurityListRequest) (response core.GetSecurityListResponse, err error) {
+	return core.GetSecurityListResponse{}, nil
+}
+
+func (c *mockVirtualNetworkClient) UpdateSecurityList(ctx context.Context, request core.UpdateSecurityListRequest) (response core.UpdateSecurityListResponse, err error) {
+	return core.UpdateSecurityListResponse{}, nil
+}