Lilac by chesko256

A Papyrus Testing Framework

Lilac is a unit testing framework for Papyrus. It has a simple and direct syntax so that you can easily write tests to increase the quality of your mods.

It is inspired by Jasmine for Javascript. It is currently available for Skyrim, with Fallout 4 support coming soon.

Lilac can be built into your mod and distributed with it. Your tests will only run when you decide to run them; your users will most likely never know they exist.

Documentation can be found on the Lilac GitHub Wiki: https://github.com/chesko256/Lilac/wiki

Installation

All of Lilac is contained in a single script file, Lilac.psc. There is no complex set-up or installation.

Download and install the latest release using a mod manager, or just drop Lilac.psc into your Scripts/Source directory. Then, create a new script that extends Lilac and away you go:

scriptname MyTests extends Lilac

Writing Tests

Lilac allows you to write tests in a clear and expressive syntax.

function MonsterSpawnerSuite()

    it ( "should spawn monsters", MonsterSpawnerTest() )

endFunction


function MonsterSpawnerTest()

    spawner.SpawnMonsters()

    expectInt ( spawner.SpawnedMonsterCount, to, beEqualTo, 20 )
    expectRef ( spawner.LastSpawnedMonster, notTo, beNone )
    expectForm ( spawner.LastSpawnedMonsterType, to, beEqualTo, MegaDragon )

endFunction

Running Tests

Just run a console command to start the quest that you attached your test script to, and Lilac takes care of the rest. The results will be output to your Papyrus log:

startquest MyTestQuest

License

Lilac is licensed under the MIT License.

Contact