Enable session affinity for canaries (#7371)
This commit is contained in:
wasker
GitHub
parent
a327a809d9
commit
f222c752be
17 changed files with 1021 additions and 322 deletions
|
|
@ -6,12 +6,9 @@ local original_ngx = ngx
|
|||
|
||||
local function reset_ngx()
|
||||
_G.ngx = original_ngx
|
||||
end
|
||||
|
||||
local function mock_ngx(mock)
|
||||
local _ngx = mock
|
||||
setmetatable(_ngx, { __index = ngx })
|
||||
_G.ngx = _ngx
|
||||
-- Ensure balancer cache is reset.
|
||||
_G.ngx.ctx.balancer = nil
|
||||
end
|
||||
|
||||
local function reset_balancer()
|
||||
|
|
@ -19,6 +16,19 @@ local function reset_balancer()
|
|||
balancer = require("balancer")
|
||||
end
|
||||
|
||||
local function mock_ngx(mock, after_mock_set)
|
||||
local _ngx = mock
|
||||
setmetatable(_ngx, { __index = ngx })
|
||||
_G.ngx = _ngx
|
||||
|
||||
if after_mock_set then
|
||||
after_mock_set()
|
||||
end
|
||||
|
||||
-- Balancer module caches ngx module, must be reset after mocks were configured.
|
||||
reset_balancer()
|
||||
end
|
||||
|
||||
local function reset_expected_implementations()
|
||||
expected_implementations = {
|
||||
["access-router-production-web-80"] = package.loaded["balancer.round_robin"],
|
||||
|
|
@ -26,7 +36,8 @@ local function reset_expected_implementations()
|
|||
["my-dummy-app-2"] = package.loaded["balancer.chash"],
|
||||
["my-dummy-app-3"] = package.loaded["balancer.sticky_persistent"],
|
||||
["my-dummy-app-4"] = package.loaded["balancer.ewma"],
|
||||
["my-dummy-app-5"] = package.loaded["balancer.sticky_balanced"]
|
||||
["my-dummy-app-5"] = package.loaded["balancer.sticky_balanced"],
|
||||
["my-dummy-app-6"] = package.loaded["balancer.chashsubset"]
|
||||
}
|
||||
end
|
||||
|
||||
|
|
@ -48,20 +59,35 @@ local function reset_backends()
|
|||
cookie = ""
|
||||
},
|
||||
},
|
||||
{ name = "my-dummy-app-1", ["load-balance"] = "round_robin", },
|
||||
{
|
||||
name = "my-dummy-app-2", ["load-balance"] = "chash",
|
||||
name = "my-dummy-app-1",
|
||||
["load-balance"] = "round_robin",
|
||||
},
|
||||
{
|
||||
name = "my-dummy-app-2",
|
||||
["load-balance"] = "round_robin", -- upstreamHashByConfig will take priority.
|
||||
upstreamHashByConfig = { ["upstream-hash-by"] = "$request_uri", },
|
||||
},
|
||||
{
|
||||
name = "my-dummy-app-3", ["load-balance"] = "ewma",
|
||||
sessionAffinityConfig = { name = "cookie", mode = 'persistent', cookieSessionAffinity = { name = "route" } }
|
||||
name = "my-dummy-app-3",
|
||||
["load-balance"] = "ewma", -- sessionAffinityConfig will take priority.
|
||||
sessionAffinityConfig = { name = "cookie", mode = "persistent", cookieSessionAffinity = { name = "route" } }
|
||||
},
|
||||
{ name = "my-dummy-app-4", ["load-balance"] = "ewma", },
|
||||
{
|
||||
name = "my-dummy-app-5", ["load-balance"] = "ewma", ["upstream-hash-by"] = "$request_uri",
|
||||
name = "my-dummy-app-4",
|
||||
["load-balance"] = "ewma",
|
||||
},
|
||||
{
|
||||
name = "my-dummy-app-5",
|
||||
["load-balance"] = "ewma", -- sessionAffinityConfig will take priority.
|
||||
upstreamHashByConfig = { ["upstream-hash-by"] = "$request_uri", },
|
||||
sessionAffinityConfig = { name = "cookie", cookieSessionAffinity = { name = "route" } }
|
||||
},
|
||||
{
|
||||
name = "my-dummy-app-6",
|
||||
["load-balance"] = "ewma", -- upstreamHashByConfig will take priority.
|
||||
upstreamHashByConfig = { ["upstream-hash-by"] = "$request_uri", ["upstream-hash-by-subset"] = "true", }
|
||||
},
|
||||
}
|
||||
end
|
||||
|
||||
|
|
@ -77,7 +103,7 @@ describe("Balancer", function()
|
|||
end)
|
||||
|
||||
describe("get_implementation()", function()
|
||||
it("returns correct implementation for given backend", function()
|
||||
it("uses heuristics to select correct load balancer implementation for a given backend", function()
|
||||
for _, backend in pairs(backends) do
|
||||
local expected_implementation = expected_implementations[backend.name]
|
||||
local implementation = balancer.get_implementation(backend)
|
||||
|
|
@ -89,8 +115,8 @@ describe("Balancer", function()
|
|||
describe("get_balancer()", function()
|
||||
it("always returns the same balancer for given request context", function()
|
||||
local backend = {
|
||||
name = "my-dummy-app-6", ["load-balance"] = "ewma",
|
||||
alternativeBackends = { "my-dummy-canary-app-6" },
|
||||
name = "my-dummy-app-100", ["load-balance"] = "ewma",
|
||||
alternativeBackends = { "my-dummy-canary-app-100" },
|
||||
endpoints = { { address = "10.184.7.40", port = "8080", maxFails = 0, failTimeout = 0 } },
|
||||
trafficShapingPolicy = {
|
||||
weight = 0,
|
||||
|
|
@ -100,8 +126,8 @@ describe("Balancer", function()
|
|||
},
|
||||
}
|
||||
local canary_backend = {
|
||||
name = "my-dummy-canary-app-6", ["load-balance"] = "ewma",
|
||||
alternativeBackends = { "my-dummy-canary-app-6" },
|
||||
name = "my-dummy-canary-app-100", ["load-balance"] = "ewma",
|
||||
alternativeBackends = { "my-dummy-canary-app-100" },
|
||||
endpoints = { { address = "11.184.7.40", port = "8080", maxFails = 0, failTimeout = 0 } },
|
||||
trafficShapingPolicy = {
|
||||
weight = 5,
|
||||
|
|
@ -112,7 +138,6 @@ describe("Balancer", function()
|
|||
}
|
||||
|
||||
mock_ngx({ var = { proxy_upstream_name = backend.name } })
|
||||
reset_balancer()
|
||||
|
||||
balancer.sync_backend(backend)
|
||||
balancer.sync_backend(canary_backend)
|
||||
|
|
@ -126,172 +151,223 @@ describe("Balancer", function()
|
|||
end)
|
||||
|
||||
describe("route_to_alternative_balancer()", function()
|
||||
local backend, _balancer
|
||||
local backend, _primaryBalancer
|
||||
|
||||
before_each(function()
|
||||
backend = backends[1]
|
||||
_balancer = {
|
||||
_primaryBalancer = {
|
||||
alternative_backends = {
|
||||
backend.name,
|
||||
}
|
||||
}
|
||||
mock_ngx({ var = { request_uri = "/" } })
|
||||
reset_balancer()
|
||||
end)
|
||||
|
||||
it("returns false when no trafficShapingPolicy is set", function()
|
||||
balancer.sync_backend(backend)
|
||||
assert.equal(false, balancer.route_to_alternative_balancer(_balancer))
|
||||
end)
|
||||
-- Not affinitized request must follow traffic shaping policies.
|
||||
describe("not affinitized", function()
|
||||
|
||||
it("returns false when no alternative backends is set", function()
|
||||
backend.trafficShapingPolicy.weight = 100
|
||||
balancer.sync_backend(backend)
|
||||
_balancer.alternative_backends = nil
|
||||
assert.equal(false, balancer.route_to_alternative_balancer(_balancer))
|
||||
end)
|
||||
before_each(function()
|
||||
_primaryBalancer.is_affinitized = function (_)
|
||||
return false
|
||||
end
|
||||
end)
|
||||
|
||||
it("returns false when alternative backends name does not match", function()
|
||||
backend.trafficShapingPolicy.weight = 100
|
||||
balancer.sync_backend(backend)
|
||||
_balancer.alternative_backends[1] = "nonExistingBackend"
|
||||
assert.equal(false, balancer.route_to_alternative_balancer(_balancer))
|
||||
end)
|
||||
it("returns false when no trafficShapingPolicy is set", function()
|
||||
balancer.sync_backend(backend)
|
||||
assert.equal(false, balancer.route_to_alternative_balancer(_primaryBalancer))
|
||||
end)
|
||||
|
||||
context("canary by weight", function()
|
||||
it("returns true when weight is 100", function()
|
||||
it("returns false when no alternative backends is set", function()
|
||||
backend.trafficShapingPolicy.weight = 100
|
||||
balancer.sync_backend(backend)
|
||||
assert.equal(true, balancer.route_to_alternative_balancer(_balancer))
|
||||
_primaryBalancer.alternative_backends = nil
|
||||
assert.equal(false, balancer.route_to_alternative_balancer(_primaryBalancer))
|
||||
end)
|
||||
|
||||
it("returns false when weight is 0", function()
|
||||
backend.trafficShapingPolicy.weight = 0
|
||||
it("returns false when alternative backends name does not match", function()
|
||||
backend.trafficShapingPolicy.weight = 100
|
||||
balancer.sync_backend(backend)
|
||||
assert.equal(false, balancer.route_to_alternative_balancer(_balancer))
|
||||
_primaryBalancer.alternative_backends[1] = "nonExistingBackend"
|
||||
assert.equal(false, balancer.route_to_alternative_balancer(_primaryBalancer))
|
||||
end)
|
||||
|
||||
describe("canary by weight", function()
|
||||
it("returns true when weight is 100", function()
|
||||
backend.trafficShapingPolicy.weight = 100
|
||||
balancer.sync_backend(backend)
|
||||
assert.equal(true, balancer.route_to_alternative_balancer(_primaryBalancer))
|
||||
end)
|
||||
|
||||
it("returns false when weight is 0", function()
|
||||
backend.trafficShapingPolicy.weight = 0
|
||||
balancer.sync_backend(backend)
|
||||
assert.equal(false, balancer.route_to_alternative_balancer(_primaryBalancer))
|
||||
end)
|
||||
end)
|
||||
|
||||
describe("canary by cookie", function()
|
||||
it("returns correct result for given cookies", function()
|
||||
local test_patterns = {
|
||||
{
|
||||
case_title = "cookie_value is 'always'",
|
||||
request_cookie_name = "canaryCookie",
|
||||
request_cookie_value = "always",
|
||||
expected_result = true,
|
||||
},
|
||||
{
|
||||
case_title = "cookie_value is 'never'",
|
||||
request_cookie_name = "canaryCookie",
|
||||
request_cookie_value = "never",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "cookie_value is undefined",
|
||||
request_cookie_name = "canaryCookie",
|
||||
request_cookie_value = "foo",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "cookie_name is undefined",
|
||||
request_cookie_name = "foo",
|
||||
request_cookie_value = "always",
|
||||
expected_result = false
|
||||
},
|
||||
}
|
||||
for _, test_pattern in pairs(test_patterns) do
|
||||
mock_ngx({ var = {
|
||||
["cookie_" .. test_pattern.request_cookie_name] = test_pattern.request_cookie_value,
|
||||
request_uri = "/"
|
||||
}})
|
||||
backend.trafficShapingPolicy.cookie = "canaryCookie"
|
||||
balancer.sync_backend(backend)
|
||||
assert.message("\nTest data pattern: " .. test_pattern.case_title)
|
||||
.equal(test_pattern.expected_result, balancer.route_to_alternative_balancer(_primaryBalancer))
|
||||
reset_ngx()
|
||||
end
|
||||
end)
|
||||
end)
|
||||
|
||||
describe("canary by header", function()
|
||||
it("returns correct result for given headers", function()
|
||||
local test_patterns = {
|
||||
-- with no header value setting
|
||||
{
|
||||
case_title = "no custom header value and header value is 'always'",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "always",
|
||||
expected_result = true,
|
||||
},
|
||||
{
|
||||
case_title = "no custom header value and header value is 'never'",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "never",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "no custom header value and header value is undefined",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "foo",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "no custom header value and header name is undefined",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "",
|
||||
request_header_name = "foo",
|
||||
request_header_value = "always",
|
||||
expected_result = false,
|
||||
},
|
||||
-- with header value setting
|
||||
{
|
||||
case_title = "custom header value is set and header value is 'always'",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "foo",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "always",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "custom header value is set and header value match custom header value",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "foo",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "foo",
|
||||
expected_result = true,
|
||||
},
|
||||
{
|
||||
case_title = "custom header value is set and header name is undefined",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "foo",
|
||||
request_header_name = "bar",
|
||||
request_header_value = "foo",
|
||||
expected_result = false
|
||||
},
|
||||
}
|
||||
|
||||
for _, test_pattern in pairs(test_patterns) do
|
||||
mock_ngx({ var = {
|
||||
["http_" .. test_pattern.request_header_name] = test_pattern.request_header_value,
|
||||
request_uri = "/"
|
||||
}})
|
||||
backend.trafficShapingPolicy.header = test_pattern.header_name
|
||||
backend.trafficShapingPolicy.headerValue = test_pattern.header_value
|
||||
balancer.sync_backend(backend)
|
||||
assert.message("\nTest data pattern: " .. test_pattern.case_title)
|
||||
.equal(test_pattern.expected_result, balancer.route_to_alternative_balancer(_primaryBalancer))
|
||||
reset_ngx()
|
||||
end
|
||||
end)
|
||||
end)
|
||||
|
||||
end)
|
||||
|
||||
context("canary by cookie", function()
|
||||
it("returns correct result for given cookies", function()
|
||||
local test_patterns = {
|
||||
{
|
||||
case_title = "cookie_value is 'always'",
|
||||
request_cookie_name = "canaryCookie",
|
||||
request_cookie_value = "always",
|
||||
expected_result = true,
|
||||
},
|
||||
{
|
||||
case_title = "cookie_value is 'never'",
|
||||
request_cookie_name = "canaryCookie",
|
||||
request_cookie_value = "never",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "cookie_value is undefined",
|
||||
request_cookie_name = "canaryCookie",
|
||||
request_cookie_value = "foo",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "cookie_name is undefined",
|
||||
request_cookie_name = "foo",
|
||||
request_cookie_value = "always",
|
||||
expected_result = false
|
||||
},
|
||||
}
|
||||
for _, test_pattern in pairs(test_patterns) do
|
||||
mock_ngx({ var = {
|
||||
["cookie_" .. test_pattern.request_cookie_name] = test_pattern.request_cookie_value,
|
||||
request_uri = "/"
|
||||
}})
|
||||
reset_balancer()
|
||||
backend.trafficShapingPolicy.cookie = "canaryCookie"
|
||||
balancer.sync_backend(backend)
|
||||
assert.message("\nTest data pattern: " .. test_pattern.case_title)
|
||||
.equal(test_pattern.expected_result, balancer.route_to_alternative_balancer(_balancer))
|
||||
reset_ngx()
|
||||
end
|
||||
end)
|
||||
end)
|
||||
-- Affinitized request prefers backend it is affinitized to.
|
||||
describe("affinitized", function()
|
||||
|
||||
context("canary by header", function()
|
||||
it("returns correct result for given headers", function()
|
||||
local test_patterns = {
|
||||
-- with no header value setting
|
||||
{
|
||||
case_title = "no custom header value and header value is 'always'",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "always",
|
||||
expected_result = true,
|
||||
},
|
||||
{
|
||||
case_title = "no custom header value and header value is 'never'",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "never",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "no custom header value and header value is undefined",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "foo",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "no custom header value and header name is undefined",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "",
|
||||
request_header_name = "foo",
|
||||
request_header_value = "always",
|
||||
expected_result = false,
|
||||
},
|
||||
-- with header value setting
|
||||
{
|
||||
case_title = "custom header value is set and header value is 'always'",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "foo",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "always",
|
||||
expected_result = false,
|
||||
},
|
||||
{
|
||||
case_title = "custom header value is set and header value match custom header value",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "foo",
|
||||
request_header_name = "canaryHeader",
|
||||
request_header_value = "foo",
|
||||
expected_result = true,
|
||||
},
|
||||
{
|
||||
case_title = "custom header value is set and header name is undefined",
|
||||
header_name = "canaryHeader",
|
||||
header_value = "foo",
|
||||
request_header_name = "bar",
|
||||
request_header_value = "foo",
|
||||
expected_result = false
|
||||
},
|
||||
}
|
||||
|
||||
for _, test_pattern in pairs(test_patterns) do
|
||||
mock_ngx({ var = {
|
||||
["http_" .. test_pattern.request_header_name] = test_pattern.request_header_value,
|
||||
request_uri = "/"
|
||||
}})
|
||||
reset_balancer()
|
||||
backend.trafficShapingPolicy.header = test_pattern.header_name
|
||||
backend.trafficShapingPolicy.headerValue = test_pattern.header_value
|
||||
balancer.sync_backend(backend)
|
||||
assert.message("\nTest data pattern: " .. test_pattern.case_title)
|
||||
.equal(test_pattern.expected_result, balancer.route_to_alternative_balancer(_balancer))
|
||||
reset_ngx()
|
||||
end
|
||||
before_each(function()
|
||||
mock_ngx({ var = { request_uri = "/", proxy_upstream_name = backend.name } })
|
||||
balancer.sync_backend(backend)
|
||||
end)
|
||||
|
||||
it("returns false if request is affinitized to primary backend", function()
|
||||
_primaryBalancer.is_affinitized = function (_)
|
||||
return true
|
||||
end
|
||||
|
||||
local alternativeBalancer = balancer.get_balancer_by_upstream_name(backend.name)
|
||||
|
||||
local primarySpy = spy.on(_primaryBalancer, "is_affinitized")
|
||||
local alternativeSpy = spy.on(alternativeBalancer, "is_affinitized")
|
||||
|
||||
assert.is_false(balancer.route_to_alternative_balancer(_primaryBalancer))
|
||||
assert.spy(_primaryBalancer.is_affinitized).was_called()
|
||||
assert.spy(alternativeBalancer.is_affinitized).was_not_called()
|
||||
end)
|
||||
|
||||
it("returns true if request is affinitized to alternative backend", function()
|
||||
_primaryBalancer.is_affinitized = function (_)
|
||||
return false
|
||||
end
|
||||
|
||||
local alternativeBalancer = balancer.get_balancer_by_upstream_name(backend.name)
|
||||
alternativeBalancer.is_affinitized = function (_)
|
||||
return true
|
||||
end
|
||||
|
||||
local primarySpy = spy.on(_primaryBalancer, "is_affinitized")
|
||||
local alternativeSpy = spy.on(alternativeBalancer, "is_affinitized")
|
||||
|
||||
assert.is_true(balancer.route_to_alternative_balancer(_primaryBalancer))
|
||||
assert.spy(_primaryBalancer.is_affinitized).was_called()
|
||||
assert.spy(alternativeBalancer.is_affinitized).was_called()
|
||||
end)
|
||||
|
||||
end)
|
||||
end)
|
||||
|
||||
|
|
@ -432,10 +508,13 @@ describe("Balancer", function()
|
|||
},
|
||||
}
|
||||
}
|
||||
mock_ngx({ var = { proxy_upstream_name = "access-router-production-web-80" }, ctx = { } })
|
||||
ngx.shared.configuration_data:set("backends", cjson.encode(backends))
|
||||
reset_balancer()
|
||||
|
||||
mock_ngx({ var = { proxy_upstream_name = "access-router-production-web-80" }, ctx = { } }, function()
|
||||
ngx.shared.configuration_data:set("backends", cjson.encode(backends))
|
||||
end)
|
||||
|
||||
balancer.init_worker()
|
||||
|
||||
assert.not_equal(balancer.get_balancer(), nil)
|
||||
end)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue