https://github.com/tiagolr/asynctests

Extends haxe unit tests, providing async tests.
https://github.com/tiagolr/asynctests

Last synced: about 2 months ago
JSON representation

Extends haxe unit tests, providing async tests.

• Host: GitHub
• URL: https://github.com/tiagolr/asynctests
• Owner: tiagolr
• Created: 2014-07-05T01:19:29.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-15T14:47:12.000Z (almost 10 years ago)
• Last Synced: 2023-03-27T08:50:20.514Z (almost 2 years ago)
• Language: Haxe
• Size: 148 KB
• Stars: 9
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Async-Tests

This library provides **async unit tests** by extending haxe standard unit tests.

### Install

```

haxelib install async-tests

```

### Example

This lib consists of two files:

* **AsyncTestRunner** (extends haxe.unit.TestRunner) 

* **AsyncTestCase** (extends haxe.unit.TestCase)

Its usage is almost identical to using standard [haxe unit tests]

```astionscript

// Test runner class

class MyTestRunner {

	

	static function main() {

		var r = new async.tests.AsyncTestRunner(onComplete);

		r.add(new MyTestCase())

		r.run();

	}

	

	// function called when all tests finish

	static function onComplete() {

		#if (cpp || neko || php)

		Sys.exit(0);

		#end

	}

}

```

 **AsyncTestRunner** constructor receives a callback to ```onComplete```, so it can notify the when all tests finish.

```actionscript

class MyTestCase extends AsyncTestCase {

	function testSampleAsync() {

	

		// test only ends when async created is executed or timesout

		urlLoader.addEventListener(Event.COMPLETE, createAsync(onAssetsLoaded, 300));

	}

	

	function onAssetsLoaded(o:Dynamic) {

		var event = cast(o, Event);

		assertTrue(event.type == Event.COMPLETE);

	}

}

```

**AsyncTestCase** has the special method:

```actionscript

createAsync(callback:Dynamic->Void, timeout:Int):Dynamic->Void

``` 

When ```createAsync(method)``` is called, it creates another method wrapped around the original, and keeps track how mutch time it takes to invoke it.

```actionscript

// another alternative to perform same action

var t = createAsync(onTestsLoaded, 300);

urdLoader.addEventListener(Event.COMPLETE, t);

```

#Notes

* When ```createAsync()``` is called, the timeout starts counting immediatelly, so always create "asyncs" right before invoking an operation that uses them.

* Methods passed to ```createAsync()``` have the signature ```Dynamic->Void``` (other signatures maybe available in the future).

* **AsyncTestRunner** can run std **TestCase** and **AsyncTestCase** can run from std **TestRunner** (no async calls tho).

* Inside **AsyncTestCase** normal tests support createAsync(), the test only ends when all asyncs created are executed or timed out.

[haxe unit tests]:http://old.haxe.org/doc/cross/unit