Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
#
# A Bazel (http://bazel.io) workspace for the Google Cloud Endpoints runtime.

ISTIO_PROXY = "6e372fc510de08da504c2dd21060c09255c1aee7"
ISTIO_PROXY = "5b25d57a71c5835d265e724e0ca39b5d73a97df6"

git_repository(
name = "nginx",
Expand Down
3 changes: 3 additions & 0 deletions src/nginx/t/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
275 changes: 275 additions & 0 deletions src/nginx/t/quota.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,275 @@
# 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 Data::Dumper;

################################################################################

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(22);

# 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;
%%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, 2, 'Service control received two requests' );

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sometime, it could be 3, report will be called after 1s.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I set report_aggregator_config.flush_interval_ms longer to avoid report call?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is better to disable Report cache. Then you can expect the report will be called.

Here is example

https://github.com/cloudendpoints/esp/blob/master/src/nginx/t/report_failed.t#L76

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got it. Thanks.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added server conf to disable report cache.

service_control_config {
report_aggregator_config {
cache_entries: 0
flush_interval_ms: 1000
}
}


$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" );

if ( $quotaMetrics[0]->{metricName} eq "metrics_first" ) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can sort them first, then compare.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added array sorting

is( $quotaMetrics[0]->{metricName},
"metrics_first", "Quota metric name is 'metrics_first'" );
is( $quotaMetrics[0]->{metricValues}[0]->{int64Value},
2, "Quota metric value is 2" );
is( $quotaMetrics[1]->{metricName},
"metrics_second", "Quota metric name is 'metrics_second'" );
is( $quotaMetrics[1]->{metricValues}[0]->{int64Value},
1, "Quota metric value is 1" );
}
else {
is( $quotaMetrics[0]->{metricName},
"metrics_second", "Quota metric name is 'metrics_second'" );
is( $quotaMetrics[0]->{metricValues}[0]->{int64Value},
1, "Quota metric value is 1" );
is( $quotaMetrics[1]->{metricName},
"metrics_first", "Quota metric name is 'metrics_first'" );
is( $quotaMetrics[1]->{metricValues}[0]->{int64Value},
2, "Quota metric value is 2" );
}

################################################################################

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';

my $quota_response_success = sprintf(<<'EOF');
HTTP/1.1 200 OK
Connection: close

EOF

my $quota_response_success =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the name the same as line 231?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

ServiceControl::convert_proto( <<'EOF', 'quota_response', 'binary' );
operation_id: "a20ab01c-415e-46fb-953c-61c6768248ba"
quota_metrics {
metric_name: "serviceruntime.googleapis.com/api/consumer/quota_used_count"
metric_values {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we using these response fields? If no, can we just return "" to indicate empty proto. an empty proto indicate a positive respone

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied

labels {
key: "/quota_name"
value: "metrics_first"
}
int64_value: 2
}
metric_values {
labels {
key: "/quota_name"
value: "metrics_second"
}
int64_value: 1
}
}
EOF

$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',
$quota_response_success . $quota_response_success
);

$server->run();
}

################################################################################
Loading