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 and Fallout 4.
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
Documentation can be found on the Lilac GitHub Wiki: https://github.com/chesko256/Lilac/wiki
Requirements
Lilac does not have any extra requirements or dependencies, just the Skyrim base game.
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
Lilac test scripts are attached to quests. To run your tests, just start the quest:
startquest MyTestQuest
The results will be printed to your Papyrus log.
Version History
v1.2: Added spec expectation number to test runner output in order to assist debugging. Added 'enabled' flag in order to help prevent unwanted accidental execution by users at runtime. Removed the 'contain' matcher in order to remove the SKSE dependency.
v1.1: Fixed bugs related to reports being wrong when the Actual was a blank string.
v1.0: Initial Release
License
Lilac is released under the MIT License.
Contact
Contact Chesko at [email protected]