hhvm / hacktest
The Hack Test Library
Installs: 574 448
Dependents: 84
Suggesters: 0
Security: 0
Stars: 29
Watchers: 15
Forks: 12
Open Issues: 11
Language:Hack
Requires
- hhvm: ^4.128
- facebook/hh-clilib: ^2.5.0rc1
- hhvm/type-assert: ^3.0|^4.0
Requires (Dev)
- facebook/fbexpect: ^2.8.1
- hhvm/hhast: ^4.0
- hhvm/hhvm-autoload: ^2.0.2|^3.0
README
HackTest
HackTest is a unit test runner and base class. Assertions are provided by separate libraries, such fbexpect.
Installation
php /path/to/composer.phar require --dev hhvm/hacktest facebook/fbexpect
Usage
To run tests:
vendor/bin/hacktest [OPTIONS] tests/
Tests are methods in classes, where:
- the class name matches the file name
- the class name ends with 'Test'
- the method is public
- the method name begins with 'test'
Test methods can be async, and will automatically be awaited.
Additionally, classes can implement several special methods:
public static function beforeFirstTestAsync(): Awaitable<void>
public static function afterLastTestAsync(): Awaitable<void>
public function beforeEachTestAsync(): Awaitable<void>
public function afterEachTestAsync(): Awaitable<void>
Finally, for data-driven tests, the <<DataProvider>>
attribute can be used:
public function provideFoos(): vec<(string, int)> { return vec[ tuple('foo', 123), tuple('bar', 456), ]; } <<DataProvider('provideFoos')>> public function testFoos(string $a, int $b): void { .... }
Examples
"I want to test all files in a directory"
$ vendor/bin/hacktest tests/clean/exit/
...
Summary: 3 test(s), 3 passed, 0 failed, 0 skipped, 0 error(s).
"I want to run all tests in a specific file"
$ vendor/bin/hacktest tests/dirty/DirtyAsyncTest.php
FFF
1) DirtyAsyncTest::testWithNonNullableTypesAsync
Failed asserting that Array &0 (
0 => 1
1 => 'foo'
) is not identical to Array &0 (
0 => 1
1 => 'foo'
).
/fakepath/hacktest/tests/dirty/DirtyAsyncTest.php(22): Facebook\FBExpect\ExpectObj->toNotBeSame()
/fakepath/hacktest/src/Framework/HackTestCase.php(43): DirtyAsyncTest->testWithNonNullableTypesAsync()
2)...
Summary: 3 test(s), 0 passed, 3 failed, 0 skipped, 0 error(s).
For an example in verbose mode, see example.txt
Contributing
See CONTRIBUTING.md.
License
The HackTest framework is MIT-licensed.