Merge pull request #625 from 3scale/reset-ngx-state-in-busted-helper

Reset ngx state on every test

spec/ngx_helper.lua

@@ -1,10 +1,11 @@
 local busted = require('busted')
 local misc = require('resty.core.misc')
+local deepcopy = require('pl.tablex').deepcopy
 
-local ngx_var = ngx.var
-local ngx_ctx = ngx.ctx
-local ngx_shared = ngx.shared
-local ngx_header = ngx.header
+local ngx_var_original = deepcopy(ngx.var)
+local ngx_ctx_original = deepcopy(ngx.ctx)
+local ngx_shared_original = deepcopy(ngx.shared)
+local ngx_header_original = deepcopy(ngx.header)
 
 local register_getter = misc.register_ngx_magic_key_getter
 local register_setter = misc.register_ngx_magic_key_setter
@@ -25,14 +26,17 @@ end
 local get_status = getlocal(register_getter, 'ngx_magic_key_getters').status
 local set_status = getlocal(register_setter, 'ngx_magic_key_setters').status
 
-local function cleanup()
-  ngx.var = ngx_var
-  ngx.ctx = ngx_ctx
-  ngx.shared = ngx_shared
-  ngx.header = ngx_header
+local function reset_ngx_state()
+  ngx.var = deepcopy(ngx_var_original)
+  ngx.ctx = deepcopy(ngx_ctx_original)
+  ngx.shared = deepcopy(ngx_shared_original)
+  ngx.header = deepcopy(ngx_header_original)
+end
 
+local function cleanup()
   register_getter('status', get_status)
   register_setter('status', set_status)
+  reset_ngx_state()
 end
 
 local function setup()
@@ -43,9 +47,6 @@ local function setup()
   end)
 
   register_getter('status', function() return status end)
-
-  ngx.ctx = { }
-  ngx.header = { }
 end
 
 busted.after_each(cleanup)

spec/policy/cors/cors_spec.lua

@@ -40,8 +40,9 @@ describe('CORS policy', function()
 
   describe('.header_filter', function()
     before_each(function()
-      local headers = {}
-      stub(ngx.header, function() return headers end)
+      -- Replace original ngx.header. Openresty does not allow to modify it when
+      -- running busted tests.
+      ngx.header = {}
     end)
 
     describe('when the policy configuration defines CORS headers', function()

spec/policy/headers/headers_spec.lua

@@ -111,8 +111,9 @@ describe('Headers policy', function()
     local response_headers = 'response' -- header_filter() only modifies resp headers
 
     before_each(function()
-      local headers = {}
-      stub(ngx.header, function() return headers end)
+      -- Replace original ngx.header. Openresty does not allow to modify it when
+      -- running busted tests.
+      ngx.header = {}
     end)
 
     describe('the push operation', function()

spec/proxy_spec.lua

@@ -21,6 +21,10 @@ describe('Proxy', function()
   describe(':rewrite', function()
     local service
     before_each(function()
+      -- Replace original ngx.header. Openresty does not allow to modify it when
+      -- running busted tests.
+      ngx.header = {}
+
       ngx.var = { backend_endpoint = 'http://localhost:1853', uri = '/a/uri' }
       ngx.req = { get_method = function () return 'GET' end}
       service = Service.new({ extract_usage = function() end })