Restructure devtest's unittests and run them in CI (#11859)

This commit is contained in:
sfan5 2021-12-18 20:36:43 +01:00 committed by GitHub
parent 1c5ece8334
commit 8472141b79
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 292 additions and 75 deletions

@ -93,7 +93,7 @@ jobs:
run: | run: |
./bin/minetest --run-unittests ./bin/minetest --run-unittests
- name: Integration test - name: Integration test + devtest
run: | run: |
./util/test_multiplayer.sh ./util/test_multiplayer.sh

@ -1,6 +1,7 @@
dofile(core.get_modpath(core.get_current_modname()) .. "/crafting_prepare.lua")
-- Test minetest.clear_craft function -- Test minetest.clear_craft function
local function test_clear_craft() local function test_clear_craft()
minetest.log("info", "[unittests] Testing minetest.clear_craft")
-- Clearing by output -- Clearing by output
minetest.register_craft({ minetest.register_craft({
output = "foo", output = "foo",
@ -22,11 +23,10 @@ local function test_clear_craft()
minetest.clear_craft({recipe={{"foo", "bar"}}}) minetest.clear_craft({recipe={{"foo", "bar"}}})
assert(minetest.get_all_craft_recipes("foo") == nil) assert(minetest.get_all_craft_recipes("foo") == nil)
end end
unittests.register("test_clear_craft", test_clear_craft)
-- Test minetest.get_craft_result function -- Test minetest.get_craft_result function
local function test_get_craft_result() local function test_get_craft_result()
minetest.log("info", "[unittests] Testing minetest.get_craft_result")
-- normal -- normal
local input = { local input = {
method = "normal", method = "normal",
@ -107,14 +107,6 @@ local function test_get_craft_result()
assert(output.item) assert(output.item)
minetest.log("info", "[unittests] unrepairable tool crafting output.item:to_table(): "..dump(output.item:to_table())) minetest.log("info", "[unittests] unrepairable tool crafting output.item:to_table(): "..dump(output.item:to_table()))
-- unrepairable tool must not yield any output -- unrepairable tool must not yield any output
assert(output.item:get_name() == "") assert(output.item:is_empty())
end end
unittests.register("test_get_craft_result", test_get_craft_result)
function unittests.test_crafting()
test_clear_craft()
test_get_craft_result()
minetest.log("action", "[unittests] Crafting tests passed!")
return true
end

@ -1,18 +1,199 @@
unittests = {} unittests = {}
local modpath = minetest.get_modpath("unittests") unittests.list = {}
dofile(modpath .. "/random.lua")
dofile(modpath .. "/player.lua")
dofile(modpath .. "/crafting_prepare.lua")
dofile(modpath .. "/crafting.lua")
dofile(modpath .. "/itemdescription.lua")
if minetest.settings:get_bool("devtest_unittests_autostart", false) then -- name: Name of the test
unittests.test_random() -- func:
unittests.test_crafting() -- for sync: function(player, pos), should error on failure
unittests.test_short_desc() -- for async: function(callback, player, pos)
minetest.register_on_joinplayer(function(player) -- MUST call callback() or callback("error msg") in case of error once test is finished
unittests.test_player(player) -- this means you cannot use assert() in the test implementation
-- opts: {
-- player = false, -- Does test require a player?
-- map = false, -- Does test require map access?
-- async = false, -- Does the test run asynchronously? (read notes above!)
-- }
function unittests.register(name, func, opts)
local def = table.copy(opts or {})
def.name = name
def.func = func
table.insert(unittests.list, def)
end
function unittests.on_finished(all_passed)
-- free to override
end
-- Calls invoke with a callback as argument
-- Suspends coroutine until that callback is called
-- Return values are passed through
local function await(invoke)
local co = coroutine.running()
assert(co)
local called_early = true
invoke(function(...)
if called_early == true then
called_early = {...}
else
coroutine.resume(co, ...)
end
end)
if called_early ~= true then
-- callback was already called before yielding
return unpack(called_early)
end
called_early = nil
return coroutine.yield()
end
function unittests.run_one(idx, counters, out_callback, player, pos)
local def = unittests.list[idx]
if not def.player then
player = nil
elseif player == nil then
out_callback(false)
return false
end
if not def.map then
pos = nil
elseif pos == nil then
out_callback(false)
return false
end
local tbegin = core.get_us_time()
local function done(status, err)
local tend = core.get_us_time()
local ms_taken = (tend - tbegin) / 1000
if not status then
core.log("error", err)
end
print(string.format("[%s] %s - %dms",
status and "PASS" or "FAIL", def.name, ms_taken))
counters.time = counters.time + ms_taken
counters.total = counters.total + 1
if status then
counters.passed = counters.passed + 1
end
end
if def.async then
core.log("info", "[unittest] running " .. def.name .. " (async)")
def.func(function(err)
done(err == nil, err)
out_callback(true)
end, player, pos)
else
core.log("info", "[unittest] running " .. def.name)
local status, err = pcall(def.func, player, pos)
done(status, err)
out_callback(true)
end
return true
end
local function wait_for_player(callback)
if #core.get_connected_players() > 0 then
return callback(core.get_connected_players()[1])
end
local first = true
core.register_on_joinplayer(function(player)
if first then
callback(player)
first = false
end
end) end)
end end
local function wait_for_map(player, callback)
local check = function()
if core.get_node_or_nil(player:get_pos()) ~= nil then
callback()
else
minetest.after(0, check)
end
end
check()
end
function unittests.run_all()
-- This runs in a coroutine so it uses await().
local counters = { time = 0, total = 0, passed = 0 }
-- Run standalone tests first
for idx = 1, #unittests.list do
local def = unittests.list[idx]
def.done = await(function(cb)
unittests.run_one(idx, counters, cb, nil, nil)
end)
end
-- Wait for a player to join, run tests that require a player
local player = await(wait_for_player)
for idx = 1, #unittests.list do
local def = unittests.list[idx]
if not def.done then
def.done = await(function(cb)
unittests.run_one(idx, counters, cb, player, nil)
end)
end
end
-- Wait for the world to generate/load, run tests that require map access
await(function(cb)
wait_for_map(player, cb)
end)
local pos = vector.round(player:get_pos())
for idx = 1, #unittests.list do
local def = unittests.list[idx]
if not def.done then
def.done = await(function(cb)
unittests.run_one(idx, counters, cb, player, pos)
end)
end
end
-- Print stats
assert(#unittests.list == counters.total)
print(string.rep("+", 80))
print(string.format("Unit Test Results: %s",
counters.total == counters.passed and "PASSED" or "FAILED"))
print(string.format(" %d / %d failed tests.",
counters.total - counters.passed, counters.total))
print(string.format(" Testing took %dms total.", counters.time))
print(string.rep("+", 80))
unittests.on_finished(counters.total == counters.passed)
return counters.total == counters.passed
end
--------------
local modpath = minetest.get_modpath("unittests")
dofile(modpath .. "/misc.lua")
dofile(modpath .. "/player.lua")
dofile(modpath .. "/crafting.lua")
dofile(modpath .. "/itemdescription.lua")
--------------
if core.settings:get_bool("devtest_unittests_autostart", false) then
core.after(0, function()
coroutine.wrap(unittests.run_all)()
end)
else
minetest.register_chatcommand("unittests", {
privs = {basic_privs=true},
description = "Runs devtest unittests (may modify player or map state)",
func = function(name, param)
unittests.on_finished = function(ok)
core.chat_send_player(name,
(ok and "All tests passed." or "There were test failures.") ..
" Check the console for detailed output.")
end
coroutine.wrap(unittests.run_all)()
return true, ""
end,
})
end

@ -25,7 +25,7 @@ minetest.register_chatcommand("item_description", {
end end
}) })
function unittests.test_short_desc() local function test_short_desc()
local function get_short_description(item) local function get_short_description(item)
return ItemStack(item):get_short_description() return ItemStack(item):get_short_description()
end end
@ -49,3 +49,4 @@ function unittests.test_short_desc()
return true return true
end end
unittests.register("test_short_desc", test_short_desc)

@ -0,0 +1,38 @@
local function test_random()
-- Try out PseudoRandom
local pseudo = PseudoRandom(13)
assert(pseudo:next() == 22290)
assert(pseudo:next() == 13854)
end
unittests.register("test_random", test_random)
local function test_dynamic_media(cb, player)
if core.get_player_information(player:get_player_name()).protocol_version < 40 then
core.log("warning", "test_dynamic_media: Client too old, skipping test.")
return cb()
end
-- Check that the client acknowledges media transfers
local path = core.get_worldpath() .. "/test_media.obj"
local f = io.open(path, "w")
f:write("# contents don't matter\n")
f:close()
local call_ok = false
local ok = core.dynamic_add_media({
filepath = path,
to_player = player:get_player_name(),
}, function(name)
if not call_ok then
cb("impossible condition")
end
cb()
end)
if not ok then
return cb("dynamic_add_media() returned error")
end
call_ok = true
-- if the callback isn't called this test will just hang :shrug:
end
unittests.register("test_dynamic_media", test_dynamic_media, {async=true, player=true})

@ -2,6 +2,21 @@
-- HP Change Reasons -- HP Change Reasons
-- --
local expect = nil local expect = nil
minetest.register_on_player_hpchange(function(player, hp, reason)
if expect == nil then
return
end
for key, value in pairs(reason) do
assert(expect[key] == value)
end
for key, value in pairs(expect) do
assert(reason[key] == value)
end
expect = nil
end)
local function run_hpchangereason_tests(player) local function run_hpchangereason_tests(player)
local old_hp = player:get_hp() local old_hp = player:get_hp()
@ -20,7 +35,11 @@ local function run_hpchangereason_tests(player)
player:set_hp(old_hp) player:set_hp(old_hp)
end end
unittests.register("test_hpchangereason", run_hpchangereason_tests, {player=true})
--
-- Player meta
--
local function run_player_meta_tests(player) local function run_player_meta_tests(player)
local meta = player:get_meta() local meta = player:get_meta()
meta:set_string("foo", "bar") meta:set_string("foo", "bar")
@ -48,29 +67,4 @@ local function run_player_meta_tests(player)
assert(meta:get_string("foo") == "") assert(meta:get_string("foo") == "")
assert(meta:equals(meta2)) assert(meta:equals(meta2))
end end
unittests.register("test_player_meta", run_player_meta_tests, {player=true})
function unittests.test_player(player)
minetest.register_on_player_hpchange(function(player, hp, reason)
if not expect then
return
end
for key, value in pairs(reason) do
assert(expect[key] == value)
end
for key, value in pairs(expect) do
assert(reason[key] == value)
end
expect = nil
end)
run_hpchangereason_tests(player)
run_player_meta_tests(player)
local msg = "Player tests passed for player '"..player:get_player_name().."'!"
minetest.chat_send_all(msg)
minetest.log("action", "[unittests] "..msg)
return true
end

@ -1,10 +0,0 @@
function unittests.test_random()
-- Try out PseudoRandom
minetest.log("action", "[unittests] Testing PseudoRandom ...")
local pseudo = PseudoRandom(13)
assert(pseudo:next() == 22290)
assert(pseudo:next() == 13854)
minetest.log("action", "[unittests] PseudoRandom test passed!")
return true
end

@ -125,6 +125,15 @@ protected:
friend class ModApiEnvMod; friend class ModApiEnvMod;
friend class LuaVoxelManip; friend class LuaVoxelManip;
/*
Subtle edge case with coroutines: If for whatever reason you have a
method in a subclass that's called from existing lua_CFunction
(any of the l_*.cpp files) then make it static and take the lua_State*
as an argument. This is REQUIRED because getStack() will not return the
correct state if called inside coroutines.
Also note that src/script/common/ is the better place for such helpers.
*/
lua_State* getStack() lua_State* getStack()
{ return m_luastack; } { return m_luastack; }

@ -198,10 +198,8 @@ std::string ScriptApiServer::formatChatMessage(const std::string &name,
return ret; return ret;
} }
u32 ScriptApiServer::allocateDynamicMediaCallback(int f_idx) u32 ScriptApiServer::allocateDynamicMediaCallback(lua_State *L, int f_idx)
{ {
lua_State *L = getStack();
if (f_idx < 0) if (f_idx < 0)
f_idx = lua_gettop(L) + f_idx + 1; f_idx = lua_gettop(L) + f_idx + 1;
@ -235,7 +233,7 @@ u32 ScriptApiServer::allocateDynamicMediaCallback(int f_idx)
void ScriptApiServer::freeDynamicMediaCallback(u32 token) void ScriptApiServer::freeDynamicMediaCallback(u32 token)
{ {
lua_State *L = getStack(); SCRIPTAPI_PRECHECKHEADER
verbosestream << "freeDynamicMediaCallback(" << token << ")" << std::endl; verbosestream << "freeDynamicMediaCallback(" << token << ")" << std::endl;

@ -51,7 +51,7 @@ public:
const std::string &password); const std::string &password);
/* dynamic media handling */ /* dynamic media handling */
u32 allocateDynamicMediaCallback(int f_idx); static u32 allocateDynamicMediaCallback(lua_State *L, int f_idx);
void freeDynamicMediaCallback(u32 token); void freeDynamicMediaCallback(u32 token);
void on_dynamic_media_added(u32 token, const char *playername); void on_dynamic_media_added(u32 token, const char *playername);

@ -496,7 +496,7 @@ int ModApiServer::l_dynamic_add_media(lua_State *L)
CHECK_SECURE_PATH(L, filepath.c_str(), false); CHECK_SECURE_PATH(L, filepath.c_str(), false);
u32 token = server->getScriptIface()->allocateDynamicMediaCallback(2); u32 token = server->getScriptIface()->allocateDynamicMediaCallback(L, 2);
bool ok = server->dynamicAddMedia(filepath, token, to_player, ephemeral); bool ok = server->dynamicAddMedia(filepath, token, to_player, ephemeral);
if (!ok) if (!ok)

@ -20,7 +20,7 @@ waitfor () {
} }
gdbrun () { gdbrun () {
gdb -q -ex 'set confirm off' -ex 'r' -ex 'bt' -ex 'quit' --args "$@" gdb -q -batch -ex 'set confirm off' -ex 'r' -ex 'bt' --args "$@"
} }
[ -e $minetest ] || { echo "executable $minetest missing"; exit 1; } [ -e $minetest ] || { echo "executable $minetest missing"; exit 1; }
@ -33,17 +33,27 @@ printf '%s\n' >$testspath/client1.conf \
enable_{sound,minimap,shaders}=false enable_{sound,minimap,shaders}=false
printf '%s\n' >$testspath/server.conf \ printf '%s\n' >$testspath/server.conf \
max_block_send_distance=1 max_block_send_distance=1 devtest_unittests_autostart=true
cat >$worldpath/worldmods/test/init.lua <<"LUA" cat >$worldpath/worldmods/test/init.lua <<"LUA"
core.after(0, function() core.after(0, function()
io.close(io.open(core.get_worldpath() .. "/startup", "w")) io.close(io.open(core.get_worldpath() .. "/startup", "w"))
end) end)
core.register_on_joinplayer(function(player) local function callback(test_ok)
io.close(io.open(core.get_worldpath() .. "/player_joined", "w")) if not test_ok then
io.close(io.open(core.get_worldpath() .. "/test_failure", "w"))
end
io.close(io.open(core.get_worldpath() .. "/done", "w"))
core.request_shutdown("", false, 2) core.request_shutdown("", false, 2)
end) end
if core.settings:get_bool("devtest_unittests_autostart") then
unittests.on_finished = callback
else
core.register_on_joinplayer(function() callback(true) end)
end
LUA LUA
printf '%s\n' >$worldpath/worldmods/test/mod.conf \
name=test optional_depends=unittests
echo "Starting server" echo "Starting server"
gdbrun $minetest --server --config $conf_server --world $worldpath --gameid $gameid 2>&1 | sed -u 's/^/(server) /' & gdbrun $minetest --server --config $conf_server --world $worldpath --gameid $gameid 2>&1 | sed -u 's/^/(server) /' &
@ -51,10 +61,14 @@ waitfor $worldpath/startup
echo "Starting client" echo "Starting client"
gdbrun $minetest --config $conf_client1 --go --address 127.0.0.1 2>&1 | sed -u 's/^/(client) /' & gdbrun $minetest --config $conf_client1 --go --address 127.0.0.1 2>&1 | sed -u 's/^/(client) /' &
waitfor $worldpath/player_joined waitfor $worldpath/done
echo "Waiting for client and server to exit" echo "Waiting for client and server to exit"
wait wait
if [ -f $worldpath/test_failure ]; then
echo "There were test failures."
exit 1
fi
echo "Success" echo "Success"
exit 0 exit 0