local json = require 'json' local script = require 'gui.script' local utils = require 'utils' local args = {...} local done_command = args[1] local CONFIG_FILE = 'test_config.json' local STATUS_FILE = 'test_status.json' local TestStatus = { PENDING = 'pending', PASSED = 'passed', FAILED = 'failed', } local VALID_MODES = utils.invert{'none', 'title', 'fortress'} expect = {} function expect.true_(value, comment) return not not value, comment, 'expected true, got ' .. tostring(value) end function expect.false_(value, comment) return not value, comment, 'expected false, got ' .. tostring(value) end function expect.fail(comment) return false, comment or 'check failed, no reason provided' end function expect.nil_(value, comment) return value == nil, comment, 'expected nil, got ' .. tostring(value) end function expect.eq(a, b, comment) return a == b, comment, ('%s ~= %s'):format(a, b) end function expect.ne(a, b, comment) return a ~= b, comment, ('%s == %s'):format(a, b) end function expect.lt(a, b, comment) return a < b, comment, ('%s >= %s'):format(a, b) end function expect.le(a, b, comment) return a <= b, comment, ('%s > %s'):format(a, b) end function expect.gt(a, b, comment) return a > b, comment, ('%s <= %s'):format(a, b) end function expect.ge(a, b, comment) return a >= b, comment, ('%s < %s'):format(a, b) end function expect.table_eq(a, b, comment) local checked = {} for k, v in pairs(a) do if a[k] ~= b[k] then return false, comment, ('key "%s": %s ~= %s'):format(k, a[k], b[k]) end checked[k] = true end for k in pairs(b) do if not checked[k] then return false, comment, ('key "%s": %s ~= %s'):format(k, a[k], b[k]) end end return true end function expect.error(func, ...) local ok, ret = pcall(func, ...) if ok then return false, 'no error raised by function call' else return true end end function expect.pairs_contains(table, key, comment) for k, v in pairs(table) do if k == key then return true end end return false, comment, ('could not find key "%s" in table'):format(key) end function expect.not_pairs_contains(table, key, comment) for k, v in pairs(table) do if k == key then return false, comment, ('found key "%s" in table'):format(key) end end return true end function delay(frames) frames = frames or 1 script.sleep(frames, 'frames') end function ensure_title_screen() if df.viewscreen_titlest:is_instance(dfhack.gui.getCurViewscreen()) then return end print('Looking for title screen...') for i = 0, 100 do local scr = dfhack.gui.getCurViewscreen() if df.viewscreen_titlest:is_instance(scr) then print('Found title screen') break else scr:feed_key(df.interface_key.LEAVESCREEN) delay(10) end end if not df.viewscreen_titlest:is_instance(dfhack.gui.getCurViewscreen()) then error('Could not find title screen') end end local MODE_NAVIGATE_FNS = { none = function() end, title = ensure_title_screen, } function load_test_config(config_file) local config = {} if dfhack.filesystem.isfile(config_file) then config = json.decode_file(config_file) end if not config.test_dir then config.test_dir = dfhack.getHackPath() .. 'scripts/test' end if not dfhack.filesystem.isdir(config.test_dir) then error('Invalid test folder: ' .. config.test_dir) end return config end function build_test_env() local env = { test = utils.OrderedTable(), config = { mode = 'none', }, expect = {}, delay = delay, } local private = { checks = 0, checks_ok = 0, } for name, func in pairs(expect) do env.expect[name] = function(...) private.checks = private.checks + 1 local ret = {func(...)} local ok = table.remove(ret, 1) local msg = '' for _, part in pairs(ret) do if part then msg = msg .. ': ' .. tostring(part) end end msg = msg:sub(3) -- strip leading ': ' if ok then private.checks_ok = private.checks_ok + 1 else dfhack.printerr('Check failed! ' .. (msg or '(no message)')) local info = debug.getinfo(2) dfhack.printerr((' at %s:%d'):format(info.short_src, info.currentline)) print('') end end end setmetatable(env, {__index = _G}) return env, private end function get_test_files(test_dir) local files = {} for _, entry in ipairs(dfhack.filesystem.listdir_recursive(test_dir)) do if not entry.isdir and not entry.path:match('main.lua') then table.insert(files, entry.path) end end table.sort(files) return files end function load_test_status() if dfhack.filesystem.isfile(STATUS_FILE) then return json.decode_file(STATUS_FILE) end end function save_test_status(status) json.encode_file(status, STATUS_FILE) end function finish_tests() if done_command then dfhack.run_command(done_command) end end function load_tests(file, tests) local short_filename = file:sub(file:find('test'), -1) print('Loading file: ' .. short_filename) local env, env_private = build_test_env() local code, err = loadfile(file, 't', env) if not code then dfhack.printerr('Failed to load file: ' .. tostring(err)) return false else local ok, err = pcall(code) if not ok then dfhack.printerr('Error when running file: ' .. tostring(err)) return false else if not VALID_MODES[env.config.mode] then dfhack.printerr('Invalid config.mode: ' .. tostring(env.config.mode)) return false end for name, test_func in pairs(env.test) do local test_data = { full_name = short_filename .. ':' .. name, func = test_func, private = env_private, config = env.config, } test_data.name = test_data.full_name:gsub('test/', ''):gsub('.lua', '') table.insert(tests, test_data) end end end return true end function sort_tests(tests) -- to make sort stable local test_index = utils.invert(tests) table.sort(tests, function(a, b) if a.config.mode ~= b.config.mode then return VALID_MODES[a.config.mode] < VALID_MODES[b.config.mode] else return test_index[a] < test_index[b] end end) end function run_test(test, status, counts) test.private.checks = 0 test.private.checks_ok = 0 counts.tests = counts.tests + 1 local ok, err = pcall(test.func) local passed = false if not ok then dfhack.printerr('test errored: ' .. test.name .. ': ' .. tostring(err)) elseif test.private.checks ~= test.private.checks_ok then dfhack.printerr('test failed: ' .. test.name) else print('test passed: ' .. test.name) passed = true counts.tests_ok = counts.tests_ok + 1 end counts.checks = counts.checks + (tonumber(test.private.checks) or 0) counts.checks_ok = counts.checks_ok + (tonumber(test.private.checks_ok) or 0) return passed end function main() local config = load_test_config(CONFIG_FILE) local files = get_test_files(config.test_dir) local counts = { tests = 0, tests_ok = 0, checks = 0, checks_ok = 0, file_errors = 0, } local passed = true ensure_title_screen() print('Loading tests') local tests = {} for _, file in ipairs(files) do if not load_tests(file, tests) then passed = false counts.file_errors = counts.file_errors + 1 end end print('Filtering tests') if config.tests then local orig_length = #tests for i = #tests, 1, -1 do for _, pattern in pairs(config.tests) do if not tests[i].name:match(pattern) then table.remove(tests, i) end end end print('Selected tests: ' .. #tests .. '/' .. orig_length) end local status = load_test_status() or {} for i = #tests, 1, -1 do local test = tests[i] if not status[test.full_name] then status[test.full_name] = TestStatus.PENDING elseif status[test.full_name] ~= TestStatus.PENDING then print('skipping test: ' .. test.name .. ': state = ' .. status[test.full_name] .. ')') table.remove(tests, i) end end sort_tests(tests) print('Running ' .. #tests .. ' tests') for _, test in pairs(tests) do MODE_NAVIGATE_FNS[test.config.mode]() local passed = run_test(test, status, counts) status[test.full_name] = passed and TestStatus.PASSED or TestStatus.FAILED save_test_status(status) end print('\nTest summary:') print(('%d/%d tests passed'):format(counts.tests_ok, counts.tests)) print(('%d/%d checks passed'):format(counts.checks_ok, counts.checks)) print(('%d test files failed to load'):format(counts.file_errors)) end script.start(function() dfhack.with_finalize(finish_tests, main) end)