WoW wowUnit framework addon Dragonflight/Wrath of the Lich King Classic 2024

Name	Size	Uploaded	Game Version	Downloads
wowUnit 5.2 release	113.82 KB	Jul 15, 2019	8.2.0	93	Download
wowUnit 5.1 release	113.82 KB	Dec 15, 2018	8.1.0 +1	61	Download
wowUnit 5 release	114.82 KB	Dec 3, 2018	8.0.1	22	Download

Example

Say you have an AddOn called addAddOn that simply has a function for adding two numbers. You could write tests to make sure the function performs as expected like so:

addAddOn.tests = {
    ["Check addition of numbers"] = {
        ["See if results are correct"] = function()
            wowUnit:assertEquals(addAddOn:add(1, 1), 2, "1 and 1 is 2")
            wowUnit:assertEquals(addAddOn:add(-3, 5), 2, "-3 + 5 = 2")
            wowUnit:assertEquals(addAddOn:add(1997, -1995), 2, "1997 + (-1995) = 2")
        end,
        ["make sure it behaves as expected for strange input"] = function()
            wowUnit:isNil(addAddOn:add(), "nil when no parameters are given")
            wowUnit:isNil(addAddOn:add(1), "nil when only on parameter is given")
            wowUnit:isNil(addAddOn:add(nil, 1), "nil when only one parameter is given")
            wowUnit:assertEquals(addAddOn:add(-3, 5, 10), 2, "any parameters past the first 2 are ignored")
            wowUnit:isNil(addAddOn:add(1, "1"), "nil when a parameter is not a number")
        end
    }
}

Once tests are written and loaded, you could run these tests in game by typing "/test addAddOn".

Running Tests

You can easily run unit tests contained in any table directly accessible in the global namespace by using any of the following slash-commands:

/test myAddon
/wowunit myOtherAddon
/wu testTable
/unittest testSuite

If your tests are buried deeper within another table, you'll have to run command like so:

/run wowUnit:StartTests(myAddon.someTable.testSuiteIsHere)

Test Tables

Anatomy of a Test Suite

title

(optional) The title of this test suite, diplayed in wowUnit's main window

tests

A table containing the test categories for this test suite. The keys of any entries in this table serve as titles for your categories, while their values should be tables containing the actual tests.

Example:

testTable = {
    title = "My test Suite",
    tests = {
        ["Category 1"] = {
            ...
        },
        ["Another Category"] = {
            ...
        },
        ...
    }
}

Anatomy of a Test Category

setup

(optional) The function defined here will be called before every test in the current category.

teardown

(optional) The function defined here will be called after every test in the current category.

Any other functions defined in the table will be considered tests.

Example:

...
["Example Category"] = {
	["setup"] = function()
		-- mock complicated function
		myAddon.oldFunc = myAddon.complicatedFunction;
		myAddon.complicatedFunction = function()
			assert(true, "complicated function has been called");
		end
	end,
	["teardown"] = function()
		-- restore complicated function
		myAddon.complicatedFunction = myAddon.oldFunc;
	end,
	["does it get called?"] = function()
		wowUnit:expect(1);
	    myAddon.shouldCallTheOtherFunction();
    end,
    ...
}
...

Assertions