local sticky = require("balancer.sticky") local cookie = require("resty.cookie") local util = require("util") local original_ngx = ngx function mock_ngx(mock) local _ngx = mock setmetatable(_ngx, {__index = _G.ngx}) _G.ngx = _ngx end local function reset_ngx() _G.ngx = original_ngx end function get_mocked_cookie_new() local o = { value = nil } local mock = { get = function(self, n) return self.value end, set = function(self, c) self.value = c.value ; return true, nil end } setmetatable(o, mock) mock.__index = mock return function(self) return o; end end cookie.new = get_mocked_cookie_new() local function get_test_backend() return { name = "access-router-production-web-80", endpoints = { { address = "10.184.7.40", port = "8080", maxFails = 0, failTimeout = 0 }, }, sessionAffinityConfig = { name = "cookie", cookieSessionAffinity = { name = "test_name", hash = "sha1" } }, } end describe("Sticky", function() before_each(function() mock_ngx({ var = { location_path = "/", host = "test.com" } }) end) after_each(function() reset_ngx() end) local test_backend = get_test_backend() local test_backend_endpoint= test_backend.endpoints[1].address .. ":" .. test_backend.endpoints[1].port describe("new(backend)", function() context("when backend specifies cookie name", function() it("returns an instance containing the corresponding cookie name", function() local sticky_balancer_instance = sticky:new(test_backend) local test_backend_cookie_name = test_backend.sessionAffinityConfig.cookieSessionAffinity.name assert.equal(sticky_balancer_instance:cookie_name(), test_backend_cookie_name) end) end) context("when backend does not specify cookie name", function() it("returns an instance with 'route' as cookie name", function() local temp_backend = util.deepcopy(test_backend) temp_backend.sessionAffinityConfig.cookieSessionAffinity.name = nil local sticky_balancer_instance = sticky:new(temp_backend) local default_cookie_name = "route" assert.equal(sticky_balancer_instance:cookie_name(), default_cookie_name) end) end) end) describe("balance()", function() local mocked_cookie_new = cookie.new before_each(function() package.loaded["balancer.sticky"] = nil sticky = require("balancer.sticky") end) after_each(function() cookie.new = mocked_cookie_new end) context("when client doesn't have a cookie set and location is in cookie_locations", function() it("picks an endpoint for the client", function() local sticky_balancer_instance = sticky:new(test_backend) local peer = sticky_balancer_instance:balance() assert.equal(peer, test_backend_endpoint) end) it("sets a cookie on the client", function() local s = {} cookie.new = function(self) local cookie_instance = { set = function(self, payload) assert.equal(payload.key, test_backend.sessionAffinityConfig.cookieSessionAffinity.name) assert.equal(payload.path, ngx.var.location_path) assert.equal(payload.domain, nil) assert.equal(payload.httponly, true) assert.equal(payload.secure, false) return true, nil end, get = function(k) return false end, } s = spy.on(cookie_instance, "set") return cookie_instance, false end local b = get_test_backend() b.sessionAffinityConfig.cookieSessionAffinity.locations = {} b.sessionAffinityConfig.cookieSessionAffinity.locations["test.com"] = {"/"} local sticky_balancer_instance = sticky:new(b) assert.has_no.errors(function() sticky_balancer_instance:balance() end) assert.spy(s).was_called() end) it("sets a secure cookie on the client when being in ssl mode", function() ngx.var.https = "on" local s = {} cookie.new = function(self) local cookie_instance = { set = function(self, payload) assert.equal(payload.key, test_backend.sessionAffinityConfig.cookieSessionAffinity.name) assert.equal(payload.path, ngx.var.location_path) assert.equal(payload.domain, nil) assert.equal(payload.httponly, true) assert.equal(payload.secure, true) return true, nil end, get = function(k) return false end, } s = spy.on(cookie_instance, "set") return cookie_instance, false end local b = get_test_backend() b.sessionAffinityConfig.cookieSessionAffinity.locations = {} b.sessionAffinityConfig.cookieSessionAffinity.locations["test.com"] = {"/"} local sticky_balancer_instance = sticky:new(b) assert.has_no.errors(function() sticky_balancer_instance:balance() end) assert.spy(s).was_called() end) end) context("when client doesn't have a cookie set and cookie_locations contains a matching wildcard location", function() before_each(function () ngx.var.host = "dev.test.com" end) after_each(function () ngx.var.host = "test.com" end) it("sets a cookie on the client", function() local s = {} cookie.new = function(self) local cookie_instance = { set = function(self, payload) assert.equal(payload.key, test_backend.sessionAffinityConfig.cookieSessionAffinity.name) assert.equal(payload.path, ngx.var.location_path) assert.equal(payload.domain, nil) assert.equal(payload.httponly, true) assert.equal(payload.secure, false) return true, nil end, get = function(k) return false end, } s = spy.on(cookie_instance, "set") return cookie_instance, false end local b = get_test_backend() b.sessionAffinityConfig.cookieSessionAffinity.locations = {} b.sessionAffinityConfig.cookieSessionAffinity.locations["*.test.com"] = {"/"} local sticky_balancer_instance = sticky:new(b) assert.has_no.errors(function() sticky_balancer_instance:balance() end) assert.spy(s).was_called() end) end) context("when client doesn't have a cookie set and location not in cookie_locations", function() it("picks an endpoint for the client", function() local sticky_balancer_instance = sticky:new(test_backend) local peer = sticky_balancer_instance:balance() assert.equal(peer, test_backend_endpoint) end) it("does not set a cookie on the client", function() local s = {} cookie.new = function(self) local cookie_instance = { set = function(self, payload) assert.equal(payload.key, test_backend.sessionAffinityConfig.cookieSessionAffinity.name) assert.equal(payload.path, ngx.var.location_path) assert.equal(payload.domain, ngx.var.host) assert.equal(payload.httponly, true) return true, nil end, get = function(k) return false end, } s = spy.on(cookie_instance, "set") return cookie_instance, false end local sticky_balancer_instance = sticky:new(get_test_backend()) assert.has_no.errors(function() sticky_balancer_instance:balance() end) assert.spy(s).was_not_called() end) end) context("when client has a cookie set", function() it("does not set a cookie", function() local s = {} cookie.new = function(self) local return_obj = { set = function(v) return false, nil end, get = function(k) return test_backend_endpoint end, } s = spy.on(return_obj, "set") return return_obj, false end local sticky_balancer_instance = sticky:new(test_backend) assert.has_no.errors(function() sticky_balancer_instance:balance() end) assert.spy(s).was_not_called() end) it("returns the correct endpoint for the client", function() local sticky_balancer_instance = sticky:new(test_backend) local peer = sticky_balancer_instance:balance() assert.equal(peer, test_backend_endpoint) end) end) end) local function get_several_test_backends(option) return { name = "access-router-production-web-80", endpoints = { { address = "10.184.7.40", port = "8080", maxFails = 0, failTimeout = 0 }, { address = "10.184.7.41", port = "8080", maxFails = 0, failTimeout = 0 }, }, sessionAffinityConfig = { name = "cookie", mode = option["mode"], cookieSessionAffinity = { name = "test_name", hash = "sha1", change_on_failure = option["change_on_failure"], locations = { ['test.com'] = {'/'} } } }, } end describe("balance() after error", function() local mocked_cookie_new = cookie.new before_each(function() package.loaded["balancer.sticky"] = nil sticky = require("balancer.sticky") end) after_each(function() cookie.new = mocked_cookie_new end) context("when request to upstream fails", function() it("changes upstream when change_on_failure option is true", function() local options = { {["change_on_failure"] = false, ["mode"] = nil}, {["change_on_failure"] = false, ["mode"] = 'balanced'}, {["change_on_failure"] = false, ["mode"] = 'persistent'}, {["change_on_failure"] = true, ["mode"] = nil}, {["change_on_failure"] = true, ["mode"] = 'balanced'}, {["change_on_failure"] = true, ["mode"] = 'persistent'} } for _, option in ipairs(options) do local sticky_balancer_instance = sticky:new(get_several_test_backends(option)) local old_upstream = sticky_balancer_instance:balance() assert.is.Not.Nil(old_upstream) for _ = 1, 100 do -- make sure upstream doesn't change on subsequent calls of balance() assert.equal(old_upstream, sticky_balancer_instance:balance()) end -- simulate request failure sticky_balancer_instance.get_last_failure = function() return "failed" end _G.ngx.var.upstream_addr = old_upstream for _ = 1, 100 do local new_upstream = sticky_balancer_instance:balance() if option["change_on_failure"] == false then -- upstream should be the same inspite of error, if change_on_failure option is false assert.equal(new_upstream, old_upstream) else -- upstream should change after error, if change_on_failure option is true assert.not_equal(new_upstream, old_upstream) end end end end) end) end) end)