Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Assert that a value is false, strictly. The test fails if it is not.

Assert that a value is true, strictly. The test fails if it is not.

Assert that two values are equal, strictly. The test fails if they are not.

Assert an unconditional failure. This is just a convenience method that better indicates intent than using dummy values with assertEqual(). This causes test failure.

End this test by asserting that the test should be skipped for some reason.

This simplest way to assert exceptions are thrown.

Straightforward method for writing unit tests which check if some block of code throws an exception. For example, this allows you to test the exception behavior of is_a_fruit() on various inputs:

public function testFruit() {
  $this->tryTestCases(
    array(
      'apple is a fruit'    => new Apple(),
      'rock is not a fruit' => new Rock(),
    ),
    array(
      true,
      false,
    ),
    array($this, 'tryIsAFruit'),
    'NotAFruitException');
}

protected function tryIsAFruit($input) {
  is_a_fruit($input);
}

Convenience wrapper around tryTestCases() for cases where your inputs are scalar. For example:

public function testFruit() {
  $this->tryTestCaseMap(
    array(
      'apple' => true,
      'rock'  => false,
    ),
    array($this, 'tryIsAFruit'),
    'NotAFruitException');
}

protected function tryIsAFruit($input) {
  is_a_fruit($input);
}

For cases where your inputs are not scalar, use tryTestCases().

This hook is invoked once, before any tests in this class are run. It gives you an opportunity to perform setup steps for the entire class.

This hook is invoked once, after any tests in this class are run. It gives you an opportunity to perform teardown steps for the entire class.

This hook is invoked once per test, before the test method is invoked.

This hook is invoked once per test, after the test method is invoked.

This hook is invoked once, before any test cases execute. It gives you an opportunity to perform setup steps for the entire suite of test cases.

This hook is invoked once, after all test cases execute.

Construct a new test case. This method is final, use willRunTests() to provide test-wide setup logic.

Mark the currently-running test as a failure.

This was a triumph. I'm making a note here: HUGE SUCCESS.

Mark the current running test as skipped.

Execute the tests in this test case. You should not call this directly; use PhutilUnitTestEngine to orchestrate test execution.

Returns info about the caller function.

Fail an assertion which checks that some result is equal to a specific value, like 'true' or 'false'. This prints a readable error message and fails the current test.

This method throws and does not return.

Returns an integer seed to use when building unique identifiers (e.g., non-colliding usernames). The seed is unstable and its value will change between test runs, so your tests must not rely on it.

Throws unless tests are currently executing. This method can be used to guard code which is specific to unit tests and should not normally be reachable.

If tests aren't currently being executed, throws an exception.