Giter VIP home page Giter VIP logo

hacktest's Introduction

HackTest

Build Status

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.

hacktest's People

Contributors

fredemmott avatar kmeht avatar wlin53 avatar jjergus avatar lexidor avatar davidsnider avatar periodic1236 avatar viratyosin avatar kendallhopkins avatar hgoldstein avatar jwatzman avatar atry avatar aloiret-ed avatar wizkid avatar rodmk avatar simonwelsh avatar azjezz avatar facebook-github-bot avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.