Making Test Assertions
Making Test Assertions
- final protected function assertFalse($result, $message) — Assert that a value is `false`, strictly. The test fails if it is not.
- final protected function assertTrue($result, $message) — Assert that a value is `true`, strictly. The test fails if it is not.
- final protected function assertEqual($expect, $result, $message) — Assert that two values are equal, strictly. The test fails if they are not.
- final protected function assertFailure($message) — Assert an unconditional failure. This is just a convenience method that better indicates intent than using dummy values with assertEqual(). This causes test failure.
- final protected function assertSkipped($message) — End this test by asserting that the test should be skipped for some reason.
Exception Handling
Exception Handling
- final protected function assertException($expected_exception_class, $callable) — This simplest way to assert exceptions are thrown.
- final protected function tryTestCases($inputs, $expect, $callable, $exception_class) — 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:
- final protected function tryTestCaseMap($map, $callable, $exception_class) — Convenience wrapper around @{method:tryTestCases} for cases where your inputs are scalar. For example:
Hooks for Setup and Teardown
Hooks for Setup and Teardown
- protected function willRunTests() — 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.
- protected function didRunTests() — 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.
- protected function willRunOneTest($test_method_name) — This hook is invoked once per test, before the test method is invoked.
- protected function didRunOneTest($test_method_name) — This hook is invoked once per test, after the test method is invoked.
- public function willRunTestCases($test_cases) — 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.
- public function didRunTestCases($test_cases) — This hook is invoked once, after all test cases execute.
Internals
Internals
- final public function __construct() — Construct a new test case. This method is ##final##, use willRunTests() to provide test-wide setup logic.
- private function failTest($reason) — Mark the currently-running test as a failure.
- private function passTest($reason) — This was a triumph. I'm making a note here: HUGE SUCCESS.
- private function skipTest($reason) — Mark the current running test as skipped.
- final public function run() — Execute the tests in this test case. You should not call this directly; use @{class:PhutilUnitTestEngine} to orchestrate test execution.
- private function failAssertionWithExpectedValue($expect_description, $actual_result, $message) — 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.
Other Methods
Other Methods
- public function __get($name)
- public function __set($name, $value)
- public function current()
- public function key()
- public function next()
- public function rewind()
- public function valid()
- private function throwOnAttemptedIteration()
- public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
- final protected function assertCaught($expect, $actual, $message)
- private function resultTest($test_result, $reason)
- final public function setEnableCoverage($enable_coverage)
- private function beginCoverage()
- private function endCoverage()
- private function assertCoverageAvailable()
- final public function getWorkingCopy()
- final public function setWorkingCopy($working_copy)
- final public function getProjectRoot()
- final public function setPaths($paths)
- final protected function getLink($method)
- final public function setRenderer($renderer)
- private static function getCallerInfo() — Returns info about the caller function.
- final protected function assertExecutable($binary)
- final protected function getSupportExecutable($executable)
- final protected function getLinter()
- public function testLinter()
- protected function executeTestsInDirectory($root) — Executes all tests from the specified subdirectory. If a linter is not explicitly specified, it will be inferred from the name of the test class.
- private function lintFile($file, $linter)
- private function compareLint($file, $expect, $results)
- private function compareTransform($expected, $actual)
- private static function compareLintMessageProperty($x, $y) — Compare properties of @{class:ArcanistLintMessage} instances.
- private function renderMessages($header, $messages)
- protected function getLinterRule() — Returns an instance of the linter rule being tested.