test: adjust LuaJIT test suite for Tarantool

This patch makes it possible to run LuaJIT test suite using
Tarantool.

It disables these tests from the LuaJIT test suite,
because _G and some modules in Tarantool are different from _G and
modules in LuaJIT:
* 359 lib/contents.lua --- base
* 364 lib/contents.lua --- string
* 366 lib/contents.lua --- pre-5.2 table
* 370 lib/contents.lua --- os
* 371 lib/contents.lua --- debug
* 372 lib/contents.lua --- package
* 374 lib/contents.lua --- package.loaders
* 375 lib/contents.lua --- package.loaded

There is also some difference in Tarantool runtime (such as forbidden
global variables usage by default), so testing environment need to be
tweaked before the testing begins. For this purpose LUAJIT_TEST_INIT
CMake variable is introduced. This variable accepts the name of the Lua
script to be run prior to every test chunk.

Resolves tarantool/tarantool#4064
Part of tarantool/tarantool#4473

Signed-off-by: Igor Munkin <imun@tarantool.org>

Author: ImeevMA

CMakeLists.txt

@@ -288,6 +288,24 @@ set(LUAJIT_TEST_BINARY ${LUAJIT_BINARY} CACHE STRING
   "Lua implementation to be used for tests. Default is 'luajit'."
 )
 
+# FIXME: If LuaJIT is used in parent project, provide an option
+# to pass Lua code to be run before tests are started.
+# XXX: Attentive reader might point to LUA_INIT environment
+# variable, but this is less secure way to run the particular Lua
+# code. As a result the application to be run against LuaJIT test
+# can ignore it (for more info, see the following issue).
+# https://github.com/tarantool/tarantool/issues/5744
+# XXX: This variable is used as '-e' Lua runtime flag value and
+# the hack works since the code passed via '-e' is executed before
+# the code passed via Lua script, *but* both are executed in a
+# single environment. Hence, if this environment need to be
+# tweaked, the introduced option can be used.
+# XXX: The default behaviour is nop, so /dev/null is the best
+# option for this.
+set(LUAJIT_TEST_INIT "/dev/null" CACHE STRING
+  "Lua code need to be run before tests are started. Default is nop."
+)
+
 add_subdirectory(test)
 
 # --- Misc rules ---------------------------------------------------------------

test/CMakeLists.txt

@@ -32,6 +32,9 @@ else()
   )
 endif()
 
+set(LUAJIT_TEST_COMMAND "${LUAJIT_TEST_BINARY} -e dofile[[${LUAJIT_TEST_INIT}]]")
+separate_arguments(LUAJIT_TEST_COMMAND)
+
 add_subdirectory(tarantool-tests)
 add_subdirectory(LuaJIT-tests)
 

test/LuaJIT-tests/CMakeLists.txt

@@ -6,6 +6,6 @@ add_custom_target(LuaJIT-tests DEPENDS ${LUAJIT_TEST_BINARY})
 add_custom_command(TARGET LuaJIT-tests
   COMMENT "Running LuaJIT-tests"
   COMMAND
-    ${LUAJIT_TEST_BINARY} ${CMAKE_CURRENT_SOURCE_DIR}/test.lua
+    ${LUAJIT_TEST_COMMAND} ${CMAKE_CURRENT_SOURCE_DIR}/test.lua
   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 )

test/LuaJIT-tests/lib/contents.lua

@@ -18,9 +18,11 @@ local function check(m, expected, exclude)
   end
 end
 
-do --- base
-  check(_G, "_G:_VERSION:arg:assert:collectgarbage:coroutine:debug:dofile:error:getmetatable:io:ipairs:load:loadfile:math:misc:next:os:package:pairs:pcall:print:rawequal:rawget:rawset:require:select:setmetatable:string:table:tonumber:tostring:type:xpcall", "rawlen:bit:bit32:jit:gcinfo:setfenv:getfenv:loadstring:unpack:module:newproxy")
-end
+-- Test is disabled, because _G and some modules in Tarantool
+-- are different from _G and modules in LuaJIT.
+-- do
+--   check(_G, "_G:_VERSION:arg:assert:collectgarbage:coroutine:debug:dofile:error:getmetatable:io:ipairs:load:loadfile:math:misc:next:os:package:pairs:pcall:print:rawequal:rawget:rawset:require:select:setmetatable:string:table:tonumber:tostring:type:xpcall", "rawlen:bit:bit32:jit:gcinfo:setfenv:getfenv:loadstring:unpack:module:newproxy")
+-- end
 
 do --- pre-5.2 base +lua<5.2
   assert(gcinfo)
@@ -64,9 +66,11 @@ do --- 5.2 math +lua>=5.2
   assert(not math.log10)
 end
 
