dfhack/test/library/print.lua

208 lines
6.6 KiB
Lua

2021-08-07 01:09:48 -06:00
-- tests print-related functions added by dfhack.lua
2023-08-04 10:59:08 -06:00
config.target = 'core'
2023-08-04 02:35:51 -06:00
2021-08-07 01:09:48 -06:00
local dfhack = dfhack
local mock_print = mock.func()
local function test_wrapper(test_fn)
mock.patch({{dfhack, 'print', mock_print},
{dfhack, 'println', mock_print}},
test_fn)
mock_print = mock.func()
end
config.wrapper = test_wrapper
function test.printall_table()
printall({a='b'})
expect.eq(1, mock_print.call_count)
expect.str_find('a%s+= b', mock_print.call_args[1][1])
2021-08-07 01:09:48 -06:00
end
function test.printall_string()
printall('a')
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
function test.printall_number()
printall(10)
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
function test.printall_nil()
printall(nil)
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
function test.printall_boolean()
printall(false)
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
function test.printall_function()
printall(function() end)
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
2021-08-14 23:15:26 -06:00
local function new_int_vector()
-- create a vector of integers by cloning one from world. we do it this way
-- because we can't allocate typed vectors from lua directly.
local vector = df.global.world.busy_buildings:new()
vector:resize(0)
return vector
end
2021-08-07 01:09:48 -06:00
function test.printall_userdata()
2021-08-14 23:15:26 -06:00
local utable = new_int_vector()
dfhack.with_temp_object(utable, function()
utable:insert(0, 10)
utable:insert(1, 20)
printall(utable)
expect.eq(2, mock_print.call_count)
expect.str_find('0%s+= 10', mock_print.call_args[1][1])
expect.str_find('1%s+= 20', mock_print.call_args[2][1])
2021-08-14 23:15:26 -06:00
end)
2021-08-07 01:09:48 -06:00
end
function test.printall_noniterable_userdata()
printall(df.item._identity)
expect.eq(0, mock_print.call_count)
end
2021-08-07 01:09:48 -06:00
function test.printall_ipairs_table()
printall_ipairs({'a', 'b'})
expect.eq(2, mock_print.call_count)
expect.str_find('1%s+= a', mock_print.call_args[1][1])
expect.str_find('2%s+= b', mock_print.call_args[2][1])
2021-08-07 01:09:48 -06:00
end
function test.printall_ipairs_string()
printall_ipairs('a')
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
function test.printall_ipairs_number()
printall_ipairs(10)
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
function test.printall_ipairs_nil()
printall_ipairs(nil)
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
function test.printall_ipairs_boolean()
printall_ipairs(false)
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
function test.printall_ipairs_function()
printall_ipairs(function() end)
2021-08-14 18:36:38 -06:00
expect.eq(0, mock_print.call_count)
2021-08-07 01:09:48 -06:00
end
function test.printall_ipairs_userdata()
2021-08-14 23:15:26 -06:00
local utable = new_int_vector()
dfhack.with_temp_object(utable, function()
utable:insert(0, 10)
utable:insert(1, 20)
printall_ipairs(utable)
expect.eq(2, mock_print.call_count)
expect.str_find('0%s+= 10', mock_print.call_args[1][1])
expect.str_find('1%s+= 20', mock_print.call_args[2][1])
2021-08-14 23:15:26 -06:00
end)
2021-08-07 01:09:48 -06:00
end
function test.printall_ipairs_noniterable_userdata()
printall_ipairs(df.item._identity)
expect.eq(0, mock_print.call_count)
end
2021-08-15 09:31:42 -06:00
local function validate_patterns(start_idx, patterns)
for i,pattern in ipairs(patterns) do
expect.str_find(pattern, mock_print.call_args[start_idx+i-1][1])
2021-08-15 09:31:42 -06:00
end
return start_idx + #patterns
end
2021-08-07 01:09:48 -06:00
function test.printall_recurse()
2021-08-15 09:31:42 -06:00
local udatatable = new_int_vector()
dfhack.with_temp_object(udatatable, function()
local udataint = df.new('uint32_t')
dfhack.with_temp_object(udataint, function ()
udatatable:insert(0, 10)
udatatable:insert(1, 20)
udatatable:insert(2, 20)
udatatable:insert(3, 20)
udatatable:insert(4, 0)
udatatable:insert(5, 0)
local t2 = {}
local t = {num=5,
bool=false,
fn=function() end,
udatatable=udatatable,
udataint=udataint,
lightudata=df.item._identity,
2021-08-15 09:31:42 -06:00
table=t2}
t2.cyclic = t
printall_recurse(t)
expect.eq(55, mock_print.call_count)
expect.str_find('^table: ', mock_print.call_args[1][1])
2021-08-15 09:31:42 -06:00
local idx = 2
local EQ = '^%s+= $'
while idx <= 55 do
2021-08-15 09:31:42 -06:00
expect.eq('', mock_print.call_args[idx][1])
idx = idx + 1
local str = mock_print.call_args[idx][1]
if str:startswith('num') then
idx = validate_patterns(idx, {'^num$', EQ, '^5$'})
elseif str:startswith('bool') then
idx = validate_patterns(idx, {'^bool$', EQ, '^false$'})
elseif str:startswith('fn') then
idx = validate_patterns(idx, {'^fn$', EQ, '^function: '})
elseif str:startswith('udatatable') then
idx = validate_patterns(idx,
{'^udatatable$', EQ, '^<vector<int32_t>%[6%]: ',
'%s+', '^0$', EQ, '^10$',
'%s+', '^1$', EQ, '^20$',
'Repeated 2 times',
'%s+', '^4$', EQ, '^0$',
'Repeated 1 times'}) -- [sic]
elseif str:startswith('udataint') then
idx = validate_patterns(idx,
{'^udataint$', EQ, '^<uint32_t: ',
'%s+', '^value$', EQ, '^0$'})
elseif str:startswith('lightudata') then
idx = validate_patterns(idx,
{'^lightudata$', EQ, '',
'', 'iteration with pairs>$'})
2021-08-15 09:31:42 -06:00
elseif str:startswith('table') then
idx = validate_patterns(idx,
{'^table$', EQ, '^table: ',
'%s+', '^cyclic$', EQ, '^table: ',
'%s+', '^<Cyclic reference'})
else
expect.fail('unhandled print output')
break
end
end
end)
end)
2021-08-07 01:09:48 -06:00
end
function test.printall_recurse_cyclic_userdata()
local t = df.job_list_link:new()
dfhack.with_temp_object(t, function()
t.next = t
printall_recurse(t)
expect.eq(15, mock_print.call_count)
-- conveniently, field order is deterministic
validate_patterns(1,
{'^<job_list_link: ',
'', '^item$', EQ, 'nil',
'', '^prev$', EQ, 'nil',
'', '^next$', EQ, '^<job_list_link: ',
' +', '^<Cyclic reference'})
end)
end