| 1 |
require("corsixth") |
| 2 |
|
| 3 |
require("class_test_base") |
| 4 |
|
| 5 |
require("announcer") |
| 6 |
|
| 7 |
local Announcer = _G["Announcer"] |
| 8 |
local AnnouncementPriority = _G["AnnouncementPriority"] |
| 9 |
|
| 10 |
local function create_date_mock_type() |
| 11 |
local date_mock = {} |
| 12 |
local date_mock_mt = { __index = date_mock } |
| 13 |
|
| 14 |
function date_mock.new(value) |
| 15 |
local self = { |
| 16 |
value = value or 0 |
| 17 |
} |
| 18 |
|
| 19 |
setmetatable(self, date_mock_mt) |
| 20 |
|
| 21 |
return self |
| 22 |
end |
| 23 |
|
| 24 |
function date_mock:clone() |
| 25 |
return date_mock.new(self.value) |
| 26 |
end |
| 27 |
|
| 28 |
function date_mock:plusHours(hours) |
| 29 |
return date_mock.new(self.value + hours) |
| 30 |
end |
| 31 |
|
| 32 |
function date_mock_mt.__lt(left, right) |
| 33 |
return left.value < right.value |
| 34 |
end |
| 35 |
|
| 36 |
function date_mock_mt.__le(left, right) |
| 37 |
return left.value <= right.value |
| 38 |
end |
| 39 |
|
| 40 |
return date_mock.new |
| 41 |
end |
| 42 |
|
| 43 |
local create_date_mock = create_date_mock_type() |
| 44 |
|
| 45 |
local function create_app_mock(speed_set, desk_set) |
| 46 |
local world_mock = {} |
| 47 |
world_mock.mock_game_date = create_date_mock() |
| 48 |
world_mock.date = function() return world_mock.mock_game_date end |
| 49 |
world_mock.isCurrentSpeed = function() return speed_set end |
| 50 |
world_mock.getLocalPlayerHospital = function() |
| 51 |
return { |
| 52 |
hasReceptionDesk = function() return desk_set end |
| 53 |
} |
| 54 |
end |
| 55 |
|
| 56 |
local ui_mock = {} |
| 57 |
local subtitles_mock = { |
| 58 |
queueSubtitle = function() end, |
| 59 |
} |
| 60 |
ui_mock.subtitles = subtitles_mock |
| 61 |
|
| 62 |
local config_mock = { |
| 63 |
play_announcements = true |
| 64 |
} |
| 65 |
|
| 66 |
local played_sounds = {} |
| 67 |
|
| 68 |
local audio_mock = { |
| 69 |
__played_sounds__ = played_sounds, |
| 70 |
playSound = function(_, name, where, is_announcement, played_callback, played_callback_delay) |
| 71 |
table.insert(played_sounds, { |
| 72 |
name = name, |
| 73 |
where = where, |
| 74 |
is_announcement = is_announcement, |
| 75 |
played_callback = played_callback, |
| 76 |
played_callback_delay = played_callback_delay |
| 77 |
}) |
| 78 |
end, |
| 79 |
__mark_sounds_played__ = function() |
| 80 |
for k,v in pairs(played_sounds) do |
| 81 |
v.played_callback() |
| 82 |
played_sounds[k] = nil -- clear |
| 83 |
end |
| 84 |
end, |
| 85 |
resolveFilenameWildcard = function(_, name) |
| 86 |
return name |
| 87 |
end |
| 88 |
} |
| 89 |
|
| 90 |
local app = { |
| 91 |
world = world_mock, |
| 92 |
ui = ui_mock, |
| 93 |
config = config_mock, |
| 94 |
audio = audio_mock |
| 95 |
} |
| 96 |
|
| 97 |
return app |
| 98 |
end |
| 99 |
|
| 100 |
--[[ |
| 101 |
Test formats for the announcer should be as follows (empty lines should be used as indicated): |
| 102 |
it("description of what is expected/tested", function() |
| 103 |
local app_mock = create_app_mock(speed_set, desk_set) |
| 104 |
local announcer = Announcer(app_mock) |
| 105 |
|
| 106 |
Insert config settings here |
| 107 |
Followed by announcements to queue |
| 108 |
|
| 109 |
announcer:onTick --group ticks with each test |
| 110 |
Some test |
| 111 |
|
| 112 |
announcer:onTick |
| 113 |
Some test etc... |
| 114 |
end) |
| 115 |
|
| 116 |
speed_set is whether to obey the requested speed check in announcer.lua |
| 117 |
desk_set is whether we have a staffed desk |
| 118 |
]]-- |
| 119 |
|
| 120 |
describe("Announcer", function() |
| 121 |
it("nothing is played with an empty queue", function() |
| 122 |
local app_mock = create_app_mock(false, true) |
| 123 |
local announcer = Announcer(app_mock) |
| 124 |
|
| 125 |
announcer:onTick() |
| 126 |
|
| 127 |
assert.equal(0, #app_mock.audio.__played_sounds__) |
| 128 |
end) |
| 129 |
|
| 130 |
it("an announcement is played", function() |
| 131 |
local app_mock = create_app_mock(false, true) |
| 132 |
local announcer = Announcer(app_mock) |
| 133 |
|
| 134 |
announcer:playAnnouncement("sound.wav") |
| 135 |
|
| 136 |
announcer:onTick() |
| 137 |
assert.equal(1, #app_mock.audio.__played_sounds__) |
| 138 |
assert.equal("sound.wav", app_mock.audio.__played_sounds__[1].name) |
| 139 |
end) |
| 140 |
|
| 141 |
it("announcements shouldn't play when disabled", function() |
| 142 |
local app_mock = create_app_mock(false, true) |
| 143 |
local announcer = Announcer(app_mock) |
| 144 |
|
| 145 |
app_mock.config.play_announcements = false |
| 146 |
announcer:playAnnouncement("normal.wav") |
| 147 |
|
| 148 |
announcer:onTick() |
| 149 |
assert.equal(0, #app_mock.audio.__played_sounds__) |
| 150 |
end) |
| 151 |
|
| 152 |
it("duplicate announcements should be discarded", function() |
| 153 |
local app_mock = create_app_mock(false, true) |
| 154 |
local announcer = Announcer(app_mock) |
| 155 |
|
| 156 |
announcer:playAnnouncement("sound.wav") |
| 157 |
announcer:playAnnouncement("sound.wav") |
| 158 |
announcer:playAnnouncement("sound.wav") |
| 159 |
|
| 160 |
announcer:onTick() |
| 161 |
announcer:onTick() |
| 162 |
announcer:onTick() |
| 163 |
assert.equal(1, #app_mock.audio.__played_sounds__) |
| 164 |
end) |
| 165 |
|
| 166 |
it("announcements are played priority-wise", function() |
| 167 |
local app_mock = create_app_mock(false, true) |
| 168 |
local announcer = Announcer(app_mock) |
| 169 |
|
| 170 |
announcer:playAnnouncement("low.wav", AnnouncementPriority.Low) |
| 171 |
announcer:playAnnouncement("critical.wav", AnnouncementPriority.Critical) |
| 172 |
announcer:playAnnouncement("normal.wav", AnnouncementPriority.Normal) |
| 173 |
announcer:playAnnouncement("high.wav", AnnouncementPriority.High) |
| 174 |
|
| 175 |
announcer:onTick() |
| 176 |
assert.equal(1, #app_mock.audio.__played_sounds__) |
| 177 |
assert.equal("critical.wav", app_mock.audio.__played_sounds__[1].name) |
| 178 |
app_mock.audio.__mark_sounds_played__() |
| 179 |
|
| 180 |
announcer:onTick() |
| 181 |
assert.equal(1, #app_mock.audio.__played_sounds__) |
| 182 |
assert.equal("high.wav", app_mock.audio.__played_sounds__[1].name) |
| 183 |
app_mock.audio.__mark_sounds_played__() |
| 184 |
|
| 185 |
announcer:onTick() |
| 186 |
assert.equal(1, #app_mock.audio.__played_sounds__) |
| 187 |
assert.equal("normal.wav", app_mock.audio.__played_sounds__[1].name) |
| 188 |
app_mock.audio.__mark_sounds_played__() |
| 189 |
|
| 190 |
announcer:onTick() |
| 191 |
assert.equal(1, #app_mock.audio.__played_sounds__) |
| 192 |
assert.equal("low.wav", app_mock.audio.__played_sounds__[1].name) |
| 193 |
app_mock.audio.__mark_sounds_played__() |
| 194 |
end) |
| 195 |
|
| 196 |
it("announcements shouldn't play when not relevant anymore", function() |
| 197 |
local app_mock = create_app_mock(false, true) |
| 198 |
local announcer = Announcer(app_mock) |
| 199 |
|
| 200 |
announcer:playAnnouncement("normal.wav") |
| 201 |
app_mock.world.mock_game_date = app_mock.world.mock_game_date:plusHours(1000) -- time must be after announcement |
| 202 |
|
| 203 |
announcer:onTick() |
| 204 |
assert.equal(0, #app_mock.audio.__played_sounds__) |
| 205 |
end) |
| 206 |
|
| 207 |
it("only critical announcements play when paused", function() |
| 208 |
local app_mock = create_app_mock(true, true) |
| 209 |
local announcer = Announcer(app_mock) |
| 210 |
|
| 211 |
announcer:playAnnouncement("low.wav", AnnouncementPriority.Low) |
| 212 |
announcer:playAnnouncement("critical.wav", AnnouncementPriority.Critical) |
| 213 |
announcer:playAnnouncement("normal.wav", AnnouncementPriority.Normal) |
| 214 |
announcer:playAnnouncement("high.wav", AnnouncementPriority.High) |
| 215 |
|
| 216 |
announcer:onTick() |
| 217 |
assert.equal(1, #app_mock.audio.__played_sounds__) |
| 218 |
assert.equal("critical.wav", app_mock.audio.__played_sounds__[1].name) |
| 219 |
app_mock.audio.__mark_sounds_played__() |
| 220 |
|
| 221 |
announcer:onTick() |
| 222 |
assert.equal(0, #app_mock.audio.__played_sounds__) |
| 223 |
end) |
| 224 |
|
| 225 |
it("critical announcements play without a staffed desk", function() |
| 226 |
local app_mock = create_app_mock(false, false) |
| 227 |
local announcer = Announcer(app_mock) |
| 228 |
|
| 229 |
announcer:playAnnouncement("critical.wav", AnnouncementPriority.Critical) |
| 230 |
|
| 231 |
announcer:onTick() |
| 232 |
assert.equal(1, #app_mock.audio.__played_sounds__) |
| 233 |
assert.equal("critical.wav", app_mock.audio.__played_sounds__[1].name) |
| 234 |
app_mock.audio.__mark_sounds_played__() |
| 235 |
end) |
| 236 |
end) |