-do --- string
-  check(string, "byte:char:dump:find:format:gmatch:gsub:len:lower:match:rep:reverse:sub:upper", "gfind")
-end
+-- Test is disabled for the Tarantool's binary,
+-- see the comment above.
+-- do
+--   check(string, "byte:char:dump:find:format:gmatch:gsub:len:lower:match:rep:reverse:sub:upper", "gfind")
+-- end
 
 do --- pre-5.2 string +lua<5.2 -compat5.2
   assert(not string.gfind)
@@ -76,9 +80,11 @@ do --- 5.2 string +lua>=5.2
   assert(not string.gfind)
 end
 
-do --- pre-5.2 table +lua<5.2
-  check(table, "concat:foreach:foreachi:getn:insert:maxn:move:remove:sort", "pack:unpack:setn:new")
-end
+-- Test is disabled for the Tarantool's binary,
+-- see the comment above.
+-- do
+--   check(table, "concat:foreach:foreachi:getn:insert:maxn:move:remove:sort", "pack:unpack:setn:new")
+-- end
 
 do --- 5.2 table +lua>=5.2
   check(table, "concat:insert:pack:remove:sort:unpack")
@@ -102,19 +108,25 @@ do --- io file
   check(debug.getmetatable(io.stdin), "__gc:__index:__tostring:close:flush:lines:read:seek:setvbuf:write")
 end
 
-do --- os
-  check(os, "clock:date:difftime:execute:exit:getenv:remove:rename:setlocale:time:tmpname")
-end
+-- Test is disabled for the Tarantool's binary,
+-- see the comment above.
+-- do
+--   check(os, "clock:date:difftime:execute:exit:getenv:remove:rename:setlocale:time:tmpname")
+-- end
 
-do --- debug
-  check(debug, "debug:gethook:getinfo:getlocal:getmetatable:getregistry:getupvalue:sethook:setlocal:setmetatable:setupvalue:traceback", "getfenv:setfenv:upvalueid:upvaluejoin:getuservalue:setuservalue")
-end
+-- Test is disabled for the Tarantool's binary,
+-- see the comment above.
+-- do
+--   check(debug, "debug:gethook:getinfo:getlocal:getmetatable:getregistry:getupvalue:sethook:setlocal:setmetatable:setupvalue:traceback", "getfenv:setfenv:upvalueid:upvaluejoin:getuservalue:setuservalue")
+-- end
 
 -- TODO: Check versional differences in debug library
 
-do --- package
-  check(package, "config:cpath:loaded:loadlib:path:preload", "searchpath:loaders:searchers:seeall")
-end
+-- Test is disabled for the Tarantool's binary,
+-- see the comment above.
+-- do
+--   check(package, "config:cpath:loaded:loadlib:path:preload", "searchpath:loaders:searchers:seeall")
+-- end
 
 do --- pre-5.2 package +lua<5.2
   assert(package.loaders)
@@ -128,19 +140,23 @@ do --- 5.2 package +lua>=5.2
   assert(not package.seeall)
 end
 
-do --- package.loaders
-  check(package.loaders or package.searchers, "1:2:3:4")
-end
-
-do --- package.loaded
-  local loaded = {}
-  for k, v in pairs(package.loaded) do
-    if type(k) ~= "string" or (k:sub(1, 7) ~= "common." and k:sub(1, 4) ~= "jit.") then
-      loaded[k] = v
-    end
-  end
-  check(loaded, "_G:coroutine:debug:io:math:misc:misc.memprof:os:package:string:table", "bit:bit32:common:ffi:jit:table.new")
-end
+-- Test is disabled for the Tarantool's binary,
+-- see the comment above.
+-- do
+--   check(package.loaders or package.searchers, "1:2:3:4")
+-- end
+
+-- Test is disabled for the Tarantool's binary,
+-- see the comment above.
+-- do
+--   local loaded = {}
+--   for k, v in pairs(package.loaded) do
+--     if type(k) ~= "string" or (k:sub(1, 7) ~= "common." and k:sub(1, 4) ~= "jit.") then
+--       loaded[k] = v
+--     end
+--   end
+--   check(loaded, "_G:coroutine:debug:io:math:misc:misc.memprof:os:package:string:table", "bit:bit32:common:ffi:jit:table.new")
+-- end
 
 do --- bit +bit
   check(bit, "arshift:band:bnot:bor:bswap:bxor:lshift:rol:ror:rshift:tobit:tohex")

test/tarantool-tests/CMakeLists.txt

@@ -88,7 +88,7 @@ add_custom_command(TARGET tarantool-tests
     LUA_CPATH="${LUA_CPATH}\;\;"
     LD_LIBRARY_PATH="${LD_LIBRARY_PATH}"
     ${PROVE} ${CMAKE_CURRENT_SOURCE_DIR}
-      --exec ${LUAJIT_TEST_BINARY}
+      --exec '${LUAJIT_TEST_COMMAND}'
       --ext ${LUA_TEST_SUFFIX}
       ${LUA_TEST_FLAGS}
   WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}