Skip to content

Fix debug test suite for Factorio 2.0 #1575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
grilledham merged 1 commit into from
Jul 11, 2026
Merged

Fix debug test suite for Factorio 2.0 #1575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions features/death_corpse_tags_tests.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,17 @@ Declare.module({'features', 'death_corpse_tags'}, function()

local actual_text

Helper.modify_lua_object(context, player, 'print', function(text)
actual_text = text
end)

Helper.modify_lua_object(context, game, 'get_player', function()
return player
end)
local fake_player = Helper.fake_lua_object(player, {
print = function(text)
actual_text = text
end
})

Helper.modify_global(context, 'game', Helper.fake_lua_object(game, {
get_player = function()
return fake_player
end
}))

local event = fake_death(player, false)

Expand Down
36 changes: 22 additions & 14 deletions features/landfill_remover_tests.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,13 +727,17 @@ Declare.module(

local messages = {}

Helper.modify_lua_object(context, player, 'print', function(text)
messages[#messages+1] = text
end)

Helper.modify_lua_object(context, game, 'get_player', function()
return player
end)
local fake_player = Helper.fake_lua_object(player, {
print = function(text)
messages[#messages+1] = text
end
})

Helper.modify_global(context, 'game', Helper.fake_lua_object(game, {
get_player = function()
return fake_player
end
}))

-- Act
EventFactory.do_player_deconstruct_area(cursor, player, area)
Expand Down Expand Up @@ -765,13 +769,17 @@ Declare.module(

local messages = {}

Helper.modify_lua_object(context, player, 'print', function(text)
messages[#messages+1] = text
end)

Helper.modify_lua_object(context, game, 'get_player', function()
return player
end)
local fake_player = Helper.fake_lua_object(player, {
print = function(text)
messages[#messages+1] = text
end
})

Helper.modify_global(context, 'game', Helper.fake_lua_object(game, {
get_player = function()
return fake_player
end
}))

-- Act
EventFactory.do_player_deconstruct_area(cursor, player, area)
Expand Down
30 changes: 18 additions & 12 deletions features/restart_command_tests.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,12 @@ Declare.module({'features', 'restart_command'}, function()
declare_test('Requires admin to run command.', function(context)
-- Arrange.
local player = context.player
Helper.modify_lua_object(context, player, 'admin', false)
Helper.modify_lua_object(context, game, 'get_player', function()
return player
end)
local fake_player = Helper.fake_lua_object(player, { admin = false })
Helper.modify_global(context, 'game', Helper.fake_lua_object(game, {
get_player = function()
return fake_player
end
}))

-- Act.
run_config_command(player)
Expand All @@ -155,12 +157,16 @@ Declare.module({'features', 'restart_command'}, function()
-- Arrange.
local player = context.player
local actual = nil
Helper.modify_lua_object(context, player, 'print', function(str)
actual = str
end)
Helper.modify_lua_object(context, game, 'get_player', function()
return player
end)
local fake_player = Helper.fake_lua_object(player, {
print = function(str)
actual = str
end
})
Helper.modify_global(context, 'game', Helper.fake_lua_object(game, {
get_player = function()
return fake_player
end
}))

local start_game_data = {
type = RestartCommand.game_types.scenario,
Expand Down Expand Up @@ -345,7 +351,7 @@ Mod Pack: some_mod_pack]]
output[#output + 1] = str
end

Helper.modify_lua_object(context, game, 'print', game_print)
Helper.modify_global(context, 'game', Helper.fake_lua_object(game, { print = game_print }))

-- Act.
run_restart_command(player)
Expand Down Expand Up @@ -376,7 +382,7 @@ Mod Pack: some_mod_pack]]
output[#output + 1] = str
end

Helper.modify_lua_object(context, game, 'print', game_print)
Helper.modify_global(context, 'game', Helper.fake_lua_object(game, { print = game_print }))

-- Act.
run_restart_command(player, argument)
Expand Down
16 changes: 13 additions & 3 deletions utils/gui_tests.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,19 @@ local Helper = require 'utils.test.helper'
Declare.module({'utils', 'Gui'}, function()
Declare.module('can toggle top buttons', function()
local function count_gui_elements(player)
-- local gui = player.gui
-- return #gui.top.children + #gui.left.children + #gui.center.children + #gui.screen.children
return #Gui.get_top_flow(player).children + #Gui.get_left_flow(player).children + #player.gui.center.children + #player.gui.screen.children
local roots = {Gui.get_top_flow(player), Gui.get_left_flow(player), player.gui.center, player.gui.screen}
local count = 0
for _, root in pairs(roots) do
for _, child in pairs(root.children) do
-- Only visible elements count as open: some GUIs, such as the
-- production hud, hide their frame on close instead of
-- destroying it, to preserve its screen position.
if child.visible then
count = count + 1
end
end
end
return count
end

local function is_ignored_element(element)
Expand Down
28 changes: 28 additions & 0 deletions utils/test/helper.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ function Public.wait_for_chunk_to_be_charted(context, force, surface, chunk_posi
end

function Public.modify_lua_object(context, object, key, value)
if type(object) ~= 'table' then
error('LuaObjects are userdata since Factorio 2.0 and cannot be modified; use Helper.fake_lua_object and Helper.modify_global instead.', 2)
end

local old_value = object[key]
rawset(object, key, value)

Expand All @@ -99,6 +103,30 @@ function Public.modify_lua_object(context, object, key, value)
end)
end

-- LuaObjects are userdata since Factorio 2.0, so their fields cannot be
-- replaced. Returns a table that reads and writes through to the given object,
-- except for the overridden fields.
function Public.fake_lua_object(object, overrides)
return setmetatable(overrides or {}, {
__index = function(_, key)
return object[key]
end,
__newindex = function(_, key, value)
object[key] = value
end
})
end

-- Replaces a global variable, e.g. the 'game' object, until test teardown.
function Public.modify_global(context, name, value)
local old_value = _G[name]
rawset(_G, name, value)

context:add_teardown(function()
rawset(_G, name, old_value)
end)
end

local function get_gui_element_by_name(parent, name)
if parent.name == name then
return parent
Expand Down
Loading