https://github.com/jaliborc/wowunit

A unit testing framework for World of Warcraft
https://github.com/jaliborc/wowunit

addon game-events lua unit-testing world-of-warcraft

Last synced: 27 days ago
JSON representation

A unit testing framework for World of Warcraft

• Host: GitHub
• URL: https://github.com/jaliborc/wowunit
• Owner: Jaliborc
• Created: 2013-07-25T01:11:44.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-05-01T18:35:32.000Z (9 months ago)
• Last Synced: 2024-05-02T13:10:43.130Z (8 months ago)
• Topics: addon, game-events, lua, unit-testing, world-of-warcraft
• Language: Lua
• Homepage:
• Size: 92.8 KB
• Stars: 30
• Watchers: 5
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        

![Preview](http://jaliborc.com/media/addons/large/wowunit.jpg)

[![Install](http://img.shields.io/badge/install-curseforge-f16436)](https://www.curseforge.com/wow/addons/pettracker)

[![Patreon](http://img.shields.io/badge/news-patreon-ff424d)](https://www.patreon.com/jaliborc)

[![Community](http://img.shields.io/badge/community-discord-5865F2)](https://bit.ly/discord-jaliborc)

# WoWUnit :microscope:

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

## Integration

The easiest way to integrate unit testing into your addon is to add `## OptionalDeps: WoWUnit` to your `.toc` file. Then, check for WoWUnit in your code before running tests:

    if WoWUnit then

        local Tests = WoWUnit('MyTests')

        ... etc

    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:

|Name|Description|

|:--|:--|

| AreEqual(a, b) | Checks wether `a` and `b` match. Throws a fail status if not. |

| IsTrue(value) | Checks wether `value` passes an if statement. Throws a fail status if not. |

| Exists(value) | Same as above. |

| IsFalse(value) | Checks wether `value` fails an if statement. Throws a fail status if not. |

| Replace([table,] name, replace) | Temporarly replaces `table[name]` or global `name` with `replace` while the unit test is running. |

| ClearReplaces() | Resets all replacements done so far. |

| Enable() | Enables the current unit test (enabled by default). |

| Disable() | Disables the current unit test. |

## To Devs

If you use this tool, please list `wow-unit` as a tool you used in development on the CurseForge dependencies system. It's a big help! 👍