2017 © Pedro Peláez
 

library hacktest

The Hack Test Library

image

hhvm/hacktest

The Hack Test Library

  • Wednesday, July 18, 2018
  • by fredemmott
  • Repository
  • 9 Watchers
  • 0 Stars
  • 149 Installations
  • Hack
  • 7 Dependents
  • 0 Suggesters
  • 0 Forks
  • 4 Open issues
  • 2 Versions
  • 0 % Grown

The README.md

HackTest

Build Status, (*1)

HackTest is a unit test runner and base class. Assertions are provided by separate libraries, such fbexpect., (*2)

Installation

php /path/to/composer.phar require --dev hhvm/hacktest facebook/fbexpect

Usage

To run tests:, (*3)

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', (*4)

Test methods can be async, and will automatically be awaited., (*5)

Additionally, classes can implement several special methods:, (*6)

  • 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:, (*7)

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, (*8)

Contributing

See CONTRIBUTING.md., (*9)

License

The HackTest framework is MIT-licensed., (*10)

The Versions