class TestStatus

Same name in other branches
  1. 9 core/lib/Drupal/Core/Test/TestStatus.php \Drupal\Core\Test\TestStatus
  2. 10 core/lib/Drupal/Core/Test/TestStatus.php \Drupal\Core\Test\TestStatus
  3. 11.x core/lib/Drupal/Core/Test/TestStatus.php \Drupal\Core\Test\TestStatus

Consolidates test result status information.

For our test runners, a $status of 0 = passed test, 1 = failed test, 2 = exception, >2 indicates segfault timeout, or other type of system failure.

Hierarchy

Expanded class hierarchy of TestStatus

1 file declares its use of TestStatus
PhpUnitTestRunnerTest.php in core/tests/Drupal/Tests/Core/Test/PhpUnitTestRunnerTest.php

File

core/lib/Drupal/Core/Test/TestStatus.php, line 12

Namespace

Drupal\Core\Test
View source 
class TestStatus {
    
    /**
     * Signify that the test result was a passed test.
     */
    const PASS = 0;
    
    /**
     * Signify that the test result was a failed test.
     */
    const FAIL = 1;
    
    /**
     * Signify that the test result was an exception or code error.
     *
     * This means that the test runner was able to exit and report an error.
     */
    const EXCEPTION = 2;
    
    /**
     * Signify a system error where the test runner was unable to complete.
     *
     * Note that SYSTEM actually represents the lowest value of system errors, and
     * the returned value could be as high as 127. Since that's the case, this
     * constant should be used for range comparisons, and not just for equality.
     *
     * @see http://php.net/manual/pcntl.constants.php
     */
    const SYSTEM = 3;
    
    /**
     * Turns a status code into a human-readable string.
     *
     * @param int $status
     *   A test runner return code.
     *
     * @return string
     *   The human-readable version of the status code.
     */
    public static function label($status) {
        $statusMap = [
            static::PASS => 'pass',
            static::FAIL => 'fail',
            static::EXCEPTION => 'exception',
            static::SYSTEM => 'error',
        ];
        // For status 3 and higher, we want 'error.'
        $label = $statusMap[$status > static::SYSTEM ? static::SYSTEM : $status];
        return $label;
    }

}

Members

Title Modifiers Object type Summary
TestStatus::EXCEPTION constant Signify that the test result was an exception or code error.
TestStatus::FAIL constant Signify that the test result was a failed test.
TestStatus::label public static function Turns a status code into a human-readable string.
TestStatus::PASS constant Signify that the test result was a passed test.
TestStatus::SYSTEM constant Signify a system error where the test runner was unable to complete.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.