Files
EasyRoute/tools/test-guide.js
T
notforever-ship-it e45b5c08ee Release 0.5.0: the wizard - pick Casual, Medium or Hard, then one step at a time
/er and the minimap button now open a wizard: it asks how hard you want it, suggests an area for your faction and level, then takes you through it one stop at a time (go there and pick up, do the quests, hand in) with map markers via pfQuest. The notebook moves to /er notebook (Ctrl-click the minimap button). Adds a wizard check to the self-test and tests for the whole flow.
2026-10-07 17:08:45 +01:00

269 lines
12 KiB
JavaScript

// Drives the director window (Guide.lua) through a mock of the game's UI, on the real data, in a Lua VM (fengari).
// It builds the window, clicks quests, modes, stops and the questions, and fails on any Lua error or missing text.
// It cannot show how the window looks; it only proves the code runs and says the right things.
// Usage: node tools/test-guide.js (needs fengari: npm install in this tools folder, or NODE_PATH set)
const fs = require("fs");
const path = require("path");
const { lua, lauxlib, lualib, to_luastring, to_jsstring } = require("fengari");
const ROOT = path.resolve(__dirname, "..");
const L = lauxlib.luaL_newstate();
lualib.luaL_openlibs(L);
function run(code, name) {
const buf = typeof code === "string" ? to_luastring(code) : code;
if (lauxlib.luaL_loadbuffer(L, buf, buf.length, to_luastring(name)) !== 0 || lua.lua_pcall(L, 0, 0, 0) !== 0) {
console.error("FAILED in " + name + ": " + to_jsstring(lua.lua_tostring(L, -1)));
process.exit(1);
}
}
// Lua 5.0 helpers, the addon table, and the game's API as far as these files touch it.
run(`
table.getn = function(t) return #t end
string.gfind = string.gmatch
math.mod = math.fmod
unpack = unpack or table.unpack
failures = 0
function check(cond, msg) if not cond then failures = failures + 1 print(" FAIL: " .. msg) end end
EasyRoute = { VERSION = "test", GOLD = "", GREY = "", WHITE = "", END = "", Print = function(m) CHAT = (CHAT or "") .. "[print] " .. m .. "|" end,
Char = function() return "Tester-Realm" end,
Where = function() return "Westfall", "", 50, 50 end,
Log = function(kind, fields) fields = fields or {} fields.t = kind fields.char = "Tester-Realm" return fields end,
db = { journal = {}, ratings = {} } }
local function newFrame(name)
local f = { _scripts = {}, _shown = false, _text = "", _name = name }
setmetatable(f, { __index = function(t, k)
if k == "SetScript" then return function(self, ev, fn) self._scripts[ev] = fn end end
if k == "SetText" then return function(self, s) self._text = s or "" end end
if k == "GetText" then return function(self) return self._text end end
if k == "Show" then return function(self) self._shown = true if self._scripts.OnShow then this = self self._scripts.OnShow() end end end
if k == "Hide" then return function(self) self._shown = false end end
if k == "IsShown" or k == "IsVisible" then return function(self) return self._shown end end
if k == "GetScript" then return function(self, ev) return self._scripts[ev] end end
if k == "GetName" then return function(self) return self._name end end
return function(self) return newFrame() end
end })
if name then _G[name] = f end
return f
end
CreateFrame = function(kind, name) return newFrame(name) end
UIParent = newFrame()
GameTooltip = newFrame()
UISpecialFrames = {}
DEFAULT_CHAT_FRAME = { AddMessage = function(self, m) CHAT = (CHAT or "") .. m .. "|" end }
getglobal = function(n) return _G[n] end
GetTime = function() return os.clock() end
time = os.time
date = os.date
geterrorhandler = function() return nil end
seterrorhandler = function(f) ERRHANDLER = f end
GetZoneText = function() return "Westfall" end
level = 12
UnitLevel = function() return level end
UnitRace = function() return "Human", "Human" end
UnitClass = function() return "Warrior", "WARRIOR" end
UnitFactionGroup = function() return "Alliance" end
function click(frame, button)
this = frame
arg1 = button or "LeftButton"
frame._scripts.OnClick()
end
function hover(frame)
this = frame
frame._scripts.OnEnter()
frame._scripts.OnLeave()
end
`, "prelude");
for (const f of ["Data/Quests.lua", "Data/Zones.lua", "Data/Mobs.lua", "Director.lua", "Guide.lua", "Wizard.lua", "Selftest.lua"]) {
run(fs.readFileSync(path.join(ROOT, f)), f);
}
run(`
local ER = EasyRoute
ER.RestartNeeded = function() end
print("1. The window builds and fills in")
check(ER.ToggleGuide and ER.ShowGuide and ER.PointTo and ER.RefreshDirector, "Guide.lua did not define its functions")
ER.ShowGuide()
check(EasyRouteGuideFrame:IsShown(), "window did not open")
local shown = 0
for i = 1, 9 do
if _G["EasyRouteGuideRow" .. i]:IsShown() then shown = shown + 1 end
end
check(shown >= 3, "expected several quest rows, got " .. shown)
print(" quest rows shown: " .. shown .. ", first: " .. EasyRouteGuideRow1.text._text)
check(string.find(EasyRouteGuideRow1.text._text, "%[") ~= nil, "row text has no level")
print("2. Clicking a quest points at it; right-click says not today")
CHAT = ""
local row1 = EasyRouteGuideRow1
local id1, name1 = row1.cand.q.id, row1.cand.q.n
hover(row1)
click(row1, "LeftButton")
check(string.find(CHAT, "go to") ~= nil, "clicking a quest did not say where to go")
print(" " .. CHAT)
CHAT = ""
click(row1, "RightButton")
check(string.find(CHAT, "not today") ~= nil, "right-click did not say not today")
local still = false
for i = 1, 9 do
local r = _G["EasyRouteGuideRow" .. i]
if r:IsShown() and r.cand and r.cand.q.id == id1 then still = true end
end
check(not still, "a skipped quest is still in the window: " .. name1)
print("3. Mode buttons change the mode and the list")
for i = 1, 3 do hover(_G["EasyRouteGuideMode" .. i]) end
click(EasyRouteGuideMode3)
check(ER.Mode() == "normal", "mode did not change to normal")
click(EasyRouteGuideMode2)
check(ER.Mode() == "medium", "mode did not change to medium")
click(EasyRouteGuideMode1)
check(ER.Mode() == "casual", "mode did not change back to casual")
print("4. Stops can be paged and shown")
click(EasyRouteGuideNext)
click(EasyRouteGuideNext)
click(EasyRouteGuidePrev)
CHAT = ""
click(EasyRouteGuideGo)
check(string.find(CHAT, "go to") ~= nil, "'Show me this stop' said nothing")
print(" " .. CHAT)
print("5. Where next? gives answers that can be clicked")
click(EasyRouteGuideWhere)
check(EasyRouteGuideAsk1:IsShown(), "Where next? showed no answers")
print(" first answer: " .. EasyRouteGuideAsk1._text)
CHAT = ""
hover(EasyRouteGuideAsk1)
click(EasyRouteGuideAsk1)
check(string.find(CHAT, "go to") ~= nil, "clicking an answer did not point anywhere")
print("6. A used-up zone asks the question by itself, and Stay a while quiets it")
level = 40
ER.db.skipped = nil
ER.RefreshDirector()
check(string.find(EasyRouteGuideFrame:GetText() or "", "") ~= nil, "frame text")
check(EasyRouteGuideStay:IsShown(), "the used-up question did not show its Stay button")
click(EasyRouteGuideStay)
check(ER.db.stay and ER.db.stay["Westfall"], "Stay a while did not remember")
check(not EasyRouteGuideStay:IsShown(), "the question is still showing after Stay a while")
print("7. Chain and grind lines hover and click without errors")
level = 12
ER.db.stay = nil
ER.RefreshDirector()
for _, i in ipairs({ 101, 102, 201, 202 }) do
local l = _G["EasyRouteGuideRow" .. i]
if l:IsShown() then hover(l) click(l) end
end
print("8. The slash-command helpers")
ER.SetMode("medium")
check(ER.Mode() == "medium", "SetMode failed")
ER.SkipQuest(36)
ER.ClearSkipped()
check(next(ER.db.skipped) == nil, "ClearSkipped left something")
print("9. The in-game self-test runs and reports")
CHAT = ""
ER.db.stay = nil
this, arg1 = "the chat box", "typed text"
ER.SelfTest()
check(this == "the chat box" and arg1 == "typed text", "the self-test left this/arg1 changed, which breaks the chat box that ran the command")
check(ER.db.selftest and ER.db.selftest.failed == 0, "self-test reported failures")
for _, line in ipairs(ER.db.selftest and ER.db.selftest.results or {}) do print(" " .. line) end
check(ERRHANDLER ~= nil, "error capture was not installed")
if ERRHANDLER then
ERRHANDLER("Interface\AddOns\EasyRoute\Guide.lua:1: test error")
check(ER.db.errors and table.getn(ER.db.errors) == 1, "an EasyRoute error was not kept")
end
print("11. The wizard asks, suggests an area and walks through the steps")
-- What pfQuest would add: the objective sentence, who takes the quest back, where the targets are.
ER.QuestObjective = function(id) return "Bring 5 widgets to Bob." end
ER.QuestFacts = function(id)
return { taker = { name = "Bob", where = { map = "Westfall", area = "Sentinel Hill", x = 52, y = 53 } },
objectives = { widget = { kind = "item", where = { map = "Westfall", x = 40, y = 40 } } } }
end
level = 12
ER.db.wizardSeen = nil
ER.db.skipped = {}
ER.ShowWizard()
local w = ER.WizardInfo()
check(w and w.screen == "mood", "the wizard did not start with the difficulty question")
check(string.find(w.text, "How do you want to play") ~= nil, "difficulty question is missing")
check(EasyRouteWizardBtn1:IsShown() and EasyRouteWizardBtn2:IsShown() and EasyRouteWizardBtn3:IsShown(), "three difficulty buttons expected")
check(string.find(EasyRouteWizardBtn3._text, "Hard") ~= nil, "third button should say Hard, says " .. EasyRouteWizardBtn3._text)
click(EasyRouteWizardBtn3)
check(ER.Mode() == "normal", "choosing Hard did not set the mode")
w = ER.WizardInfo()
check(w.screen == "area", "no area suggestion after choosing a difficulty, screen is " .. w.screen)
check(string.find(w.text, "I suggest") ~= nil, "area text has no suggestion")
print(" " .. string.gsub(w.text, "\\n", " / "))
click(EasyRouteWizardBtn2)
click(EasyRouteWizardBtn2)
click(EasyRouteWizardBtn1)
w = ER.WizardInfo()
if w.screen == "travel" then click(EasyRouteWizardBtn2) w = ER.WizardInfo() end
check(w.screen == "step" and w.phase == 1, "expected step 1, got " .. w.screen)
check(w.stop and table.getn(w.stop.ids) >= 1, "the stop has no quests")
check(EasyRouteWizardRow1:IsShown(), "no quest row shown")
print(" step 1: " .. string.gsub(w.text, "\\n", " / "))
print(" row 1: " .. string.gsub(EasyRouteWizardRow1.text._text, "\\n", " / "))
hover(EasyRouteWizardRow1)
click(EasyRouteWizardRow1)
click(EasyRouteWizardBtn2)
w = ER.WizardInfo()
check(w.phase == 2, "did not move to step 2")
check(string.find(EasyRouteWizardRow1.text._text, "Bring 5 widgets") ~= nil, "step 2 does not say what to do")
check(string.find(EasyRouteWizardRow1.text._text, "widget") ~= nil, "step 2 does not name where to look")
click(EasyRouteWizardRow1)
click(EasyRouteWizardBtn2)
w = ER.WizardInfo()
check(w.phase == 3, "did not move to step 3")
check(string.find(EasyRouteWizardRow1.text._text, "Hand in to Bob") ~= nil, "step 3 does not say who to hand in to")
click(EasyRouteWizardRow1)
local first = w.stop.number
click(EasyRouteWizardBtn2)
w = ER.WizardInfo()
check(w.screen == "step" and w.phase == 1 and w.stop.number == first + 1, "next stop did not start a new stop")
click(EasyRouteWizardBtn3) -- skip this stop
w = ER.WizardInfo()
check(w.screen == "step" or w.screen == "done", "skipping a stop broke the wizard")
if w.screen == "step" then
click(EasyRouteWizardBtn4) -- grind spot
click(EasyRouteWizardBtn7) -- notebook
click(EasyRouteWizardBtn6) -- other area
check(ER.WizardInfo().screen == "area", "other area did not go back to the suggestions")
end
click(EasyRouteWizardBtn3) -- change difficulty
check(ER.WizardInfo().screen == "mood", "change difficulty did not go back to the question")
click(EasyRouteWizardBtn1) -- casual
check(ER.Mode() == "casual", "choosing Casual did not set the mode")
EasyRouteWizardFrame:Hide()
ER.ShowWizard()
check(ER.WizardInfo().screen ~= "mood", "opening the wizard again should skip the difficulty question")
EasyRouteWizardFrame:Hide()
ER.SetMode("casual")
ER.QuestObjective, ER.QuestFacts = nil, nil
print("10. Pointing with pfQuest does not leave a boolean in pfMap.queue_update")
-- pfQuest's route.SetTarget sets queue_update to true, and its map code later adds .25 to it as a time.
pfMap = { AddNode = function() end, GetMapIDByName = function() return 1 end, DeleteNode = function() end,
GetNodes = function() return { { title = "x" } } end, UpdateNodes = function() end }
pfQuest = { route = { SetTarget = function() pfMap.queue_update = true end } }
ER.PointTo("Westfall", 50, 50, "somewhere")
check(type(pfMap.queue_update) == "number", "queue_update is " .. type(pfMap.queue_update) .. ", pfQuest needs a number")
pfMap, pfQuest = nil, nil
print(failures == 0 and "WINDOW CHECKS PASSED" or (failures .. " WINDOW CHECK(S) FAILED"))
`, "window");