WoWUnit 🔬

WoWUnit allows you to easily write unit tests for your World of Warcraft addons and provides an interface to monitor them. Unit tests can be run at game events. Also provides methods for temporarily mocking variables.

Example

Let's assume we define the following functions in our addon:

Numbers = function() return 1, 2, 3 end
Realm = function() GetRealmName() .. '!' end

We can make the following tests:

local AreEqual, Exists, Replace = WoWUnit.AreEqual, WoWUnit.Exists, WoWUnit.Replace
local Tests = WoWUnit('MyAddonName', 'PLAYER_UPDATE', 'MONEY_UPDATE')
    -- tests will be called at startup, PLAYER_UPDATE and MONEY_UPDATE events

function Tests:PassingTest()
    AreEqual({1,2,3}, {Numbers()})
    Exists(true)
end

function Tests:FaillingTest()
    AreEqual('Apple', 'Pie')
    Exists(false)
end

function Tests:MockingTest()
    Replace('GetRealmName', function() return 'Horseshoe' end)
    AreEqual('Horseshoe!', Realm())
end

Test API

A unit test group is created by calling WoWUnit(name, event1, event2, ...) or WoWUnit:NewGroup(name, event1, event2, ...). Unit tests in the group are called at startup and whenever the game events listed occur.

A unit test is defined by indexing a function in the group. While the test is running, the following methods can be used: