/*
+--------------------------------------------------------------------+
- | CiviCRM version 5 |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM. |
- | |
- | CiviCRM is free software; you can copy, modify, and distribute it |
- | under the terms of the GNU Affero General Public License |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
+ | Copyright CiviCRM LLC. All rights reserved. |
| |
- | CiviCRM is distributed in the hope that it will be useful, but |
- | WITHOUT ANY WARRANTY; without even the implied warranty of |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
- | See the GNU Affero General Public License for more details. |
- | |
- | You should have received a copy of the GNU Affero General Public |
- | License and the CiviCRM Licensing Exception along |
- | with this program; if not, contact CiviCRM LLC |
- | at info[AT]civicrm[DOT]org. If you have questions about the |
- | GNU Affero General Public License or the licensing of CiviCRM, |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
namespace Civi\Test;
-class TAP extends \PHPUnit\Util\Printer implements \PHPUnit\Framework\TestListener {
-
- /**
- * @var int
- */
- protected $testNumber = 0;
-
- /**
- * @var int
- */
- protected $testSuiteLevel = 0;
-
- /**
- * @var bool
- */
- protected $testSuccessful = TRUE;
+if (version_compare(\PHPUnit\Runner\Version::id(), '7.0.0', '<')) {
+ class_alias('Civi\Test\TAPLegacy', 'Civi\Test\TAP');
+}
+else {
+ class TAP extends \PHPUnit\Util\Printer implements \PHPUnit\Framework\TestListener {
+
+ /**
+ * @var int
+ */
+ protected $testNumber = 0;
+
+ /**
+ * @var int
+ */
+ protected $testSuiteLevel = 0;
+
+ /**
+ * @var bool
+ */
+ protected $testSuccessful = TRUE;
+
+ /**
+ * Constructor.
+ *
+ * @param mixed $out
+ *
+ * @throws \PHPUnit\Framework\Exception
+ *
+ * @since Method available since Release 3.3.4
+ */
+ public function __construct($out = NULL) {
+ parent::__construct($out);
+ $this
+ ->write("TAP version 13\n");
+ }
- /**
- * Constructor.
- *
- * @param mixed $out
- *
- * @throws \PHPUnit\Framework\Exception
- *
- * @since Method available since Release 3.3.4
- */
- public function __construct($out = NULL) {
- parent::__construct($out);
- $this
- ->write("TAP version 13\n");
- }
+ /**
+ * An error occurred.
+ *
+ * @param \PHPUnit\Framework\Test $test
+ * @param \Throwable $t
+ * @param float $time
+ */
+ public function addError(\PHPUnit\Framework\Test $test, \Throwable $t, float $time): void {
+ $this
+ ->writeNotOk($test, 'Error');
+ }
- /**
- * An error occurred.
- *
- * @param \PHPUnit\Framework\Test $test
- * @param \Exception $e
- * @param float $time
- */
- public function addError(\PHPUnit\Framework\Test $test, \Exception $e, $time) {
- $this
- ->writeNotOk($test, 'Error');
- }
+ /**
+ * A failure occurred.
+ *
+ * @param \PHPUnit\Framework\Test $test
+ * @param \PHPUnit\Framework\AssertionFailedError $e
+ * @param float $time
+ */
+ public function addFailure(\PHPUnit\Framework\Test $test, \PHPUnit\Framework\AssertionFailedError $e, float $time): void {
+ $this
+ ->writeNotOk($test, 'Failure');
+ $message = explode("\n", \PHPUnit\Framework\TestFailure::exceptionToString($e));
+ $diagnostic = array(
+ 'message' => $message[0],
+ 'severity' => 'fail',
+ );
+ if ($e instanceof \PHPUnit\Framework\ExpectationFailedException) {
+ $cf = $e
+ ->getComparisonFailure();
+ if ($cf !== NULL) {
+ $diagnostic['data'] = array(
+ 'got' => $cf
+ ->getActual(),
+ 'expected' => $cf
+ ->getExpected(),
+ );
+ }
+ }
- /**
- * A failure occurred.
- *
- * @param \PHPUnit\Framework\Test $test
- * @param \PHPUnit\Framework\AssertionFailedError $e
- * @param float $time
- */
- public function addFailure(\PHPUnit\Framework\Test $test, \PHPUnit\Framework\AssertionFailedError $e, $time) {
- $this
- ->writeNotOk($test, 'Failure');
- $message = explode("\n", \PHPUnit\Framework\TestFailure::exceptionToString($e));
- $diagnostic = array(
- 'message' => $message[0],
- 'severity' => 'fail',
- );
- if ($e instanceof \PHPUnit\Framework\ExpectationFailedException) {
- $cf = $e
- ->getComparisonFailure();
- if ($cf !== NULL) {
- $diagnostic['data'] = array(
- 'got' => $cf
- ->getActual(),
- 'expected' => $cf
- ->getExpected(),
- );
+ if (function_exists('yaml_emit')) {
+ $content = \yaml_emit($diagnostic, YAML_UTF8_ENCODING);
+ $content = ' ' . strtr($content, ["\n" => "\n "]);
+ }
+ else {
+ // Any valid JSON document is a valid YAML document.
+ $content = json_encode($diagnostic, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
+ // For closest match, drop outermost {}'s. Realign indentation.
+ $content = substr($content, 0, strrpos($content, "}")) . ' }';
+ $content = ' ' . ltrim($content);
+ $content = sprintf(" ---\n%s\n ...\n", $content);
}
- }
- if (function_exists('yaml_emit')) {
- $content = \yaml_emit($diagnostic, YAML_UTF8_ENCODING);
- $content = ' ' . strtr($content, ["\n" => "\n "]);
+ $this->write($content);
}
- else {
- // Any valid JSON document is a valid YAML document.
- $content = json_encode($diagnostic, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
- // For closest match, drop outermost {}'s. Realign indentation.
- $content = substr($content, 0, strrpos($content, "}")) . ' }';
- $content = ' ' . ltrim($content);
- $content = sprintf(" ---\n%s\n ...\n", $content);
+
+ /**
+ * Incomplete test.
+ *
+ * @param \PHPUnit\Framework\Test $test
+ * @param \Throwable $t
+ * @param float $time
+ */
+ public function addIncompleteTest(\PHPUnit\Framework\Test $test, \Throwable $t, float $time): void {
+ $this
+ ->writeNotOk($test, '', 'TODO Incomplete Test');
}
- $this->write($content);
- }
+ /**
+ * Risky test.
+ *
+ * @param \PHPUnit\Framework\Test $test
+ * @param \Throwable $t
+ * @param float $time
+ *
+ * @since Method available since Release 4.0.0
+ */
+ public function addRiskyTest(\PHPUnit\Framework\Test $test, \Throwable $t, float $time): void {
+ $this
+ ->write(sprintf("ok %d - # RISKY%s\n", $this->testNumber, $t
+ ->getMessage() != '' ? ' ' . $t
+ ->getMessage() : ''));
+ $this->testSuccessful = FALSE;
+ }
- /**
- * Incomplete test.
- *
- * @param \PHPUnit\Framework\Test $test
- * @param \Exception $e
- * @param float $time
- */
- public function addIncompleteTest(\PHPUnit\Framework\Test $test, \Exception $e, $time) {
- $this
- ->writeNotOk($test, '', 'TODO Incomplete Test');
- }
+ /**
+ * Skipped test.
+ *
+ * @param \PHPUnit\Framework\Test $test
+ * @param \Throwable $t
+ * @param float $time
+ *
+ * @since Method available since Release 3.0.0
+ */
+ public function addSkippedTest(\PHPUnit\Framework\Test $test, \Throwable $t, float $time): void {
+ $this
+ ->write(sprintf("ok %d - # SKIP%s\n", $this->testNumber, $t
+ ->getMessage() != '' ? ' ' . $t
+ ->getMessage() : ''));
+ $this->testSuccessful = FALSE;
+ }
- /**
- * Risky test.
- *
- * @param \PHPUnit\Framework\Test $test
- * @param \Exception $e
- * @param float $time
- *
- * @since Method available since Release 4.0.0
- */
- public function addRiskyTest(\PHPUnit\Framework\Test $test, \Exception $e, $time) {
- $this
- ->write(sprintf("ok %d - # RISKY%s\n", $this->testNumber, $e
- ->getMessage() != '' ? ' ' . $e
- ->getMessage() : ''));
- $this->testSuccessful = FALSE;
- }
+ /**
+ * Warning test.
+ *
+ * @param \PHPUnit\Framework\Test $test
+ * @param \PHPUnit\Framework\Warning $e
+ * @param float $time
+ *
+ * @since Method available since Release 3.0.0
+ */
+ public function addWarning(\PHPUnit\Framework\Test $test, \PHPUnit\Framework\Warning $e, float $time): void {
+ $this
+ ->write(sprintf("ok %d - # Warning%s\n", $this->testNumber, $e
+ ->getMessage() != '' ? ' ' . $e
+ ->getMessage() : ''));
+ $this->testSuccessful = FALSE;
+ }
- /**
- * Skipped test.
- *
- * @param \PHPUnit\Framework\Test $test
- * @param \Exception $e
- * @param float $time
- *
- * @since Method available since Release 3.0.0
- */
- public function addSkippedTest(\PHPUnit\Framework\Test $test, \Exception $e, $time) {
- $this
- ->write(sprintf("ok %d - # SKIP%s\n", $this->testNumber, $e
- ->getMessage() != '' ? ' ' . $e
- ->getMessage() : ''));
- $this->testSuccessful = FALSE;
- }
+ /**
+ * A testsuite started.
+ *
+ * @param \PHPUnit\Framework\TestSuite $suite
+ */
+ public function startTestSuite(\PHPUnit\Framework\TestSuite $suite): void {
+ $this->testSuiteLevel++;
+ }
- /**
- * Warning test.
- *
- * @param \PHPUnit\Framework\Test $test
- * @param \PHPUnit\Framework\Warning $e
- * @param float $time
- *
- * @since Method available since Release 3.0.0
- */
- public function addWarning(\PHPUnit\Framework\Test $test, \PHPUnit\Framework\Warning $e, $time) {
- $this
- ->write(sprintf("ok %d - # Warning%s\n", $this->testNumber, $e
- ->getMessage() != '' ? ' ' . $e
- ->getMessage() : ''));
- $this->testSuccessful = FALSE;
- }
+ /**
+ * A testsuite ended.
+ *
+ * @param \PHPUnit\Framework\TestSuite $suite
+ */
+ public function endTestSuite(\PHPUnit\Framework\TestSuite $suite): void {
+ $this->testSuiteLevel--;
+ if ($this->testSuiteLevel == 0) {
+ $this
+ ->write(sprintf("1..%d\n", $this->testNumber));
+ }
+ }
- /**
- * A testsuite started.
- *
- * @param \PHPUnit\Framework\TestSuite $suite
- */
- public function startTestSuite(\PHPUnit\Framework\TestSuite $suite) {
- $this->testSuiteLevel++;
- }
+ /**
+ * A test started.
+ *
+ * @param \PHPUnit\Framework\Test $test
+ */
+ public function startTest(\PHPUnit\Framework\Test $test): void {
+ $this->testNumber++;
+ $this->testSuccessful = TRUE;
+ }
- /**
- * A testsuite ended.
- *
- * @param \PHPUnit\Framework\TestSuite $suite
- */
- public function endTestSuite(\PHPUnit\Framework\TestSuite $suite) {
- $this->testSuiteLevel--;
- if ($this->testSuiteLevel == 0) {
+ /**
+ * A test ended.
+ *
+ * @param \PHPUnit\Framework\Test $test
+ * @param float $time
+ */
+ public function endTest(\PHPUnit\Framework\Test $test, float $time): void {
+ if ($this->testSuccessful === TRUE) {
+ $this
+ ->write(sprintf("ok %d - %s\n", $this->testNumber, \PHPUnit\Util\Test::describeAsString($test)));
+ }
$this
- ->write(sprintf("1..%d\n", $this->testNumber));
+ ->writeDiagnostics($test);
}
- }
- /**
- * A test started.
- *
- * @param \PHPUnit\Framework\Test $test
- */
- public function startTest(\PHPUnit\Framework\Test $test) {
- $this->testNumber++;
- $this->testSuccessful = TRUE;
- }
-
- /**
- * A test ended.
- *
- * @param \PHPUnit\Framework\Test $test
- * @param float $time
- */
- public function endTest(\PHPUnit\Framework\Test $test, $time) {
- if ($this->testSuccessful === TRUE) {
+ /**
+ * @param \PHPUnit\Framework\Test $test
+ * @param string $prefix
+ * @param string $directive
+ */
+ protected function writeNotOk(\PHPUnit\Framework\Test $test, $prefix = '', $directive = ''): void {
$this
- ->write(sprintf("ok %d - %s\n", $this->testNumber, \PHPUnit\Util\Test::describe($test)));
+ ->write(sprintf("not ok %d - %s%s%s\n", $this->testNumber, $prefix != '' ? $prefix . ': ' : '', \PHPUnit\Util\Test::describeAsString($test), $directive != '' ? ' # ' . $directive : ''));
+ $this->testSuccessful = FALSE;
}
- $this
- ->writeDiagnostics($test);
- }
-
- /**
- * @param \PHPUnit\Framework\Test $test
- * @param string $prefix
- * @param string $directive
- */
- protected function writeNotOk(\PHPUnit\Framework\Test $test, $prefix = '', $directive = '') {
- $this
- ->write(sprintf("not ok %d - %s%s%s\n", $this->testNumber, $prefix != '' ? $prefix . ': ' : '', \PHPUnit\Util\Test::describe($test), $directive != '' ? ' # ' . $directive : ''));
- $this->testSuccessful = FALSE;
- }
- /**
- * @param \PHPUnit\Framework\Test $test
- */
- private function writeDiagnostics(\PHPUnit\Framework\Test $test) {
- if (!$test instanceof \PHPUnit\Framework\TestCase) {
- return;
- }
- if (!$test
- ->hasOutput()) {
- return;
- }
- foreach (explode("\n", trim($test
- ->getActualOutput())) as $line) {
- $this
- ->write(sprintf("# %s\n", $line));
+ /**
+ * @param \PHPUnit\Framework\Test $test
+ */
+ private function writeDiagnostics(\PHPUnit\Framework\Test $test): void {
+ if (!$test instanceof \PHPUnit\Framework\TestCase) {
+ return;
+ }
+ if (!$test
+ ->hasOutput()) {
+ return;
+ }
+ foreach (explode("\n", trim($test
+ ->getActualOutput())) as $line) {
+ $this
+ ->write(sprintf("# %s\n", $line));
+ }
}
- }
+ }
}
projects / civicrm-core.git / blobdiff