Added test cases for rate limiting

WORKSPACE

@@ -26,7 +26,7 @@
 #
 # A Bazel (http://bazel.io) workspace for the Google Cloud Endpoints runtime.
 
-ISTIO_PROXY = "6e372fc510de08da504c2dd21060c09255c1aee7"
+ISTIO_PROXY = "0d04d7a191f644ef384d9585a5b93d0ffb8e7f3d"
 
 git_repository(
     name = "nginx",

src/nginx/t/BUILD

@@ -187,6 +187,9 @@ nginx_suite(
         "multiple_apis.t",
         "no_backend.t",
         "no_service_control.t",
+        "quota.t",
+        "quota_api_not_available.t",
+        "quota_exhausted.t",
         "reject_unrecognized.t",
         "report_3xx.t",
         "report_4xx.t",

src/nginx/t/check_no_consumer.t

@@ -131,7 +131,6 @@ my $expected_report_body = ServiceControl::gen_report_body({
         'serviceName' =>  'endpoints-test.cloudendpointsapis.com',
         'url' => '/shelves?key=this-is-an-api-key',
         'location' => 'us-central1',
-        'api_key' => 'this-is-an-api-key',
         'api_method' =>  'ListShelves',
         'http_method' => 'GET',
         'log_message' => 'Method: ListShelves',

src/nginx/t/cloud_trace.t

@@ -44,7 +44,7 @@ my $BackendPort = ApiManager::pick_port();
 my $ServiceControlPort = ApiManager::pick_port();
 my $CloudTracePort = ApiManager::pick_port();
 
-my $t = Test::Nginx->new()->has(qw/http proxy/)->plan(27);
+my $t = Test::Nginx->new()->has(qw/http proxy/)->plan(29);
 
 my $config = ApiManager::get_bookstore_service_config_allow_unregistered .
     ApiManager::read_test_file('testdata/logs_metrics.pb.txt') . <<"EOF";
@@ -151,11 +151,15 @@ is($json_obj->{traces}->[0]->{spans}->[3]->{name}, 'Call ServiceControl server',
     'Next trace span is Call ServiceControl server');
 is($json_obj->{traces}->[0]->{spans}->[3]->{parentSpanId}, $check_service_control_cache_id,
     'Parent of Call ServiceControl sever span is CheckServiceControlCache');
-is($json_obj->{traces}->[0]->{spans}->[4]->{name}, 'Backend',
+is($json_obj->{traces}->[0]->{spans}->[4]->{name}, 'QuotaControl',
     'Next trace span is Backend');
 is($json_obj->{traces}->[0]->{spans}->[4]->{parentSpanId}, $rootid,
     'Parent of Beckend span is root');
-my $backend_span_id = $json_obj->{traces}->[0]->{spans}->[4]->{spanId};
+is($json_obj->{traces}->[0]->{spans}->[5]->{name}, 'Backend',
+    'Next trace span is Backend');
+is($json_obj->{traces}->[0]->{spans}->[5]->{parentSpanId}, $rootid,
+    'Parent of Beckend span is root');
+my $backend_span_id = $json_obj->{traces}->[0]->{spans}->[5]->{spanId};
 
 my @bookstore_requests = ApiManager::read_http_stream($t, 'bookstore.log');
 is(scalar @bookstore_requests, 1, 'Bookstore received 1 request.');

src/nginx/t/quota.t

@@ -0,0 +1,253 @@
+# Copyright (C) Extensible Service Proxy Authors
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+################################################################################
+#
+use strict;
+use warnings;
+use JSON::PP;
+
+################################################################################
+
+use src::nginx::t::ApiManager;    # Must be first (sets up import path to
+                                  # the Nginx test module)
+use src::nginx::t::HttpServer;
+use src::nginx::t::ServiceControl;
+use Test::Nginx;    # Imports Nginx's test module
+use Test::More;     # And the test framework
+
+################################################################################
+
+# Port assignments
+my $NginxPort          = ApiManager::pick_port();
+my $BackendPort        = ApiManager::pick_port();
+my $ServiceControlPort = ApiManager::pick_port();
+
+my $t = Test::Nginx->new()->has(qw/http proxy/)->plan(26);
+
+# Save servce configuration that disables the report cache.
+# Report request will be sent for each client request
+$t->write_file('server.pb.txt', <<"EOF");
+service_control_config {
+  report_aggregator_config {
+    cache_entries: 0
+    flush_interval_ms: 1000
+  }
+}
+EOF
+
+# Save service name in the service configuration protocol buffer file.
+$t->write_file( 'service.pb.txt',
+  ApiManager::get_bookstore_service_config . <<"EOF");
+control {
+  environment: "http://127.0.0.1:${ServiceControlPort}"
+}
+quota {
+ metric_rules [
+   {
+     selector: "ListShelves"
+     metric_costs: [
+       {
+         key: "metrics_first"
+         value: 2
+       },
+       {
+         key: "metrics_second"
+         value: 1
+       }
+     ]
+   }
+ ]
+}
+EOF
+
+ApiManager::write_file_expand( $t, 'nginx.conf', <<"EOF");
+%%TEST_GLOBALS%%
+daemon off;
+events {
+  worker_connections 32;
+}
+http {
+  %%TEST_GLOBALS_HTTP%%
+  server_tokens off;
+  server {
+    listen 127.0.0.1:${NginxPort};
+    server_name localhost;
+    location / {
+      endpoints {
+        api service.pb.txt;
+        server_config server.pb.txt;
+        %%TEST_CONFIG%%
+        on;
+      }
+      proxy_pass http://127.0.0.1:${BackendPort};
+    }
+  }
+}
+EOF
+
+$t->run_daemon( \&bookstore, $t, $BackendPort, 'bookstore.log' );
+$t->run_daemon( \&servicecontrol, $t, $ServiceControlPort, 'servicecontrol.log' );
+is( $t->waitforsocket("127.0.0.1:${BackendPort}"), 1, 'Bookstore socket ready.' );
+is( $t->waitforsocket("127.0.0.1:${ServiceControlPort}"), 1,
+  'Service control socket ready.' );
+$t->run();
+
+################################################################################
+
+my $response = ApiManager::http_get(
+  $NginxPort, '/shelves?key=this-is-an-api-key' );
+
+$t->stop_daemons();
+
+my ( $response_headers, $response_body ) = split /\r\n\r\n/, $response, 2;
+
+like( $response_headers, qr/HTTP\/1\.1 200 OK/, 'Returned HTTP 200.' );
+is( $response_body, <<'EOF', 'Shelves returned in the response body.' );
+{ "shelves": [
+    { "name": "shelves/1", "theme": "Fiction" },
+    { "name": "shelves/2", "theme": "Fantasy" }
+  ]
+}
+EOF
+
+my @requests = ApiManager::read_http_stream( $t, 'bookstore.log' );
+is( scalar @requests, 1, 'Backend received one request' );
+
+my $r = shift @requests;
+
+is( $r->{verb}, 'GET', 'Backend request was a get' );
+is( $r->{uri}, '/shelves?key=this-is-an-api-key', 'Backend uri was /shelves' );
+is( $r->{headers}->{host}, "127.0.0.1:${BackendPort}", 'Host header was set' );
+
+@requests = ApiManager::read_http_stream( $t, 'servicecontrol.log' );
+is( scalar @requests, 3, 'Service control received three requests' );
+
+# check
+$r = shift @requests;
+is( $r->{verb}, 'POST', ':check verb was post' );
+is( $r->{uri}, '/v1/services/endpoints-test.cloudendpointsapis.com:check',
+  ':check was called');
+is( $r->{headers}->{host}, "127.0.0.1:${ServiceControlPort}",
+  'Host header was set');
+is( $r->{headers}->{'content-type'}, 'application/x-protobuf',
+  ':check Content-Type was protocol buffer');
+
+# test allocateQuota request was requested
+$r = shift @requests;
+is( $r->{verb}, 'POST', ':allocateQuota verb was post' );
+is( $r->{uri},
+  '/v1/services/endpoints-test.cloudendpointsapis.com:allocateQuota',
+  ':allocateQuota was called');
+is( $r->{headers}->{host}, "127.0.0.1:${ServiceControlPort}",
+  'Host header was set');
+is( $r->{headers}->{'content-type'}, 'application/x-protobuf',
+  ':check Content-Type was protocol buffer' );
+
+my $allocate_quota_request = decode_json(ServiceControl::convert_proto(
+  $r->{body}, 'quota_request', 'json' ) );
+
+my @quotaMetrics =
+  @{ $allocate_quota_request->{allocateOperation}->{quotaMetrics} };
+is( @quotaMetrics, 2, "Quota metrics should have two elements" );
+
+my @sorted_quotaMetrics =
+  sort { $a->{metricName} cmp $b->{metricName} } @quotaMetrics;
+
+is( $sorted_quotaMetrics[0]->{metricName}, "metrics_first",
+  "Quota metric name is 'metrics_first'" );
+is( $sorted_quotaMetrics[0]->{metricValues}[0]->{int64Value}, 2,
+  "Quota metric value is 2" );
+is( $sorted_quotaMetrics[1]->{metricName}, "metrics_second",
+  "Quota metric name is 'metrics_second'" );
+is( $sorted_quotaMetrics[1]->{metricValues}[0]->{int64Value}, 1,
+  "Quota metric value is 1" );
+
+# check report
+$r = shift @requests;
+
+is( $r->{verb}, 'POST', ':report verb was post' );
+is( $r->{uri}, '/v1/services/endpoints-test.cloudendpointsapis.com:report',
+  ':report was called');
+is( $r->{headers}->{host}, "127.0.0.1:${ServiceControlPort}",
+  'Host header was set');
+is( $r->{headers}->{'content-type'}, 'application/x-protobuf',
+  ':check Content-Type was protocol buffer' );
+
+################################################################################
+
+sub bookstore {
+  my ( $t, $port, $file ) = @_;
+  my $server = HttpServer->new( $port, $t->testdir() . '/' . $file )
+    or die "Can't create test server socket: $!\n";
+  local $SIG{PIPE} = 'IGNORE';
+
+  $server->on( 'GET', '/shelves?key=this-is-an-api-key', <<'EOF');
+HTTP/1.1 200 OK
+Connection: close
+
+{ "shelves": [
+    { "name": "shelves/1", "theme": "Fiction" },
+    { "name": "shelves/2", "theme": "Fantasy" }
+  ]
+}
+EOF
+  $server->run();
+}
+
+my @quota_responses      = ();
+my $quota_response_index = 0;
+
+sub servicecontrol {
+  my ( $t, $port, $file ) = @_;
+  my $server = HttpServer->new( $port, $t->testdir() . '/' . $file )
+    or die "Can't create test server socket: $!\n";
+  local $SIG{PIPE} = 'IGNORE';
+
+  $server->on( 'POST',
+    '/v1/services/endpoints-test.cloudendpointsapis.com:check', <<'EOF');
+HTTP/1.1 200 OK
+Connection: close
+
+EOF
+
+  $server->on('POST',
+    '/v1/services/endpoints-test.cloudendpointsapis.com:allocateQuota',
+    <<'EOF');
+HTTP/1.1 200 OK
+Connection: close
+
+EOF
+
+  $server->on( 'POST',
+    '/v1/services/endpoints-test.cloudendpointsapis.com:report', <<'EOF');
+HTTP/1.1 200 OK
+Connection: close
+
+EOF
+
+  $server->run();
+}
+
+################################################################################