This is not the latest stable version of tink_unittest. See version 0.5.5 for the latest version.

To install, run:

haxelib install tink_unittest 0.5.2 

See using Haxelib in Haxelib documentation for more information.


Tink Unit Test Framework Build Status

Quick Look

Quick Look


  1. Tag instance methods with metadata (see below)
  2. Create a test batch with TestBatch.make([...])
  3. Run it with Runner.run(batch)
  4. Handle the results and exit accordingly

Supported metadata:

  • @:startup: Run once before all tests
  • @:before: Run before each tests
  • @:after: Run after each tests
  • @:shutdown: Run once after all tests
  • @:timeout(int): Set timeout (in ms), default: 5000 (you can also put this at class-level)
  • @:describe(string): Set description of test, default: name of function
  • @:variant(params): Add variants to a test (see example below)
  • @:include: Only run tests tagged with @:include
  • @:exclude: Exclude this test

Basic Example

import tink.testrunner.Runner;
import tink.unit.Assert.assert;

using tink.CoreApi;

class RunTests {
	static function main() {
			new NormalTest(),
			new AwaitTest(),

class NormalTest {
	public function new() {}
	@:before public function before() return Noise;
	@:after public function after() return Noise;
	@:startup public function startup() return Noise;
	@:shutdown public function shutdown() return Noise;
	@:describe('Sync test')
	public function sync()
		return new Assertion(true, 'Always true');
	@:describe('Test using Assert')
	public function syncAssert()
		return assert(true);
	@:describe('Async test')
	public function async()
		return Future.sync(new Assertion(true, 'Always true'));
	@:describe('Async test using Assert')
	public function asyncAssert()
		return Future.sync(assert(true));
	@:timeout(500) // in ms
	@:describe('Timeout test')
	public function timeout()
		return Future.async(function(cb) haxe.Timer.delay(function() cb(assert(true)), 1000));
	@:describe('  your')
	@:describe('    descriptions')
	public function nestedDescriptions()
		return assert(true);
	@:variant("Variant description" (1, 1))
	@:variant(2, 2)
	@:variant(target.myInt, 3) // access public fields of "this" with "target.field"
	public function variant(a:Int, b:Int) {
		return assert(a == b);
	public var myInt = 3;

class AwaitTest {
  public function new() {}
	@:describe('Async test powered by tink_await')
	@:async public function async() {
		var actual = @:await someAsyncValue();
		return assert('expected' == actual);
	function someAsyncValue() 
		return Future.async(function(cb) haxe.Timer.delay(function() cb('actual'), 1000));

Test Methods

All public method without the following metadata is considered a test method:

  • @:startup
  • @:before
  • @:after
  • @:shutdown

Each test method should return a value that can be casted to tink.testrunner.Assertions. There are multiple ways in doing so, the simplest way is to return a single tink.testrunner.Assertion:

Sync Assertions
return new Assertion(true, 'Some description);
// or
return tink.unit.Assert.assert(true);

You can also return an Array<Assertion>

return [for(i in 0...10) new Assertion(true, 'Some description)];
// or
return [for(i in 0...10) tink.unit.Assert.assert(true)];
Async Assertions

You can use the Future/Promise variants of Assertion/Assertions

You can also use AssertionBuffer, which can emit Assertion over time and in async operations:

var asserts = new AssertionBuffer();
return asserts.done();

To save some typing, you can tag the class with @:asserts, then a asserts:AssertionBuffer argument will be automatically injected to each of the test methods;

class MyTest {
	public function testSomething() {
		return asserts.done();
1 year ago

All libraries are free

Every month, more than thousand developers use haxelib to find, share, and reuse code — and assemble it in powerful new ways. Enjoy Haxe; It is great!

Explore Haxe

Haxe Manual

Haxe Code Cookbook

Haxe API documentation

You can try Haxe in the browser! try.haxe.org

Join us on Github!

Haxe is being developed on GitHub. Feel free to contribute or report issues to our projects.

Haxe on Github