Skip to content

t/apicast-caching.t tests conversion to blackbox #1351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eguzki merged 1 commit into from
Jun 6, 2022
Merged

t/apicast-caching.t tests conversion to blackbox #1351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
274 changes: 94 additions & 180 deletions t/apicast-caching.t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
use lib 't';
use Test::APIcast 'no_plan';
use Test::APIcast::Blackbox 'no_plan';

$ENV{APICAST_ACCESS_LOG_FILE} = "$Test::Nginx::Util::ErrLogFile";

repeat_each(1); # Can't be two as the second call would hit the cache
run_tests();
Expand All @@ -8,199 +10,111 @@ __DATA__

=== TEST 1: call to backend is cached
First call is done synchronously and the second out of band.
--- http_config
include $TEST_NGINX_UPSTREAM_CONFIG;
lua_package_path "$TEST_NGINX_LUA_PATH";
init_by_lua_block {
require('apicast.configuration_loader').mock({
services = {
{
id = 42,
backend_version = 1,
backend_authentication_type = 'service_token',
backend_authentication_value = 'token-value',
proxy = {
api_backend = "http://127.0.0.1:$TEST_NGINX_SERVER_PORT/api-backend/",
proxy_rules = {
{ pattern = '/', http_method = 'GET', metric_system_name = 'hits', delta = 2 }
}
}
--- configuration
{
"services": [{
"id": 42,
"backend_version": 1,
"backend_authentication_type": "service_token",
"backend_authentication_value": "token-value",
"proxy": {
"api_backend": "http://test:$TEST_NGINX_SERVER_PORT/",
"proxy_rules": [
{ "pattern": "/", "http_method" : "GET", "metric_system_name" : "hits", "delta" : 2 }
]
}
}]
}
--- backend
location /transactions/authrep.xml {
content_by_lua_block {
ngx.exit(200)
}
})
}
lua_shared_dict api_keys 10m;
--- config
include $TEST_NGINX_APICAST_CONFIG;

location /transactions/authrep.xml {
content_by_lua_block { ngx.exit(200) }
}

location /api-backend/ {
echo 'yay, api backend';
}

location ~ /test/(.+) {
proxy_pass $scheme://127.0.0.1:$server_port/$1$is_args$args;
proxy_set_header Host localhost;
}

location = /t {
echo_subrequest GET /test/one -q user_key=value;
echo_subrequest GET /test/two -q user_key=value;
}
--- request
GET /t
--- response_body
yay, api backend
yay, api backend
--- error_code: 200
--- grep_error_log eval: qr/apicast cache (?:hit|miss|write) key: [^,\s]+/
}
--- upstream
location /t {
echo 'yay, api backend';
}
--- pipelined_requests eval
["GET /t?user_key=value","GET /t?user_key=value"]
--- response_body eval
["yay, api backend\n", "yay, api backend\n"]
--- error_code eval
[200, 200]
--- grep_error_log_out
apicast cache miss key: 42:value:usage%5Bhits%5D=2
apicast cache write key: 42:value:usage%5Bhits%5D=2
apicast cache hit key: 42:value:usage%5Bhits%5D=2

=== TEST 2: multi service configuration
Two services can exist together and are split by their hostname.
--- http_config
include $TEST_NGINX_UPSTREAM_CONFIG;
lua_package_path "$TEST_NGINX_LUA_PATH";
init_by_lua_block {
require('apicast.configuration_loader').mock({
services = {
{
id = 1,
backend_version = 1,
backend_authentication_type = 'service_token',
backend_authentication_value = 'service-one',
proxy = {
api_backend = "http://127.0.0.1:$TEST_NGINX_SERVER_PORT/api-backend/foo/",
hosts = { 'one' },
proxy_rules = {
{ pattern = '/', http_method = 'GET', metric_system_name = 'hits', delta = 1 }
}
}
},
{
id = 2,
backend_version = 2,
backend_authentication_type = 'service_token',
backend_authentication_value = 'service-two',
proxy = {
api_backend = "http://127.0.0.1:$TEST_NGINX_SERVER_PORT/api-backend/bar/",
hosts = { 'two' },
proxy_rules = {
{ pattern = '/', http_method = 'GET', metric_system_name = 'hits', delta = 2 }
}
}
--- configuration
{
"services": [
{
"id": 1,
"backend_version": 1,
"backend_authentication_type": "service_token",
"backend_authentication_value": "service-one",
"proxy": {
"hosts": [ "one" ],
"api_backend": "http://test:$TEST_NGINX_SERVER_PORT/one",
"proxy_rules": [
{ "pattern": "/", "http_method" : "GET", "metric_system_name" : "hits", "delta" : 1 }
]
}
},
{
"id": 2,
"backend_version": 2,
"backend_authentication_type": "service_token",
"backend_authentication_value": "service-two",
"proxy": {
"hosts": [ "two" ],
"api_backend": "http://test:$TEST_NGINX_SERVER_PORT/two",
"proxy_rules": [
{ "pattern": "/", "http_method" : "GET", "metric_system_name" : "hits", "delta" : 2 }
]
}
}
]
}
--- backend
location /transactions/authrep.xml {
content_by_lua_block {
if ngx.var.arg_service_id == '1' then
if ngx.var.arg_service_token == 'service-one' then
return ngx.exit(200)
end
elseif ngx.var.arg_service_id == '2' then
if ngx.var.arg_service_token == 'service-two' then
return ngx.exit(200)
end
end

ngx.exit(403)
}
})
}
lua_shared_dict api_keys 10m;
--- config
include $TEST_NGINX_APICAST_CONFIG;

location /transactions/authrep.xml {
content_by_lua_block {
if ngx.var.arg_service_id == '1' then
if ngx.var.arg_service_token == 'service-one' then
return ngx.exit(200)
end
elseif ngx.var.arg_service_id == '2' then
if ngx.var.arg_service_token == 'service-two' then
return ngx.exit(200)
end
end

ngx.exit(403)
}
}

location ~ /api-backend(/.+) {
echo 'yay, api backend: $1';
}

location ~ /test/(.+) {
proxy_pass $scheme://127.0.0.1:$server_port/$1$is_args$args;
proxy_set_header Host $arg_host;
}

location = /t {
echo_subrequest GET /test/one -q user_key=one-key&host=one;
echo_subrequest GET /test/two -q app_id=two-id&app_key=two-key&host=two;
}
--- request
GET /t
--- response_body
yay, api backend: /foo/one
yay, api backend: /bar/two
--- error_code: 200
--- no_error_log
[error]
--- grep_error_log eval: qr/apicast cache (?:hit|miss|write) key: [^,\s]+/
--- upstream
location /one/one-resource {
echo 'yay, api backend: one';
}

location /two/two-resource {
echo 'yay, api backend: two';
}
--- pipelined_requests eval
["GET /one-resource?user_key=one-key","GET /two-resource?app_id=two-id&app_key=two-key"]
--- more_headers eval
["Host: one","Host: two"]
--- response_body eval
["yay, api backend: one\n", "yay, api backend: two\n"]
--- error_code eval
[200, 200]
--- no_error_log eval
[qr/\[error\]/, qr/\[error\]/]
--- grep_error_log_out
apicast cache miss key: 1:one-key:usage%5Bhits%5D=1
apicast cache write key: 1:one-key:usage%5Bhits%5D=1
apicast cache miss key: 2:two-id:two-key:usage%5Bhits%5D=2
apicast cache write key: 2:two-id:two-key:usage%5Bhits%5D=2

=== TEST 3: call to backend is cached
Copy link
Member Author

@eguzki eguzki Jun 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

TEST 1 and TEST 3 were identical

Thus, removing

First call is done synchronously and the second out of band.
--- http_config
include $TEST_NGINX_UPSTREAM_CONFIG;
lua_package_path "$TEST_NGINX_LUA_PATH";
init_by_lua_block {
require('apicast.configuration_loader').mock({
services = {
{
id = 42,
backend_version = 1,
backend_authentication_type = 'service_token',
backend_authentication_value = 'token-value',
proxy = {
api_backend = "http://127.0.0.1:$TEST_NGINX_SERVER_PORT/api-backend/",
proxy_rules = {
{ pattern = '/', http_method = 'GET', metric_system_name = 'hits', delta = 2 }
}
}
}
}
})
}
lua_shared_dict api_keys 10m;
--- config
include $TEST_NGINX_APICAST_CONFIG;

location /transactions/authrep.xml {
content_by_lua_block {
ngx.exit(200)
}
}

location /api-backend/ {
echo 'yay, api backend';
}

location ~ /test/(.+) {
proxy_pass $scheme://127.0.0.1:$server_port/$1$is_args$args;
proxy_set_header Host localhost;
}

location = /t {
echo_subrequest GET /test/one -q user_key=value;
echo_subrequest GET /test/two -q user_key=value;
}
--- request
GET /t
--- response_body
yay, api backend
yay, api backend
--- error_code: 200
--- grep_error_log eval: qr/apicast cache (?:hit|miss|write) key: [^,\s]+/
--- grep_error_log_out
apicast cache miss key: 42:value:usage%5Bhits%5D=2
apicast cache write key: 42:value:usage%5Bhits%5D=2
apicast cache hit key: 42:value:usage%5Bhits%5D=2