8889841cPK [ z README.mdnu W+A
# PHPUnit
[](https://packagist.org/packages/phpunit/phpunit)
[](https://github.com/sebastianbergmann/phpunit/actions)
[](https://shepherd.dev/github/sebastianbergmann/phpunit)
[](https://codecov.io/gh/sebastianbergmann/phpunit)
PHPUnit is a programmer-oriented testing framework for PHP. It is an instance of the xUnit architecture for unit testing frameworks.
## Installation
We distribute a [PHP Archive (PHAR)](https://php.net/phar) that has all required (as well as some optional) dependencies of PHPUnit bundled in a single file:
```bash
$ wget https://phar.phpunit.de/phpunit-X.Y.phar
$ php phpunit-X.Y.phar --version
```
Please replace `X.Y` with the version of PHPUnit you are interested in.
Alternatively, you may use [Composer](https://getcomposer.org/) to download and install PHPUnit as well as its dependencies. Please refer to the "[Getting Started](https://phpunit.de/getting-started-with-phpunit.html)" guide for details on how to install PHPUnit.
## Contribute
Please refer to [CONTRIBUTING.md](https://github.com/sebastianbergmann/phpunit/blob/master/.github/CONTRIBUTING.md) for information on how to contribute to PHPUnit and its related projects.
## List of Contributors
Thanks to everyone who has contributed to PHPUnit! You can find a detailed list of contributors on every PHPUnit related package on GitHub. This list shows only the major components:
* [PHPUnit](https://github.com/sebastianbergmann/phpunit/graphs/contributors)
* [php-code-coverage](https://github.com/sebastianbergmann/php-code-coverage/graphs/contributors)
A very special thanks to everyone who has contributed to the [documentation](https://github.com/sebastianbergmann/phpunit-documentation-english/graphs/contributors).
PK [O .phpstorm.meta.phpnu W+A "$0"])
);
override(
\PHPUnit\Framework\TestCase::createStub(0),
map([""=>"$0"])
);
override(
\PHPUnit\Framework\TestCase::createConfiguredMock(0),
map([""=>"$0"])
);
override(
\PHPUnit\Framework\TestCase::createPartialMock(0),
map([""=>"$0"])
);
override(
\PHPUnit\Framework\TestCase::createTestProxy(0),
map([""=>"$0"])
);
override(
\PHPUnit\Framework\TestCase::getMockForAbstractClass(0),
map([""=>"$0"])
);
}
PK [ˊʜ
phpunitnu W+A #!/usr/bin/env php
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
if (!version_compare(PHP_VERSION, PHP_VERSION, '=')) {
fwrite(
STDERR,
sprintf(
'%s declares an invalid value for PHP_VERSION.' . PHP_EOL .
'This breaks fundamental functionality such as version_compare().' . PHP_EOL .
'Please use a different PHP interpreter.' . PHP_EOL,
PHP_BINARY
)
);
die(1);
}
if (version_compare('7.3.0', PHP_VERSION, '>')) {
fwrite(
STDERR,
sprintf(
'This version of PHPUnit requires PHP >= 7.3.' . PHP_EOL .
'You are using PHP %s (%s).' . PHP_EOL,
PHP_VERSION,
PHP_BINARY
)
);
die(1);
}
$requiredExtensions = ['dom', 'json', 'libxml', 'mbstring', 'tokenizer', 'xml', 'xmlwriter'];
$unavailableExtensions = array_filter(
$requiredExtensions,
static function ($extension) {
return !extension_loaded($extension);
}
);
if ([] !== $unavailableExtensions) {
fwrite(
STDERR,
sprintf(
'PHPUnit requires the "%s" extensions, but the "%s" %s not available.' . PHP_EOL,
count($unavailableExtensions) === 1 ? 'extension is' : 'extensions are',
implode('", "', $requiredExtensions),
implode('", "', $unavailableExtensions)
)
);
die(1);
}
unset($requiredExtensions, $unavailableExtensions);
if (!ini_get('date.timezone')) {
ini_set('date.timezone', 'UTC');
}
if (isset($GLOBALS['_composer_autoload_path'])) {
define('PHPUNIT_COMPOSER_INSTALL', $GLOBALS['_composer_autoload_path']);
unset($GLOBALS['_composer_autoload_path']);
} else {
foreach (array(__DIR__ . '/../../autoload.php', __DIR__ . '/../vendor/autoload.php', __DIR__ . '/vendor/autoload.php') as $file) {
if (file_exists($file)) {
define('PHPUNIT_COMPOSER_INSTALL', $file);
break;
}
}
unset($file);
}
if (!defined('PHPUNIT_COMPOSER_INSTALL')) {
fwrite(
STDERR,
'You need to set up the project dependencies using Composer:' . PHP_EOL . PHP_EOL .
' composer install' . PHP_EOL . PHP_EOL .
'You can learn all about Composer on https://getcomposer.org/.' . PHP_EOL
);
die(1);
}
$options = getopt('', array('prepend:'));
if (isset($options['prepend'])) {
require $options['prepend'];
}
unset($options);
require PHPUNIT_COMPOSER_INSTALL;
PHPUnit\TextUI\Command::main();
PK []r8
src/Util/Printer.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const ENT_COMPAT;
use const ENT_SUBSTITUTE;
use const PHP_SAPI;
use function assert;
use function count;
use function dirname;
use function explode;
use function fclose;
use function fopen;
use function fsockopen;
use function fwrite;
use function htmlspecialchars;
use function is_resource;
use function is_string;
use function sprintf;
use function str_replace;
use function strncmp;
use function strpos;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class Printer
{
/**
* @psalm-var closed-resource|resource
*/
private $stream;
/**
* @var bool
*/
private $isPhpStream;
/**
* @param null|resource|string $out
*
* @throws Exception
*/
public function __construct($out = null)
{
if (is_resource($out)) {
$this->stream = $out;
return;
}
if (!is_string($out)) {
return;
}
if (strpos($out, 'socket://') === 0) {
$tmp = explode(':', str_replace('socket://', '', $out));
if (count($tmp) !== 2) {
throw new Exception(
sprintf(
'"%s" does not match "socket://hostname:port" format',
$out
)
);
}
$this->stream = fsockopen($tmp[0], (int) $tmp[1]);
return;
}
if (strpos($out, 'php://') === false && !Filesystem::createDirectory(dirname($out))) {
throw new Exception(
sprintf(
'Directory "%s" was not created',
dirname($out)
)
);
}
$this->stream = fopen($out, 'wb');
$this->isPhpStream = strncmp($out, 'php://', 6) !== 0;
}
public function write(string $buffer): void
{
if ($this->stream) {
assert(is_resource($this->stream));
fwrite($this->stream, $buffer);
} else {
if (PHP_SAPI !== 'cli' && PHP_SAPI !== 'phpdbg') {
$buffer = htmlspecialchars($buffer, ENT_COMPAT | ENT_SUBSTITUTE);
}
print $buffer;
}
}
public function flush(): void
{
if ($this->stream && $this->isPhpStream) {
assert(is_resource($this->stream));
fclose($this->stream);
}
}
}
PK [T src/Util/ErrorHandler.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const E_DEPRECATED;
use const E_NOTICE;
use const E_STRICT;
use const E_USER_DEPRECATED;
use const E_USER_NOTICE;
use const E_USER_WARNING;
use const E_WARNING;
use function error_reporting;
use function restore_error_handler;
use function set_error_handler;
use PHPUnit\Framework\Error\Deprecated;
use PHPUnit\Framework\Error\Error;
use PHPUnit\Framework\Error\Notice;
use PHPUnit\Framework\Error\Warning;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ErrorHandler
{
/**
* @var bool
*/
private $convertDeprecationsToExceptions;
/**
* @var bool
*/
private $convertErrorsToExceptions;
/**
* @var bool
*/
private $convertNoticesToExceptions;
/**
* @var bool
*/
private $convertWarningsToExceptions;
/**
* @var bool
*/
private $registered = false;
public static function invokeIgnoringWarnings(callable $callable)
{
set_error_handler(
static function ($errorNumber, $errorString)
{
if ($errorNumber === E_WARNING) {
return;
}
return false;
}
);
$result = $callable();
restore_error_handler();
return $result;
}
public function __construct(bool $convertDeprecationsToExceptions, bool $convertErrorsToExceptions, bool $convertNoticesToExceptions, bool $convertWarningsToExceptions)
{
$this->convertDeprecationsToExceptions = $convertDeprecationsToExceptions;
$this->convertErrorsToExceptions = $convertErrorsToExceptions;
$this->convertNoticesToExceptions = $convertNoticesToExceptions;
$this->convertWarningsToExceptions = $convertWarningsToExceptions;
}
public function __invoke(int $errorNumber, string $errorString, string $errorFile, int $errorLine): bool
{
/*
* Do not raise an exception when the error suppression operator (@) was used.
*
* @see https://github.com/sebastianbergmann/phpunit/issues/3739
*/
if (!($errorNumber & error_reporting())) {
return false;
}
switch ($errorNumber) {
case E_NOTICE:
case E_USER_NOTICE:
case E_STRICT:
if (!$this->convertNoticesToExceptions) {
return false;
}
throw new Notice($errorString, $errorNumber, $errorFile, $errorLine);
case E_WARNING:
case E_USER_WARNING:
if (!$this->convertWarningsToExceptions) {
return false;
}
throw new Warning($errorString, $errorNumber, $errorFile, $errorLine);
case E_DEPRECATED:
case E_USER_DEPRECATED:
if (!$this->convertDeprecationsToExceptions) {
return false;
}
throw new Deprecated($errorString, $errorNumber, $errorFile, $errorLine);
default:
if (!$this->convertErrorsToExceptions) {
return false;
}
throw new Error($errorString, $errorNumber, $errorFile, $errorLine);
}
}
public function register(): void
{
if ($this->registered) {
return;
}
$oldErrorHandler = set_error_handler($this);
if ($oldErrorHandler !== null) {
restore_error_handler();
return;
}
$this->registered = true;
}
public function unregister(): void
{
if (!$this->registered) {
return;
}
restore_error_handler();
}
}
PK [q src/Util/Type.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Type
{
public static function isType(string $type): bool
{
switch ($type) {
case 'numeric':
case 'integer':
case 'int':
case 'iterable':
case 'float':
case 'string':
case 'boolean':
case 'bool':
case 'null':
case 'array':
case 'object':
case 'resource':
case 'scalar':
return true;
default:
return false;
}
}
}
PK [If f src/Util/Json.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const JSON_PRETTY_PRINT;
use const JSON_UNESCAPED_SLASHES;
use const JSON_UNESCAPED_UNICODE;
use function count;
use function is_array;
use function is_object;
use function json_decode;
use function json_encode;
use function json_last_error;
use function ksort;
use PHPUnit\Framework\Exception;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Json
{
/**
* Prettify json string.
*
* @throws \PHPUnit\Framework\Exception
*/
public static function prettify(string $json): string
{
$decodedJson = json_decode($json, false);
if (json_last_error()) {
throw new Exception(
'Cannot prettify invalid json'
);
}
return json_encode($decodedJson, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
}
/**
* To allow comparison of JSON strings, first process them into a consistent
* format so that they can be compared as strings.
*
* @return array ($error, $canonicalized_json) The $error parameter is used
* to indicate an error decoding the json. This is used to avoid ambiguity
* with JSON strings consisting entirely of 'null' or 'false'.
*/
public static function canonicalize(string $json): array
{
$decodedJson = json_decode($json);
if (json_last_error()) {
return [true, null];
}
self::recursiveSort($decodedJson);
$reencodedJson = json_encode($decodedJson);
return [false, $reencodedJson];
}
/**
* JSON object keys are unordered while PHP array keys are ordered.
*
* Sort all array keys to ensure both the expected and actual values have
* their keys in the same order.
*/
private static function recursiveSort(&$json): void
{
if (!is_array($json)) {
// If the object is not empty, change it to an associative array
// so we can sort the keys (and we will still re-encode it
// correctly, since PHP encodes associative arrays as JSON objects.)
// But EMPTY objects MUST remain empty objects. (Otherwise we will
// re-encode it as a JSON array rather than a JSON object.)
// See #2919.
if (is_object($json) && count((array) $json) > 0) {
$json = (array) $json;
} else {
return;
}
}
ksort($json);
foreach ($json as $key => &$value) {
self::recursiveSort($value);
}
}
}
PK [tqHH src/Util/Color.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const DIRECTORY_SEPARATOR;
use function array_keys;
use function array_map;
use function array_values;
use function count;
use function explode;
use function implode;
use function min;
use function preg_replace;
use function preg_replace_callback;
use function sprintf;
use function strtr;
use function trim;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Color
{
/**
* @var array
*/
private const WHITESPACE_MAP = [
' ' => '·',
"\t" => '⇥',
];
/**
* @var array
*/
private const WHITESPACE_EOL_MAP = [
' ' => '·',
"\t" => '⇥',
"\n" => '↵',
"\r" => '⟵',
];
/**
* @var array
*/
private static $ansiCodes = [
'reset' => '0',
'bold' => '1',
'dim' => '2',
'dim-reset' => '22',
'underlined' => '4',
'fg-default' => '39',
'fg-black' => '30',
'fg-red' => '31',
'fg-green' => '32',
'fg-yellow' => '33',
'fg-blue' => '34',
'fg-magenta' => '35',
'fg-cyan' => '36',
'fg-white' => '37',
'bg-default' => '49',
'bg-black' => '40',
'bg-red' => '41',
'bg-green' => '42',
'bg-yellow' => '43',
'bg-blue' => '44',
'bg-magenta' => '45',
'bg-cyan' => '46',
'bg-white' => '47',
];
public static function colorize(string $color, string $buffer): string
{
if (trim($buffer) === '') {
return $buffer;
}
$codes = array_map('\trim', explode(',', $color));
$styles = [];
foreach ($codes as $code) {
if (isset(self::$ansiCodes[$code])) {
$styles[] = self::$ansiCodes[$code] ?? '';
}
}
if (empty($styles)) {
return $buffer;
}
return self::optimizeColor(sprintf("\x1b[%sm", implode(';', $styles)) . $buffer . "\x1b[0m");
}
public static function colorizePath(string $path, ?string $prevPath = null, bool $colorizeFilename = false): string
{
if ($prevPath === null) {
$prevPath = '';
}
$path = explode(DIRECTORY_SEPARATOR, $path);
$prevPath = explode(DIRECTORY_SEPARATOR, $prevPath);
for ($i = 0; $i < min(count($path), count($prevPath)); $i++) {
if ($path[$i] == $prevPath[$i]) {
$path[$i] = self::dim($path[$i]);
}
}
if ($colorizeFilename) {
$last = count($path) - 1;
$path[$last] = preg_replace_callback(
'/([\-_\.]+|phpt$)/',
static function ($matches)
{
return self::dim($matches[0]);
},
$path[$last]
);
}
return self::optimizeColor(implode(self::dim(DIRECTORY_SEPARATOR), $path));
}
public static function dim(string $buffer): string
{
if (trim($buffer) === '') {
return $buffer;
}
return "\e[2m{$buffer}\e[22m";
}
public static function visualizeWhitespace(string $buffer, bool $visualizeEOL = false): string
{
$replaceMap = $visualizeEOL ? self::WHITESPACE_EOL_MAP : self::WHITESPACE_MAP;
return preg_replace_callback('/\s+/', static function ($matches) use ($replaceMap)
{
return self::dim(strtr($matches[0], $replaceMap));
}, $buffer);
}
private static function optimizeColor(string $buffer): string
{
$patterns = [
"/\e\\[22m\e\\[2m/" => '',
"/\e\\[([^m]*)m\e\\[([1-9][0-9;]*)m/" => "\e[$1;$2m",
"/(\e\\[[^m]*m)+(\e\\[0m)/" => '$2',
];
return preg_replace(array_keys($patterns), array_values($patterns), $buffer);
}
}
PK [̹}-_
_
src/Util/Filter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use function array_unshift;
use function defined;
use function in_array;
use function is_file;
use function realpath;
use function sprintf;
use function strpos;
use PHPUnit\Framework\Exception;
use PHPUnit\Framework\SyntheticError;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Filter
{
/**
* @throws Exception
*/
public static function getFilteredStacktrace(Throwable $t): string
{
$filteredStacktrace = '';
if ($t instanceof SyntheticError) {
$eTrace = $t->getSyntheticTrace();
$eFile = $t->getSyntheticFile();
$eLine = $t->getSyntheticLine();
} elseif ($t instanceof Exception) {
$eTrace = $t->getSerializableTrace();
$eFile = $t->getFile();
$eLine = $t->getLine();
} else {
if ($t->getPrevious()) {
$t = $t->getPrevious();
}
$eTrace = $t->getTrace();
$eFile = $t->getFile();
$eLine = $t->getLine();
}
if (!self::frameExists($eTrace, $eFile, $eLine)) {
array_unshift(
$eTrace,
['file' => $eFile, 'line' => $eLine]
);
}
$prefix = defined('__PHPUNIT_PHAR_ROOT__') ? __PHPUNIT_PHAR_ROOT__ : false;
$excludeList = new ExcludeList;
foreach ($eTrace as $frame) {
if (self::shouldPrintFrame($frame, $prefix, $excludeList)) {
$filteredStacktrace .= sprintf(
"%s:%s\n",
$frame['file'],
$frame['line'] ?? '?'
);
}
}
return $filteredStacktrace;
}
private static function shouldPrintFrame(array $frame, $prefix, ExcludeList $excludeList): bool
{
if (!isset($frame['file'])) {
return false;
}
$file = $frame['file'];
$fileIsNotPrefixed = $prefix === false || strpos($file, $prefix) !== 0;
// @see https://github.com/sebastianbergmann/phpunit/issues/4033
if (isset($GLOBALS['_SERVER']['SCRIPT_NAME'])) {
$script = realpath($GLOBALS['_SERVER']['SCRIPT_NAME']);
} else {
$script = '';
}
return is_file($file) &&
self::fileIsExcluded($file, $excludeList) &&
$fileIsNotPrefixed &&
$file !== $script;
}
private static function fileIsExcluded(string $file, ExcludeList $excludeList): bool
{
return (empty($GLOBALS['__PHPUNIT_ISOLATION_EXCLUDE_LIST']) ||
!in_array($file, $GLOBALS['__PHPUNIT_ISOLATION_EXCLUDE_LIST'], true)) &&
!$excludeList->isExcluded($file);
}
private static function frameExists(array $trace, string $file, int $line): bool
{
foreach ($trace as $frame) {
if (isset($frame['file'], $frame['line']) && $frame['file'] === $file && $frame['line'] === $line) {
return true;
}
}
return false;
}
}
PK [i & src/Util/VersionComparisonOperator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use function in_array;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class VersionComparisonOperator
{
/**
* @psalm-var '<'|'lt'|'<='|'le'|'>'|'gt'|'>='|'ge'|'=='|'='|'eq'|'!='|'<>'|'ne'
*/
private $operator;
public function __construct(string $operator)
{
$this->ensureOperatorIsValid($operator);
$this->operator = $operator;
}
/**
* @return '!='|'<'|'<='|'<>'|'='|'=='|'>'|'>='|'eq'|'ge'|'gt'|'le'|'lt'|'ne'
*/
public function asString(): string
{
return $this->operator;
}
/**
* @throws Exception
*
* @psalm-assert '<'|'lt'|'<='|'le'|'>'|'gt'|'>='|'ge'|'=='|'='|'eq'|'!='|'<>'|'ne' $operator
*/
private function ensureOperatorIsValid(string $operator): void
{
if (!in_array($operator, ['<', 'lt', '<=', 'le', '>', 'gt', '>=', 'ge', '==', '=', 'eq', '!=', '<>', 'ne'], true)) {
throw new Exception(
sprintf(
'"%s" is not a valid version_compare() operator',
$operator
)
);
}
}
}
PK [/k- - src/Util/Filesystem.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const DIRECTORY_SEPARATOR;
use function is_dir;
use function mkdir;
use function str_replace;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Filesystem
{
/**
* Maps class names to source file names.
*
* - PEAR CS: Foo_Bar_Baz -> Foo/Bar/Baz.php
* - Namespace: Foo\Bar\Baz -> Foo/Bar/Baz.php
*/
public static function classNameToFilename(string $className): string
{
return str_replace(
['_', '\\'],
DIRECTORY_SEPARATOR,
$className
) . '.php';
}
public static function createDirectory(string $directory): bool
{
return !(!is_dir($directory) && !@mkdir($directory, 0777, true) && !is_dir($directory));
}
}
PK [ (" " src/Util/GlobalState.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const PHP_MAJOR_VERSION;
use const PHP_MINOR_VERSION;
use function array_keys;
use function array_reverse;
use function array_shift;
use function defined;
use function get_defined_constants;
use function get_included_files;
use function in_array;
use function ini_get_all;
use function is_array;
use function is_file;
use function is_scalar;
use function preg_match;
use function serialize;
use function sprintf;
use function strpos;
use function strtr;
use function substr;
use function var_export;
use Closure;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class GlobalState
{
/**
* @var string[]
*/
private const SUPER_GLOBAL_ARRAYS = [
'_ENV',
'_POST',
'_GET',
'_COOKIE',
'_SERVER',
'_FILES',
'_REQUEST',
];
/**
* @psalm-var array>
*/
private const DEPRECATED_INI_SETTINGS = [
'7.3' => [
'iconv.input_encoding' => true,
'iconv.output_encoding' => true,
'iconv.internal_encoding' => true,
'mbstring.func_overload' => true,
'mbstring.http_input' => true,
'mbstring.http_output' => true,
'mbstring.internal_encoding' => true,
'string.strip_tags' => true,
],
'7.4' => [
'iconv.input_encoding' => true,
'iconv.output_encoding' => true,
'iconv.internal_encoding' => true,
'mbstring.func_overload' => true,
'mbstring.http_input' => true,
'mbstring.http_output' => true,
'mbstring.internal_encoding' => true,
'pdo_odbc.db2_instance_name' => true,
'string.strip_tags' => true,
],
'8.0' => [
'iconv.input_encoding' => true,
'iconv.output_encoding' => true,
'iconv.internal_encoding' => true,
'mbstring.http_input' => true,
'mbstring.http_output' => true,
'mbstring.internal_encoding' => true,
],
'8.1' => [
'auto_detect_line_endings' => true,
'filter.default' => true,
'iconv.input_encoding' => true,
'iconv.output_encoding' => true,
'iconv.internal_encoding' => true,
'mbstring.http_input' => true,
'mbstring.http_output' => true,
'mbstring.internal_encoding' => true,
'oci8.old_oci_close_semantics' => true,
],
'8.2' => [
'auto_detect_line_endings' => true,
'filter.default' => true,
'iconv.input_encoding' => true,
'iconv.output_encoding' => true,
'iconv.internal_encoding' => true,
'mbstring.http_input' => true,
'mbstring.http_output' => true,
'mbstring.internal_encoding' => true,
'oci8.old_oci_close_semantics' => true,
],
'8.3' => [
'auto_detect_line_endings' => true,
'filter.default' => true,
'iconv.input_encoding' => true,
'iconv.output_encoding' => true,
'iconv.internal_encoding' => true,
'mbstring.http_input' => true,
'mbstring.http_output' => true,
'mbstring.internal_encoding' => true,
'oci8.old_oci_close_semantics' => true,
],
];
/**
* @throws Exception
*/
public static function getIncludedFilesAsString(): string
{
return self::processIncludedFilesAsString(get_included_files());
}
/**
* @param string[] $files
*
* @throws Exception
*/
public static function processIncludedFilesAsString(array $files): string
{
$excludeList = new ExcludeList;
$prefix = false;
$result = '';
if (defined('__PHPUNIT_PHAR__')) {
$prefix = 'phar://' . __PHPUNIT_PHAR__ . '/';
}
// Do not process bootstrap script
array_shift($files);
// If bootstrap script was a Composer bin proxy, skip the second entry as well
if (substr(strtr($files[0], '\\', '/'), -24) === '/phpunit/phpunit/phpunit') {
array_shift($files);
}
foreach (array_reverse($files) as $file) {
if (!empty($GLOBALS['__PHPUNIT_ISOLATION_EXCLUDE_LIST']) &&
in_array($file, $GLOBALS['__PHPUNIT_ISOLATION_EXCLUDE_LIST'], true)) {
continue;
}
if ($prefix !== false && strpos($file, $prefix) === 0) {
continue;
}
// Skip virtual file system protocols
if (preg_match('/^(vfs|phpvfs[a-z0-9]+):/', $file)) {
continue;
}
if (!$excludeList->isExcluded($file) && is_file($file)) {
$result = 'require_once \'' . $file . "';\n" . $result;
}
}
return $result;
}
public static function getIniSettingsAsString(): string
{
$result = '';
foreach (ini_get_all(null, false) as $key => $value) {
if (self::isIniSettingDeprecated($key)) {
continue;
}
$result .= sprintf(
'@ini_set(%s, %s);' . "\n",
self::exportVariable($key),
self::exportVariable((string) $value)
);
}
return $result;
}
public static function getConstantsAsString(): string
{
$constants = get_defined_constants(true);
$result = '';
if (isset($constants['user'])) {
foreach ($constants['user'] as $name => $value) {
$result .= sprintf(
'if (!defined(\'%s\')) define(\'%s\', %s);' . "\n",
$name,
$name,
self::exportVariable($value)
);
}
}
return $result;
}
public static function getGlobalsAsString(): string
{
$result = '';
foreach (self::SUPER_GLOBAL_ARRAYS as $superGlobalArray) {
if (isset($GLOBALS[$superGlobalArray]) && is_array($GLOBALS[$superGlobalArray])) {
foreach (array_keys($GLOBALS[$superGlobalArray]) as $key) {
if ($GLOBALS[$superGlobalArray][$key] instanceof Closure) {
continue;
}
$result .= sprintf(
'$GLOBALS[\'%s\'][\'%s\'] = %s;' . "\n",
$superGlobalArray,
$key,
self::exportVariable($GLOBALS[$superGlobalArray][$key])
);
}
}
}
$excludeList = self::SUPER_GLOBAL_ARRAYS;
$excludeList[] = 'GLOBALS';
foreach (array_keys($GLOBALS) as $key) {
if (!$GLOBALS[$key] instanceof Closure && !in_array($key, $excludeList, true)) {
$result .= sprintf(
'$GLOBALS[\'%s\'] = %s;' . "\n",
$key,
self::exportVariable($GLOBALS[$key])
);
}
}
return $result;
}
private static function exportVariable($variable): string
{
if (is_scalar($variable) || $variable === null ||
(is_array($variable) && self::arrayOnlyContainsScalars($variable))) {
return var_export($variable, true);
}
return 'unserialize(' . var_export(serialize($variable), true) . ')';
}
private static function arrayOnlyContainsScalars(array $array): bool
{
$result = true;
foreach ($array as $element) {
if (is_array($element)) {
$result = self::arrayOnlyContainsScalars($element);
} elseif (!is_scalar($element) && $element !== null) {
$result = false;
}
if (!$result) {
break;
}
}
return $result;
}
private static function isIniSettingDeprecated(string $iniSetting): bool
{
return isset(self::DEPRECATED_INI_SETTINGS[PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION][$iniSetting]);
}
}
PK [Cԓ src/Util/Xml.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const ENT_QUOTES;
use function assert;
use function class_exists;
use function htmlspecialchars;
use function mb_convert_encoding;
use function ord;
use function preg_replace;
use function settype;
use function strlen;
use DOMCharacterData;
use DOMDocument;
use DOMElement;
use DOMNode;
use DOMText;
use ReflectionClass;
use ReflectionException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Xml
{
/**
* @deprecated Only used by assertEqualXMLStructure()
*/
public static function import(DOMElement $element): DOMElement
{
return (new DOMDocument)->importNode($element, true);
}
/**
* @deprecated Only used by assertEqualXMLStructure()
*/
public static function removeCharacterDataNodes(DOMNode $node): void
{
if ($node->hasChildNodes()) {
for ($i = $node->childNodes->length - 1; $i >= 0; $i--) {
if (($child = $node->childNodes->item($i)) instanceof DOMCharacterData) {
$node->removeChild($child);
}
}
}
}
/**
* Escapes a string for the use in XML documents.
*
* Any Unicode character is allowed, excluding the surrogate blocks, FFFE,
* and FFFF (not even as character reference).
*
* @see https://www.w3.org/TR/xml/#charsets
*/
public static function prepareString(string $string): string
{
return preg_replace(
'/[\\x00-\\x08\\x0b\\x0c\\x0e-\\x1f\\x7f]/',
'',
htmlspecialchars(
self::convertToUtf8($string),
ENT_QUOTES
)
);
}
/**
* "Convert" a DOMElement object into a PHP variable.
*/
public static function xmlToVariable(DOMElement $element)
{
$variable = null;
switch ($element->tagName) {
case 'array':
$variable = [];
foreach ($element->childNodes as $entry) {
if (!$entry instanceof DOMElement || $entry->tagName !== 'element') {
continue;
}
$item = $entry->childNodes->item(0);
if ($item instanceof DOMText) {
$item = $entry->childNodes->item(1);
}
$value = self::xmlToVariable($item);
if ($entry->hasAttribute('key')) {
$variable[(string) $entry->getAttribute('key')] = $value;
} else {
$variable[] = $value;
}
}
break;
case 'object':
$className = $element->getAttribute('class');
if ($element->hasChildNodes()) {
$arguments = $element->childNodes->item(0)->childNodes;
$constructorArgs = [];
foreach ($arguments as $argument) {
if ($argument instanceof DOMElement) {
$constructorArgs[] = self::xmlToVariable($argument);
}
}
try {
assert(class_exists($className));
$variable = (new ReflectionClass($className))->newInstanceArgs($constructorArgs);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
} else {
$variable = new $className;
}
break;
case 'boolean':
$variable = $element->textContent === 'true';
break;
case 'integer':
case 'double':
case 'string':
$variable = $element->textContent;
settype($variable, $element->tagName);
break;
}
return $variable;
}
private static function convertToUtf8(string $string): string
{
if (!self::isUtf8($string)) {
$string = mb_convert_encoding($string, 'UTF-8');
}
return $string;
}
private static function isUtf8(string $string): bool
{
$length = strlen($string);
for ($i = 0; $i < $length; $i++) {
if (ord($string[$i]) < 0x80) {
$n = 0;
} elseif ((ord($string[$i]) & 0xE0) === 0xC0) {
$n = 1;
} elseif ((ord($string[$i]) & 0xF0) === 0xE0) {
$n = 2;
} elseif ((ord($string[$i]) & 0xF0) === 0xF0) {
$n = 3;
} else {
return false;
}
for ($j = 0; $j < $n; $j++) {
if ((++$i === $length) || ((ord($string[$i]) & 0xC0) !== 0x80)) {
return false;
}
}
}
return true;
}
}
PK [ , src/Util/Xml/FailedSchemaDetectionResult.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class FailedSchemaDetectionResult extends SchemaDetectionResult
{
}
PK [ui 0 src/Util/Xml/SuccessfulSchemaDetectionResult.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class SuccessfulSchemaDetectionResult extends SchemaDetectionResult
{
/**
* @var string
*/
private $version;
public function __construct(string $version)
{
$this->version = $version;
}
public function detected(): bool
{
return true;
}
public function version(): string
{
return $this->version;
}
}
PK [G src/Util/Xml/SchemaFinder.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
use function defined;
use function is_file;
use function sprintf;
use PHPUnit\Runner\Version;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class SchemaFinder
{
/**
* @throws Exception
*/
public function find(string $version): string
{
if ($version === Version::series()) {
$filename = $this->path() . 'phpunit.xsd';
} else {
$filename = $this->path() . 'schema/' . $version . '.xsd';
}
if (!is_file($filename)) {
throw new Exception(
sprintf(
'Schema for PHPUnit %s is not available',
$version
)
);
}
return $filename;
}
private function path(): string
{
if (defined('__PHPUNIT_PHAR_ROOT__')) {
return __PHPUNIT_PHAR_ROOT__ . '/';
}
return __DIR__ . '/../../../';
}
}
PK [WY src/Util/Xml/Validator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
use function file_get_contents;
use function libxml_clear_errors;
use function libxml_get_errors;
use function libxml_use_internal_errors;
use DOMDocument;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Validator
{
public function validate(DOMDocument $document, string $xsdFilename): ValidationResult
{
$originalErrorHandling = libxml_use_internal_errors(true);
$document->schemaValidateSource(file_get_contents($xsdFilename));
$errors = libxml_get_errors();
libxml_clear_errors();
libxml_use_internal_errors($originalErrorHandling);
return ValidationResult::fromArray($errors);
}
}
PK [ͼQ src/Util/Xml/SchemaDetector.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class SchemaDetector
{
/**
* @throws Exception
*/
public function detect(string $filename): SchemaDetectionResult
{
$document = (new Loader)->loadFile(
$filename,
false,
true,
true
);
foreach (['9.2', '8.5'] as $candidate) {
$schema = (new SchemaFinder)->find($candidate);
if (!(new Validator)->validate($document, $schema)->hasValidationErrors()) {
return new SuccessfulSchemaDetectionResult($candidate);
}
}
return new FailedSchemaDetectionResult;
}
}
PK [ϸ8 ! src/Util/Xml/ValidationResult.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
use function sprintf;
use function trim;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class ValidationResult
{
/**
* @psalm-var array>
*/
private $validationErrors = [];
/**
* @psalm-param array $errors
*/
public static function fromArray(array $errors): self
{
$validationErrors = [];
foreach ($errors as $error) {
if (!isset($validationErrors[$error->line])) {
$validationErrors[$error->line] = [];
}
$validationErrors[$error->line][] = trim($error->message);
}
return new self($validationErrors);
}
private function __construct(array $validationErrors)
{
$this->validationErrors = $validationErrors;
}
public function hasValidationErrors(): bool
{
return !empty($this->validationErrors);
}
public function asString(): string
{
$buffer = '';
foreach ($this->validationErrors as $line => $validationErrorsOnLine) {
$buffer .= sprintf(PHP_EOL . ' Line %d:' . PHP_EOL, $line);
foreach ($validationErrorsOnLine as $validationError) {
$buffer .= sprintf(' - %s' . PHP_EOL, $validationError);
}
}
return $buffer;
}
}
PK [ Ob4 4 src/Util/Xml/Loader.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
use function chdir;
use function dirname;
use function error_reporting;
use function file_get_contents;
use function getcwd;
use function libxml_get_errors;
use function libxml_use_internal_errors;
use function sprintf;
use DOMDocument;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Loader
{
/**
* @throws Exception
*/
public function loadFile(string $filename, bool $isHtml = false, bool $xinclude = false, bool $strict = false): DOMDocument
{
$reporting = error_reporting(0);
$contents = file_get_contents($filename);
error_reporting($reporting);
if ($contents === false) {
throw new Exception(
sprintf(
'Could not read "%s".',
$filename
)
);
}
return $this->load($contents, $isHtml, $filename, $xinclude, $strict);
}
/**
* @throws Exception
*/
public function load(string $actual, bool $isHtml = false, string $filename = '', bool $xinclude = false, bool $strict = false): DOMDocument
{
if ($actual === '') {
throw new Exception('Could not load XML from empty string');
}
// Required for XInclude on Windows.
if ($xinclude) {
$cwd = getcwd();
@chdir(dirname($filename));
}
$document = new DOMDocument;
$document->preserveWhiteSpace = false;
$internal = libxml_use_internal_errors(true);
$message = '';
$reporting = error_reporting(0);
if ($filename !== '') {
// Required for XInclude
$document->documentURI = $filename;
}
if ($isHtml) {
$loaded = $document->loadHTML($actual);
} else {
$loaded = $document->loadXML($actual);
}
if (!$isHtml && $xinclude) {
$document->xinclude();
}
foreach (libxml_get_errors() as $error) {
$message .= "\n" . $error->message;
}
libxml_use_internal_errors($internal);
error_reporting($reporting);
if (isset($cwd)) {
@chdir($cwd);
}
if ($loaded === false || ($strict && $message !== '')) {
if ($filename !== '') {
throw new Exception(
sprintf(
'Could not load "%s".%s',
$filename,
$message !== '' ? "\n" . $message : ''
)
);
}
if ($message === '') {
$message = 'Could not load XML for unknown reason';
}
throw new Exception($message);
}
return $document;
}
}
PK [2)cΟ & src/Util/Xml/SchemaDetectionResult.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
abstract class SchemaDetectionResult
{
public function detected(): bool
{
return false;
}
/**
* @throws Exception
*/
public function version(): string
{
throw new Exception('No supported schema was detected');
}
}
PK [. src/Util/Xml/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
use RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Exception extends RuntimeException implements \PHPUnit\Exception
{
}
PK [{G G ! src/Util/Xml/SnapshotNodeList.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Xml;
use function count;
use ArrayIterator;
use Countable;
use DOMNode;
use DOMNodeList;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements IteratorAggregate
*/
final class SnapshotNodeList implements Countable, IteratorAggregate
{
/**
* @var DOMNode[]
*/
private $nodes = [];
public static function fromNodeList(DOMNodeList $list): self
{
$snapshot = new self;
foreach ($list as $node) {
$snapshot->nodes[] = $node;
}
return $snapshot;
}
public function count(): int
{
return count($this->nodes);
}
public function getIterator(): ArrayIterator
{
return new ArrayIterator($this->nodes);
}
}
PK [ src/Util/Blacklist.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
/**
* @deprecated Use ExcludeList instead
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class Blacklist
{
public static function addDirectory(string $directory): void
{
ExcludeList::addDirectory($directory);
}
/**
* @throws Exception
*
* @return string[]
*/
public function getBlacklistedDirectories(): array
{
return (new ExcludeList)->getExcludedDirectories();
}
/**
* @throws Exception
*/
public function isBlacklisted(string $file): bool
{
return (new ExcludeList)->isExcluded($file);
}
}
PK [' src/Util/ExcludeList.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const DIRECTORY_SEPARATOR;
use function class_exists;
use function defined;
use function dirname;
use function is_dir;
use function realpath;
use function sprintf;
use function strpos;
use function sys_get_temp_dir;
use Composer\Autoload\ClassLoader;
use DeepCopy\DeepCopy;
use Doctrine\Instantiator\Instantiator;
use PharIo\Manifest\Manifest;
use PharIo\Version\Version as PharIoVersion;
use PhpParser\Parser;
use PHPUnit\Framework\TestCase;
use ReflectionClass;
use SebastianBergmann\CliParser\Parser as CliParser;
use SebastianBergmann\CodeCoverage\CodeCoverage;
use SebastianBergmann\CodeUnit\CodeUnit;
use SebastianBergmann\CodeUnitReverseLookup\Wizard;
use SebastianBergmann\Comparator\Comparator;
use SebastianBergmann\Complexity\Calculator;
use SebastianBergmann\Diff\Diff;
use SebastianBergmann\Environment\Runtime;
use SebastianBergmann\Exporter\Exporter;
use SebastianBergmann\FileIterator\Facade as FileIteratorFacade;
use SebastianBergmann\GlobalState\Snapshot;
use SebastianBergmann\Invoker\Invoker;
use SebastianBergmann\LinesOfCode\Counter;
use SebastianBergmann\ObjectEnumerator\Enumerator;
use SebastianBergmann\RecursionContext\Context;
use SebastianBergmann\ResourceOperations\ResourceOperations;
use SebastianBergmann\Template\Template;
use SebastianBergmann\Timer\Timer;
use SebastianBergmann\Type\TypeName;
use SebastianBergmann\Version;
use TheSeer\Tokenizer\Tokenizer;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class ExcludeList
{
/**
* @var array
*/
private const EXCLUDED_CLASS_NAMES = [
// composer
ClassLoader::class => 1,
// doctrine/instantiator
Instantiator::class => 1,
// myclabs/deepcopy
DeepCopy::class => 1,
// nikic/php-parser
Parser::class => 1,
// phar-io/manifest
Manifest::class => 1,
// phar-io/version
PharIoVersion::class => 1,
// phpdocumentor/type-resolver
Type::class => 1,
// phpunit/phpunit
TestCase::class => 2,
// phpunit/php-code-coverage
CodeCoverage::class => 1,
// phpunit/php-file-iterator
FileIteratorFacade::class => 1,
// phpunit/php-invoker
Invoker::class => 1,
// phpunit/php-text-template
Template::class => 1,
// phpunit/php-timer
Timer::class => 1,
// sebastian/cli-parser
CliParser::class => 1,
// sebastian/code-unit
CodeUnit::class => 1,
// sebastian/code-unit-reverse-lookup
Wizard::class => 1,
// sebastian/comparator
Comparator::class => 1,
// sebastian/complexity
Calculator::class => 1,
// sebastian/diff
Diff::class => 1,
// sebastian/environment
Runtime::class => 1,
// sebastian/exporter
Exporter::class => 1,
// sebastian/global-state
Snapshot::class => 1,
// sebastian/lines-of-code
Counter::class => 1,
// sebastian/object-enumerator
Enumerator::class => 1,
// sebastian/recursion-context
Context::class => 1,
// sebastian/resource-operations
ResourceOperations::class => 1,
// sebastian/type
TypeName::class => 1,
// sebastian/version
Version::class => 1,
// theseer/tokenizer
Tokenizer::class => 1,
];
/**
* @var string[]
*/
private static $directories = [];
/**
* @var bool
*/
private static $initialized = false;
public static function addDirectory(string $directory): void
{
if (!is_dir($directory)) {
throw new Exception(
sprintf(
'"%s" is not a directory',
$directory
)
);
}
self::$directories[] = realpath($directory);
}
/**
* @throws Exception
*
* @return string[]
*/
public function getExcludedDirectories(): array
{
$this->initialize();
return self::$directories;
}
/**
* @throws Exception
*/
public function isExcluded(string $file): bool
{
if (defined('PHPUNIT_TESTSUITE')) {
return false;
}
$this->initialize();
foreach (self::$directories as $directory) {
if (strpos($file, $directory) === 0) {
return true;
}
}
return false;
}
/**
* @throws Exception
*/
private function initialize(): void
{
if (self::$initialized) {
return;
}
foreach (self::EXCLUDED_CLASS_NAMES as $className => $parent) {
if (!class_exists($className)) {
continue;
}
$directory = (new ReflectionClass($className))->getFileName();
for ($i = 0; $i < $parent; $i++) {
$directory = dirname($directory);
}
self::$directories[] = $directory;
}
// Hide process isolation workaround on Windows.
if (DIRECTORY_SEPARATOR === '\\') {
// tempnam() prefix is limited to first 3 chars.
// @see https://php.net/manual/en/function.tempnam.php
self::$directories[] = sys_get_temp_dir() . '\\PHP';
}
self::$initialized = true;
}
}
PK [/O " src/Util/PHP/DefaultPhpProcess.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\PHP;
use function array_merge;
use function fclose;
use function file_put_contents;
use function fread;
use function fwrite;
use function is_array;
use function is_resource;
use function proc_close;
use function proc_open;
use function proc_terminate;
use function rewind;
use function sprintf;
use function stream_get_contents;
use function stream_select;
use function sys_get_temp_dir;
use function tempnam;
use function unlink;
use PHPUnit\Framework\Exception;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class DefaultPhpProcess extends AbstractPhpProcess
{
/**
* @var string
*/
protected $tempFile;
/**
* Runs a single job (PHP code) using a separate PHP process.
*
* @throws Exception
*/
public function runJob(string $job, array $settings = []): array
{
if ($this->stdin || $this->useTemporaryFile()) {
if (!($this->tempFile = tempnam(sys_get_temp_dir(), 'PHPUnit')) ||
file_put_contents($this->tempFile, $job) === false) {
throw new Exception(
'Unable to write temporary file'
);
}
$job = $this->stdin;
}
return $this->runProcess($job, $settings);
}
/**
* Returns an array of file handles to be used in place of pipes.
*/
protected function getHandles(): array
{
return [];
}
/**
* Handles creating the child process and returning the STDOUT and STDERR.
*
* @throws Exception
*/
protected function runProcess(string $job, array $settings): array
{
$handles = $this->getHandles();
$env = null;
if ($this->env) {
$env = $_SERVER ?? [];
unset($env['argv'], $env['argc']);
$env = array_merge($env, $this->env);
foreach ($env as $envKey => $envVar) {
if (is_array($envVar)) {
unset($env[$envKey]);
}
}
}
$pipeSpec = [
0 => $handles[0] ?? ['pipe', 'r'],
1 => $handles[1] ?? ['pipe', 'w'],
2 => $handles[2] ?? ['pipe', 'w'],
];
$process = proc_open(
$this->getCommand($settings, $this->tempFile),
$pipeSpec,
$pipes,
null,
$env
);
if (!is_resource($process)) {
throw new Exception(
'Unable to spawn worker process'
);
}
if ($job) {
$this->process($pipes[0], $job);
}
fclose($pipes[0]);
$stderr = $stdout = '';
if ($this->timeout) {
unset($pipes[0]);
while (true) {
$r = $pipes;
$w = null;
$e = null;
$n = @stream_select($r, $w, $e, $this->timeout);
if ($n === false) {
break;
}
if ($n === 0) {
proc_terminate($process, 9);
throw new Exception(
sprintf(
'Job execution aborted after %d seconds',
$this->timeout
)
);
}
if ($n > 0) {
foreach ($r as $pipe) {
$pipeOffset = 0;
foreach ($pipes as $i => $origPipe) {
if ($pipe === $origPipe) {
$pipeOffset = $i;
break;
}
}
if (!$pipeOffset) {
break;
}
$line = fread($pipe, 8192);
if ($line === '' || $line === false) {
fclose($pipes[$pipeOffset]);
unset($pipes[$pipeOffset]);
} elseif ($pipeOffset === 1) {
$stdout .= $line;
} else {
$stderr .= $line;
}
}
if (empty($pipes)) {
break;
}
}
}
} else {
if (isset($pipes[1])) {
$stdout = stream_get_contents($pipes[1]);
fclose($pipes[1]);
}
if (isset($pipes[2])) {
$stderr = stream_get_contents($pipes[2]);
fclose($pipes[2]);
}
}
if (isset($handles[1])) {
rewind($handles[1]);
$stdout = stream_get_contents($handles[1]);
fclose($handles[1]);
}
if (isset($handles[2])) {
rewind($handles[2]);
$stderr = stream_get_contents($handles[2]);
fclose($handles[2]);
}
proc_close($process);
$this->cleanup();
return ['stdout' => $stdout, 'stderr' => $stderr];
}
/**
* @param resource $pipe
*/
protected function process($pipe, string $job): void
{
fwrite($pipe, $job);
}
protected function cleanup(): void
{
if ($this->tempFile) {
unlink($this->tempFile);
}
}
protected function useTemporaryFile(): bool
{
return false;
}
}
PK [cϑ " src/Util/PHP/WindowsPhpProcess.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\PHP;
use const PHP_MAJOR_VERSION;
use function tmpfile;
use PHPUnit\Framework\Exception;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @see https://bugs.php.net/bug.php?id=51800
*/
final class WindowsPhpProcess extends DefaultPhpProcess
{
public function getCommand(array $settings, string $file = null): string
{
if (PHP_MAJOR_VERSION < 8) {
return '"' . parent::getCommand($settings, $file) . '"';
}
return parent::getCommand($settings, $file);
}
/**
* @throws Exception
*/
protected function getHandles(): array
{
if (false === $stdout_handle = tmpfile()) {
throw new Exception(
'A temporary file could not be created; verify that your TEMP environment variable is writable'
);
}
return [
1 => $stdout_handle,
];
}
protected function useTemporaryFile(): bool
{
return true;
}
}
PK [w+ + # src/Util/PHP/AbstractPhpProcess.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\PHP;
use const DIRECTORY_SEPARATOR;
use const PHP_SAPI;
use function array_keys;
use function array_merge;
use function assert;
use function escapeshellarg;
use function ini_get_all;
use function restore_error_handler;
use function set_error_handler;
use function sprintf;
use function str_replace;
use function strpos;
use function strrpos;
use function substr;
use function trim;
use function unserialize;
use __PHP_Incomplete_Class;
use ErrorException;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\Exception;
use PHPUnit\Framework\SyntheticError;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestFailure;
use PHPUnit\Framework\TestResult;
use SebastianBergmann\Environment\Runtime;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
abstract class AbstractPhpProcess
{
/**
* @var Runtime
*/
protected $runtime;
/**
* @var bool
*/
protected $stderrRedirection = false;
/**
* @var string
*/
protected $stdin = '';
/**
* @var string
*/
protected $args = '';
/**
* @var array
*/
protected $env = [];
/**
* @var int
*/
protected $timeout = 0;
public static function factory(): self
{
if (DIRECTORY_SEPARATOR === '\\') {
return new WindowsPhpProcess;
}
return new DefaultPhpProcess;
}
public function __construct()
{
$this->runtime = new Runtime;
}
/**
* Defines if should use STDERR redirection or not.
*
* Then $stderrRedirection is TRUE, STDERR is redirected to STDOUT.
*/
public function setUseStderrRedirection(bool $stderrRedirection): void
{
$this->stderrRedirection = $stderrRedirection;
}
/**
* Returns TRUE if uses STDERR redirection or FALSE if not.
*/
public function useStderrRedirection(): bool
{
return $this->stderrRedirection;
}
/**
* Sets the input string to be sent via STDIN.
*/
public function setStdin(string $stdin): void
{
$this->stdin = $stdin;
}
/**
* Returns the input string to be sent via STDIN.
*/
public function getStdin(): string
{
return $this->stdin;
}
/**
* Sets the string of arguments to pass to the php job.
*/
public function setArgs(string $args): void
{
$this->args = $args;
}
/**
* Returns the string of arguments to pass to the php job.
*/
public function getArgs(): string
{
return $this->args;
}
/**
* Sets the array of environment variables to start the child process with.
*
* @param array $env
*/
public function setEnv(array $env): void
{
$this->env = $env;
}
/**
* Returns the array of environment variables to start the child process with.
*/
public function getEnv(): array
{
return $this->env;
}
/**
* Sets the amount of seconds to wait before timing out.
*/
public function setTimeout(int $timeout): void
{
$this->timeout = $timeout;
}
/**
* Returns the amount of seconds to wait before timing out.
*/
public function getTimeout(): int
{
return $this->timeout;
}
/**
* Runs a single test in a separate PHP process.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function runTestJob(string $job, Test $test, TestResult $result): void
{
$result->startTest($test);
$_result = $this->runJob($job);
$this->processChildResult(
$test,
$result,
$_result['stdout'],
$_result['stderr']
);
}
/**
* Returns the command based into the configurations.
*/
public function getCommand(array $settings, string $file = null): string
{
$command = $this->runtime->getBinary();
if ($this->runtime->hasPCOV()) {
$settings = array_merge(
$settings,
$this->runtime->getCurrentSettings(
array_keys(ini_get_all('pcov'))
)
);
} elseif ($this->runtime->hasXdebug()) {
$settings = array_merge(
$settings,
$this->runtime->getCurrentSettings(
array_keys(ini_get_all('xdebug'))
)
);
}
$command .= $this->settingsToParameters($settings);
if (PHP_SAPI === 'phpdbg') {
$command .= ' -qrr';
if (!$file) {
$command .= 's=';
}
}
if ($file) {
$command .= ' ' . escapeshellarg($file);
}
if ($this->args) {
if (!$file) {
$command .= ' --';
}
$command .= ' ' . $this->args;
}
if ($this->stderrRedirection) {
$command .= ' 2>&1';
}
return $command;
}
/**
* Runs a single job (PHP code) using a separate PHP process.
*/
abstract public function runJob(string $job, array $settings = []): array;
protected function settingsToParameters(array $settings): string
{
$buffer = '';
foreach ($settings as $setting) {
$buffer .= ' -d ' . escapeshellarg($setting);
}
return $buffer;
}
/**
* Processes the TestResult object from an isolated process.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function processChildResult(Test $test, TestResult $result, string $stdout, string $stderr): void
{
$time = 0;
if (!empty($stderr)) {
$result->addError(
$test,
new Exception(trim($stderr)),
$time
);
} else {
set_error_handler(
/**
* @throws ErrorException
*/
static function ($errno, $errstr, $errfile, $errline): void
{
throw new ErrorException($errstr, $errno, $errno, $errfile, $errline);
}
);
try {
if (strpos($stdout, "#!/usr/bin/env php\n") === 0) {
$stdout = substr($stdout, 19);
}
$childResult = unserialize(str_replace("#!/usr/bin/env php\n", '', $stdout));
restore_error_handler();
if ($childResult === false) {
$result->addFailure(
$test,
new AssertionFailedError('Test was run in child process and ended unexpectedly'),
$time
);
}
} catch (ErrorException $e) {
restore_error_handler();
$childResult = false;
$result->addError(
$test,
new Exception(trim($stdout), 0, $e),
$time
);
}
if ($childResult !== false) {
if (!empty($childResult['output'])) {
$output = $childResult['output'];
}
/* @var TestCase $test */
$test->setResult($childResult['testResult']);
$test->addToAssertionCount($childResult['numAssertions']);
$childResult = $childResult['result'];
assert($childResult instanceof TestResult);
if ($result->getCollectCodeCoverageInformation()) {
$result->getCodeCoverage()->merge(
$childResult->getCodeCoverage()
);
}
$time = $childResult->time();
$notImplemented = $childResult->notImplemented();
$risky = $childResult->risky();
$skipped = $childResult->skipped();
$errors = $childResult->errors();
$warnings = $childResult->warnings();
$failures = $childResult->failures();
if (!empty($notImplemented)) {
$result->addError(
$test,
$this->getException($notImplemented[0]),
$time
);
} elseif (!empty($risky)) {
$result->addError(
$test,
$this->getException($risky[0]),
$time
);
} elseif (!empty($skipped)) {
$result->addError(
$test,
$this->getException($skipped[0]),
$time
);
} elseif (!empty($errors)) {
$result->addError(
$test,
$this->getException($errors[0]),
$time
);
} elseif (!empty($warnings)) {
$result->addWarning(
$test,
$this->getException($warnings[0]),
$time
);
} elseif (!empty($failures)) {
$result->addFailure(
$test,
$this->getException($failures[0]),
$time
);
}
}
}
$result->endTest($test, $time);
if (!empty($output)) {
print $output;
}
}
/**
* Gets the thrown exception from a PHPUnit\Framework\TestFailure.
*
* @see https://github.com/sebastianbergmann/phpunit/issues/74
*/
private function getException(TestFailure $error): Exception
{
$exception = $error->thrownException();
if ($exception instanceof __PHP_Incomplete_Class) {
$exceptionArray = [];
foreach ((array) $exception as $key => $value) {
$key = substr($key, strrpos($key, "\0") + 1);
$exceptionArray[$key] = $value;
}
$exception = new SyntheticError(
sprintf(
'%s: %s',
$exceptionArray['_PHP_Incomplete_Class_Name'],
$exceptionArray['message']
),
$exceptionArray['code'],
$exceptionArray['file'],
$exceptionArray['line'],
$exceptionArray['trace']
);
}
return $exception;
}
}
PK [w^ȯ
( src/Util/PHP/Template/TestCaseMethod.tplnu W+A {driverMethod}($filter),
$filter
);
if ({cachesStaticAnalysis}) {
$codeCoverage->cacheStaticAnalysis(unserialize('{codeCoverageCacheDirectory}'));
}
$result->setCodeCoverage($codeCoverage);
}
$result->beStrictAboutTestsThatDoNotTestAnything({isStrictAboutTestsThatDoNotTestAnything});
$result->beStrictAboutOutputDuringTests({isStrictAboutOutputDuringTests});
$result->enforceTimeLimit({enforcesTimeLimit});
$result->beStrictAboutTodoAnnotatedTests({isStrictAboutTodoAnnotatedTests});
$result->beStrictAboutResourceUsageDuringSmallTests({isStrictAboutResourceUsageDuringSmallTests});
$test = new {className}('{methodName}', unserialize('{data}'), '{dataName}');
\assert($test instanceof TestCase);
$test->setDependencyInput(unserialize('{dependencyInput}'));
$test->setInIsolation(true);
ob_end_clean();
$test->run($result);
$output = '';
if (!$test->hasExpectationOnOutput()) {
$output = $test->getActualOutput();
}
ini_set('xdebug.scream', '0');
@rewind(STDOUT); /* @ as not every STDOUT target stream is rewindable */
if ($stdout = @stream_get_contents(STDOUT)) {
$output = $stdout . $output;
$streamMetaData = stream_get_meta_data(STDOUT);
if (!empty($streamMetaData['stream_type']) && 'STDIO' === $streamMetaData['stream_type']) {
@ftruncate(STDOUT, 0);
@rewind(STDOUT);
}
}
print serialize(
[
'testResult' => $test->getResult(),
'numAssertions' => $test->getNumAssertions(),
'result' => $result,
'output' => $output
]
);
}
$configurationFilePath = '{configurationFilePath}';
if ('' !== $configurationFilePath) {
$configuration = (new Loader)->load($configurationFilePath);
(new PhpHandler)->handle($configuration->php());
unset($configuration);
}
function __phpunit_error_handler($errno, $errstr, $errfile, $errline)
{
return true;
}
set_error_handler('__phpunit_error_handler');
{constants}
{included_files}
{globals}
restore_error_handler();
if (isset($GLOBALS['__PHPUNIT_BOOTSTRAP'])) {
require_once $GLOBALS['__PHPUNIT_BOOTSTRAP'];
unset($GLOBALS['__PHPUNIT_BOOTSTRAP']);
}
__phpunit_run_isolated_test();
PK [+U `
`
' src/Util/PHP/Template/TestCaseClass.tplnu W+A {driverMethod}($filter),
$filter
);
if ({cachesStaticAnalysis}) {
$codeCoverage->cacheStaticAnalysis(unserialize('{codeCoverageCacheDirectory}'));
}
$result->setCodeCoverage($codeCoverage);
}
$result->beStrictAboutTestsThatDoNotTestAnything({isStrictAboutTestsThatDoNotTestAnything});
$result->beStrictAboutOutputDuringTests({isStrictAboutOutputDuringTests});
$result->enforceTimeLimit({enforcesTimeLimit});
$result->beStrictAboutTodoAnnotatedTests({isStrictAboutTodoAnnotatedTests});
$result->beStrictAboutResourceUsageDuringSmallTests({isStrictAboutResourceUsageDuringSmallTests});
$test = new {className}('{name}', unserialize('{data}'), '{dataName}');
$test->setDependencyInput(unserialize('{dependencyInput}'));
$test->setInIsolation(TRUE);
ob_end_clean();
$test->run($result);
$output = '';
if (!$test->hasExpectationOnOutput()) {
$output = $test->getActualOutput();
}
ini_set('xdebug.scream', '0');
@rewind(STDOUT); /* @ as not every STDOUT target stream is rewindable */
if ($stdout = @stream_get_contents(STDOUT)) {
$output = $stdout . $output;
$streamMetaData = stream_get_meta_data(STDOUT);
if (!empty($streamMetaData['stream_type']) && 'STDIO' === $streamMetaData['stream_type']) {
@ftruncate(STDOUT, 0);
@rewind(STDOUT);
}
}
print serialize(
[
'testResult' => $test->getResult(),
'numAssertions' => $test->getNumAssertions(),
'result' => $result,
'output' => $output
]
);
}
$configurationFilePath = '{configurationFilePath}';
if ('' !== $configurationFilePath) {
$configuration = (new Loader)->load($configurationFilePath);
(new PhpHandler)->handle($configuration->php());
unset($configuration);
}
function __phpunit_error_handler($errno, $errstr, $errfile, $errline)
{
return true;
}
set_error_handler('__phpunit_error_handler');
{constants}
{included_files}
{globals}
restore_error_handler();
if (isset($GLOBALS['__PHPUNIT_BOOTSTRAP'])) {
require_once $GLOBALS['__PHPUNIT_BOOTSTRAP'];
unset($GLOBALS['__PHPUNIT_BOOTSTRAP']);
}
__phpunit_run_isolated_test();
PK [h" & src/Util/PHP/Template/PhptTestCase.tplnu W+A {driverMethod}($filter),
$filter
);
if ({codeCoverageCacheDirectory}) {
$coverage->cacheStaticAnalysis({codeCoverageCacheDirectory});
}
$coverage->start(__FILE__);
}
register_shutdown_function(
function() use ($coverage) {
$output = null;
if ($coverage) {
$output = $coverage->stop();
}
file_put_contents('{coverageFile}', serialize($output));
}
);
ob_end_clean();
require '{job}';
PK [#4 src/Util/RegularExpression.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use function preg_match;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class RegularExpression
{
/**
* @return false|int
*/
public static function safeMatch(string $pattern, string $subject)
{
return ErrorHandler::invokeIgnoringWarnings(
static function () use ($pattern, $subject)
{
return preg_match($pattern, $subject);
}
);
}
}
PK [)s src/Util/FileLoader.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const DIRECTORY_SEPARATOR;
use function array_diff;
use function array_keys;
use function fopen;
use function get_defined_vars;
use function sprintf;
use function stream_resolve_include_path;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class FileLoader
{
/**
* Checks if a PHP sourcecode file is readable. The sourcecode file is loaded through the load() method.
*
* As a fallback, PHP looks in the directory of the file executing the stream_resolve_include_path function.
* We do not want to load the Test.php file here, so skip it if it found that.
* PHP prioritizes the include_path setting, so if the current directory is in there, it will first look in the
* current working directory.
*
* @throws Exception
*/
public static function checkAndLoad(string $filename): string
{
$includePathFilename = stream_resolve_include_path($filename);
$localFile = __DIR__ . DIRECTORY_SEPARATOR . $filename;
if (!$includePathFilename ||
$includePathFilename === $localFile ||
!self::isReadable($includePathFilename)) {
throw new Exception(
sprintf('Cannot open file "%s".' . "\n", $filename)
);
}
self::load($includePathFilename);
return $includePathFilename;
}
/**
* Loads a PHP sourcefile.
*/
public static function load(string $filename): void
{
$oldVariableNames = array_keys(get_defined_vars());
/**
* @noinspection PhpIncludeInspection
*
* @psalm-suppress UnresolvableInclude
*/
include_once $filename;
$newVariables = get_defined_vars();
foreach (array_diff(array_keys($newVariables), $oldVariableNames) as $variableName) {
if ($variableName !== 'oldVariableNames') {
$GLOBALS[$variableName] = $newVariables[$variableName];
}
}
}
/**
* @see https://github.com/sebastianbergmann/phpunit/pull/2751
*/
private static function isReadable(string $filename): bool
{
return @fopen($filename, 'r') !== false;
}
}
PK [ǵNd Nd src/Util/Test.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const PHP_OS;
use const PHP_VERSION;
use function addcslashes;
use function array_flip;
use function array_key_exists;
use function array_merge;
use function array_unique;
use function array_unshift;
use function class_exists;
use function count;
use function explode;
use function extension_loaded;
use function function_exists;
use function get_class;
use function ini_get;
use function interface_exists;
use function is_array;
use function is_int;
use function method_exists;
use function phpversion;
use function preg_match;
use function preg_replace;
use function sprintf;
use function strncmp;
use function strpos;
use function strtolower;
use function trim;
use function version_compare;
use PHPUnit\Framework\CodeCoverageException;
use PHPUnit\Framework\ExecutionOrderDependency;
use PHPUnit\Framework\InvalidCoversTargetException;
use PHPUnit\Framework\SelfDescribing;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\Warning;
use PHPUnit\Runner\Version;
use PHPUnit\Util\Annotation\Registry;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;
use SebastianBergmann\CodeUnit\CodeUnitCollection;
use SebastianBergmann\CodeUnit\InvalidCodeUnitException;
use SebastianBergmann\CodeUnit\Mapper;
use SebastianBergmann\Environment\OperatingSystem;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Test
{
/**
* @var int
*/
public const UNKNOWN = -1;
/**
* @var int
*/
public const SMALL = 0;
/**
* @var int
*/
public const MEDIUM = 1;
/**
* @var int
*/
public const LARGE = 2;
/**
* @var array
*/
private static $hookMethods = [];
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public static function describe(\PHPUnit\Framework\Test $test): array
{
if ($test instanceof TestCase) {
return [get_class($test), $test->getName()];
}
if ($test instanceof SelfDescribing) {
return ['', $test->toString()];
}
return ['', get_class($test)];
}
public static function describeAsString(\PHPUnit\Framework\Test $test): string
{
if ($test instanceof SelfDescribing) {
return $test->toString();
}
return get_class($test);
}
/**
* @throws CodeCoverageException
*
* @return array|bool
*
* @psalm-param class-string $className
*/
public static function getLinesToBeCovered(string $className, string $methodName)
{
$annotations = self::parseTestMethodAnnotations(
$className,
$methodName
);
if (!self::shouldCoversAnnotationBeUsed($annotations)) {
return false;
}
return self::getLinesToBeCoveredOrUsed($className, $methodName, 'covers');
}
/**
* Returns lines of code specified with the @uses annotation.
*
* @throws CodeCoverageException
*
* @psalm-param class-string $className
*/
public static function getLinesToBeUsed(string $className, string $methodName): array
{
return self::getLinesToBeCoveredOrUsed($className, $methodName, 'uses');
}
public static function requiresCodeCoverageDataCollection(TestCase $test): bool
{
$annotations = self::parseTestMethodAnnotations(
get_class($test),
$test->getName(false)
);
// If there is no @covers annotation but a @coversNothing annotation on
// the test method then code coverage data does not need to be collected
if (isset($annotations['method']['coversNothing'])) {
// @see https://github.com/sebastianbergmann/phpunit/issues/4947#issuecomment-1084480950
// return false;
}
// If there is at least one @covers annotation then
// code coverage data needs to be collected
if (isset($annotations['method']['covers'])) {
return true;
}
// If there is no @covers annotation but a @coversNothing annotation
// then code coverage data does not need to be collected
if (isset($annotations['class']['coversNothing'])) {
// @see https://github.com/sebastianbergmann/phpunit/issues/4947#issuecomment-1084480950
// return false;
}
// If there is no @coversNothing annotation then
// code coverage data may be collected
return true;
}
/**
* @throws Exception
*
* @psalm-param class-string $className
*/
public static function getRequirements(string $className, string $methodName): array
{
return self::mergeArraysRecursively(
Registry::getInstance()->forClassName($className)->requirements(),
Registry::getInstance()->forMethod($className, $methodName)->requirements()
);
}
/**
* Returns the missing requirements for a test.
*
* @throws Exception
* @throws Warning
*
* @psalm-param class-string $className
*/
public static function getMissingRequirements(string $className, string $methodName): array
{
$required = self::getRequirements($className, $methodName);
$missing = [];
$hint = null;
if (!empty($required['PHP'])) {
$operator = new VersionComparisonOperator(empty($required['PHP']['operator']) ? '>=' : $required['PHP']['operator']);
if (!version_compare(PHP_VERSION, $required['PHP']['version'], $operator->asString())) {
$missing[] = sprintf('PHP %s %s is required.', $operator->asString(), $required['PHP']['version']);
$hint = 'PHP';
}
} elseif (!empty($required['PHP_constraint'])) {
$version = new \PharIo\Version\Version(self::sanitizeVersionNumber(PHP_VERSION));
if (!$required['PHP_constraint']['constraint']->complies($version)) {
$missing[] = sprintf(
'PHP version does not match the required constraint %s.',
$required['PHP_constraint']['constraint']->asString()
);
$hint = 'PHP_constraint';
}
}
if (!empty($required['PHPUnit'])) {
$phpunitVersion = Version::id();
$operator = new VersionComparisonOperator(empty($required['PHPUnit']['operator']) ? '>=' : $required['PHPUnit']['operator']);
if (!version_compare($phpunitVersion, $required['PHPUnit']['version'], $operator->asString())) {
$missing[] = sprintf('PHPUnit %s %s is required.', $operator->asString(), $required['PHPUnit']['version']);
$hint = $hint ?? 'PHPUnit';
}
} elseif (!empty($required['PHPUnit_constraint'])) {
$phpunitVersion = new \PharIo\Version\Version(self::sanitizeVersionNumber(Version::id()));
if (!$required['PHPUnit_constraint']['constraint']->complies($phpunitVersion)) {
$missing[] = sprintf(
'PHPUnit version does not match the required constraint %s.',
$required['PHPUnit_constraint']['constraint']->asString()
);
$hint = $hint ?? 'PHPUnit_constraint';
}
}
if (!empty($required['OSFAMILY']) && $required['OSFAMILY'] !== (new OperatingSystem)->getFamily()) {
$missing[] = sprintf('Operating system %s is required.', $required['OSFAMILY']);
$hint = $hint ?? 'OSFAMILY';
}
if (!empty($required['OS'])) {
$requiredOsPattern = sprintf('/%s/i', addcslashes($required['OS'], '/'));
if (!preg_match($requiredOsPattern, PHP_OS)) {
$missing[] = sprintf('Operating system matching %s is required.', $requiredOsPattern);
$hint = $hint ?? 'OS';
}
}
if (!empty($required['functions'])) {
foreach ($required['functions'] as $function) {
$pieces = explode('::', $function);
if (count($pieces) === 2 && class_exists($pieces[0]) && method_exists($pieces[0], $pieces[1])) {
continue;
}
if (function_exists($function)) {
continue;
}
$missing[] = sprintf('Function %s is required.', $function);
$hint = $hint ?? 'function_' . $function;
}
}
if (!empty($required['setting'])) {
foreach ($required['setting'] as $setting => $value) {
if (ini_get($setting) !== $value) {
$missing[] = sprintf('Setting "%s" must be "%s".', $setting, $value);
$hint = $hint ?? '__SETTING_' . $setting;
}
}
}
if (!empty($required['extensions'])) {
foreach ($required['extensions'] as $extension) {
if (isset($required['extension_versions'][$extension])) {
continue;
}
if (!extension_loaded($extension)) {
$missing[] = sprintf('Extension %s is required.', $extension);
$hint = $hint ?? 'extension_' . $extension;
}
}
}
if (!empty($required['extension_versions'])) {
foreach ($required['extension_versions'] as $extension => $req) {
$actualVersion = phpversion($extension);
$operator = new VersionComparisonOperator(empty($req['operator']) ? '>=' : $req['operator']);
if ($actualVersion === false || !version_compare($actualVersion, $req['version'], $operator->asString())) {
$missing[] = sprintf('Extension %s %s %s is required.', $extension, $operator->asString(), $req['version']);
$hint = $hint ?? 'extension_' . $extension;
}
}
}
if ($hint && isset($required['__OFFSET'])) {
array_unshift($missing, '__OFFSET_FILE=' . $required['__OFFSET']['__FILE']);
array_unshift($missing, '__OFFSET_LINE=' . ($required['__OFFSET'][$hint] ?? 1));
}
return $missing;
}
/**
* Returns the provided data for a method.
*
* @throws Exception
*
* @psalm-param class-string $className
*/
public static function getProvidedData(string $className, string $methodName): ?array
{
return Registry::getInstance()->forMethod($className, $methodName)->getProvidedData();
}
/**
* @psalm-param class-string $className
*/
public static function parseTestMethodAnnotations(string $className, ?string $methodName = null): array
{
$registry = Registry::getInstance();
if ($methodName !== null) {
try {
return [
'method' => $registry->forMethod($className, $methodName)->symbolAnnotations(),
'class' => $registry->forClassName($className)->symbolAnnotations(),
];
} catch (Exception $methodNotFound) {
// ignored
}
}
return [
'method' => null,
'class' => $registry->forClassName($className)->symbolAnnotations(),
];
}
/**
* @psalm-param class-string $className
*/
public static function getInlineAnnotations(string $className, string $methodName): array
{
return Registry::getInstance()->forMethod($className, $methodName)->getInlineAnnotations();
}
/** @psalm-param class-string $className */
public static function getBackupSettings(string $className, string $methodName): array
{
return [
'backupGlobals' => self::getBooleanAnnotationSetting(
$className,
$methodName,
'backupGlobals'
),
'backupStaticAttributes' => self::getBooleanAnnotationSetting(
$className,
$methodName,
'backupStaticAttributes'
),
];
}
/**
* @psalm-param class-string $className
*
* @return ExecutionOrderDependency[]
*/
public static function getDependencies(string $className, string $methodName): array
{
$annotations = self::parseTestMethodAnnotations(
$className,
$methodName
);
$dependsAnnotations = $annotations['class']['depends'] ?? [];
if (isset($annotations['method']['depends'])) {
$dependsAnnotations = array_merge(
$dependsAnnotations,
$annotations['method']['depends']
);
}
// Normalize dependency name to className::methodName
$dependencies = [];
foreach ($dependsAnnotations as $value) {
$dependencies[] = ExecutionOrderDependency::createFromDependsAnnotation($className, $value);
}
return array_unique($dependencies);
}
/** @psalm-param class-string $className */
public static function getGroups(string $className, ?string $methodName = ''): array
{
$annotations = self::parseTestMethodAnnotations(
$className,
$methodName
);
$groups = [];
if (isset($annotations['method']['author'])) {
$groups[] = $annotations['method']['author'];
} elseif (isset($annotations['class']['author'])) {
$groups[] = $annotations['class']['author'];
}
if (isset($annotations['class']['group'])) {
$groups[] = $annotations['class']['group'];
}
if (isset($annotations['method']['group'])) {
$groups[] = $annotations['method']['group'];
}
if (isset($annotations['class']['ticket'])) {
$groups[] = $annotations['class']['ticket'];
}
if (isset($annotations['method']['ticket'])) {
$groups[] = $annotations['method']['ticket'];
}
foreach (['method', 'class'] as $element) {
foreach (['small', 'medium', 'large'] as $size) {
if (isset($annotations[$element][$size])) {
$groups[] = [$size];
break 2;
}
}
}
foreach (['method', 'class'] as $element) {
if (isset($annotations[$element]['covers'])) {
foreach ($annotations[$element]['covers'] as $coversTarget) {
$groups[] = ['__phpunit_covers_' . self::canonicalizeName($coversTarget)];
}
}
if (isset($annotations[$element]['uses'])) {
foreach ($annotations[$element]['uses'] as $usesTarget) {
$groups[] = ['__phpunit_uses_' . self::canonicalizeName($usesTarget)];
}
}
}
return array_unique(array_merge([], ...$groups));
}
/** @psalm-param class-string $className */
public static function getSize(string $className, ?string $methodName): int
{
$groups = array_flip(self::getGroups($className, $methodName));
if (isset($groups['large'])) {
return self::LARGE;
}
if (isset($groups['medium'])) {
return self::MEDIUM;
}
if (isset($groups['small'])) {
return self::SMALL;
}
return self::UNKNOWN;
}
/** @psalm-param class-string $className */
public static function getProcessIsolationSettings(string $className, string $methodName): bool
{
$annotations = self::parseTestMethodAnnotations(
$className,
$methodName
);
return isset($annotations['class']['runTestsInSeparateProcesses']) || isset($annotations['method']['runInSeparateProcess']);
}
/** @psalm-param class-string $className */
public static function getClassProcessIsolationSettings(string $className, string $methodName): bool
{
$annotations = self::parseTestMethodAnnotations(
$className,
$methodName
);
return isset($annotations['class']['runClassInSeparateProcess']);
}
/** @psalm-param class-string $className */
public static function getPreserveGlobalStateSettings(string $className, string $methodName): ?bool
{
return self::getBooleanAnnotationSetting(
$className,
$methodName,
'preserveGlobalState'
);
}
/** @psalm-param class-string $className */
public static function getHookMethods(string $className): array
{
if (!class_exists($className, false)) {
return self::emptyHookMethodsArray();
}
if (!isset(self::$hookMethods[$className])) {
self::$hookMethods[$className] = self::emptyHookMethodsArray();
try {
foreach ((new Reflection)->methodsInTestClass(new ReflectionClass($className)) as $method) {
$docBlock = Registry::getInstance()->forMethod($className, $method->getName());
if ($method->isStatic()) {
if ($docBlock->isHookToBeExecutedBeforeClass()) {
array_unshift(
self::$hookMethods[$className]['beforeClass'],
$method->getName()
);
}
if ($docBlock->isHookToBeExecutedAfterClass()) {
self::$hookMethods[$className]['afterClass'][] = $method->getName();
}
}
if ($docBlock->isToBeExecutedBeforeTest()) {
array_unshift(
self::$hookMethods[$className]['before'],
$method->getName()
);
}
if ($docBlock->isToBeExecutedAsPreCondition()) {
array_unshift(
self::$hookMethods[$className]['preCondition'],
$method->getName()
);
}
if ($docBlock->isToBeExecutedAsPostCondition()) {
self::$hookMethods[$className]['postCondition'][] = $method->getName();
}
if ($docBlock->isToBeExecutedAfterTest()) {
self::$hookMethods[$className]['after'][] = $method->getName();
}
}
} catch (ReflectionException $e) {
}
}
return self::$hookMethods[$className];
}
public static function isTestMethod(ReflectionMethod $method): bool
{
if (!$method->isPublic()) {
return false;
}
if (strpos($method->getName(), 'test') === 0) {
return true;
}
return array_key_exists(
'test',
Registry::getInstance()->forMethod(
$method->getDeclaringClass()->getName(),
$method->getName()
)
->symbolAnnotations()
);
}
/**
* @throws CodeCoverageException
*
* @psalm-param class-string $className
*/
private static function getLinesToBeCoveredOrUsed(string $className, string $methodName, string $mode): array
{
$annotations = self::parseTestMethodAnnotations(
$className,
$methodName
);
$classShortcut = null;
if (!empty($annotations['class'][$mode . 'DefaultClass'])) {
if (count($annotations['class'][$mode . 'DefaultClass']) > 1) {
throw new CodeCoverageException(
sprintf(
'More than one @%sClass annotation in class or interface "%s".',
$mode,
$className
)
);
}
$classShortcut = $annotations['class'][$mode . 'DefaultClass'][0];
}
$list = $annotations['class'][$mode] ?? [];
if (isset($annotations['method'][$mode])) {
$list = array_merge($list, $annotations['method'][$mode]);
}
$codeUnits = CodeUnitCollection::fromArray([]);
$mapper = new Mapper;
foreach (array_unique($list) as $element) {
if ($classShortcut && strncmp($element, '::', 2) === 0) {
$element = $classShortcut . $element;
}
$element = preg_replace('/[\s()]+$/', '', $element);
$element = explode(' ', $element);
$element = $element[0];
if ($mode === 'covers' && interface_exists($element)) {
throw new InvalidCoversTargetException(
sprintf(
'Trying to @cover interface "%s".',
$element
)
);
}
try {
$codeUnits = $codeUnits->mergeWith($mapper->stringToCodeUnits($element));
} catch (InvalidCodeUnitException $e) {
throw new InvalidCoversTargetException(
sprintf(
'"@%s %s" is invalid',
$mode,
$element
),
$e->getCode(),
$e
);
}
}
return $mapper->codeUnitsToSourceLines($codeUnits);
}
private static function emptyHookMethodsArray(): array
{
return [
'beforeClass' => ['setUpBeforeClass'],
'before' => ['setUp'],
'preCondition' => ['assertPreConditions'],
'postCondition' => ['assertPostConditions'],
'after' => ['tearDown'],
'afterClass' => ['tearDownAfterClass'],
];
}
/** @psalm-param class-string $className */
private static function getBooleanAnnotationSetting(string $className, ?string $methodName, string $settingName): ?bool
{
$annotations = self::parseTestMethodAnnotations(
$className,
$methodName
);
if (isset($annotations['method'][$settingName])) {
if ($annotations['method'][$settingName][0] === 'enabled') {
return true;
}
if ($annotations['method'][$settingName][0] === 'disabled') {
return false;
}
}
if (isset($annotations['class'][$settingName])) {
if ($annotations['class'][$settingName][0] === 'enabled') {
return true;
}
if ($annotations['class'][$settingName][0] === 'disabled') {
return false;
}
}
return null;
}
/**
* Trims any extensions from version string that follows after
* the .[.] format.
*/
private static function sanitizeVersionNumber(string $version)
{
return preg_replace(
'/^(\d+\.\d+(?:.\d+)?).*$/',
'$1',
$version
);
}
private static function shouldCoversAnnotationBeUsed(array $annotations): bool
{
if (isset($annotations['method']['coversNothing'])) {
return false;
}
if (isset($annotations['method']['covers'])) {
return true;
}
if (isset($annotations['class']['coversNothing'])) {
return false;
}
return true;
}
/**
* Merge two arrays together.
*
* If an integer key exists in both arrays and preserveNumericKeys is false, the value
* from the second array will be appended to the first array. If both values are arrays, they
* are merged together, else the value of the second array overwrites the one of the first array.
*
* This implementation is copied from https://github.com/zendframework/zend-stdlib/blob/76b653c5e99b40eccf5966e3122c90615134ae46/src/ArrayUtils.php
*
* Zend Framework (http://framework.zend.com/)
*
* @see http://github.com/zendframework/zf2 for the canonical source repository
*
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
private static function mergeArraysRecursively(array $a, array $b): array
{
foreach ($b as $key => $value) {
if (array_key_exists($key, $a)) {
if (is_int($key)) {
$a[] = $value;
} elseif (is_array($value) && is_array($a[$key])) {
$a[$key] = self::mergeArraysRecursively($a[$key], $value);
} else {
$a[$key] = $value;
}
} else {
$a[$key] = $value;
}
}
return $a;
}
private static function canonicalizeName(string $name): string
{
return strtolower(trim($name, '\\'));
}
}
PK [.2 src/Util/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Exception extends RuntimeException implements \PHPUnit\Exception
{
}
PK [eF F src/Util/Annotation/DocBlock.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Annotation;
use const JSON_ERROR_NONE;
use const PREG_OFFSET_CAPTURE;
use function array_filter;
use function array_key_exists;
use function array_map;
use function array_merge;
use function array_pop;
use function array_slice;
use function array_values;
use function count;
use function explode;
use function file;
use function implode;
use function is_array;
use function is_int;
use function json_decode;
use function json_last_error;
use function json_last_error_msg;
use function preg_match;
use function preg_match_all;
use function preg_replace;
use function preg_split;
use function realpath;
use function rtrim;
use function sprintf;
use function str_replace;
use function strlen;
use function strpos;
use function strtolower;
use function substr;
use function trim;
use PharIo\Version\VersionConstraintParser;
use PHPUnit\Framework\InvalidDataProviderException;
use PHPUnit\Framework\SkippedTestError;
use PHPUnit\Framework\Warning;
use PHPUnit\Util\Exception;
use PHPUnit\Util\InvalidDataSetException;
use ReflectionClass;
use ReflectionException;
use ReflectionFunctionAbstract;
use ReflectionMethod;
use Reflector;
use Traversable;
/**
* This is an abstraction around a PHPUnit-specific docBlock,
* allowing us to ask meaningful questions about a specific
* reflection symbol.
*
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class DocBlock
{
/**
* @todo This constant should be private (it's public because of TestTest::testGetProvidedDataRegEx)
*/
public const REGEX_DATA_PROVIDER = '/@dataProvider\s+([a-zA-Z0-9._:-\\\\x7f-\xff]+)/';
private const REGEX_REQUIRES_VERSION = '/@requires\s+(?PPHP(?:Unit)?)\s+(?P[<>=!]{0,2})\s*(?P[\d\.-]+(dev|(RC|alpha|beta)[\d\.])?)[ \t]*\r?$/m';
private const REGEX_REQUIRES_VERSION_CONSTRAINT = '/@requires\s+(?PPHP(?:Unit)?)\s+(?P[\d\t \-.|~^]+)[ \t]*\r?$/m';
private const REGEX_REQUIRES_OS = '/@requires\s+(?POS(?:FAMILY)?)\s+(?P.+?)[ \t]*\r?$/m';
private const REGEX_REQUIRES_SETTING = '/@requires\s+(?Psetting)\s+(?P([^ ]+?))\s*(?P[\w\.-]+[\w\.]?)?[ \t]*\r?$/m';
private const REGEX_REQUIRES = '/@requires\s+(?Pfunction|extension)\s+(?P([^\s<>=!]+))\s*(?P[<>=!]{0,2})\s*(?P[\d\.-]+[\d\.]?)?[ \t]*\r?$/m';
private const REGEX_TEST_WITH = '/@testWith\s+/';
/** @var string */
private $docComment;
/** @var bool */
private $isMethod;
/** @var array> pre-parsed annotations indexed by name and occurrence index */
private $symbolAnnotations;
/**
* @var null|array
*
* @psalm-var null|(array{
* __OFFSET: array&array{__FILE: string},
* setting?: array,
* extension_versions?: array
* }&array<
* string,
* string|array{version: string, operator: string}|array{constraint: string}|array
* >)
*/
private $parsedRequirements;
/** @var int */
private $startLine;
/** @var int */
private $endLine;
/** @var string */
private $fileName;
/** @var string */
private $name;
/**
* @var string
*
* @psalm-var class-string
*/
private $className;
public static function ofClass(ReflectionClass $class): self
{
$className = $class->getName();
return new self(
(string) $class->getDocComment(),
false,
self::extractAnnotationsFromReflector($class),
$class->getStartLine(),
$class->getEndLine(),
$class->getFileName(),
$className,
$className
);
}
/**
* @psalm-param class-string $classNameInHierarchy
*/
public static function ofMethod(ReflectionMethod $method, string $classNameInHierarchy): self
{
return new self(
(string) $method->getDocComment(),
true,
self::extractAnnotationsFromReflector($method),
$method->getStartLine(),
$method->getEndLine(),
$method->getFileName(),
$method->getName(),
$classNameInHierarchy
);
}
/**
* Note: we do not preserve an instance of the reflection object, since it cannot be safely (de-)serialized.
*
* @param array> $symbolAnnotations
*
* @psalm-param class-string $className
*/
private function __construct(string $docComment, bool $isMethod, array $symbolAnnotations, int $startLine, int $endLine, string $fileName, string $name, string $className)
{
$this->docComment = $docComment;
$this->isMethod = $isMethod;
$this->symbolAnnotations = $symbolAnnotations;
$this->startLine = $startLine;
$this->endLine = $endLine;
$this->fileName = $fileName;
$this->name = $name;
$this->className = $className;
}
/**
* @psalm-return array{
* __OFFSET: array&array{__FILE: string},
* setting?: array,
* extension_versions?: array
* }&array<
* string,
* string|array{version: string, operator: string}|array{constraint: string}|array
* >
*
* @throws Warning if the requirements version constraint is not well-formed
*/
public function requirements(): array
{
if ($this->parsedRequirements !== null) {
return $this->parsedRequirements;
}
$offset = $this->startLine;
$requires = [];
$recordedSettings = [];
$extensionVersions = [];
$recordedOffsets = [
'__FILE' => realpath($this->fileName),
];
// Trim docblock markers, split it into lines and rewind offset to start of docblock
$lines = preg_replace(['#^/\*{2}#', '#\*/$#'], '', preg_split('/\r\n|\r|\n/', $this->docComment));
$offset -= count($lines);
foreach ($lines as $line) {
if (preg_match(self::REGEX_REQUIRES_OS, $line, $matches)) {
$requires[$matches['name']] = $matches['value'];
$recordedOffsets[$matches['name']] = $offset;
}
if (preg_match(self::REGEX_REQUIRES_VERSION, $line, $matches)) {
$requires[$matches['name']] = [
'version' => $matches['version'],
'operator' => $matches['operator'],
];
$recordedOffsets[$matches['name']] = $offset;
}
if (preg_match(self::REGEX_REQUIRES_VERSION_CONSTRAINT, $line, $matches)) {
if (!empty($requires[$matches['name']])) {
$offset++;
continue;
}
try {
$versionConstraintParser = new VersionConstraintParser;
$requires[$matches['name'] . '_constraint'] = [
'constraint' => $versionConstraintParser->parse(trim($matches['constraint'])),
];
$recordedOffsets[$matches['name'] . '_constraint'] = $offset;
} catch (\PharIo\Version\Exception $e) {
throw new Warning($e->getMessage(), $e->getCode(), $e);
}
}
if (preg_match(self::REGEX_REQUIRES_SETTING, $line, $matches)) {
$recordedSettings[$matches['setting']] = $matches['value'];
$recordedOffsets['__SETTING_' . $matches['setting']] = $offset;
}
if (preg_match(self::REGEX_REQUIRES, $line, $matches)) {
$name = $matches['name'] . 's';
if (!isset($requires[$name])) {
$requires[$name] = [];
}
$requires[$name][] = $matches['value'];
$recordedOffsets[$matches['name'] . '_' . $matches['value']] = $offset;
if ($name === 'extensions' && !empty($matches['version'])) {
$extensionVersions[$matches['value']] = [
'version' => $matches['version'],
'operator' => $matches['operator'],
];
}
}
$offset++;
}
return $this->parsedRequirements = array_merge(
$requires,
['__OFFSET' => $recordedOffsets],
array_filter([
'setting' => $recordedSettings,
'extension_versions' => $extensionVersions,
])
);
}
/**
* Returns the provided data for a method.
*
* @throws Exception
*/
public function getProvidedData(): ?array
{
/** @noinspection SuspiciousBinaryOperationInspection */
$data = $this->getDataFromDataProviderAnnotation($this->docComment) ?? $this->getDataFromTestWithAnnotation($this->docComment);
if ($data === null) {
return null;
}
if ($data === []) {
throw new SkippedTestError;
}
foreach ($data as $key => $value) {
if (!is_array($value)) {
throw new InvalidDataSetException(
sprintf(
'Data set %s is invalid.',
is_int($key) ? '#' . $key : '"' . $key . '"'
)
);
}
}
return $data;
}
/**
* @psalm-return array
*/
public function getInlineAnnotations(): array
{
$code = file($this->fileName);
$lineNumber = $this->startLine;
$startLine = $this->startLine - 1;
$endLine = $this->endLine - 1;
$codeLines = array_slice($code, $startLine, $endLine - $startLine + 1);
$annotations = [];
foreach ($codeLines as $line) {
if (preg_match('#/\*\*?\s*@(?P[A-Za-z_-]+)(?:[ \t]+(?P.*?))?[ \t]*\r?\*/$#m', $line, $matches)) {
$annotations[strtolower($matches['name'])] = [
'line' => $lineNumber,
'value' => $matches['value'],
];
}
$lineNumber++;
}
return $annotations;
}
public function symbolAnnotations(): array
{
return $this->symbolAnnotations;
}
public function isHookToBeExecutedBeforeClass(): bool
{
return $this->isMethod &&
false !== strpos($this->docComment, '@beforeClass');
}
public function isHookToBeExecutedAfterClass(): bool
{
return $this->isMethod &&
false !== strpos($this->docComment, '@afterClass');
}
public function isToBeExecutedBeforeTest(): bool
{
return 1 === preg_match('/@before\b/', $this->docComment);
}
public function isToBeExecutedAfterTest(): bool
{
return 1 === preg_match('/@after\b/', $this->docComment);
}
public function isToBeExecutedAsPreCondition(): bool
{
return 1 === preg_match('/@preCondition\b/', $this->docComment);
}
public function isToBeExecutedAsPostCondition(): bool
{
return 1 === preg_match('/@postCondition\b/', $this->docComment);
}
private function getDataFromDataProviderAnnotation(string $docComment): ?array
{
$methodName = null;
$className = $this->className;
if ($this->isMethod) {
$methodName = $this->name;
}
if (!preg_match_all(self::REGEX_DATA_PROVIDER, $docComment, $matches)) {
return null;
}
$result = [];
foreach ($matches[1] as $match) {
$dataProviderMethodNameNamespace = explode('\\', $match);
$leaf = explode('::', array_pop($dataProviderMethodNameNamespace));
$dataProviderMethodName = array_pop($leaf);
if (empty($dataProviderMethodNameNamespace)) {
$dataProviderMethodNameNamespace = '';
} else {
$dataProviderMethodNameNamespace = implode('\\', $dataProviderMethodNameNamespace) . '\\';
}
if (empty($leaf)) {
$dataProviderClassName = $className;
} else {
/** @psalm-var class-string $dataProviderClassName */
$dataProviderClassName = $dataProviderMethodNameNamespace . array_pop($leaf);
}
try {
$dataProviderClass = new ReflectionClass($dataProviderClassName);
$dataProviderMethod = $dataProviderClass->getMethod(
$dataProviderMethodName
);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
// @codeCoverageIgnoreEnd
}
if ($dataProviderMethod->isStatic()) {
$object = null;
} else {
$object = $dataProviderClass->newInstance();
}
if ($dataProviderMethod->getNumberOfParameters() === 0) {
$data = $dataProviderMethod->invoke($object);
} else {
$data = $dataProviderMethod->invoke($object, $methodName);
}
if ($data instanceof Traversable) {
$origData = $data;
$data = [];
foreach ($origData as $key => $value) {
if (is_int($key)) {
$data[] = $value;
} elseif (array_key_exists($key, $data)) {
throw new InvalidDataProviderException(
sprintf(
'The key "%s" has already been defined in the data provider "%s".',
$key,
$match
)
);
} else {
$data[$key] = $value;
}
}
}
if (is_array($data)) {
$result = array_merge($result, $data);
}
}
return $result;
}
/**
* @throws Exception
*/
private function getDataFromTestWithAnnotation(string $docComment): ?array
{
$docComment = $this->cleanUpMultiLineAnnotation($docComment);
if (!preg_match(self::REGEX_TEST_WITH, $docComment, $matches, PREG_OFFSET_CAPTURE)) {
return null;
}
$offset = strlen($matches[0][0]) + $matches[0][1];
$annotationContent = substr($docComment, $offset);
$data = [];
foreach (explode("\n", $annotationContent) as $candidateRow) {
$candidateRow = trim($candidateRow);
if ($candidateRow[0] !== '[') {
break;
}
$dataSet = json_decode($candidateRow, true);
if (json_last_error() !== JSON_ERROR_NONE) {
throw new Exception(
'The data set for the @testWith annotation cannot be parsed: ' . json_last_error_msg()
);
}
$data[] = $dataSet;
}
if (!$data) {
throw new Exception('The data set for the @testWith annotation cannot be parsed.');
}
return $data;
}
private function cleanUpMultiLineAnnotation(string $docComment): string
{
//removing initial ' * ' for docComment
$docComment = str_replace("\r\n", "\n", $docComment);
$docComment = preg_replace('/' . '\n' . '\s*' . '\*' . '\s?' . '/', "\n", $docComment);
$docComment = (string) substr($docComment, 0, -1);
return rtrim($docComment, "\n");
}
/** @return array> */
private static function parseDocBlock(string $docBlock): array
{
// Strip away the docblock header and footer to ease parsing of one line annotations
$docBlock = (string) substr($docBlock, 3, -2);
$annotations = [];
if (preg_match_all('/@(?P[A-Za-z_-]+)(?:[ \t]+(?P.*?))?[ \t]*\r?$/m', $docBlock, $matches)) {
$numMatches = count($matches[0]);
for ($i = 0; $i < $numMatches; $i++) {
$annotations[$matches['name'][$i]][] = (string) $matches['value'][$i];
}
}
return $annotations;
}
/** @param ReflectionClass|ReflectionFunctionAbstract $reflector */
private static function extractAnnotationsFromReflector(Reflector $reflector): array
{
$annotations = [];
if ($reflector instanceof ReflectionClass) {
$annotations = array_merge(
$annotations,
...array_map(
static function (ReflectionClass $trait): array
{
return self::parseDocBlock((string) $trait->getDocComment());
},
array_values($reflector->getTraits())
)
);
}
return array_merge(
$annotations,
self::parseDocBlock((string) $reflector->getDocComment())
);
}
}
PK [Tsh
h
src/Util/Annotation/Registry.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Annotation;
use function array_key_exists;
use PHPUnit\Util\Exception;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;
/**
* Reflection information, and therefore DocBlock information, is static within
* a single PHP process. It is therefore okay to use a Singleton registry here.
*
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Registry
{
/** @var null|self */
private static $instance;
/** @var array indexed by class name */
private $classDocBlocks = [];
/** @var array> indexed by class name and method name */
private $methodDocBlocks = [];
public static function getInstance(): self
{
return self::$instance ?? self::$instance = new self;
}
private function __construct()
{
}
/**
* @throws Exception
*
* @psalm-param class-string $class
*/
public function forClassName(string $class): DocBlock
{
if (array_key_exists($class, $this->classDocBlocks)) {
return $this->classDocBlocks[$class];
}
try {
$reflection = new ReflectionClass($class);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
return $this->classDocBlocks[$class] = DocBlock::ofClass($reflection);
}
/**
* @throws Exception
*
* @psalm-param class-string $classInHierarchy
*/
public function forMethod(string $classInHierarchy, string $method): DocBlock
{
if (isset($this->methodDocBlocks[$classInHierarchy][$method])) {
return $this->methodDocBlocks[$classInHierarchy][$method];
}
try {
$reflection = new ReflectionMethod($classInHierarchy, $method);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
return $this->methodDocBlocks[$classInHierarchy][$method] = DocBlock::ofMethod($reflection, $classInHierarchy);
}
}
PK [ ͳ ! src/Util/TextTestListRenderer.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const PHP_EOL;
use function get_class;
use function sprintf;
use function str_replace;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Runner\PhptTestCase;
use RecursiveIteratorIterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TextTestListRenderer
{
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function render(TestSuite $suite): string
{
$buffer = 'Available test(s):' . PHP_EOL;
foreach (new RecursiveIteratorIterator($suite->getIterator()) as $test) {
if ($test instanceof TestCase) {
$name = sprintf(
'%s::%s',
get_class($test),
str_replace(' with data set ', '', $test->getName())
);
} elseif ($test instanceof PhptTestCase) {
$name = $test->getName();
} else {
continue;
}
$buffer .= sprintf(
' - %s' . PHP_EOL,
$name
);
}
return $buffer;
}
}
PK [3\!% % ( src/Util/XdebugFilterScriptGenerator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use const DIRECTORY_SEPARATOR;
use function addslashes;
use function array_map;
use function implode;
use function is_string;
use function realpath;
use function sprintf;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\CodeCoverage as FilterConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @deprecated
*/
final class XdebugFilterScriptGenerator
{
public function generate(FilterConfiguration $filter): string
{
$files = array_map(
static function ($item)
{
return sprintf(
" '%s'",
$item
);
},
$this->getItems($filter)
);
$files = implode(",\n", $files);
return <<directories() as $directory) {
$path = realpath($directory->path());
if (is_string($path)) {
$files[] = sprintf(
addslashes('%s' . DIRECTORY_SEPARATOR),
$path
);
}
}
foreach ($filter->files() as $file) {
$files[] = $file->path();
}
return $files;
}
}
PK [/+ /+ # src/Util/TestDox/TestDoxPrinter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\TestDox;
use const PHP_EOL;
use function array_map;
use function get_class;
use function implode;
use function method_exists;
use function preg_split;
use function trim;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\Reorderable;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestResult;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Framework\Warning;
use PHPUnit\Runner\BaseTestRunner;
use PHPUnit\Runner\PhptTestCase;
use PHPUnit\TextUI\DefaultResultPrinter;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class TestDoxPrinter extends DefaultResultPrinter
{
/**
* @var NamePrettifier
*/
protected $prettifier;
/**
* @var int The number of test results received from the TestRunner
*/
protected $testIndex = 0;
/**
* @var int The number of test results already sent to the output
*/
protected $testFlushIndex = 0;
/**
* @var array Buffer for test results
*/
protected $testResults = [];
/**
* @var array Lookup table for testname to testResults[index]
*/
protected $testNameResultIndex = [];
/**
* @var bool
*/
protected $enableOutputBuffer = false;
/**
* @var array array
*/
protected $originalExecutionOrder = [];
/**
* @var int
*/
protected $spinState = 0;
/**
* @var bool
*/
protected $showProgress = true;
/**
* @param null|resource|string $out
* @param int|string $numberOfColumns
*
* @throws \PHPUnit\Framework\Exception
*/
public function __construct($out = null, bool $verbose = false, string $colors = self::COLOR_DEFAULT, bool $debug = false, $numberOfColumns = 80, bool $reverse = false)
{
parent::__construct($out, $verbose, $colors, $debug, $numberOfColumns, $reverse);
$this->prettifier = new NamePrettifier($this->colors);
}
public function setOriginalExecutionOrder(array $order): void
{
$this->originalExecutionOrder = $order;
$this->enableOutputBuffer = !empty($order);
}
public function setShowProgressAnimation(bool $showProgress): void
{
$this->showProgress = $showProgress;
}
public function printResult(TestResult $result): void
{
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function endTest(Test $test, float $time): void
{
if (!$test instanceof TestCase && !$test instanceof PhptTestCase && !$test instanceof TestSuite) {
return;
}
if ($this->testHasPassed()) {
$this->registerTestResult($test, null, BaseTestRunner::STATUS_PASSED, $time, false);
}
if ($test instanceof TestCase || $test instanceof PhptTestCase) {
$this->testIndex++;
}
parent::endTest($test, $time);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function addError(Test $test, Throwable $t, float $time): void
{
$this->registerTestResult($test, $t, BaseTestRunner::STATUS_ERROR, $time, true);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function addWarning(Test $test, Warning $e, float $time): void
{
$this->registerTestResult($test, $e, BaseTestRunner::STATUS_WARNING, $time, true);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function addFailure(Test $test, AssertionFailedError $e, float $time): void
{
$this->registerTestResult($test, $e, BaseTestRunner::STATUS_FAILURE, $time, true);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function addIncompleteTest(Test $test, Throwable $t, float $time): void
{
$this->registerTestResult($test, $t, BaseTestRunner::STATUS_INCOMPLETE, $time, false);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function addRiskyTest(Test $test, Throwable $t, float $time): void
{
$this->registerTestResult($test, $t, BaseTestRunner::STATUS_RISKY, $time, false);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function addSkippedTest(Test $test, Throwable $t, float $time): void
{
$this->registerTestResult($test, $t, BaseTestRunner::STATUS_SKIPPED, $time, false);
}
public function writeProgress(string $progress): void
{
$this->flushOutputBuffer();
}
public function flush(): void
{
$this->flushOutputBuffer(true);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function registerTestResult(Test $test, ?Throwable $t, int $status, float $time, bool $verbose): void
{
$testName = $test instanceof Reorderable ? $test->sortId() : $test->getName();
$result = [
'className' => $this->formatClassName($test),
'testName' => $testName,
'testMethod' => $this->formatTestName($test),
'message' => '',
'status' => $status,
'time' => $time,
'verbose' => $verbose,
];
if ($t !== null) {
$result['message'] = $this->formatTestResultMessage($t, $result);
}
$this->testResults[$this->testIndex] = $result;
$this->testNameResultIndex[$testName] = $this->testIndex;
}
protected function formatTestName(Test $test): string
{
return method_exists($test, 'getName') ? $test->getName() : '';
}
protected function formatClassName(Test $test): string
{
return get_class($test);
}
protected function testHasPassed(): bool
{
if (!isset($this->testResults[$this->testIndex]['status'])) {
return true;
}
if ($this->testResults[$this->testIndex]['status'] === BaseTestRunner::STATUS_PASSED) {
return true;
}
return false;
}
protected function flushOutputBuffer(bool $forceFlush = false): void
{
if ($this->testFlushIndex === $this->testIndex) {
return;
}
if ($this->testFlushIndex > 0) {
if ($this->enableOutputBuffer &&
isset($this->originalExecutionOrder[$this->testFlushIndex - 1])) {
$prevResult = $this->getTestResultByName($this->originalExecutionOrder[$this->testFlushIndex - 1]);
} else {
$prevResult = $this->testResults[$this->testFlushIndex - 1];
}
} else {
$prevResult = $this->getEmptyTestResult();
}
if (!$this->enableOutputBuffer) {
$this->writeTestResult($prevResult, $this->testResults[$this->testFlushIndex++]);
} else {
do {
$flushed = false;
if (!$forceFlush && isset($this->originalExecutionOrder[$this->testFlushIndex])) {
$result = $this->getTestResultByName($this->originalExecutionOrder[$this->testFlushIndex]);
} else {
// This test(name) cannot found in original execution order,
// flush result to output stream right away
$result = $this->testResults[$this->testFlushIndex];
}
if (!empty($result)) {
$this->hideSpinner();
$this->writeTestResult($prevResult, $result);
$this->testFlushIndex++;
$prevResult = $result;
$flushed = true;
} else {
$this->showSpinner();
}
} while ($flushed && $this->testFlushIndex < $this->testIndex);
}
}
protected function showSpinner(): void
{
if (!$this->showProgress) {
return;
}
if ($this->spinState) {
$this->undrawSpinner();
}
$this->spinState++;
$this->drawSpinner();
}
protected function hideSpinner(): void
{
if (!$this->showProgress) {
return;
}
if ($this->spinState) {
$this->undrawSpinner();
}
$this->spinState = 0;
}
protected function drawSpinner(): void
{
// optional for CLI printers: show the user a 'buffering output' spinner
}
protected function undrawSpinner(): void
{
// remove the spinner from the current line
}
protected function writeTestResult(array $prevResult, array $result): void
{
}
protected function getEmptyTestResult(): array
{
return [
'className' => '',
'testName' => '',
'message' => '',
'failed' => '',
'verbose' => '',
];
}
protected function getTestResultByName(?string $testName): array
{
if (isset($this->testNameResultIndex[$testName])) {
return $this->testResults[$this->testNameResultIndex[$testName]];
}
return [];
}
protected function formatThrowable(Throwable $t, ?int $status = null): string
{
$message = trim(\PHPUnit\Framework\TestFailure::exceptionToString($t));
if ($message) {
$message .= PHP_EOL . PHP_EOL . $this->formatStacktrace($t);
} else {
$message = $this->formatStacktrace($t);
}
return $message;
}
protected function formatStacktrace(Throwable $t): string
{
return \PHPUnit\Util\Filter::getFilteredStacktrace($t);
}
protected function formatTestResultMessage(Throwable $t, array $result, string $prefix = '│'): string
{
$message = $this->formatThrowable($t, $result['status']);
if ($message === '') {
return '';
}
if (!($this->verbose || $result['verbose'])) {
return '';
}
return $this->prefixLines($prefix, $message);
}
protected function prefixLines(string $prefix, string $message): string
{
$message = trim($message);
return implode(
PHP_EOL,
array_map(
static function (string $text) use ($prefix)
{
return ' ' . $prefix . ($text ? ' ' . $text : '');
},
preg_split('/\r\n|\r|\n/', $message)
)
);
}
}
PK [s,I
I
& src/Util/TestDox/HtmlResultPrinter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\TestDox;
use function sprintf;
use PHPUnit\Framework\TestResult;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class HtmlResultPrinter extends ResultPrinter
{
/**
* @var string
*/
private const PAGE_HEADER = <<<'EOT'
Test Documentation
EOT;
/**
* @var string
*/
private const CLASS_HEADER = <<<'EOT'
%s
EOT;
/**
* @var string
*/
private const CLASS_FOOTER = <<<'EOT'
EOT;
/**
* @var string
*/
private const PAGE_FOOTER = <<<'EOT'
EOT;
public function printResult(TestResult $result): void
{
}
/**
* Handler for 'start run' event.
*/
protected function startRun(): void
{
$this->write(self::PAGE_HEADER);
}
/**
* Handler for 'start class' event.
*/
protected function startClass(string $name): void
{
$this->write(
sprintf(
self::CLASS_HEADER,
$this->currentTestClassPrettified
)
);
}
/**
* Handler for 'on test' event.
*/
protected function onTest(string $name, bool $success = true): void
{
$this->write(
sprintf(
" %s\n",
$success ? 'success' : 'defect',
$name
)
);
}
/**
* Handler for 'end class' event.
*/
protected function endClass(string $name): void
{
$this->write(self::CLASS_FOOTER);
}
/**
* Handler for 'end run' event.
*/
protected function endRun(): void
{
$this->write(self::PAGE_FOOTER);
}
}
PK [{.- .- & src/Util/TestDox/CliTestDoxPrinter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\TestDox;
use const PHP_EOL;
use function array_map;
use function ceil;
use function count;
use function explode;
use function get_class;
use function implode;
use function preg_match;
use function sprintf;
use function strlen;
use function strpos;
use function trim;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestResult;
use PHPUnit\Runner\BaseTestRunner;
use PHPUnit\Runner\PhptTestCase;
use PHPUnit\Util\Color;
use SebastianBergmann\Timer\ResourceUsageFormatter;
use SebastianBergmann\Timer\Timer;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class CliTestDoxPrinter extends TestDoxPrinter
{
/**
* The default Testdox left margin for messages is a vertical line.
*/
private const PREFIX_SIMPLE = [
'default' => '│',
'start' => '│',
'message' => '│',
'diff' => '│',
'trace' => '│',
'last' => '│',
];
/**
* Colored Testdox use box-drawing for a more textured map of the message.
*/
private const PREFIX_DECORATED = [
'default' => '│',
'start' => '┐',
'message' => '├',
'diff' => '┊',
'trace' => '╵',
'last' => '┴',
];
private const SPINNER_ICONS = [
" \e[36m◐\e[0m running tests",
" \e[36m◓\e[0m running tests",
" \e[36m◑\e[0m running tests",
" \e[36m◒\e[0m running tests",
];
private const STATUS_STYLES = [
BaseTestRunner::STATUS_PASSED => [
'symbol' => '✔',
'color' => 'fg-green',
],
BaseTestRunner::STATUS_ERROR => [
'symbol' => '✘',
'color' => 'fg-yellow',
'message' => 'bg-yellow,fg-black',
],
BaseTestRunner::STATUS_FAILURE => [
'symbol' => '✘',
'color' => 'fg-red',
'message' => 'bg-red,fg-white',
],
BaseTestRunner::STATUS_SKIPPED => [
'symbol' => '↩',
'color' => 'fg-cyan',
'message' => 'fg-cyan',
],
BaseTestRunner::STATUS_RISKY => [
'symbol' => '☢',
'color' => 'fg-yellow',
'message' => 'fg-yellow',
],
BaseTestRunner::STATUS_INCOMPLETE => [
'symbol' => '∅',
'color' => 'fg-yellow',
'message' => 'fg-yellow',
],
BaseTestRunner::STATUS_WARNING => [
'symbol' => '⚠',
'color' => 'fg-yellow',
'message' => 'fg-yellow',
],
BaseTestRunner::STATUS_UNKNOWN => [
'symbol' => '?',
'color' => 'fg-blue',
'message' => 'fg-white,bg-blue',
],
];
/**
* @var int[]
*/
private $nonSuccessfulTestResults = [];
/**
* @var Timer
*/
private $timer;
/**
* @param null|resource|string $out
* @param int|string $numberOfColumns
*
* @throws \PHPUnit\Framework\Exception
*/
public function __construct($out = null, bool $verbose = false, string $colors = self::COLOR_DEFAULT, bool $debug = false, $numberOfColumns = 80, bool $reverse = false)
{
parent::__construct($out, $verbose, $colors, $debug, $numberOfColumns, $reverse);
$this->timer = new Timer;
$this->timer->start();
}
public function printResult(TestResult $result): void
{
$this->printHeader($result);
$this->printNonSuccessfulTestsSummary($result->count());
$this->printFooter($result);
}
protected function printHeader(TestResult $result): void
{
$this->write("\n" . (new ResourceUsageFormatter)->resourceUsage($this->timer->stop()) . "\n\n");
}
protected function formatClassName(Test $test): string
{
if ($test instanceof TestCase) {
return $this->prettifier->prettifyTestClass(get_class($test));
}
return get_class($test);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function registerTestResult(Test $test, ?Throwable $t, int $status, float $time, bool $verbose): void
{
if ($status !== BaseTestRunner::STATUS_PASSED) {
$this->nonSuccessfulTestResults[] = $this->testIndex;
}
parent::registerTestResult($test, $t, $status, $time, $verbose);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function formatTestName(Test $test): string
{
if ($test instanceof TestCase) {
return $this->prettifier->prettifyTestCase($test);
}
return parent::formatTestName($test);
}
protected function writeTestResult(array $prevResult, array $result): void
{
// spacer line for new suite headers and after verbose messages
if ($prevResult['testName'] !== '' &&
(!empty($prevResult['message']) || $prevResult['className'] !== $result['className'])) {
$this->write(PHP_EOL);
}
// suite header
if ($prevResult['className'] !== $result['className']) {
$this->write($this->colorizeTextBox('underlined', $result['className']) . PHP_EOL);
}
// test result line
if ($this->colors && $result['className'] === PhptTestCase::class) {
$testName = Color::colorizePath($result['testName'], $prevResult['testName'], true);
} else {
$testName = $result['testMethod'];
}
$style = self::STATUS_STYLES[$result['status']];
$line = sprintf(
' %s %s%s' . PHP_EOL,
$this->colorizeTextBox($style['color'], $style['symbol']),
$testName,
$this->verbose ? ' ' . $this->formatRuntime($result['time'], $style['color']) : ''
);
$this->write($line);
// additional information when verbose
$this->write($result['message']);
}
protected function formatThrowable(Throwable $t, ?int $status = null): string
{
return trim(\PHPUnit\Framework\TestFailure::exceptionToString($t));
}
protected function colorizeMessageAndDiff(string $style, string $buffer): array
{
$lines = $buffer ? array_map('\rtrim', explode(PHP_EOL, $buffer)) : [];
$message = [];
$diff = [];
$insideDiff = false;
foreach ($lines as $line) {
if ($line === '--- Expected') {
$insideDiff = true;
}
if (!$insideDiff) {
$message[] = $line;
} else {
if (strpos($line, '-') === 0) {
$line = Color::colorize('fg-red', Color::visualizeWhitespace($line, true));
} elseif (strpos($line, '+') === 0) {
$line = Color::colorize('fg-green', Color::visualizeWhitespace($line, true));
} elseif ($line === '@@ @@') {
$line = Color::colorize('fg-cyan', $line);
}
$diff[] = $line;
}
}
$diff = implode(PHP_EOL, $diff);
if (!empty($message)) {
$message = $this->colorizeTextBox($style, implode(PHP_EOL, $message));
}
return [$message, $diff];
}
protected function formatStacktrace(Throwable $t): string
{
$trace = \PHPUnit\Util\Filter::getFilteredStacktrace($t);
if (!$this->colors) {
return $trace;
}
$lines = [];
$prevPath = '';
foreach (explode(PHP_EOL, $trace) as $line) {
if (preg_match('/^(.*):(\d+)$/', $line, $matches)) {
$lines[] = Color::colorizePath($matches[1], $prevPath) .
Color::dim(':') .
Color::colorize('fg-blue', $matches[2]) .
"\n";
$prevPath = $matches[1];
} else {
$lines[] = $line;
$prevPath = '';
}
}
return implode('', $lines);
}
protected function formatTestResultMessage(Throwable $t, array $result, ?string $prefix = null): string
{
$message = $this->formatThrowable($t, $result['status']);
$diff = '';
if (!($this->verbose || $result['verbose'])) {
return '';
}
if ($message && $this->colors) {
$style = self::STATUS_STYLES[$result['status']]['message'] ?? '';
[$message, $diff] = $this->colorizeMessageAndDiff($style, $message);
}
if ($prefix === null || !$this->colors) {
$prefix = self::PREFIX_SIMPLE;
}
if ($this->colors) {
$color = self::STATUS_STYLES[$result['status']]['color'] ?? '';
$prefix = array_map(static function ($p) use ($color)
{
return Color::colorize($color, $p);
}, self::PREFIX_DECORATED);
}
$trace = $this->formatStacktrace($t);
$out = $this->prefixLines($prefix['start'], PHP_EOL) . PHP_EOL;
if ($message) {
$out .= $this->prefixLines($prefix['message'], $message . PHP_EOL) . PHP_EOL;
}
if ($diff) {
$out .= $this->prefixLines($prefix['diff'], $diff . PHP_EOL) . PHP_EOL;
}
if ($trace) {
if ($message || $diff) {
$out .= $this->prefixLines($prefix['default'], PHP_EOL) . PHP_EOL;
}
$out .= $this->prefixLines($prefix['trace'], $trace . PHP_EOL) . PHP_EOL;
}
$out .= $this->prefixLines($prefix['last'], PHP_EOL) . PHP_EOL;
return $out;
}
protected function drawSpinner(): void
{
if ($this->colors) {
$id = $this->spinState % count(self::SPINNER_ICONS);
$this->write(self::SPINNER_ICONS[$id]);
}
}
protected function undrawSpinner(): void
{
if ($this->colors) {
$id = $this->spinState % count(self::SPINNER_ICONS);
$this->write("\e[1K\e[" . strlen(self::SPINNER_ICONS[$id]) . 'D');
}
}
private function formatRuntime(float $time, string $color = ''): string
{
if (!$this->colors) {
return sprintf('[%.2f ms]', $time * 1000);
}
if ($time > 1) {
$color = 'fg-magenta';
}
return Color::colorize($color, ' ' . (int) ceil($time * 1000) . ' ' . Color::dim('ms'));
}
private function printNonSuccessfulTestsSummary(int $numberOfExecutedTests): void
{
if (empty($this->nonSuccessfulTestResults)) {
return;
}
if ((count($this->nonSuccessfulTestResults) / $numberOfExecutedTests) >= 0.7) {
return;
}
$this->write("Summary of non-successful tests:\n\n");
$prevResult = $this->getEmptyTestResult();
foreach ($this->nonSuccessfulTestResults as $testIndex) {
$result = $this->testResults[$testIndex];
$this->writeTestResult($prevResult, $result);
$prevResult = $result;
}
}
}
PK [5bS S " src/Util/TestDox/ResultPrinter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\TestDox;
use function get_class;
use function in_array;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\ErrorTestCase;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Framework\Warning;
use PHPUnit\Framework\WarningTestCase;
use PHPUnit\Runner\BaseTestRunner;
use PHPUnit\TextUI\ResultPrinter as ResultPrinterInterface;
use PHPUnit\Util\Printer;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
abstract class ResultPrinter extends Printer implements ResultPrinterInterface
{
/**
* @var NamePrettifier
*/
protected $prettifier;
/**
* @var string
*/
protected $testClass = '';
/**
* @var int
*/
protected $testStatus;
/**
* @var array
*/
protected $tests = [];
/**
* @var int
*/
protected $successful = 0;
/**
* @var int
*/
protected $warned = 0;
/**
* @var int
*/
protected $failed = 0;
/**
* @var int
*/
protected $risky = 0;
/**
* @var int
*/
protected $skipped = 0;
/**
* @var int
*/
protected $incomplete = 0;
/**
* @var null|string
*/
protected $currentTestClassPrettified;
/**
* @var null|string
*/
protected $currentTestMethodPrettified;
/**
* @var array
*/
private $groups;
/**
* @var array
*/
private $excludeGroups;
/**
* @param resource $out
*
* @throws \PHPUnit\Framework\Exception
*/
public function __construct($out = null, array $groups = [], array $excludeGroups = [])
{
parent::__construct($out);
$this->groups = $groups;
$this->excludeGroups = $excludeGroups;
$this->prettifier = new NamePrettifier;
$this->startRun();
}
/**
* Flush buffer and close output.
*/
public function flush(): void
{
$this->doEndClass();
$this->endRun();
parent::flush();
}
/**
* An error occurred.
*/
public function addError(Test $test, Throwable $t, float $time): void
{
if (!$this->isOfInterest($test)) {
return;
}
$this->testStatus = BaseTestRunner::STATUS_ERROR;
$this->failed++;
}
/**
* A warning occurred.
*/
public function addWarning(Test $test, Warning $e, float $time): void
{
if (!$this->isOfInterest($test)) {
return;
}
$this->testStatus = BaseTestRunner::STATUS_WARNING;
$this->warned++;
}
/**
* A failure occurred.
*/
public function addFailure(Test $test, AssertionFailedError $e, float $time): void
{
if (!$this->isOfInterest($test)) {
return;
}
$this->testStatus = BaseTestRunner::STATUS_FAILURE;
$this->failed++;
}
/**
* Incomplete test.
*/
public function addIncompleteTest(Test $test, Throwable $t, float $time): void
{
if (!$this->isOfInterest($test)) {
return;
}
$this->testStatus = BaseTestRunner::STATUS_INCOMPLETE;
$this->incomplete++;
}
/**
* Risky test.
*/
public function addRiskyTest(Test $test, Throwable $t, float $time): void
{
if (!$this->isOfInterest($test)) {
return;
}
$this->testStatus = BaseTestRunner::STATUS_RISKY;
$this->risky++;
}
/**
* Skipped test.
*/
public function addSkippedTest(Test $test, Throwable $t, float $time): void
{
if (!$this->isOfInterest($test)) {
return;
}
$this->testStatus = BaseTestRunner::STATUS_SKIPPED;
$this->skipped++;
}
/**
* A testsuite started.
*/
public function startTestSuite(TestSuite $suite): void
{
}
/**
* A testsuite ended.
*/
public function endTestSuite(TestSuite $suite): void
{
}
/**
* A test started.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function startTest(Test $test): void
{
if (!$this->isOfInterest($test)) {
return;
}
$class = get_class($test);
if ($this->testClass !== $class) {
if ($this->testClass !== '') {
$this->doEndClass();
}
$this->currentTestClassPrettified = $this->prettifier->prettifyTestClass($class);
$this->testClass = $class;
$this->tests = [];
$this->startClass($class);
}
if ($test instanceof TestCase) {
$this->currentTestMethodPrettified = $this->prettifier->prettifyTestCase($test);
}
$this->testStatus = BaseTestRunner::STATUS_PASSED;
}
/**
* A test ended.
*/
public function endTest(Test $test, float $time): void
{
if (!$this->isOfInterest($test)) {
return;
}
$this->tests[] = [$this->currentTestMethodPrettified, $this->testStatus];
$this->currentTestClassPrettified = null;
$this->currentTestMethodPrettified = null;
}
protected function doEndClass(): void
{
foreach ($this->tests as $test) {
$this->onTest($test[0], $test[1] === BaseTestRunner::STATUS_PASSED);
}
$this->endClass($this->testClass);
}
/**
* Handler for 'start run' event.
*/
protected function startRun(): void
{
}
/**
* Handler for 'start class' event.
*/
protected function startClass(string $name): void
{
}
/**
* Handler for 'on test' event.
*/
protected function onTest(string $name, bool $success = true): void
{
}
/**
* Handler for 'end class' event.
*/
protected function endClass(string $name): void
{
}
/**
* Handler for 'end run' event.
*/
protected function endRun(): void
{
}
private function isOfInterest(Test $test): bool
{
if (!$test instanceof TestCase) {
return false;
}
if ($test instanceof ErrorTestCase || $test instanceof WarningTestCase) {
return false;
}
if (!empty($this->groups)) {
foreach ($test->getGroups() as $group) {
if (in_array($group, $this->groups, true)) {
return true;
}
}
return false;
}
if (!empty($this->excludeGroups)) {
foreach ($test->getGroups() as $group) {
if (in_array($group, $this->excludeGroups, true)) {
return false;
}
}
return true;
}
return true;
}
}
PK [_D># ># # src/Util/TestDox/NamePrettifier.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\TestDox;
use function array_key_exists;
use function array_keys;
use function array_map;
use function array_pop;
use function array_values;
use function explode;
use function get_class;
use function gettype;
use function implode;
use function in_array;
use function is_bool;
use function is_float;
use function is_int;
use function is_numeric;
use function is_object;
use function is_scalar;
use function is_string;
use function ord;
use function preg_quote;
use function preg_replace;
use function range;
use function sprintf;
use function str_replace;
use function strlen;
use function strpos;
use function strtolower;
use function strtoupper;
use function substr;
use function trim;
use PHPUnit\Framework\TestCase;
use PHPUnit\Util\Color;
use PHPUnit\Util\Exception as UtilException;
use PHPUnit\Util\Test;
use ReflectionException;
use ReflectionMethod;
use ReflectionObject;
use SebastianBergmann\Exporter\Exporter;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class NamePrettifier
{
/**
* @var string[]
*/
private $strings = [];
/**
* @var bool
*/
private $useColor;
public function __construct(bool $useColor = false)
{
$this->useColor = $useColor;
}
/**
* Prettifies the name of a test class.
*
* @psalm-param class-string $className
*/
public function prettifyTestClass(string $className): string
{
try {
$annotations = Test::parseTestMethodAnnotations($className);
if (isset($annotations['class']['testdox'][0])) {
return $annotations['class']['testdox'][0];
}
} catch (UtilException $e) {
// ignore, determine className by parsing the provided name
}
$parts = explode('\\', $className);
$className = array_pop($parts);
if (substr($className, -1 * strlen('Test')) === 'Test') {
$className = substr($className, 0, strlen($className) - strlen('Test'));
}
if (strpos($className, 'Tests') === 0) {
$className = substr($className, strlen('Tests'));
} elseif (strpos($className, 'Test') === 0) {
$className = substr($className, strlen('Test'));
}
if (empty($className)) {
$className = 'UnnamedTests';
}
if (!empty($parts)) {
$parts[] = $className;
$fullyQualifiedName = implode('\\', $parts);
} else {
$fullyQualifiedName = $className;
}
$result = preg_replace('/(?<=[[:lower:]])(?=[[:upper:]])/u', ' ', $className);
if ($fullyQualifiedName !== $className) {
return $result . ' (' . $fullyQualifiedName . ')';
}
return $result;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function prettifyTestCase(TestCase $test): string
{
$annotations = Test::parseTestMethodAnnotations(
get_class($test),
$test->getName(false)
);
$annotationWithPlaceholders = false;
$callback = static function (string $variable): string
{
return sprintf('/%s(?=\b)/', preg_quote($variable, '/'));
};
if (isset($annotations['method']['testdox'][0])) {
$result = $annotations['method']['testdox'][0];
if (strpos($result, '$') !== false) {
$annotation = $annotations['method']['testdox'][0];
$providedData = $this->mapTestMethodParameterNamesToProvidedDataValues($test);
$variables = array_map($callback, array_keys($providedData));
$result = trim(preg_replace($variables, $providedData, $annotation));
$annotationWithPlaceholders = true;
}
} else {
$result = $this->prettifyTestMethod($test->getName(false));
}
if (!$annotationWithPlaceholders && $test->usesDataProvider()) {
$result .= $this->prettifyDataSet($test);
}
return $result;
}
public function prettifyDataSet(TestCase $test): string
{
if (!$this->useColor) {
return $test->getDataSetAsString(false);
}
if (is_int($test->dataName())) {
$data = Color::dim(' with data set ') . Color::colorize('fg-cyan', (string) $test->dataName());
} else {
$data = Color::dim(' with ') . Color::colorize('fg-cyan', Color::visualizeWhitespace((string) $test->dataName()));
}
return $data;
}
/**
* Prettifies the name of a test method.
*/
public function prettifyTestMethod(string $name): string
{
$buffer = '';
if ($name === '') {
return $buffer;
}
$string = (string) preg_replace('#\d+$#', '', $name, -1, $count);
if (in_array($string, $this->strings, true)) {
$name = $string;
} elseif ($count === 0) {
$this->strings[] = $string;
}
if (strpos($name, 'test_') === 0) {
$name = substr($name, 5);
} elseif (strpos($name, 'test') === 0) {
$name = substr($name, 4);
}
if ($name === '') {
return $buffer;
}
$name[0] = strtoupper($name[0]);
if (strpos($name, '_') !== false) {
return trim(str_replace('_', ' ', $name));
}
$wasNumeric = false;
foreach (range(0, strlen($name) - 1) as $i) {
if ($i > 0 && ord($name[$i]) >= 65 && ord($name[$i]) <= 90) {
$buffer .= ' ' . strtolower($name[$i]);
} else {
$isNumeric = is_numeric($name[$i]);
if (!$wasNumeric && $isNumeric) {
$buffer .= ' ';
$wasNumeric = true;
}
if ($wasNumeric && !$isNumeric) {
$wasNumeric = false;
}
$buffer .= $name[$i];
}
}
return $buffer;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function mapTestMethodParameterNamesToProvidedDataValues(TestCase $test): array
{
try {
$reflector = new ReflectionMethod(get_class($test), $test->getName(false));
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new UtilException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$providedData = [];
$providedDataValues = array_values($test->getProvidedData());
$i = 0;
$providedData['$_dataName'] = $test->dataName();
foreach ($reflector->getParameters() as $parameter) {
if (!array_key_exists($i, $providedDataValues) && $parameter->isDefaultValueAvailable()) {
try {
$providedDataValues[$i] = $parameter->getDefaultValue();
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new UtilException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
}
$value = $providedDataValues[$i++] ?? null;
if (is_object($value)) {
$reflector = new ReflectionObject($value);
if ($reflector->hasMethod('__toString')) {
$value = (string) $value;
} else {
$value = get_class($value);
}
}
if (!is_scalar($value)) {
$value = gettype($value);
}
if (is_bool($value) || is_int($value) || is_float($value)) {
$value = (new Exporter)->export($value);
}
if (is_string($value) && $value === '') {
if ($this->useColor) {
$value = Color::colorize('dim,underlined', 'empty');
} else {
$value = "''";
}
}
$providedData['$' . $parameter->getName()] = $value;
}
if ($this->useColor) {
$providedData = array_map(static function ($value)
{
return Color::colorize('fg-cyan', Color::visualizeWhitespace((string) $value, true));
}, $providedData);
}
return $providedData;
}
}
PK [(/ % src/Util/TestDox/XmlResultPrinter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\TestDox;
use function array_filter;
use function get_class;
use function implode;
use function strpos;
use DOMDocument;
use DOMElement;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\Exception;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestListener;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Framework\Warning;
use PHPUnit\Framework\WarningTestCase;
use PHPUnit\Util\Printer;
use PHPUnit\Util\Test as TestUtil;
use ReflectionClass;
use ReflectionException;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class XmlResultPrinter extends Printer implements TestListener
{
/**
* @var DOMDocument
*/
private $document;
/**
* @var DOMElement
*/
private $root;
/**
* @var NamePrettifier
*/
private $prettifier;
/**
* @var null|Throwable
*/
private $exception;
/**
* @param resource|string $out
*
* @throws Exception
*/
public function __construct($out = null)
{
$this->document = new DOMDocument('1.0', 'UTF-8');
$this->document->formatOutput = true;
$this->root = $this->document->createElement('tests');
$this->document->appendChild($this->root);
$this->prettifier = new NamePrettifier;
parent::__construct($out);
}
/**
* Flush buffer and close output.
*/
public function flush(): void
{
$this->write($this->document->saveXML());
parent::flush();
}
/**
* An error occurred.
*/
public function addError(Test $test, Throwable $t, float $time): void
{
$this->exception = $t;
}
/**
* A warning occurred.
*/
public function addWarning(Test $test, Warning $e, float $time): void
{
}
/**
* A failure occurred.
*/
public function addFailure(Test $test, AssertionFailedError $e, float $time): void
{
$this->exception = $e;
}
/**
* Incomplete test.
*/
public function addIncompleteTest(Test $test, Throwable $t, float $time): void
{
}
/**
* Risky test.
*/
public function addRiskyTest(Test $test, Throwable $t, float $time): void
{
}
/**
* Skipped test.
*/
public function addSkippedTest(Test $test, Throwable $t, float $time): void
{
}
/**
* A test suite started.
*/
public function startTestSuite(TestSuite $suite): void
{
}
/**
* A test suite ended.
*/
public function endTestSuite(TestSuite $suite): void
{
}
/**
* A test started.
*/
public function startTest(Test $test): void
{
$this->exception = null;
}
/**
* A test ended.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function endTest(Test $test, float $time): void
{
if (!$test instanceof TestCase || $test instanceof WarningTestCase) {
return;
}
$groups = array_filter(
$test->getGroups(),
static function ($group)
{
return !($group === 'small' || $group === 'medium' || $group === 'large' || strpos($group, '__phpunit_') === 0);
}
);
$testNode = $this->document->createElement('test');
$testNode->setAttribute('className', get_class($test));
$testNode->setAttribute('methodName', $test->getName());
$testNode->setAttribute('prettifiedClassName', $this->prettifier->prettifyTestClass(get_class($test)));
$testNode->setAttribute('prettifiedMethodName', $this->prettifier->prettifyTestCase($test));
$testNode->setAttribute('status', (string) $test->getStatus());
$testNode->setAttribute('time', (string) $time);
$testNode->setAttribute('size', (string) $test->getSize());
$testNode->setAttribute('groups', implode(',', $groups));
foreach ($groups as $group) {
$groupNode = $this->document->createElement('group');
$groupNode->setAttribute('name', $group);
$testNode->appendChild($groupNode);
}
$annotations = TestUtil::parseTestMethodAnnotations(
get_class($test),
$test->getName(false)
);
foreach (['class', 'method'] as $type) {
foreach ($annotations[$type] as $annotation => $values) {
if ($annotation !== 'covers' && $annotation !== 'uses') {
continue;
}
foreach ($values as $value) {
$coversNode = $this->document->createElement($annotation);
$coversNode->setAttribute('target', $value);
$testNode->appendChild($coversNode);
}
}
}
foreach ($test->doubledTypes() as $doubledType) {
$testDoubleNode = $this->document->createElement('testDouble');
$testDoubleNode->setAttribute('type', $doubledType);
$testNode->appendChild($testDoubleNode);
}
$inlineAnnotations = \PHPUnit\Util\Test::getInlineAnnotations(get_class($test), $test->getName(false));
if (isset($inlineAnnotations['given'], $inlineAnnotations['when'], $inlineAnnotations['then'])) {
$testNode->setAttribute('given', $inlineAnnotations['given']['value']);
$testNode->setAttribute('givenStartLine', (string) $inlineAnnotations['given']['line']);
$testNode->setAttribute('when', $inlineAnnotations['when']['value']);
$testNode->setAttribute('whenStartLine', (string) $inlineAnnotations['when']['line']);
$testNode->setAttribute('then', $inlineAnnotations['then']['value']);
$testNode->setAttribute('thenStartLine', (string) $inlineAnnotations['then']['line']);
}
if ($this->exception !== null) {
if ($this->exception instanceof Exception) {
$steps = $this->exception->getSerializableTrace();
} else {
$steps = $this->exception->getTrace();
}
try {
$file = (new ReflectionClass($test))->getFileName();
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
foreach ($steps as $step) {
if (isset($step['file']) && $step['file'] === $file) {
$testNode->setAttribute('exceptionLine', (string) $step['line']);
break;
}
}
$testNode->setAttribute('exceptionMessage', $this->exception->getMessage());
}
$this->root->appendChild($testNode);
}
}
PK [w & src/Util/TestDox/TextResultPrinter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\TestDox;
use PHPUnit\Framework\TestResult;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TextResultPrinter extends ResultPrinter
{
public function printResult(TestResult $result): void
{
}
/**
* Handler for 'start class' event.
*/
protected function startClass(string $name): void
{
$this->write($this->currentTestClassPrettified . "\n");
}
/**
* Handler for 'on test' event.
*/
protected function onTest(string $name, bool $success = true): void
{
if ($success) {
$this->write(' [x] ');
} else {
$this->write(' [ ] ');
}
$this->write($name . "\n");
}
/**
* Handler for 'end class' event.
*/
protected function endClass(string $name): void
{
$this->write("\n");
}
}
PK [ \Y src/Util/Cloner.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Cloner
{
/**
* @psalm-template OriginalType
*
* @psalm-param OriginalType $original
*
* @psalm-return OriginalType
*/
public static function clone(object $original): object
{
try {
return clone $original;
} catch (Throwable $t) {
return $original;
}
}
}
PK [,u~G) G) src/Util/Log/TeamCity.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Log;
use function class_exists;
use function count;
use function explode;
use function get_class;
use function getmypid;
use function ini_get;
use function is_bool;
use function is_scalar;
use function method_exists;
use function print_r;
use function round;
use function str_replace;
use function stripos;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\ExceptionWrapper;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestFailure;
use PHPUnit\Framework\TestResult;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Framework\Warning;
use PHPUnit\TextUI\DefaultResultPrinter;
use PHPUnit\Util\Exception;
use PHPUnit\Util\Filter;
use ReflectionClass;
use ReflectionException;
use SebastianBergmann\Comparator\ComparisonFailure;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TeamCity extends DefaultResultPrinter
{
/**
* @var bool
*/
private $isSummaryTestCountPrinted = false;
/**
* @var string
*/
private $startedTestName;
/**
* @var false|int
*/
private $flowId;
public function printResult(TestResult $result): void
{
$this->printHeader($result);
$this->printFooter($result);
}
/**
* An error occurred.
*/
public function addError(Test $test, Throwable $t, float $time): void
{
$this->printEvent(
'testFailed',
[
'name' => $test->getName(),
'message' => self::getMessage($t),
'details' => self::getDetails($t),
'duration' => self::toMilliseconds($time),
]
);
}
/**
* A warning occurred.
*/
public function addWarning(Test $test, Warning $e, float $time): void
{
$this->write(self::getMessage($e) . PHP_EOL);
}
/**
* A failure occurred.
*/
public function addFailure(Test $test, AssertionFailedError $e, float $time): void
{
$parameters = [
'name' => $test->getName(),
'message' => self::getMessage($e),
'details' => self::getDetails($e),
'duration' => self::toMilliseconds($time),
];
if ($e instanceof ExpectationFailedException) {
$comparisonFailure = $e->getComparisonFailure();
if ($comparisonFailure instanceof ComparisonFailure) {
$expectedString = $comparisonFailure->getExpectedAsString();
if ($expectedString === null || empty($expectedString)) {
$expectedString = self::getPrimitiveValueAsString($comparisonFailure->getExpected());
}
$actualString = $comparisonFailure->getActualAsString();
if ($actualString === null || empty($actualString)) {
$actualString = self::getPrimitiveValueAsString($comparisonFailure->getActual());
}
if ($actualString !== null && $expectedString !== null) {
$parameters['type'] = 'comparisonFailure';
$parameters['actual'] = $actualString;
$parameters['expected'] = $expectedString;
}
}
}
$this->printEvent('testFailed', $parameters);
}
/**
* Incomplete test.
*/
public function addIncompleteTest(Test $test, Throwable $t, float $time): void
{
$this->printIgnoredTest($test->getName(), $t, $time);
}
/**
* Risky test.
*/
public function addRiskyTest(Test $test, Throwable $t, float $time): void
{
$this->addError($test, $t, $time);
}
/**
* Skipped test.
*/
public function addSkippedTest(Test $test, Throwable $t, float $time): void
{
$testName = $test->getName();
if ($this->startedTestName !== $testName) {
$this->startTest($test);
$this->printIgnoredTest($testName, $t, $time);
$this->endTest($test, $time);
} else {
$this->printIgnoredTest($testName, $t, $time);
}
}
public function printIgnoredTest(string $testName, Throwable $t, float $time): void
{
$this->printEvent(
'testIgnored',
[
'name' => $testName,
'message' => self::getMessage($t),
'details' => self::getDetails($t),
'duration' => self::toMilliseconds($time),
]
);
}
/**
* A testsuite started.
*/
public function startTestSuite(TestSuite $suite): void
{
if (stripos(ini_get('disable_functions'), 'getmypid') === false) {
$this->flowId = getmypid();
} else {
$this->flowId = false;
}
if (!$this->isSummaryTestCountPrinted) {
$this->isSummaryTestCountPrinted = true;
$this->printEvent(
'testCount',
['count' => count($suite)]
);
}
$suiteName = $suite->getName();
if (empty($suiteName)) {
return;
}
$parameters = ['name' => $suiteName];
if (class_exists($suiteName, false)) {
$fileName = self::getFileName($suiteName);
$parameters['locationHint'] = "php_qn://{$fileName}::\\{$suiteName}";
} else {
$split = explode('::', $suiteName);
if (count($split) === 2 && class_exists($split[0]) && method_exists($split[0], $split[1])) {
$fileName = self::getFileName($split[0]);
$parameters['locationHint'] = "php_qn://{$fileName}::\\{$suiteName}";
$parameters['name'] = $split[1];
}
}
$this->printEvent('testSuiteStarted', $parameters);
}
/**
* A testsuite ended.
*/
public function endTestSuite(TestSuite $suite): void
{
$suiteName = $suite->getName();
if (empty($suiteName)) {
return;
}
$parameters = ['name' => $suiteName];
if (!class_exists($suiteName, false)) {
$split = explode('::', $suiteName);
if (count($split) === 2 && class_exists($split[0]) && method_exists($split[0], $split[1])) {
$parameters['name'] = $split[1];
}
}
$this->printEvent('testSuiteFinished', $parameters);
}
/**
* A test started.
*/
public function startTest(Test $test): void
{
$testName = $test->getName();
$this->startedTestName = $testName;
$params = ['name' => $testName];
if ($test instanceof TestCase) {
$className = get_class($test);
$fileName = self::getFileName($className);
$params['locationHint'] = "php_qn://{$fileName}::\\{$className}::{$testName}";
}
$this->printEvent('testStarted', $params);
}
/**
* A test ended.
*/
public function endTest(Test $test, float $time): void
{
parent::endTest($test, $time);
$this->printEvent(
'testFinished',
[
'name' => $test->getName(),
'duration' => self::toMilliseconds($time),
]
);
}
protected function writeProgress(string $progress): void
{
}
private function printEvent(string $eventName, array $params = []): void
{
$this->write("\n##teamcity[{$eventName}");
if ($this->flowId) {
$params['flowId'] = $this->flowId;
}
foreach ($params as $key => $value) {
$escapedValue = self::escapeValue((string) $value);
$this->write(" {$key}='{$escapedValue}'");
}
$this->write("]\n");
}
private static function getMessage(Throwable $t): string
{
$message = '';
if ($t instanceof ExceptionWrapper) {
if ($t->getClassName() !== '') {
$message .= $t->getClassName();
}
if ($message !== '' && $t->getMessage() !== '') {
$message .= ' : ';
}
}
return $message . $t->getMessage();
}
private static function getDetails(Throwable $t): string
{
$stackTrace = Filter::getFilteredStacktrace($t);
$previous = $t instanceof ExceptionWrapper ? $t->getPreviousWrapped() : $t->getPrevious();
while ($previous) {
$stackTrace .= "\nCaused by\n" .
TestFailure::exceptionToString($previous) . "\n" .
Filter::getFilteredStacktrace($previous);
$previous = $previous instanceof ExceptionWrapper ?
$previous->getPreviousWrapped() : $previous->getPrevious();
}
return ' ' . str_replace("\n", "\n ", $stackTrace);
}
private static function getPrimitiveValueAsString($value): ?string
{
if ($value === null) {
return 'null';
}
if (is_bool($value)) {
return $value ? 'true' : 'false';
}
if (is_scalar($value)) {
return print_r($value, true);
}
return null;
}
private static function escapeValue(string $text): string
{
return str_replace(
['|', "'", "\n", "\r", ']', '['],
['||', "|'", '|n', '|r', '|]', '|['],
$text
);
}
/**
* @param string $className
*/
private static function getFileName($className): string
{
try {
return (new ReflectionClass($className))->getFileName();
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
}
/**
* @param float $time microseconds
*/
private static function toMilliseconds(float $time): int
{
return (int) round($time * 1000);
}
}
PK [Fk- - src/Util/Log/JUnit.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Log;
use function class_exists;
use function get_class;
use function method_exists;
use function sprintf;
use function str_replace;
use function trim;
use DOMDocument;
use DOMElement;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\ExceptionWrapper;
use PHPUnit\Framework\SelfDescribing;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestFailure;
use PHPUnit\Framework\TestListener;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Framework\Warning;
use PHPUnit\Util\Exception;
use PHPUnit\Util\Filter;
use PHPUnit\Util\Printer;
use PHPUnit\Util\Xml;
use ReflectionClass;
use ReflectionException;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class JUnit extends Printer implements TestListener
{
/**
* @var DOMDocument
*/
private $document;
/**
* @var DOMElement
*/
private $root;
/**
* @var bool
*/
private $reportRiskyTests = false;
/**
* @var DOMElement[]
*/
private $testSuites = [];
/**
* @var int[]
*/
private $testSuiteTests = [0];
/**
* @var int[]
*/
private $testSuiteAssertions = [0];
/**
* @var int[]
*/
private $testSuiteErrors = [0];
/**
* @var int[]
*/
private $testSuiteWarnings = [0];
/**
* @var int[]
*/
private $testSuiteFailures = [0];
/**
* @var int[]
*/
private $testSuiteSkipped = [0];
/**
* @var int[]
*/
private $testSuiteTimes = [0];
/**
* @var int
*/
private $testSuiteLevel = 0;
/**
* @var DOMElement
*/
private $currentTestCase;
/**
* @param null|mixed $out
*/
public function __construct($out = null, bool $reportRiskyTests = false)
{
$this->document = new DOMDocument('1.0', 'UTF-8');
$this->document->formatOutput = true;
$this->root = $this->document->createElement('testsuites');
$this->document->appendChild($this->root);
parent::__construct($out);
$this->reportRiskyTests = $reportRiskyTests;
}
/**
* Flush buffer and close output.
*/
public function flush(): void
{
$this->write($this->getXML());
parent::flush();
}
/**
* An error occurred.
*/
public function addError(Test $test, Throwable $t, float $time): void
{
$this->doAddFault($test, $t, 'error');
$this->testSuiteErrors[$this->testSuiteLevel]++;
}
/**
* A warning occurred.
*/
public function addWarning(Test $test, Warning $e, float $time): void
{
$this->doAddFault($test, $e, 'warning');
$this->testSuiteWarnings[$this->testSuiteLevel]++;
}
/**
* A failure occurred.
*/
public function addFailure(Test $test, AssertionFailedError $e, float $time): void
{
$this->doAddFault($test, $e, 'failure');
$this->testSuiteFailures[$this->testSuiteLevel]++;
}
/**
* Incomplete test.
*/
public function addIncompleteTest(Test $test, Throwable $t, float $time): void
{
$this->doAddSkipped();
}
/**
* Risky test.
*/
public function addRiskyTest(Test $test, Throwable $t, float $time): void
{
if (!$this->reportRiskyTests) {
return;
}
$this->doAddFault($test, $t, 'error');
$this->testSuiteErrors[$this->testSuiteLevel]++;
}
/**
* Skipped test.
*/
public function addSkippedTest(Test $test, Throwable $t, float $time): void
{
$this->doAddSkipped();
}
/**
* A testsuite started.
*/
public function startTestSuite(TestSuite $suite): void
{
$testSuite = $this->document->createElement('testsuite');
$testSuite->setAttribute('name', $suite->getName());
if (class_exists($suite->getName(), false)) {
try {
$class = new ReflectionClass($suite->getName());
$testSuite->setAttribute('file', $class->getFileName());
} catch (ReflectionException $e) {
}
}
if ($this->testSuiteLevel > 0) {
$this->testSuites[$this->testSuiteLevel]->appendChild($testSuite);
} else {
$this->root->appendChild($testSuite);
}
$this->testSuiteLevel++;
$this->testSuites[$this->testSuiteLevel] = $testSuite;
$this->testSuiteTests[$this->testSuiteLevel] = 0;
$this->testSuiteAssertions[$this->testSuiteLevel] = 0;
$this->testSuiteErrors[$this->testSuiteLevel] = 0;
$this->testSuiteWarnings[$this->testSuiteLevel] = 0;
$this->testSuiteFailures[$this->testSuiteLevel] = 0;
$this->testSuiteSkipped[$this->testSuiteLevel] = 0;
$this->testSuiteTimes[$this->testSuiteLevel] = 0;
}
/**
* A testsuite ended.
*/
public function endTestSuite(TestSuite $suite): void
{
$this->testSuites[$this->testSuiteLevel]->setAttribute(
'tests',
(string) $this->testSuiteTests[$this->testSuiteLevel]
);
$this->testSuites[$this->testSuiteLevel]->setAttribute(
'assertions',
(string) $this->testSuiteAssertions[$this->testSuiteLevel]
);
$this->testSuites[$this->testSuiteLevel]->setAttribute(
'errors',
(string) $this->testSuiteErrors[$this->testSuiteLevel]
);
$this->testSuites[$this->testSuiteLevel]->setAttribute(
'warnings',
(string) $this->testSuiteWarnings[$this->testSuiteLevel]
);
$this->testSuites[$this->testSuiteLevel]->setAttribute(
'failures',
(string) $this->testSuiteFailures[$this->testSuiteLevel]
);
$this->testSuites[$this->testSuiteLevel]->setAttribute(
'skipped',
(string) $this->testSuiteSkipped[$this->testSuiteLevel]
);
$this->testSuites[$this->testSuiteLevel]->setAttribute(
'time',
sprintf('%F', $this->testSuiteTimes[$this->testSuiteLevel])
);
if ($this->testSuiteLevel > 1) {
$this->testSuiteTests[$this->testSuiteLevel - 1] += $this->testSuiteTests[$this->testSuiteLevel];
$this->testSuiteAssertions[$this->testSuiteLevel - 1] += $this->testSuiteAssertions[$this->testSuiteLevel];
$this->testSuiteErrors[$this->testSuiteLevel - 1] += $this->testSuiteErrors[$this->testSuiteLevel];
$this->testSuiteWarnings[$this->testSuiteLevel - 1] += $this->testSuiteWarnings[$this->testSuiteLevel];
$this->testSuiteFailures[$this->testSuiteLevel - 1] += $this->testSuiteFailures[$this->testSuiteLevel];
$this->testSuiteSkipped[$this->testSuiteLevel - 1] += $this->testSuiteSkipped[$this->testSuiteLevel];
$this->testSuiteTimes[$this->testSuiteLevel - 1] += $this->testSuiteTimes[$this->testSuiteLevel];
}
$this->testSuiteLevel--;
}
/**
* A test started.
*/
public function startTest(Test $test): void
{
$usesDataprovider = false;
if (method_exists($test, 'usesDataProvider')) {
$usesDataprovider = $test->usesDataProvider();
}
$testCase = $this->document->createElement('testcase');
$testCase->setAttribute('name', $test->getName());
try {
$class = new ReflectionClass($test);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$methodName = $test->getName(!$usesDataprovider);
if ($class->hasMethod($methodName)) {
try {
$method = $class->getMethod($methodName);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$testCase->setAttribute('class', $class->getName());
$testCase->setAttribute('classname', str_replace('\\', '.', $class->getName()));
$testCase->setAttribute('file', $class->getFileName());
$testCase->setAttribute('line', (string) $method->getStartLine());
}
$this->currentTestCase = $testCase;
}
/**
* A test ended.
*/
public function endTest(Test $test, float $time): void
{
$numAssertions = 0;
if (method_exists($test, 'getNumAssertions')) {
$numAssertions = $test->getNumAssertions();
}
$this->testSuiteAssertions[$this->testSuiteLevel] += $numAssertions;
$this->currentTestCase->setAttribute(
'assertions',
(string) $numAssertions
);
$this->currentTestCase->setAttribute(
'time',
sprintf('%F', $time)
);
$this->testSuites[$this->testSuiteLevel]->appendChild(
$this->currentTestCase
);
$this->testSuiteTests[$this->testSuiteLevel]++;
$this->testSuiteTimes[$this->testSuiteLevel] += $time;
$testOutput = '';
if (method_exists($test, 'hasOutput') && method_exists($test, 'getActualOutput')) {
$testOutput = $test->hasOutput() ? $test->getActualOutput() : '';
}
if (!empty($testOutput)) {
$systemOut = $this->document->createElement(
'system-out',
Xml::prepareString($testOutput)
);
$this->currentTestCase->appendChild($systemOut);
}
$this->currentTestCase = null;
}
/**
* Returns the XML as a string.
*/
public function getXML(): string
{
return $this->document->saveXML();
}
private function doAddFault(Test $test, Throwable $t, string $type): void
{
if ($this->currentTestCase === null) {
return;
}
if ($test instanceof SelfDescribing) {
$buffer = $test->toString() . "\n";
} else {
$buffer = '';
}
$buffer .= trim(
TestFailure::exceptionToString($t) . "\n" .
Filter::getFilteredStacktrace($t)
);
$fault = $this->document->createElement(
$type,
Xml::prepareString($buffer)
);
if ($t instanceof ExceptionWrapper) {
$fault->setAttribute('type', $t->getClassName());
} else {
$fault->setAttribute('type', get_class($t));
}
$this->currentTestCase->appendChild($fault);
}
private function doAddSkipped(): void
{
if ($this->currentTestCase === null) {
return;
}
$skipped = $this->document->createElement('skipped');
$this->currentTestCase->appendChild($skipped);
$this->testSuiteSkipped[$this->testSuiteLevel]++;
}
}
PK [4/
src/Util/XmlTestListRenderer.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use function get_class;
use function implode;
use function str_replace;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Runner\PhptTestCase;
use RecursiveIteratorIterator;
use XMLWriter;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class XmlTestListRenderer
{
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function render(TestSuite $suite): string
{
$writer = new XMLWriter;
$writer->openMemory();
$writer->setIndent(true);
$writer->startDocument('1.0', 'UTF-8');
$writer->startElement('tests');
$currentTestCase = null;
foreach (new RecursiveIteratorIterator($suite->getIterator()) as $test) {
if ($test instanceof TestCase) {
if (get_class($test) !== $currentTestCase) {
if ($currentTestCase !== null) {
$writer->endElement();
}
$writer->startElement('testCaseClass');
$writer->writeAttribute('name', get_class($test));
$currentTestCase = get_class($test);
}
$writer->startElement('testCaseMethod');
$writer->writeAttribute('name', $test->getName(false));
$writer->writeAttribute('groups', implode(',', $test->getGroups()));
if (!empty($test->getDataSetAsString(false))) {
$writer->writeAttribute(
'dataSet',
str_replace(
' with data set ',
'',
$test->getDataSetAsString(false)
)
);
}
$writer->endElement();
} elseif ($test instanceof PhptTestCase) {
if ($currentTestCase !== null) {
$writer->endElement();
$currentTestCase = null;
}
$writer->startElement('phptFile');
$writer->writeAttribute('path', $test->getName());
$writer->endElement();
}
}
if ($currentTestCase !== null) {
$writer->endElement();
}
$writer->endElement();
$writer->endDocument();
return $writer->outputMemory();
}
}
PK [X $ src/Util/InvalidDataSetException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvalidDataSetException extends RuntimeException implements \PHPUnit\Exception
{
}
PK [o src/Util/Reflection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use PHPUnit\Framework\Assert;
use PHPUnit\Framework\TestCase;
use ReflectionClass;
use ReflectionMethod;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Reflection
{
/**
* @psalm-return list
*/
public function publicMethodsInTestClass(ReflectionClass $class): array
{
return $this->filterMethods($class, ReflectionMethod::IS_PUBLIC);
}
/**
* @psalm-return list
*/
public function methodsInTestClass(ReflectionClass $class): array
{
return $this->filterMethods($class, null);
}
/**
* @psalm-return list
*/
private function filterMethods(ReflectionClass $class, ?int $filter): array
{
$methods = [];
// PHP <7.3.5 throw error when null is passed
// to ReflectionClass::getMethods() when strict_types is enabled.
$classMethods = $filter === null ? $class->getMethods() : $class->getMethods($filter);
foreach ($classMethods as $method) {
if ($method->getDeclaringClass()->getName() === TestCase::class) {
continue;
}
if ($method->getDeclaringClass()->getName() === Assert::class) {
continue;
}
$methods[] = $method;
}
return $methods;
}
}
PK [(3E src/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface Exception extends Throwable
{
}
PK [*E % src/Runner/DefaultTestResultCache.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use const DIRECTORY_SEPARATOR;
use const LOCK_EX;
use function assert;
use function dirname;
use function file_get_contents;
use function file_put_contents;
use function in_array;
use function is_array;
use function is_dir;
use function is_file;
use function json_decode;
use function json_encode;
use function sprintf;
use PHPUnit\Util\Filesystem;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class DefaultTestResultCache implements TestResultCache
{
/**
* @var int
*/
private const VERSION = 1;
/**
* @psalm-var list
*/
private const ALLOWED_TEST_STATUSES = [
BaseTestRunner::STATUS_SKIPPED,
BaseTestRunner::STATUS_INCOMPLETE,
BaseTestRunner::STATUS_FAILURE,
BaseTestRunner::STATUS_ERROR,
BaseTestRunner::STATUS_RISKY,
BaseTestRunner::STATUS_WARNING,
];
/**
* @var string
*/
private const DEFAULT_RESULT_CACHE_FILENAME = '.phpunit.result.cache';
/**
* @var string
*/
private $cacheFilename;
/**
* @psalm-var array
*/
private $defects = [];
/**
* @psalm-var array
*/
private $times = [];
public function __construct(?string $filepath = null)
{
if ($filepath !== null && is_dir($filepath)) {
$filepath .= DIRECTORY_SEPARATOR . self::DEFAULT_RESULT_CACHE_FILENAME;
}
$this->cacheFilename = $filepath ?? $_ENV['PHPUNIT_RESULT_CACHE'] ?? self::DEFAULT_RESULT_CACHE_FILENAME;
}
public function setState(string $testName, int $state): void
{
if (!in_array($state, self::ALLOWED_TEST_STATUSES, true)) {
return;
}
$this->defects[$testName] = $state;
}
public function getState(string $testName): int
{
return $this->defects[$testName] ?? BaseTestRunner::STATUS_UNKNOWN;
}
public function setTime(string $testName, float $time): void
{
$this->times[$testName] = $time;
}
public function getTime(string $testName): float
{
return $this->times[$testName] ?? 0.0;
}
public function load(): void
{
if (!is_file($this->cacheFilename)) {
return;
}
$data = json_decode(
file_get_contents($this->cacheFilename),
true
);
if ($data === null) {
return;
}
if (!isset($data['version'])) {
return;
}
if ($data['version'] !== self::VERSION) {
return;
}
assert(isset($data['defects']) && is_array($data['defects']));
assert(isset($data['times']) && is_array($data['times']));
$this->defects = $data['defects'];
$this->times = $data['times'];
}
/**
* @throws Exception
*/
public function persist(): void
{
if (!Filesystem::createDirectory(dirname($this->cacheFilename))) {
throw new Exception(
sprintf(
'Cannot create directory "%s" for result cache file',
$this->cacheFilename
)
);
}
file_put_contents(
$this->cacheFilename,
json_encode(
[
'version' => self::VERSION,
'defects' => $this->defects,
'times' => $this->times,
]
),
LOCK_EX
);
}
}
PK [DT^ T^ src/Runner/PhptTestCase.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use const DEBUG_BACKTRACE_IGNORE_ARGS;
use const DIRECTORY_SEPARATOR;
use function array_merge;
use function basename;
use function debug_backtrace;
use function defined;
use function dirname;
use function explode;
use function extension_loaded;
use function file;
use function file_get_contents;
use function file_put_contents;
use function is_array;
use function is_file;
use function is_readable;
use function is_string;
use function ltrim;
use function phpversion;
use function preg_match;
use function preg_replace;
use function preg_split;
use function realpath;
use function rtrim;
use function sprintf;
use function str_replace;
use function strncasecmp;
use function strpos;
use function substr;
use function trim;
use function unlink;
use function unserialize;
use function var_export;
use function version_compare;
use PHPUnit\Framework\Assert;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\ExecutionOrderDependency;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\IncompleteTestError;
use PHPUnit\Framework\PHPTAssertionFailedError;
use PHPUnit\Framework\Reorderable;
use PHPUnit\Framework\SelfDescribing;
use PHPUnit\Framework\SkippedTestError;
use PHPUnit\Framework\SyntheticSkippedError;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestResult;
use PHPUnit\Util\PHP\AbstractPhpProcess;
use SebastianBergmann\CodeCoverage\RawCodeCoverageData;
use SebastianBergmann\Template\Template;
use SebastianBergmann\Timer\Timer;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class PhptTestCase implements Reorderable, SelfDescribing, Test
{
/**
* @var string
*/
private $filename;
/**
* @var AbstractPhpProcess
*/
private $phpUtil;
/**
* @var string
*/
private $output = '';
/**
* Constructs a test case with the given filename.
*
* @throws Exception
*/
public function __construct(string $filename, AbstractPhpProcess $phpUtil = null)
{
if (!is_file($filename)) {
throw new Exception(
sprintf(
'File "%s" does not exist.',
$filename
)
);
}
$this->filename = $filename;
$this->phpUtil = $phpUtil ?: AbstractPhpProcess::factory();
}
/**
* Counts the number of test cases executed by run(TestResult result).
*/
public function count(): int
{
return 1;
}
/**
* Runs a test and collects its result in a TestResult instance.
*
* @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
* @throws \SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*/
public function run(TestResult $result = null): TestResult
{
if ($result === null) {
$result = new TestResult;
}
try {
$sections = $this->parse();
} catch (Exception $e) {
$result->startTest($this);
$result->addFailure($this, new SkippedTestError($e->getMessage()), 0);
$result->endTest($this, 0);
return $result;
}
$code = $this->render($sections['FILE']);
$xfail = false;
$settings = $this->parseIniSection($this->settings($result->getCollectCodeCoverageInformation()));
$result->startTest($this);
if (isset($sections['INI'])) {
$settings = $this->parseIniSection($sections['INI'], $settings);
}
if (isset($sections['ENV'])) {
$env = $this->parseEnvSection($sections['ENV']);
$this->phpUtil->setEnv($env);
}
$this->phpUtil->setUseStderrRedirection(true);
if ($result->enforcesTimeLimit()) {
$this->phpUtil->setTimeout($result->getTimeoutForLargeTests());
}
$skip = $this->runSkip($sections, $result, $settings);
if ($skip) {
return $result;
}
if (isset($sections['XFAIL'])) {
$xfail = trim($sections['XFAIL']);
}
if (isset($sections['STDIN'])) {
$this->phpUtil->setStdin($sections['STDIN']);
}
if (isset($sections['ARGS'])) {
$this->phpUtil->setArgs($sections['ARGS']);
}
if ($result->getCollectCodeCoverageInformation()) {
$codeCoverageCacheDirectory = null;
$pathCoverage = false;
$codeCoverage = $result->getCodeCoverage();
if ($codeCoverage) {
if ($codeCoverage->cachesStaticAnalysis()) {
$codeCoverageCacheDirectory = $codeCoverage->cacheDirectory();
}
$pathCoverage = $codeCoverage->collectsBranchAndPathCoverage();
}
$this->renderForCoverage($code, $pathCoverage, $codeCoverageCacheDirectory);
}
$timer = new Timer;
$timer->start();
$jobResult = $this->phpUtil->runJob($code, $this->stringifyIni($settings));
$time = $timer->stop()->asSeconds();
$this->output = $jobResult['stdout'] ?? '';
if (isset($codeCoverage) && ($coverage = $this->cleanupForCoverage())) {
$codeCoverage->append($coverage, $this, true, [], []);
}
try {
$this->assertPhptExpectation($sections, $this->output);
} catch (AssertionFailedError $e) {
$failure = $e;
if ($xfail !== false) {
$failure = new IncompleteTestError($xfail, 0, $e);
} elseif ($e instanceof ExpectationFailedException) {
$comparisonFailure = $e->getComparisonFailure();
if ($comparisonFailure) {
$diff = $comparisonFailure->getDiff();
} else {
$diff = $e->getMessage();
}
$hint = $this->getLocationHintFromDiff($diff, $sections);
$trace = array_merge($hint, debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS));
$failure = new PHPTAssertionFailedError(
$e->getMessage(),
0,
$trace[0]['file'],
$trace[0]['line'],
$trace,
$comparisonFailure ? $diff : ''
);
}
$result->addFailure($this, $failure, $time);
} catch (Throwable $t) {
$result->addError($this, $t, $time);
}
if ($xfail !== false && $result->allCompletelyImplemented()) {
$result->addFailure($this, new IncompleteTestError('XFAIL section but test passes'), $time);
}
$this->runClean($sections, $result->getCollectCodeCoverageInformation());
$result->endTest($this, $time);
return $result;
}
/**
* Returns the name of the test case.
*/
public function getName(): string
{
return $this->toString();
}
/**
* Returns a string representation of the test case.
*/
public function toString(): string
{
return $this->filename;
}
public function usesDataProvider(): bool
{
return false;
}
public function getNumAssertions(): int
{
return 1;
}
public function getActualOutput(): string
{
return $this->output;
}
public function hasOutput(): bool
{
return !empty($this->output);
}
public function sortId(): string
{
return $this->filename;
}
/**
* @return list
*/
public function provides(): array
{
return [];
}
/**
* @return list
*/
public function requires(): array
{
return [];
}
/**
* Parse --INI-- section key value pairs and return as array.
*
* @param array|string $content
*/
private function parseIniSection($content, array $ini = []): array
{
if (is_string($content)) {
$content = explode("\n", trim($content));
}
foreach ($content as $setting) {
if (strpos($setting, '=') === false) {
continue;
}
$setting = explode('=', $setting, 2);
$name = trim($setting[0]);
$value = trim($setting[1]);
if ($name === 'extension' || $name === 'zend_extension') {
if (!isset($ini[$name])) {
$ini[$name] = [];
}
$ini[$name][] = $value;
continue;
}
$ini[$name] = $value;
}
return $ini;
}
private function parseEnvSection(string $content): array
{
$env = [];
foreach (explode("\n", trim($content)) as $e) {
$e = explode('=', trim($e), 2);
if (!empty($e[0]) && isset($e[1])) {
$env[$e[0]] = $e[1];
}
}
return $env;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
private function assertPhptExpectation(array $sections, string $output): void
{
$assertions = [
'EXPECT' => 'assertEquals',
'EXPECTF' => 'assertStringMatchesFormat',
'EXPECTREGEX' => 'assertMatchesRegularExpression',
];
$actual = preg_replace('/\r\n/', "\n", trim($output));
foreach ($assertions as $sectionName => $sectionAssertion) {
if (isset($sections[$sectionName])) {
$sectionContent = preg_replace('/\r\n/', "\n", trim($sections[$sectionName]));
$expected = $sectionName === 'EXPECTREGEX' ? "/{$sectionContent}/" : $sectionContent;
if ($expected === '') {
throw new Exception('No PHPT expectation found');
}
Assert::$sectionAssertion($expected, $actual);
return;
}
}
throw new Exception('No PHPT assertion found');
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function runSkip(array &$sections, TestResult $result, array $settings): bool
{
if (!isset($sections['SKIPIF'])) {
return false;
}
$skipif = $this->render($sections['SKIPIF']);
$jobResult = $this->phpUtil->runJob($skipif, $this->stringifyIni($settings));
if (!strncasecmp('skip', ltrim($jobResult['stdout']), 4)) {
$message = '';
if (preg_match('/^\s*skip\s*(.+)\s*/i', $jobResult['stdout'], $skipMatch)) {
$message = substr($skipMatch[1], 2);
}
$hint = $this->getLocationHint($message, $sections, 'SKIPIF');
$trace = array_merge($hint, debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS));
$result->addFailure(
$this,
new SyntheticSkippedError($message, 0, $trace[0]['file'], $trace[0]['line'], $trace),
0
);
$result->endTest($this, 0);
return true;
}
return false;
}
private function runClean(array &$sections, bool $collectCoverage): void
{
$this->phpUtil->setStdin('');
$this->phpUtil->setArgs('');
if (isset($sections['CLEAN'])) {
$cleanCode = $this->render($sections['CLEAN']);
$this->phpUtil->runJob($cleanCode, $this->settings($collectCoverage));
}
}
/**
* @throws Exception
*/
private function parse(): array
{
$sections = [];
$section = '';
$unsupportedSections = [
'CGI',
'COOKIE',
'DEFLATE_POST',
'EXPECTHEADERS',
'EXTENSIONS',
'GET',
'GZIP_POST',
'HEADERS',
'PHPDBG',
'POST',
'POST_RAW',
'PUT',
'REDIRECTTEST',
'REQUEST',
];
$lineNr = 0;
foreach (file($this->filename) as $line) {
$lineNr++;
if (preg_match('/^--([_A-Z]+)--/', $line, $result)) {
$section = $result[1];
$sections[$section] = '';
$sections[$section . '_offset'] = $lineNr;
continue;
}
if (empty($section)) {
throw new Exception('Invalid PHPT file: empty section header');
}
$sections[$section] .= $line;
}
if (isset($sections['FILEEOF'])) {
$sections['FILE'] = rtrim($sections['FILEEOF'], "\r\n");
unset($sections['FILEEOF']);
}
$this->parseExternal($sections);
if (!$this->validate($sections)) {
throw new Exception('Invalid PHPT file');
}
foreach ($unsupportedSections as $section) {
if (isset($sections[$section])) {
throw new Exception(
"PHPUnit does not support PHPT {$section} sections"
);
}
}
return $sections;
}
/**
* @throws Exception
*/
private function parseExternal(array &$sections): void
{
$allowSections = [
'FILE',
'EXPECT',
'EXPECTF',
'EXPECTREGEX',
];
$testDirectory = dirname($this->filename) . DIRECTORY_SEPARATOR;
foreach ($allowSections as $section) {
if (isset($sections[$section . '_EXTERNAL'])) {
$externalFilename = trim($sections[$section . '_EXTERNAL']);
if (!is_file($testDirectory . $externalFilename) ||
!is_readable($testDirectory . $externalFilename)) {
throw new Exception(
sprintf(
'Could not load --%s-- %s for PHPT file',
$section . '_EXTERNAL',
$testDirectory . $externalFilename
)
);
}
$sections[$section] = file_get_contents($testDirectory . $externalFilename);
}
}
}
private function validate(array &$sections): bool
{
$requiredSections = [
'FILE',
[
'EXPECT',
'EXPECTF',
'EXPECTREGEX',
],
];
foreach ($requiredSections as $section) {
if (is_array($section)) {
$foundSection = false;
foreach ($section as $anySection) {
if (isset($sections[$anySection])) {
$foundSection = true;
break;
}
}
if (!$foundSection) {
return false;
}
continue;
}
if (!isset($sections[$section])) {
return false;
}
}
return true;
}
private function render(string $code): string
{
return str_replace(
[
'__DIR__',
'__FILE__',
],
[
"'" . dirname($this->filename) . "'",
"'" . $this->filename . "'",
],
$code
);
}
private function getCoverageFiles(): array
{
$baseDir = dirname(realpath($this->filename)) . DIRECTORY_SEPARATOR;
$basename = basename($this->filename, 'phpt');
return [
'coverage' => $baseDir . $basename . 'coverage',
'job' => $baseDir . $basename . 'php',
];
}
private function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory): void
{
$files = $this->getCoverageFiles();
$template = new Template(
__DIR__ . '/../Util/PHP/Template/PhptTestCase.tpl'
);
$composerAutoload = '\'\'';
if (defined('PHPUNIT_COMPOSER_INSTALL')) {
$composerAutoload = var_export(PHPUNIT_COMPOSER_INSTALL, true);
}
$phar = '\'\'';
if (defined('__PHPUNIT_PHAR__')) {
$phar = var_export(__PHPUNIT_PHAR__, true);
}
$globals = '';
if (!empty($GLOBALS['__PHPUNIT_BOOTSTRAP'])) {
$globals = '$GLOBALS[\'__PHPUNIT_BOOTSTRAP\'] = ' . var_export(
$GLOBALS['__PHPUNIT_BOOTSTRAP'],
true
) . ";\n";
}
if ($codeCoverageCacheDirectory === null) {
$codeCoverageCacheDirectory = 'null';
} else {
$codeCoverageCacheDirectory = "'" . $codeCoverageCacheDirectory . "'";
}
$template->setVar(
[
'composerAutoload' => $composerAutoload,
'phar' => $phar,
'globals' => $globals,
'job' => $files['job'],
'coverageFile' => $files['coverage'],
'driverMethod' => $pathCoverage ? 'forLineAndPathCoverage' : 'forLineCoverage',
'codeCoverageCacheDirectory' => $codeCoverageCacheDirectory,
]
);
file_put_contents($files['job'], $job);
$job = $template->render();
}
private function cleanupForCoverage(): RawCodeCoverageData
{
$coverage = RawCodeCoverageData::fromXdebugWithoutPathCoverage([]);
$files = $this->getCoverageFiles();
if (is_file($files['coverage'])) {
$buffer = @file_get_contents($files['coverage']);
if ($buffer !== false) {
$coverage = @unserialize($buffer);
if ($coverage === false) {
$coverage = RawCodeCoverageData::fromXdebugWithoutPathCoverage([]);
}
}
}
foreach ($files as $file) {
@unlink($file);
}
return $coverage;
}
private function stringifyIni(array $ini): array
{
$settings = [];
foreach ($ini as $key => $value) {
if (is_array($value)) {
foreach ($value as $val) {
$settings[] = $key . '=' . $val;
}
continue;
}
$settings[] = $key . '=' . $value;
}
return $settings;
}
private function getLocationHintFromDiff(string $message, array $sections): array
{
$needle = '';
$previousLine = '';
$block = 'message';
foreach (preg_split('/\r\n|\r|\n/', $message) as $line) {
$line = trim($line);
if ($block === 'message' && $line === '--- Expected') {
$block = 'expected';
}
if ($block === 'expected' && $line === '@@ @@') {
$block = 'diff';
}
if ($block === 'diff') {
if (strpos($line, '+') === 0) {
$needle = $this->getCleanDiffLine($previousLine);
break;
}
if (strpos($line, '-') === 0) {
$needle = $this->getCleanDiffLine($line);
break;
}
}
if (!empty($line)) {
$previousLine = $line;
}
}
return $this->getLocationHint($needle, $sections);
}
private function getCleanDiffLine(string $line): string
{
if (preg_match('/^[\-+]([\'\"]?)(.*)\1$/', $line, $matches)) {
$line = $matches[2];
}
return $line;
}
private function getLocationHint(string $needle, array $sections, ?string $sectionName = null): array
{
$needle = trim($needle);
if (empty($needle)) {
return [[
'file' => realpath($this->filename),
'line' => 1,
]];
}
if ($sectionName) {
$search = [$sectionName];
} else {
$search = [
// 'FILE',
'EXPECT',
'EXPECTF',
'EXPECTREGEX',
];
}
$sectionOffset = null;
foreach ($search as $section) {
if (!isset($sections[$section])) {
continue;
}
if (isset($sections[$section . '_EXTERNAL'])) {
$externalFile = trim($sections[$section . '_EXTERNAL']);
return [
[
'file' => realpath(dirname($this->filename) . DIRECTORY_SEPARATOR . $externalFile),
'line' => 1,
],
[
'file' => realpath($this->filename),
'line' => ($sections[$section . '_EXTERNAL_offset'] ?? 0) + 1,
],
];
}
$sectionOffset = $sections[$section . '_offset'] ?? 0;
$offset = $sectionOffset + 1;
foreach (preg_split('/\r\n|\r|\n/', $sections[$section]) as $line) {
if (strpos($line, $needle) !== false) {
return [[
'file' => realpath($this->filename),
'line' => $offset,
]];
}
$offset++;
}
}
if ($sectionName) {
// String not found in specified section, show user the start of the named section
return [[
'file' => realpath($this->filename),
'line' => $sectionOffset,
]];
}
// No section specified, show user start of code
return [[
'file' => realpath($this->filename),
'line' => 1,
]];
}
/**
* @psalm-return list
*/
private function settings(bool $collectCoverage): array
{
$settings = [
'allow_url_fopen=1',
'auto_append_file=',
'auto_prepend_file=',
'disable_functions=',
'display_errors=1',
'docref_ext=.html',
'docref_root=',
'error_append_string=',
'error_prepend_string=',
'error_reporting=-1',
'html_errors=0',
'log_errors=0',
'open_basedir=',
'output_buffering=Off',
'output_handler=',
'report_memleaks=0',
'report_zend_debug=0',
];
if (extension_loaded('pcov')) {
if ($collectCoverage) {
$settings[] = 'pcov.enabled=1';
} else {
$settings[] = 'pcov.enabled=0';
}
}
if (extension_loaded('xdebug')) {
if (version_compare(phpversion('xdebug'), '3', '>=')) {
if ($collectCoverage) {
$settings[] = 'xdebug.mode=coverage';
} else {
$settings[] = 'xdebug.mode=off';
}
} else {
$settings[] = 'xdebug.default_enable=0';
if ($collectCoverage) {
$settings[] = 'xdebug.coverage_enable=1';
}
}
}
return $settings;
}
}
PK [@ & src/Runner/StandardTestSuiteLoader.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use function array_diff;
use function array_values;
use function basename;
use function class_exists;
use function get_declared_classes;
use function sprintf;
use function stripos;
use function strlen;
use function substr;
use PHPUnit\Framework\TestCase;
use PHPUnit\Util\FileLoader;
use ReflectionClass;
use ReflectionException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @deprecated see https://github.com/sebastianbergmann/phpunit/issues/4039
*/
final class StandardTestSuiteLoader implements TestSuiteLoader
{
/**
* @throws Exception
*/
public function load(string $suiteClassFile): ReflectionClass
{
$suiteClassName = basename($suiteClassFile, '.php');
$loadedClasses = get_declared_classes();
if (!class_exists($suiteClassName, false)) {
/* @noinspection UnusedFunctionResultInspection */
FileLoader::checkAndLoad($suiteClassFile);
$loadedClasses = array_values(
array_diff(get_declared_classes(), $loadedClasses)
);
if (empty($loadedClasses)) {
throw new Exception(
sprintf(
'Class %s could not be found in %s',
$suiteClassName,
$suiteClassFile
)
);
}
}
if (!class_exists($suiteClassName, false)) {
$offset = 0 - strlen($suiteClassName);
foreach ($loadedClasses as $loadedClass) {
// @see https://github.com/sebastianbergmann/phpunit/issues/5020
if (stripos(substr($loadedClass, $offset - 1), '\\' . $suiteClassName) === 0 ||
stripos(substr($loadedClass, $offset - 1), '_' . $suiteClassName) === 0) {
$suiteClassName = $loadedClass;
break;
}
}
}
if (!class_exists($suiteClassName, false)) {
throw new Exception(
sprintf(
'Class %s could not be found in %s',
$suiteClassName,
$suiteClassFile
)
);
}
try {
$class = new ReflectionClass($suiteClassName);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if ($class->isSubclassOf(TestCase::class)) {
if ($class->isAbstract()) {
throw new Exception(
sprintf(
'Class %s declared in %s is abstract',
$suiteClassName,
$suiteClassFile
)
);
}
return $class;
}
if ($class->hasMethod('suite')) {
try {
$method = $class->getMethod('suite');
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
sprintf(
'Method %s::suite() declared in %s is abstract',
$suiteClassName,
$suiteClassFile
)
);
}
if (!$method->isPublic()) {
throw new Exception(
sprintf(
'Method %s::suite() declared in %s is not public',
$suiteClassName,
$suiteClassFile
)
);
}
if (!$method->isStatic()) {
throw new Exception(
sprintf(
'Method %s::suite() declared in %s is not static',
$suiteClassName,
$suiteClassFile
)
);
}
}
return $class;
}
public function reload(ReflectionClass $aClass): ReflectionClass
{
return $aClass;
}
}
PK [
src/Runner/TestSuiteLoader.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use ReflectionClass;
/**
* @deprecated see https://github.com/sebastianbergmann/phpunit/issues/4039
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
interface TestSuiteLoader
{
public function load(string $suiteClassFile): ReflectionClass;
public function reload(ReflectionClass $aClass): ReflectionClass;
}
PK [rv v " src/Runner/NullTestResultCache.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class NullTestResultCache implements TestResultCache
{
public function setState(string $testName, int $state): void
{
}
public function getState(string $testName): int
{
return BaseTestRunner::STATUS_UNKNOWN;
}
public function setTime(string $testName, float $time): void
{
}
public function getTime(string $testName): float
{
return 0;
}
public function load(): void
{
}
public function persist(): void
{
}
}
PK [ src/Runner/BaseTestRunner.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use function is_dir;
use function is_file;
use function substr;
use PHPUnit\Framework\Exception;
use PHPUnit\Framework\TestSuite;
use ReflectionClass;
use ReflectionException;
use SebastianBergmann\FileIterator\Facade as FileIteratorFacade;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
abstract class BaseTestRunner
{
/**
* @var int
*/
public const STATUS_UNKNOWN = -1;
/**
* @var int
*/
public const STATUS_PASSED = 0;
/**
* @var int
*/
public const STATUS_SKIPPED = 1;
/**
* @var int
*/
public const STATUS_INCOMPLETE = 2;
/**
* @var int
*/
public const STATUS_FAILURE = 3;
/**
* @var int
*/
public const STATUS_ERROR = 4;
/**
* @var int
*/
public const STATUS_RISKY = 5;
/**
* @var int
*/
public const STATUS_WARNING = 6;
/**
* @var string
*/
public const SUITE_METHODNAME = 'suite';
/**
* Returns the loader to be used.
*/
public function getLoader(): TestSuiteLoader
{
return new StandardTestSuiteLoader;
}
/**
* Returns the Test corresponding to the given suite.
* This is a template method, subclasses override
* the runFailed() and clearStatus() methods.
*
* @param string|string[] $suffixes
*
* @throws Exception
*/
public function getTest(string $suiteClassFile, $suffixes = ''): ?TestSuite
{
if (is_dir($suiteClassFile)) {
/** @var string[] $files */
$files = (new FileIteratorFacade)->getFilesAsArray(
$suiteClassFile,
$suffixes
);
$suite = new TestSuite($suiteClassFile);
$suite->addTestFiles($files);
return $suite;
}
if (is_file($suiteClassFile) && substr($suiteClassFile, -5, 5) === '.phpt') {
$suite = new TestSuite;
$suite->addTestFile($suiteClassFile);
return $suite;
}
try {
$testClass = $this->loadSuiteClass(
$suiteClassFile
);
} catch (\PHPUnit\Exception $e) {
$this->runFailed($e->getMessage());
return null;
}
try {
$suiteMethod = $testClass->getMethod(self::SUITE_METHODNAME);
if (!$suiteMethod->isStatic()) {
$this->runFailed(
'suite() method must be static.'
);
return null;
}
$test = $suiteMethod->invoke(null, $testClass->getName());
} catch (ReflectionException $e) {
$test = new TestSuite($testClass);
}
$this->clearStatus();
return $test;
}
/**
* Returns the loaded ReflectionClass for a suite name.
*/
protected function loadSuiteClass(string $suiteClassFile): ReflectionClass
{
return $this->getLoader()->load($suiteClassFile);
}
/**
* Clears the status message.
*/
protected function clearStatus(): void
{
}
/**
* Override to define how to handle a failed loading of
* a test suite.
*/
abstract protected function runFailed(string $message): void;
}
PK [#z)
# src/Runner/Extension/PharLoader.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner\Extension;
use function is_file;
use PharIo\Manifest\ApplicationName;
use PharIo\Manifest\Exception as ManifestException;
use PharIo\Manifest\ManifestLoader;
use PharIo\Version\Version as PharIoVersion;
use PHPUnit\Runner\Version;
use SebastianBergmann\FileIterator\Facade as FileIteratorFacade;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class PharLoader
{
/**
* @psalm-return array{loadedExtensions: list, notLoadedExtensions: list}
*/
public function loadPharExtensionsInDirectory(string $directory): array
{
$loadedExtensions = [];
$notLoadedExtensions = [];
foreach ((new FileIteratorFacade)->getFilesAsArray($directory, '.phar') as $file) {
if (!is_file('phar://' . $file . '/manifest.xml')) {
$notLoadedExtensions[] = $file . ' is not an extension for PHPUnit';
continue;
}
try {
$applicationName = new ApplicationName('phpunit/phpunit');
$version = new PharIoVersion(Version::series());
$manifest = ManifestLoader::fromFile('phar://' . $file . '/manifest.xml');
if (!$manifest->isExtensionFor($applicationName)) {
$notLoadedExtensions[] = $file . ' is not an extension for PHPUnit';
continue;
}
if (!$manifest->isExtensionFor($applicationName, $version)) {
$notLoadedExtensions[] = $file . ' is not compatible with this version of PHPUnit';
continue;
}
} catch (ManifestException $e) {
$notLoadedExtensions[] = $file . ': ' . $e->getMessage();
continue;
}
/**
* @noinspection PhpIncludeInspection
*
* @psalm-suppress UnresolvableInclude
*/
require $file;
$loadedExtensions[] = $manifest->getName()->asString() . ' ' . $manifest->getVersion()->getVersionString();
}
return [
'loadedExtensions' => $loadedExtensions,
'notLoadedExtensions' => $notLoadedExtensions,
];
}
}
PK [wuS ) src/Runner/Extension/ExtensionHandler.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner\Extension;
use function class_exists;
use function sprintf;
use PHPUnit\Framework\TestListener;
use PHPUnit\Runner\Exception;
use PHPUnit\Runner\Hook;
use PHPUnit\TextUI\TestRunner;
use PHPUnit\TextUI\XmlConfiguration\Extension;
use ReflectionClass;
use ReflectionException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ExtensionHandler
{
/**
* @throws Exception
*/
public function registerExtension(Extension $extensionConfiguration, TestRunner $runner): void
{
$extension = $this->createInstance($extensionConfiguration);
if (!$extension instanceof Hook) {
throw new Exception(
sprintf(
'Class "%s" does not implement a PHPUnit\Runner\Hook interface',
$extensionConfiguration->className()
)
);
}
$runner->addExtension($extension);
}
/**
* @throws Exception
*
* @deprecated
*/
public function createTestListenerInstance(Extension $listenerConfiguration): TestListener
{
$listener = $this->createInstance($listenerConfiguration);
if (!$listener instanceof TestListener) {
throw new Exception(
sprintf(
'Class "%s" does not implement the PHPUnit\Framework\TestListener interface',
$listenerConfiguration->className()
)
);
}
return $listener;
}
/**
* @throws Exception
*/
private function createInstance(Extension $extensionConfiguration): object
{
$this->ensureClassExists($extensionConfiguration);
try {
$reflector = new ReflectionClass($extensionConfiguration->className());
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
if (!$extensionConfiguration->hasArguments()) {
return $reflector->newInstance();
}
return $reflector->newInstanceArgs($extensionConfiguration->arguments());
}
/**
* @throws Exception
*/
private function ensureClassExists(Extension $extensionConfiguration): void
{
if (class_exists($extensionConfiguration->className(), false)) {
return;
}
if ($extensionConfiguration->hasSourceFile()) {
/**
* @noinspection PhpIncludeInspection
*
* @psalm-suppress UnresolvableInclude
*/
require_once $extensionConfiguration->sourceFile();
}
if (!class_exists($extensionConfiguration->className())) {
throw new Exception(
sprintf(
'Class "%s" does not exist',
$extensionConfiguration->className()
)
);
}
}
}
PK [NM src/Runner/Version.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use function array_slice;
use function dirname;
use function explode;
use function implode;
use function strpos;
use SebastianBergmann\Version as VersionId;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class Version
{
/**
* @var string
*/
private static $pharVersion = '';
/**
* @var string
*/
private static $version = '';
/**
* Returns the current version of PHPUnit.
*/
public static function id(): string
{
if (self::$pharVersion !== '') {
return self::$pharVersion;
}
if (self::$version === '') {
self::$version = (new VersionId('9.6.6', dirname(__DIR__, 2)))->getVersion();
}
return self::$version;
}
public static function series(): string
{
if (strpos(self::id(), '-')) {
$version = explode('-', self::id())[0];
} else {
$version = self::id();
}
return implode('.', array_slice(explode('.', $version), 0, 2));
}
public static function getVersionString(): string
{
return 'PHPUnit ' . self::id() . ' by Sebastian Bergmann and contributors.';
}
}
PK [L"X X 0 src/Runner/Filter/IncludeGroupFilterIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner\Filter;
use function in_array;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class IncludeGroupFilterIterator extends GroupFilterIterator
{
protected function doAccept(string $hash): bool
{
return in_array($hash, $this->groupTests, true);
}
}
PK [ ) src/Runner/Filter/GroupFilterIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner\Filter;
use function array_map;
use function array_merge;
use function in_array;
use function spl_object_hash;
use PHPUnit\Framework\TestSuite;
use RecursiveFilterIterator;
use RecursiveIterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
abstract class GroupFilterIterator extends RecursiveFilterIterator
{
/**
* @var string[]
*/
protected $groupTests = [];
public function __construct(RecursiveIterator $iterator, array $groups, TestSuite $suite)
{
parent::__construct($iterator);
foreach ($suite->getGroupDetails() as $group => $tests) {
if (in_array((string) $group, $groups, true)) {
$testHashes = array_map(
'spl_object_hash',
$tests
);
$this->groupTests = array_merge($this->groupTests, $testHashes);
}
}
}
public function accept(): bool
{
$test = $this->getInnerIterator()->current();
if ($test instanceof TestSuite) {
return true;
}
return $this->doAccept(spl_object_hash($test));
}
abstract protected function doAccept(string $hash);
}
PK [ՂDY Y 0 src/Runner/Filter/ExcludeGroupFilterIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner\Filter;
use function in_array;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ExcludeGroupFilterIterator extends GroupFilterIterator
{
protected function doAccept(string $hash): bool
{
return !in_array($hash, $this->groupTests, true);
}
}
PK [ src/Runner/Filter/Factory.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner\Filter;
use function assert;
use function sprintf;
use FilterIterator;
use Iterator;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Runner\Exception;
use RecursiveFilterIterator;
use ReflectionClass;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Factory
{
/**
* @psalm-var array
*/
private $filters = [];
/**
* @param array|string $args
*
* @throws Exception
*/
public function addFilter(ReflectionClass $filter, $args): void
{
if (!$filter->isSubclassOf(RecursiveFilterIterator::class)) {
throw new Exception(
sprintf(
'Class "%s" does not extend RecursiveFilterIterator',
$filter->name
)
);
}
$this->filters[] = [$filter, $args];
}
public function factory(Iterator $iterator, TestSuite $suite): FilterIterator
{
foreach ($this->filters as $filter) {
[$class, $args] = $filter;
$iterator = $class->newInstance($iterator, $args, $suite);
}
assert($iterator instanceof FilterIterator);
return $iterator;
}
}
PK [X1q q ( src/Runner/Filter/NameFilterIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner\Filter;
use function end;
use function implode;
use function preg_match;
use function sprintf;
use function str_replace;
use Exception;
use PHPUnit\Framework\ErrorTestCase;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Framework\WarningTestCase;
use PHPUnit\Util\RegularExpression;
use RecursiveFilterIterator;
use RecursiveIterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class NameFilterIterator extends RecursiveFilterIterator
{
/**
* @var string
*/
private $filter;
/**
* @var int
*/
private $filterMin;
/**
* @var int
*/
private $filterMax;
/**
* @throws Exception
*/
public function __construct(RecursiveIterator $iterator, string $filter)
{
parent::__construct($iterator);
$this->setFilter($filter);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function accept(): bool
{
$test = $this->getInnerIterator()->current();
if ($test instanceof TestSuite) {
return true;
}
$tmp = \PHPUnit\Util\Test::describe($test);
if ($test instanceof ErrorTestCase || $test instanceof WarningTestCase) {
$name = $test->getMessage();
} elseif ($tmp[0] !== '') {
$name = implode('::', $tmp);
} else {
$name = $tmp[1];
}
$accepted = @preg_match($this->filter, $name, $matches);
if ($accepted && isset($this->filterMax)) {
$set = end($matches);
$accepted = $set >= $this->filterMin && $set <= $this->filterMax;
}
return (bool) $accepted;
}
/**
* @throws Exception
*/
private function setFilter(string $filter): void
{
if (RegularExpression::safeMatch($filter, '') === false) {
// Handles:
// * testAssertEqualsSucceeds#4
// * testAssertEqualsSucceeds#4-8
if (preg_match('/^(.*?)#(\d+)(?:-(\d+))?$/', $filter, $matches)) {
if (isset($matches[3]) && $matches[2] < $matches[3]) {
$filter = sprintf(
'%s.*with data set #(\d+)$',
$matches[1]
);
$this->filterMin = (int) $matches[2];
$this->filterMax = (int) $matches[3];
} else {
$filter = sprintf(
'%s.*with data set #%s$',
$matches[1],
$matches[2]
);
}
} // Handles:
// * testDetermineJsonError@JSON_ERROR_NONE
// * testDetermineJsonError@JSON.*
elseif (preg_match('/^(.*?)@(.+)$/', $filter, $matches)) {
$filter = sprintf(
'%s.*with data set "%s"$',
$matches[1],
$matches[2]
);
}
// Escape delimiters in regular expression. Do NOT use preg_quote,
// to keep magic characters.
$filter = sprintf(
'/%s/i',
str_replace(
'/',
'\\/',
$filter
)
);
}
$this->filter = $filter;
}
}
PK [WP
P
# src/Runner/ResultCacheExtension.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use function preg_match;
use function round;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ResultCacheExtension implements AfterIncompleteTestHook, AfterLastTestHook, AfterRiskyTestHook, AfterSkippedTestHook, AfterSuccessfulTestHook, AfterTestErrorHook, AfterTestFailureHook, AfterTestWarningHook
{
/**
* @var TestResultCache
*/
private $cache;
public function __construct(TestResultCache $cache)
{
$this->cache = $cache;
}
public function flush(): void
{
$this->cache->persist();
}
public function executeAfterSuccessfulTest(string $test, float $time): void
{
$testName = $this->getTestName($test);
$this->cache->setTime($testName, round($time, 3));
}
public function executeAfterIncompleteTest(string $test, string $message, float $time): void
{
$testName = $this->getTestName($test);
$this->cache->setTime($testName, round($time, 3));
$this->cache->setState($testName, BaseTestRunner::STATUS_INCOMPLETE);
}
public function executeAfterRiskyTest(string $test, string $message, float $time): void
{
$testName = $this->getTestName($test);
$this->cache->setTime($testName, round($time, 3));
$this->cache->setState($testName, BaseTestRunner::STATUS_RISKY);
}
public function executeAfterSkippedTest(string $test, string $message, float $time): void
{
$testName = $this->getTestName($test);
$this->cache->setTime($testName, round($time, 3));
$this->cache->setState($testName, BaseTestRunner::STATUS_SKIPPED);
}
public function executeAfterTestError(string $test, string $message, float $time): void
{
$testName = $this->getTestName($test);
$this->cache->setTime($testName, round($time, 3));
$this->cache->setState($testName, BaseTestRunner::STATUS_ERROR);
}
public function executeAfterTestFailure(string $test, string $message, float $time): void
{
$testName = $this->getTestName($test);
$this->cache->setTime($testName, round($time, 3));
$this->cache->setState($testName, BaseTestRunner::STATUS_FAILURE);
}
public function executeAfterTestWarning(string $test, string $message, float $time): void
{
$testName = $this->getTestName($test);
$this->cache->setTime($testName, round($time, 3));
$this->cache->setState($testName, BaseTestRunner::STATUS_WARNING);
}
public function executeAfterLastTest(): void
{
$this->flush();
}
/**
* @param string $test A long description format of the current test
*
* @return string The test name without TestSuiteClassName:: and @dataprovider details
*/
private function getTestName(string $test): string
{
$matches = [];
if (preg_match('/^(?\S+::\S+)(?:(? with data set (?:#\d+|"[^"]+"))\s\()?/', $test, $matches)) {
$test = $matches['name'] . ($matches['dataname'] ?? '');
}
return $test;
}
}
PK [k src/Runner/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Exception extends RuntimeException implements \PHPUnit\Exception
{
}
PK [?[% ( src/Runner/Hook/AfterTestWarningHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface AfterTestWarningHook extends TestHook
{
public function executeAfterTestWarning(string $test, string $message, float $time): void;
}
PK [ 5D & src/Runner/Hook/AfterRiskyTestHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface AfterRiskyTestHook extends TestHook
{
public function executeAfterRiskyTest(string $test, string $message, float $time): void;
}
PK [7 ' src/Runner/Hook/BeforeFirstTestHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface BeforeFirstTestHook extends Hook
{
public function executeBeforeFirstTest(): void;
}
PK [Ԥ#Ŕ src/Runner/Hook/Hook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface Hook
{
}
PK [ src/Runner/Hook/TestHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface TestHook extends Hook
{
}
PK [sl % src/Runner/Hook/AfterLastTestHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface AfterLastTestHook extends Hook
{
public function executeAfterLastTest(): void;
}
PK [F( ( ' src/Runner/Hook/TestListenerAdapter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestListener;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Framework\Warning;
use PHPUnit\Util\Test as TestUtil;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TestListenerAdapter implements TestListener
{
/**
* @var TestHook[]
*/
private $hooks = [];
/**
* @var bool
*/
private $lastTestWasNotSuccessful;
public function add(TestHook $hook): void
{
$this->hooks[] = $hook;
}
public function startTest(Test $test): void
{
foreach ($this->hooks as $hook) {
if ($hook instanceof BeforeTestHook) {
$hook->executeBeforeTest(TestUtil::describeAsString($test));
}
}
$this->lastTestWasNotSuccessful = false;
}
public function addError(Test $test, Throwable $t, float $time): void
{
foreach ($this->hooks as $hook) {
if ($hook instanceof AfterTestErrorHook) {
$hook->executeAfterTestError(TestUtil::describeAsString($test), $t->getMessage(), $time);
}
}
$this->lastTestWasNotSuccessful = true;
}
public function addWarning(Test $test, Warning $e, float $time): void
{
foreach ($this->hooks as $hook) {
if ($hook instanceof AfterTestWarningHook) {
$hook->executeAfterTestWarning(TestUtil::describeAsString($test), $e->getMessage(), $time);
}
}
$this->lastTestWasNotSuccessful = true;
}
public function addFailure(Test $test, AssertionFailedError $e, float $time): void
{
foreach ($this->hooks as $hook) {
if ($hook instanceof AfterTestFailureHook) {
$hook->executeAfterTestFailure(TestUtil::describeAsString($test), $e->getMessage(), $time);
}
}
$this->lastTestWasNotSuccessful = true;
}
public function addIncompleteTest(Test $test, Throwable $t, float $time): void
{
foreach ($this->hooks as $hook) {
if ($hook instanceof AfterIncompleteTestHook) {
$hook->executeAfterIncompleteTest(TestUtil::describeAsString($test), $t->getMessage(), $time);
}
}
$this->lastTestWasNotSuccessful = true;
}
public function addRiskyTest(Test $test, Throwable $t, float $time): void
{
foreach ($this->hooks as $hook) {
if ($hook instanceof AfterRiskyTestHook) {
$hook->executeAfterRiskyTest(TestUtil::describeAsString($test), $t->getMessage(), $time);
}
}
$this->lastTestWasNotSuccessful = true;
}
public function addSkippedTest(Test $test, Throwable $t, float $time): void
{
foreach ($this->hooks as $hook) {
if ($hook instanceof AfterSkippedTestHook) {
$hook->executeAfterSkippedTest(TestUtil::describeAsString($test), $t->getMessage(), $time);
}
}
$this->lastTestWasNotSuccessful = true;
}
public function endTest(Test $test, float $time): void
{
if (!$this->lastTestWasNotSuccessful) {
foreach ($this->hooks as $hook) {
if ($hook instanceof AfterSuccessfulTestHook) {
$hook->executeAfterSuccessfulTest(TestUtil::describeAsString($test), $time);
}
}
}
foreach ($this->hooks as $hook) {
if ($hook instanceof AfterTestHook) {
$hook->executeAfterTest(TestUtil::describeAsString($test), $time);
}
}
}
public function startTestSuite(TestSuite $suite): void
{
}
public function endTestSuite(TestSuite $suite): void
{
}
}
PK [ޗ ( src/Runner/Hook/AfterSkippedTestHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface AfterSkippedTestHook extends TestHook
{
public function executeAfterSkippedTest(string $test, string $message, float $time): void;
}
PK [ & src/Runner/Hook/AfterTestErrorHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface AfterTestErrorHook extends TestHook
{
public function executeAfterTestError(string $test, string $message, float $time): void;
}
PK [t{5- + src/Runner/Hook/AfterIncompleteTestHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface AfterIncompleteTestHook extends TestHook
{
public function executeAfterIncompleteTest(string $test, string $message, float $time): void;
}
PK [ 9 + src/Runner/Hook/AfterSuccessfulTestHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface AfterSuccessfulTestHook extends TestHook
{
public function executeAfterSuccessfulTest(string $test, float $time): void;
}
PK [K ! src/Runner/Hook/AfterTestHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface AfterTestHook extends TestHook
{
/**
* This hook will fire after any test, regardless of the result.
*
* For more fine grained control, have a look at the other hooks
* that extend PHPUnit\Runner\Hook.
*/
public function executeAfterTest(string $test, float $time): void;
}
PK [x " src/Runner/Hook/BeforeTestHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface BeforeTestHook extends TestHook
{
public function executeBeforeTest(string $test): void;
}
PK [y3 ( src/Runner/Hook/AfterTestFailureHook.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface AfterTestFailureHook extends TestHook
{
public function executeAfterTestFailure(string $test, string $message, float $time): void;
}
PK [Y) src/Runner/TestResultCache.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface TestResultCache
{
public function setState(string $testName, int $state): void;
public function getState(string $testName): int;
public function setTime(string $testName, float $time): void;
public function getTime(string $testName): float;
public function load(): void;
public function persist(): void;
}
PK [mV]i- - src/Runner/TestSuiteSorter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Runner;
use function array_diff;
use function array_merge;
use function array_reverse;
use function array_splice;
use function count;
use function in_array;
use function max;
use function shuffle;
use function usort;
use PHPUnit\Framework\DataProviderTestSuite;
use PHPUnit\Framework\Reorderable;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Util\Test as TestUtil;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TestSuiteSorter
{
/**
* @var int
*/
public const ORDER_DEFAULT = 0;
/**
* @var int
*/
public const ORDER_RANDOMIZED = 1;
/**
* @var int
*/
public const ORDER_REVERSED = 2;
/**
* @var int
*/
public const ORDER_DEFECTS_FIRST = 3;
/**
* @var int
*/
public const ORDER_DURATION = 4;
/**
* Order tests by @size annotation 'small', 'medium', 'large'.
*
* @var int
*/
public const ORDER_SIZE = 5;
/**
* List of sorting weights for all test result codes. A higher number gives higher priority.
*/
private const DEFECT_SORT_WEIGHT = [
BaseTestRunner::STATUS_ERROR => 6,
BaseTestRunner::STATUS_FAILURE => 5,
BaseTestRunner::STATUS_WARNING => 4,
BaseTestRunner::STATUS_INCOMPLETE => 3,
BaseTestRunner::STATUS_RISKY => 2,
BaseTestRunner::STATUS_SKIPPED => 1,
BaseTestRunner::STATUS_UNKNOWN => 0,
];
private const SIZE_SORT_WEIGHT = [
TestUtil::SMALL => 1,
TestUtil::MEDIUM => 2,
TestUtil::LARGE => 3,
TestUtil::UNKNOWN => 4,
];
/**
* @var array Associative array of (string => DEFECT_SORT_WEIGHT) elements
*/
private $defectSortOrder = [];
/**
* @var TestResultCache
*/
private $cache;
/**
* @var array A list of normalized names of tests before reordering
*/
private $originalExecutionOrder = [];
/**
* @var array A list of normalized names of tests affected by reordering
*/
private $executionOrder = [];
public function __construct(?TestResultCache $cache = null)
{
$this->cache = $cache ?? new NullTestResultCache;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*/
public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDependencies, int $orderDefects, bool $isRootTestSuite = true): void
{
$allowedOrders = [
self::ORDER_DEFAULT,
self::ORDER_REVERSED,
self::ORDER_RANDOMIZED,
self::ORDER_DURATION,
self::ORDER_SIZE,
];
if (!in_array($order, $allowedOrders, true)) {
throw new Exception(
'$order must be one of TestSuiteSorter::ORDER_[DEFAULT|REVERSED|RANDOMIZED|DURATION|SIZE]'
);
}
$allowedOrderDefects = [
self::ORDER_DEFAULT,
self::ORDER_DEFECTS_FIRST,
];
if (!in_array($orderDefects, $allowedOrderDefects, true)) {
throw new Exception(
'$orderDefects must be one of TestSuiteSorter::ORDER_DEFAULT, TestSuiteSorter::ORDER_DEFECTS_FIRST'
);
}
if ($isRootTestSuite) {
$this->originalExecutionOrder = $this->calculateTestExecutionOrder($suite);
}
if ($suite instanceof TestSuite) {
foreach ($suite as $_suite) {
$this->reorderTestsInSuite($_suite, $order, $resolveDependencies, $orderDefects, false);
}
if ($orderDefects === self::ORDER_DEFECTS_FIRST) {
$this->addSuiteToDefectSortOrder($suite);
}
$this->sort($suite, $order, $resolveDependencies, $orderDefects);
}
if ($isRootTestSuite) {
$this->executionOrder = $this->calculateTestExecutionOrder($suite);
}
}
public function getOriginalExecutionOrder(): array
{
return $this->originalExecutionOrder;
}
public function getExecutionOrder(): array
{
return $this->executionOrder;
}
private function sort(TestSuite $suite, int $order, bool $resolveDependencies, int $orderDefects): void
{
if (empty($suite->tests())) {
return;
}
if ($order === self::ORDER_REVERSED) {
$suite->setTests($this->reverse($suite->tests()));
} elseif ($order === self::ORDER_RANDOMIZED) {
$suite->setTests($this->randomize($suite->tests()));
} elseif ($order === self::ORDER_DURATION && $this->cache !== null) {
$suite->setTests($this->sortByDuration($suite->tests()));
} elseif ($order === self::ORDER_SIZE) {
$suite->setTests($this->sortBySize($suite->tests()));
}
if ($orderDefects === self::ORDER_DEFECTS_FIRST && $this->cache !== null) {
$suite->setTests($this->sortDefectsFirst($suite->tests()));
}
if ($resolveDependencies && !($suite instanceof DataProviderTestSuite)) {
/** @var TestCase[] $tests */
$tests = $suite->tests();
$suite->setTests($this->resolveDependencies($tests));
}
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function addSuiteToDefectSortOrder(TestSuite $suite): void
{
$max = 0;
foreach ($suite->tests() as $test) {
if (!$test instanceof Reorderable) {
continue;
}
if (!isset($this->defectSortOrder[$test->sortId()])) {
$this->defectSortOrder[$test->sortId()] = self::DEFECT_SORT_WEIGHT[$this->cache->getState($test->sortId())];
$max = max($max, $this->defectSortOrder[$test->sortId()]);
}
}
$this->defectSortOrder[$suite->sortId()] = $max;
}
private function reverse(array $tests): array
{
return array_reverse($tests);
}
private function randomize(array $tests): array
{
shuffle($tests);
return $tests;
}
private function sortDefectsFirst(array $tests): array
{
usort(
$tests,
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
function ($left, $right)
{
return $this->cmpDefectPriorityAndTime($left, $right);
}
);
return $tests;
}
private function sortByDuration(array $tests): array
{
usort(
$tests,
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
function ($left, $right)
{
return $this->cmpDuration($left, $right);
}
);
return $tests;
}
private function sortBySize(array $tests): array
{
usort(
$tests,
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
function ($left, $right)
{
return $this->cmpSize($left, $right);
}
);
return $tests;
}
/**
* Comparator callback function to sort tests for "reach failure as fast as possible".
*
* 1. sort tests by defect weight defined in self::DEFECT_SORT_WEIGHT
* 2. when tests are equally defective, sort the fastest to the front
* 3. do not reorder successful tests
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function cmpDefectPriorityAndTime(Test $a, Test $b): int
{
if (!($a instanceof Reorderable && $b instanceof Reorderable)) {
return 0;
}
$priorityA = $this->defectSortOrder[$a->sortId()] ?? 0;
$priorityB = $this->defectSortOrder[$b->sortId()] ?? 0;
if ($priorityB <=> $priorityA) {
// Sort defect weight descending
return $priorityB <=> $priorityA;
}
if ($priorityA || $priorityB) {
return $this->cmpDuration($a, $b);
}
// do not change execution order
return 0;
}
/**
* Compares test duration for sorting tests by duration ascending.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function cmpDuration(Test $a, Test $b): int
{
if (!($a instanceof Reorderable && $b instanceof Reorderable)) {
return 0;
}
return $this->cache->getTime($a->sortId()) <=> $this->cache->getTime($b->sortId());
}
/**
* Compares test size for sorting tests small->medium->large->unknown.
*/
private function cmpSize(Test $a, Test $b): int
{
$sizeA = ($a instanceof TestCase || $a instanceof DataProviderTestSuite)
? $a->getSize()
: TestUtil::UNKNOWN;
$sizeB = ($b instanceof TestCase || $b instanceof DataProviderTestSuite)
? $b->getSize()
: TestUtil::UNKNOWN;
return self::SIZE_SORT_WEIGHT[$sizeA] <=> self::SIZE_SORT_WEIGHT[$sizeB];
}
/**
* Reorder Tests within a TestCase in such a way as to resolve as many dependencies as possible.
* The algorithm will leave the tests in original running order when it can.
* For more details see the documentation for test dependencies.
*
* Short description of algorithm:
* 1. Pick the next Test from remaining tests to be checked for dependencies.
* 2. If the test has no dependencies: mark done, start again from the top
* 3. If the test has dependencies but none left to do: mark done, start again from the top
* 4. When we reach the end add any leftover tests to the end. These will be marked 'skipped' during execution.
*
* @param array $tests
*
* @return array
*/
private function resolveDependencies(array $tests): array
{
$newTestOrder = [];
$i = 0;
$provided = [];
do {
if ([] === array_diff($tests[$i]->requires(), $provided)) {
$provided = array_merge($provided, $tests[$i]->provides());
$newTestOrder = array_merge($newTestOrder, array_splice($tests, $i, 1));
$i = 0;
} else {
$i++;
}
} while (!empty($tests) && ($i < count($tests)));
return array_merge($newTestOrder, $tests);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function calculateTestExecutionOrder(Test $suite): array
{
$tests = [];
if ($suite instanceof TestSuite) {
foreach ($suite->tests() as $test) {
if (!$test instanceof TestSuite && $test instanceof Reorderable) {
$tests[] = $test->sortId();
} else {
$tests = array_merge($tests, $this->calculateTestExecutionOrder($test));
}
}
}
return $tests;
}
}
PK [}# 0 src/Framework/InvalidParameterGroupException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvalidParameterGroupException extends Exception
{
}
PK [J9 " src/Framework/Assert/Functions.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use function func_get_args;
use function function_exists;
use ArrayAccess;
use Countable;
use DOMDocument;
use DOMElement;
use PHPUnit\Framework\Constraint\ArrayHasKey;
use PHPUnit\Framework\Constraint\Callback;
use PHPUnit\Framework\Constraint\ClassHasAttribute;
use PHPUnit\Framework\Constraint\ClassHasStaticAttribute;
use PHPUnit\Framework\Constraint\Constraint;
use PHPUnit\Framework\Constraint\Count;
use PHPUnit\Framework\Constraint\DirectoryExists;
use PHPUnit\Framework\Constraint\FileExists;
use PHPUnit\Framework\Constraint\GreaterThan;
use PHPUnit\Framework\Constraint\IsAnything;
use PHPUnit\Framework\Constraint\IsEmpty;
use PHPUnit\Framework\Constraint\IsEqual;
use PHPUnit\Framework\Constraint\IsEqualCanonicalizing;
use PHPUnit\Framework\Constraint\IsEqualIgnoringCase;
use PHPUnit\Framework\Constraint\IsEqualWithDelta;
use PHPUnit\Framework\Constraint\IsFalse;
use PHPUnit\Framework\Constraint\IsFinite;
use PHPUnit\Framework\Constraint\IsIdentical;
use PHPUnit\Framework\Constraint\IsInfinite;
use PHPUnit\Framework\Constraint\IsInstanceOf;
use PHPUnit\Framework\Constraint\IsJson;
use PHPUnit\Framework\Constraint\IsNan;
use PHPUnit\Framework\Constraint\IsNull;
use PHPUnit\Framework\Constraint\IsReadable;
use PHPUnit\Framework\Constraint\IsTrue;
use PHPUnit\Framework\Constraint\IsType;
use PHPUnit\Framework\Constraint\IsWritable;
use PHPUnit\Framework\Constraint\LessThan;
use PHPUnit\Framework\Constraint\LogicalAnd;
use PHPUnit\Framework\Constraint\LogicalNot;
use PHPUnit\Framework\Constraint\LogicalOr;
use PHPUnit\Framework\Constraint\LogicalXor;
use PHPUnit\Framework\Constraint\ObjectEquals;
use PHPUnit\Framework\Constraint\ObjectHasAttribute;
use PHPUnit\Framework\Constraint\RegularExpression;
use PHPUnit\Framework\Constraint\StringContains;
use PHPUnit\Framework\Constraint\StringEndsWith;
use PHPUnit\Framework\Constraint\StringMatchesFormatDescription;
use PHPUnit\Framework\Constraint\StringStartsWith;
use PHPUnit\Framework\Constraint\TraversableContainsEqual;
use PHPUnit\Framework\Constraint\TraversableContainsIdentical;
use PHPUnit\Framework\Constraint\TraversableContainsOnly;
use PHPUnit\Framework\MockObject\Rule\AnyInvokedCount as AnyInvokedCountMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedAtIndex as InvokedAtIndexMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedAtLeastCount as InvokedAtLeastCountMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedAtLeastOnce as InvokedAtLeastOnceMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedAtMostCount as InvokedAtMostCountMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedCount as InvokedCountMatcher;
use PHPUnit\Framework\MockObject\Stub\ConsecutiveCalls as ConsecutiveCallsStub;
use PHPUnit\Framework\MockObject\Stub\Exception as ExceptionStub;
use PHPUnit\Framework\MockObject\Stub\ReturnArgument as ReturnArgumentStub;
use PHPUnit\Framework\MockObject\Stub\ReturnCallback as ReturnCallbackStub;
use PHPUnit\Framework\MockObject\Stub\ReturnSelf as ReturnSelfStub;
use PHPUnit\Framework\MockObject\Stub\ReturnStub;
use PHPUnit\Framework\MockObject\Stub\ReturnValueMap as ReturnValueMapStub;
use Throwable;
if (!function_exists('PHPUnit\Framework\assertArrayHasKey')) {
/**
* Asserts that an array has a specified key.
*
* @param int|string $key
* @param array|ArrayAccess $array
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertArrayHasKey
*/
function assertArrayHasKey($key, $array, string $message = ''): void
{
Assert::assertArrayHasKey(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertArrayNotHasKey')) {
/**
* Asserts that an array does not have a specified key.
*
* @param int|string $key
* @param array|ArrayAccess $array
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertArrayNotHasKey
*/
function assertArrayNotHasKey($key, $array, string $message = ''): void
{
Assert::assertArrayNotHasKey(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertContains')) {
/**
* Asserts that a haystack contains a needle.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertContains
*/
function assertContains($needle, iterable $haystack, string $message = ''): void
{
Assert::assertContains(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertContainsEquals')) {
function assertContainsEquals($needle, iterable $haystack, string $message = ''): void
{
Assert::assertContainsEquals(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotContains')) {
/**
* Asserts that a haystack does not contain a needle.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotContains
*/
function assertNotContains($needle, iterable $haystack, string $message = ''): void
{
Assert::assertNotContains(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotContainsEquals')) {
function assertNotContainsEquals($needle, iterable $haystack, string $message = ''): void
{
Assert::assertNotContainsEquals(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertContainsOnly')) {
/**
* Asserts that a haystack contains only values of a given type.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertContainsOnly
*/
function assertContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void
{
Assert::assertContainsOnly(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertContainsOnlyInstancesOf')) {
/**
* Asserts that a haystack contains only instances of a given class name.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertContainsOnlyInstancesOf
*/
function assertContainsOnlyInstancesOf(string $className, iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyInstancesOf(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotContainsOnly')) {
/**
* Asserts that a haystack does not contain only values of a given type.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotContainsOnly
*/
function assertNotContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void
{
Assert::assertNotContainsOnly(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertCount')) {
/**
* Asserts the number of elements of an array, Countable or Traversable.
*
* @param Countable|iterable $haystack
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertCount
*/
function assertCount(int $expectedCount, $haystack, string $message = ''): void
{
Assert::assertCount(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotCount')) {
/**
* Asserts the number of elements of an array, Countable or Traversable.
*
* @param Countable|iterable $haystack
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotCount
*/
function assertNotCount(int $expectedCount, $haystack, string $message = ''): void
{
Assert::assertNotCount(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertEquals')) {
/**
* Asserts that two variables are equal.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertEquals
*/
function assertEquals($expected, $actual, string $message = ''): void
{
Assert::assertEquals(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertEqualsCanonicalizing')) {
/**
* Asserts that two variables are equal (canonicalizing).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertEqualsCanonicalizing
*/
function assertEqualsCanonicalizing($expected, $actual, string $message = ''): void
{
Assert::assertEqualsCanonicalizing(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertEqualsIgnoringCase')) {
/**
* Asserts that two variables are equal (ignoring case).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertEqualsIgnoringCase
*/
function assertEqualsIgnoringCase($expected, $actual, string $message = ''): void
{
Assert::assertEqualsIgnoringCase(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertEqualsWithDelta')) {
/**
* Asserts that two variables are equal (with delta).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertEqualsWithDelta
*/
function assertEqualsWithDelta($expected, $actual, float $delta, string $message = ''): void
{
Assert::assertEqualsWithDelta(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotEquals')) {
/**
* Asserts that two variables are not equal.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotEquals
*/
function assertNotEquals($expected, $actual, string $message = ''): void
{
Assert::assertNotEquals(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotEqualsCanonicalizing')) {
/**
* Asserts that two variables are not equal (canonicalizing).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotEqualsCanonicalizing
*/
function assertNotEqualsCanonicalizing($expected, $actual, string $message = ''): void
{
Assert::assertNotEqualsCanonicalizing(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotEqualsIgnoringCase')) {
/**
* Asserts that two variables are not equal (ignoring case).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotEqualsIgnoringCase
*/
function assertNotEqualsIgnoringCase($expected, $actual, string $message = ''): void
{
Assert::assertNotEqualsIgnoringCase(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotEqualsWithDelta')) {
/**
* Asserts that two variables are not equal (with delta).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotEqualsWithDelta
*/
function assertNotEqualsWithDelta($expected, $actual, float $delta, string $message = ''): void
{
Assert::assertNotEqualsWithDelta(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertObjectEquals')) {
/**
* @throws ExpectationFailedException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertObjectEquals
*/
function assertObjectEquals(object $expected, object $actual, string $method = 'equals', string $message = ''): void
{
Assert::assertObjectEquals(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertEmpty')) {
/**
* Asserts that a variable is empty.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert empty $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertEmpty
*/
function assertEmpty($actual, string $message = ''): void
{
Assert::assertEmpty(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotEmpty')) {
/**
* Asserts that a variable is not empty.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !empty $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotEmpty
*/
function assertNotEmpty($actual, string $message = ''): void
{
Assert::assertNotEmpty(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertGreaterThan')) {
/**
* Asserts that a value is greater than another value.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertGreaterThan
*/
function assertGreaterThan($expected, $actual, string $message = ''): void
{
Assert::assertGreaterThan(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertGreaterThanOrEqual')) {
/**
* Asserts that a value is greater than or equal to another value.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertGreaterThanOrEqual
*/
function assertGreaterThanOrEqual($expected, $actual, string $message = ''): void
{
Assert::assertGreaterThanOrEqual(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertLessThan')) {
/**
* Asserts that a value is smaller than another value.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertLessThan
*/
function assertLessThan($expected, $actual, string $message = ''): void
{
Assert::assertLessThan(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertLessThanOrEqual')) {
/**
* Asserts that a value is smaller than or equal to another value.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertLessThanOrEqual
*/
function assertLessThanOrEqual($expected, $actual, string $message = ''): void
{
Assert::assertLessThanOrEqual(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileEquals')) {
/**
* Asserts that the contents of one file is equal to the contents of another
* file.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileEquals
*/
function assertFileEquals(string $expected, string $actual, string $message = ''): void
{
Assert::assertFileEquals(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileEqualsCanonicalizing')) {
/**
* Asserts that the contents of one file is equal to the contents of another
* file (canonicalizing).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileEqualsCanonicalizing
*/
function assertFileEqualsCanonicalizing(string $expected, string $actual, string $message = ''): void
{
Assert::assertFileEqualsCanonicalizing(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileEqualsIgnoringCase')) {
/**
* Asserts that the contents of one file is equal to the contents of another
* file (ignoring case).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileEqualsIgnoringCase
*/
function assertFileEqualsIgnoringCase(string $expected, string $actual, string $message = ''): void
{
Assert::assertFileEqualsIgnoringCase(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileNotEquals')) {
/**
* Asserts that the contents of one file is not equal to the contents of
* another file.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileNotEquals
*/
function assertFileNotEquals(string $expected, string $actual, string $message = ''): void
{
Assert::assertFileNotEquals(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileNotEqualsCanonicalizing')) {
/**
* Asserts that the contents of one file is not equal to the contents of another
* file (canonicalizing).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileNotEqualsCanonicalizing
*/
function assertFileNotEqualsCanonicalizing(string $expected, string $actual, string $message = ''): void
{
Assert::assertFileNotEqualsCanonicalizing(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileNotEqualsIgnoringCase')) {
/**
* Asserts that the contents of one file is not equal to the contents of another
* file (ignoring case).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileNotEqualsIgnoringCase
*/
function assertFileNotEqualsIgnoringCase(string $expected, string $actual, string $message = ''): void
{
Assert::assertFileNotEqualsIgnoringCase(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringEqualsFile')) {
/**
* Asserts that the contents of a string is equal
* to the contents of a file.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringEqualsFile
*/
function assertStringEqualsFile(string $expectedFile, string $actualString, string $message = ''): void
{
Assert::assertStringEqualsFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringEqualsFileCanonicalizing')) {
/**
* Asserts that the contents of a string is equal
* to the contents of a file (canonicalizing).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringEqualsFileCanonicalizing
*/
function assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = ''): void
{
Assert::assertStringEqualsFileCanonicalizing(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringEqualsFileIgnoringCase')) {
/**
* Asserts that the contents of a string is equal
* to the contents of a file (ignoring case).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringEqualsFileIgnoringCase
*/
function assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = ''): void
{
Assert::assertStringEqualsFileIgnoringCase(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringNotEqualsFile')) {
/**
* Asserts that the contents of a string is not equal
* to the contents of a file.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringNotEqualsFile
*/
function assertStringNotEqualsFile(string $expectedFile, string $actualString, string $message = ''): void
{
Assert::assertStringNotEqualsFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringNotEqualsFileCanonicalizing')) {
/**
* Asserts that the contents of a string is not equal
* to the contents of a file (canonicalizing).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringNotEqualsFileCanonicalizing
*/
function assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = ''): void
{
Assert::assertStringNotEqualsFileCanonicalizing(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringNotEqualsFileIgnoringCase')) {
/**
* Asserts that the contents of a string is not equal
* to the contents of a file (ignoring case).
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringNotEqualsFileIgnoringCase
*/
function assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = ''): void
{
Assert::assertStringNotEqualsFileIgnoringCase(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsReadable')) {
/**
* Asserts that a file/dir is readable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsReadable
*/
function assertIsReadable(string $filename, string $message = ''): void
{
Assert::assertIsReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotReadable')) {
/**
* Asserts that a file/dir exists and is not readable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotReadable
*/
function assertIsNotReadable(string $filename, string $message = ''): void
{
Assert::assertIsNotReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotIsReadable')) {
/**
* Asserts that a file/dir exists and is not readable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4062
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotIsReadable
*/
function assertNotIsReadable(string $filename, string $message = ''): void
{
Assert::assertNotIsReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsWritable')) {
/**
* Asserts that a file/dir exists and is writable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsWritable
*/
function assertIsWritable(string $filename, string $message = ''): void
{
Assert::assertIsWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotWritable')) {
/**
* Asserts that a file/dir exists and is not writable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotWritable
*/
function assertIsNotWritable(string $filename, string $message = ''): void
{
Assert::assertIsNotWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotIsWritable')) {
/**
* Asserts that a file/dir exists and is not writable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4065
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotIsWritable
*/
function assertNotIsWritable(string $filename, string $message = ''): void
{
Assert::assertNotIsWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDirectoryExists')) {
/**
* Asserts that a directory exists.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDirectoryExists
*/
function assertDirectoryExists(string $directory, string $message = ''): void
{
Assert::assertDirectoryExists(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDirectoryDoesNotExist')) {
/**
* Asserts that a directory does not exist.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDirectoryDoesNotExist
*/
function assertDirectoryDoesNotExist(string $directory, string $message = ''): void
{
Assert::assertDirectoryDoesNotExist(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDirectoryNotExists')) {
/**
* Asserts that a directory does not exist.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4068
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDirectoryNotExists
*/
function assertDirectoryNotExists(string $directory, string $message = ''): void
{
Assert::assertDirectoryNotExists(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDirectoryIsReadable')) {
/**
* Asserts that a directory exists and is readable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDirectoryIsReadable
*/
function assertDirectoryIsReadable(string $directory, string $message = ''): void
{
Assert::assertDirectoryIsReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDirectoryIsNotReadable')) {
/**
* Asserts that a directory exists and is not readable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDirectoryIsNotReadable
*/
function assertDirectoryIsNotReadable(string $directory, string $message = ''): void
{
Assert::assertDirectoryIsNotReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDirectoryNotIsReadable')) {
/**
* Asserts that a directory exists and is not readable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4071
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDirectoryNotIsReadable
*/
function assertDirectoryNotIsReadable(string $directory, string $message = ''): void
{
Assert::assertDirectoryNotIsReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDirectoryIsWritable')) {
/**
* Asserts that a directory exists and is writable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDirectoryIsWritable
*/
function assertDirectoryIsWritable(string $directory, string $message = ''): void
{
Assert::assertDirectoryIsWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDirectoryIsNotWritable')) {
/**
* Asserts that a directory exists and is not writable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDirectoryIsNotWritable
*/
function assertDirectoryIsNotWritable(string $directory, string $message = ''): void
{
Assert::assertDirectoryIsNotWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDirectoryNotIsWritable')) {
/**
* Asserts that a directory exists and is not writable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4074
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDirectoryNotIsWritable
*/
function assertDirectoryNotIsWritable(string $directory, string $message = ''): void
{
Assert::assertDirectoryNotIsWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileExists')) {
/**
* Asserts that a file exists.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileExists
*/
function assertFileExists(string $filename, string $message = ''): void
{
Assert::assertFileExists(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileDoesNotExist')) {
/**
* Asserts that a file does not exist.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileDoesNotExist
*/
function assertFileDoesNotExist(string $filename, string $message = ''): void
{
Assert::assertFileDoesNotExist(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileNotExists')) {
/**
* Asserts that a file does not exist.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4077
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileNotExists
*/
function assertFileNotExists(string $filename, string $message = ''): void
{
Assert::assertFileNotExists(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileIsReadable')) {
/**
* Asserts that a file exists and is readable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileIsReadable
*/
function assertFileIsReadable(string $file, string $message = ''): void
{
Assert::assertFileIsReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileIsNotReadable')) {
/**
* Asserts that a file exists and is not readable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileIsNotReadable
*/
function assertFileIsNotReadable(string $file, string $message = ''): void
{
Assert::assertFileIsNotReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileNotIsReadable')) {
/**
* Asserts that a file exists and is not readable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4080
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileNotIsReadable
*/
function assertFileNotIsReadable(string $file, string $message = ''): void
{
Assert::assertFileNotIsReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileIsWritable')) {
/**
* Asserts that a file exists and is writable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileIsWritable
*/
function assertFileIsWritable(string $file, string $message = ''): void
{
Assert::assertFileIsWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileIsNotWritable')) {
/**
* Asserts that a file exists and is not writable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileIsNotWritable
*/
function assertFileIsNotWritable(string $file, string $message = ''): void
{
Assert::assertFileIsNotWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFileNotIsWritable')) {
/**
* Asserts that a file exists and is not writable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4083
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFileNotIsWritable
*/
function assertFileNotIsWritable(string $file, string $message = ''): void
{
Assert::assertFileNotIsWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertTrue')) {
/**
* Asserts that a condition is true.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert true $condition
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertTrue
*/
function assertTrue($condition, string $message = ''): void
{
Assert::assertTrue(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotTrue')) {
/**
* Asserts that a condition is not true.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !true $condition
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotTrue
*/
function assertNotTrue($condition, string $message = ''): void
{
Assert::assertNotTrue(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFalse')) {
/**
* Asserts that a condition is false.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert false $condition
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFalse
*/
function assertFalse($condition, string $message = ''): void
{
Assert::assertFalse(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotFalse')) {
/**
* Asserts that a condition is not false.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !false $condition
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotFalse
*/
function assertNotFalse($condition, string $message = ''): void
{
Assert::assertNotFalse(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNull')) {
/**
* Asserts that a variable is null.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert null $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNull
*/
function assertNull($actual, string $message = ''): void
{
Assert::assertNull(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotNull')) {
/**
* Asserts that a variable is not null.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !null $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotNull
*/
function assertNotNull($actual, string $message = ''): void
{
Assert::assertNotNull(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertFinite')) {
/**
* Asserts that a variable is finite.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertFinite
*/
function assertFinite($actual, string $message = ''): void
{
Assert::assertFinite(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertInfinite')) {
/**
* Asserts that a variable is infinite.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertInfinite
*/
function assertInfinite($actual, string $message = ''): void
{
Assert::assertInfinite(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNan')) {
/**
* Asserts that a variable is nan.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNan
*/
function assertNan($actual, string $message = ''): void
{
Assert::assertNan(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertClassHasAttribute')) {
/**
* Asserts that a class has a specified attribute.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertClassHasAttribute
*/
function assertClassHasAttribute(string $attributeName, string $className, string $message = ''): void
{
Assert::assertClassHasAttribute(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertClassNotHasAttribute')) {
/**
* Asserts that a class does not have a specified attribute.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertClassNotHasAttribute
*/
function assertClassNotHasAttribute(string $attributeName, string $className, string $message = ''): void
{
Assert::assertClassNotHasAttribute(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertClassHasStaticAttribute')) {
/**
* Asserts that a class has a specified static attribute.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertClassHasStaticAttribute
*/
function assertClassHasStaticAttribute(string $attributeName, string $className, string $message = ''): void
{
Assert::assertClassHasStaticAttribute(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertClassNotHasStaticAttribute')) {
/**
* Asserts that a class does not have a specified static attribute.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertClassNotHasStaticAttribute
*/
function assertClassNotHasStaticAttribute(string $attributeName, string $className, string $message = ''): void
{
Assert::assertClassNotHasStaticAttribute(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertObjectHasAttribute')) {
/**
* Asserts that an object has a specified attribute.
*
* @param object $object
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertObjectHasAttribute
*/
function assertObjectHasAttribute(string $attributeName, $object, string $message = ''): void
{
Assert::assertObjectHasAttribute(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertObjectNotHasAttribute')) {
/**
* Asserts that an object does not have a specified attribute.
*
* @param object $object
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertObjectNotHasAttribute
*/
function assertObjectNotHasAttribute(string $attributeName, $object, string $message = ''): void
{
Assert::assertObjectNotHasAttribute(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertSame')) {
/**
* Asserts that two variables have the same type and value.
* Used on objects, it asserts that two variables reference
* the same object.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-template ExpectedType
*
* @psalm-param ExpectedType $expected
*
* @psalm-assert =ExpectedType $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertSame
*/
function assertSame($expected, $actual, string $message = ''): void
{
Assert::assertSame(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotSame')) {
/**
* Asserts that two variables do not have the same type and value.
* Used on objects, it asserts that two variables do not reference
* the same object.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotSame
*/
function assertNotSame($expected, $actual, string $message = ''): void
{
Assert::assertNotSame(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertInstanceOf')) {
/**
* Asserts that a variable is of a given type.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @psalm-template ExpectedType of object
*
* @psalm-param class-string $expected
*
* @psalm-assert =ExpectedType $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertInstanceOf
*/
function assertInstanceOf(string $expected, $actual, string $message = ''): void
{
Assert::assertInstanceOf(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotInstanceOf')) {
/**
* Asserts that a variable is not of a given type.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @psalm-template ExpectedType of object
*
* @psalm-param class-string $expected
*
* @psalm-assert !ExpectedType $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotInstanceOf
*/
function assertNotInstanceOf(string $expected, $actual, string $message = ''): void
{
Assert::assertNotInstanceOf(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsArray')) {
/**
* Asserts that a variable is of type array.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert array $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsArray
*/
function assertIsArray($actual, string $message = ''): void
{
Assert::assertIsArray(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsBool')) {
/**
* Asserts that a variable is of type bool.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert bool $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsBool
*/
function assertIsBool($actual, string $message = ''): void
{
Assert::assertIsBool(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsFloat')) {
/**
* Asserts that a variable is of type float.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert float $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsFloat
*/
function assertIsFloat($actual, string $message = ''): void
{
Assert::assertIsFloat(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsInt')) {
/**
* Asserts that a variable is of type int.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert int $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsInt
*/
function assertIsInt($actual, string $message = ''): void
{
Assert::assertIsInt(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNumeric')) {
/**
* Asserts that a variable is of type numeric.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert numeric $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNumeric
*/
function assertIsNumeric($actual, string $message = ''): void
{
Assert::assertIsNumeric(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsObject')) {
/**
* Asserts that a variable is of type object.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert object $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsObject
*/
function assertIsObject($actual, string $message = ''): void
{
Assert::assertIsObject(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsResource')) {
/**
* Asserts that a variable is of type resource.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert resource $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsResource
*/
function assertIsResource($actual, string $message = ''): void
{
Assert::assertIsResource(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsClosedResource')) {
/**
* Asserts that a variable is of type resource and is closed.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert resource $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsClosedResource
*/
function assertIsClosedResource($actual, string $message = ''): void
{
Assert::assertIsClosedResource(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsString')) {
/**
* Asserts that a variable is of type string.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert string $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsString
*/
function assertIsString($actual, string $message = ''): void
{
Assert::assertIsString(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsScalar')) {
/**
* Asserts that a variable is of type scalar.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert scalar $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsScalar
*/
function assertIsScalar($actual, string $message = ''): void
{
Assert::assertIsScalar(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsCallable')) {
/**
* Asserts that a variable is of type callable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert callable $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsCallable
*/
function assertIsCallable($actual, string $message = ''): void
{
Assert::assertIsCallable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsIterable')) {
/**
* Asserts that a variable is of type iterable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert iterable $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsIterable
*/
function assertIsIterable($actual, string $message = ''): void
{
Assert::assertIsIterable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotArray')) {
/**
* Asserts that a variable is not of type array.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !array $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotArray
*/
function assertIsNotArray($actual, string $message = ''): void
{
Assert::assertIsNotArray(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotBool')) {
/**
* Asserts that a variable is not of type bool.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !bool $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotBool
*/
function assertIsNotBool($actual, string $message = ''): void
{
Assert::assertIsNotBool(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotFloat')) {
/**
* Asserts that a variable is not of type float.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !float $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotFloat
*/
function assertIsNotFloat($actual, string $message = ''): void
{
Assert::assertIsNotFloat(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotInt')) {
/**
* Asserts that a variable is not of type int.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !int $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotInt
*/
function assertIsNotInt($actual, string $message = ''): void
{
Assert::assertIsNotInt(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotNumeric')) {
/**
* Asserts that a variable is not of type numeric.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !numeric $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotNumeric
*/
function assertIsNotNumeric($actual, string $message = ''): void
{
Assert::assertIsNotNumeric(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotObject')) {
/**
* Asserts that a variable is not of type object.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !object $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotObject
*/
function assertIsNotObject($actual, string $message = ''): void
{
Assert::assertIsNotObject(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotResource')) {
/**
* Asserts that a variable is not of type resource.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !resource $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotResource
*/
function assertIsNotResource($actual, string $message = ''): void
{
Assert::assertIsNotResource(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotClosedResource')) {
/**
* Asserts that a variable is not of type resource.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !resource $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotClosedResource
*/
function assertIsNotClosedResource($actual, string $message = ''): void
{
Assert::assertIsNotClosedResource(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotString')) {
/**
* Asserts that a variable is not of type string.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !string $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotString
*/
function assertIsNotString($actual, string $message = ''): void
{
Assert::assertIsNotString(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotScalar')) {
/**
* Asserts that a variable is not of type scalar.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !scalar $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotScalar
*/
function assertIsNotScalar($actual, string $message = ''): void
{
Assert::assertIsNotScalar(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotCallable')) {
/**
* Asserts that a variable is not of type callable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !callable $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotCallable
*/
function assertIsNotCallable($actual, string $message = ''): void
{
Assert::assertIsNotCallable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertIsNotIterable')) {
/**
* Asserts that a variable is not of type iterable.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @psalm-assert !iterable $actual
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertIsNotIterable
*/
function assertIsNotIterable($actual, string $message = ''): void
{
Assert::assertIsNotIterable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertMatchesRegularExpression')) {
/**
* Asserts that a string matches a given regular expression.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertMatchesRegularExpression
*/
function assertMatchesRegularExpression(string $pattern, string $string, string $message = ''): void
{
Assert::assertMatchesRegularExpression(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertRegExp')) {
/**
* Asserts that a string matches a given regular expression.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4086
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertRegExp
*/
function assertRegExp(string $pattern, string $string, string $message = ''): void
{
Assert::assertRegExp(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertDoesNotMatchRegularExpression')) {
/**
* Asserts that a string does not match a given regular expression.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertDoesNotMatchRegularExpression
*/
function assertDoesNotMatchRegularExpression(string $pattern, string $string, string $message = ''): void
{
Assert::assertDoesNotMatchRegularExpression(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotRegExp')) {
/**
* Asserts that a string does not match a given regular expression.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4089
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotRegExp
*/
function assertNotRegExp(string $pattern, string $string, string $message = ''): void
{
Assert::assertNotRegExp(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertSameSize')) {
/**
* Assert that the size of two arrays (or `Countable` or `Traversable` objects)
* is the same.
*
* @param Countable|iterable $expected
* @param Countable|iterable $actual
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertSameSize
*/
function assertSameSize($expected, $actual, string $message = ''): void
{
Assert::assertSameSize(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertNotSameSize')) {
/**
* Assert that the size of two arrays (or `Countable` or `Traversable` objects)
* is not the same.
*
* @param Countable|iterable $expected
* @param Countable|iterable $actual
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertNotSameSize
*/
function assertNotSameSize($expected, $actual, string $message = ''): void
{
Assert::assertNotSameSize(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringMatchesFormat')) {
/**
* Asserts that a string matches a given format string.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringMatchesFormat
*/
function assertStringMatchesFormat(string $format, string $string, string $message = ''): void
{
Assert::assertStringMatchesFormat(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringNotMatchesFormat')) {
/**
* Asserts that a string does not match a given format string.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringNotMatchesFormat
*/
function assertStringNotMatchesFormat(string $format, string $string, string $message = ''): void
{
Assert::assertStringNotMatchesFormat(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringMatchesFormatFile')) {
/**
* Asserts that a string matches a given format file.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringMatchesFormatFile
*/
function assertStringMatchesFormatFile(string $formatFile, string $string, string $message = ''): void
{
Assert::assertStringMatchesFormatFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringNotMatchesFormatFile')) {
/**
* Asserts that a string does not match a given format string.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringNotMatchesFormatFile
*/
function assertStringNotMatchesFormatFile(string $formatFile, string $string, string $message = ''): void
{
Assert::assertStringNotMatchesFormatFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringStartsWith')) {
/**
* Asserts that a string starts with a given prefix.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringStartsWith
*/
function assertStringStartsWith(string $prefix, string $string, string $message = ''): void
{
Assert::assertStringStartsWith(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringStartsNotWith')) {
/**
* Asserts that a string starts not with a given prefix.
*
* @param string $prefix
* @param string $string
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringStartsNotWith
*/
function assertStringStartsNotWith($prefix, $string, string $message = ''): void
{
Assert::assertStringStartsNotWith(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringContainsString')) {
/**
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringContainsString
*/
function assertStringContainsString(string $needle, string $haystack, string $message = ''): void
{
Assert::assertStringContainsString(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringContainsStringIgnoringCase')) {
/**
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringContainsStringIgnoringCase
*/
function assertStringContainsStringIgnoringCase(string $needle, string $haystack, string $message = ''): void
{
Assert::assertStringContainsStringIgnoringCase(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringNotContainsString')) {
/**
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringNotContainsString
*/
function assertStringNotContainsString(string $needle, string $haystack, string $message = ''): void
{
Assert::assertStringNotContainsString(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringNotContainsStringIgnoringCase')) {
/**
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringNotContainsStringIgnoringCase
*/
function assertStringNotContainsStringIgnoringCase(string $needle, string $haystack, string $message = ''): void
{
Assert::assertStringNotContainsStringIgnoringCase(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringEndsWith')) {
/**
* Asserts that a string ends with a given suffix.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringEndsWith
*/
function assertStringEndsWith(string $suffix, string $string, string $message = ''): void
{
Assert::assertStringEndsWith(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertStringEndsNotWith')) {
/**
* Asserts that a string ends not with a given suffix.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertStringEndsNotWith
*/
function assertStringEndsNotWith(string $suffix, string $string, string $message = ''): void
{
Assert::assertStringEndsNotWith(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertXmlFileEqualsXmlFile')) {
/**
* Asserts that two XML files are equal.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertXmlFileEqualsXmlFile
*/
function assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile, string $message = ''): void
{
Assert::assertXmlFileEqualsXmlFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertXmlFileNotEqualsXmlFile')) {
/**
* Asserts that two XML files are not equal.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws \PHPUnit\Util\Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertXmlFileNotEqualsXmlFile
*/
function assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile, string $message = ''): void
{
Assert::assertXmlFileNotEqualsXmlFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertXmlStringEqualsXmlFile')) {
/**
* Asserts that two XML documents are equal.
*
* @param DOMDocument|string $actualXml
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws \PHPUnit\Util\Xml\Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertXmlStringEqualsXmlFile
*/
function assertXmlStringEqualsXmlFile(string $expectedFile, $actualXml, string $message = ''): void
{
Assert::assertXmlStringEqualsXmlFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertXmlStringNotEqualsXmlFile')) {
/**
* Asserts that two XML documents are not equal.
*
* @param DOMDocument|string $actualXml
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws \PHPUnit\Util\Xml\Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertXmlStringNotEqualsXmlFile
*/
function assertXmlStringNotEqualsXmlFile(string $expectedFile, $actualXml, string $message = ''): void
{
Assert::assertXmlStringNotEqualsXmlFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertXmlStringEqualsXmlString')) {
/**
* Asserts that two XML documents are equal.
*
* @param DOMDocument|string $expectedXml
* @param DOMDocument|string $actualXml
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws \PHPUnit\Util\Xml\Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertXmlStringEqualsXmlString
*/
function assertXmlStringEqualsXmlString($expectedXml, $actualXml, string $message = ''): void
{
Assert::assertXmlStringEqualsXmlString(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertXmlStringNotEqualsXmlString')) {
/**
* Asserts that two XML documents are not equal.
*
* @param DOMDocument|string $expectedXml
* @param DOMDocument|string $actualXml
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws \PHPUnit\Util\Xml\Exception
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertXmlStringNotEqualsXmlString
*/
function assertXmlStringNotEqualsXmlString($expectedXml, $actualXml, string $message = ''): void
{
Assert::assertXmlStringNotEqualsXmlString(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertEqualXMLStructure')) {
/**
* Asserts that a hierarchy of DOMElements matches.
*
* @throws AssertionFailedError
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4091
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertEqualXMLStructure
*/
function assertEqualXMLStructure(DOMElement $expectedElement, DOMElement $actualElement, bool $checkAttributes = false, string $message = ''): void
{
Assert::assertEqualXMLStructure(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertThat')) {
/**
* Evaluates a PHPUnit\Framework\Constraint matcher object.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertThat
*/
function assertThat($value, Constraint $constraint, string $message = ''): void
{
Assert::assertThat(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertJson')) {
/**
* Asserts that a string is a valid JSON string.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertJson
*/
function assertJson(string $actualJson, string $message = ''): void
{
Assert::assertJson(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertJsonStringEqualsJsonString')) {
/**
* Asserts that two given JSON encoded objects or arrays are equal.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertJsonStringEqualsJsonString
*/
function assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson, string $message = ''): void
{
Assert::assertJsonStringEqualsJsonString(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertJsonStringNotEqualsJsonString')) {
/**
* Asserts that two given JSON encoded objects or arrays are not equal.
*
* @param string $expectedJson
* @param string $actualJson
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertJsonStringNotEqualsJsonString
*/
function assertJsonStringNotEqualsJsonString($expectedJson, $actualJson, string $message = ''): void
{
Assert::assertJsonStringNotEqualsJsonString(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertJsonStringEqualsJsonFile')) {
/**
* Asserts that the generated JSON encoded object and the content of the given file are equal.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertJsonStringEqualsJsonFile
*/
function assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson, string $message = ''): void
{
Assert::assertJsonStringEqualsJsonFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertJsonStringNotEqualsJsonFile')) {
/**
* Asserts that the generated JSON encoded object and the content of the given file are not equal.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertJsonStringNotEqualsJsonFile
*/
function assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson, string $message = ''): void
{
Assert::assertJsonStringNotEqualsJsonFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertJsonFileEqualsJsonFile')) {
/**
* Asserts that two JSON files are equal.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertJsonFileEqualsJsonFile
*/
function assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile, string $message = ''): void
{
Assert::assertJsonFileEqualsJsonFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\assertJsonFileNotEqualsJsonFile')) {
/**
* Asserts that two JSON files are not equal.
*
* @throws ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @see Assert::assertJsonFileNotEqualsJsonFile
*/
function assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile, string $message = ''): void
{
Assert::assertJsonFileNotEqualsJsonFile(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\logicalAnd')) {
function logicalAnd(): LogicalAnd
{
return Assert::logicalAnd(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\logicalOr')) {
function logicalOr(): LogicalOr
{
return Assert::logicalOr(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\logicalNot')) {
function logicalNot(Constraint $constraint): LogicalNot
{
return Assert::logicalNot(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\logicalXor')) {
function logicalXor(): LogicalXor
{
return Assert::logicalXor(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\anything')) {
function anything(): IsAnything
{
return Assert::anything(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isTrue')) {
function isTrue(): IsTrue
{
return Assert::isTrue(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\callback')) {
function callback(callable $callback): Callback
{
return Assert::callback(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isFalse')) {
function isFalse(): IsFalse
{
return Assert::isFalse(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isJson')) {
function isJson(): IsJson
{
return Assert::isJson(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isNull')) {
function isNull(): IsNull
{
return Assert::isNull(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isFinite')) {
function isFinite(): IsFinite
{
return Assert::isFinite(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isInfinite')) {
function isInfinite(): IsInfinite
{
return Assert::isInfinite(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isNan')) {
function isNan(): IsNan
{
return Assert::isNan(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\containsEqual')) {
function containsEqual($value): TraversableContainsEqual
{
return Assert::containsEqual(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\containsIdentical')) {
function containsIdentical($value): TraversableContainsIdentical
{
return Assert::containsIdentical(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\containsOnly')) {
function containsOnly(string $type): TraversableContainsOnly
{
return Assert::containsOnly(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\containsOnlyInstancesOf')) {
function containsOnlyInstancesOf(string $className): TraversableContainsOnly
{
return Assert::containsOnlyInstancesOf(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\arrayHasKey')) {
function arrayHasKey($key): ArrayHasKey
{
return Assert::arrayHasKey(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\equalTo')) {
function equalTo($value): IsEqual
{
return Assert::equalTo(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\equalToCanonicalizing')) {
function equalToCanonicalizing($value): IsEqualCanonicalizing
{
return Assert::equalToCanonicalizing(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\equalToIgnoringCase')) {
function equalToIgnoringCase($value): IsEqualIgnoringCase
{
return Assert::equalToIgnoringCase(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\equalToWithDelta')) {
function equalToWithDelta($value, float $delta): IsEqualWithDelta
{
return Assert::equalToWithDelta(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isEmpty')) {
function isEmpty(): IsEmpty
{
return Assert::isEmpty(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isWritable')) {
function isWritable(): IsWritable
{
return Assert::isWritable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isReadable')) {
function isReadable(): IsReadable
{
return Assert::isReadable(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\directoryExists')) {
function directoryExists(): DirectoryExists
{
return Assert::directoryExists(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\fileExists')) {
function fileExists(): FileExists
{
return Assert::fileExists(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\greaterThan')) {
function greaterThan($value): GreaterThan
{
return Assert::greaterThan(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\greaterThanOrEqual')) {
function greaterThanOrEqual($value): LogicalOr
{
return Assert::greaterThanOrEqual(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\classHasAttribute')) {
function classHasAttribute(string $attributeName): ClassHasAttribute
{
return Assert::classHasAttribute(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\classHasStaticAttribute')) {
function classHasStaticAttribute(string $attributeName): ClassHasStaticAttribute
{
return Assert::classHasStaticAttribute(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\objectHasAttribute')) {
function objectHasAttribute($attributeName): ObjectHasAttribute
{
return Assert::objectHasAttribute(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\identicalTo')) {
function identicalTo($value): IsIdentical
{
return Assert::identicalTo(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isInstanceOf')) {
function isInstanceOf(string $className): IsInstanceOf
{
return Assert::isInstanceOf(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\isType')) {
function isType(string $type): IsType
{
return Assert::isType(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\lessThan')) {
function lessThan($value): LessThan
{
return Assert::lessThan(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\lessThanOrEqual')) {
function lessThanOrEqual($value): LogicalOr
{
return Assert::lessThanOrEqual(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\matchesRegularExpression')) {
function matchesRegularExpression(string $pattern): RegularExpression
{
return Assert::matchesRegularExpression(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\matches')) {
function matches(string $string): StringMatchesFormatDescription
{
return Assert::matches(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\stringStartsWith')) {
function stringStartsWith($prefix): StringStartsWith
{
return Assert::stringStartsWith(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\stringContains')) {
function stringContains(string $string, bool $case = true): StringContains
{
return Assert::stringContains(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\stringEndsWith')) {
function stringEndsWith(string $suffix): StringEndsWith
{
return Assert::stringEndsWith(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\countOf')) {
function countOf(int $count): Count
{
return Assert::countOf(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\objectEquals')) {
function objectEquals(object $object, string $method = 'equals'): ObjectEquals
{
return Assert::objectEquals(...func_get_args());
}
}
if (!function_exists('PHPUnit\Framework\any')) {
/**
* Returns a matcher that matches when the method is executed
* zero or more times.
*/
function any(): AnyInvokedCountMatcher
{
return new AnyInvokedCountMatcher;
}
}
if (!function_exists('PHPUnit\Framework\never')) {
/**
* Returns a matcher that matches when the method is never executed.
*/
function never(): InvokedCountMatcher
{
return new InvokedCountMatcher(0);
}
}
if (!function_exists('PHPUnit\Framework\atLeast')) {
/**
* Returns a matcher that matches when the method is executed
* at least N times.
*/
function atLeast(int $requiredInvocations): InvokedAtLeastCountMatcher
{
return new InvokedAtLeastCountMatcher(
$requiredInvocations
);
}
}
if (!function_exists('PHPUnit\Framework\atLeastOnce')) {
/**
* Returns a matcher that matches when the method is executed at least once.
*/
function atLeastOnce(): InvokedAtLeastOnceMatcher
{
return new InvokedAtLeastOnceMatcher;
}
}
if (!function_exists('PHPUnit\Framework\once')) {
/**
* Returns a matcher that matches when the method is executed exactly once.
*/
function once(): InvokedCountMatcher
{
return new InvokedCountMatcher(1);
}
}
if (!function_exists('PHPUnit\Framework\exactly')) {
/**
* Returns a matcher that matches when the method is executed
* exactly $count times.
*/
function exactly(int $count): InvokedCountMatcher
{
return new InvokedCountMatcher($count);
}
}
if (!function_exists('PHPUnit\Framework\atMost')) {
/**
* Returns a matcher that matches when the method is executed
* at most N times.
*/
function atMost(int $allowedInvocations): InvokedAtMostCountMatcher
{
return new InvokedAtMostCountMatcher($allowedInvocations);
}
}
if (!function_exists('PHPUnit\Framework\at')) {
/**
* Returns a matcher that matches when the method is executed
* at the given index.
*/
function at(int $index): InvokedAtIndexMatcher
{
return new InvokedAtIndexMatcher($index);
}
}
if (!function_exists('PHPUnit\Framework\returnValue')) {
function returnValue($value): ReturnStub
{
return new ReturnStub($value);
}
}
if (!function_exists('PHPUnit\Framework\returnValueMap')) {
function returnValueMap(array $valueMap): ReturnValueMapStub
{
return new ReturnValueMapStub($valueMap);
}
}
if (!function_exists('PHPUnit\Framework\returnArgument')) {
function returnArgument(int $argumentIndex): ReturnArgumentStub
{
return new ReturnArgumentStub($argumentIndex);
}
}
if (!function_exists('PHPUnit\Framework\returnCallback')) {
function returnCallback($callback): ReturnCallbackStub
{
return new ReturnCallbackStub($callback);
}
}
if (!function_exists('PHPUnit\Framework\returnSelf')) {
/**
* Returns the current object.
*
* This method is useful when mocking a fluent interface.
*/
function returnSelf(): ReturnSelfStub
{
return new ReturnSelfStub;
}
}
if (!function_exists('PHPUnit\Framework\throwException')) {
function throwException(Throwable $exception): ExceptionStub
{
return new ExceptionStub($exception);
}
}
if (!function_exists('PHPUnit\Framework\onConsecutiveCalls')) {
function onConsecutiveCalls(): ConsecutiveCallsStub
{
$args = func_get_args();
return new ConsecutiveCallsStub($args);
}
}
PK [! # src/Framework/TestSuiteIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use function assert;
use function count;
use RecursiveIterator;
/**
* @template-implements RecursiveIterator
*
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TestSuiteIterator implements RecursiveIterator
{
/**
* @var int
*/
private $position = 0;
/**
* @var Test[]
*/
private $tests;
public function __construct(TestSuite $testSuite)
{
$this->tests = $testSuite->tests();
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->tests);
}
public function key(): int
{
return $this->position;
}
public function current(): Test
{
return $this->tests[$this->position];
}
public function next(): void
{
$this->position++;
}
/**
* @throws NoChildTestSuiteException
*/
public function getChildren(): self
{
if (!$this->hasChildren()) {
throw new NoChildTestSuiteException(
'The current item is not a TestSuite instance and therefore does not have any children.'
);
}
$current = $this->current();
assert($current instanceof TestSuite);
return new self($current);
}
public function hasChildren(): bool
{
return $this->valid() && $this->current() instanceof TestSuite;
}
}
PK [zۈ src/Framework/Reorderable.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface Reorderable
{
public function sortId(): string;
/**
* @return list
*/
public function provides(): array;
/**
* @return list
*/
public function requires(): array;
}
PK [(]A A 3 src/Framework/TestListenerDefaultImplementation.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use Throwable;
/**
* @deprecated The `TestListener` interface is deprecated
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
trait TestListenerDefaultImplementation
{
public function addError(Test $test, Throwable $t, float $time): void
{
}
public function addWarning(Test $test, Warning $e, float $time): void
{
}
public function addFailure(Test $test, AssertionFailedError $e, float $time): void
{
}
public function addIncompleteTest(Test $test, Throwable $t, float $time): void
{
}
public function addRiskyTest(Test $test, Throwable $t, float $time): void
{
}
public function addSkippedTest(Test $test, Throwable $t, float $time): void
{
}
public function startTestSuite(TestSuite $suite): void
{
}
public function endTestSuite(TestSuite $suite): void
{
}
public function startTest(Test $test): void
{
}
public function endTest(Test $test, float $time): void
{
}
}
PK [k n n " src/Framework/ExceptionWrapper.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const PHP_VERSION_ID;
use function array_keys;
use function get_class;
use function spl_object_hash;
use PHPUnit\Util\Filter;
use Throwable;
use WeakReference;
/**
* Wraps Exceptions thrown by code under test.
*
* Re-instantiates Exceptions thrown by user-space code to retain their original
* class names, properties, and stack traces (but without arguments).
*
* Unlike PHPUnit\Framework\Exception, the complete stack of previous Exceptions
* is processed.
*
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ExceptionWrapper extends Exception
{
/**
* @var string
*/
protected $className;
/**
* @var null|ExceptionWrapper
*/
protected $previous;
/**
* @var null|WeakReference
*/
private $originalException;
public function __construct(Throwable $t)
{
// PDOException::getCode() is a string.
// @see https://php.net/manual/en/class.pdoexception.php#95812
parent::__construct($t->getMessage(), (int) $t->getCode());
$this->setOriginalException($t);
}
public function __toString(): string
{
$string = TestFailure::exceptionToString($this);
if ($trace = Filter::getFilteredStacktrace($this)) {
$string .= "\n" . $trace;
}
if ($this->previous) {
$string .= "\nCaused by\n" . $this->previous;
}
return $string;
}
public function getClassName(): string
{
return $this->className;
}
public function getPreviousWrapped(): ?self
{
return $this->previous;
}
public function setClassName(string $className): void
{
$this->className = $className;
}
public function setOriginalException(Throwable $t): void
{
$this->originalException($t);
$this->className = get_class($t);
$this->file = $t->getFile();
$this->line = $t->getLine();
$this->serializableTrace = $t->getTrace();
foreach (array_keys($this->serializableTrace) as $key) {
unset($this->serializableTrace[$key]['args']);
}
if ($t->getPrevious()) {
$this->previous = new self($t->getPrevious());
}
}
public function getOriginalException(): ?Throwable
{
return $this->originalException();
}
/**
* Method to contain static originalException to exclude it from stacktrace to prevent the stacktrace contents,
* which can be quite big, from being garbage-collected, thus blocking memory until shutdown.
*
* Approach works both for var_dump() and var_export() and print_r().
*/
private function originalException(Throwable $exceptionToStore = null): ?Throwable
{
// drop once PHP 7.3 support is removed
if (PHP_VERSION_ID < 70400) {
static $originalExceptions;
$instanceId = spl_object_hash($this);
if ($exceptionToStore) {
$originalExceptions[$instanceId] = $exceptionToStore;
}
return $originalExceptions[$instanceId] ?? null;
}
if ($exceptionToStore) {
$this->originalException = WeakReference::create($exceptionToStore);
}
return $this->originalException !== null ? $this->originalException->get() : null;
}
}
PK [ ? ? src/Framework/TestCase.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const LC_ALL;
use const LC_COLLATE;
use const LC_CTYPE;
use const LC_MONETARY;
use const LC_NUMERIC;
use const LC_TIME;
use const PATHINFO_FILENAME;
use const PHP_EOL;
use const PHP_URL_PATH;
use function array_filter;
use function array_flip;
use function array_keys;
use function array_merge;
use function array_pop;
use function array_search;
use function array_unique;
use function array_values;
use function basename;
use function call_user_func;
use function chdir;
use function class_exists;
use function clearstatcache;
use function count;
use function debug_backtrace;
use function defined;
use function explode;
use function get_class;
use function get_include_path;
use function getcwd;
use function implode;
use function in_array;
use function ini_set;
use function is_array;
use function is_callable;
use function is_int;
use function is_object;
use function is_string;
use function libxml_clear_errors;
use function method_exists;
use function ob_end_clean;
use function ob_get_contents;
use function ob_get_level;
use function ob_start;
use function parse_url;
use function pathinfo;
use function preg_replace;
use function serialize;
use function setlocale;
use function sprintf;
use function strpos;
use function substr;
use function trim;
use function var_export;
use DeepCopy\DeepCopy;
use PHPUnit\Framework\Constraint\Exception as ExceptionConstraint;
use PHPUnit\Framework\Constraint\ExceptionCode;
use PHPUnit\Framework\Constraint\ExceptionMessage;
use PHPUnit\Framework\Constraint\ExceptionMessageRegularExpression;
use PHPUnit\Framework\Constraint\LogicalOr;
use PHPUnit\Framework\Error\Deprecated;
use PHPUnit\Framework\Error\Error;
use PHPUnit\Framework\Error\Notice;
use PHPUnit\Framework\Error\Warning as WarningError;
use PHPUnit\Framework\MockObject\Generator as MockGenerator;
use PHPUnit\Framework\MockObject\MockBuilder;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\MockObject\Rule\AnyInvokedCount as AnyInvokedCountMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedAtIndex as InvokedAtIndexMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedAtLeastCount as InvokedAtLeastCountMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedAtLeastOnce as InvokedAtLeastOnceMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedAtMostCount as InvokedAtMostCountMatcher;
use PHPUnit\Framework\MockObject\Rule\InvokedCount as InvokedCountMatcher;
use PHPUnit\Framework\MockObject\Stub;
use PHPUnit\Framework\MockObject\Stub\ConsecutiveCalls as ConsecutiveCallsStub;
use PHPUnit\Framework\MockObject\Stub\Exception as ExceptionStub;
use PHPUnit\Framework\MockObject\Stub\ReturnArgument as ReturnArgumentStub;
use PHPUnit\Framework\MockObject\Stub\ReturnCallback as ReturnCallbackStub;
use PHPUnit\Framework\MockObject\Stub\ReturnSelf as ReturnSelfStub;
use PHPUnit\Framework\MockObject\Stub\ReturnStub;
use PHPUnit\Framework\MockObject\Stub\ReturnValueMap as ReturnValueMapStub;
use PHPUnit\Runner\BaseTestRunner;
use PHPUnit\Runner\PhptTestCase;
use PHPUnit\Util\Cloner;
use PHPUnit\Util\Exception as UtilException;
use PHPUnit\Util\GlobalState;
use PHPUnit\Util\PHP\AbstractPhpProcess;
use PHPUnit\Util\Test as TestUtil;
use Prophecy\Exception\Prediction\PredictionException;
use Prophecy\Prophecy\MethodProphecy;
use Prophecy\Prophecy\ObjectProphecy;
use Prophecy\Prophet;
use ReflectionClass;
use ReflectionException;
use SebastianBergmann\Comparator\Comparator;
use SebastianBergmann\Comparator\Factory as ComparatorFactory;
use SebastianBergmann\Diff\Differ;
use SebastianBergmann\Exporter\Exporter;
use SebastianBergmann\GlobalState\ExcludeList;
use SebastianBergmann\GlobalState\Restorer;
use SebastianBergmann\GlobalState\Snapshot;
use SebastianBergmann\ObjectEnumerator\Enumerator;
use SebastianBergmann\Template\Template;
use SoapClient;
use Throwable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
abstract class TestCase extends Assert implements Reorderable, SelfDescribing, Test
{
private const LOCALE_CATEGORIES = [LC_ALL, LC_COLLATE, LC_CTYPE, LC_MONETARY, LC_NUMERIC, LC_TIME];
/**
* @var ?bool
*/
protected $backupGlobals;
/**
* @var string[]
*/
protected $backupGlobalsExcludeList = [];
/**
* @var string[]
*
* @deprecated Use $backupGlobalsExcludeList instead
*/
protected $backupGlobalsBlacklist = [];
/**
* @var bool
*/
protected $backupStaticAttributes;
/**
* @var array>
*/
protected $backupStaticAttributesExcludeList = [];
/**
* @var array>
*
* @deprecated Use $backupStaticAttributesExcludeList instead
*/
protected $backupStaticAttributesBlacklist = [];
/**
* @var bool
*/
protected $runTestInSeparateProcess;
/**
* @var bool
*/
protected $preserveGlobalState = true;
/**
* @var list
*/
protected $providedTests = [];
/**
* @var bool
*/
private $runClassInSeparateProcess;
/**
* @var bool
*/
private $inIsolation = false;
/**
* @var array
*/
private $data;
/**
* @var int|string
*/
private $dataName;
/**
* @var null|string
*/
private $expectedException;
/**
* @var null|string
*/
private $expectedExceptionMessage;
/**
* @var null|string
*/
private $expectedExceptionMessageRegExp;
/**
* @var null|int|string
*/
private $expectedExceptionCode;
/**
* @var string
*/
private $name = '';
/**
* @var list
*/
private $dependencies = [];
/**
* @var array
*/
private $dependencyInput = [];
/**
* @var array
*/
private $iniSettings = [];
/**
* @var array
*/
private $locale = [];
/**
* @var MockObject[]
*/
private $mockObjects = [];
/**
* @var MockGenerator
*/
private $mockObjectGenerator;
/**
* @var int
*/
private $status = BaseTestRunner::STATUS_UNKNOWN;
/**
* @var string
*/
private $statusMessage = '';
/**
* @var int
*/
private $numAssertions = 0;
/**
* @var TestResult
*/
private $result;
/**
* @var mixed
*/
private $testResult;
/**
* @var string
*/
private $output = '';
/**
* @var ?string
*/
private $outputExpectedRegex;
/**
* @var ?string
*/
private $outputExpectedString;
/**
* @var mixed
*/
private $outputCallback = false;
/**
* @var bool
*/
private $outputBufferingActive = false;
/**
* @var int
*/
private $outputBufferingLevel;
/**
* @var bool
*/
private $outputRetrievedForAssertion = false;
/**
* @var ?Snapshot
*/
private $snapshot;
/**
* @var \Prophecy\Prophet
*/
private $prophet;
/**
* @var bool
*/
private $beStrictAboutChangesToGlobalState = false;
/**
* @var bool
*/
private $registerMockObjectsFromTestArgumentsRecursively = false;
/**
* @var string[]
*/
private $warnings = [];
/**
* @var string[]
*/
private $groups = [];
/**
* @var bool
*/
private $doesNotPerformAssertions = false;
/**
* @var Comparator[]
*/
private $customComparators = [];
/**
* @var string[]
*/
private $doubledTypes = [];
/**
* Returns a matcher that matches when the method is executed
* zero or more times.
*/
public static function any(): AnyInvokedCountMatcher
{
return new AnyInvokedCountMatcher;
}
/**
* Returns a matcher that matches when the method is never executed.
*/
public static function never(): InvokedCountMatcher
{
return new InvokedCountMatcher(0);
}
/**
* Returns a matcher that matches when the method is executed
* at least N times.
*/
public static function atLeast(int $requiredInvocations): InvokedAtLeastCountMatcher
{
return new InvokedAtLeastCountMatcher(
$requiredInvocations
);
}
/**
* Returns a matcher that matches when the method is executed at least once.
*/
public static function atLeastOnce(): InvokedAtLeastOnceMatcher
{
return new InvokedAtLeastOnceMatcher;
}
/**
* Returns a matcher that matches when the method is executed exactly once.
*/
public static function once(): InvokedCountMatcher
{
return new InvokedCountMatcher(1);
}
/**
* Returns a matcher that matches when the method is executed
* exactly $count times.
*/
public static function exactly(int $count): InvokedCountMatcher
{
return new InvokedCountMatcher($count);
}
/**
* Returns a matcher that matches when the method is executed
* at most N times.
*/
public static function atMost(int $allowedInvocations): InvokedAtMostCountMatcher
{
return new InvokedAtMostCountMatcher($allowedInvocations);
}
/**
* Returns a matcher that matches when the method is executed
* at the given index.
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4297
*
* @codeCoverageIgnore
*/
public static function at(int $index): InvokedAtIndexMatcher
{
$stack = debug_backtrace();
while (!empty($stack)) {
$frame = array_pop($stack);
if (isset($frame['object']) && $frame['object'] instanceof self) {
$frame['object']->addWarning(
'The at() matcher has been deprecated. It will be removed in PHPUnit 10. Please refactor your test to not rely on the order in which methods are invoked.'
);
break;
}
}
return new InvokedAtIndexMatcher($index);
}
public static function returnValue($value): ReturnStub
{
return new ReturnStub($value);
}
public static function returnValueMap(array $valueMap): ReturnValueMapStub
{
return new ReturnValueMapStub($valueMap);
}
public static function returnArgument(int $argumentIndex): ReturnArgumentStub
{
return new ReturnArgumentStub($argumentIndex);
}
public static function returnCallback($callback): ReturnCallbackStub
{
return new ReturnCallbackStub($callback);
}
/**
* Returns the current object.
*
* This method is useful when mocking a fluent interface.
*/
public static function returnSelf(): ReturnSelfStub
{
return new ReturnSelfStub;
}
public static function throwException(Throwable $exception): ExceptionStub
{
return new ExceptionStub($exception);
}
public static function onConsecutiveCalls(...$args): ConsecutiveCallsStub
{
return new ConsecutiveCallsStub($args);
}
/**
* @param int|string $dataName
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function __construct(?string $name = null, array $data = [], $dataName = '')
{
if ($name !== null) {
$this->setName($name);
}
$this->data = $data;
$this->dataName = $dataName;
}
/**
* This method is called before the first test of this test class is run.
*/
public static function setUpBeforeClass(): void
{
}
/**
* This method is called after the last test of this test class is run.
*/
public static function tearDownAfterClass(): void
{
}
/**
* This method is called before each test.
*/
protected function setUp(): void
{
}
/**
* Performs assertions shared by all tests of a test case.
*
* This method is called between setUp() and test.
*/
protected function assertPreConditions(): void
{
}
/**
* Performs assertions shared by all tests of a test case.
*
* This method is called between test and tearDown().
*/
protected function assertPostConditions(): void
{
}
/**
* This method is called after each test.
*/
protected function tearDown(): void
{
}
/**
* Returns a string representation of the test case.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
*/
public function toString(): string
{
try {
$class = new ReflectionClass($this);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$buffer = sprintf(
'%s::%s',
$class->name,
$this->getName(false)
);
return $buffer . $this->getDataSetAsString();
}
public function count(): int
{
return 1;
}
public function getActualOutputForAssertion(): string
{
$this->outputRetrievedForAssertion = true;
return $this->getActualOutput();
}
public function expectOutputRegex(string $expectedRegex): void
{
$this->outputExpectedRegex = $expectedRegex;
}
public function expectOutputString(string $expectedString): void
{
$this->outputExpectedString = $expectedString;
}
/**
* @psalm-param class-string<\Throwable> $exception
*/
public function expectException(string $exception): void
{
// @codeCoverageIgnoreStart
switch ($exception) {
case Deprecated::class:
$this->addWarning('Expecting E_DEPRECATED and E_USER_DEPRECATED is deprecated and will no longer be possible in PHPUnit 10.');
break;
case Error::class:
$this->addWarning('Expecting E_ERROR and E_USER_ERROR is deprecated and will no longer be possible in PHPUnit 10.');
break;
case Notice::class:
$this->addWarning('Expecting E_STRICT, E_NOTICE, and E_USER_NOTICE is deprecated and will no longer be possible in PHPUnit 10.');
break;
case WarningError::class:
$this->addWarning('Expecting E_WARNING and E_USER_WARNING is deprecated and will no longer be possible in PHPUnit 10.');
break;
}
// @codeCoverageIgnoreEnd
$this->expectedException = $exception;
}
/**
* @param int|string $code
*/
public function expectExceptionCode($code): void
{
$this->expectedExceptionCode = $code;
}
public function expectExceptionMessage(string $message): void
{
$this->expectedExceptionMessage = $message;
}
public function expectExceptionMessageMatches(string $regularExpression): void
{
$this->expectedExceptionMessageRegExp = $regularExpression;
}
/**
* Sets up an expectation for an exception to be raised by the code under test.
* Information for expected exception class, expected exception message, and
* expected exception code are retrieved from a given Exception object.
*/
public function expectExceptionObject(\Exception $exception): void
{
$this->expectException(get_class($exception));
$this->expectExceptionMessage($exception->getMessage());
$this->expectExceptionCode($exception->getCode());
}
public function expectNotToPerformAssertions(): void
{
$this->doesNotPerformAssertions = true;
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectDeprecation(): void
{
$this->addWarning('Expecting E_DEPRECATED and E_USER_DEPRECATED is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectedException = Deprecated::class;
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectDeprecationMessage(string $message): void
{
$this->addWarning('Expecting E_DEPRECATED and E_USER_DEPRECATED is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectExceptionMessage($message);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectDeprecationMessageMatches(string $regularExpression): void
{
$this->addWarning('Expecting E_DEPRECATED and E_USER_DEPRECATED is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectExceptionMessageMatches($regularExpression);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectNotice(): void
{
$this->addWarning('Expecting E_STRICT, E_NOTICE, and E_USER_NOTICE is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectedException = Notice::class;
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectNoticeMessage(string $message): void
{
$this->addWarning('Expecting E_STRICT, E_NOTICE, and E_USER_NOTICE is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectExceptionMessage($message);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectNoticeMessageMatches(string $regularExpression): void
{
$this->addWarning('Expecting E_STRICT, E_NOTICE, and E_USER_NOTICE is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectExceptionMessageMatches($regularExpression);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectWarning(): void
{
$this->addWarning('Expecting E_WARNING and E_USER_WARNING is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectedException = WarningError::class;
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectWarningMessage(string $message): void
{
$this->addWarning('Expecting E_WARNING and E_USER_WARNING is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectExceptionMessage($message);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectWarningMessageMatches(string $regularExpression): void
{
$this->addWarning('Expecting E_WARNING and E_USER_WARNING is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectExceptionMessageMatches($regularExpression);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectError(): void
{
$this->addWarning('Expecting E_ERROR and E_USER_ERROR is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectedException = Error::class;
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectErrorMessage(string $message): void
{
$this->addWarning('Expecting E_ERROR and E_USER_ERROR is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectExceptionMessage($message);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/5062
*/
public function expectErrorMessageMatches(string $regularExpression): void
{
$this->addWarning('Expecting E_ERROR and E_USER_ERROR is deprecated and will no longer be possible in PHPUnit 10.');
$this->expectExceptionMessageMatches($regularExpression);
}
public function getStatus(): int
{
return $this->status;
}
public function markAsRisky(): void
{
$this->status = BaseTestRunner::STATUS_RISKY;
}
public function getStatusMessage(): string
{
return $this->statusMessage;
}
public function hasFailed(): bool
{
$status = $this->getStatus();
return $status === BaseTestRunner::STATUS_FAILURE || $status === BaseTestRunner::STATUS_ERROR;
}
/**
* Runs the test case and collects the results in a TestResult object.
* If no TestResult object is passed a new one will be created.
*
* @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
* @throws \SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws CodeCoverageException
* @throws UtilException
*/
public function run(TestResult $result = null): TestResult
{
if ($result === null) {
$result = $this->createResult();
}
if (!$this instanceof ErrorTestCase && !$this instanceof WarningTestCase) {
$this->setTestResultObject($result);
}
if (!$this instanceof ErrorTestCase &&
!$this instanceof WarningTestCase &&
!$this instanceof SkippedTestCase &&
!$this->handleDependencies()) {
return $result;
}
if ($this->runInSeparateProcess()) {
$runEntireClass = $this->runClassInSeparateProcess && !$this->runTestInSeparateProcess;
try {
$class = new ReflectionClass($this);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if ($runEntireClass) {
$template = new Template(
__DIR__ . '/../Util/PHP/Template/TestCaseClass.tpl'
);
} else {
$template = new Template(
__DIR__ . '/../Util/PHP/Template/TestCaseMethod.tpl'
);
}
if ($this->preserveGlobalState) {
$constants = GlobalState::getConstantsAsString();
$globals = GlobalState::getGlobalsAsString();
$includedFiles = GlobalState::getIncludedFilesAsString();
$iniSettings = GlobalState::getIniSettingsAsString();
} else {
$constants = '';
if (!empty($GLOBALS['__PHPUNIT_BOOTSTRAP'])) {
$globals = '$GLOBALS[\'__PHPUNIT_BOOTSTRAP\'] = ' . var_export($GLOBALS['__PHPUNIT_BOOTSTRAP'], true) . ";\n";
} else {
$globals = '';
}
$includedFiles = '';
$iniSettings = '';
}
$coverage = $result->getCollectCodeCoverageInformation() ? 'true' : 'false';
$isStrictAboutTestsThatDoNotTestAnything = $result->isStrictAboutTestsThatDoNotTestAnything() ? 'true' : 'false';
$isStrictAboutOutputDuringTests = $result->isStrictAboutOutputDuringTests() ? 'true' : 'false';
$enforcesTimeLimit = $result->enforcesTimeLimit() ? 'true' : 'false';
$isStrictAboutTodoAnnotatedTests = $result->isStrictAboutTodoAnnotatedTests() ? 'true' : 'false';
$isStrictAboutResourceUsageDuringSmallTests = $result->isStrictAboutResourceUsageDuringSmallTests() ? 'true' : 'false';
if (defined('PHPUNIT_COMPOSER_INSTALL')) {
$composerAutoload = var_export(PHPUNIT_COMPOSER_INSTALL, true);
} else {
$composerAutoload = '\'\'';
}
if (defined('__PHPUNIT_PHAR__')) {
$phar = var_export(__PHPUNIT_PHAR__, true);
} else {
$phar = '\'\'';
}
$codeCoverage = $result->getCodeCoverage();
$codeCoverageFilter = null;
$cachesStaticAnalysis = 'false';
$codeCoverageCacheDirectory = null;
$driverMethod = 'forLineCoverage';
if ($codeCoverage) {
$codeCoverageFilter = $codeCoverage->filter();
if ($codeCoverage->collectsBranchAndPathCoverage()) {
$driverMethod = 'forLineAndPathCoverage';
}
if ($codeCoverage->cachesStaticAnalysis()) {
$cachesStaticAnalysis = 'true';
$codeCoverageCacheDirectory = $codeCoverage->cacheDirectory();
}
}
$data = var_export(serialize($this->data), true);
$dataName = var_export($this->dataName, true);
$dependencyInput = var_export(serialize($this->dependencyInput), true);
$includePath = var_export(get_include_path(), true);
$codeCoverageFilter = var_export(serialize($codeCoverageFilter), true);
$codeCoverageCacheDirectory = var_export(serialize($codeCoverageCacheDirectory), true);
// must do these fixes because TestCaseMethod.tpl has unserialize('{data}') in it, and we can't break BC
// the lines above used to use addcslashes() rather than var_export(), which breaks null byte escape sequences
$data = "'." . $data . ".'";
$dataName = "'.(" . $dataName . ").'";
$dependencyInput = "'." . $dependencyInput . ".'";
$includePath = "'." . $includePath . ".'";
$codeCoverageFilter = "'." . $codeCoverageFilter . ".'";
$codeCoverageCacheDirectory = "'." . $codeCoverageCacheDirectory . ".'";
$configurationFilePath = $GLOBALS['__PHPUNIT_CONFIGURATION_FILE'] ?? '';
$var = [
'composerAutoload' => $composerAutoload,
'phar' => $phar,
'filename' => $class->getFileName(),
'className' => $class->getName(),
'collectCodeCoverageInformation' => $coverage,
'cachesStaticAnalysis' => $cachesStaticAnalysis,
'codeCoverageCacheDirectory' => $codeCoverageCacheDirectory,
'driverMethod' => $driverMethod,
'data' => $data,
'dataName' => $dataName,
'dependencyInput' => $dependencyInput,
'constants' => $constants,
'globals' => $globals,
'include_path' => $includePath,
'included_files' => $includedFiles,
'iniSettings' => $iniSettings,
'isStrictAboutTestsThatDoNotTestAnything' => $isStrictAboutTestsThatDoNotTestAnything,
'isStrictAboutOutputDuringTests' => $isStrictAboutOutputDuringTests,
'enforcesTimeLimit' => $enforcesTimeLimit,
'isStrictAboutTodoAnnotatedTests' => $isStrictAboutTodoAnnotatedTests,
'isStrictAboutResourceUsageDuringSmallTests' => $isStrictAboutResourceUsageDuringSmallTests,
'codeCoverageFilter' => $codeCoverageFilter,
'configurationFilePath' => $configurationFilePath,
'name' => $this->getName(false),
];
if (!$runEntireClass) {
$var['methodName'] = $this->name;
}
$template->setVar($var);
$php = AbstractPhpProcess::factory();
$php->runTestJob($template->render(), $this, $result);
} else {
$result->run($this);
}
$this->result = null;
return $result;
}
/**
* Returns a builder object to create mock objects using a fluent interface.
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string $className
*
* @psalm-return MockBuilder
*/
public function getMockBuilder(string $className): MockBuilder
{
$this->recordDoubledType($className);
return new MockBuilder($this, $className);
}
public function registerComparator(Comparator $comparator): void
{
ComparatorFactory::getInstance()->register($comparator);
$this->customComparators[] = $comparator;
}
/**
* @return string[]
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function doubledTypes(): array
{
return array_unique($this->doubledTypes);
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getGroups(): array
{
return $this->groups;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setGroups(array $groups): void
{
$this->groups = $groups;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getName(bool $withDataSet = true): string
{
if ($withDataSet) {
return $this->name . $this->getDataSetAsString(false);
}
return $this->name;
}
/**
* Returns the size of the test.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getSize(): int
{
return TestUtil::getSize(
static::class,
$this->getName(false)
);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function hasSize(): bool
{
return $this->getSize() !== TestUtil::UNKNOWN;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function isSmall(): bool
{
return $this->getSize() === TestUtil::SMALL;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function isMedium(): bool
{
return $this->getSize() === TestUtil::MEDIUM;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function isLarge(): bool
{
return $this->getSize() === TestUtil::LARGE;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getActualOutput(): string
{
if (!$this->outputBufferingActive) {
return $this->output;
}
return (string) ob_get_contents();
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function hasOutput(): bool
{
if ($this->output === '') {
return false;
}
if ($this->hasExpectationOnOutput()) {
return false;
}
return true;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function doesNotPerformAssertions(): bool
{
return $this->doesNotPerformAssertions;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function hasExpectationOnOutput(): bool
{
return is_string($this->outputExpectedString) || is_string($this->outputExpectedRegex) || $this->outputRetrievedForAssertion;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getExpectedException(): ?string
{
return $this->expectedException;
}
/**
* @return null|int|string
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getExpectedExceptionCode()
{
return $this->expectedExceptionCode;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getExpectedExceptionMessage(): ?string
{
return $this->expectedExceptionMessage;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getExpectedExceptionMessageRegExp(): ?string
{
return $this->expectedExceptionMessageRegExp;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setRegisterMockObjectsFromTestArgumentsRecursively(bool $flag): void
{
$this->registerMockObjectsFromTestArgumentsRecursively = $flag;
}
/**
* @throws Throwable
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function runBare(): void
{
$this->numAssertions = 0;
$this->snapshotGlobalState();
$this->startOutputBuffering();
clearstatcache();
$currentWorkingDirectory = getcwd();
$hookMethods = TestUtil::getHookMethods(static::class);
$hasMetRequirements = false;
try {
$this->checkRequirements();
$hasMetRequirements = true;
if ($this->inIsolation) {
foreach ($hookMethods['beforeClass'] as $method) {
$this->{$method}();
}
}
$this->setDoesNotPerformAssertionsFromAnnotation();
foreach ($hookMethods['before'] as $method) {
$this->{$method}();
}
foreach ($hookMethods['preCondition'] as $method) {
$this->{$method}();
}
$this->testResult = $this->runTest();
$this->verifyMockObjects();
foreach ($hookMethods['postCondition'] as $method) {
$this->{$method}();
}
if (!empty($this->warnings)) {
throw new Warning(
implode(
"\n",
array_unique($this->warnings)
)
);
}
$this->status = BaseTestRunner::STATUS_PASSED;
} catch (IncompleteTest $e) {
$this->status = BaseTestRunner::STATUS_INCOMPLETE;
$this->statusMessage = $e->getMessage();
} catch (SkippedTest $e) {
$this->status = BaseTestRunner::STATUS_SKIPPED;
$this->statusMessage = $e->getMessage();
} catch (Warning $e) {
$this->status = BaseTestRunner::STATUS_WARNING;
$this->statusMessage = $e->getMessage();
} catch (AssertionFailedError $e) {
$this->status = BaseTestRunner::STATUS_FAILURE;
$this->statusMessage = $e->getMessage();
} catch (PredictionException $e) {
$this->status = BaseTestRunner::STATUS_FAILURE;
$this->statusMessage = $e->getMessage();
} catch (Throwable $_e) {
$e = $_e;
$this->status = BaseTestRunner::STATUS_ERROR;
$this->statusMessage = $_e->getMessage();
}
$this->mockObjects = [];
$this->prophet = null;
// Tear down the fixture. An exception raised in tearDown() will be
// caught and passed on when no exception was raised before.
try {
if ($hasMetRequirements) {
foreach ($hookMethods['after'] as $method) {
$this->{$method}();
}
if ($this->inIsolation) {
foreach ($hookMethods['afterClass'] as $method) {
$this->{$method}();
}
}
}
} catch (Throwable $_e) {
$e = $e ?? $_e;
}
try {
$this->stopOutputBuffering();
} catch (RiskyTestError $_e) {
$e = $e ?? $_e;
}
if (isset($_e)) {
$this->status = BaseTestRunner::STATUS_ERROR;
$this->statusMessage = $_e->getMessage();
}
clearstatcache();
if ($currentWorkingDirectory !== getcwd()) {
chdir($currentWorkingDirectory);
}
$this->restoreGlobalState();
$this->unregisterCustomComparators();
$this->cleanupIniSettings();
$this->cleanupLocaleSettings();
libxml_clear_errors();
// Perform assertion on output.
if (!isset($e)) {
try {
if ($this->outputExpectedRegex !== null) {
$this->assertMatchesRegularExpression($this->outputExpectedRegex, $this->output);
} elseif ($this->outputExpectedString !== null) {
$this->assertEquals($this->outputExpectedString, $this->output);
}
} catch (Throwable $_e) {
$e = $_e;
}
}
// Workaround for missing "finally".
if (isset($e)) {
if ($e instanceof PredictionException) {
$e = new AssertionFailedError($e->getMessage());
}
$this->onNotSuccessfulTest($e);
}
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setName(string $name): void
{
$this->name = $name;
if (is_callable($this->sortId(), true)) {
$this->providedTests = [new ExecutionOrderDependency($this->sortId())];
}
}
/**
* @param list $dependencies
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setDependencies(array $dependencies): void
{
$this->dependencies = $dependencies;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setDependencyInput(array $dependencyInput): void
{
$this->dependencyInput = $dependencyInput;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setBeStrictAboutChangesToGlobalState(?bool $beStrictAboutChangesToGlobalState): void
{
$this->beStrictAboutChangesToGlobalState = $beStrictAboutChangesToGlobalState;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setBackupGlobals(?bool $backupGlobals): void
{
if ($this->backupGlobals === null && $backupGlobals !== null) {
$this->backupGlobals = $backupGlobals;
}
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setBackupStaticAttributes(?bool $backupStaticAttributes): void
{
if ($this->backupStaticAttributes === null && $backupStaticAttributes !== null) {
$this->backupStaticAttributes = $backupStaticAttributes;
}
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setRunTestInSeparateProcess(bool $runTestInSeparateProcess): void
{
if ($this->runTestInSeparateProcess === null) {
$this->runTestInSeparateProcess = $runTestInSeparateProcess;
}
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setRunClassInSeparateProcess(bool $runClassInSeparateProcess): void
{
if ($this->runClassInSeparateProcess === null) {
$this->runClassInSeparateProcess = $runClassInSeparateProcess;
}
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setPreserveGlobalState(bool $preserveGlobalState): void
{
$this->preserveGlobalState = $preserveGlobalState;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setInIsolation(bool $inIsolation): void
{
$this->inIsolation = $inIsolation;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function isInIsolation(): bool
{
return $this->inIsolation;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getResult()
{
return $this->testResult;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setResult($result): void
{
$this->testResult = $result;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setOutputCallback(callable $callback): void
{
$this->outputCallback = $callback;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getTestResultObject(): ?TestResult
{
return $this->result;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function setTestResultObject(TestResult $result): void
{
$this->result = $result;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function registerMockObject(MockObject $mockObject): void
{
$this->mockObjects[] = $mockObject;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function addToAssertionCount(int $count): void
{
$this->numAssertions += $count;
}
/**
* Returns the number of assertions performed by this test.
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getNumAssertions(): int
{
return $this->numAssertions;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function usesDataProvider(): bool
{
return !empty($this->data);
}
/**
* @return int|string
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function dataName()
{
return $this->dataName;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getDataSetAsString(bool $includeData = true): string
{
$buffer = '';
if (!empty($this->data)) {
if (is_int($this->dataName)) {
$buffer .= sprintf(' with data set #%d', $this->dataName);
} else {
$buffer .= sprintf(' with data set "%s"', $this->dataName);
}
if ($includeData) {
$exporter = new Exporter;
$buffer .= sprintf(' (%s)', $exporter->shortenedRecursiveExport($this->data));
}
}
return $buffer;
}
/**
* Gets the data set of a TestCase.
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function getProvidedData(): array
{
return $this->data;
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function addWarning(string $warning): void
{
$this->warnings[] = $warning;
}
public function sortId(): string
{
$id = $this->name;
if (strpos($id, '::') === false) {
$id = static::class . '::' . $id;
}
if ($this->usesDataProvider()) {
$id .= $this->getDataSetAsString(false);
}
return $id;
}
/**
* Returns the normalized test name as class::method.
*
* @return list
*/
public function provides(): array
{
return $this->providedTests;
}
/**
* Returns a list of normalized dependency names, class::method.
*
* This list can differ from the raw dependencies as the resolver has
* no need for the [!][shallow]clone prefix that is filtered out
* during normalization.
*
* @return list
*/
public function requires(): array
{
return $this->dependencies;
}
/**
* Override to run the test and assert its state.
*
* @throws \SebastianBergmann\ObjectEnumerator\InvalidArgumentException
* @throws AssertionFailedError
* @throws Exception
* @throws ExpectationFailedException
* @throws Throwable
*/
protected function runTest()
{
if (trim($this->name) === '') {
throw new Exception(
'PHPUnit\Framework\TestCase::$name must be a non-blank string.'
);
}
$testArguments = array_merge($this->data, $this->dependencyInput);
$this->registerMockObjectsFromTestArguments($testArguments);
try {
$testResult = $this->{$this->name}(...array_values($testArguments));
} catch (Throwable $exception) {
if (!$this->checkExceptionExpectations($exception)) {
throw $exception;
}
if ($this->expectedException !== null) {
if ($this->expectedException === Error::class) {
$this->assertThat(
$exception,
LogicalOr::fromConstraints(
new ExceptionConstraint(Error::class),
new ExceptionConstraint(\Error::class)
)
);
} else {
$this->assertThat(
$exception,
new ExceptionConstraint(
$this->expectedException
)
);
}
}
if ($this->expectedExceptionMessage !== null) {
$this->assertThat(
$exception,
new ExceptionMessage(
$this->expectedExceptionMessage
)
);
}
if ($this->expectedExceptionMessageRegExp !== null) {
$this->assertThat(
$exception,
new ExceptionMessageRegularExpression(
$this->expectedExceptionMessageRegExp
)
);
}
if ($this->expectedExceptionCode !== null) {
$this->assertThat(
$exception,
new ExceptionCode(
$this->expectedExceptionCode
)
);
}
return;
}
if ($this->expectedException !== null) {
$this->assertThat(
null,
new ExceptionConstraint(
$this->expectedException
)
);
} elseif ($this->expectedExceptionMessage !== null) {
$this->numAssertions++;
throw new AssertionFailedError(
sprintf(
'Failed asserting that exception with message "%s" is thrown',
$this->expectedExceptionMessage
)
);
} elseif ($this->expectedExceptionMessageRegExp !== null) {
$this->numAssertions++;
throw new AssertionFailedError(
sprintf(
'Failed asserting that exception with message matching "%s" is thrown',
$this->expectedExceptionMessageRegExp
)
);
} elseif ($this->expectedExceptionCode !== null) {
$this->numAssertions++;
throw new AssertionFailedError(
sprintf(
'Failed asserting that exception with code "%s" is thrown',
$this->expectedExceptionCode
)
);
}
return $testResult;
}
/**
* This method is a wrapper for the ini_set() function that automatically
* resets the modified php.ini setting to its original value after the
* test is run.
*
* @throws Exception
*/
protected function iniSet(string $varName, string $newValue): void
{
$currentValue = ini_set($varName, $newValue);
if ($currentValue !== false) {
$this->iniSettings[$varName] = $currentValue;
} else {
throw new Exception(
sprintf(
'INI setting "%s" could not be set to "%s".',
$varName,
$newValue
)
);
}
}
/**
* This method is a wrapper for the setlocale() function that automatically
* resets the locale to its original value after the test is run.
*
* @throws Exception
*/
protected function setLocale(...$args): void
{
if (count($args) < 2) {
throw new Exception;
}
[$category, $locale] = $args;
if (!in_array($category, self::LOCALE_CATEGORIES, true)) {
throw new Exception;
}
if (!is_array($locale) && !is_string($locale)) {
throw new Exception;
}
$this->locale[$category] = setlocale($category, 0);
$result = setlocale(...$args);
if ($result === false) {
throw new Exception(
'The locale functionality is not implemented on your platform, ' .
'the specified locale does not exist or the category name is ' .
'invalid.'
);
}
}
/**
* Makes configurable stub for the specified class.
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string $originalClassName
*
* @psalm-return Stub&RealInstanceType
*/
protected function createStub(string $originalClassName): Stub
{
return $this->createMockObject($originalClassName);
}
/**
* Returns a mock object for the specified class.
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string $originalClassName
*
* @psalm-return MockObject&RealInstanceType
*/
protected function createMock(string $originalClassName): MockObject
{
return $this->createMockObject($originalClassName);
}
/**
* Returns a configured mock object for the specified class.
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string $originalClassName
*
* @psalm-return MockObject&RealInstanceType
*/
protected function createConfiguredMock(string $originalClassName, array $configuration): MockObject
{
$o = $this->createMockObject($originalClassName);
foreach ($configuration as $method => $return) {
$o->method($method)->willReturn($return);
}
return $o;
}
/**
* Returns a partial mock object for the specified class.
*
* @param string[] $methods
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string $originalClassName
*
* @psalm-return MockObject&RealInstanceType
*/
protected function createPartialMock(string $originalClassName, array $methods): MockObject
{
try {
$reflector = new ReflectionClass($originalClassName);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$mockedMethodsThatDontExist = array_filter(
$methods,
static function (string $method) use ($reflector)
{
return !$reflector->hasMethod($method);
}
);
if ($mockedMethodsThatDontExist) {
$this->addWarning(
sprintf(
'createPartialMock() called with method(s) %s that do not exist in %s. This will not be allowed in future versions of PHPUnit.',
implode(', ', $mockedMethodsThatDontExist),
$originalClassName
)
);
}
return $this->getMockBuilder($originalClassName)
->disableOriginalConstructor()
->disableOriginalClone()
->disableArgumentCloning()
->disallowMockingUnknownTypes()
->setMethods(empty($methods) ? null : $methods)
->getMock();
}
/**
* Returns a test proxy for the specified class.
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string $originalClassName
*
* @psalm-return MockObject&RealInstanceType
*/
protected function createTestProxy(string $originalClassName, array $constructorArguments = []): MockObject
{
return $this->getMockBuilder($originalClassName)
->setConstructorArgs($constructorArguments)
->enableProxyingToOriginalMethods()
->getMock();
}
/**
* Mocks the specified class and returns the name of the mocked class.
*
* @param null|array $methods $methods
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string|string $originalClassName
*
* @psalm-return class-string
*
* @deprecated
*/
protected function getMockClass(string $originalClassName, $methods = [], array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = false, bool $callOriginalClone = true, bool $callAutoload = true, bool $cloneArguments = false): string
{
$this->addWarning('PHPUnit\Framework\TestCase::getMockClass() is deprecated and will be removed in PHPUnit 10.');
$this->recordDoubledType($originalClassName);
$mock = $this->getMockObjectGenerator()->getMock(
$originalClassName,
$methods,
$arguments,
$mockClassName,
$callOriginalConstructor,
$callOriginalClone,
$callAutoload,
$cloneArguments
);
return get_class($mock);
}
/**
* Returns a mock object for the specified abstract class with all abstract
* methods of the class mocked. Concrete methods are not mocked by default.
* To mock concrete methods, use the 7th parameter ($mockedMethods).
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string $originalClassName
*
* @psalm-return MockObject&RealInstanceType
*/
protected function getMockForAbstractClass(string $originalClassName, array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, array $mockedMethods = [], bool $cloneArguments = false): MockObject
{
$this->recordDoubledType($originalClassName);
$mockObject = $this->getMockObjectGenerator()->getMockForAbstractClass(
$originalClassName,
$arguments,
$mockClassName,
$callOriginalConstructor,
$callOriginalClone,
$callAutoload,
$mockedMethods,
$cloneArguments
);
$this->registerMockObject($mockObject);
return $mockObject;
}
/**
* Returns a mock object based on the given WSDL file.
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string|string $originalClassName
*
* @psalm-return MockObject&RealInstanceType
*/
protected function getMockFromWsdl(string $wsdlFile, string $originalClassName = '', string $mockClassName = '', array $methods = [], bool $callOriginalConstructor = true, array $options = []): MockObject
{
$this->recordDoubledType(SoapClient::class);
if ($originalClassName === '') {
$fileName = pathinfo(basename(parse_url($wsdlFile, PHP_URL_PATH)), PATHINFO_FILENAME);
$originalClassName = preg_replace('/\W/', '', $fileName);
}
if (!class_exists($originalClassName)) {
eval(
$this->getMockObjectGenerator()->generateClassFromWsdl(
$wsdlFile,
$originalClassName,
$methods,
$options
)
);
}
$mockObject = $this->getMockObjectGenerator()->getMock(
$originalClassName,
$methods,
['', $options],
$mockClassName,
$callOriginalConstructor,
false,
false
);
$this->registerMockObject($mockObject);
return $mockObject;
}
/**
* Returns a mock object for the specified trait with all abstract methods
* of the trait mocked. Concrete methods to mock can be specified with the
* `$mockedMethods` parameter.
*
* @psalm-param trait-string $traitName
*/
protected function getMockForTrait(string $traitName, array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, array $mockedMethods = [], bool $cloneArguments = false): MockObject
{
$this->recordDoubledType($traitName);
$mockObject = $this->getMockObjectGenerator()->getMockForTrait(
$traitName,
$arguments,
$mockClassName,
$callOriginalConstructor,
$callOriginalClone,
$callAutoload,
$mockedMethods,
$cloneArguments
);
$this->registerMockObject($mockObject);
return $mockObject;
}
/**
* Returns an object for the specified trait.
*
* @psalm-param trait-string $traitName
*/
protected function getObjectForTrait(string $traitName, array $arguments = [], string $traitClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true): object
{
$this->recordDoubledType($traitName);
return $this->getMockObjectGenerator()->getObjectForTrait(
$traitName,
$traitClassName,
$callAutoload,
$callOriginalConstructor,
$arguments
);
}
/**
* @throws \Prophecy\Exception\Doubler\ClassNotFoundException
* @throws \Prophecy\Exception\Doubler\DoubleException
* @throws \Prophecy\Exception\Doubler\InterfaceNotFoundException
*
* @psalm-param class-string|null $classOrInterface
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4141
*/
protected function prophesize(?string $classOrInterface = null): ObjectProphecy
{
if (!class_exists(Prophet::class)) {
throw new Exception('This test uses TestCase::prophesize(), but phpspec/prophecy is not installed. Please run "composer require --dev phpspec/prophecy".');
}
$this->addWarning('PHPUnit\Framework\TestCase::prophesize() is deprecated and will be removed in PHPUnit 10. Please use the trait provided by phpspec/prophecy-phpunit.');
if (is_string($classOrInterface)) {
$this->recordDoubledType($classOrInterface);
}
return $this->getProphet()->prophesize($classOrInterface);
}
/**
* Creates a default TestResult object.
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
protected function createResult(): TestResult
{
return new TestResult;
}
/**
* This method is called when a test method did not execute successfully.
*
* @throws Throwable
*/
protected function onNotSuccessfulTest(Throwable $t): void
{
throw $t;
}
protected function recordDoubledType(string $originalClassName): void
{
$this->doubledTypes[] = $originalClassName;
}
/**
* @throws Throwable
*/
private function verifyMockObjects(): void
{
foreach ($this->mockObjects as $mockObject) {
if ($mockObject->__phpunit_hasMatchers()) {
$this->numAssertions++;
}
$mockObject->__phpunit_verify(
$this->shouldInvocationMockerBeReset($mockObject)
);
}
if ($this->prophet !== null) {
try {
$this->prophet->checkPredictions();
} finally {
foreach ($this->prophet->getProphecies() as $objectProphecy) {
foreach ($objectProphecy->getMethodProphecies() as $methodProphecies) {
foreach ($methodProphecies as $methodProphecy) {
/* @var MethodProphecy $methodProphecy */
$this->numAssertions += count($methodProphecy->getCheckedPredictions());
}
}
}
}
}
}
/**
* @throws SkippedTestError
* @throws SyntheticSkippedError
* @throws Warning
*/
private function checkRequirements(): void
{
if (!$this->name || !method_exists($this, $this->name)) {
return;
}
$missingRequirements = TestUtil::getMissingRequirements(
static::class,
$this->name
);
if (!empty($missingRequirements)) {
$this->markTestSkipped(implode(PHP_EOL, $missingRequirements));
}
}
private function handleDependencies(): bool
{
if ([] === $this->dependencies || $this->inIsolation) {
return true;
}
$passed = $this->result->passed();
$passedKeys = array_keys($passed);
$numKeys = count($passedKeys);
for ($i = 0; $i < $numKeys; $i++) {
$pos = strpos($passedKeys[$i], ' with data set');
if ($pos !== false) {
$passedKeys[$i] = substr($passedKeys[$i], 0, $pos);
}
}
$passedKeys = array_flip(array_unique($passedKeys));
foreach ($this->dependencies as $dependency) {
if (!$dependency->isValid()) {
$this->markSkippedForNotSpecifyingDependency();
return false;
}
if ($dependency->targetIsClass()) {
$dependencyClassName = $dependency->getTargetClassName();
if (array_search($dependencyClassName, $this->result->passedClasses(), true) === false) {
$this->markSkippedForMissingDependency($dependency);
return false;
}
continue;
}
$dependencyTarget = $dependency->getTarget();
if (!isset($passedKeys[$dependencyTarget])) {
if (!$this->isCallableTestMethod($dependencyTarget)) {
$this->markWarningForUncallableDependency($dependency);
} else {
$this->markSkippedForMissingDependency($dependency);
}
return false;
}
if (isset($passed[$dependencyTarget])) {
if ($passed[$dependencyTarget]['size'] != \PHPUnit\Util\Test::UNKNOWN &&
$this->getSize() != \PHPUnit\Util\Test::UNKNOWN &&
$passed[$dependencyTarget]['size'] > $this->getSize()) {
$this->result->addError(
$this,
new SkippedTestError(
'This test depends on a test that is larger than itself.'
),
0
);
return false;
}
if ($dependency->useDeepClone()) {
$deepCopy = new DeepCopy;
$deepCopy->skipUncloneable(false);
$this->dependencyInput[$dependencyTarget] = $deepCopy->copy($passed[$dependencyTarget]['result']);
} elseif ($dependency->useShallowClone()) {
$this->dependencyInput[$dependencyTarget] = clone $passed[$dependencyTarget]['result'];
} else {
$this->dependencyInput[$dependencyTarget] = $passed[$dependencyTarget]['result'];
}
} else {
$this->dependencyInput[$dependencyTarget] = null;
}
}
return true;
}
private function markSkippedForNotSpecifyingDependency(): void
{
$this->status = BaseTestRunner::STATUS_SKIPPED;
$this->result->startTest($this);
$this->result->addError(
$this,
new SkippedTestError(
'This method has an invalid @depends annotation.'
),
0
);
$this->result->endTest($this, 0);
}
private function markSkippedForMissingDependency(ExecutionOrderDependency $dependency): void
{
$this->status = BaseTestRunner::STATUS_SKIPPED;
$this->result->startTest($this);
$this->result->addError(
$this,
new SkippedTestError(
sprintf(
'This test depends on "%s" to pass.',
$dependency->getTarget()
)
),
0
);
$this->result->endTest($this, 0);
}
private function markWarningForUncallableDependency(ExecutionOrderDependency $dependency): void
{
$this->status = BaseTestRunner::STATUS_WARNING;
$this->result->startTest($this);
$this->result->addWarning(
$this,
new Warning(
sprintf(
'This test depends on "%s" which does not exist.',
$dependency->getTarget()
)
),
0
);
$this->result->endTest($this, 0);
}
/**
* Get the mock object generator, creating it if it doesn't exist.
*/
private function getMockObjectGenerator(): MockGenerator
{
if ($this->mockObjectGenerator === null) {
$this->mockObjectGenerator = new MockGenerator;
}
return $this->mockObjectGenerator;
}
private function startOutputBuffering(): void
{
ob_start();
$this->outputBufferingActive = true;
$this->outputBufferingLevel = ob_get_level();
}
/**
* @throws RiskyTestError
*/
private function stopOutputBuffering(): void
{
if (ob_get_level() !== $this->outputBufferingLevel) {
while (ob_get_level() >= $this->outputBufferingLevel) {
ob_end_clean();
}
throw new RiskyTestError(
'Test code or tested code did not (only) close its own output buffers'
);
}
$this->output = ob_get_contents();
if ($this->outputCallback !== false) {
$this->output = (string) call_user_func($this->outputCallback, $this->output);
}
ob_end_clean();
$this->outputBufferingActive = false;
$this->outputBufferingLevel = ob_get_level();
}
private function snapshotGlobalState(): void
{
if ($this->runTestInSeparateProcess || $this->inIsolation ||
(!$this->backupGlobals && !$this->backupStaticAttributes)) {
return;
}
$this->snapshot = $this->createGlobalStateSnapshot($this->backupGlobals === true);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws RiskyTestError
*/
private function restoreGlobalState(): void
{
if (!$this->snapshot instanceof Snapshot) {
return;
}
if ($this->beStrictAboutChangesToGlobalState) {
try {
$this->compareGlobalStateSnapshots(
$this->snapshot,
$this->createGlobalStateSnapshot($this->backupGlobals === true)
);
} catch (RiskyTestError $rte) {
// Intentionally left empty
}
}
$restorer = new Restorer;
if ($this->backupGlobals) {
$restorer->restoreGlobalVariables($this->snapshot);
}
if ($this->backupStaticAttributes) {
$restorer->restoreStaticAttributes($this->snapshot);
}
$this->snapshot = null;
if (isset($rte)) {
throw $rte;
}
}
private function createGlobalStateSnapshot(bool $backupGlobals): Snapshot
{
$excludeList = new ExcludeList;
foreach ($this->backupGlobalsExcludeList as $globalVariable) {
$excludeList->addGlobalVariable($globalVariable);
}
if (!empty($this->backupGlobalsBlacklist)) {
$this->addWarning('PHPUnit\Framework\TestCase::$backupGlobalsBlacklist is deprecated and will be removed in PHPUnit 10. Please use PHPUnit\Framework\TestCase::$backupGlobalsExcludeList instead.');
foreach ($this->backupGlobalsBlacklist as $globalVariable) {
$excludeList->addGlobalVariable($globalVariable);
}
}
if (!defined('PHPUNIT_TESTSUITE')) {
$excludeList->addClassNamePrefix('PHPUnit');
$excludeList->addClassNamePrefix('SebastianBergmann\CodeCoverage');
$excludeList->addClassNamePrefix('SebastianBergmann\FileIterator');
$excludeList->addClassNamePrefix('SebastianBergmann\Invoker');
$excludeList->addClassNamePrefix('SebastianBergmann\Template');
$excludeList->addClassNamePrefix('SebastianBergmann\Timer');
$excludeList->addClassNamePrefix('Doctrine\Instantiator');
$excludeList->addClassNamePrefix('Prophecy');
$excludeList->addStaticAttribute(ComparatorFactory::class, 'instance');
foreach ($this->backupStaticAttributesExcludeList as $class => $attributes) {
foreach ($attributes as $attribute) {
$excludeList->addStaticAttribute($class, $attribute);
}
}
if (!empty($this->backupStaticAttributesBlacklist)) {
$this->addWarning('PHPUnit\Framework\TestCase::$backupStaticAttributesBlacklist is deprecated and will be removed in PHPUnit 10. Please use PHPUnit\Framework\TestCase::$backupStaticAttributesExcludeList instead.');
foreach ($this->backupStaticAttributesBlacklist as $class => $attributes) {
foreach ($attributes as $attribute) {
$excludeList->addStaticAttribute($class, $attribute);
}
}
}
}
return new Snapshot(
$excludeList,
$backupGlobals,
(bool) $this->backupStaticAttributes,
false,
false,
false,
false,
false,
false,
false
);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws RiskyTestError
*/
private function compareGlobalStateSnapshots(Snapshot $before, Snapshot $after): void
{
$backupGlobals = $this->backupGlobals === null || $this->backupGlobals;
if ($backupGlobals) {
$this->compareGlobalStateSnapshotPart(
$before->globalVariables(),
$after->globalVariables(),
"--- Global variables before the test\n+++ Global variables after the test\n"
);
$this->compareGlobalStateSnapshotPart(
$before->superGlobalVariables(),
$after->superGlobalVariables(),
"--- Super-global variables before the test\n+++ Super-global variables after the test\n"
);
}
if ($this->backupStaticAttributes) {
$this->compareGlobalStateSnapshotPart(
$before->staticAttributes(),
$after->staticAttributes(),
"--- Static attributes before the test\n+++ Static attributes after the test\n"
);
}
}
/**
* @throws RiskyTestError
*/
private function compareGlobalStateSnapshotPart(array $before, array $after, string $header): void
{
if ($before != $after) {
$differ = new Differ($header);
$exporter = new Exporter;
$diff = $differ->diff(
$exporter->export($before),
$exporter->export($after)
);
throw new RiskyTestError(
$diff
);
}
}
private function getProphet(): Prophet
{
if ($this->prophet === null) {
$this->prophet = new Prophet;
}
return $this->prophet;
}
/**
* @throws \SebastianBergmann\ObjectEnumerator\InvalidArgumentException
*/
private function shouldInvocationMockerBeReset(MockObject $mock): bool
{
$enumerator = new Enumerator;
foreach ($enumerator->enumerate($this->dependencyInput) as $object) {
if ($mock === $object) {
return false;
}
}
if (!is_array($this->testResult) && !is_object($this->testResult)) {
return true;
}
return !in_array($mock, $enumerator->enumerate($this->testResult), true);
}
/**
* @throws \SebastianBergmann\ObjectEnumerator\InvalidArgumentException
* @throws \SebastianBergmann\ObjectReflector\InvalidArgumentException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function registerMockObjectsFromTestArguments(array $testArguments, array &$visited = []): void
{
if ($this->registerMockObjectsFromTestArgumentsRecursively) {
foreach ((new Enumerator)->enumerate($testArguments) as $object) {
if ($object instanceof MockObject) {
$this->registerMockObject($object);
}
}
} else {
foreach ($testArguments as $testArgument) {
if ($testArgument instanceof MockObject) {
$testArgument = Cloner::clone($testArgument);
$this->registerMockObject($testArgument);
} elseif (is_array($testArgument) && !in_array($testArgument, $visited, true)) {
$visited[] = $testArgument;
$this->registerMockObjectsFromTestArguments(
$testArgument,
$visited
);
}
}
}
}
private function setDoesNotPerformAssertionsFromAnnotation(): void
{
$annotations = TestUtil::parseTestMethodAnnotations(
static::class,
$this->name
);
if (isset($annotations['method']['doesNotPerformAssertions'])) {
$this->doesNotPerformAssertions = true;
}
}
private function unregisterCustomComparators(): void
{
$factory = ComparatorFactory::getInstance();
foreach ($this->customComparators as $comparator) {
$factory->unregister($comparator);
}
$this->customComparators = [];
}
private function cleanupIniSettings(): void
{
foreach ($this->iniSettings as $varName => $oldValue) {
ini_set($varName, $oldValue);
}
$this->iniSettings = [];
}
private function cleanupLocaleSettings(): void
{
foreach ($this->locale as $category => $locale) {
setlocale($category, $locale);
}
$this->locale = [];
}
/**
* @throws Exception
*/
private function checkExceptionExpectations(Throwable $throwable): bool
{
$result = false;
if ($this->expectedException !== null || $this->expectedExceptionCode !== null || $this->expectedExceptionMessage !== null || $this->expectedExceptionMessageRegExp !== null) {
$result = true;
}
if ($throwable instanceof Exception) {
$result = false;
}
if (is_string($this->expectedException)) {
try {
$reflector = new ReflectionClass($this->expectedException);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if ($this->expectedException === 'PHPUnit\Framework\Exception' ||
$this->expectedException === '\PHPUnit\Framework\Exception' ||
$reflector->isSubclassOf(Exception::class)) {
$result = true;
}
}
return $result;
}
private function runInSeparateProcess(): bool
{
return ($this->runTestInSeparateProcess || $this->runClassInSeparateProcess) &&
!$this->inIsolation && !$this instanceof PhptTestCase;
}
private function isCallableTestMethod(string $dependency): bool
{
[$className, $methodName] = explode('::', $dependency);
if (!class_exists($className)) {
return false;
}
try {
$class = new ReflectionClass($className);
} catch (ReflectionException $e) {
return false;
}
if (!$class->isSubclassOf(__CLASS__)) {
return false;
}
if (!$class->hasMethod($methodName)) {
return false;
}
try {
$method = $class->getMethod($methodName);
} catch (ReflectionException $e) {
return false;
}
return TestUtil::isTestMethod($method);
}
/**
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string $originalClassName
*
* @psalm-return MockObject&RealInstanceType
*/
private function createMockObject(string $originalClassName): MockObject
{
return $this->getMockBuilder($originalClassName)
->disableOriginalConstructor()
->disableOriginalClone()
->disableArgumentCloning()
->disallowMockingUnknownTypes()
->getMock();
}
}
PK [WyVg * src/Framework/ExecutionOrderDependency.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use function array_filter;
use function array_map;
use function array_values;
use function count;
use function explode;
use function in_array;
use function strpos;
use function trim;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ExecutionOrderDependency
{
/**
* @var string
*/
private $className = '';
/**
* @var string
*/
private $methodName = '';
/**
* @var bool
*/
private $useShallowClone = false;
/**
* @var bool
*/
private $useDeepClone = false;
public static function createFromDependsAnnotation(string $className, string $annotation): self
{
// Split clone option and target
$parts = explode(' ', trim($annotation), 2);
if (count($parts) === 1) {
$cloneOption = '';
$target = $parts[0];
} else {
$cloneOption = $parts[0];
$target = $parts[1];
}
// Prefix provided class for targets assumed to be in scope
if ($target !== '' && strpos($target, '::') === false) {
$target = $className . '::' . $target;
}
return new self($target, null, $cloneOption);
}
/**
* @psalm-param list $dependencies
*
* @psalm-return list
*/
public static function filterInvalid(array $dependencies): array
{
return array_values(
array_filter(
$dependencies,
static function (self $d)
{
return $d->isValid();
}
)
);
}
/**
* @psalm-param list $existing
* @psalm-param list $additional
*
* @psalm-return list
*/
public static function mergeUnique(array $existing, array $additional): array
{
$existingTargets = array_map(
static function ($dependency)
{
return $dependency->getTarget();
},
$existing
);
foreach ($additional as $dependency) {
if (in_array($dependency->getTarget(), $existingTargets, true)) {
continue;
}
$existingTargets[] = $dependency->getTarget();
$existing[] = $dependency;
}
return $existing;
}
/**
* @psalm-param list $left
* @psalm-param list $right
*
* @psalm-return list
*/
public static function diff(array $left, array $right): array
{
if ($right === []) {
return $left;
}
if ($left === []) {
return [];
}
$diff = [];
$rightTargets = array_map(
static function ($dependency)
{
return $dependency->getTarget();
},
$right
);
foreach ($left as $dependency) {
if (in_array($dependency->getTarget(), $rightTargets, true)) {
continue;
}
$diff[] = $dependency;
}
return $diff;
}
public function __construct(string $classOrCallableName, ?string $methodName = null, ?string $option = null)
{
if ($classOrCallableName === '') {
return;
}
if (strpos($classOrCallableName, '::') !== false) {
[$this->className, $this->methodName] = explode('::', $classOrCallableName);
} else {
$this->className = $classOrCallableName;
$this->methodName = !empty($methodName) ? $methodName : 'class';
}
if ($option === 'clone') {
$this->useDeepClone = true;
} elseif ($option === 'shallowClone') {
$this->useShallowClone = true;
}
}
public function __toString(): string
{
return $this->getTarget();
}
public function isValid(): bool
{
// Invalid dependencies can be declared and are skipped by the runner
return $this->className !== '' && $this->methodName !== '';
}
public function useShallowClone(): bool
{
return $this->useShallowClone;
}
public function useDeepClone(): bool
{
return $this->useDeepClone;
}
public function targetIsClass(): bool
{
return $this->methodName === 'class';
}
public function getTarget(): string
{
return $this->isValid()
? $this->className . '::' . $this->methodName
: '';
}
public function getTargetClassName(): string
{
return $this->className;
}
}
PK [iEw w $ src/Framework/IncompleteTestCase.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class IncompleteTestCase extends TestCase
{
/**
* @var bool
*/
protected $backupGlobals = false;
/**
* @var bool
*/
protected $backupStaticAttributes = false;
/**
* @var bool
*/
protected $runTestInSeparateProcess = false;
/**
* @var string
*/
private $message;
public function __construct(string $className, string $methodName, string $message = '')
{
parent::__construct($className . '::' . $methodName);
$this->message = $message;
}
public function getMessage(): string
{
return $this->message;
}
/**
* Returns a string representation of the test case.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
return $this->getName();
}
/**
* @throws Exception
*/
protected function runTest(): void
{
$this->markTestIncomplete($this->message);
}
}
PK [H src/Framework/TestResult.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const PHP_EOL;
use function class_exists;
use function count;
use function extension_loaded;
use function function_exists;
use function get_class;
use function sprintf;
use function xdebug_get_monitored_functions;
use function xdebug_is_debugger_active;
use function xdebug_start_function_monitor;
use function xdebug_stop_function_monitor;
use AssertionError;
use Countable;
use Error;
use PHPUnit\Util\ErrorHandler;
use PHPUnit\Util\ExcludeList;
use PHPUnit\Util\Printer;
use PHPUnit\Util\Test as TestUtil;
use ReflectionClass;
use ReflectionException;
use SebastianBergmann\CodeCoverage\CodeCoverage;
use SebastianBergmann\CodeCoverage\Exception as OriginalCodeCoverageException;
use SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException;
use SebastianBergmann\Invoker\Invoker;
use SebastianBergmann\Invoker\TimeoutException;
use SebastianBergmann\ResourceOperations\ResourceOperations;
use SebastianBergmann\Timer\Timer;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TestResult implements Countable
{
/**
* @var array
*/
private $passed = [];
/**
* @var array
*/
private $passedTestClasses = [];
/**
* @var bool
*/
private $currentTestSuiteFailed = false;
/**
* @var TestFailure[]
*/
private $errors = [];
/**
* @var TestFailure[]
*/
private $failures = [];
/**
* @var TestFailure[]
*/
private $warnings = [];
/**
* @var TestFailure[]
*/
private $notImplemented = [];
/**
* @var TestFailure[]
*/
private $risky = [];
/**
* @var TestFailure[]
*/
private $skipped = [];
/**
* @deprecated Use the `TestHook` interfaces instead
*
* @var TestListener[]
*/
private $listeners = [];
/**
* @var int
*/
private $runTests = 0;
/**
* @var float
*/
private $time = 0;
/**
* Code Coverage information.
*
* @var CodeCoverage
*/
private $codeCoverage;
/**
* @var bool
*/
private $convertDeprecationsToExceptions = false;
/**
* @var bool
*/
private $convertErrorsToExceptions = true;
/**
* @var bool
*/
private $convertNoticesToExceptions = true;
/**
* @var bool
*/
private $convertWarningsToExceptions = true;
/**
* @var bool
*/
private $stop = false;
/**
* @var bool
*/
private $stopOnError = false;
/**
* @var bool
*/
private $stopOnFailure = false;
/**
* @var bool
*/
private $stopOnWarning = false;
/**
* @var bool
*/
private $beStrictAboutTestsThatDoNotTestAnything = true;
/**
* @var bool
*/
private $beStrictAboutOutputDuringTests = false;
/**
* @var bool
*/
private $beStrictAboutTodoAnnotatedTests = false;
/**
* @var bool
*/
private $beStrictAboutResourceUsageDuringSmallTests = false;
/**
* @var bool
*/
private $enforceTimeLimit = false;
/**
* @var bool
*/
private $forceCoversAnnotation = false;
/**
* @var int
*/
private $timeoutForSmallTests = 1;
/**
* @var int
*/
private $timeoutForMediumTests = 10;
/**
* @var int
*/
private $timeoutForLargeTests = 60;
/**
* @var bool
*/
private $stopOnRisky = false;
/**
* @var bool
*/
private $stopOnIncomplete = false;
/**
* @var bool
*/
private $stopOnSkipped = false;
/**
* @var bool
*/
private $lastTestFailed = false;
/**
* @var int
*/
private $defaultTimeLimit = 0;
/**
* @var bool
*/
private $stopOnDefect = false;
/**
* @var bool
*/
private $registerMockObjectsFromTestArgumentsRecursively = false;
/**
* @deprecated Use the `TestHook` interfaces instead
*
* @codeCoverageIgnore
*
* Registers a TestListener.
*/
public function addListener(TestListener $listener): void
{
$this->listeners[] = $listener;
}
/**
* @deprecated Use the `TestHook` interfaces instead
*
* @codeCoverageIgnore
*
* Unregisters a TestListener.
*/
public function removeListener(TestListener $listener): void
{
foreach ($this->listeners as $key => $_listener) {
if ($listener === $_listener) {
unset($this->listeners[$key]);
}
}
}
/**
* @deprecated Use the `TestHook` interfaces instead
*
* @codeCoverageIgnore
*
* Flushes all flushable TestListeners.
*/
public function flushListeners(): void
{
foreach ($this->listeners as $listener) {
if ($listener instanceof Printer) {
$listener->flush();
}
}
}
/**
* Adds an error to the list of errors.
*/
public function addError(Test $test, Throwable $t, float $time): void
{
if ($t instanceof RiskyTestError) {
$this->recordRisky($test, $t);
$notifyMethod = 'addRiskyTest';
if ($test instanceof TestCase) {
$test->markAsRisky();
}
if ($this->stopOnRisky || $this->stopOnDefect) {
$this->stop();
}
} elseif ($t instanceof IncompleteTest) {
$this->recordNotImplemented($test, $t);
$notifyMethod = 'addIncompleteTest';
if ($this->stopOnIncomplete) {
$this->stop();
}
} elseif ($t instanceof SkippedTest) {
$this->recordSkipped($test, $t);
$notifyMethod = 'addSkippedTest';
if ($this->stopOnSkipped) {
$this->stop();
}
} else {
$this->recordError($test, $t);
$notifyMethod = 'addError';
if ($this->stopOnError || $this->stopOnFailure) {
$this->stop();
}
}
// @see https://github.com/sebastianbergmann/phpunit/issues/1953
if ($t instanceof Error) {
$t = new ExceptionWrapper($t);
}
foreach ($this->listeners as $listener) {
$listener->{$notifyMethod}($test, $t, $time);
}
$this->lastTestFailed = true;
$this->time += $time;
}
/**
* Adds a warning to the list of warnings.
* The passed in exception caused the warning.
*/
public function addWarning(Test $test, Warning $e, float $time): void
{
if ($this->stopOnWarning || $this->stopOnDefect) {
$this->stop();
}
$this->recordWarning($test, $e);
foreach ($this->listeners as $listener) {
$listener->addWarning($test, $e, $time);
}
$this->time += $time;
}
/**
* Adds a failure to the list of failures.
* The passed in exception caused the failure.
*/
public function addFailure(Test $test, AssertionFailedError $e, float $time): void
{
if ($e instanceof RiskyTestError || $e instanceof OutputError) {
$this->recordRisky($test, $e);
$notifyMethod = 'addRiskyTest';
if ($test instanceof TestCase) {
$test->markAsRisky();
}
if ($this->stopOnRisky || $this->stopOnDefect) {
$this->stop();
}
} elseif ($e instanceof IncompleteTest) {
$this->recordNotImplemented($test, $e);
$notifyMethod = 'addIncompleteTest';
if ($this->stopOnIncomplete) {
$this->stop();
}
} elseif ($e instanceof SkippedTest) {
$this->recordSkipped($test, $e);
$notifyMethod = 'addSkippedTest';
if ($this->stopOnSkipped) {
$this->stop();
}
} else {
$this->failures[] = new TestFailure($test, $e);
$notifyMethod = 'addFailure';
if ($this->stopOnFailure || $this->stopOnDefect) {
$this->stop();
}
}
foreach ($this->listeners as $listener) {
$listener->{$notifyMethod}($test, $e, $time);
}
$this->lastTestFailed = true;
$this->time += $time;
}
/**
* Informs the result that a test suite will be started.
*/
public function startTestSuite(TestSuite $suite): void
{
$this->currentTestSuiteFailed = false;
foreach ($this->listeners as $listener) {
$listener->startTestSuite($suite);
}
}
/**
* Informs the result that a test suite was completed.
*/
public function endTestSuite(TestSuite $suite): void
{
if (!$this->currentTestSuiteFailed) {
$this->passedTestClasses[] = $suite->getName();
}
foreach ($this->listeners as $listener) {
$listener->endTestSuite($suite);
}
}
/**
* Informs the result that a test will be started.
*/
public function startTest(Test $test): void
{
$this->lastTestFailed = false;
$this->runTests += count($test);
foreach ($this->listeners as $listener) {
$listener->startTest($test);
}
}
/**
* Informs the result that a test was completed.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function endTest(Test $test, float $time): void
{
foreach ($this->listeners as $listener) {
$listener->endTest($test, $time);
}
if (!$this->lastTestFailed && $test instanceof TestCase) {
$class = get_class($test);
$key = $class . '::' . $test->getName();
$this->passed[$key] = [
'result' => $test->getResult(),
'size' => TestUtil::getSize(
$class,
$test->getName(false)
),
];
$this->time += $time;
}
if ($this->lastTestFailed && $test instanceof TestCase) {
$this->currentTestSuiteFailed = true;
}
}
/**
* Returns true if no risky test occurred.
*/
public function allHarmless(): bool
{
return $this->riskyCount() === 0;
}
/**
* Gets the number of risky tests.
*/
public function riskyCount(): int
{
return count($this->risky);
}
/**
* Returns true if no incomplete test occurred.
*/
public function allCompletelyImplemented(): bool
{
return $this->notImplementedCount() === 0;
}
/**
* Gets the number of incomplete tests.
*/
public function notImplementedCount(): int
{
return count($this->notImplemented);
}
/**
* Returns an array of TestFailure objects for the risky tests.
*
* @return TestFailure[]
*/
public function risky(): array
{
return $this->risky;
}
/**
* Returns an array of TestFailure objects for the incomplete tests.
*
* @return TestFailure[]
*/
public function notImplemented(): array
{
return $this->notImplemented;
}
/**
* Returns true if no test has been skipped.
*/
public function noneSkipped(): bool
{
return $this->skippedCount() === 0;
}
/**
* Gets the number of skipped tests.
*/
public function skippedCount(): int
{
return count($this->skipped);
}
/**
* Returns an array of TestFailure objects for the skipped tests.
*
* @return TestFailure[]
*/
public function skipped(): array
{
return $this->skipped;
}
/**
* Gets the number of detected errors.
*/
public function errorCount(): int
{
return count($this->errors);
}
/**
* Returns an array of TestFailure objects for the errors.
*
* @return TestFailure[]
*/
public function errors(): array
{
return $this->errors;
}
/**
* Gets the number of detected failures.
*/
public function failureCount(): int
{
return count($this->failures);
}
/**
* Returns an array of TestFailure objects for the failures.
*
* @return TestFailure[]
*/
public function failures(): array
{
return $this->failures;
}
/**
* Gets the number of detected warnings.
*/
public function warningCount(): int
{
return count($this->warnings);
}
/**
* Returns an array of TestFailure objects for the warnings.
*
* @return TestFailure[]
*/
public function warnings(): array
{
return $this->warnings;
}
/**
* Returns the names of the tests that have passed.
*/
public function passed(): array
{
return $this->passed;
}
/**
* Returns the names of the TestSuites that have passed.
*
* This enables @depends-annotations for TestClassName::class
*/
public function passedClasses(): array
{
return $this->passedTestClasses;
}
/**
* Returns whether code coverage information should be collected.
*/
public function getCollectCodeCoverageInformation(): bool
{
return $this->codeCoverage !== null;
}
/**
* Runs a TestCase.
*
* @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws CodeCoverageException
* @throws UnintentionallyCoveredCodeException
*/
public function run(Test $test): void
{
Assert::resetCount();
$size = TestUtil::UNKNOWN;
if ($test instanceof TestCase) {
$test->setRegisterMockObjectsFromTestArgumentsRecursively(
$this->registerMockObjectsFromTestArgumentsRecursively
);
$isAnyCoverageRequired = TestUtil::requiresCodeCoverageDataCollection($test);
$size = $test->getSize();
}
$error = false;
$failure = false;
$warning = false;
$incomplete = false;
$risky = false;
$skipped = false;
$this->startTest($test);
if ($this->convertDeprecationsToExceptions || $this->convertErrorsToExceptions || $this->convertNoticesToExceptions || $this->convertWarningsToExceptions) {
$errorHandler = new ErrorHandler(
$this->convertDeprecationsToExceptions,
$this->convertErrorsToExceptions,
$this->convertNoticesToExceptions,
$this->convertWarningsToExceptions
);
$errorHandler->register();
}
$collectCodeCoverage = $this->codeCoverage !== null &&
!$test instanceof ErrorTestCase &&
!$test instanceof WarningTestCase &&
$isAnyCoverageRequired;
if ($collectCodeCoverage) {
$this->codeCoverage->start($test);
}
$monitorFunctions = $this->beStrictAboutResourceUsageDuringSmallTests &&
!$test instanceof ErrorTestCase &&
!$test instanceof WarningTestCase &&
$size === TestUtil::SMALL &&
function_exists('xdebug_start_function_monitor');
if ($monitorFunctions) {
/* @noinspection ForgottenDebugOutputInspection */
xdebug_start_function_monitor(ResourceOperations::getFunctions());
}
$timer = new Timer;
$timer->start();
try {
$invoker = new Invoker;
if (!$test instanceof ErrorTestCase &&
!$test instanceof WarningTestCase &&
$this->shouldTimeLimitBeEnforced($size) &&
$invoker->canInvokeWithTimeout()) {
switch ($size) {
case TestUtil::SMALL:
$_timeout = $this->timeoutForSmallTests;
break;
case TestUtil::MEDIUM:
$_timeout = $this->timeoutForMediumTests;
break;
case TestUtil::LARGE:
$_timeout = $this->timeoutForLargeTests;
break;
default:
$_timeout = $this->defaultTimeLimit;
}
$invoker->invoke([$test, 'runBare'], [], $_timeout);
} else {
$test->runBare();
}
} catch (TimeoutException $e) {
$this->addFailure(
$test,
new RiskyTestError(
$e->getMessage()
),
$_timeout
);
$risky = true;
} catch (AssertionFailedError $e) {
$failure = true;
if ($e instanceof RiskyTestError) {
$risky = true;
} elseif ($e instanceof IncompleteTestError) {
$incomplete = true;
} elseif ($e instanceof SkippedTestError) {
$skipped = true;
}
} catch (AssertionError $e) {
$test->addToAssertionCount(1);
$failure = true;
$frame = $e->getTrace()[0];
$e = new AssertionFailedError(
sprintf(
'%s in %s:%s',
$e->getMessage(),
$frame['file'] ?? $e->getFile(),
$frame['line'] ?? $e->getLine()
),
0,
$e
);
} catch (Warning $e) {
$warning = true;
} catch (Exception $e) {
$error = true;
} catch (Throwable $e) {
$e = new ExceptionWrapper($e);
$error = true;
}
$time = $timer->stop()->asSeconds();
$test->addToAssertionCount(Assert::getCount());
if ($monitorFunctions) {
$excludeList = new ExcludeList;
/** @noinspection ForgottenDebugOutputInspection */
$functions = xdebug_get_monitored_functions();
/* @noinspection ForgottenDebugOutputInspection */
xdebug_stop_function_monitor();
foreach ($functions as $function) {
if (!$excludeList->isExcluded($function['filename'])) {
$this->addFailure(
$test,
new RiskyTestError(
sprintf(
'%s() used in %s:%s',
$function['function'],
$function['filename'],
$function['lineno']
)
),
$time
);
}
}
}
if ($this->beStrictAboutTestsThatDoNotTestAnything &&
$test->getNumAssertions() === 0) {
$risky = true;
}
if ($this->forceCoversAnnotation && !$error && !$failure && !$warning && !$incomplete && !$skipped && !$risky) {
$annotations = TestUtil::parseTestMethodAnnotations(
get_class($test),
$test->getName(false)
);
if (!isset($annotations['class']['covers']) &&
!isset($annotations['method']['covers']) &&
!isset($annotations['class']['coversNothing']) &&
!isset($annotations['method']['coversNothing'])) {
$this->addFailure(
$test,
new MissingCoversAnnotationException(
'This test does not have a @covers annotation but is expected to have one'
),
$time
);
$risky = true;
}
}
if ($collectCodeCoverage) {
$append = !$risky && !$incomplete && !$skipped;
$linesToBeCovered = [];
$linesToBeUsed = [];
if ($append && $test instanceof TestCase) {
try {
$linesToBeCovered = TestUtil::getLinesToBeCovered(
get_class($test),
$test->getName(false)
);
$linesToBeUsed = TestUtil::getLinesToBeUsed(
get_class($test),
$test->getName(false)
);
} catch (InvalidCoversTargetException $cce) {
$this->addWarning(
$test,
new Warning(
$cce->getMessage()
),
$time
);
}
}
try {
$this->codeCoverage->stop(
$append,
$linesToBeCovered,
$linesToBeUsed
);
} catch (UnintentionallyCoveredCodeException $cce) {
$unintentionallyCoveredCodeError = new UnintentionallyCoveredCodeError(
'This test executed code that is not listed as code to be covered or used:' .
PHP_EOL . $cce->getMessage()
);
} catch (OriginalCodeCoverageException $cce) {
$error = true;
$e = $e ?? $cce;
}
}
if (isset($errorHandler)) {
$errorHandler->unregister();
unset($errorHandler);
}
if ($error) {
$this->addError($test, $e, $time);
} elseif ($failure) {
$this->addFailure($test, $e, $time);
} elseif ($warning) {
$this->addWarning($test, $e, $time);
} elseif (isset($unintentionallyCoveredCodeError)) {
$this->addFailure(
$test,
$unintentionallyCoveredCodeError,
$time
);
} elseif ($this->beStrictAboutTestsThatDoNotTestAnything &&
!$test->doesNotPerformAssertions() &&
$test->getNumAssertions() === 0) {
try {
$reflected = new ReflectionClass($test);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$name = $test->getName(false);
if ($name && $reflected->hasMethod($name)) {
try {
$reflected = $reflected->getMethod($name);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
}
$this->addFailure(
$test,
new RiskyTestError(
sprintf(
"This test did not perform any assertions\n\n%s:%d",
$reflected->getFileName(),
$reflected->getStartLine()
)
),
$time
);
} elseif ($this->beStrictAboutTestsThatDoNotTestAnything &&
$test->doesNotPerformAssertions() &&
$test->getNumAssertions() > 0) {
$this->addFailure(
$test,
new RiskyTestError(
sprintf(
'This test is annotated with "@doesNotPerformAssertions" but performed %d assertions',
$test->getNumAssertions()
)
),
$time
);
} elseif ($this->beStrictAboutOutputDuringTests && $test->hasOutput()) {
$this->addFailure(
$test,
new OutputError(
sprintf(
'This test printed output: %s',
$test->getActualOutput()
)
),
$time
);
} elseif ($this->beStrictAboutTodoAnnotatedTests && $test instanceof TestCase) {
$annotations = TestUtil::parseTestMethodAnnotations(
get_class($test),
$test->getName(false)
);
if (isset($annotations['method']['todo'])) {
$this->addFailure(
$test,
new RiskyTestError(
'Test method is annotated with @todo'
),
$time
);
}
}
$this->endTest($test, $time);
}
/**
* Gets the number of run tests.
*/
public function count(): int
{
return $this->runTests;
}
/**
* Checks whether the test run should stop.
*/
public function shouldStop(): bool
{
return $this->stop;
}
/**
* Marks that the test run should stop.
*/
public function stop(): void
{
$this->stop = true;
}
/**
* Returns the code coverage object.
*/
public function getCodeCoverage(): ?CodeCoverage
{
return $this->codeCoverage;
}
/**
* Sets the code coverage object.
*/
public function setCodeCoverage(CodeCoverage $codeCoverage): void
{
$this->codeCoverage = $codeCoverage;
}
/**
* Enables or disables the deprecation-to-exception conversion.
*/
public function convertDeprecationsToExceptions(bool $flag): void
{
$this->convertDeprecationsToExceptions = $flag;
}
/**
* Returns the deprecation-to-exception conversion setting.
*/
public function getConvertDeprecationsToExceptions(): bool
{
return $this->convertDeprecationsToExceptions;
}
/**
* Enables or disables the error-to-exception conversion.
*/
public function convertErrorsToExceptions(bool $flag): void
{
$this->convertErrorsToExceptions = $flag;
}
/**
* Returns the error-to-exception conversion setting.
*/
public function getConvertErrorsToExceptions(): bool
{
return $this->convertErrorsToExceptions;
}
/**
* Enables or disables the notice-to-exception conversion.
*/
public function convertNoticesToExceptions(bool $flag): void
{
$this->convertNoticesToExceptions = $flag;
}
/**
* Returns the notice-to-exception conversion setting.
*/
public function getConvertNoticesToExceptions(): bool
{
return $this->convertNoticesToExceptions;
}
/**
* Enables or disables the warning-to-exception conversion.
*/
public function convertWarningsToExceptions(bool $flag): void
{
$this->convertWarningsToExceptions = $flag;
}
/**
* Returns the warning-to-exception conversion setting.
*/
public function getConvertWarningsToExceptions(): bool
{
return $this->convertWarningsToExceptions;
}
/**
* Enables or disables the stopping when an error occurs.
*/
public function stopOnError(bool $flag): void
{
$this->stopOnError = $flag;
}
/**
* Enables or disables the stopping when a failure occurs.
*/
public function stopOnFailure(bool $flag): void
{
$this->stopOnFailure = $flag;
}
/**
* Enables or disables the stopping when a warning occurs.
*/
public function stopOnWarning(bool $flag): void
{
$this->stopOnWarning = $flag;
}
public function beStrictAboutTestsThatDoNotTestAnything(bool $flag): void
{
$this->beStrictAboutTestsThatDoNotTestAnything = $flag;
}
public function isStrictAboutTestsThatDoNotTestAnything(): bool
{
return $this->beStrictAboutTestsThatDoNotTestAnything;
}
public function beStrictAboutOutputDuringTests(bool $flag): void
{
$this->beStrictAboutOutputDuringTests = $flag;
}
public function isStrictAboutOutputDuringTests(): bool
{
return $this->beStrictAboutOutputDuringTests;
}
public function beStrictAboutResourceUsageDuringSmallTests(bool $flag): void
{
$this->beStrictAboutResourceUsageDuringSmallTests = $flag;
}
public function isStrictAboutResourceUsageDuringSmallTests(): bool
{
return $this->beStrictAboutResourceUsageDuringSmallTests;
}
public function enforceTimeLimit(bool $flag): void
{
$this->enforceTimeLimit = $flag;
}
public function enforcesTimeLimit(): bool
{
return $this->enforceTimeLimit;
}
public function beStrictAboutTodoAnnotatedTests(bool $flag): void
{
$this->beStrictAboutTodoAnnotatedTests = $flag;
}
public function isStrictAboutTodoAnnotatedTests(): bool
{
return $this->beStrictAboutTodoAnnotatedTests;
}
public function forceCoversAnnotation(): void
{
$this->forceCoversAnnotation = true;
}
public function forcesCoversAnnotation(): bool
{
return $this->forceCoversAnnotation;
}
/**
* Enables or disables the stopping for risky tests.
*/
public function stopOnRisky(bool $flag): void
{
$this->stopOnRisky = $flag;
}
/**
* Enables or disables the stopping for incomplete tests.
*/
public function stopOnIncomplete(bool $flag): void
{
$this->stopOnIncomplete = $flag;
}
/**
* Enables or disables the stopping for skipped tests.
*/
public function stopOnSkipped(bool $flag): void
{
$this->stopOnSkipped = $flag;
}
/**
* Enables or disables the stopping for defects: error, failure, warning.
*/
public function stopOnDefect(bool $flag): void
{
$this->stopOnDefect = $flag;
}
/**
* Returns the time spent running the tests.
*/
public function time(): float
{
return $this->time;
}
/**
* Returns whether the entire test was successful or not.
*/
public function wasSuccessful(): bool
{
return $this->wasSuccessfulIgnoringWarnings() && empty($this->warnings);
}
public function wasSuccessfulIgnoringWarnings(): bool
{
return empty($this->errors) && empty($this->failures);
}
public function wasSuccessfulAndNoTestIsRiskyOrSkippedOrIncomplete(): bool
{
return $this->wasSuccessful() && $this->allHarmless() && $this->allCompletelyImplemented() && $this->noneSkipped();
}
/**
* Sets the default timeout for tests.
*/
public function setDefaultTimeLimit(int $timeout): void
{
$this->defaultTimeLimit = $timeout;
}
/**
* Sets the timeout for small tests.
*/
public function setTimeoutForSmallTests(int $timeout): void
{
$this->timeoutForSmallTests = $timeout;
}
/**
* Sets the timeout for medium tests.
*/
public function setTimeoutForMediumTests(int $timeout): void
{
$this->timeoutForMediumTests = $timeout;
}
/**
* Sets the timeout for large tests.
*/
public function setTimeoutForLargeTests(int $timeout): void
{
$this->timeoutForLargeTests = $timeout;
}
/**
* Returns the set timeout for large tests.
*/
public function getTimeoutForLargeTests(): int
{
return $this->timeoutForLargeTests;
}
public function setRegisterMockObjectsFromTestArgumentsRecursively(bool $flag): void
{
$this->registerMockObjectsFromTestArgumentsRecursively = $flag;
}
private function recordError(Test $test, Throwable $t): void
{
$this->errors[] = new TestFailure($test, $t);
}
private function recordNotImplemented(Test $test, Throwable $t): void
{
$this->notImplemented[] = new TestFailure($test, $t);
}
private function recordRisky(Test $test, Throwable $t): void
{
$this->risky[] = new TestFailure($test, $t);
}
private function recordSkipped(Test $test, Throwable $t): void
{
$this->skipped[] = new TestFailure($test, $t);
}
private function recordWarning(Test $test, Throwable $t): void
{
$this->warnings[] = new TestFailure($test, $t);
}
private function shouldTimeLimitBeEnforced(int $size): bool
{
if (!$this->enforceTimeLimit) {
return false;
}
if (!(($this->defaultTimeLimit || $size !== TestUtil::UNKNOWN))) {
return false;
}
if (!extension_loaded('pcntl')) {
return false;
}
if (!class_exists(Invoker::class)) {
return false;
}
if (extension_loaded('xdebug') && xdebug_is_debugger_active()) {
return false;
}
return true;
}
}
PK [ޢq q ! src/Framework/SkippedTestCase.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class SkippedTestCase extends TestCase
{
/**
* @var bool
*/
protected $backupGlobals = false;
/**
* @var bool
*/
protected $backupStaticAttributes = false;
/**
* @var bool
*/
protected $runTestInSeparateProcess = false;
/**
* @var string
*/
private $message;
public function __construct(string $className, string $methodName, string $message = '')
{
parent::__construct($className . '::' . $methodName);
$this->message = $message;
}
public function getMessage(): string
{
return $this->message;
}
/**
* Returns a string representation of the test case.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
return $this->getName();
}
/**
* @throws Exception
*/
protected function runTest(): void
{
$this->markTestSkipped($this->message);
}
}
PK [h _ _ " src/Framework/Error/Deprecated.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Error;
/**
* @internal
*/
final class Deprecated extends Error
{
}
PK [2`nl l src/Framework/Error/Error.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Error;
use PHPUnit\Framework\Exception;
/**
* @internal
*/
class Error extends Exception
{
public function __construct(string $message, int $code, string $file, int $line, \Exception $previous = null)
{
parent::__construct($message, $code, $previous);
$this->file = $file;
$this->line = $line;
}
}
PK [*[ [ src/Framework/Error/Notice.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Error;
/**
* @internal
*/
final class Notice extends Error
{
}
PK [Z@\ \ src/Framework/Error/Warning.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Error;
/**
* @internal
*/
final class Warning extends Error
{
}
PK [j:V V src/Framework/Test.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use Countable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
interface Test extends Countable
{
/**
* Runs a test and collects its result in a TestResult instance.
*/
public function run(TestResult $result = null): TestResult;
}
PK [F $ src/Framework/MockObject/Api/Api.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use PHPUnit\Framework\MockObject\Builder\InvocationMocker as InvocationMockerBuilder;
use PHPUnit\Framework\MockObject\Rule\InvocationOrder;
/**
* @internal This trait is not covered by the backward compatibility promise for PHPUnit
*/
trait Api
{
/**
* @var ConfigurableMethod[]
*/
private static $__phpunit_configurableMethods;
/**
* @var object
*/
private $__phpunit_originalObject;
/**
* @var bool
*/
private $__phpunit_returnValueGeneration = true;
/**
* @var InvocationHandler
*/
private $__phpunit_invocationMocker;
/** @noinspection MagicMethodsValidityInspection */
public static function __phpunit_initConfigurableMethods(ConfigurableMethod ...$configurableMethods): void
{
if (isset(static::$__phpunit_configurableMethods)) {
throw new ConfigurableMethodsAlreadyInitializedException(
'Configurable methods is already initialized and can not be reinitialized'
);
}
static::$__phpunit_configurableMethods = $configurableMethods;
}
/** @noinspection MagicMethodsValidityInspection */
public function __phpunit_setOriginalObject($originalObject): void
{
$this->__phpunit_originalObject = $originalObject;
}
/** @noinspection MagicMethodsValidityInspection */
public function __phpunit_setReturnValueGeneration(bool $returnValueGeneration): void
{
$this->__phpunit_returnValueGeneration = $returnValueGeneration;
}
/** @noinspection MagicMethodsValidityInspection */
public function __phpunit_getInvocationHandler(): InvocationHandler
{
if ($this->__phpunit_invocationMocker === null) {
$this->__phpunit_invocationMocker = new InvocationHandler(
static::$__phpunit_configurableMethods,
$this->__phpunit_returnValueGeneration
);
}
return $this->__phpunit_invocationMocker;
}
/** @noinspection MagicMethodsValidityInspection */
public function __phpunit_hasMatchers(): bool
{
return $this->__phpunit_getInvocationHandler()->hasMatchers();
}
/** @noinspection MagicMethodsValidityInspection */
public function __phpunit_verify(bool $unsetInvocationMocker = true): void
{
$this->__phpunit_getInvocationHandler()->verify();
if ($unsetInvocationMocker) {
$this->__phpunit_invocationMocker = null;
}
}
public function expects(InvocationOrder $matcher): InvocationMockerBuilder
{
return $this->__phpunit_getInvocationHandler()->expects($matcher);
}
}
PK [ ' src/Framework/MockObject/Api/Method.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function call_user_func_array;
use function func_get_args;
use PHPUnit\Framework\MockObject\Rule\AnyInvokedCount;
/**
* @internal This trait is not covered by the backward compatibility promise for PHPUnit
*/
trait Method
{
public function method()
{
$expects = $this->expects(new AnyInvokedCount);
return call_user_func_array(
[$expects, 'method'],
func_get_args()
);
}
}
PK [\ ! src/Framework/MockObject/Stub.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use PHPUnit\Framework\MockObject\Builder\InvocationStubber;
/**
* @method InvocationStubber method($constraint)
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
interface Stub
{
public function __phpunit_getInvocationHandler(): InvocationHandler;
public function __phpunit_hasMatchers(): bool;
public function __phpunit_setReturnValueGeneration(bool $returnValueGeneration): void;
}
PK [9, , 1 src/Framework/MockObject/MethodNameConstraint.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function is_string;
use function sprintf;
use function strtolower;
use PHPUnit\Framework\Constraint\Constraint;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MethodNameConstraint extends Constraint
{
/**
* @var string
*/
private $methodName;
public function __construct(string $methodName)
{
$this->methodName = $methodName;
}
public function toString(): string
{
return sprintf(
'is "%s"',
$this->methodName
);
}
protected function matches($other): bool
{
if (!is_string($other)) {
return false;
}
return strtolower($this->methodName) === strtolower($other);
}
}
PK [^ j j & src/Framework/MockObject/MockTrait.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function class_exists;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MockTrait implements MockType
{
/**
* @var string
*/
private $classCode;
/**
* @var class-string
*/
private $mockName;
/**
* @psalm-param class-string $mockName
*/
public function __construct(string $classCode, string $mockName)
{
$this->classCode = $classCode;
$this->mockName = $mockName;
}
/**
* @psalm-return class-string
*/
public function generate(): string
{
if (!class_exists($this->mockName, false)) {
eval($this->classCode);
}
return $this->mockName;
}
public function getClassCode(): string
{
return $this->classCode;
}
}
PK [
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use PHPUnit\Framework\MockObject\Builder\InvocationMocker as BuilderInvocationMocker;
use PHPUnit\Framework\MockObject\Rule\InvocationOrder;
/**
* @method BuilderInvocationMocker method($constraint)
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
interface MockObject extends Stub
{
public function __phpunit_setOriginalObject($originalObject): void;
public function __phpunit_verify(bool $unsetInvocationMocker = true): void;
public function expects(InvocationOrder $invocationRule): BuilderInvocationMocker;
}
PK [WY& & 4 src/Framework/MockObject/Rule/InvokedAtLeastOnce.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvokedAtLeastOnce extends InvocationOrder
{
public function toString(): string
{
return 'invoked at least once';
}
/**
* Verifies that the current expectation is valid. If everything is OK the
* code should just return, if not it must throw an exception.
*
* @throws ExpectationFailedException
*/
public function verify(): void
{
$count = $this->getInvocationCount();
if ($count < 1) {
throw new ExpectationFailedException(
'Expected invocation at least once but it never occurred.'
);
}
}
public function matches(BaseInvocation $invocation): bool
{
return true;
}
protected function invokedDo(BaseInvocation $invocation): void
{
}
}
PK [MD D 1 src/Framework/MockObject/Rule/AnyInvokedCount.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class AnyInvokedCount extends InvocationOrder
{
public function toString(): string
{
return 'invoked zero or more times';
}
public function verify(): void
{
}
public function matches(BaseInvocation $invocation): bool
{
return true;
}
protected function invokedDo(BaseInvocation $invocation): void
{
}
}
PK [ 1 src/Framework/MockObject/Rule/InvocationOrder.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use function count;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
use PHPUnit\Framework\MockObject\Verifiable;
use PHPUnit\Framework\SelfDescribing;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
abstract class InvocationOrder implements SelfDescribing, Verifiable
{
/**
* @var BaseInvocation[]
*/
private $invocations = [];
public function getInvocationCount(): int
{
return count($this->invocations);
}
public function hasBeenInvoked(): bool
{
return count($this->invocations) > 0;
}
final public function invoked(BaseInvocation $invocation)
{
$this->invocations[] = $invocation;
return $this->invokedDo($invocation);
}
abstract public function matches(BaseInvocation $invocation): bool;
abstract protected function invokedDo(BaseInvocation $invocation);
}
PK [jP
P
. src/Framework/MockObject/Rule/InvokedCount.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use function sprintf;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvokedCount extends InvocationOrder
{
/**
* @var int
*/
private $expectedCount;
/**
* @param int $expectedCount
*/
public function __construct($expectedCount)
{
$this->expectedCount = $expectedCount;
}
public function isNever(): bool
{
return $this->expectedCount === 0;
}
public function toString(): string
{
return 'invoked ' . $this->expectedCount . ' time(s)';
}
public function matches(BaseInvocation $invocation): bool
{
return true;
}
/**
* Verifies that the current expectation is valid. If everything is OK the
* code should just return, if not it must throw an exception.
*
* @throws ExpectationFailedException
*/
public function verify(): void
{
$count = $this->getInvocationCount();
if ($count !== $this->expectedCount) {
throw new ExpectationFailedException(
sprintf(
'Method was expected to be called %d times, ' .
'actually called %d times.',
$this->expectedCount,
$count
)
);
}
}
/**
* @throws ExpectationFailedException
*/
protected function invokedDo(BaseInvocation $invocation): void
{
$count = $this->getInvocationCount();
if ($count > $this->expectedCount) {
$message = $invocation->toString() . ' ';
switch ($this->expectedCount) {
case 0:
$message .= 'was not expected to be called.';
break;
case 1:
$message .= 'was not expected to be called more than once.';
break;
default:
$message .= sprintf(
'was not expected to be called more than %d times.',
$this->expectedCount
);
}
throw new ExpectationFailedException($message);
}
}
}
PK [=u3 3 , src/Framework/MockObject/Rule/Parameters.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use function count;
use function get_class;
use function sprintf;
use Exception;
use PHPUnit\Framework\Constraint\Constraint;
use PHPUnit\Framework\Constraint\IsAnything;
use PHPUnit\Framework\Constraint\IsEqual;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Parameters implements ParametersRule
{
/**
* @var Constraint[]
*/
private $parameters = [];
/**
* @var BaseInvocation
*/
private $invocation;
/**
* @var bool|ExpectationFailedException
*/
private $parameterVerificationResult;
/**
* @throws \PHPUnit\Framework\Exception
*/
public function __construct(array $parameters)
{
foreach ($parameters as $parameter) {
if (!($parameter instanceof Constraint)) {
$parameter = new IsEqual(
$parameter
);
}
$this->parameters[] = $parameter;
}
}
public function toString(): string
{
$text = 'with parameter';
foreach ($this->parameters as $index => $parameter) {
if ($index > 0) {
$text .= ' and';
}
$text .= ' ' . $index . ' ' . $parameter->toString();
}
return $text;
}
/**
* @throws Exception
*/
public function apply(BaseInvocation $invocation): void
{
$this->invocation = $invocation;
$this->parameterVerificationResult = null;
try {
$this->parameterVerificationResult = $this->doVerify();
} catch (ExpectationFailedException $e) {
$this->parameterVerificationResult = $e;
throw $this->parameterVerificationResult;
}
}
/**
* Checks if the invocation $invocation matches the current rules. If it
* does the rule will get the invoked() method called which should check
* if an expectation is met.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public function verify(): void
{
$this->doVerify();
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
private function doVerify(): bool
{
if (isset($this->parameterVerificationResult)) {
return $this->guardAgainstDuplicateEvaluationOfParameterConstraints();
}
if ($this->invocation === null) {
throw new ExpectationFailedException('Mocked method does not exist.');
}
if (count($this->invocation->getParameters()) < count($this->parameters)) {
$message = 'Parameter count for invocation %s is too low.';
// The user called `->with($this->anything())`, but may have meant
// `->withAnyParameters()`.
//
// @see https://github.com/sebastianbergmann/phpunit-mock-objects/issues/199
if (count($this->parameters) === 1 &&
get_class($this->parameters[0]) === IsAnything::class) {
$message .= "\nTo allow 0 or more parameters with any value, omit ->with() or use ->withAnyParameters() instead.";
}
throw new ExpectationFailedException(
sprintf($message, $this->invocation->toString())
);
}
foreach ($this->parameters as $i => $parameter) {
$parameter->evaluate(
$this->invocation->getParameters()[$i],
sprintf(
'Parameter %s for invocation %s does not match expected ' .
'value.',
$i,
$this->invocation->toString()
)
);
}
return true;
}
/**
* @throws ExpectationFailedException
*/
private function guardAgainstDuplicateEvaluationOfParameterConstraints(): bool
{
if ($this->parameterVerificationResult instanceof ExpectationFailedException) {
throw $this->parameterVerificationResult;
}
return (bool) $this->parameterVerificationResult;
}
}
PK [:4 , src/Framework/MockObject/Rule/MethodName.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use function is_string;
use PHPUnit\Framework\Constraint\Constraint;
use PHPUnit\Framework\InvalidArgumentException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
use PHPUnit\Framework\MockObject\MethodNameConstraint;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MethodName
{
/**
* @var Constraint
*/
private $constraint;
/**
* @param Constraint|string $constraint
*
* @throws InvalidArgumentException
*/
public function __construct($constraint)
{
if (is_string($constraint)) {
$constraint = new MethodNameConstraint($constraint);
}
if (!$constraint instanceof Constraint) {
throw InvalidArgumentException::create(1, 'PHPUnit\Framework\Constraint\Constraint object or string');
}
$this->constraint = $constraint;
}
public function toString(): string
{
return 'method name ' . $this->constraint->toString();
}
/**
* @throws \PHPUnit\Framework\ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function matches(BaseInvocation $invocation): bool
{
return $this->matchesName($invocation->getMethodName());
}
/**
* @throws \PHPUnit\Framework\ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function matchesName(string $methodName): bool
{
return (bool) $this->constraint->evaluate($methodName, '', true);
}
}
PK [.la a 0 src/Framework/MockObject/Rule/ParametersRule.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
use PHPUnit\Framework\MockObject\Verifiable;
use PHPUnit\Framework\SelfDescribing;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
interface ParametersRule extends SelfDescribing, Verifiable
{
/**
* @throws ExpectationFailedException if the invocation violates the rule
*/
public function apply(BaseInvocation $invocation): void;
public function verify(): void;
}
PK [7ɞc c 0 src/Framework/MockObject/Rule/InvokedAtIndex.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use function sprintf;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4297
*
* @codeCoverageIgnore
*/
final class InvokedAtIndex extends InvocationOrder
{
/**
* @var int
*/
private $sequenceIndex;
/**
* @var int
*/
private $currentIndex = -1;
/**
* @param int $sequenceIndex
*/
public function __construct($sequenceIndex)
{
$this->sequenceIndex = $sequenceIndex;
}
public function toString(): string
{
return 'invoked at sequence index ' . $this->sequenceIndex;
}
public function matches(BaseInvocation $invocation): bool
{
$this->currentIndex++;
return $this->currentIndex == $this->sequenceIndex;
}
/**
* Verifies that the current expectation is valid. If everything is OK the
* code should just return, if not it must throw an exception.
*
* @throws ExpectationFailedException
*/
public function verify(): void
{
if ($this->currentIndex < $this->sequenceIndex) {
throw new ExpectationFailedException(
sprintf(
'The expected invocation at index %s was never reached.',
$this->sequenceIndex
)
);
}
}
protected function invokedDo(BaseInvocation $invocation): void
{
}
}
PK [l 4 src/Framework/MockObject/Rule/InvokedAtMostCount.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvokedAtMostCount extends InvocationOrder
{
/**
* @var int
*/
private $allowedInvocations;
/**
* @param int $allowedInvocations
*/
public function __construct($allowedInvocations)
{
$this->allowedInvocations = $allowedInvocations;
}
public function toString(): string
{
return 'invoked at most ' . $this->allowedInvocations . ' times';
}
/**
* Verifies that the current expectation is valid. If everything is OK the
* code should just return, if not it must throw an exception.
*
* @throws ExpectationFailedException
*/
public function verify(): void
{
$count = $this->getInvocationCount();
if ($count > $this->allowedInvocations) {
throw new ExpectationFailedException(
'Expected invocation at most ' . $this->allowedInvocations .
' times but it occurred ' . $count . ' time(s).'
);
}
}
public function matches(BaseInvocation $invocation): bool
{
return true;
}
protected function invokedDo(BaseInvocation $invocation): void
{
}
}
PK [; / src/Framework/MockObject/Rule/AnyParameters.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class AnyParameters implements ParametersRule
{
public function toString(): string
{
return 'with any parameters';
}
public function apply(BaseInvocation $invocation): void
{
}
public function verify(): void
{
}
}
PK [u' 7 src/Framework/MockObject/Rule/ConsecutiveParameters.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use function count;
use function gettype;
use function is_iterable;
use function sprintf;
use PHPUnit\Framework\Constraint\Constraint;
use PHPUnit\Framework\Constraint\IsEqual;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\InvalidParameterGroupException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @deprecated
*/
final class ConsecutiveParameters implements ParametersRule
{
/**
* @var array
*/
private $parameterGroups = [];
/**
* @var array
*/
private $invocations = [];
/**
* @throws \PHPUnit\Framework\Exception
*/
public function __construct(array $parameterGroups)
{
foreach ($parameterGroups as $index => $parameters) {
if (!is_iterable($parameters)) {
throw new InvalidParameterGroupException(
sprintf(
'Parameter group #%d must be an array or Traversable, got %s',
$index,
gettype($parameters)
)
);
}
foreach ($parameters as $parameter) {
if (!$parameter instanceof Constraint) {
$parameter = new IsEqual($parameter);
}
$this->parameterGroups[$index][] = $parameter;
}
}
}
public function toString(): string
{
return 'with consecutive parameters';
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public function apply(BaseInvocation $invocation): void
{
$this->invocations[] = $invocation;
$callIndex = count($this->invocations) - 1;
$this->verifyInvocation($invocation, $callIndex);
}
/**
* @throws \PHPUnit\Framework\ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function verify(): void
{
foreach ($this->invocations as $callIndex => $invocation) {
$this->verifyInvocation($invocation, $callIndex);
}
}
/**
* Verify a single invocation.
*
* @param int $callIndex
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
private function verifyInvocation(BaseInvocation $invocation, $callIndex): void
{
if (!isset($this->parameterGroups[$callIndex])) {
// no parameter assertion for this call index
return;
}
$parameters = $this->parameterGroups[$callIndex];
if (count($invocation->getParameters()) < count($parameters)) {
throw new ExpectationFailedException(
sprintf(
'Parameter count for invocation %s is too low.',
$invocation->toString()
)
);
}
foreach ($parameters as $i => $parameter) {
$parameter->evaluate(
$invocation->getParameters()[$i],
sprintf(
'Parameter %s for invocation #%d %s does not match expected ' .
'value.',
$i,
$callIndex,
$invocation->toString()
)
);
}
}
}
PK [ 5 src/Framework/MockObject/Rule/InvokedAtLeastCount.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Rule;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvokedAtLeastCount extends InvocationOrder
{
/**
* @var int
*/
private $requiredInvocations;
/**
* @param int $requiredInvocations
*/
public function __construct($requiredInvocations)
{
$this->requiredInvocations = $requiredInvocations;
}
public function toString(): string
{
return 'invoked at least ' . $this->requiredInvocations . ' times';
}
/**
* Verifies that the current expectation is valid. If everything is OK the
* code should just return, if not it must throw an exception.
*
* @throws ExpectationFailedException
*/
public function verify(): void
{
$count = $this->getInvocationCount();
if ($count < $this->requiredInvocations) {
throw new ExpectationFailedException(
'Expected invocation at least ' . $this->requiredInvocations .
' times but it occurred ' . $count . ' time(s).'
);
}
}
public function matches(BaseInvocation $invocation): bool
{
return true;
}
protected function invokedDo(BaseInvocation $invocation): void
{
}
}
PK [$Z Z $ src/Framework/MockObject/Matcher.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function assert;
use function implode;
use function sprintf;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\MockObject\Rule\AnyInvokedCount;
use PHPUnit\Framework\MockObject\Rule\AnyParameters;
use PHPUnit\Framework\MockObject\Rule\InvocationOrder;
use PHPUnit\Framework\MockObject\Rule\InvokedAtMostCount;
use PHPUnit\Framework\MockObject\Rule\InvokedCount;
use PHPUnit\Framework\MockObject\Rule\MethodName;
use PHPUnit\Framework\MockObject\Rule\ParametersRule;
use PHPUnit\Framework\MockObject\Stub\Stub;
use PHPUnit\Framework\TestFailure;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Matcher
{
/**
* @var InvocationOrder
*/
private $invocationRule;
/**
* @var mixed
*/
private $afterMatchBuilderId;
/**
* @var bool
*/
private $afterMatchBuilderIsInvoked = false;
/**
* @var MethodName
*/
private $methodNameRule;
/**
* @var ParametersRule
*/
private $parametersRule;
/**
* @var Stub
*/
private $stub;
public function __construct(InvocationOrder $rule)
{
$this->invocationRule = $rule;
}
public function hasMatchers(): bool
{
return !$this->invocationRule instanceof AnyInvokedCount;
}
public function hasMethodNameRule(): bool
{
return $this->methodNameRule !== null;
}
public function getMethodNameRule(): MethodName
{
return $this->methodNameRule;
}
public function setMethodNameRule(MethodName $rule): void
{
$this->methodNameRule = $rule;
}
public function hasParametersRule(): bool
{
return $this->parametersRule !== null;
}
public function setParametersRule(ParametersRule $rule): void
{
$this->parametersRule = $rule;
}
public function setStub(Stub $stub): void
{
$this->stub = $stub;
}
public function setAfterMatchBuilderId(string $id): void
{
$this->afterMatchBuilderId = $id;
}
/**
* @throws ExpectationFailedException
* @throws MatchBuilderNotFoundException
* @throws MethodNameNotConfiguredException
* @throws RuntimeException
*/
public function invoked(Invocation $invocation)
{
if ($this->methodNameRule === null) {
throw new MethodNameNotConfiguredException;
}
if ($this->afterMatchBuilderId !== null) {
$matcher = $invocation->getObject()
->__phpunit_getInvocationHandler()
->lookupMatcher($this->afterMatchBuilderId);
if (!$matcher) {
throw new MatchBuilderNotFoundException($this->afterMatchBuilderId);
}
assert($matcher instanceof self);
if ($matcher->invocationRule->hasBeenInvoked()) {
$this->afterMatchBuilderIsInvoked = true;
}
}
$this->invocationRule->invoked($invocation);
try {
if ($this->parametersRule !== null) {
$this->parametersRule->apply($invocation);
}
} catch (ExpectationFailedException $e) {
throw new ExpectationFailedException(
sprintf(
"Expectation failed for %s when %s\n%s",
$this->methodNameRule->toString(),
$this->invocationRule->toString(),
$e->getMessage()
),
$e->getComparisonFailure()
);
}
if ($this->stub) {
return $this->stub->invoke($invocation);
}
return $invocation->generateReturnValue();
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
* @throws MatchBuilderNotFoundException
* @throws MethodNameNotConfiguredException
* @throws RuntimeException
*/
public function matches(Invocation $invocation): bool
{
if ($this->afterMatchBuilderId !== null) {
$matcher = $invocation->getObject()
->__phpunit_getInvocationHandler()
->lookupMatcher($this->afterMatchBuilderId);
if (!$matcher) {
throw new MatchBuilderNotFoundException($this->afterMatchBuilderId);
}
assert($matcher instanceof self);
if (!$matcher->invocationRule->hasBeenInvoked()) {
return false;
}
}
if ($this->methodNameRule === null) {
throw new MethodNameNotConfiguredException;
}
if (!$this->invocationRule->matches($invocation)) {
return false;
}
try {
if (!$this->methodNameRule->matches($invocation)) {
return false;
}
} catch (ExpectationFailedException $e) {
throw new ExpectationFailedException(
sprintf(
"Expectation failed for %s when %s\n%s",
$this->methodNameRule->toString(),
$this->invocationRule->toString(),
$e->getMessage()
),
$e->getComparisonFailure()
);
}
return true;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
* @throws MethodNameNotConfiguredException
*/
public function verify(): void
{
if ($this->methodNameRule === null) {
throw new MethodNameNotConfiguredException;
}
try {
$this->invocationRule->verify();
if ($this->parametersRule === null) {
$this->parametersRule = new AnyParameters;
}
$invocationIsAny = $this->invocationRule instanceof AnyInvokedCount;
$invocationIsNever = $this->invocationRule instanceof InvokedCount && $this->invocationRule->isNever();
$invocationIsAtMost = $this->invocationRule instanceof InvokedAtMostCount;
if (!$invocationIsAny && !$invocationIsNever && !$invocationIsAtMost) {
$this->parametersRule->verify();
}
} catch (ExpectationFailedException $e) {
throw new ExpectationFailedException(
sprintf(
"Expectation failed for %s when %s.\n%s",
$this->methodNameRule->toString(),
$this->invocationRule->toString(),
TestFailure::exceptionToString($e)
)
);
}
}
public function toString(): string
{
$list = [];
if ($this->invocationRule !== null) {
$list[] = $this->invocationRule->toString();
}
if ($this->methodNameRule !== null) {
$list[] = 'where ' . $this->methodNameRule->toString();
}
if ($this->parametersRule !== null) {
$list[] = 'and ' . $this->parametersRule->toString();
}
if ($this->afterMatchBuilderId !== null) {
$list[] = 'after ' . $this->afterMatchBuilderId;
}
if ($this->stub !== null) {
$list[] = 'will ' . $this->stub->toString();
}
return implode(' ', $list);
}
}
PK [d* * ' src/Framework/MockObject/MockMethod.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use const DIRECTORY_SEPARATOR;
use function explode;
use function implode;
use function is_object;
use function is_string;
use function preg_match;
use function preg_replace;
use function sprintf;
use function strlen;
use function strpos;
use function substr;
use function substr_count;
use function trim;
use function var_export;
use ReflectionMethod;
use ReflectionParameter;
use SebastianBergmann\Template\Exception as TemplateException;
use SebastianBergmann\Template\Template;
use SebastianBergmann\Type\ReflectionMapper;
use SebastianBergmann\Type\Type;
use SebastianBergmann\Type\UnknownType;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MockMethod
{
/**
* @var Template[]
*/
private static $templates = [];
/**
* @var string
*/
private $className;
/**
* @var string
*/
private $methodName;
/**
* @var bool
*/
private $cloneArguments;
/**
* @var string string
*/
private $modifier;
/**
* @var string
*/
private $argumentsForDeclaration;
/**
* @var string
*/
private $argumentsForCall;
/**
* @var Type
*/
private $returnType;
/**
* @var string
*/
private $reference;
/**
* @var bool
*/
private $callOriginalMethod;
/**
* @var bool
*/
private $static;
/**
* @var ?string
*/
private $deprecation;
/**
* @throws ReflectionException
* @throws RuntimeException
*/
public static function fromReflection(ReflectionMethod $method, bool $callOriginalMethod, bool $cloneArguments): self
{
if ($method->isPrivate()) {
$modifier = 'private';
} elseif ($method->isProtected()) {
$modifier = 'protected';
} else {
$modifier = 'public';
}
if ($method->isStatic()) {
$modifier .= ' static';
}
if ($method->returnsReference()) {
$reference = '&';
} else {
$reference = '';
}
$docComment = $method->getDocComment();
if (is_string($docComment) &&
preg_match('#\*[ \t]*+@deprecated[ \t]*+(.*?)\r?+\n[ \t]*+\*(?:[ \t]*+@|/$)#s', $docComment, $deprecation)) {
$deprecation = trim(preg_replace('#[ \t]*\r?\n[ \t]*+\*[ \t]*+#', ' ', $deprecation[1]));
} else {
$deprecation = null;
}
return new self(
$method->getDeclaringClass()->getName(),
$method->getName(),
$cloneArguments,
$modifier,
self::getMethodParametersForDeclaration($method),
self::getMethodParametersForCall($method),
(new ReflectionMapper)->fromReturnType($method),
$reference,
$callOriginalMethod,
$method->isStatic(),
$deprecation
);
}
public static function fromName(string $fullClassName, string $methodName, bool $cloneArguments): self
{
return new self(
$fullClassName,
$methodName,
$cloneArguments,
'public',
'',
'',
new UnknownType,
'',
false,
false,
null
);
}
public function __construct(string $className, string $methodName, bool $cloneArguments, string $modifier, string $argumentsForDeclaration, string $argumentsForCall, Type $returnType, string $reference, bool $callOriginalMethod, bool $static, ?string $deprecation)
{
$this->className = $className;
$this->methodName = $methodName;
$this->cloneArguments = $cloneArguments;
$this->modifier = $modifier;
$this->argumentsForDeclaration = $argumentsForDeclaration;
$this->argumentsForCall = $argumentsForCall;
$this->returnType = $returnType;
$this->reference = $reference;
$this->callOriginalMethod = $callOriginalMethod;
$this->static = $static;
$this->deprecation = $deprecation;
}
public function getName(): string
{
return $this->methodName;
}
/**
* @throws RuntimeException
*/
public function generateCode(): string
{
if ($this->static) {
$templateFile = 'mocked_static_method.tpl';
} elseif ($this->returnType->isNever() || $this->returnType->isVoid()) {
$templateFile = sprintf(
'%s_method_never_or_void.tpl',
$this->callOriginalMethod ? 'proxied' : 'mocked'
);
} else {
$templateFile = sprintf(
'%s_method.tpl',
$this->callOriginalMethod ? 'proxied' : 'mocked'
);
}
$deprecation = $this->deprecation;
if (null !== $this->deprecation) {
$deprecation = "The {$this->className}::{$this->methodName} method is deprecated ({$this->deprecation}).";
$deprecationTemplate = $this->getTemplate('deprecation.tpl');
$deprecationTemplate->setVar(
[
'deprecation' => var_export($deprecation, true),
]
);
$deprecation = $deprecationTemplate->render();
}
$template = $this->getTemplate($templateFile);
$template->setVar(
[
'arguments_decl' => $this->argumentsForDeclaration,
'arguments_call' => $this->argumentsForCall,
'return_declaration' => !empty($this->returnType->asString()) ? (': ' . $this->returnType->asString()) : '',
'return_type' => $this->returnType->asString(),
'arguments_count' => !empty($this->argumentsForCall) ? substr_count($this->argumentsForCall, ',') + 1 : 0,
'class_name' => $this->className,
'method_name' => $this->methodName,
'modifier' => $this->modifier,
'reference' => $this->reference,
'clone_arguments' => $this->cloneArguments ? 'true' : 'false',
'deprecation' => $deprecation,
]
);
return $template->render();
}
public function getReturnType(): Type
{
return $this->returnType;
}
/**
* @throws RuntimeException
*/
private function getTemplate(string $template): Template
{
$filename = __DIR__ . DIRECTORY_SEPARATOR . 'Generator' . DIRECTORY_SEPARATOR . $template;
if (!isset(self::$templates[$filename])) {
try {
self::$templates[$filename] = new Template($filename);
} catch (TemplateException $e) {
throw new RuntimeException(
$e->getMessage(),
$e->getCode(),
$e
);
}
}
return self::$templates[$filename];
}
/**
* Returns the parameters of a function or method.
*
* @throws RuntimeException
*/
private static function getMethodParametersForDeclaration(ReflectionMethod $method): string
{
$parameters = [];
$types = (new ReflectionMapper)->fromParameterTypes($method);
foreach ($method->getParameters() as $i => $parameter) {
$name = '$' . $parameter->getName();
/* Note: PHP extensions may use empty names for reference arguments
* or "..." for methods taking a variable number of arguments.
*/
if ($name === '$' || $name === '$...') {
$name = '$arg' . $i;
}
$default = '';
$reference = '';
$typeDeclaration = '';
if (!$types[$i]->type()->isUnknown()) {
$typeDeclaration = $types[$i]->type()->asString() . ' ';
}
if ($parameter->isPassedByReference()) {
$reference = '&';
}
if ($parameter->isVariadic()) {
$name = '...' . $name;
} elseif ($parameter->isDefaultValueAvailable()) {
$default = ' = ' . self::exportDefaultValue($parameter);
} elseif ($parameter->isOptional()) {
$default = ' = null';
}
$parameters[] = $typeDeclaration . $reference . $name . $default;
}
return implode(', ', $parameters);
}
/**
* Returns the parameters of a function or method.
*
* @throws ReflectionException
*/
private static function getMethodParametersForCall(ReflectionMethod $method): string
{
$parameters = [];
foreach ($method->getParameters() as $i => $parameter) {
$name = '$' . $parameter->getName();
/* Note: PHP extensions may use empty names for reference arguments
* or "..." for methods taking a variable number of arguments.
*/
if ($name === '$' || $name === '$...') {
$name = '$arg' . $i;
}
if ($parameter->isVariadic()) {
continue;
}
if ($parameter->isPassedByReference()) {
$parameters[] = '&' . $name;
} else {
$parameters[] = $name;
}
}
return implode(', ', $parameters);
}
/**
* @throws ReflectionException
*/
private static function exportDefaultValue(ReflectionParameter $parameter): string
{
try {
$defaultValue = $parameter->getDefaultValue();
if (!is_object($defaultValue)) {
return (string) var_export($defaultValue, true);
}
$parameterAsString = $parameter->__toString();
return (string) explode(
' = ',
substr(
substr(
$parameterAsString,
strpos($parameterAsString, ' ') + strlen(' ')
),
0,
-2
)
)[1];
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
}
}
PK [ 1 src/Framework/MockObject/Generator/wsdl_class.tplnu W+A declare(strict_types=1);
{namespace}class {class_name} extends \SoapClient
{
public function __construct($wsdl, array $options)
{
parent::__construct('{wsdl}', $options);
}
{methods}}
PK [-XL L 3 src/Framework/MockObject/Generator/intersection.tplnu W+A declare(strict_types=1);
interface {intersection} extends {interfaces}
{
}
PK [@ė} } 5 src/Framework/MockObject/Generator/proxied_method.tplnu W+A
{modifier} function {reference}{method_name}({arguments_decl}){return_declaration}
{
$__phpunit_arguments = [{arguments_call}];
$__phpunit_count = func_num_args();
if ($__phpunit_count > {arguments_count}) {
$__phpunit_arguments_tmp = func_get_args();
for ($__phpunit_i = {arguments_count}; $__phpunit_i < $__phpunit_count; $__phpunit_i++) {
$__phpunit_arguments[] = $__phpunit_arguments_tmp[$__phpunit_i];
}
}
$this->__phpunit_getInvocationHandler()->invoke(
new \PHPUnit\Framework\MockObject\Invocation(
'{class_name}', '{method_name}', $__phpunit_arguments, '{return_type}', $this, {clone_arguments}, true
)
);
return call_user_func_array(array($this->__phpunit_originalObject, "{method_name}"), $__phpunit_arguments);
}
PK [KF F 4 src/Framework/MockObject/Generator/mocked_method.tplnu W+A
{modifier} function {reference}{method_name}({arguments_decl}){return_declaration}
{{deprecation}
$__phpunit_arguments = [{arguments_call}];
$__phpunit_count = func_num_args();
if ($__phpunit_count > {arguments_count}) {
$__phpunit_arguments_tmp = func_get_args();
for ($__phpunit_i = {arguments_count}; $__phpunit_i < $__phpunit_count; $__phpunit_i++) {
$__phpunit_arguments[] = $__phpunit_arguments_tmp[$__phpunit_i];
}
}
$__phpunit_result = $this->__phpunit_getInvocationHandler()->invoke(
new \PHPUnit\Framework\MockObject\Invocation(
'{class_name}', '{method_name}', $__phpunit_arguments, '{return_type}', $this, {clone_arguments}
)
);
return $__phpunit_result;
}
PK [p B src/Framework/MockObject/Generator/mocked_method_never_or_void.tplnu W+A
{modifier} function {reference}{method_name}({arguments_decl}){return_declaration}
{{deprecation}
$__phpunit_arguments = [{arguments_call}];
$__phpunit_count = func_num_args();
if ($__phpunit_count > {arguments_count}) {
$__phpunit_arguments_tmp = func_get_args();
for ($__phpunit_i = {arguments_count}; $__phpunit_i < $__phpunit_count; $__phpunit_i++) {
$__phpunit_arguments[] = $__phpunit_arguments_tmp[$__phpunit_i];
}
}
$this->__phpunit_getInvocationHandler()->invoke(
new \PHPUnit\Framework\MockObject\Invocation(
'{class_name}', '{method_name}', $__phpunit_arguments, '{return_type}', $this, {clone_arguments}
)
);
}
PK [i< < 2 src/Framework/MockObject/Generator/wsdl_method.tplnu W+A
public function {method_name}({arguments})
{
}
PK [O5s; ; 2 src/Framework/MockObject/Generator/deprecation.tplnu W+A
@trigger_error({deprecation}, E_USER_DEPRECATED);
PK [Tv v C src/Framework/MockObject/Generator/proxied_method_never_or_void.tplnu W+A
{modifier} function {reference}{method_name}({arguments_decl}){return_declaration}
{
$__phpunit_arguments = [{arguments_call}];
$__phpunit_count = func_num_args();
if ($__phpunit_count > {arguments_count}) {
$__phpunit_arguments_tmp = func_get_args();
for ($__phpunit_i = {arguments_count}; $__phpunit_i < $__phpunit_count; $__phpunit_i++) {
$__phpunit_arguments[] = $__phpunit_arguments_tmp[$__phpunit_i];
}
}
$this->__phpunit_getInvocationHandler()->invoke(
new \PHPUnit\Framework\MockObject\Invocation(
'{class_name}', '{method_name}', $__phpunit_arguments, '{return_type}', $this, {clone_arguments}, true
)
);
call_user_func_array(array($this->__phpunit_originalObject, "{method_name}"), $__phpunit_arguments);
}
PK [wZ 3 src/Framework/MockObject/Generator/mocked_class.tplnu W+A declare(strict_types=1);
{prologue}{class_declaration}
{
use \PHPUnit\Framework\MockObject\Api;{method}{clone}
{mocked_methods}}{epilogue}
PK [ 4R ; src/Framework/MockObject/Generator/mocked_static_method.tplnu W+A
{modifier} function {reference}{method_name}({arguments_decl}){return_declaration}
{
throw new \PHPUnit\Framework\MockObject\BadMethodCallException('Static method "{method_name}" cannot be invoked on mock object');
}
PK [
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface MockType
{
/**
* @psalm-return class-string
*/
public function generate(): string;
}
PK [Փ . src/Framework/MockObject/InvocationHandler.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function strtolower;
use Exception;
use PHPUnit\Framework\MockObject\Builder\InvocationMocker;
use PHPUnit\Framework\MockObject\Rule\InvocationOrder;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvocationHandler
{
/**
* @var Matcher[]
*/
private $matchers = [];
/**
* @var Matcher[]
*/
private $matcherMap = [];
/**
* @var ConfigurableMethod[]
*/
private $configurableMethods;
/**
* @var bool
*/
private $returnValueGeneration;
/**
* @var Throwable
*/
private $deferredError;
public function __construct(array $configurableMethods, bool $returnValueGeneration)
{
$this->configurableMethods = $configurableMethods;
$this->returnValueGeneration = $returnValueGeneration;
}
public function hasMatchers(): bool
{
foreach ($this->matchers as $matcher) {
if ($matcher->hasMatchers()) {
return true;
}
}
return false;
}
/**
* Looks up the match builder with identification $id and returns it.
*
* @param string $id The identification of the match builder
*/
public function lookupMatcher(string $id): ?Matcher
{
if (isset($this->matcherMap[$id])) {
return $this->matcherMap[$id];
}
return null;
}
/**
* Registers a matcher with the identification $id. The matcher can later be
* looked up using lookupMatcher() to figure out if it has been invoked.
*
* @param string $id The identification of the matcher
* @param Matcher $matcher The builder which is being registered
*
* @throws MatcherAlreadyRegisteredException
*/
public function registerMatcher(string $id, Matcher $matcher): void
{
if (isset($this->matcherMap[$id])) {
throw new MatcherAlreadyRegisteredException($id);
}
$this->matcherMap[$id] = $matcher;
}
public function expects(InvocationOrder $rule): InvocationMocker
{
$matcher = new Matcher($rule);
$this->addMatcher($matcher);
return new InvocationMocker(
$this,
$matcher,
...$this->configurableMethods
);
}
/**
* @throws Exception
* @throws RuntimeException
*/
public function invoke(Invocation $invocation)
{
$exception = null;
$hasReturnValue = false;
$returnValue = null;
foreach ($this->matchers as $match) {
try {
if ($match->matches($invocation)) {
$value = $match->invoked($invocation);
if (!$hasReturnValue) {
$returnValue = $value;
$hasReturnValue = true;
}
}
} catch (Exception $e) {
$exception = $e;
}
}
if ($exception !== null) {
throw $exception;
}
if ($hasReturnValue) {
return $returnValue;
}
if (!$this->returnValueGeneration) {
$exception = new ReturnValueNotConfiguredException($invocation);
if (strtolower($invocation->getMethodName()) === '__tostring') {
$this->deferredError = $exception;
return '';
}
throw $exception;
}
return $invocation->generateReturnValue();
}
public function matches(Invocation $invocation): bool
{
foreach ($this->matchers as $matcher) {
if (!$matcher->matches($invocation)) {
return false;
}
}
return true;
}
/**
* @throws Throwable
*/
public function verify(): void
{
foreach ($this->matchers as $matcher) {
$matcher->verify();
}
if ($this->deferredError) {
throw $this->deferredError;
}
}
private function addMatcher(Matcher $matcher): void
{
$this->matchers[] = $matcher;
}
}
PK [Tp_ * src/Framework/MockObject/MockMethodSet.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function array_key_exists;
use function array_values;
use function strtolower;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MockMethodSet
{
/**
* @var MockMethod[]
*/
private $methods = [];
public function addMethods(MockMethod ...$methods): void
{
foreach ($methods as $method) {
$this->methods[strtolower($method->getName())] = $method;
}
}
/**
* @return MockMethod[]
*/
public function asArray(): array
{
return array_values($this->methods);
}
public function hasMethod(string $methodName): bool
{
return array_key_exists(strtolower($methodName), $this->methods);
}
}
PK [x? ' src/Framework/MockObject/Invocation.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function array_map;
use function explode;
use function get_class;
use function implode;
use function in_array;
use function interface_exists;
use function is_object;
use function sprintf;
use function strpos;
use function strtolower;
use function substr;
use Doctrine\Instantiator\Instantiator;
use PHPUnit\Framework\SelfDescribing;
use PHPUnit\Util\Cloner;
use SebastianBergmann\Exporter\Exporter;
use stdClass;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Invocation implements SelfDescribing
{
/**
* @var string
*/
private $className;
/**
* @var string
*/
private $methodName;
/**
* @var array
*/
private $parameters;
/**
* @var string
*/
private $returnType;
/**
* @var bool
*/
private $isReturnTypeNullable = false;
/**
* @var bool
*/
private $proxiedCall;
/**
* @var object
*/
private $object;
public function __construct(string $className, string $methodName, array $parameters, string $returnType, object $object, bool $cloneObjects = false, bool $proxiedCall = false)
{
$this->className = $className;
$this->methodName = $methodName;
$this->parameters = $parameters;
$this->object = $object;
$this->proxiedCall = $proxiedCall;
if (strtolower($methodName) === '__tostring') {
$returnType = 'string';
}
if (strpos($returnType, '?') === 0) {
$returnType = substr($returnType, 1);
$this->isReturnTypeNullable = true;
}
$this->returnType = $returnType;
if (!$cloneObjects) {
return;
}
foreach ($this->parameters as $key => $value) {
if (is_object($value)) {
$this->parameters[$key] = Cloner::clone($value);
}
}
}
public function getClassName(): string
{
return $this->className;
}
public function getMethodName(): string
{
return $this->methodName;
}
public function getParameters(): array
{
return $this->parameters;
}
/**
* @throws RuntimeException
*
* @return mixed Mocked return value
*/
public function generateReturnValue()
{
if ($this->isReturnTypeNullable || $this->proxiedCall) {
return null;
}
$intersection = false;
$union = false;
$unionContainsIntersections = false;
if (strpos($this->returnType, '|') !== false) {
$types = explode('|', $this->returnType);
$union = true;
if (strpos($this->returnType, '(') !== false) {
$unionContainsIntersections = true;
}
} elseif (strpos($this->returnType, '&') !== false) {
$types = explode('&', $this->returnType);
$intersection = true;
} else {
$types = [$this->returnType];
}
$types = array_map('strtolower', $types);
if (!$intersection && !$unionContainsIntersections) {
if (in_array('', $types, true) ||
in_array('null', $types, true) ||
in_array('mixed', $types, true) ||
in_array('void', $types, true)) {
return null;
}
if (in_array('true', $types, true)) {
return true;
}
if (in_array('false', $types, true) ||
in_array('bool', $types, true)) {
return false;
}
if (in_array('float', $types, true)) {
return 0.0;
}
if (in_array('int', $types, true)) {
return 0;
}
if (in_array('string', $types, true)) {
return '';
}
if (in_array('array', $types, true)) {
return [];
}
if (in_array('static', $types, true)) {
try {
return (new Instantiator)->instantiate(get_class($this->object));
} catch (Throwable $t) {
throw new RuntimeException(
$t->getMessage(),
(int) $t->getCode(),
$t
);
}
}
if (in_array('object', $types, true)) {
return new stdClass;
}
if (in_array('callable', $types, true) ||
in_array('closure', $types, true)) {
return static function (): void
{
};
}
if (in_array('traversable', $types, true) ||
in_array('generator', $types, true) ||
in_array('iterable', $types, true)) {
$generator = static function (): \Generator
{
yield from [];
};
return $generator();
}
if (!$union) {
try {
return (new Generator)->getMock($this->returnType, [], [], '', false);
} catch (Throwable $t) {
if ($t instanceof Exception) {
throw $t;
}
throw new RuntimeException(
$t->getMessage(),
(int) $t->getCode(),
$t
);
}
}
}
if ($intersection && $this->onlyInterfaces($types)) {
try {
return (new Generator)->getMockForInterfaces($types);
} catch (Throwable $t) {
throw new RuntimeException(
sprintf(
'Return value for %s::%s() cannot be generated: %s',
$this->className,
$this->methodName,
$t->getMessage(),
),
(int) $t->getCode(),
);
}
}
$reason = '';
if ($union) {
$reason = ' because the declared return type is a union';
} elseif ($intersection) {
$reason = ' because the declared return type is an intersection';
}
throw new RuntimeException(
sprintf(
'Return value for %s::%s() cannot be generated%s, please configure a return value for this method',
$this->className,
$this->methodName,
$reason
)
);
}
public function toString(): string
{
$exporter = new Exporter;
return sprintf(
'%s::%s(%s)%s',
$this->className,
$this->methodName,
implode(
', ',
array_map(
[$exporter, 'shortenedExport'],
$this->parameters
)
),
$this->returnType ? sprintf(': %s', $this->returnType) : ''
);
}
public function getObject(): object
{
return $this->object;
}
/**
* @psalm-param non-empty-list $types
*/
private function onlyInterfaces(array $types): bool
{
foreach ($types as $type) {
if (!interface_exists($type)) {
return false;
}
}
return true;
}
}
PK [, , ( src/Framework/MockObject/MockBuilder.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function array_diff;
use function array_merge;
use PHPUnit\Framework\TestCase;
use ReflectionClass;
/**
* @psalm-template MockedType
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class MockBuilder
{
/**
* @var TestCase
*/
private $testCase;
/**
* @var string
*/
private $type;
/**
* @var null|string[]
*/
private $methods = [];
/**
* @var bool
*/
private $emptyMethodsArray = false;
/**
* @var string
*/
private $mockClassName = '';
/**
* @var array
*/
private $constructorArgs = [];
/**
* @var bool
*/
private $originalConstructor = true;
/**
* @var bool
*/
private $originalClone = true;
/**
* @var bool
*/
private $autoload = true;
/**
* @var bool
*/
private $cloneArguments = false;
/**
* @var bool
*/
private $callOriginalMethods = false;
/**
* @var ?object
*/
private $proxyTarget;
/**
* @var bool
*/
private $allowMockingUnknownTypes = true;
/**
* @var bool
*/
private $returnValueGeneration = true;
/**
* @var Generator
*/
private $generator;
/**
* @param string|string[] $type
*
* @psalm-param class-string|string|string[] $type
*/
public function __construct(TestCase $testCase, $type)
{
$this->testCase = $testCase;
$this->type = $type;
$this->generator = new Generator;
}
/**
* Creates a mock object using a fluent interface.
*
* @throws \PHPUnit\Framework\InvalidArgumentException
* @throws ClassAlreadyExistsException
* @throws ClassIsFinalException
* @throws ClassIsReadonlyException
* @throws DuplicateMethodException
* @throws InvalidMethodNameException
* @throws OriginalConstructorInvocationRequiredException
* @throws ReflectionException
* @throws RuntimeException
* @throws UnknownTypeException
*
* @psalm-return MockObject&MockedType
*/
public function getMock(): MockObject
{
$object = $this->generator->getMock(
$this->type,
!$this->emptyMethodsArray ? $this->methods : null,
$this->constructorArgs,
$this->mockClassName,
$this->originalConstructor,
$this->originalClone,
$this->autoload,
$this->cloneArguments,
$this->callOriginalMethods,
$this->proxyTarget,
$this->allowMockingUnknownTypes,
$this->returnValueGeneration
);
$this->testCase->registerMockObject($object);
return $object;
}
/**
* Creates a mock object for an abstract class using a fluent interface.
*
* @psalm-return MockObject&MockedType
*
* @throws \PHPUnit\Framework\Exception
* @throws ReflectionException
* @throws RuntimeException
*/
public function getMockForAbstractClass(): MockObject
{
$object = $this->generator->getMockForAbstractClass(
$this->type,
$this->constructorArgs,
$this->mockClassName,
$this->originalConstructor,
$this->originalClone,
$this->autoload,
$this->methods,
$this->cloneArguments
);
$this->testCase->registerMockObject($object);
return $object;
}
/**
* Creates a mock object for a trait using a fluent interface.
*
* @psalm-return MockObject&MockedType
*
* @throws \PHPUnit\Framework\Exception
* @throws ReflectionException
* @throws RuntimeException
*/
public function getMockForTrait(): MockObject
{
$object = $this->generator->getMockForTrait(
$this->type,
$this->constructorArgs,
$this->mockClassName,
$this->originalConstructor,
$this->originalClone,
$this->autoload,
$this->methods,
$this->cloneArguments
);
$this->testCase->registerMockObject($object);
return $object;
}
/**
* Specifies the subset of methods to mock. Default is to mock none of them.
*
* @deprecated https://github.com/sebastianbergmann/phpunit/pull/3687
*
* @return $this
*/
public function setMethods(?array $methods = null): self
{
if ($methods === null) {
$this->methods = $methods;
} else {
$this->methods = array_merge($this->methods ?? [], $methods);
}
return $this;
}
/**
* Specifies the subset of methods to mock, requiring each to exist in the class.
*
* @param string[] $methods
*
* @throws CannotUseOnlyMethodsException
* @throws ReflectionException
*
* @return $this
*/
public function onlyMethods(array $methods): self
{
if (empty($methods)) {
$this->emptyMethodsArray = true;
return $this;
}
try {
$reflector = new ReflectionClass($this->type);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
foreach ($methods as $method) {
if (!$reflector->hasMethod($method)) {
throw new CannotUseOnlyMethodsException($this->type, $method);
}
}
$this->methods = array_merge($this->methods ?? [], $methods);
return $this;
}
/**
* Specifies methods that don't exist in the class which you want to mock.
*
* @param string[] $methods
*
* @throws CannotUseAddMethodsException
* @throws ReflectionException
* @throws RuntimeException
*
* @return $this
*/
public function addMethods(array $methods): self
{
if (empty($methods)) {
$this->emptyMethodsArray = true;
return $this;
}
try {
$reflector = new ReflectionClass($this->type);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
foreach ($methods as $method) {
if ($reflector->hasMethod($method)) {
throw new CannotUseAddMethodsException($this->type, $method);
}
}
$this->methods = array_merge($this->methods ?? [], $methods);
return $this;
}
/**
* Specifies the subset of methods to not mock. Default is to mock all of them.
*
* @deprecated https://github.com/sebastianbergmann/phpunit/pull/3687
*
* @throws ReflectionException
*/
public function setMethodsExcept(array $methods = []): self
{
return $this->setMethods(
array_diff(
$this->generator->getClassMethods($this->type),
$methods
)
);
}
/**
* Specifies the arguments for the constructor.
*
* @return $this
*/
public function setConstructorArgs(array $args): self
{
$this->constructorArgs = $args;
return $this;
}
/**
* Specifies the name for the mock class.
*
* @return $this
*/
public function setMockClassName(string $name): self
{
$this->mockClassName = $name;
return $this;
}
/**
* Disables the invocation of the original constructor.
*
* @return $this
*/
public function disableOriginalConstructor(): self
{
$this->originalConstructor = false;
return $this;
}
/**
* Enables the invocation of the original constructor.
*
* @return $this
*/
public function enableOriginalConstructor(): self
{
$this->originalConstructor = true;
return $this;
}
/**
* Disables the invocation of the original clone constructor.
*
* @return $this
*/
public function disableOriginalClone(): self
{
$this->originalClone = false;
return $this;
}
/**
* Enables the invocation of the original clone constructor.
*
* @return $this
*/
public function enableOriginalClone(): self
{
$this->originalClone = true;
return $this;
}
/**
* Disables the use of class autoloading while creating the mock object.
*
* @return $this
*/
public function disableAutoload(): self
{
$this->autoload = false;
return $this;
}
/**
* Enables the use of class autoloading while creating the mock object.
*
* @return $this
*/
public function enableAutoload(): self
{
$this->autoload = true;
return $this;
}
/**
* Disables the cloning of arguments passed to mocked methods.
*
* @return $this
*/
public function disableArgumentCloning(): self
{
$this->cloneArguments = false;
return $this;
}
/**
* Enables the cloning of arguments passed to mocked methods.
*
* @return $this
*/
public function enableArgumentCloning(): self
{
$this->cloneArguments = true;
return $this;
}
/**
* Enables the invocation of the original methods.
*
* @return $this
*/
public function enableProxyingToOriginalMethods(): self
{
$this->callOriginalMethods = true;
return $this;
}
/**
* Disables the invocation of the original methods.
*
* @return $this
*/
public function disableProxyingToOriginalMethods(): self
{
$this->callOriginalMethods = false;
$this->proxyTarget = null;
return $this;
}
/**
* Sets the proxy target.
*
* @return $this
*/
public function setProxyTarget(object $object): self
{
$this->proxyTarget = $object;
return $this;
}
/**
* @return $this
*/
public function allowMockingUnknownTypes(): self
{
$this->allowMockingUnknownTypes = true;
return $this;
}
/**
* @return $this
*/
public function disallowMockingUnknownTypes(): self
{
$this->allowMockingUnknownTypes = false;
return $this;
}
/**
* @return $this
*/
public function enableAutoReturnValueGeneration(): self
{
$this->returnValueGeneration = true;
return $this;
}
/**
* @return $this
*/
public function disableAutoReturnValueGeneration(): self
{
$this->returnValueGeneration = false;
return $this;
}
}
PK [%m & src/Framework/MockObject/Generator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use const DIRECTORY_SEPARATOR;
use const PHP_EOL;
use const PHP_MAJOR_VERSION;
use const PREG_OFFSET_CAPTURE;
use const WSDL_CACHE_NONE;
use function array_merge;
use function array_pop;
use function array_unique;
use function class_exists;
use function count;
use function explode;
use function extension_loaded;
use function implode;
use function in_array;
use function interface_exists;
use function is_array;
use function is_object;
use function md5;
use function method_exists;
use function mt_rand;
use function preg_match;
use function preg_match_all;
use function range;
use function serialize;
use function sort;
use function sprintf;
use function str_replace;
use function strlen;
use function strpos;
use function strtolower;
use function substr;
use function trait_exists;
use Doctrine\Instantiator\Exception\ExceptionInterface as InstantiatorException;
use Doctrine\Instantiator\Instantiator;
use Exception;
use Iterator;
use IteratorAggregate;
use PHPUnit\Framework\InvalidArgumentException;
use ReflectionClass;
use ReflectionMethod;
use SebastianBergmann\Template\Exception as TemplateException;
use SebastianBergmann\Template\Template;
use SoapClient;
use SoapFault;
use Throwable;
use Traversable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Generator
{
private const MOCKED_CLONE_METHOD_WITH_VOID_RETURN_TYPE_TRAIT = <<<'EOT'
namespace PHPUnit\Framework\MockObject;
trait MockedCloneMethodWithVoidReturnType
{
public function __clone(): void
{
$this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationHandler();
}
}
EOT;
private const MOCKED_CLONE_METHOD_WITHOUT_RETURN_TYPE_TRAIT = <<<'EOT'
namespace PHPUnit\Framework\MockObject;
trait MockedCloneMethodWithoutReturnType
{
public function __clone()
{
$this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationHandler();
}
}
EOT;
private const UNMOCKED_CLONE_METHOD_WITH_VOID_RETURN_TYPE_TRAIT = <<<'EOT'
namespace PHPUnit\Framework\MockObject;
trait UnmockedCloneMethodWithVoidReturnType
{
public function __clone(): void
{
$this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationHandler();
parent::__clone();
}
}
EOT;
private const UNMOCKED_CLONE_METHOD_WITHOUT_RETURN_TYPE_TRAIT = <<<'EOT'
namespace PHPUnit\Framework\MockObject;
trait UnmockedCloneMethodWithoutReturnType
{
public function __clone()
{
$this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationHandler();
parent::__clone();
}
}
EOT;
/**
* @var array
*/
private const EXCLUDED_METHOD_NAMES = [
'__CLASS__' => true,
'__DIR__' => true,
'__FILE__' => true,
'__FUNCTION__' => true,
'__LINE__' => true,
'__METHOD__' => true,
'__NAMESPACE__' => true,
'__TRAIT__' => true,
'__clone' => true,
'__halt_compiler' => true,
];
/**
* @var array
*/
private static $cache = [];
/**
* @var Template[]
*/
private static $templates = [];
/**
* Returns a mock object for the specified class.
*
* @param null|array $methods
*
* @throws \PHPUnit\Framework\InvalidArgumentException
* @throws ClassAlreadyExistsException
* @throws ClassIsFinalException
* @throws ClassIsReadonlyException
* @throws DuplicateMethodException
* @throws InvalidMethodNameException
* @throws OriginalConstructorInvocationRequiredException
* @throws ReflectionException
* @throws RuntimeException
* @throws UnknownTypeException
*/
public function getMock(string $type, $methods = [], array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, bool $cloneArguments = true, bool $callOriginalMethods = false, object $proxyTarget = null, bool $allowMockingUnknownTypes = true, bool $returnValueGeneration = true): MockObject
{
if (!is_array($methods) && null !== $methods) {
throw InvalidArgumentException::create(2, 'array');
}
if ($type === 'Traversable' || $type === '\\Traversable') {
$type = 'Iterator';
}
if (!$allowMockingUnknownTypes && !class_exists($type, $callAutoload) && !interface_exists($type, $callAutoload)) {
throw new UnknownTypeException($type);
}
if (null !== $methods) {
foreach ($methods as $method) {
if (!preg_match('~[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*~', (string) $method)) {
throw new InvalidMethodNameException((string) $method);
}
}
if ($methods !== array_unique($methods)) {
throw new DuplicateMethodException($methods);
}
}
if ($mockClassName !== '' && class_exists($mockClassName, false)) {
try {
$reflector = new ReflectionClass($mockClassName);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if (!$reflector->implementsInterface(MockObject::class)) {
throw new ClassAlreadyExistsException($mockClassName);
}
}
if (!$callOriginalConstructor && $callOriginalMethods) {
throw new OriginalConstructorInvocationRequiredException;
}
$mock = $this->generate(
$type,
$methods,
$mockClassName,
$callOriginalClone,
$callAutoload,
$cloneArguments,
$callOriginalMethods
);
return $this->getObject(
$mock,
$type,
$callOriginalConstructor,
$callAutoload,
$arguments,
$callOriginalMethods,
$proxyTarget,
$returnValueGeneration
);
}
/**
* @psalm-param list $interfaces
*
* @throws RuntimeException
* @throws UnknownTypeException
*/
public function getMockForInterfaces(array $interfaces, bool $callAutoload = true): MockObject
{
if (count($interfaces) < 2) {
throw new RuntimeException('At least two interfaces must be specified');
}
foreach ($interfaces as $interface) {
if (!interface_exists($interface, $callAutoload)) {
throw new UnknownTypeException($interface);
}
}
sort($interfaces);
$methods = [];
foreach ($interfaces as $interface) {
$methods = array_merge($methods, $this->getClassMethods($interface));
}
if (count(array_unique($methods)) < count($methods)) {
throw new RuntimeException('Interfaces must not declare the same method');
}
$unqualifiedNames = [];
foreach ($interfaces as $interface) {
$parts = explode('\\', $interface);
$unqualifiedNames[] = array_pop($parts);
}
sort($unqualifiedNames);
do {
$intersectionName = sprintf(
'Intersection_%s_%s',
implode('_', $unqualifiedNames),
substr(md5((string) mt_rand()), 0, 8)
);
} while (interface_exists($intersectionName, false));
$template = $this->getTemplate('intersection.tpl');
$template->setVar(
[
'intersection' => $intersectionName,
'interfaces' => implode(', ', $interfaces),
]
);
eval($template->render());
return $this->getMock($intersectionName);
}
/**
* Returns a mock object for the specified abstract class with all abstract
* methods of the class mocked.
*
* Concrete methods to mock can be specified with the $mockedMethods parameter.
*
* @psalm-template RealInstanceType of object
*
* @psalm-param class-string $originalClassName
*
* @psalm-return MockObject&RealInstanceType
*
* @throws \PHPUnit\Framework\InvalidArgumentException
* @throws ClassAlreadyExistsException
* @throws ClassIsFinalException
* @throws ClassIsReadonlyException
* @throws DuplicateMethodException
* @throws InvalidMethodNameException
* @throws OriginalConstructorInvocationRequiredException
* @throws ReflectionException
* @throws RuntimeException
* @throws UnknownClassException
* @throws UnknownTypeException
*/
public function getMockForAbstractClass(string $originalClassName, array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, array $mockedMethods = null, bool $cloneArguments = true): MockObject
{
if (class_exists($originalClassName, $callAutoload) ||
interface_exists($originalClassName, $callAutoload)) {
try {
$reflector = new ReflectionClass($originalClassName);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$methods = $mockedMethods;
foreach ($reflector->getMethods() as $method) {
if ($method->isAbstract() && !in_array($method->getName(), $methods ?? [], true)) {
$methods[] = $method->getName();
}
}
if (empty($methods)) {
$methods = null;
}
return $this->getMock(
$originalClassName,
$methods,
$arguments,
$mockClassName,
$callOriginalConstructor,
$callOriginalClone,
$callAutoload,
$cloneArguments
);
}
throw new UnknownClassException($originalClassName);
}
/**
* Returns a mock object for the specified trait with all abstract methods
* of the trait mocked. Concrete methods to mock can be specified with the
* `$mockedMethods` parameter.
*
* @psalm-param trait-string $traitName
*
* @throws \PHPUnit\Framework\InvalidArgumentException
* @throws ClassAlreadyExistsException
* @throws ClassIsFinalException
* @throws ClassIsReadonlyException
* @throws DuplicateMethodException
* @throws InvalidMethodNameException
* @throws OriginalConstructorInvocationRequiredException
* @throws ReflectionException
* @throws RuntimeException
* @throws UnknownClassException
* @throws UnknownTraitException
* @throws UnknownTypeException
*/
public function getMockForTrait(string $traitName, array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, array $mockedMethods = null, bool $cloneArguments = true): MockObject
{
if (!trait_exists($traitName, $callAutoload)) {
throw new UnknownTraitException($traitName);
}
$className = $this->generateClassName(
$traitName,
'',
'Trait_'
);
$classTemplate = $this->getTemplate('trait_class.tpl');
$classTemplate->setVar(
[
'prologue' => 'abstract ',
'class_name' => $className['className'],
'trait_name' => $traitName,
]
);
$mockTrait = new MockTrait($classTemplate->render(), $className['className']);
$mockTrait->generate();
return $this->getMockForAbstractClass($className['className'], $arguments, $mockClassName, $callOriginalConstructor, $callOriginalClone, $callAutoload, $mockedMethods, $cloneArguments);
}
/**
* Returns an object for the specified trait.
*
* @psalm-param trait-string $traitName
*
* @throws ReflectionException
* @throws RuntimeException
* @throws UnknownTraitException
*/
public function getObjectForTrait(string $traitName, string $traitClassName = '', bool $callAutoload = true, bool $callOriginalConstructor = false, array $arguments = []): object
{
if (!trait_exists($traitName, $callAutoload)) {
throw new UnknownTraitException($traitName);
}
$className = $this->generateClassName(
$traitName,
$traitClassName,
'Trait_'
);
$classTemplate = $this->getTemplate('trait_class.tpl');
$classTemplate->setVar(
[
'prologue' => '',
'class_name' => $className['className'],
'trait_name' => $traitName,
]
);
return $this->getObject(
new MockTrait(
$classTemplate->render(),
$className['className']
),
'',
$callOriginalConstructor,
$callAutoload,
$arguments
);
}
/**
* @throws ClassIsFinalException
* @throws ClassIsReadonlyException
* @throws ReflectionException
* @throws RuntimeException
*/
public function generate(string $type, array $methods = null, string $mockClassName = '', bool $callOriginalClone = true, bool $callAutoload = true, bool $cloneArguments = true, bool $callOriginalMethods = false): MockClass
{
if ($mockClassName !== '') {
return $this->generateMock(
$type,
$methods,
$mockClassName,
$callOriginalClone,
$callAutoload,
$cloneArguments,
$callOriginalMethods
);
}
$key = md5(
$type .
serialize($methods) .
serialize($callOriginalClone) .
serialize($cloneArguments) .
serialize($callOriginalMethods)
);
if (!isset(self::$cache[$key])) {
self::$cache[$key] = $this->generateMock(
$type,
$methods,
$mockClassName,
$callOriginalClone,
$callAutoload,
$cloneArguments,
$callOriginalMethods
);
}
return self::$cache[$key];
}
/**
* @throws RuntimeException
* @throws SoapExtensionNotAvailableException
*/
public function generateClassFromWsdl(string $wsdlFile, string $className, array $methods = [], array $options = []): string
{
if (!extension_loaded('soap')) {
throw new SoapExtensionNotAvailableException;
}
$options = array_merge($options, ['cache_wsdl' => WSDL_CACHE_NONE]);
try {
$client = new SoapClient($wsdlFile, $options);
$_methods = array_unique($client->__getFunctions());
unset($client);
} catch (SoapFault $e) {
throw new RuntimeException(
$e->getMessage(),
$e->getCode(),
$e
);
}
sort($_methods);
$methodTemplate = $this->getTemplate('wsdl_method.tpl');
$methodsBuffer = '';
foreach ($_methods as $method) {
preg_match_all('/[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\(/', $method, $matches, PREG_OFFSET_CAPTURE);
$lastFunction = array_pop($matches[0]);
$nameStart = $lastFunction[1];
$nameEnd = $nameStart + strlen($lastFunction[0]) - 1;
$name = str_replace('(', '', $lastFunction[0]);
if (empty($methods) || in_array($name, $methods, true)) {
$args = explode(
',',
str_replace(')', '', substr($method, $nameEnd + 1))
);
foreach (range(0, count($args) - 1) as $i) {
$parameterStart = strpos($args[$i], '$');
if (!$parameterStart) {
continue;
}
$args[$i] = substr($args[$i], $parameterStart);
}
$methodTemplate->setVar(
[
'method_name' => $name,
'arguments' => implode(', ', $args),
]
);
$methodsBuffer .= $methodTemplate->render();
}
}
$optionsBuffer = '[';
foreach ($options as $key => $value) {
$optionsBuffer .= $key . ' => ' . $value;
}
$optionsBuffer .= ']';
$classTemplate = $this->getTemplate('wsdl_class.tpl');
$namespace = '';
if (strpos($className, '\\') !== false) {
$parts = explode('\\', $className);
$className = array_pop($parts);
$namespace = 'namespace ' . implode('\\', $parts) . ';' . "\n\n";
}
$classTemplate->setVar(
[
'namespace' => $namespace,
'class_name' => $className,
'wsdl' => $wsdlFile,
'options' => $optionsBuffer,
'methods' => $methodsBuffer,
]
);
return $classTemplate->render();
}
/**
* @throws ReflectionException
*
* @return string[]
*/
public function getClassMethods(string $className): array
{
try {
$class = new ReflectionClass($className);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$methods = [];
foreach ($class->getMethods() as $method) {
if ($method->isPublic() || $method->isAbstract()) {
$methods[] = $method->getName();
}
}
return $methods;
}
/**
* @throws ReflectionException
*
* @return MockMethod[]
*/
public function mockClassMethods(string $className, bool $callOriginalMethods, bool $cloneArguments): array
{
try {
$class = new ReflectionClass($className);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$methods = [];
foreach ($class->getMethods() as $method) {
if (($method->isPublic() || $method->isAbstract()) && $this->canMockMethod($method)) {
$methods[] = MockMethod::fromReflection($method, $callOriginalMethods, $cloneArguments);
}
}
return $methods;
}
/**
* @throws ReflectionException
*
* @return MockMethod[]
*/
public function mockInterfaceMethods(string $interfaceName, bool $cloneArguments): array
{
try {
$class = new ReflectionClass($interfaceName);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$methods = [];
foreach ($class->getMethods() as $method) {
$methods[] = MockMethod::fromReflection($method, false, $cloneArguments);
}
return $methods;
}
/**
* @psalm-param class-string $interfaceName
*
* @throws ReflectionException
*
* @return ReflectionMethod[]
*/
private function userDefinedInterfaceMethods(string $interfaceName): array
{
try {
// @codeCoverageIgnoreStart
$interface = new ReflectionClass($interfaceName);
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$methods = [];
foreach ($interface->getMethods() as $method) {
if (!$method->isUserDefined()) {
continue;
}
$methods[] = $method;
}
return $methods;
}
/**
* @throws ReflectionException
* @throws RuntimeException
*/
private function getObject(MockType $mockClass, $type = '', bool $callOriginalConstructor = false, bool $callAutoload = false, array $arguments = [], bool $callOriginalMethods = false, object $proxyTarget = null, bool $returnValueGeneration = true)
{
$className = $mockClass->generate();
if ($callOriginalConstructor) {
if (count($arguments) === 0) {
$object = new $className;
} else {
try {
$class = new ReflectionClass($className);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$object = $class->newInstanceArgs($arguments);
}
} else {
try {
$object = (new Instantiator)->instantiate($className);
} catch (InstantiatorException $e) {
throw new RuntimeException($e->getMessage());
}
}
if ($callOriginalMethods) {
if (!is_object($proxyTarget)) {
if (count($arguments) === 0) {
$proxyTarget = new $type;
} else {
try {
$class = new ReflectionClass($type);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
$proxyTarget = $class->newInstanceArgs($arguments);
}
}
$object->__phpunit_setOriginalObject($proxyTarget);
}
if ($object instanceof MockObject) {
$object->__phpunit_setReturnValueGeneration($returnValueGeneration);
}
return $object;
}
/**
* @throws ClassIsFinalException
* @throws ClassIsReadonlyException
* @throws ReflectionException
* @throws RuntimeException
*/
private function generateMock(string $type, ?array $explicitMethods, string $mockClassName, bool $callOriginalClone, bool $callAutoload, bool $cloneArguments, bool $callOriginalMethods): MockClass
{
$classTemplate = $this->getTemplate('mocked_class.tpl');
$additionalInterfaces = [];
$mockedCloneMethod = false;
$unmockedCloneMethod = false;
$isClass = false;
$isInterface = false;
$class = null;
$mockMethods = new MockMethodSet;
$_mockClassName = $this->generateClassName(
$type,
$mockClassName,
'Mock_'
);
if (class_exists($_mockClassName['fullClassName'], $callAutoload)) {
$isClass = true;
} elseif (interface_exists($_mockClassName['fullClassName'], $callAutoload)) {
$isInterface = true;
}
if (!$isClass && !$isInterface) {
$prologue = 'class ' . $_mockClassName['originalClassName'] . "\n{\n}\n\n";
if (!empty($_mockClassName['namespaceName'])) {
$prologue = 'namespace ' . $_mockClassName['namespaceName'] .
" {\n\n" . $prologue . "}\n\n" .
"namespace {\n\n";
$epilogue = "\n\n}";
}
$mockedCloneMethod = true;
} else {
try {
$class = new ReflectionClass($_mockClassName['fullClassName']);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if ($class->isFinal()) {
throw new ClassIsFinalException($_mockClassName['fullClassName']);
}
if (method_exists($class, 'isReadOnly') && $class->isReadOnly()) {
throw new ClassIsReadonlyException($_mockClassName['fullClassName']);
}
// @see https://github.com/sebastianbergmann/phpunit/issues/2995
if ($isInterface && $class->implementsInterface(Throwable::class)) {
$actualClassName = Exception::class;
$additionalInterfaces[] = $class->getName();
$isInterface = false;
try {
$class = new ReflectionClass($actualClassName);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
foreach ($this->userDefinedInterfaceMethods($_mockClassName['fullClassName']) as $method) {
$methodName = $method->getName();
if ($class->hasMethod($methodName)) {
try {
$classMethod = $class->getMethod($methodName);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if (!$this->canMockMethod($classMethod)) {
continue;
}
}
$mockMethods->addMethods(
MockMethod::fromReflection($method, $callOriginalMethods, $cloneArguments)
);
}
$_mockClassName = $this->generateClassName(
$actualClassName,
$_mockClassName['className'],
'Mock_'
);
}
// @see https://github.com/sebastianbergmann/phpunit-mock-objects/issues/103
if ($isInterface && $class->implementsInterface(Traversable::class) &&
!$class->implementsInterface(Iterator::class) &&
!$class->implementsInterface(IteratorAggregate::class)) {
$additionalInterfaces[] = Iterator::class;
$mockMethods->addMethods(
...$this->mockClassMethods(Iterator::class, $callOriginalMethods, $cloneArguments)
);
}
if ($class->hasMethod('__clone')) {
try {
$cloneMethod = $class->getMethod('__clone');
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if (!$cloneMethod->isFinal()) {
if ($callOriginalClone && !$isInterface) {
$unmockedCloneMethod = true;
} else {
$mockedCloneMethod = true;
}
}
} else {
$mockedCloneMethod = true;
}
}
if ($isClass && $explicitMethods === []) {
$mockMethods->addMethods(
...$this->mockClassMethods($_mockClassName['fullClassName'], $callOriginalMethods, $cloneArguments)
);
}
if ($isInterface && ($explicitMethods === [] || $explicitMethods === null)) {
$mockMethods->addMethods(
...$this->mockInterfaceMethods($_mockClassName['fullClassName'], $cloneArguments)
);
}
if (is_array($explicitMethods)) {
foreach ($explicitMethods as $methodName) {
if ($class !== null && $class->hasMethod($methodName)) {
try {
$method = $class->getMethod($methodName);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if ($this->canMockMethod($method)) {
$mockMethods->addMethods(
MockMethod::fromReflection($method, $callOriginalMethods, $cloneArguments)
);
}
} else {
$mockMethods->addMethods(
MockMethod::fromName(
$_mockClassName['fullClassName'],
$methodName,
$cloneArguments
)
);
}
}
}
$mockedMethods = '';
$configurable = [];
foreach ($mockMethods->asArray() as $mockMethod) {
$mockedMethods .= $mockMethod->generateCode();
$configurable[] = new ConfigurableMethod($mockMethod->getName(), $mockMethod->getReturnType());
}
$method = '';
if (!$mockMethods->hasMethod('method') && (!isset($class) || !$class->hasMethod('method'))) {
$method = PHP_EOL . ' use \PHPUnit\Framework\MockObject\Method;';
}
$cloneTrait = '';
if ($mockedCloneMethod) {
$cloneTrait = $this->mockedCloneMethod();
}
if ($unmockedCloneMethod) {
$cloneTrait = $this->unmockedCloneMethod();
}
$classTemplate->setVar(
[
'prologue' => $prologue ?? '',
'epilogue' => $epilogue ?? '',
'class_declaration' => $this->generateMockClassDeclaration(
$_mockClassName,
$isInterface,
$additionalInterfaces
),
'clone' => $cloneTrait,
'mock_class_name' => $_mockClassName['className'],
'mocked_methods' => $mockedMethods,
'method' => $method,
]
);
return new MockClass(
$classTemplate->render(),
$_mockClassName['className'],
$configurable
);
}
private function generateClassName(string $type, string $className, string $prefix): array
{
if ($type[0] === '\\') {
$type = substr($type, 1);
}
$classNameParts = explode('\\', $type);
if (count($classNameParts) > 1) {
$type = array_pop($classNameParts);
$namespaceName = implode('\\', $classNameParts);
$fullClassName = $namespaceName . '\\' . $type;
} else {
$namespaceName = '';
$fullClassName = $type;
}
if ($className === '') {
do {
$className = $prefix . $type . '_' .
substr(md5((string) mt_rand()), 0, 8);
} while (class_exists($className, false));
}
return [
'className' => $className,
'originalClassName' => $type,
'fullClassName' => $fullClassName,
'namespaceName' => $namespaceName,
];
}
private function generateMockClassDeclaration(array $mockClassName, bool $isInterface, array $additionalInterfaces = []): string
{
$buffer = 'class ';
$additionalInterfaces[] = MockObject::class;
$interfaces = implode(', ', $additionalInterfaces);
if ($isInterface) {
$buffer .= sprintf(
'%s implements %s',
$mockClassName['className'],
$interfaces
);
if (!in_array($mockClassName['originalClassName'], $additionalInterfaces, true)) {
$buffer .= ', ';
if (!empty($mockClassName['namespaceName'])) {
$buffer .= $mockClassName['namespaceName'] . '\\';
}
$buffer .= $mockClassName['originalClassName'];
}
} else {
$buffer .= sprintf(
'%s extends %s%s implements %s',
$mockClassName['className'],
!empty($mockClassName['namespaceName']) ? $mockClassName['namespaceName'] . '\\' : '',
$mockClassName['originalClassName'],
$interfaces
);
}
return $buffer;
}
private function canMockMethod(ReflectionMethod $method): bool
{
return !($this->isConstructor($method) || $method->isFinal() || $method->isPrivate() || $this->isMethodNameExcluded($method->getName()));
}
private function isMethodNameExcluded(string $name): bool
{
return isset(self::EXCLUDED_METHOD_NAMES[$name]);
}
/**
* @throws RuntimeException
*/
private function getTemplate(string $template): Template
{
$filename = __DIR__ . DIRECTORY_SEPARATOR . 'Generator' . DIRECTORY_SEPARATOR . $template;
if (!isset(self::$templates[$filename])) {
try {
self::$templates[$filename] = new Template($filename);
} catch (TemplateException $e) {
throw new RuntimeException(
$e->getMessage(),
$e->getCode(),
$e
);
}
}
return self::$templates[$filename];
}
/**
* @see https://github.com/sebastianbergmann/phpunit/issues/4139#issuecomment-605409765
*/
private function isConstructor(ReflectionMethod $method): bool
{
$methodName = strtolower($method->getName());
if ($methodName === '__construct') {
return true;
}
if (PHP_MAJOR_VERSION >= 8) {
return false;
}
$className = strtolower($method->getDeclaringClass()->getName());
return $methodName === $className;
}
private function mockedCloneMethod(): string
{
if (PHP_MAJOR_VERSION >= 8) {
if (!trait_exists('\PHPUnit\Framework\MockObject\MockedCloneMethodWithVoidReturnType')) {
eval(self::MOCKED_CLONE_METHOD_WITH_VOID_RETURN_TYPE_TRAIT);
}
return PHP_EOL . ' use \PHPUnit\Framework\MockObject\MockedCloneMethodWithVoidReturnType;';
}
if (!trait_exists('\PHPUnit\Framework\MockObject\MockedCloneMethodWithoutReturnType')) {
eval(self::MOCKED_CLONE_METHOD_WITHOUT_RETURN_TYPE_TRAIT);
}
return PHP_EOL . ' use \PHPUnit\Framework\MockObject\MockedCloneMethodWithoutReturnType;';
}
private function unmockedCloneMethod(): string
{
if (PHP_MAJOR_VERSION >= 8) {
if (!trait_exists('\PHPUnit\Framework\MockObject\UnmockedCloneMethodWithVoidReturnType')) {
eval(self::UNMOCKED_CLONE_METHOD_WITH_VOID_RETURN_TYPE_TRAIT);
}
return PHP_EOL . ' use \PHPUnit\Framework\MockObject\UnmockedCloneMethodWithVoidReturnType;';
}
if (!trait_exists('\PHPUnit\Framework\MockObject\UnmockedCloneMethodWithoutReturnType')) {
eval(self::UNMOCKED_CLONE_METHOD_WITHOUT_RETURN_TYPE_TRAIT);
}
return PHP_EOL . ' use \PHPUnit\Framework\MockObject\UnmockedCloneMethodWithoutReturnType;';
}
}
PK [/v ' src/Framework/MockObject/Verifiable.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use PHPUnit\Framework\ExpectationFailedException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface Verifiable
{
/**
* Verifies that the current expectation is valid. If everything is OK the
* code should just return, if not it must throw an exception.
*
* @throws ExpectationFailedException
*/
public function verify(): void;
}
PK [7c2 2 & src/Framework/MockObject/Stub/Stub.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Stub;
use PHPUnit\Framework\MockObject\Invocation;
use PHPUnit\Framework\SelfDescribing;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface Stub extends SelfDescribing
{
/**
* Fakes the processing of the invocation $invocation by returning a
* specific value.
*
* @param Invocation $invocation The invocation which was mocked and matched by the current method and argument matchers
*/
public function invoke(Invocation $invocation);
}
PK [ 0 src/Framework/MockObject/Stub/ReturnArgument.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Stub;
use function sprintf;
use PHPUnit\Framework\MockObject\Invocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ReturnArgument implements Stub
{
/**
* @var int
*/
private $argumentIndex;
public function __construct($argumentIndex)
{
$this->argumentIndex = $argumentIndex;
}
public function invoke(Invocation $invocation)
{
if (isset($invocation->getParameters()[$this->argumentIndex])) {
return $invocation->getParameters()[$this->argumentIndex];
}
}
public function toString(): string
{
return sprintf('return argument #%d', $this->argumentIndex);
}
}
PK [UG 0 src/Framework/MockObject/Stub/ReturnValueMap.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Stub;
use function array_pop;
use function count;
use function is_array;
use PHPUnit\Framework\MockObject\Invocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ReturnValueMap implements Stub
{
/**
* @var array
*/
private $valueMap;
public function __construct(array $valueMap)
{
$this->valueMap = $valueMap;
}
public function invoke(Invocation $invocation)
{
$parameterCount = count($invocation->getParameters());
foreach ($this->valueMap as $map) {
if (!is_array($map) || $parameterCount !== (count($map) - 1)) {
continue;
}
$return = array_pop($map);
if ($invocation->getParameters() === $map) {
return $return;
}
}
}
public function toString(): string
{
return 'return value from a map';
}
}
PK [: : 0 src/Framework/MockObject/Stub/ReturnCallback.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Stub;
use function call_user_func_array;
use function get_class;
use function is_array;
use function is_object;
use function sprintf;
use PHPUnit\Framework\MockObject\Invocation;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ReturnCallback implements Stub
{
private $callback;
public function __construct($callback)
{
$this->callback = $callback;
}
public function invoke(Invocation $invocation)
{
return call_user_func_array($this->callback, $invocation->getParameters());
}
public function toString(): string
{
if (is_array($this->callback)) {
if (is_object($this->callback[0])) {
$class = get_class($this->callback[0]);
$type = '->';
} else {
$class = $this->callback[0];
$type = '::';
}
return sprintf(
'return result of user defined callback %s%s%s() with the ' .
'passed arguments',
$class,
$type,
$this->callback[1]
);
}
return 'return result of user defined callback ' . $this->callback .
' with the passed arguments';
}
}
PK [ , src/Framework/MockObject/Stub/ReturnSelf.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Stub;
use PHPUnit\Framework\MockObject\Invocation;
use PHPUnit\Framework\MockObject\RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ReturnSelf implements Stub
{
/**
* @throws RuntimeException
*/
public function invoke(Invocation $invocation)
{
return $invocation->getObject();
}
public function toString(): string
{
return 'return the current object';
}
}
PK [P< + src/Framework/MockObject/Stub/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Stub;
use function sprintf;
use PHPUnit\Framework\MockObject\Invocation;
use SebastianBergmann\Exporter\Exporter;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Exception implements Stub
{
private $exception;
public function __construct(Throwable $exception)
{
$this->exception = $exception;
}
/**
* @throws Throwable
*/
public function invoke(Invocation $invocation): void
{
throw $this->exception;
}
public function toString(): string
{
$exporter = new Exporter;
return sprintf(
'raise user-specified exception %s',
$exporter->export($this->exception)
);
}
}
PK [53 2 src/Framework/MockObject/Stub/ConsecutiveCalls.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Stub;
use function array_shift;
use function sprintf;
use PHPUnit\Framework\MockObject\Invocation;
use SebastianBergmann\Exporter\Exporter;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ConsecutiveCalls implements Stub
{
/**
* @var array
*/
private $stack;
/**
* @var mixed
*/
private $value;
public function __construct(array $stack)
{
$this->stack = $stack;
}
public function invoke(Invocation $invocation)
{
$this->value = array_shift($this->stack);
if ($this->value instanceof Stub) {
$this->value = $this->value->invoke($invocation);
}
return $this->value;
}
public function toString(): string
{
$exporter = new Exporter;
return sprintf(
'return user-specified value %s',
$exporter->export($this->value)
);
}
}
PK [V 1 src/Framework/MockObject/Stub/ReturnReference.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Stub;
use function sprintf;
use PHPUnit\Framework\MockObject\Invocation;
use SebastianBergmann\Exporter\Exporter;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ReturnReference implements Stub
{
/**
* @var mixed
*/
private $reference;
public function __construct(&$reference)
{
$this->reference = &$reference;
}
public function invoke(Invocation $invocation)
{
return $this->reference;
}
public function toString(): string
{
$exporter = new Exporter;
return sprintf(
'return user-specified reference %s',
$exporter->export($this->reference)
);
}
}
PK [
, src/Framework/MockObject/Stub/ReturnStub.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Stub;
use function sprintf;
use PHPUnit\Framework\MockObject\Invocation;
use SebastianBergmann\Exporter\Exporter;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ReturnStub implements Stub
{
/**
* @var mixed
*/
private $value;
public function __construct($value)
{
$this->value = $value;
}
public function invoke(Invocation $invocation)
{
return $this->value;
}
public function toString(): string
{
$exporter = new Exporter;
return sprintf(
'return user-specified value %s',
$exporter->export($this->value)
);
}
}
PK [`i / src/Framework/MockObject/ConfigurableMethod.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use SebastianBergmann\Type\Type;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ConfigurableMethod
{
/**
* @var string
*/
private $name;
/**
* @var Type
*/
private $returnType;
public function __construct(string $name, Type $returnType)
{
$this->name = $name;
$this->returnType = $returnType;
}
public function getName(): string
{
return $this->name;
}
public function mayReturn($value): bool
{
if ($value === null && $this->returnType->allowsNull()) {
return true;
}
return $this->returnType->isAssignable(Type::fromValue($value, false));
}
public function getReturnTypeDeclaration(): string
{
return $this->returnType->asString();
}
}
PK [? ) src/Framework/MockObject/Builder/Stub.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Builder;
use PHPUnit\Framework\MockObject\Stub\Stub as BaseStub;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface Stub extends Identity
{
/**
* Stubs the matching method with the stub object $stub. Any invocations of
* the matched method will now be handled by the stub instead.
*/
public function will(BaseStub $stub): Identity;
}
PK [v 6 src/Framework/MockObject/Builder/InvocationStubber.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Builder;
use PHPUnit\Framework\MockObject\Stub\Stub;
use Throwable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
interface InvocationStubber
{
public function will(Stub $stub): Identity;
/** @return self */
public function willReturn($value, ...$nextValues)/*: self */;
/**
* @param mixed $reference
*
* @return self
*/
public function willReturnReference(&$reference)/*: self */;
/**
* @param array> $valueMap
*
* @return self
*/
public function willReturnMap(array $valueMap)/*: self */;
/**
* @param int $argumentIndex
*
* @return self
*/
public function willReturnArgument($argumentIndex)/*: self */;
/**
* @param callable $callback
*
* @return self
*/
public function willReturnCallback($callback)/*: self */;
/** @return self */
public function willReturnSelf()/*: self */;
/**
* @param mixed $values
*
* @return self
*/
public function willReturnOnConsecutiveCalls(...$values)/*: self */;
/** @return self */
public function willThrowException(Throwable $exception)/*: self */;
}
PK [}" - src/Framework/MockObject/Builder/Identity.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Builder;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface Identity
{
/**
* Sets the identification of the expectation to $id.
*
* @note The identifier is unique per mock object.
*
* @param string $id unique identification of expectation
*/
public function id($id);
}
PK [4
-j 4 src/Framework/MockObject/Builder/ParametersMatch.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Builder;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface ParametersMatch extends Stub
{
/**
* Defines the expectation which must occur before the current is valid.
*
* @param string $id the identification of the expectation that should
* occur before this one
*
* @return Stub
*/
public function after($id);
/**
* Sets the parameters to match for, each parameter to this function will
* be part of match. To perform specific matches or constraints create a
* new PHPUnit\Framework\Constraint\Constraint and use it for the parameter.
* If the parameter value is not a constraint it will use the
* PHPUnit\Framework\Constraint\IsEqual for the value.
*
* Some examples:
*
* // match first parameter with value 2
* $b->with(2);
* // match first parameter with value 'smock' and second identical to 42
* $b->with('smock', new PHPUnit\Framework\Constraint\IsEqual(42));
*
*
* @return ParametersMatch
*/
public function with(...$arguments);
/**
* Sets a rule which allows any kind of parameters.
*
* Some examples:
*
* // match any number of parameters
* $b->withAnyParameters();
*
*
* @return ParametersMatch
*/
public function withAnyParameters();
}
PK [}l2O O 4 src/Framework/MockObject/Builder/MethodNameMatch.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Builder;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface MethodNameMatch extends ParametersMatch
{
/**
* Adds a new method name match and returns the parameter match object for
* further matching possibilities.
*
* @param \PHPUnit\Framework\Constraint\Constraint $constraint Constraint for matching method, if a string is passed it will use the PHPUnit_Framework_Constraint_IsEqual
*
* @return ParametersMatch
*/
public function method($constraint);
}
PK [;[`@ @ 5 src/Framework/MockObject/Builder/InvocationMocker.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject\Builder;
use function array_map;
use function array_merge;
use function count;
use function in_array;
use function is_string;
use function strtolower;
use PHPUnit\Framework\Constraint\Constraint;
use PHPUnit\Framework\MockObject\ConfigurableMethod;
use PHPUnit\Framework\MockObject\IncompatibleReturnValueException;
use PHPUnit\Framework\MockObject\InvocationHandler;
use PHPUnit\Framework\MockObject\Matcher;
use PHPUnit\Framework\MockObject\MatcherAlreadyRegisteredException;
use PHPUnit\Framework\MockObject\MethodCannotBeConfiguredException;
use PHPUnit\Framework\MockObject\MethodNameAlreadyConfiguredException;
use PHPUnit\Framework\MockObject\MethodNameNotConfiguredException;
use PHPUnit\Framework\MockObject\MethodParametersAlreadyConfiguredException;
use PHPUnit\Framework\MockObject\Rule;
use PHPUnit\Framework\MockObject\Stub\ConsecutiveCalls;
use PHPUnit\Framework\MockObject\Stub\Exception;
use PHPUnit\Framework\MockObject\Stub\ReturnArgument;
use PHPUnit\Framework\MockObject\Stub\ReturnCallback;
use PHPUnit\Framework\MockObject\Stub\ReturnReference;
use PHPUnit\Framework\MockObject\Stub\ReturnSelf;
use PHPUnit\Framework\MockObject\Stub\ReturnStub;
use PHPUnit\Framework\MockObject\Stub\ReturnValueMap;
use PHPUnit\Framework\MockObject\Stub\Stub;
use Throwable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class InvocationMocker implements InvocationStubber, MethodNameMatch
{
/**
* @var InvocationHandler
*/
private $invocationHandler;
/**
* @var Matcher
*/
private $matcher;
/**
* @var ConfigurableMethod[]
*/
private $configurableMethods;
public function __construct(InvocationHandler $handler, Matcher $matcher, ConfigurableMethod ...$configurableMethods)
{
$this->invocationHandler = $handler;
$this->matcher = $matcher;
$this->configurableMethods = $configurableMethods;
}
/**
* @throws MatcherAlreadyRegisteredException
*
* @return $this
*/
public function id($id): self
{
$this->invocationHandler->registerMatcher($id, $this->matcher);
return $this;
}
/**
* @return $this
*/
public function will(Stub $stub): Identity
{
$this->matcher->setStub($stub);
return $this;
}
/**
* @param mixed $value
* @param mixed[] $nextValues
*
* @throws IncompatibleReturnValueException
*/
public function willReturn($value, ...$nextValues): self
{
if (count($nextValues) === 0) {
$this->ensureTypeOfReturnValues([$value]);
$stub = $value instanceof Stub ? $value : new ReturnStub($value);
} else {
$values = array_merge([$value], $nextValues);
$this->ensureTypeOfReturnValues($values);
$stub = new ConsecutiveCalls($values);
}
return $this->will($stub);
}
public function willReturnReference(&$reference): self
{
$stub = new ReturnReference($reference);
return $this->will($stub);
}
public function willReturnMap(array $valueMap): self
{
$stub = new ReturnValueMap($valueMap);
return $this->will($stub);
}
public function willReturnArgument($argumentIndex): self
{
$stub = new ReturnArgument($argumentIndex);
return $this->will($stub);
}
public function willReturnCallback($callback): self
{
$stub = new ReturnCallback($callback);
return $this->will($stub);
}
public function willReturnSelf(): self
{
$stub = new ReturnSelf;
return $this->will($stub);
}
public function willReturnOnConsecutiveCalls(...$values): self
{
$stub = new ConsecutiveCalls($values);
return $this->will($stub);
}
public function willThrowException(Throwable $exception): self
{
$stub = new Exception($exception);
return $this->will($stub);
}
/**
* @return $this
*/
public function after($id): self
{
$this->matcher->setAfterMatchBuilderId($id);
return $this;
}
/**
* @param mixed[] $arguments
*
* @throws \PHPUnit\Framework\Exception
* @throws MethodNameNotConfiguredException
* @throws MethodParametersAlreadyConfiguredException
*
* @return $this
*/
public function with(...$arguments): self
{
$this->ensureParametersCanBeConfigured();
$this->matcher->setParametersRule(new Rule\Parameters($arguments));
return $this;
}
/**
* @param array ...$arguments
*
* @throws \PHPUnit\Framework\Exception
* @throws MethodNameNotConfiguredException
* @throws MethodParametersAlreadyConfiguredException
*
* @return $this
*
* @deprecated
*/
public function withConsecutive(...$arguments): self
{
$this->ensureParametersCanBeConfigured();
$this->matcher->setParametersRule(new Rule\ConsecutiveParameters($arguments));
return $this;
}
/**
* @throws MethodNameNotConfiguredException
* @throws MethodParametersAlreadyConfiguredException
*
* @return $this
*/
public function withAnyParameters(): self
{
$this->ensureParametersCanBeConfigured();
$this->matcher->setParametersRule(new Rule\AnyParameters);
return $this;
}
/**
* @param Constraint|string $constraint
*
* @throws \PHPUnit\Framework\InvalidArgumentException
* @throws MethodCannotBeConfiguredException
* @throws MethodNameAlreadyConfiguredException
*
* @return $this
*/
public function method($constraint): self
{
if ($this->matcher->hasMethodNameRule()) {
throw new MethodNameAlreadyConfiguredException;
}
$configurableMethodNames = array_map(
static function (ConfigurableMethod $configurable)
{
return strtolower($configurable->getName());
},
$this->configurableMethods
);
if (is_string($constraint) && !in_array(strtolower($constraint), $configurableMethodNames, true)) {
throw new MethodCannotBeConfiguredException($constraint);
}
$this->matcher->setMethodNameRule(new Rule\MethodName($constraint));
return $this;
}
/**
* @throws MethodNameNotConfiguredException
* @throws MethodParametersAlreadyConfiguredException
*/
private function ensureParametersCanBeConfigured(): void
{
if (!$this->matcher->hasMethodNameRule()) {
throw new MethodNameNotConfiguredException;
}
if ($this->matcher->hasParametersRule()) {
throw new MethodParametersAlreadyConfiguredException;
}
}
private function getConfiguredMethod(): ?ConfigurableMethod
{
$configuredMethod = null;
foreach ($this->configurableMethods as $configurableMethod) {
if ($this->matcher->getMethodNameRule()->matchesName($configurableMethod->getName())) {
if ($configuredMethod !== null) {
return null;
}
$configuredMethod = $configurableMethod;
}
}
return $configuredMethod;
}
/**
* @throws IncompatibleReturnValueException
*/
private function ensureTypeOfReturnValues(array $values): void
{
$configuredMethod = $this->getConfiguredMethod();
if ($configuredMethod === null) {
return;
}
foreach ($values as $value) {
if (!$configuredMethod->mayReturn($value)) {
throw new IncompatibleReturnValueException(
$configuredMethod,
$value
);
}
}
}
}
PK [i = src/Framework/MockObject/Exception/BadMethodCallException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class BadMethodCallException extends \BadMethodCallException implements Exception
{
}
PK [f f K src/Framework/MockObject/Exception/MethodNameAlreadyConfiguredException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MethodNameAlreadyConfiguredException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct()
{
parent::__construct('Method name is already configured');
}
}
PK [9 D src/Framework/MockObject/Exception/MatchBuilderNotFoundException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MatchBuilderNotFoundException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $id)
{
parent::__construct(
sprintf(
'No builder found for match builder identification <%s>',
$id
)
);
}
}
PK [a-^ ^ G src/Framework/MockObject/Exception/MethodNameNotConfiguredException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MethodNameNotConfiguredException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct()
{
parent::__construct('Method name is not configured');
}
}
PK [% j j C src/Framework/MockObject/Exception/CannotUseAddMethodsException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class CannotUseAddMethodsException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $type, string $methodName)
{
parent::__construct(
sprintf(
'Trying to configure method "%s" with addMethods(), but it exists in class "%s". Use onlyMethods() for methods that exist in the class',
$methodName,
$type
)
);
}
}
PK [< I src/Framework/MockObject/Exception/SoapExtensionNotAvailableException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class SoapExtensionNotAvailableException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct()
{
parent::__construct(
'The SOAP extension is required to generate a test double from WSDL'
);
}
}
PK [66 ; src/Framework/MockObject/Exception/UnknownTypeException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class UnknownTypeException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $type)
{
parent::__construct(
sprintf(
'Class or interface "%s" does not exist',
$type
)
);
}
}
PK [ H src/Framework/MockObject/Exception/MatcherAlreadyRegisteredException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MatcherAlreadyRegisteredException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $id)
{
parent::__construct(
sprintf(
'Matcher with id <%s> is already registered',
$id
)
);
}
}
PK [/_Wz z D src/Framework/MockObject/Exception/CannotUseOnlyMethodsException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class CannotUseOnlyMethodsException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $type, string $methodName)
{
parent::__construct(
sprintf(
'Trying to configure method "%s" with onlyMethods(), but it does not exist in class "%s". Use addMethods() for methods that do not exist in the class',
$methodName,
$type
)
);
}
}
PK [ A A H src/Framework/MockObject/Exception/MethodCannotBeConfiguredException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MethodCannotBeConfiguredException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $method)
{
parent::__construct(
sprintf(
'Trying to configure method "%s" which cannot be configured because it does not exist, has not been specified, is final, or is static',
$method
)
);
}
}
PK [;ߑ ? src/Framework/MockObject/Exception/DuplicateMethodException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function array_diff_assoc;
use function array_unique;
use function implode;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class DuplicateMethodException extends \PHPUnit\Framework\Exception implements Exception
{
/**
* @psalm-param list $methods
*/
public function __construct(array $methods)
{
parent::__construct(
sprintf(
'Cannot double using a method list that contains duplicates: "%s" (duplicate: "%s")',
implode(', ', $methods),
implode(', ', array_unique(array_diff_assoc($methods, array_unique($methods))))
)
);
}
}
PK ["bB 7 src/Framework/MockObject/Exception/RuntimeException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class RuntimeException extends \RuntimeException implements Exception
{
}
PK [N, 0 src/Framework/MockObject/Exception/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface Exception extends Throwable
{
}
PK [2 M M H src/Framework/MockObject/Exception/ReturnValueNotConfiguredException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ReturnValueNotConfiguredException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(Invocation $invocation)
{
parent::__construct(
sprintf(
'Return value inference disabled and no expectation set up for %s::%s()',
$invocation->getClassName(),
$invocation->getMethodName()
)
);
}
}
PK [#ݡ5 < src/Framework/MockObject/Exception/UnknownClassException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class UnknownClassException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $className)
{
parent::__construct(
sprintf(
'Class "%s" does not exist',
$className
)
);
}
}
PK [ G src/Framework/MockObject/Exception/IncompatibleReturnValueException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function get_class;
use function gettype;
use function is_object;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class IncompatibleReturnValueException extends \PHPUnit\Framework\Exception implements Exception
{
/**
* @param mixed $value
*/
public function __construct(ConfigurableMethod $method, $value)
{
parent::__construct(
sprintf(
'Method %s may not return value of type %s, its declared return type is "%s"',
$method->getName(),
is_object($value) ? get_class($value) : gettype($value),
$method->getReturnTypeDeclaration()
)
);
}
}
PK [q+k < src/Framework/MockObject/Exception/ClassIsFinalException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ClassIsFinalException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $className)
{
parent::__construct(
sprintf(
'Class "%s" is declared "final" and cannot be doubled',
$className
)
);
}
}
PK [S A src/Framework/MockObject/Exception/InvalidMethodNameException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvalidMethodNameException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $method)
{
parent::__construct(
sprintf(
'Cannot double method with invalid name "%s"',
$method
)
);
}
}
PK [ ? src/Framework/MockObject/Exception/ClassIsReadonlyException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ClassIsReadonlyException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $className)
{
parent::__construct(
sprintf(
'Class "%s" is declared "readonly" and cannot be doubled',
$className
)
);
}
}
PK ["o o Q src/Framework/MockObject/Exception/MethodParametersAlreadyConfiguredException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MethodParametersAlreadyConfiguredException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct()
{
parent::__construct('Method parameters already configured');
}
}
PK [9"t B src/Framework/MockObject/Exception/ClassAlreadyExistsException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ClassAlreadyExistsException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $className)
{
parent::__construct(
sprintf(
'Class "%s" already exists',
$className
)
);
}
}
PK [U : src/Framework/MockObject/Exception/ReflectionException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ReflectionException extends RuntimeException implements Exception
{
}
PK [}- U src/Framework/MockObject/Exception/ConfigurableMethodsAlreadyInitializedException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ConfigurableMethodsAlreadyInitializedException extends \PHPUnit\Framework\Exception implements Exception
{
}
PK [G7 < src/Framework/MockObject/Exception/UnknownTraitException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class UnknownTraitException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct(string $traitName)
{
parent::__construct(
sprintf(
'Trait "%s" does not exist',
$traitName
)
);
}
}
PK [; U src/Framework/MockObject/Exception/OriginalConstructorInvocationRequiredException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class OriginalConstructorInvocationRequiredException extends \PHPUnit\Framework\Exception implements Exception
{
public function __construct()
{
parent::__construct('Proxying to original methods requires invoking the original constructor');
}
}
PK ['# # & src/Framework/MockObject/MockClass.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function call_user_func;
use function class_exists;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MockClass implements MockType
{
/**
* @var string
*/
private $classCode;
/**
* @var class-string
*/
private $mockName;
/**
* @var ConfigurableMethod[]
*/
private $configurableMethods;
/**
* @psalm-param class-string $mockName
*/
public function __construct(string $classCode, string $mockName, array $configurableMethods)
{
$this->classCode = $classCode;
$this->mockName = $mockName;
$this->configurableMethods = $configurableMethods;
}
/**
* @psalm-return class-string
*/
public function generate(): string
{
if (!class_exists($this->mockName, false)) {
eval($this->classCode);
call_user_func(
[
$this->mockName,
'__phpunit_initConfigurableMethods',
],
...$this->configurableMethods
);
}
return $this->mockName;
}
public function getClassCode(): string
{
return $this->classCode;
}
}
PK [F src/Framework/SelfDescribing.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface SelfDescribing
{
/**
* Returns a string representation of the object.
*/
public function toString(): string;
}
PK [Cŋ ' src/Framework/DataProviderTestSuite.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use function explode;
use PHPUnit\Util\Test as TestUtil;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class DataProviderTestSuite extends TestSuite
{
/**
* @var list
*/
private $dependencies = [];
/**
* @param list $dependencies
*/
public function setDependencies(array $dependencies): void
{
$this->dependencies = $dependencies;
foreach ($this->tests as $test) {
if (!$test instanceof TestCase) {
// @codeCoverageIgnoreStart
continue;
// @codeCoverageIgnoreStart
}
$test->setDependencies($dependencies);
}
}
/**
* @return list
*/
public function provides(): array
{
if ($this->providedTests === null) {
$this->providedTests = [new ExecutionOrderDependency($this->getName())];
}
return $this->providedTests;
}
/**
* @return list
*/
public function requires(): array
{
// A DataProviderTestSuite does not have to traverse its child tests
// as these are inherited and cannot reference dataProvider rows directly
return $this->dependencies;
}
/**
* Returns the size of the each test created using the data provider(s).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function getSize(): int
{
[$className, $methodName] = explode('::', $this->getName());
return TestUtil::getSize($className, $methodName);
}
}
PK [r
' src/Framework/SkippedTest.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface SkippedTest extends Throwable
{
}
PK [
src/Framework/TestBuilder.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use function assert;
use function count;
use function get_class;
use function sprintf;
use function trim;
use PHPUnit\Util\Filter;
use PHPUnit\Util\InvalidDataSetException;
use PHPUnit\Util\Test as TestUtil;
use ReflectionClass;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TestBuilder
{
public function build(ReflectionClass $theClass, string $methodName): Test
{
$className = $theClass->getName();
if (!$theClass->isInstantiable()) {
return new ErrorTestCase(
sprintf('Cannot instantiate class "%s".', $className)
);
}
$backupSettings = TestUtil::getBackupSettings(
$className,
$methodName
);
$preserveGlobalState = TestUtil::getPreserveGlobalStateSettings(
$className,
$methodName
);
$runTestInSeparateProcess = TestUtil::getProcessIsolationSettings(
$className,
$methodName
);
$runClassInSeparateProcess = TestUtil::getClassProcessIsolationSettings(
$className,
$methodName
);
$constructor = $theClass->getConstructor();
if ($constructor === null) {
throw new Exception('No valid test provided.');
}
$parameters = $constructor->getParameters();
// TestCase() or TestCase($name)
if (count($parameters) < 2) {
$test = $this->buildTestWithoutData($className);
} // TestCase($name, $data)
else {
try {
$data = TestUtil::getProvidedData(
$className,
$methodName
);
} catch (IncompleteTestError $e) {
$message = sprintf(
"Test for %s::%s marked incomplete by data provider\n%s",
$className,
$methodName,
$this->throwableToString($e)
);
$data = new IncompleteTestCase($className, $methodName, $message);
} catch (SkippedTestError $e) {
$message = sprintf(
"Test for %s::%s skipped by data provider\n%s",
$className,
$methodName,
$this->throwableToString($e)
);
$data = new SkippedTestCase($className, $methodName, $message);
} catch (Throwable $t) {
$message = sprintf(
"The data provider specified for %s::%s is invalid.\n%s",
$className,
$methodName,
$this->throwableToString($t)
);
$data = new ErrorTestCase($message);
}
// Test method with @dataProvider.
if (isset($data)) {
$test = $this->buildDataProviderTestSuite(
$methodName,
$className,
$data,
$runTestInSeparateProcess,
$preserveGlobalState,
$runClassInSeparateProcess,
$backupSettings
);
} else {
$test = $this->buildTestWithoutData($className);
}
}
if ($test instanceof TestCase) {
$test->setName($methodName);
$this->configureTestCase(
$test,
$runTestInSeparateProcess,
$preserveGlobalState,
$runClassInSeparateProcess,
$backupSettings
);
}
return $test;
}
/** @psalm-param class-string $className */
private function buildTestWithoutData(string $className)
{
return new $className;
}
/** @psalm-param class-string $className */
private function buildDataProviderTestSuite(
string $methodName,
string $className,
$data,
bool $runTestInSeparateProcess,
?bool $preserveGlobalState,
bool $runClassInSeparateProcess,
array $backupSettings
): DataProviderTestSuite {
$dataProviderTestSuite = new DataProviderTestSuite(
$className . '::' . $methodName
);
$groups = TestUtil::getGroups($className, $methodName);
if ($data instanceof ErrorTestCase ||
$data instanceof SkippedTestCase ||
$data instanceof IncompleteTestCase) {
$dataProviderTestSuite->addTest($data, $groups);
} else {
foreach ($data as $_dataName => $_data) {
$_test = new $className($methodName, $_data, $_dataName);
assert($_test instanceof TestCase);
$this->configureTestCase(
$_test,
$runTestInSeparateProcess,
$preserveGlobalState,
$runClassInSeparateProcess,
$backupSettings
);
$dataProviderTestSuite->addTest($_test, $groups);
}
}
return $dataProviderTestSuite;
}
private function configureTestCase(
TestCase $test,
bool $runTestInSeparateProcess,
?bool $preserveGlobalState,
bool $runClassInSeparateProcess,
array $backupSettings
): void {
if ($runTestInSeparateProcess) {
$test->setRunTestInSeparateProcess(true);
if ($preserveGlobalState !== null) {
$test->setPreserveGlobalState($preserveGlobalState);
}
}
if ($runClassInSeparateProcess) {
$test->setRunClassInSeparateProcess(true);
if ($preserveGlobalState !== null) {
$test->setPreserveGlobalState($preserveGlobalState);
}
}
if ($backupSettings['backupGlobals'] !== null) {
$test->setBackupGlobals($backupSettings['backupGlobals']);
}
if ($backupSettings['backupStaticAttributes'] !== null) {
$test->setBackupStaticAttributes(
$backupSettings['backupStaticAttributes']
);
}
}
private function throwableToString(Throwable $t): string
{
$message = $t->getMessage();
if (empty(trim($message))) {
$message = '';
}
if ($t instanceof InvalidDataSetException) {
return sprintf(
"%s\n%s",
$message,
Filter::getFilteredStacktrace($t)
);
}
return sprintf(
"%s: %s\n%s",
get_class($t),
$message,
Filter::getFilteredStacktrace($t)
);
}
}
PK [Z[ src/Framework/TestFailure.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use function get_class;
use function sprintf;
use function trim;
use PHPUnit\Framework\Error\Error;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TestFailure
{
/**
* @var null|Test
*/
private $failedTest;
/**
* @var Throwable
*/
private $thrownException;
/**
* @var string
*/
private $testName;
/**
* Returns a description for an exception.
*/
public static function exceptionToString(Throwable $e): string
{
if ($e instanceof SelfDescribing) {
$buffer = $e->toString();
if ($e instanceof ExpectationFailedException && $e->getComparisonFailure()) {
$buffer .= $e->getComparisonFailure()->getDiff();
}
if ($e instanceof PHPTAssertionFailedError) {
$buffer .= $e->getDiff();
}
if (!empty($buffer)) {
$buffer = trim($buffer) . "\n";
}
return $buffer;
}
if ($e instanceof Error) {
return $e->getMessage() . "\n";
}
if ($e instanceof ExceptionWrapper) {
return $e->getClassName() . ': ' . $e->getMessage() . "\n";
}
return get_class($e) . ': ' . $e->getMessage() . "\n";
}
/**
* Constructs a TestFailure with the given test and exception.
*/
public function __construct(Test $failedTest, Throwable $t)
{
if ($failedTest instanceof SelfDescribing) {
$this->testName = $failedTest->toString();
} else {
$this->testName = get_class($failedTest);
}
if (!$failedTest instanceof TestCase || !$failedTest->isInIsolation()) {
$this->failedTest = $failedTest;
}
$this->thrownException = $t;
}
/**
* Returns a short description of the failure.
*/
public function toString(): string
{
return sprintf(
'%s: %s',
$this->testName,
$this->thrownException->getMessage()
);
}
/**
* Returns a description for the thrown exception.
*/
public function getExceptionAsString(): string
{
return self::exceptionToString($this->thrownException);
}
/**
* Returns the name of the failing test (including data set, if any).
*/
public function getTestName(): string
{
return $this->testName;
}
/**
* Returns the failing test.
*
* Note: The test object is not set when the test is executed in process
* isolation.
*
* @see Exception
*/
public function failedTest(): ?Test
{
return $this->failedTest;
}
/**
* Gets the thrown exception.
*/
public function thrownException(): Throwable
{
return $this->thrownException;
}
/**
* Returns the exception's message.
*/
public function exceptionMessage(): string
{
return $this->thrownException()->getMessage();
}
/**
* Returns true if the thrown exception
* is of type AssertionFailedError.
*/
public function isFailure(): bool
{
return $this->thrownException() instanceof AssertionFailedError;
}
}
PK [$F src/Framework/IncompleteTest.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface IncompleteTest extends Throwable
{
}
PK [ A src/Framework/Exception/ComparisonMethodDoesNotExistException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const PHP_EOL;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ComparisonMethodDoesNotExistException extends Exception
{
public function __construct(string $className, string $methodName)
{
parent::__construct(
sprintf(
'Comparison method %s::%s() does not exist.',
$className,
$methodName
),
0,
null
);
}
public function __toString(): string
{
return $this->getMessage() . PHP_EOL;
}
}
PK [ P src/Framework/Exception/ComparisonMethodDoesNotDeclareParameterTypeException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const PHP_EOL;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ComparisonMethodDoesNotDeclareParameterTypeException extends Exception
{
public function __construct(string $className, string $methodName)
{
parent::__construct(
sprintf(
'Parameter of comparison method %s::%s() does not have a declared type.',
$className,
$methodName
),
0,
null
);
}
public function __toString(): string
{
return $this->getMessage() . PHP_EOL;
}
}
PK []N 5 src/Framework/Exception/NoChildTestSuiteException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class NoChildTestSuiteException extends Exception
{
}
PK [ӏ 1 src/Framework/Exception/SyntheticSkippedError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class SyntheticSkippedError extends SyntheticError implements SkippedTest
{
}
PK [^sa a ! src/Framework/Exception/Error.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Error extends Exception implements SelfDescribing
{
/**
* Wrapper for getMessage() which is declared as final.
*/
public function toString(): string
{
return $this->getMessage();
}
}
PK [i & & * src/Framework/Exception/SyntheticError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class SyntheticError extends AssertionFailedError
{
/**
* The synthetic file.
*
* @var string
*/
protected $syntheticFile = '';
/**
* The synthetic line number.
*
* @var int
*/
protected $syntheticLine = 0;
/**
* The synthetic trace.
*
* @var array
*/
protected $syntheticTrace = [];
public function __construct(string $message, int $code, string $file, int $line, array $trace)
{
parent::__construct($message, $code);
$this->syntheticFile = $file;
$this->syntheticLine = $line;
$this->syntheticTrace = $trace;
}
public function getSyntheticFile(): string
{
return $this->syntheticFile;
}
public function getSyntheticLine(): int
{
return $this->syntheticLine;
}
public function getSyntheticTrace(): array
{
return $this->syntheticTrace;
}
}
PK [>G 4 src/Framework/Exception/PHPTAssertionFailedError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class PHPTAssertionFailedError extends SyntheticError
{
/**
* @var string
*/
private $diff;
public function __construct(string $message, int $code, string $file, int $line, array $trace, string $diff)
{
parent::__construct($message, $code, $file, $line, $trace);
$this->diff = $diff;
}
public function getDiff(): string
{
return $this->diff;
}
}
PK [> O src/Framework/Exception/ComparisonMethodDoesNotAcceptParameterTypeException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const PHP_EOL;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ComparisonMethodDoesNotAcceptParameterTypeException extends Exception
{
public function __construct(string $className, string $methodName, string $type)
{
parent::__construct(
sprintf(
'%s is not an accepted argument type for comparison method %s::%s().',
$type,
$className,
$methodName
),
0,
null
);
}
public function __toString(): string
{
return $this->getMessage() . PHP_EOL;
}
}
PK [<߆] 1 src/Framework/Exception/CodeCoverageException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class CodeCoverageException extends Exception
{
}
PK [j = src/Framework/Exception/ActualValueIsNotAnObjectException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const PHP_EOL;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ActualValueIsNotAnObjectException extends Exception
{
public function __construct()
{
parent::__construct(
'Actual value is not an object',
0,
null
);
}
public function __toString(): string
{
return $this->getMessage() . PHP_EOL;
}
}
PK [f 1 src/Framework/Exception/SkippedTestSuiteError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class SkippedTestSuiteError extends AssertionFailedError implements SkippedTest
{
}
PK [=@ , src/Framework/Exception/SkippedTestError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class SkippedTestError extends AssertionFailedError implements SkippedTest
{
}
PK [U 8 src/Framework/Exception/InvalidCoversTargetException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvalidCoversTargetException extends CodeCoverageException
{
}
PK [:t ' src/Framework/Exception/OutputError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class OutputError extends AssertionFailedError
{
}
PK [it ; src/Framework/Exception/UnintentionallyCoveredCodeError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class UnintentionallyCoveredCodeError extends RiskyTestError
{
}
PK [9d * src/Framework/Exception/RiskyTestError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class RiskyTestError extends AssertionFailedError
{
}
PK [ % src/Framework/Exception/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use function array_keys;
use function get_object_vars;
use PHPUnit\Util\Filter;
use RuntimeException;
use Throwable;
/**
* Base class for all PHPUnit Framework exceptions.
*
* Ensures that exceptions thrown during a test run do not leave stray
* references behind.
*
* Every Exception contains a stack trace. Each stack frame contains the 'args'
* of the called function. The function arguments can contain references to
* instantiated objects. The references prevent the objects from being
* destructed (until test results are eventually printed), so memory cannot be
* freed up.
*
* With enabled process isolation, test results are serialized in the child
* process and unserialized in the parent process. The stack trace of Exceptions
* may contain objects that cannot be serialized or unserialized (e.g., PDO
* connections). Unserializing user-space objects from the child process into
* the parent would break the intended encapsulation of process isolation.
*
* @see http://fabien.potencier.org/article/9/php-serialization-stack-traces-and-exceptions
*
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class Exception extends RuntimeException implements \PHPUnit\Exception
{
/**
* @var array
*/
protected $serializableTrace;
public function __construct($message = '', $code = 0, Throwable $previous = null)
{
parent::__construct($message, $code, $previous);
$this->serializableTrace = $this->getTrace();
foreach (array_keys($this->serializableTrace) as $key) {
unset($this->serializableTrace[$key]['args']);
}
}
public function __toString(): string
{
$string = TestFailure::exceptionToString($this);
if ($trace = Filter::getFilteredStacktrace($this)) {
$string .= "\n" . $trace;
}
return $string;
}
public function __sleep(): array
{
return array_keys(get_object_vars($this));
}
/**
* Returns the serializable trace (without 'args').
*/
public function getSerializableTrace(): array
{
return $this->serializableTrace;
}
}
PK [p ; src/Framework/Exception/CoveredCodeNotExecutedException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class CoveredCodeNotExecutedException extends RiskyTestError
{
}
PK [ 8N Q src/Framework/Exception/ComparisonMethodDoesNotDeclareBoolReturnTypeException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const PHP_EOL;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ComparisonMethodDoesNotDeclareBoolReturnTypeException extends Exception
{
public function __construct(string $className, string $methodName)
{
parent::__construct(
sprintf(
'Comparison method %s::%s() does not declare bool return type.',
$className,
$methodName
),
0,
null
);
}
public function __toString(): string
{
return $this->getMessage() . PHP_EOL;
}
}
PK [
% 4 src/Framework/Exception/InvalidArgumentException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use function debug_backtrace;
use function in_array;
use function lcfirst;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvalidArgumentException extends Exception
{
public static function create(int $argument, string $type): self
{
$stack = debug_backtrace();
$function = $stack[1]['function'];
if (isset($stack[1]['class'])) {
$function = sprintf('%s::%s', $stack[1]['class'], $stack[1]['function']);
}
return new self(
sprintf(
'Argument #%d of %s() must be %s %s',
$argument,
$function,
in_array(lcfirst($type)[0], ['a', 'e', 'i', 'o', 'u'], true) ? 'an' : 'a',
$type
)
);
}
private function __construct(string $message = '', int $code = 0, \Exception $previous = null)
{
parent::__construct($message, $code, $previous);
}
}
PK [ Jc c # src/Framework/Exception/Warning.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Warning extends Exception implements SelfDescribing
{
/**
* Wrapper for getMessage() which is declared as final.
*/
public function toString(): string
{
return $this->getMessage();
}
}
PK [ ݘ V src/Framework/Exception/ComparisonMethodDoesNotDeclareExactlyOneParameterException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const PHP_EOL;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ComparisonMethodDoesNotDeclareExactlyOneParameterException extends Exception
{
public function __construct(string $className, string $methodName)
{
parent::__construct(
sprintf(
'Comparison method %s::%s() does not declare exactly one parameter.',
$className,
$methodName
),
0,
null
);
}
public function __toString(): string
{
return $this->getMessage() . PHP_EOL;
}
}
PK [R 8 src/Framework/Exception/InvalidDataProviderException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class InvalidDataProviderException extends Exception
{
}
PK [1 < src/Framework/Exception/MissingCoversAnnotationException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MissingCoversAnnotationException extends RiskyTestError
{
}
PK [)R / src/Framework/Exception/IncompleteTestError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class IncompleteTestError extends AssertionFailedError implements IncompleteTest
{
}
PK [ZYj j 0 src/Framework/Exception/AssertionFailedError.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class AssertionFailedError extends Exception implements SelfDescribing
{
/**
* Wrapper for getMessage() which is declared as final.
*/
public function toString(): string
{
return $this->getMessage();
}
}
PK [Kyó 6 src/Framework/Exception/ExpectationFailedException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use Exception;
use SebastianBergmann\Comparator\ComparisonFailure;
/**
* Exception for expectations which failed their check.
*
* The exception contains the error message and optionally a
* SebastianBergmann\Comparator\ComparisonFailure which is used to
* generate diff output of the failed expectations.
*
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ExpectationFailedException extends AssertionFailedError
{
/**
* @var ComparisonFailure
*/
protected $comparisonFailure;
public function __construct(string $message, ComparisonFailure $comparisonFailure = null, Exception $previous = null)
{
$this->comparisonFailure = $comparisonFailure;
parent::__construct($message, 0, $previous);
}
public function getComparisonFailure(): ?ComparisonFailure
{
return $this->comparisonFailure;
}
}
PK [x/ src/Framework/ErrorTestCase.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ErrorTestCase extends TestCase
{
/**
* @var bool
*/
protected $backupGlobals = false;
/**
* @var bool
*/
protected $backupStaticAttributes = false;
/**
* @var bool
*/
protected $runTestInSeparateProcess = false;
/**
* @var string
*/
private $message;
public function __construct(string $message = '')
{
$this->message = $message;
parent::__construct('Error');
}
public function getMessage(): string
{
return $this->message;
}
/**
* Returns a string representation of the test case.
*/
public function toString(): string
{
return 'Error';
}
/**
* @throws Exception
*
* @psalm-return never-return
*/
protected function runTest(): void
{
throw new Error($this->message);
}
}
PK [)0 src/Framework/TestListener.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use Throwable;
/**
* This interface, as well as the associated mechanism for extending PHPUnit,
* will be removed in PHPUnit 10. There is no alternative available in this
* version of PHPUnit.
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @deprecated
* @see https://github.com/sebastianbergmann/phpunit/issues/4676
*/
interface TestListener
{
public function addError(Test $test, Throwable $t, float $time): void;
public function addWarning(Test $test, Warning $e, float $time): void;
public function addFailure(Test $test, AssertionFailedError $e, float $time): void;
public function addIncompleteTest(Test $test, Throwable $t, float $time): void;
public function addRiskyTest(Test $test, Throwable $t, float $time): void;
public function addSkippedTest(Test $test, Throwable $t, float $time): void;
public function startTestSuite(TestSuite $suite): void;
public function endTestSuite(TestSuite $suite): void;
public function startTest(Test $test): void;
public function endTest(Test $test, float $time): void;
}
PK [d
o
o src/Framework/Assert.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const DEBUG_BACKTRACE_IGNORE_ARGS;
use const PHP_EOL;
use function array_shift;
use function array_unshift;
use function assert;
use function class_exists;
use function count;
use function debug_backtrace;
use function explode;
use function file_get_contents;
use function func_get_args;
use function implode;
use function interface_exists;
use function is_array;
use function is_bool;
use function is_int;
use function is_iterable;
use function is_object;
use function is_string;
use function preg_match;
use function preg_split;
use function sprintf;
use function strpos;
use ArrayAccess;
use Countable;
use DOMAttr;
use DOMDocument;
use DOMElement;
use Generator;
use PHPUnit\Framework\Constraint\ArrayHasKey;
use PHPUnit\Framework\Constraint\Callback;
use PHPUnit\Framework\Constraint\ClassHasAttribute;
use PHPUnit\Framework\Constraint\ClassHasStaticAttribute;
use PHPUnit\Framework\Constraint\Constraint;
use PHPUnit\Framework\Constraint\Count;
use PHPUnit\Framework\Constraint\DirectoryExists;
use PHPUnit\Framework\Constraint\FileExists;
use PHPUnit\Framework\Constraint\GreaterThan;
use PHPUnit\Framework\Constraint\IsAnything;
use PHPUnit\Framework\Constraint\IsEmpty;
use PHPUnit\Framework\Constraint\IsEqual;
use PHPUnit\Framework\Constraint\IsEqualCanonicalizing;
use PHPUnit\Framework\Constraint\IsEqualIgnoringCase;
use PHPUnit\Framework\Constraint\IsEqualWithDelta;
use PHPUnit\Framework\Constraint\IsFalse;
use PHPUnit\Framework\Constraint\IsFinite;
use PHPUnit\Framework\Constraint\IsIdentical;
use PHPUnit\Framework\Constraint\IsInfinite;
use PHPUnit\Framework\Constraint\IsInstanceOf;
use PHPUnit\Framework\Constraint\IsJson;
use PHPUnit\Framework\Constraint\IsNan;
use PHPUnit\Framework\Constraint\IsNull;
use PHPUnit\Framework\Constraint\IsReadable;
use PHPUnit\Framework\Constraint\IsTrue;
use PHPUnit\Framework\Constraint\IsType;
use PHPUnit\Framework\Constraint\IsWritable;
use PHPUnit\Framework\Constraint\JsonMatches;
use PHPUnit\Framework\Constraint\LessThan;
use PHPUnit\Framework\Constraint\LogicalAnd;
use PHPUnit\Framework\Constraint\LogicalNot;
use PHPUnit\Framework\Constraint\LogicalOr;
use PHPUnit\Framework\Constraint\LogicalXor;
use PHPUnit\Framework\Constraint\ObjectEquals;
use PHPUnit\Framework\Constraint\ObjectHasAttribute;
use PHPUnit\Framework\Constraint\RegularExpression;
use PHPUnit\Framework\Constraint\SameSize;
use PHPUnit\Framework\Constraint\StringContains;
use PHPUnit\Framework\Constraint\StringEndsWith;
use PHPUnit\Framework\Constraint\StringMatchesFormatDescription;
use PHPUnit\Framework\Constraint\StringStartsWith;
use PHPUnit\Framework\Constraint\TraversableContainsEqual;
use PHPUnit\Framework\Constraint\TraversableContainsIdentical;
use PHPUnit\Framework\Constraint\TraversableContainsOnly;
use PHPUnit\Util\Type;
use PHPUnit\Util\Xml;
use PHPUnit\Util\Xml\Loader as XmlLoader;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
abstract class Assert
{
/**
* @var int
*/
private static $count = 0;
/**
* Asserts that an array has a specified key.
*
* @param int|string $key
* @param array|ArrayAccess $array
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
public static function assertArrayHasKey($key, $array, string $message = ''): void
{
if (!(is_int($key) || is_string($key))) {
throw InvalidArgumentException::create(
1,
'integer or string'
);
}
if (!(is_array($array) || $array instanceof ArrayAccess)) {
throw InvalidArgumentException::create(
2,
'array or ArrayAccess'
);
}
$constraint = new ArrayHasKey($key);
static::assertThat($array, $constraint, $message);
}
/**
* Asserts that an array does not have a specified key.
*
* @param int|string $key
* @param array|ArrayAccess $array
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
public static function assertArrayNotHasKey($key, $array, string $message = ''): void
{
if (!(is_int($key) || is_string($key))) {
throw InvalidArgumentException::create(
1,
'integer or string'
);
}
if (!(is_array($array) || $array instanceof ArrayAccess)) {
throw InvalidArgumentException::create(
2,
'array or ArrayAccess'
);
}
$constraint = new LogicalNot(
new ArrayHasKey($key)
);
static::assertThat($array, $constraint, $message);
}
/**
* Asserts that a haystack contains a needle.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
public static function assertContains($needle, iterable $haystack, string $message = ''): void
{
$constraint = new TraversableContainsIdentical($needle);
static::assertThat($haystack, $constraint, $message);
}
public static function assertContainsEquals($needle, iterable $haystack, string $message = ''): void
{
$constraint = new TraversableContainsEqual($needle);
static::assertThat($haystack, $constraint, $message);
}
/**
* Asserts that a haystack does not contain a needle.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
public static function assertNotContains($needle, iterable $haystack, string $message = ''): void
{
$constraint = new LogicalNot(
new TraversableContainsIdentical($needle)
);
static::assertThat($haystack, $constraint, $message);
}
public static function assertNotContainsEquals($needle, iterable $haystack, string $message = ''): void
{
$constraint = new LogicalNot(new TraversableContainsEqual($needle));
static::assertThat($haystack, $constraint, $message);
}
/**
* Asserts that a haystack contains only values of a given type.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void
{
if ($isNativeType === null) {
$isNativeType = Type::isType($type);
}
static::assertThat(
$haystack,
new TraversableContainsOnly(
$type,
$isNativeType
),
$message
);
}
/**
* Asserts that a haystack contains only instances of a given class name.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertContainsOnlyInstancesOf(string $className, iterable $haystack, string $message = ''): void
{
static::assertThat(
$haystack,
new TraversableContainsOnly(
$className,
false
),
$message
);
}
/**
* Asserts that a haystack does not contain only values of a given type.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertNotContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void
{
if ($isNativeType === null) {
$isNativeType = Type::isType($type);
}
static::assertThat(
$haystack,
new LogicalNot(
new TraversableContainsOnly(
$type,
$isNativeType
)
),
$message
);
}
/**
* Asserts the number of elements of an array, Countable or Traversable.
*
* @param Countable|iterable $haystack
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
public static function assertCount(int $expectedCount, $haystack, string $message = ''): void
{
if ($haystack instanceof Generator) {
self::createWarning('Passing an argument of type Generator for the $haystack parameter is deprecated. Support for this will be removed in PHPUnit 10.');
}
if (!$haystack instanceof Countable && !is_iterable($haystack)) {
throw InvalidArgumentException::create(2, 'countable or iterable');
}
static::assertThat(
$haystack,
new Count($expectedCount),
$message
);
}
/**
* Asserts the number of elements of an array, Countable or Traversable.
*
* @param Countable|iterable $haystack
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
public static function assertNotCount(int $expectedCount, $haystack, string $message = ''): void
{
if ($haystack instanceof Generator) {
self::createWarning('Passing an argument of type Generator for the $haystack parameter is deprecated. Support for this will be removed in PHPUnit 10.');
}
if (!$haystack instanceof Countable && !is_iterable($haystack)) {
throw InvalidArgumentException::create(2, 'countable or iterable');
}
$constraint = new LogicalNot(
new Count($expectedCount)
);
static::assertThat($haystack, $constraint, $message);
}
/**
* Asserts that two variables are equal.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertEquals($expected, $actual, string $message = ''): void
{
$constraint = new IsEqual($expected);
static::assertThat($actual, $constraint, $message);
}
/**
* Asserts that two variables are equal (canonicalizing).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertEqualsCanonicalizing($expected, $actual, string $message = ''): void
{
$constraint = new IsEqualCanonicalizing($expected);
static::assertThat($actual, $constraint, $message);
}
/**
* Asserts that two variables are equal (ignoring case).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertEqualsIgnoringCase($expected, $actual, string $message = ''): void
{
$constraint = new IsEqualIgnoringCase($expected);
static::assertThat($actual, $constraint, $message);
}
/**
* Asserts that two variables are equal (with delta).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertEqualsWithDelta($expected, $actual, float $delta, string $message = ''): void
{
$constraint = new IsEqualWithDelta(
$expected,
$delta
);
static::assertThat($actual, $constraint, $message);
}
/**
* Asserts that two variables are not equal.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertNotEquals($expected, $actual, string $message = ''): void
{
$constraint = new LogicalNot(
new IsEqual($expected)
);
static::assertThat($actual, $constraint, $message);
}
/**
* Asserts that two variables are not equal (canonicalizing).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertNotEqualsCanonicalizing($expected, $actual, string $message = ''): void
{
$constraint = new LogicalNot(
new IsEqualCanonicalizing($expected)
);
static::assertThat($actual, $constraint, $message);
}
/**
* Asserts that two variables are not equal (ignoring case).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertNotEqualsIgnoringCase($expected, $actual, string $message = ''): void
{
$constraint = new LogicalNot(
new IsEqualIgnoringCase($expected)
);
static::assertThat($actual, $constraint, $message);
}
/**
* Asserts that two variables are not equal (with delta).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertNotEqualsWithDelta($expected, $actual, float $delta, string $message = ''): void
{
$constraint = new LogicalNot(
new IsEqualWithDelta(
$expected,
$delta
)
);
static::assertThat($actual, $constraint, $message);
}
/**
* @throws ExpectationFailedException
*/
public static function assertObjectEquals(object $expected, object $actual, string $method = 'equals', string $message = ''): void
{
static::assertThat(
$actual,
static::objectEquals($expected, $method),
$message
);
}
/**
* Asserts that a variable is empty.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert empty $actual
*/
public static function assertEmpty($actual, string $message = ''): void
{
if ($actual instanceof Generator) {
self::createWarning('Passing an argument of type Generator for the $actual parameter is deprecated. Support for this will be removed in PHPUnit 10.');
}
static::assertThat($actual, static::isEmpty(), $message);
}
/**
* Asserts that a variable is not empty.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !empty $actual
*/
public static function assertNotEmpty($actual, string $message = ''): void
{
if ($actual instanceof Generator) {
self::createWarning('Passing an argument of type Generator for the $actual parameter is deprecated. Support for this will be removed in PHPUnit 10.');
}
static::assertThat($actual, static::logicalNot(static::isEmpty()), $message);
}
/**
* Asserts that a value is greater than another value.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertGreaterThan($expected, $actual, string $message = ''): void
{
static::assertThat($actual, static::greaterThan($expected), $message);
}
/**
* Asserts that a value is greater than or equal to another value.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertGreaterThanOrEqual($expected, $actual, string $message = ''): void
{
static::assertThat(
$actual,
static::greaterThanOrEqual($expected),
$message
);
}
/**
* Asserts that a value is smaller than another value.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertLessThan($expected, $actual, string $message = ''): void
{
static::assertThat($actual, static::lessThan($expected), $message);
}
/**
* Asserts that a value is smaller than or equal to another value.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertLessThanOrEqual($expected, $actual, string $message = ''): void
{
static::assertThat($actual, static::lessThanOrEqual($expected), $message);
}
/**
* Asserts that the contents of one file is equal to the contents of another
* file.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileEquals(string $expected, string $actual, string $message = ''): void
{
static::assertFileExists($expected, $message);
static::assertFileExists($actual, $message);
$constraint = new IsEqual(file_get_contents($expected));
static::assertThat(file_get_contents($actual), $constraint, $message);
}
/**
* Asserts that the contents of one file is equal to the contents of another
* file (canonicalizing).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileEqualsCanonicalizing(string $expected, string $actual, string $message = ''): void
{
static::assertFileExists($expected, $message);
static::assertFileExists($actual, $message);
$constraint = new IsEqualCanonicalizing(
file_get_contents($expected)
);
static::assertThat(file_get_contents($actual), $constraint, $message);
}
/**
* Asserts that the contents of one file is equal to the contents of another
* file (ignoring case).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileEqualsIgnoringCase(string $expected, string $actual, string $message = ''): void
{
static::assertFileExists($expected, $message);
static::assertFileExists($actual, $message);
$constraint = new IsEqualIgnoringCase(file_get_contents($expected));
static::assertThat(file_get_contents($actual), $constraint, $message);
}
/**
* Asserts that the contents of one file is not equal to the contents of
* another file.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileNotEquals(string $expected, string $actual, string $message = ''): void
{
static::assertFileExists($expected, $message);
static::assertFileExists($actual, $message);
$constraint = new LogicalNot(
new IsEqual(file_get_contents($expected))
);
static::assertThat(file_get_contents($actual), $constraint, $message);
}
/**
* Asserts that the contents of one file is not equal to the contents of another
* file (canonicalizing).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileNotEqualsCanonicalizing(string $expected, string $actual, string $message = ''): void
{
static::assertFileExists($expected, $message);
static::assertFileExists($actual, $message);
$constraint = new LogicalNot(
new IsEqualCanonicalizing(file_get_contents($expected))
);
static::assertThat(file_get_contents($actual), $constraint, $message);
}
/**
* Asserts that the contents of one file is not equal to the contents of another
* file (ignoring case).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileNotEqualsIgnoringCase(string $expected, string $actual, string $message = ''): void
{
static::assertFileExists($expected, $message);
static::assertFileExists($actual, $message);
$constraint = new LogicalNot(
new IsEqualIgnoringCase(file_get_contents($expected))
);
static::assertThat(file_get_contents($actual), $constraint, $message);
}
/**
* Asserts that the contents of a string is equal
* to the contents of a file.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringEqualsFile(string $expectedFile, string $actualString, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
$constraint = new IsEqual(file_get_contents($expectedFile));
static::assertThat($actualString, $constraint, $message);
}
/**
* Asserts that the contents of a string is equal
* to the contents of a file (canonicalizing).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
$constraint = new IsEqualCanonicalizing(file_get_contents($expectedFile));
static::assertThat($actualString, $constraint, $message);
}
/**
* Asserts that the contents of a string is equal
* to the contents of a file (ignoring case).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
$constraint = new IsEqualIgnoringCase(file_get_contents($expectedFile));
static::assertThat($actualString, $constraint, $message);
}
/**
* Asserts that the contents of a string is not equal
* to the contents of a file.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringNotEqualsFile(string $expectedFile, string $actualString, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
$constraint = new LogicalNot(
new IsEqual(file_get_contents($expectedFile))
);
static::assertThat($actualString, $constraint, $message);
}
/**
* Asserts that the contents of a string is not equal
* to the contents of a file (canonicalizing).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
$constraint = new LogicalNot(
new IsEqualCanonicalizing(file_get_contents($expectedFile))
);
static::assertThat($actualString, $constraint, $message);
}
/**
* Asserts that the contents of a string is not equal
* to the contents of a file (ignoring case).
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
$constraint = new LogicalNot(
new IsEqualIgnoringCase(file_get_contents($expectedFile))
);
static::assertThat($actualString, $constraint, $message);
}
/**
* Asserts that a file/dir is readable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertIsReadable(string $filename, string $message = ''): void
{
static::assertThat($filename, new IsReadable, $message);
}
/**
* Asserts that a file/dir exists and is not readable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertIsNotReadable(string $filename, string $message = ''): void
{
static::assertThat($filename, new LogicalNot(new IsReadable), $message);
}
/**
* Asserts that a file/dir exists and is not readable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4062
*/
public static function assertNotIsReadable(string $filename, string $message = ''): void
{
self::createWarning('assertNotIsReadable() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertIsNotReadable() instead.');
static::assertThat($filename, new LogicalNot(new IsReadable), $message);
}
/**
* Asserts that a file/dir exists and is writable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertIsWritable(string $filename, string $message = ''): void
{
static::assertThat($filename, new IsWritable, $message);
}
/**
* Asserts that a file/dir exists and is not writable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertIsNotWritable(string $filename, string $message = ''): void
{
static::assertThat($filename, new LogicalNot(new IsWritable), $message);
}
/**
* Asserts that a file/dir exists and is not writable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4065
*/
public static function assertNotIsWritable(string $filename, string $message = ''): void
{
self::createWarning('assertNotIsWritable() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertIsNotWritable() instead.');
static::assertThat($filename, new LogicalNot(new IsWritable), $message);
}
/**
* Asserts that a directory exists.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertDirectoryExists(string $directory, string $message = ''): void
{
static::assertThat($directory, new DirectoryExists, $message);
}
/**
* Asserts that a directory does not exist.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertDirectoryDoesNotExist(string $directory, string $message = ''): void
{
static::assertThat($directory, new LogicalNot(new DirectoryExists), $message);
}
/**
* Asserts that a directory does not exist.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4068
*/
public static function assertDirectoryNotExists(string $directory, string $message = ''): void
{
self::createWarning('assertDirectoryNotExists() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertDirectoryDoesNotExist() instead.');
static::assertThat($directory, new LogicalNot(new DirectoryExists), $message);
}
/**
* Asserts that a directory exists and is readable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertDirectoryIsReadable(string $directory, string $message = ''): void
{
self::assertDirectoryExists($directory, $message);
self::assertIsReadable($directory, $message);
}
/**
* Asserts that a directory exists and is not readable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertDirectoryIsNotReadable(string $directory, string $message = ''): void
{
self::assertDirectoryExists($directory, $message);
self::assertIsNotReadable($directory, $message);
}
/**
* Asserts that a directory exists and is not readable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4071
*/
public static function assertDirectoryNotIsReadable(string $directory, string $message = ''): void
{
self::createWarning('assertDirectoryNotIsReadable() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertDirectoryIsNotReadable() instead.');
self::assertDirectoryExists($directory, $message);
self::assertIsNotReadable($directory, $message);
}
/**
* Asserts that a directory exists and is writable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertDirectoryIsWritable(string $directory, string $message = ''): void
{
self::assertDirectoryExists($directory, $message);
self::assertIsWritable($directory, $message);
}
/**
* Asserts that a directory exists and is not writable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertDirectoryIsNotWritable(string $directory, string $message = ''): void
{
self::assertDirectoryExists($directory, $message);
self::assertIsNotWritable($directory, $message);
}
/**
* Asserts that a directory exists and is not writable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4074
*/
public static function assertDirectoryNotIsWritable(string $directory, string $message = ''): void
{
self::createWarning('assertDirectoryNotIsWritable() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertDirectoryIsNotWritable() instead.');
self::assertDirectoryExists($directory, $message);
self::assertIsNotWritable($directory, $message);
}
/**
* Asserts that a file exists.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileExists(string $filename, string $message = ''): void
{
static::assertThat($filename, new FileExists, $message);
}
/**
* Asserts that a file does not exist.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileDoesNotExist(string $filename, string $message = ''): void
{
static::assertThat($filename, new LogicalNot(new FileExists), $message);
}
/**
* Asserts that a file does not exist.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4077
*/
public static function assertFileNotExists(string $filename, string $message = ''): void
{
self::createWarning('assertFileNotExists() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertFileDoesNotExist() instead.');
static::assertThat($filename, new LogicalNot(new FileExists), $message);
}
/**
* Asserts that a file exists and is readable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileIsReadable(string $file, string $message = ''): void
{
self::assertFileExists($file, $message);
self::assertIsReadable($file, $message);
}
/**
* Asserts that a file exists and is not readable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileIsNotReadable(string $file, string $message = ''): void
{
self::assertFileExists($file, $message);
self::assertIsNotReadable($file, $message);
}
/**
* Asserts that a file exists and is not readable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4080
*/
public static function assertFileNotIsReadable(string $file, string $message = ''): void
{
self::createWarning('assertFileNotIsReadable() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertFileIsNotReadable() instead.');
self::assertFileExists($file, $message);
self::assertIsNotReadable($file, $message);
}
/**
* Asserts that a file exists and is writable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileIsWritable(string $file, string $message = ''): void
{
self::assertFileExists($file, $message);
self::assertIsWritable($file, $message);
}
/**
* Asserts that a file exists and is not writable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFileIsNotWritable(string $file, string $message = ''): void
{
self::assertFileExists($file, $message);
self::assertIsNotWritable($file, $message);
}
/**
* Asserts that a file exists and is not writable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4083
*/
public static function assertFileNotIsWritable(string $file, string $message = ''): void
{
self::createWarning('assertFileNotIsWritable() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertFileIsNotWritable() instead.');
self::assertFileExists($file, $message);
self::assertIsNotWritable($file, $message);
}
/**
* Asserts that a condition is true.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert true $condition
*/
public static function assertTrue($condition, string $message = ''): void
{
static::assertThat($condition, static::isTrue(), $message);
}
/**
* Asserts that a condition is not true.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !true $condition
*/
public static function assertNotTrue($condition, string $message = ''): void
{
static::assertThat($condition, static::logicalNot(static::isTrue()), $message);
}
/**
* Asserts that a condition is false.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert false $condition
*/
public static function assertFalse($condition, string $message = ''): void
{
static::assertThat($condition, static::isFalse(), $message);
}
/**
* Asserts that a condition is not false.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !false $condition
*/
public static function assertNotFalse($condition, string $message = ''): void
{
static::assertThat($condition, static::logicalNot(static::isFalse()), $message);
}
/**
* Asserts that a variable is null.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert null $actual
*/
public static function assertNull($actual, string $message = ''): void
{
static::assertThat($actual, static::isNull(), $message);
}
/**
* Asserts that a variable is not null.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !null $actual
*/
public static function assertNotNull($actual, string $message = ''): void
{
static::assertThat($actual, static::logicalNot(static::isNull()), $message);
}
/**
* Asserts that a variable is finite.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertFinite($actual, string $message = ''): void
{
static::assertThat($actual, static::isFinite(), $message);
}
/**
* Asserts that a variable is infinite.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertInfinite($actual, string $message = ''): void
{
static::assertThat($actual, static::isInfinite(), $message);
}
/**
* Asserts that a variable is nan.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertNan($actual, string $message = ''): void
{
static::assertThat($actual, static::isNan(), $message);
}
/**
* Asserts that a class has a specified attribute.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
public static function assertClassHasAttribute(string $attributeName, string $className, string $message = ''): void
{
self::createWarning('assertClassHasAttribute() is deprecated and will be removed in PHPUnit 10.');
if (!self::isValidClassAttributeName($attributeName)) {
throw InvalidArgumentException::create(1, 'valid attribute name');
}
if (!class_exists($className)) {
throw InvalidArgumentException::create(2, 'class name');
}
static::assertThat($className, new ClassHasAttribute($attributeName), $message);
}
/**
* Asserts that a class does not have a specified attribute.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
public static function assertClassNotHasAttribute(string $attributeName, string $className, string $message = ''): void
{
self::createWarning('assertClassNotHasAttribute() is deprecated and will be removed in PHPUnit 10.');
if (!self::isValidClassAttributeName($attributeName)) {
throw InvalidArgumentException::create(1, 'valid attribute name');
}
if (!class_exists($className)) {
throw InvalidArgumentException::create(2, 'class name');
}
static::assertThat(
$className,
new LogicalNot(
new ClassHasAttribute($attributeName)
),
$message
);
}
/**
* Asserts that a class has a specified static attribute.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
public static function assertClassHasStaticAttribute(string $attributeName, string $className, string $message = ''): void
{
self::createWarning('assertClassHasStaticAttribute() is deprecated and will be removed in PHPUnit 10.');
if (!self::isValidClassAttributeName($attributeName)) {
throw InvalidArgumentException::create(1, 'valid attribute name');
}
if (!class_exists($className)) {
throw InvalidArgumentException::create(2, 'class name');
}
static::assertThat(
$className,
new ClassHasStaticAttribute($attributeName),
$message
);
}
/**
* Asserts that a class does not have a specified static attribute.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
public static function assertClassNotHasStaticAttribute(string $attributeName, string $className, string $message = ''): void
{
self::createWarning('assertClassNotHasStaticAttribute() is deprecated and will be removed in PHPUnit 10.');
if (!self::isValidClassAttributeName($attributeName)) {
throw InvalidArgumentException::create(1, 'valid attribute name');
}
if (!class_exists($className)) {
throw InvalidArgumentException::create(2, 'class name');
}
static::assertThat(
$className,
new LogicalNot(
new ClassHasStaticAttribute($attributeName)
),
$message
);
}
/**
* Asserts that an object has a specified attribute.
*
* @param object $object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
public static function assertObjectHasAttribute(string $attributeName, $object, string $message = ''): void
{
self::createWarning('assertObjectHasAttribute() is deprecated and will be removed in PHPUnit 10.');
if (!self::isValidObjectAttributeName($attributeName)) {
throw InvalidArgumentException::create(1, 'valid attribute name');
}
if (!is_object($object)) {
throw InvalidArgumentException::create(2, 'object');
}
static::assertThat(
$object,
new ObjectHasAttribute($attributeName),
$message
);
}
/**
* Asserts that an object does not have a specified attribute.
*
* @param object $object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
public static function assertObjectNotHasAttribute(string $attributeName, $object, string $message = ''): void
{
self::createWarning('assertObjectNotHasAttribute() is deprecated and will be removed in PHPUnit 10.');
if (!self::isValidObjectAttributeName($attributeName)) {
throw InvalidArgumentException::create(1, 'valid attribute name');
}
if (!is_object($object)) {
throw InvalidArgumentException::create(2, 'object');
}
static::assertThat(
$object,
new LogicalNot(
new ObjectHasAttribute($attributeName)
),
$message
);
}
/**
* Asserts that two variables have the same type and value.
* Used on objects, it asserts that two variables reference
* the same object.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-template ExpectedType
*
* @psalm-param ExpectedType $expected
*
* @psalm-assert =ExpectedType $actual
*/
public static function assertSame($expected, $actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsIdentical($expected),
$message
);
}
/**
* Asserts that two variables do not have the same type and value.
* Used on objects, it asserts that two variables do not reference
* the same object.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertNotSame($expected, $actual, string $message = ''): void
{
if (is_bool($expected) && is_bool($actual)) {
static::assertNotEquals($expected, $actual, $message);
}
static::assertThat(
$actual,
new LogicalNot(
new IsIdentical($expected)
),
$message
);
}
/**
* Asserts that a variable is of a given type.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*
* @psalm-template ExpectedType of object
*
* @psalm-param class-string $expected
*
* @psalm-assert =ExpectedType $actual
*/
public static function assertInstanceOf(string $expected, $actual, string $message = ''): void
{
if (!class_exists($expected) && !interface_exists($expected)) {
throw InvalidArgumentException::create(1, 'class or interface name');
}
static::assertThat(
$actual,
new IsInstanceOf($expected),
$message
);
}
/**
* Asserts that a variable is not of a given type.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*
* @psalm-template ExpectedType of object
*
* @psalm-param class-string $expected
*
* @psalm-assert !ExpectedType $actual
*/
public static function assertNotInstanceOf(string $expected, $actual, string $message = ''): void
{
if (!class_exists($expected) && !interface_exists($expected)) {
throw InvalidArgumentException::create(1, 'class or interface name');
}
static::assertThat(
$actual,
new LogicalNot(
new IsInstanceOf($expected)
),
$message
);
}
/**
* Asserts that a variable is of type array.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert array $actual
*/
public static function assertIsArray($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_ARRAY),
$message
);
}
/**
* Asserts that a variable is of type bool.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert bool $actual
*/
public static function assertIsBool($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_BOOL),
$message
);
}
/**
* Asserts that a variable is of type float.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert float $actual
*/
public static function assertIsFloat($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_FLOAT),
$message
);
}
/**
* Asserts that a variable is of type int.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert int $actual
*/
public static function assertIsInt($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_INT),
$message
);
}
/**
* Asserts that a variable is of type numeric.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert numeric $actual
*/
public static function assertIsNumeric($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_NUMERIC),
$message
);
}
/**
* Asserts that a variable is of type object.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert object $actual
*/
public static function assertIsObject($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_OBJECT),
$message
);
}
/**
* Asserts that a variable is of type resource.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert resource $actual
*/
public static function assertIsResource($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_RESOURCE),
$message
);
}
/**
* Asserts that a variable is of type resource and is closed.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert resource $actual
*/
public static function assertIsClosedResource($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_CLOSED_RESOURCE),
$message
);
}
/**
* Asserts that a variable is of type string.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert string $actual
*/
public static function assertIsString($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_STRING),
$message
);
}
/**
* Asserts that a variable is of type scalar.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert scalar $actual
*/
public static function assertIsScalar($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_SCALAR),
$message
);
}
/**
* Asserts that a variable is of type callable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert callable $actual
*/
public static function assertIsCallable($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_CALLABLE),
$message
);
}
/**
* Asserts that a variable is of type iterable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert iterable $actual
*/
public static function assertIsIterable($actual, string $message = ''): void
{
static::assertThat(
$actual,
new IsType(IsType::TYPE_ITERABLE),
$message
);
}
/**
* Asserts that a variable is not of type array.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !array $actual
*/
public static function assertIsNotArray($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_ARRAY)),
$message
);
}
/**
* Asserts that a variable is not of type bool.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !bool $actual
*/
public static function assertIsNotBool($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_BOOL)),
$message
);
}
/**
* Asserts that a variable is not of type float.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !float $actual
*/
public static function assertIsNotFloat($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_FLOAT)),
$message
);
}
/**
* Asserts that a variable is not of type int.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !int $actual
*/
public static function assertIsNotInt($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_INT)),
$message
);
}
/**
* Asserts that a variable is not of type numeric.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !numeric $actual
*/
public static function assertIsNotNumeric($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_NUMERIC)),
$message
);
}
/**
* Asserts that a variable is not of type object.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !object $actual
*/
public static function assertIsNotObject($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_OBJECT)),
$message
);
}
/**
* Asserts that a variable is not of type resource.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !resource $actual
*/
public static function assertIsNotResource($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_RESOURCE)),
$message
);
}
/**
* Asserts that a variable is not of type resource.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !resource $actual
*/
public static function assertIsNotClosedResource($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_CLOSED_RESOURCE)),
$message
);
}
/**
* Asserts that a variable is not of type string.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !string $actual
*/
public static function assertIsNotString($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_STRING)),
$message
);
}
/**
* Asserts that a variable is not of type scalar.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !scalar $actual
*/
public static function assertIsNotScalar($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_SCALAR)),
$message
);
}
/**
* Asserts that a variable is not of type callable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !callable $actual
*/
public static function assertIsNotCallable($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_CALLABLE)),
$message
);
}
/**
* Asserts that a variable is not of type iterable.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-assert !iterable $actual
*/
public static function assertIsNotIterable($actual, string $message = ''): void
{
static::assertThat(
$actual,
new LogicalNot(new IsType(IsType::TYPE_ITERABLE)),
$message
);
}
/**
* Asserts that a string matches a given regular expression.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertMatchesRegularExpression(string $pattern, string $string, string $message = ''): void
{
static::assertThat($string, new RegularExpression($pattern), $message);
}
/**
* Asserts that a string matches a given regular expression.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4086
*/
public static function assertRegExp(string $pattern, string $string, string $message = ''): void
{
self::createWarning('assertRegExp() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertMatchesRegularExpression() instead.');
static::assertThat($string, new RegularExpression($pattern), $message);
}
/**
* Asserts that a string does not match a given regular expression.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertDoesNotMatchRegularExpression(string $pattern, string $string, string $message = ''): void
{
static::assertThat(
$string,
new LogicalNot(
new RegularExpression($pattern)
),
$message
);
}
/**
* Asserts that a string does not match a given regular expression.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4089
*/
public static function assertNotRegExp(string $pattern, string $string, string $message = ''): void
{
self::createWarning('assertNotRegExp() is deprecated and will be removed in PHPUnit 10. Refactor your code to use assertDoesNotMatchRegularExpression() instead.');
static::assertThat(
$string,
new LogicalNot(
new RegularExpression($pattern)
),
$message
);
}
/**
* Assert that the size of two arrays (or `Countable` or `Traversable` objects)
* is the same.
*
* @param Countable|iterable $expected
* @param Countable|iterable $actual
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
public static function assertSameSize($expected, $actual, string $message = ''): void
{
if ($expected instanceof Generator) {
self::createWarning('Passing an argument of type Generator for the $expected parameter is deprecated. Support for this will be removed in PHPUnit 10.');
}
if ($actual instanceof Generator) {
self::createWarning('Passing an argument of type Generator for the $actual parameter is deprecated. Support for this will be removed in PHPUnit 10.');
}
if (!$expected instanceof Countable && !is_iterable($expected)) {
throw InvalidArgumentException::create(1, 'countable or iterable');
}
if (!$actual instanceof Countable && !is_iterable($actual)) {
throw InvalidArgumentException::create(2, 'countable or iterable');
}
static::assertThat(
$actual,
new SameSize($expected),
$message
);
}
/**
* Assert that the size of two arrays (or `Countable` or `Traversable` objects)
* is not the same.
*
* @param Countable|iterable $expected
* @param Countable|iterable $actual
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
public static function assertNotSameSize($expected, $actual, string $message = ''): void
{
if ($expected instanceof Generator) {
self::createWarning('Passing an argument of type Generator for the $expected parameter is deprecated. Support for this will be removed in PHPUnit 10.');
}
if ($actual instanceof Generator) {
self::createWarning('Passing an argument of type Generator for the $actual parameter is deprecated. Support for this will be removed in PHPUnit 10.');
}
if (!$expected instanceof Countable && !is_iterable($expected)) {
throw InvalidArgumentException::create(1, 'countable or iterable');
}
if (!$actual instanceof Countable && !is_iterable($actual)) {
throw InvalidArgumentException::create(2, 'countable or iterable');
}
static::assertThat(
$actual,
new LogicalNot(
new SameSize($expected)
),
$message
);
}
/**
* Asserts that a string matches a given format string.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringMatchesFormat(string $format, string $string, string $message = ''): void
{
static::assertThat($string, new StringMatchesFormatDescription($format), $message);
}
/**
* Asserts that a string does not match a given format string.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringNotMatchesFormat(string $format, string $string, string $message = ''): void
{
static::assertThat(
$string,
new LogicalNot(
new StringMatchesFormatDescription($format)
),
$message
);
}
/**
* Asserts that a string matches a given format file.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringMatchesFormatFile(string $formatFile, string $string, string $message = ''): void
{
static::assertFileExists($formatFile, $message);
static::assertThat(
$string,
new StringMatchesFormatDescription(
file_get_contents($formatFile)
),
$message
);
}
/**
* Asserts that a string does not match a given format string.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringNotMatchesFormatFile(string $formatFile, string $string, string $message = ''): void
{
static::assertFileExists($formatFile, $message);
static::assertThat(
$string,
new LogicalNot(
new StringMatchesFormatDescription(
file_get_contents($formatFile)
)
),
$message
);
}
/**
* Asserts that a string starts with a given prefix.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringStartsWith(string $prefix, string $string, string $message = ''): void
{
static::assertThat($string, new StringStartsWith($prefix), $message);
}
/**
* Asserts that a string starts not with a given prefix.
*
* @param string $prefix
* @param string $string
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringStartsNotWith($prefix, $string, string $message = ''): void
{
static::assertThat(
$string,
new LogicalNot(
new StringStartsWith($prefix)
),
$message
);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringContainsString(string $needle, string $haystack, string $message = ''): void
{
$constraint = new StringContains($needle, false);
static::assertThat($haystack, $constraint, $message);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringContainsStringIgnoringCase(string $needle, string $haystack, string $message = ''): void
{
$constraint = new StringContains($needle, true);
static::assertThat($haystack, $constraint, $message);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringNotContainsString(string $needle, string $haystack, string $message = ''): void
{
$constraint = new LogicalNot(new StringContains($needle));
static::assertThat($haystack, $constraint, $message);
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringNotContainsStringIgnoringCase(string $needle, string $haystack, string $message = ''): void
{
$constraint = new LogicalNot(new StringContains($needle, true));
static::assertThat($haystack, $constraint, $message);
}
/**
* Asserts that a string ends with a given suffix.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringEndsWith(string $suffix, string $string, string $message = ''): void
{
static::assertThat($string, new StringEndsWith($suffix), $message);
}
/**
* Asserts that a string ends not with a given suffix.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertStringEndsNotWith(string $suffix, string $string, string $message = ''): void
{
static::assertThat(
$string,
new LogicalNot(
new StringEndsWith($suffix)
),
$message
);
}
/**
* Asserts that two XML files are equal.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Exception
* @throws ExpectationFailedException
*/
public static function assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile, string $message = ''): void
{
$expected = (new XmlLoader)->loadFile($expectedFile);
$actual = (new XmlLoader)->loadFile($actualFile);
static::assertEquals($expected, $actual, $message);
}
/**
* Asserts that two XML files are not equal.
*
* @throws \PHPUnit\Util\Exception
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile, string $message = ''): void
{
$expected = (new XmlLoader)->loadFile($expectedFile);
$actual = (new XmlLoader)->loadFile($actualFile);
static::assertNotEquals($expected, $actual, $message);
}
/**
* Asserts that two XML documents are equal.
*
* @param DOMDocument|string $actualXml
*
* @throws \PHPUnit\Util\Xml\Exception
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertXmlStringEqualsXmlFile(string $expectedFile, $actualXml, string $message = ''): void
{
if (!is_string($actualXml)) {
self::createWarning('Passing an argument of type DOMDocument for the $actualXml parameter is deprecated. Support for this will be removed in PHPUnit 10.');
$actual = $actualXml;
} else {
$actual = (new XmlLoader)->load($actualXml);
}
$expected = (new XmlLoader)->loadFile($expectedFile);
static::assertEquals($expected, $actual, $message);
}
/**
* Asserts that two XML documents are not equal.
*
* @param DOMDocument|string $actualXml
*
* @throws \PHPUnit\Util\Xml\Exception
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertXmlStringNotEqualsXmlFile(string $expectedFile, $actualXml, string $message = ''): void
{
if (!is_string($actualXml)) {
self::createWarning('Passing an argument of type DOMDocument for the $actualXml parameter is deprecated. Support for this will be removed in PHPUnit 10.');
$actual = $actualXml;
} else {
$actual = (new XmlLoader)->load($actualXml);
}
$expected = (new XmlLoader)->loadFile($expectedFile);
static::assertNotEquals($expected, $actual, $message);
}
/**
* Asserts that two XML documents are equal.
*
* @param DOMDocument|string $expectedXml
* @param DOMDocument|string $actualXml
*
* @throws \PHPUnit\Util\Xml\Exception
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertXmlStringEqualsXmlString($expectedXml, $actualXml, string $message = ''): void
{
if (!is_string($expectedXml)) {
self::createWarning('Passing an argument of type DOMDocument for the $expectedXml parameter is deprecated. Support for this will be removed in PHPUnit 10.');
$expected = $expectedXml;
} else {
$expected = (new XmlLoader)->load($expectedXml);
}
if (!is_string($actualXml)) {
self::createWarning('Passing an argument of type DOMDocument for the $actualXml parameter is deprecated. Support for this will be removed in PHPUnit 10.');
$actual = $actualXml;
} else {
$actual = (new XmlLoader)->load($actualXml);
}
static::assertEquals($expected, $actual, $message);
}
/**
* Asserts that two XML documents are not equal.
*
* @param DOMDocument|string $expectedXml
* @param DOMDocument|string $actualXml
*
* @throws \PHPUnit\Util\Xml\Exception
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertXmlStringNotEqualsXmlString($expectedXml, $actualXml, string $message = ''): void
{
if (!is_string($expectedXml)) {
self::createWarning('Passing an argument of type DOMDocument for the $expectedXml parameter is deprecated. Support for this will be removed in PHPUnit 10.');
$expected = $expectedXml;
} else {
$expected = (new XmlLoader)->load($expectedXml);
}
if (!is_string($actualXml)) {
self::createWarning('Passing an argument of type DOMDocument for the $actualXml parameter is deprecated. Support for this will be removed in PHPUnit 10.');
$actual = $actualXml;
} else {
$actual = (new XmlLoader)->load($actualXml);
}
static::assertNotEquals($expected, $actual, $message);
}
/**
* Asserts that a hierarchy of DOMElements matches.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws AssertionFailedError
* @throws ExpectationFailedException
*
* @codeCoverageIgnore
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4091
*/
public static function assertEqualXMLStructure(DOMElement $expectedElement, DOMElement $actualElement, bool $checkAttributes = false, string $message = ''): void
{
self::createWarning('assertEqualXMLStructure() is deprecated and will be removed in PHPUnit 10.');
$expectedElement = Xml::import($expectedElement);
$actualElement = Xml::import($actualElement);
static::assertSame(
$expectedElement->tagName,
$actualElement->tagName,
$message
);
if ($checkAttributes) {
static::assertSame(
$expectedElement->attributes->length,
$actualElement->attributes->length,
sprintf(
'%s%sNumber of attributes on node "%s" does not match',
$message,
!empty($message) ? "\n" : '',
$expectedElement->tagName
)
);
for ($i = 0; $i < $expectedElement->attributes->length; $i++) {
$expectedAttribute = $expectedElement->attributes->item($i);
$actualAttribute = $actualElement->attributes->getNamedItem($expectedAttribute->name);
assert($expectedAttribute instanceof DOMAttr);
if (!$actualAttribute) {
static::fail(
sprintf(
'%s%sCould not find attribute "%s" on node "%s"',
$message,
!empty($message) ? "\n" : '',
$expectedAttribute->name,
$expectedElement->tagName
)
);
}
}
}
Xml::removeCharacterDataNodes($expectedElement);
Xml::removeCharacterDataNodes($actualElement);
static::assertSame(
$expectedElement->childNodes->length,
$actualElement->childNodes->length,
sprintf(
'%s%sNumber of child nodes of "%s" differs',
$message,
!empty($message) ? "\n" : '',
$expectedElement->tagName
)
);
for ($i = 0; $i < $expectedElement->childNodes->length; $i++) {
static::assertEqualXMLStructure(
$expectedElement->childNodes->item($i),
$actualElement->childNodes->item($i),
$checkAttributes,
$message
);
}
}
/**
* Evaluates a PHPUnit\Framework\Constraint matcher object.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertThat($value, Constraint $constraint, string $message = ''): void
{
self::$count += count($constraint);
$constraint->evaluate($value, $message);
}
/**
* Asserts that a string is a valid JSON string.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertJson(string $actualJson, string $message = ''): void
{
static::assertThat($actualJson, static::isJson(), $message);
}
/**
* Asserts that two given JSON encoded objects or arrays are equal.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson, string $message = ''): void
{
static::assertJson($expectedJson, $message);
static::assertJson($actualJson, $message);
static::assertThat($actualJson, new JsonMatches($expectedJson), $message);
}
/**
* Asserts that two given JSON encoded objects or arrays are not equal.
*
* @param string $expectedJson
* @param string $actualJson
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertJsonStringNotEqualsJsonString($expectedJson, $actualJson, string $message = ''): void
{
static::assertJson($expectedJson, $message);
static::assertJson($actualJson, $message);
static::assertThat(
$actualJson,
new LogicalNot(
new JsonMatches($expectedJson)
),
$message
);
}
/**
* Asserts that the generated JSON encoded object and the content of the given file are equal.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
$expectedJson = file_get_contents($expectedFile);
static::assertJson($expectedJson, $message);
static::assertJson($actualJson, $message);
static::assertThat($actualJson, new JsonMatches($expectedJson), $message);
}
/**
* Asserts that the generated JSON encoded object and the content of the given file are not equal.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
$expectedJson = file_get_contents($expectedFile);
static::assertJson($expectedJson, $message);
static::assertJson($actualJson, $message);
static::assertThat(
$actualJson,
new LogicalNot(
new JsonMatches($expectedJson)
),
$message
);
}
/**
* Asserts that two JSON files are equal.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
static::assertFileExists($actualFile, $message);
$actualJson = file_get_contents($actualFile);
$expectedJson = file_get_contents($expectedFile);
static::assertJson($expectedJson, $message);
static::assertJson($actualJson, $message);
$constraintExpected = new JsonMatches(
$expectedJson
);
$constraintActual = new JsonMatches($actualJson);
static::assertThat($expectedJson, $constraintActual, $message);
static::assertThat($actualJson, $constraintExpected, $message);
}
/**
* Asserts that two JSON files are not equal.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public static function assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile, string $message = ''): void
{
static::assertFileExists($expectedFile, $message);
static::assertFileExists($actualFile, $message);
$actualJson = file_get_contents($actualFile);
$expectedJson = file_get_contents($expectedFile);
static::assertJson($expectedJson, $message);
static::assertJson($actualJson, $message);
$constraintExpected = new JsonMatches(
$expectedJson
);
$constraintActual = new JsonMatches($actualJson);
static::assertThat($expectedJson, new LogicalNot($constraintActual), $message);
static::assertThat($actualJson, new LogicalNot($constraintExpected), $message);
}
/**
* @throws Exception
*/
public static function logicalAnd(): LogicalAnd
{
$constraints = func_get_args();
$constraint = new LogicalAnd;
$constraint->setConstraints($constraints);
return $constraint;
}
public static function logicalOr(): LogicalOr
{
$constraints = func_get_args();
$constraint = new LogicalOr;
$constraint->setConstraints($constraints);
return $constraint;
}
public static function logicalNot(Constraint $constraint): LogicalNot
{
return new LogicalNot($constraint);
}
public static function logicalXor(): LogicalXor
{
$constraints = func_get_args();
$constraint = new LogicalXor;
$constraint->setConstraints($constraints);
return $constraint;
}
public static function anything(): IsAnything
{
return new IsAnything;
}
public static function isTrue(): IsTrue
{
return new IsTrue;
}
/**
* @psalm-template CallbackInput of mixed
*
* @psalm-param callable(CallbackInput $callback): bool $callback
*
* @psalm-return Callback
*/
public static function callback(callable $callback): Callback
{
return new Callback($callback);
}
public static function isFalse(): IsFalse
{
return new IsFalse;
}
public static function isJson(): IsJson
{
return new IsJson;
}
public static function isNull(): IsNull
{
return new IsNull;
}
public static function isFinite(): IsFinite
{
return new IsFinite;
}
public static function isInfinite(): IsInfinite
{
return new IsInfinite;
}
public static function isNan(): IsNan
{
return new IsNan;
}
public static function containsEqual($value): TraversableContainsEqual
{
return new TraversableContainsEqual($value);
}
public static function containsIdentical($value): TraversableContainsIdentical
{
return new TraversableContainsIdentical($value);
}
public static function containsOnly(string $type): TraversableContainsOnly
{
return new TraversableContainsOnly($type);
}
public static function containsOnlyInstancesOf(string $className): TraversableContainsOnly
{
return new TraversableContainsOnly($className, false);
}
/**
* @param int|string $key
*/
public static function arrayHasKey($key): ArrayHasKey
{
return new ArrayHasKey($key);
}
public static function equalTo($value): IsEqual
{
return new IsEqual($value, 0.0, false, false);
}
public static function equalToCanonicalizing($value): IsEqualCanonicalizing
{
return new IsEqualCanonicalizing($value);
}
public static function equalToIgnoringCase($value): IsEqualIgnoringCase
{
return new IsEqualIgnoringCase($value);
}
public static function equalToWithDelta($value, float $delta): IsEqualWithDelta
{
return new IsEqualWithDelta($value, $delta);
}
public static function isEmpty(): IsEmpty
{
return new IsEmpty;
}
public static function isWritable(): IsWritable
{
return new IsWritable;
}
public static function isReadable(): IsReadable
{
return new IsReadable;
}
public static function directoryExists(): DirectoryExists
{
return new DirectoryExists;
}
public static function fileExists(): FileExists
{
return new FileExists;
}
public static function greaterThan($value): GreaterThan
{
return new GreaterThan($value);
}
public static function greaterThanOrEqual($value): LogicalOr
{
return static::logicalOr(
new IsEqual($value),
new GreaterThan($value)
);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
public static function classHasAttribute(string $attributeName): ClassHasAttribute
{
self::createWarning('classHasAttribute() is deprecated and will be removed in PHPUnit 10.');
return new ClassHasAttribute($attributeName);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
public static function classHasStaticAttribute(string $attributeName): ClassHasStaticAttribute
{
self::createWarning('classHasStaticAttribute() is deprecated and will be removed in PHPUnit 10.');
return new ClassHasStaticAttribute($attributeName);
}
/**
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
public static function objectHasAttribute($attributeName): ObjectHasAttribute
{
self::createWarning('objectHasAttribute() is deprecated and will be removed in PHPUnit 10.');
return new ObjectHasAttribute($attributeName);
}
public static function identicalTo($value): IsIdentical
{
return new IsIdentical($value);
}
public static function isInstanceOf(string $className): IsInstanceOf
{
return new IsInstanceOf($className);
}
public static function isType(string $type): IsType
{
return new IsType($type);
}
public static function lessThan($value): LessThan
{
return new LessThan($value);
}
public static function lessThanOrEqual($value): LogicalOr
{
return static::logicalOr(
new IsEqual($value),
new LessThan($value)
);
}
public static function matchesRegularExpression(string $pattern): RegularExpression
{
return new RegularExpression($pattern);
}
public static function matches(string $string): StringMatchesFormatDescription
{
return new StringMatchesFormatDescription($string);
}
public static function stringStartsWith($prefix): StringStartsWith
{
return new StringStartsWith($prefix);
}
public static function stringContains(string $string, bool $case = true): StringContains
{
return new StringContains($string, $case);
}
public static function stringEndsWith(string $suffix): StringEndsWith
{
return new StringEndsWith($suffix);
}
public static function countOf(int $count): Count
{
return new Count($count);
}
public static function objectEquals(object $object, string $method = 'equals'): ObjectEquals
{
return new ObjectEquals($object, $method);
}
/**
* Fails a test with the given message.
*
* @throws AssertionFailedError
*
* @psalm-return never-return
*/
public static function fail(string $message = ''): void
{
self::$count++;
throw new AssertionFailedError($message);
}
/**
* Mark the test as incomplete.
*
* @throws IncompleteTestError
*
* @psalm-return never-return
*/
public static function markTestIncomplete(string $message = ''): void
{
throw new IncompleteTestError($message);
}
/**
* Mark the test as skipped.
*
* @throws SkippedTestError
* @throws SyntheticSkippedError
*
* @psalm-return never-return
*/
public static function markTestSkipped(string $message = ''): void
{
if ($hint = self::detectLocationHint($message)) {
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
array_unshift($trace, $hint);
throw new SyntheticSkippedError($hint['message'], 0, $hint['file'], (int) $hint['line'], $trace);
}
throw new SkippedTestError($message);
}
/**
* Return the current assertion count.
*/
public static function getCount(): int
{
return self::$count;
}
/**
* Reset the assertion counter.
*/
public static function resetCount(): void
{
self::$count = 0;
}
private static function detectLocationHint(string $message): ?array
{
$hint = null;
$lines = preg_split('/\r\n|\r|\n/', $message);
while (strpos($lines[0], '__OFFSET') !== false) {
$offset = explode('=', array_shift($lines));
if ($offset[0] === '__OFFSET_FILE') {
$hint['file'] = $offset[1];
}
if ($offset[0] === '__OFFSET_LINE') {
$hint['line'] = $offset[1];
}
}
if ($hint) {
$hint['message'] = implode(PHP_EOL, $lines);
}
return $hint;
}
private static function isValidObjectAttributeName(string $attributeName): bool
{
return (bool) preg_match('/[^\x00-\x1f\x7f-\x9f]+/', $attributeName);
}
private static function isValidClassAttributeName(string $attributeName): bool
{
return (bool) preg_match('/[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', $attributeName);
}
/**
* @codeCoverageIgnore
*/
private static function createWarning(string $warning): void
{
foreach (debug_backtrace() as $step) {
if (isset($step['object']) && $step['object'] instanceof TestCase) {
assert($step['object'] instanceof TestCase);
$step['object']->addWarning($warning);
break;
}
}
}
}
PK ['b ! src/Framework/WarningTestCase.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class WarningTestCase extends TestCase
{
/**
* @var bool
*/
protected $backupGlobals = false;
/**
* @var bool
*/
protected $backupStaticAttributes = false;
/**
* @var bool
*/
protected $runTestInSeparateProcess = false;
/**
* @var string
*/
private $message;
public function __construct(string $message = '')
{
$this->message = $message;
parent::__construct('Warning');
}
public function getMessage(): string
{
return $this->message;
}
/**
* Returns a string representation of the test case.
*/
public function toString(): string
{
return 'Warning';
}
/**
* @throws Exception
*
* @psalm-return never-return
*/
protected function runTest(): void
{
throw new Warning($this->message);
}
}
PK [8>i >i src/Framework/TestSuite.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework;
use const PHP_EOL;
use function array_keys;
use function array_map;
use function array_merge;
use function array_slice;
use function array_unique;
use function basename;
use function call_user_func;
use function class_exists;
use function count;
use function dirname;
use function get_declared_classes;
use function implode;
use function is_bool;
use function is_callable;
use function is_file;
use function is_object;
use function is_string;
use function method_exists;
use function preg_match;
use function preg_quote;
use function sprintf;
use function strpos;
use function substr;
use Iterator;
use IteratorAggregate;
use PHPUnit\Runner\BaseTestRunner;
use PHPUnit\Runner\Filter\Factory;
use PHPUnit\Runner\PhptTestCase;
use PHPUnit\Util\FileLoader;
use PHPUnit\Util\Reflection;
use PHPUnit\Util\Test as TestUtil;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;
use Throwable;
/**
* @template-implements IteratorAggregate
*
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class TestSuite implements IteratorAggregate, Reorderable, SelfDescribing, Test
{
/**
* Enable or disable the backup and restoration of the $GLOBALS array.
*
* @var bool
*/
protected $backupGlobals;
/**
* Enable or disable the backup and restoration of static attributes.
*
* @var bool
*/
protected $backupStaticAttributes;
/**
* @var bool
*/
protected $runTestInSeparateProcess = false;
/**
* The name of the test suite.
*
* @var string
*/
protected $name = '';
/**
* The test groups of the test suite.
*
* @psalm-var array>
*/
protected $groups = [];
/**
* The tests in the test suite.
*
* @var Test[]
*/
protected $tests = [];
/**
* The number of tests in the test suite.
*
* @var int
*/
protected $numTests = -1;
/**
* @var bool
*/
protected $testCase = false;
/**
* @var string[]
*/
protected $foundClasses = [];
/**
* @var null|list
*/
protected $providedTests;
/**
* @var null|list
*/
protected $requiredTests;
/**
* @var bool
*/
private $beStrictAboutChangesToGlobalState;
/**
* @var Factory
*/
private $iteratorFilter;
/**
* @var int
*/
private $declaredClassesPointer;
/**
* @psalm-var array
*/
private $warnings = [];
/**
* Constructs a new TestSuite.
*
* - PHPUnit\Framework\TestSuite() constructs an empty TestSuite.
*
* - PHPUnit\Framework\TestSuite(ReflectionClass) constructs a
* TestSuite from the given class.
*
* - PHPUnit\Framework\TestSuite(ReflectionClass, String)
* constructs a TestSuite from the given class with the given
* name.
*
* - PHPUnit\Framework\TestSuite(String) either constructs a
* TestSuite from the given class (if the passed string is the
* name of an existing class) or constructs an empty TestSuite
* with the given name.
*
* @param ReflectionClass|string $theClass
*
* @throws Exception
*/
public function __construct($theClass = '', string $name = '')
{
if (!is_string($theClass) && !$theClass instanceof ReflectionClass) {
throw InvalidArgumentException::create(
1,
'ReflectionClass object or string'
);
}
$this->declaredClassesPointer = count(get_declared_classes());
if (!$theClass instanceof ReflectionClass) {
if (class_exists($theClass, true)) {
if ($name === '') {
$name = $theClass;
}
try {
$theClass = new ReflectionClass($theClass);
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
} else {
$this->setName($theClass);
return;
}
}
if (!$theClass->isSubclassOf(TestCase::class)) {
$this->setName((string) $theClass);
return;
}
if ($name !== '') {
$this->setName($name);
} else {
$this->setName($theClass->getName());
}
$constructor = $theClass->getConstructor();
if ($constructor !== null &&
!$constructor->isPublic()) {
$this->addTest(
new WarningTestCase(
sprintf(
'Class "%s" has no public constructor.',
$theClass->getName()
)
)
);
return;
}
foreach ((new Reflection)->publicMethodsInTestClass($theClass) as $method) {
if (!TestUtil::isTestMethod($method)) {
continue;
}
$this->addTestMethod($theClass, $method);
}
if (empty($this->tests)) {
$this->addTest(
new WarningTestCase(
sprintf(
'No tests found in class "%s".',
$theClass->getName()
)
)
);
}
$this->testCase = true;
}
/**
* Returns a string representation of the test suite.
*/
public function toString(): string
{
return $this->getName();
}
/**
* Adds a test to the suite.
*
* @param array $groups
*/
public function addTest(Test $test, $groups = []): void
{
try {
$class = new ReflectionClass($test);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if (!$class->isAbstract()) {
$this->tests[] = $test;
$this->clearCaches();
if ($test instanceof self && empty($groups)) {
$groups = $test->getGroups();
}
if ($this->containsOnlyVirtualGroups($groups)) {
$groups[] = 'default';
}
foreach ($groups as $group) {
if (!isset($this->groups[$group])) {
$this->groups[$group] = [$test];
} else {
$this->groups[$group][] = $test;
}
}
if ($test instanceof TestCase) {
$test->setGroups($groups);
}
}
}
/**
* Adds the tests from the given class to the suite.
*
* @psalm-param object|class-string $testClass
*
* @throws Exception
*/
public function addTestSuite($testClass): void
{
if (!(is_object($testClass) || (is_string($testClass) && class_exists($testClass)))) {
throw InvalidArgumentException::create(
1,
'class name or object'
);
}
if (!is_object($testClass)) {
try {
$testClass = new ReflectionClass($testClass);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
}
if ($testClass instanceof self) {
$this->addTest($testClass);
} elseif ($testClass instanceof ReflectionClass) {
$suiteMethod = false;
if (!$testClass->isAbstract() && $testClass->hasMethod(BaseTestRunner::SUITE_METHODNAME)) {
try {
$method = $testClass->getMethod(
BaseTestRunner::SUITE_METHODNAME
);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if ($method->isStatic()) {
$this->addTest(
$method->invoke(null, $testClass->getName())
);
$suiteMethod = true;
}
}
if (!$suiteMethod && !$testClass->isAbstract() && $testClass->isSubclassOf(TestCase::class)) {
$this->addTest(new self($testClass));
}
} else {
throw new Exception;
}
}
public function addWarning(string $warning): void
{
$this->warnings[] = $warning;
}
/**
* Wraps both addTest() and addTestSuite
* as well as the separate import statements for the user's convenience.
*
* If the named file cannot be read or there are no new tests that can be
* added, a PHPUnit\Framework\WarningTestCase will be created instead,
* leaving the current test run untouched.
*
* @throws Exception
*/
public function addTestFile(string $filename): void
{
if (is_file($filename) && substr($filename, -5) === '.phpt') {
$this->addTest(new PhptTestCase($filename));
$this->declaredClassesPointer = count(get_declared_classes());
return;
}
$numTests = count($this->tests);
// The given file may contain further stub classes in addition to the
// test class itself. Figure out the actual test class.
$filename = FileLoader::checkAndLoad($filename);
$newClasses = array_slice(get_declared_classes(), $this->declaredClassesPointer);
// The diff is empty in case a parent class (with test methods) is added
// AFTER a child class that inherited from it. To account for that case,
// accumulate all discovered classes, so the parent class may be found in
// a later invocation.
if (!empty($newClasses)) {
// On the assumption that test classes are defined first in files,
// process discovered classes in approximate LIFO order, so as to
// avoid unnecessary reflection.
$this->foundClasses = array_merge($newClasses, $this->foundClasses);
$this->declaredClassesPointer = count(get_declared_classes());
}
// The test class's name must match the filename, either in full, or as
// a PEAR/PSR-0 prefixed short name ('NameSpace_ShortName'), or as a
// PSR-1 local short name ('NameSpace\ShortName'). The comparison must be
// anchored to prevent false-positive matches (e.g., 'OtherShortName').
$shortName = basename($filename, '.php');
$shortNameRegEx = '/(?:^|_|\\\\)' . preg_quote($shortName, '/') . '$/';
foreach ($this->foundClasses as $i => $className) {
if (preg_match($shortNameRegEx, $className)) {
try {
$class = new ReflectionClass($className);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if ($class->getFileName() == $filename) {
$newClasses = [$className];
unset($this->foundClasses[$i]);
break;
}
}
}
foreach ($newClasses as $className) {
try {
$class = new ReflectionClass($className);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if (dirname($class->getFileName()) === __DIR__) {
continue;
}
if ($class->isAbstract() && $class->isSubclassOf(TestCase::class)) {
$this->addWarning(
sprintf(
'Abstract test case classes with "Test" suffix are deprecated (%s)',
$class->getName()
)
);
}
if (!$class->isAbstract()) {
if ($class->hasMethod(BaseTestRunner::SUITE_METHODNAME)) {
try {
$method = $class->getMethod(
BaseTestRunner::SUITE_METHODNAME
);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if ($method->isStatic()) {
$this->addTest($method->invoke(null, $className));
}
} elseif ($class->implementsInterface(Test::class)) {
// Do we have modern namespacing ('Foo\Bar\WhizBangTest') or old-school namespacing ('Foo_Bar_WhizBangTest')?
$isPsr0 = (!$class->inNamespace()) && (strpos($class->getName(), '_') !== false);
$expectedClassName = $isPsr0 ? $className : $shortName;
if (($pos = strpos($expectedClassName, '.')) !== false) {
$expectedClassName = substr(
$expectedClassName,
0,
$pos
);
}
if ($class->getShortName() !== $expectedClassName) {
$this->addWarning(
sprintf(
"Test case class not matching filename is deprecated\n in %s\n Class name was '%s', expected '%s'",
$filename,
$class->getShortName(),
$expectedClassName
)
);
}
$this->addTestSuite($class);
}
}
}
if (count($this->tests) > ++$numTests) {
$this->addWarning(
sprintf(
"Multiple test case classes per file is deprecated\n in %s",
$filename
)
);
}
$this->numTests = -1;
}
/**
* Wrapper for addTestFile() that adds multiple test files.
*
* @throws Exception
*/
public function addTestFiles(iterable $fileNames): void
{
foreach ($fileNames as $filename) {
$this->addTestFile((string) $filename);
}
}
/**
* Counts the number of test cases that will be run by this test.
*
* @todo refactor usage of numTests in DefaultResultPrinter
*/
public function count(): int
{
$this->numTests = 0;
foreach ($this as $test) {
$this->numTests += count($test);
}
return $this->numTests;
}
/**
* Returns the name of the suite.
*/
public function getName(): string
{
return $this->name;
}
/**
* Returns the test groups of the suite.
*
* @psalm-return list
*/
public function getGroups(): array
{
return array_map(
static function ($key): string
{
return (string) $key;
},
array_keys($this->groups)
);
}
public function getGroupDetails(): array
{
return $this->groups;
}
/**
* Set tests groups of the test case.
*/
public function setGroupDetails(array $groups): void
{
$this->groups = $groups;
}
/**
* Runs the tests and collects their result in a TestResult.
*
* @throws \PHPUnit\Framework\CodeCoverageException
* @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
* @throws \SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws Warning
*/
public function run(TestResult $result = null): TestResult
{
if ($result === null) {
$result = $this->createResult();
}
if (count($this) === 0) {
return $result;
}
/** @psalm-var class-string $className */
$className = $this->name;
$hookMethods = TestUtil::getHookMethods($className);
$result->startTestSuite($this);
$test = null;
if ($this->testCase && class_exists($this->name, false)) {
try {
foreach ($hookMethods['beforeClass'] as $beforeClassMethod) {
if (method_exists($this->name, $beforeClassMethod)) {
if ($missingRequirements = TestUtil::getMissingRequirements($this->name, $beforeClassMethod)) {
$this->markTestSuiteSkipped(implode(PHP_EOL, $missingRequirements));
}
call_user_func([$this->name, $beforeClassMethod]);
}
}
} catch (SkippedTestSuiteError|SkippedTestError $error) {
foreach ($this->tests() as $test) {
$result->startTest($test);
$result->addFailure($test, $error, 0);
$result->endTest($test, 0);
}
$result->endTestSuite($this);
return $result;
} catch (Throwable $t) {
$errorAdded = false;
foreach ($this->tests() as $test) {
if ($result->shouldStop()) {
break;
}
$result->startTest($test);
if (!$errorAdded) {
$result->addError($test, $t, 0);
$errorAdded = true;
} else {
$result->addFailure(
$test,
new SkippedTestError('Test skipped because of an error in hook method'),
0
);
}
$result->endTest($test, 0);
}
$result->endTestSuite($this);
return $result;
}
}
foreach ($this as $test) {
if ($result->shouldStop()) {
break;
}
if ($test instanceof TestCase || $test instanceof self) {
$test->setBeStrictAboutChangesToGlobalState($this->beStrictAboutChangesToGlobalState);
$test->setBackupGlobals($this->backupGlobals);
$test->setBackupStaticAttributes($this->backupStaticAttributes);
$test->setRunTestInSeparateProcess($this->runTestInSeparateProcess);
}
$test->run($result);
}
if ($this->testCase && class_exists($this->name, false)) {
foreach ($hookMethods['afterClass'] as $afterClassMethod) {
if (method_exists($this->name, $afterClassMethod)) {
try {
call_user_func([$this->name, $afterClassMethod]);
} catch (Throwable $t) {
$message = "Exception in {$this->name}::{$afterClassMethod}" . PHP_EOL . $t->getMessage();
$error = new SyntheticError($message, 0, $t->getFile(), $t->getLine(), $t->getTrace());
$placeholderTest = clone $test;
$placeholderTest->setName($afterClassMethod);
$result->startTest($placeholderTest);
$result->addFailure($placeholderTest, $error, 0);
$result->endTest($placeholderTest, 0);
}
}
}
}
$result->endTestSuite($this);
return $result;
}
public function setRunTestInSeparateProcess(bool $runTestInSeparateProcess): void
{
$this->runTestInSeparateProcess = $runTestInSeparateProcess;
}
public function setName(string $name): void
{
$this->name = $name;
}
/**
* Returns the tests as an enumeration.
*
* @return Test[]
*/
public function tests(): array
{
return $this->tests;
}
/**
* Set tests of the test suite.
*
* @param Test[] $tests
*/
public function setTests(array $tests): void
{
$this->tests = $tests;
}
/**
* Mark the test suite as skipped.
*
* @param string $message
*
* @throws SkippedTestSuiteError
*
* @psalm-return never-return
*/
public function markTestSuiteSkipped($message = ''): void
{
throw new SkippedTestSuiteError($message);
}
/**
* @param bool $beStrictAboutChangesToGlobalState
*/
public function setBeStrictAboutChangesToGlobalState($beStrictAboutChangesToGlobalState): void
{
if (null === $this->beStrictAboutChangesToGlobalState && is_bool($beStrictAboutChangesToGlobalState)) {
$this->beStrictAboutChangesToGlobalState = $beStrictAboutChangesToGlobalState;
}
}
/**
* @param bool $backupGlobals
*/
public function setBackupGlobals($backupGlobals): void
{
if (null === $this->backupGlobals && is_bool($backupGlobals)) {
$this->backupGlobals = $backupGlobals;
}
}
/**
* @param bool $backupStaticAttributes
*/
public function setBackupStaticAttributes($backupStaticAttributes): void
{
if (null === $this->backupStaticAttributes && is_bool($backupStaticAttributes)) {
$this->backupStaticAttributes = $backupStaticAttributes;
}
}
/**
* Returns an iterator for this test suite.
*/
public function getIterator(): Iterator
{
$iterator = new TestSuiteIterator($this);
if ($this->iteratorFilter !== null) {
$iterator = $this->iteratorFilter->factory($iterator, $this);
}
return $iterator;
}
public function injectFilter(Factory $filter): void
{
$this->iteratorFilter = $filter;
foreach ($this as $test) {
if ($test instanceof self) {
$test->injectFilter($filter);
}
}
}
/**
* @psalm-return array
*/
public function warnings(): array
{
return array_unique($this->warnings);
}
/**
* @return list
*/
public function provides(): array
{
if ($this->providedTests === null) {
$this->providedTests = [];
if (is_callable($this->sortId(), true)) {
$this->providedTests[] = new ExecutionOrderDependency($this->sortId());
}
foreach ($this->tests as $test) {
if (!($test instanceof Reorderable)) {
// @codeCoverageIgnoreStart
continue;
// @codeCoverageIgnoreEnd
}
$this->providedTests = ExecutionOrderDependency::mergeUnique($this->providedTests, $test->provides());
}
}
return $this->providedTests;
}
/**
* @return list
*/
public function requires(): array
{
if ($this->requiredTests === null) {
$this->requiredTests = [];
foreach ($this->tests as $test) {
if (!($test instanceof Reorderable)) {
// @codeCoverageIgnoreStart
continue;
// @codeCoverageIgnoreEnd
}
$this->requiredTests = ExecutionOrderDependency::mergeUnique(
ExecutionOrderDependency::filterInvalid($this->requiredTests),
$test->requires()
);
}
$this->requiredTests = ExecutionOrderDependency::diff($this->requiredTests, $this->provides());
}
return $this->requiredTests;
}
public function sortId(): string
{
return $this->getName() . '::class';
}
/**
* Creates a default TestResult object.
*/
protected function createResult(): TestResult
{
return new TestResult;
}
/**
* @throws Exception
*/
protected function addTestMethod(ReflectionClass $class, ReflectionMethod $method): void
{
$methodName = $method->getName();
$test = (new TestBuilder)->build($class, $methodName);
if ($test instanceof TestCase || $test instanceof DataProviderTestSuite) {
$test->setDependencies(
TestUtil::getDependencies($class->getName(), $methodName)
);
}
$this->addTest(
$test,
TestUtil::getGroups($class->getName(), $methodName)
);
}
private function clearCaches(): void
{
$this->numTests = -1;
$this->providedTests = null;
$this->requiredTests = null;
}
private function containsOnlyVirtualGroups(array $groups): bool
{
foreach ($groups as $group) {
if (strpos($group, '__phpunit_') !== 0) {
return false;
}
}
return true;
}
}
PK [X1 . src/Framework/Constraint/Type/IsInstanceOf.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function sprintf;
use ReflectionClass;
use ReflectionException;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsInstanceOf extends Constraint
{
/**
* @var string
*/
private $className;
public function __construct(string $className)
{
$this->className = $className;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return sprintf(
'is instance of %s "%s"',
$this->getType(),
$this->className
);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return $other instanceof $this->className;
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function failureDescription($other): string
{
return sprintf(
'%s is an instance of %s "%s"',
$this->exporter()->shortenedExport($other),
$this->getType(),
$this->className
);
}
private function getType(): string
{
try {
$reflection = new ReflectionClass($this->className);
if ($reflection->isInterface()) {
return 'interface';
}
} catch (ReflectionException $e) {
}
return 'class';
}
}
PK [a7TE E ( src/Framework/Constraint/Type/IsType.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function gettype;
use function is_array;
use function is_bool;
use function is_callable;
use function is_float;
use function is_int;
use function is_iterable;
use function is_numeric;
use function is_object;
use function is_scalar;
use function is_string;
use function sprintf;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsType extends Constraint
{
/**
* @var string
*/
public const TYPE_ARRAY = 'array';
/**
* @var string
*/
public const TYPE_BOOL = 'bool';
/**
* @var string
*/
public const TYPE_FLOAT = 'float';
/**
* @var string
*/
public const TYPE_INT = 'int';
/**
* @var string
*/
public const TYPE_NULL = 'null';
/**
* @var string
*/
public const TYPE_NUMERIC = 'numeric';
/**
* @var string
*/
public const TYPE_OBJECT = 'object';
/**
* @var string
*/
public const TYPE_RESOURCE = 'resource';
/**
* @var string
*/
public const TYPE_CLOSED_RESOURCE = 'resource (closed)';
/**
* @var string
*/
public const TYPE_STRING = 'string';
/**
* @var string
*/
public const TYPE_SCALAR = 'scalar';
/**
* @var string
*/
public const TYPE_CALLABLE = 'callable';
/**
* @var string
*/
public const TYPE_ITERABLE = 'iterable';
/**
* @var array
*/
private const KNOWN_TYPES = [
'array' => true,
'boolean' => true,
'bool' => true,
'double' => true,
'float' => true,
'integer' => true,
'int' => true,
'null' => true,
'numeric' => true,
'object' => true,
'real' => true,
'resource' => true,
'resource (closed)' => true,
'string' => true,
'scalar' => true,
'callable' => true,
'iterable' => true,
];
/**
* @var string
*/
private $type;
/**
* @throws \PHPUnit\Framework\Exception
*/
public function __construct(string $type)
{
if (!isset(self::KNOWN_TYPES[$type])) {
throw new \PHPUnit\Framework\Exception(
sprintf(
'Type specified for PHPUnit\Framework\Constraint\IsType <%s> ' .
'is not a valid type.',
$type
)
);
}
$this->type = $type;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return sprintf(
'is of type "%s"',
$this->type
);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
switch ($this->type) {
case 'numeric':
return is_numeric($other);
case 'integer':
case 'int':
return is_int($other);
case 'double':
case 'float':
case 'real':
return is_float($other);
case 'string':
return is_string($other);
case 'boolean':
case 'bool':
return is_bool($other);
case 'null':
return null === $other;
case 'array':
return is_array($other);
case 'object':
return is_object($other);
case 'resource':
$type = gettype($other);
return $type === 'resource' || $type === 'resource (closed)';
case 'resource (closed)':
return gettype($other) === 'resource (closed)';
case 'scalar':
return is_scalar($other);
case 'callable':
return is_callable($other);
case 'iterable':
return is_iterable($other);
default:
return false;
}
}
}
PK [w5Lu u ( src/Framework/Constraint/Type/IsNull.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsNull extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is null';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return $other === null;
}
}
PK [uXU
U
0 src/Framework/Constraint/Operator/LogicalNot.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function array_map;
use function count;
use function preg_match;
use function preg_quote;
use function preg_replace;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class LogicalNot extends UnaryOperator
{
public static function negate(string $string): string
{
$positives = [
'contains ',
'exists',
'has ',
'is ',
'are ',
'matches ',
'starts with ',
'ends with ',
'reference ',
'not not ',
];
$negatives = [
'does not contain ',
'does not exist',
'does not have ',
'is not ',
'are not ',
'does not match ',
'starts not with ',
'ends not with ',
'don\'t reference ',
'not ',
];
preg_match('/(\'[\w\W]*\')([\w\W]*)("[\w\W]*")/i', $string, $matches);
$positives = array_map(static function (string $s)
{
return '/\\b' . preg_quote($s, '/') . '/';
}, $positives);
if (count($matches) > 0) {
$nonInput = $matches[2];
$negatedString = preg_replace(
'/' . preg_quote($nonInput, '/') . '/',
preg_replace(
$positives,
$negatives,
$nonInput
),
$string
);
} else {
$negatedString = preg_replace(
$positives,
$negatives,
$string
);
}
return $negatedString;
}
/**
* Returns the name of this operator.
*/
public function operator(): string
{
return 'not';
}
/**
* Returns this operator's precedence.
*
* @see https://www.php.net/manual/en/language.operators.precedence.php
*/
public function precedence(): int
{
return 5;
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return !$this->constraint()->evaluate($other, '', true);
}
/**
* Applies additional transformation to strings returned by toString() or
* failureDescription().
*/
protected function transformString(string $string): string
{
return self::negate($string);
}
/**
* Reduces the sub-expression starting at $this by skipping degenerate
* sub-expression and returns first descendant constraint that starts
* a non-reducible sub-expression.
*
* See Constraint::reduce() for more.
*/
protected function reduce(): Constraint
{
$constraint = $this->constraint();
if ($constraint instanceof self) {
return $constraint->constraint()->reduce();
}
return parent::reduce();
}
}
PK [J 3 src/Framework/Constraint/Operator/UnaryOperator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function count;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
abstract class UnaryOperator extends Operator
{
/**
* @var Constraint
*/
private $constraint;
/**
* @param Constraint|mixed $constraint
*/
public function __construct($constraint)
{
$this->constraint = $this->checkConstraint($constraint);
}
/**
* Returns the number of operands (constraints).
*/
public function arity(): int
{
return 1;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
$reduced = $this->reduce();
if ($reduced !== $this) {
return $reduced->toString();
}
$constraint = $this->constraint->reduce();
if ($this->constraintNeedsParentheses($constraint)) {
return $this->operator() . '( ' . $constraint->toString() . ' )';
}
$string = $constraint->toStringInContext($this, 0);
if ($string === '') {
return $this->transformString($constraint->toString());
}
return $string;
}
/**
* Counts the number of constraint elements.
*/
public function count(): int
{
return count($this->constraint);
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function failureDescription($other): string
{
$reduced = $this->reduce();
if ($reduced !== $this) {
return $reduced->failureDescription($other);
}
$constraint = $this->constraint->reduce();
if ($this->constraintNeedsParentheses($constraint)) {
return $this->operator() . '( ' . $constraint->failureDescription($other) . ' )';
}
$string = $constraint->failureDescriptionInContext($this, 0, $other);
if ($string === '') {
return $this->transformString($constraint->failureDescription($other));
}
return $string;
}
/**
* Transforms string returned by the memeber constraint's toString() or
* failureDescription() such that it reflects constraint's participation in
* this expression.
*
* The method may be overwritten in a subclass to apply default
* transformation in case the operand constraint does not provide its own
* custom strings via toStringInContext() or failureDescriptionInContext().
*
* @param string $string the string to be transformed
*/
protected function transformString(string $string): string
{
return $string;
}
/**
* Provides access to $this->constraint for subclasses.
*/
final protected function constraint(): Constraint
{
return $this->constraint;
}
/**
* Returns true if the $constraint needs to be wrapped with parentheses.
*/
protected function constraintNeedsParentheses(Constraint $constraint): bool
{
$constraint = $constraint->reduce();
return $constraint instanceof self || parent::constraintNeedsParentheses($constraint);
}
}
PK [V9( ( 0 src/Framework/Constraint/Operator/LogicalXor.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function array_reduce;
use function array_shift;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class LogicalXor extends BinaryOperator
{
/**
* Returns the name of this operator.
*/
public function operator(): string
{
return 'xor';
}
/**
* Returns this operator's precedence.
*
* @see https://www.php.net/manual/en/language.operators.precedence.php.
*/
public function precedence(): int
{
return 23;
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
public function matches($other): bool
{
$constraints = $this->constraints();
$initial = array_shift($constraints);
if ($initial === null) {
return false;
}
return array_reduce(
$constraints,
static function (bool $matches, Constraint $constraint) use ($other): bool
{
return $matches xor $constraint->evaluate($other, '', true);
},
$initial->evaluate($other, '', true)
);
}
}
PK [] / src/Framework/Constraint/Operator/LogicalOr.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class LogicalOr extends BinaryOperator
{
/**
* Returns the name of this operator.
*/
public function operator(): string
{
return 'or';
}
/**
* Returns this operator's precedence.
*
* @see https://www.php.net/manual/en/language.operators.precedence.php
*/
public function precedence(): int
{
return 24;
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
public function matches($other): bool
{
foreach ($this->constraints() as $constraint) {
if ($constraint->evaluate($other, '', true)) {
return true;
}
}
return false;
}
}
PK [tJ 0 src/Framework/Constraint/Operator/LogicalAnd.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class LogicalAnd extends BinaryOperator
{
/**
* Returns the name of this operator.
*/
public function operator(): string
{
return 'and';
}
/**
* Returns this operator's precedence.
*
* @see https://www.php.net/manual/en/language.operators.precedence.php
*/
public function precedence(): int
{
return 22;
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
foreach ($this->constraints() as $constraint) {
if (!$constraint->evaluate($other, '', true)) {
return false;
}
}
return [] !== $this->constraints();
}
}
PK [≬ . src/Framework/Constraint/Operator/Operator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
abstract class Operator extends Constraint
{
/**
* Returns the name of this operator.
*/
abstract public function operator(): string;
/**
* Returns this operator's precedence.
*
* @see https://www.php.net/manual/en/language.operators.precedence.php
*/
abstract public function precedence(): int;
/**
* Returns the number of operands.
*/
abstract public function arity(): int;
/**
* Validates $constraint argument.
*/
protected function checkConstraint($constraint): Constraint
{
if (!$constraint instanceof Constraint) {
return new IsEqual($constraint);
}
return $constraint;
}
/**
* Returns true if the $constraint needs to be wrapped with braces.
*/
protected function constraintNeedsParentheses(Constraint $constraint): bool
{
return $constraint instanceof self &&
$constraint->arity() > 1 &&
$this->precedence() <= $constraint->precedence();
}
}
PK [ 4 src/Framework/Constraint/Operator/BinaryOperator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function array_map;
use function array_values;
use function count;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
abstract class BinaryOperator extends Operator
{
/**
* @var Constraint[]
*/
private $constraints = [];
public static function fromConstraints(Constraint ...$constraints): self
{
$constraint = new static;
$constraint->constraints = $constraints;
return $constraint;
}
/**
* @param mixed[] $constraints
*/
public function setConstraints(array $constraints): void
{
$this->constraints = array_map(function ($constraint): Constraint
{
return $this->checkConstraint($constraint);
}, array_values($constraints));
}
/**
* Returns the number of operands (constraints).
*/
final public function arity(): int
{
return count($this->constraints);
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
$reduced = $this->reduce();
if ($reduced !== $this) {
return $reduced->toString();
}
$text = '';
foreach ($this->constraints as $key => $constraint) {
$constraint = $constraint->reduce();
$text .= $this->constraintToString($constraint, $key);
}
return $text;
}
/**
* Counts the number of constraint elements.
*/
public function count(): int
{
$count = 0;
foreach ($this->constraints as $constraint) {
$count += count($constraint);
}
return $count;
}
/**
* Returns the nested constraints.
*/
final protected function constraints(): array
{
return $this->constraints;
}
/**
* Returns true if the $constraint needs to be wrapped with braces.
*/
final protected function constraintNeedsParentheses(Constraint $constraint): bool
{
return $this->arity() > 1 && parent::constraintNeedsParentheses($constraint);
}
/**
* Reduces the sub-expression starting at $this by skipping degenerate
* sub-expression and returns first descendant constraint that starts
* a non-reducible sub-expression.
*
* See Constraint::reduce() for more.
*/
protected function reduce(): Constraint
{
if ($this->arity() === 1 && $this->constraints[0] instanceof Operator) {
return $this->constraints[0]->reduce();
}
return parent::reduce();
}
/**
* Returns string representation of given operand in context of this operator.
*
* @param Constraint $constraint operand constraint
* @param int $position position of $constraint in this expression
*/
private function constraintToString(Constraint $constraint, int $position): string
{
$prefix = '';
if ($position > 0) {
$prefix = (' ' . $this->operator() . ' ');
}
if ($this->constraintNeedsParentheses($constraint)) {
return $prefix . '( ' . $constraint->toString() . ' )';
}
$string = $constraint->toStringInContext($this, $position);
if ($string === '') {
$string = $constraint->toString();
}
return $prefix . $string;
}
}
PK [? ? ? < src/Framework/Constraint/JsonMatchesErrorMessageProvider.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use const JSON_ERROR_CTRL_CHAR;
use const JSON_ERROR_DEPTH;
use const JSON_ERROR_NONE;
use const JSON_ERROR_STATE_MISMATCH;
use const JSON_ERROR_SYNTAX;
use const JSON_ERROR_UTF8;
use function strtolower;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class JsonMatchesErrorMessageProvider
{
/**
* Translates JSON error to a human readable string.
*/
public static function determineJsonError(string $error, string $prefix = ''): ?string
{
switch ($error) {
case JSON_ERROR_NONE:
return null;
case JSON_ERROR_DEPTH:
return $prefix . 'Maximum stack depth exceeded';
case JSON_ERROR_STATE_MISMATCH:
return $prefix . 'Underflow or the modes mismatch';
case JSON_ERROR_CTRL_CHAR:
return $prefix . 'Unexpected control character found';
case JSON_ERROR_SYNTAX:
return $prefix . 'Syntax error, malformed JSON';
case JSON_ERROR_UTF8:
return $prefix . 'Malformed UTF-8 characters, possibly incorrectly encoded';
default:
return $prefix . 'Unknown error';
}
}
/**
* Translates a given type to a human readable message prefix.
*/
public static function translateTypeToPrefix(string $type): string
{
switch (strtolower($type)) {
case 'expected':
$prefix = 'Expected value JSON decode error - ';
break;
case 'actual':
$prefix = 'Actual value JSON decode error - ';
break;
default:
$prefix = '';
break;
}
return $prefix;
}
}
PK [J ( src/Framework/Constraint/JsonMatches.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function json_decode;
use function sprintf;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Util\Json;
use SebastianBergmann\Comparator\ComparisonFailure;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class JsonMatches extends Constraint
{
/**
* @var string
*/
private $value;
public function __construct(string $value)
{
$this->value = $value;
}
/**
* Returns a string representation of the object.
*/
public function toString(): string
{
return sprintf(
'matches JSON string "%s"',
$this->value
);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* This method can be overridden to implement the evaluation algorithm.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
[$error, $recodedOther] = Json::canonicalize($other);
if ($error) {
return false;
}
[$error, $recodedValue] = Json::canonicalize($this->value);
if ($error) {
return false;
}
return $recodedOther == $recodedValue;
}
/**
* Throws an exception for the given compared value and test description.
*
* @param mixed $other evaluated value or object
* @param string $description Additional information about the test
* @param ComparisonFailure $comparisonFailure
*
* @throws \PHPUnit\Framework\Exception
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-return never-return
*/
protected function fail($other, $description, ComparisonFailure $comparisonFailure = null): void
{
if ($comparisonFailure === null) {
[$error, $recodedOther] = Json::canonicalize($other);
if ($error) {
parent::fail($other, $description);
}
[$error, $recodedValue] = Json::canonicalize($this->value);
if ($error) {
parent::fail($other, $description);
}
$comparisonFailure = new ComparisonFailure(
json_decode($this->value),
json_decode($other),
Json::prettify($recodedValue),
Json::prettify($recodedOther),
false,
'Failed asserting that two json values are equal.'
);
}
parent::fail($other, $description, $comparisonFailure);
}
}
PK [/g" g" ' src/Framework/Constraint/Constraint.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function sprintf;
use Countable;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\SelfDescribing;
use SebastianBergmann\Comparator\ComparisonFailure;
use SebastianBergmann\Exporter\Exporter;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
abstract class Constraint implements Countable, SelfDescribing
{
/**
* @var ?Exporter
*/
private $exporter;
/**
* Evaluates the constraint for parameter $other.
*
* If $returnResult is set to false (the default), an exception is thrown
* in case of a failure. null is returned otherwise.
*
* If $returnResult is true, the result of the evaluation is returned as
* a boolean value instead: true in case of success, false in case of a
* failure.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
{
$success = false;
if ($this->matches($other)) {
$success = true;
}
if ($returnResult) {
return $success;
}
if (!$success) {
$this->fail($other, $description);
}
return null;
}
/**
* Counts the number of constraint elements.
*/
public function count(): int
{
return 1;
}
protected function exporter(): Exporter
{
if ($this->exporter === null) {
$this->exporter = new Exporter;
}
return $this->exporter;
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* This method can be overridden to implement the evaluation algorithm.
*
* @param mixed $other value or object to evaluate
*
* @codeCoverageIgnore
*/
protected function matches($other): bool
{
return false;
}
/**
* Throws an exception for the given compared value and test description.
*
* @param mixed $other evaluated value or object
* @param string $description Additional information about the test
* @param ComparisonFailure $comparisonFailure
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*
* @psalm-return never-return
*/
protected function fail($other, $description, ComparisonFailure $comparisonFailure = null): void
{
$failureDescription = sprintf(
'Failed asserting that %s.',
$this->failureDescription($other)
);
$additionalFailureDescription = $this->additionalFailureDescription($other);
if ($additionalFailureDescription) {
$failureDescription .= "\n" . $additionalFailureDescription;
}
if (!empty($description)) {
$failureDescription = $description . "\n" . $failureDescription;
}
throw new ExpectationFailedException(
$failureDescription,
$comparisonFailure
);
}
/**
* Return additional failure description where needed.
*
* The function can be overridden to provide additional failure
* information like a diff
*
* @param mixed $other evaluated value or object
*/
protected function additionalFailureDescription($other): string
{
return '';
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* To provide additional failure information additionalFailureDescription
* can be used.
*
* @param mixed $other evaluated value or object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function failureDescription($other): string
{
return $this->exporter()->export($other) . ' ' . $this->toString();
}
/**
* Returns a custom string representation of the constraint object when it
* appears in context of an $operator expression.
*
* The purpose of this method is to provide meaningful descriptive string
* in context of operators such as LogicalNot. Native PHPUnit constraints
* are supported out of the box by LogicalNot, but externally developed
* ones had no way to provide correct strings in this context.
*
* The method shall return empty string, when it does not handle
* customization by itself.
*
* @param Operator $operator the $operator of the expression
* @param mixed $role role of $this constraint in the $operator expression
*/
protected function toStringInContext(Operator $operator, $role): string
{
return '';
}
/**
* Returns the description of the failure when this constraint appears in
* context of an $operator expression.
*
* The purpose of this method is to provide meaningful failure description
* in context of operators such as LogicalNot. Native PHPUnit constraints
* are supported out of the box by LogicalNot, but externally developed
* ones had no way to provide correct messages in this context.
*
* The method shall return empty string, when it does not handle
* customization by itself.
*
* @param Operator $operator the $operator of the expression
* @param mixed $role role of $this constraint in the $operator expression
* @param mixed $other evaluated value or object
*/
protected function failureDescriptionInContext(Operator $operator, $role, $other): string
{
$string = $this->toStringInContext($operator, $role);
if ($string === '') {
return '';
}
return $this->exporter()->export($other) . ' ' . $string;
}
/**
* Reduces the sub-expression starting at $this by skipping degenerate
* sub-expression and returns first descendant constraint that starts
* a non-reducible sub-expression.
*
* Returns $this for terminal constraints and for operators that start
* non-reducible sub-expression, or the nearest descendant of $this that
* starts a non-reducible sub-expression.
*
* A constraint expression may be modelled as a tree with non-terminal
* nodes (operators) and terminal nodes. For example:
*
* LogicalOr (operator, non-terminal)
* + LogicalAnd (operator, non-terminal)
* | + IsType('int') (terminal)
* | + GreaterThan(10) (terminal)
* + LogicalNot (operator, non-terminal)
* + IsType('array') (terminal)
*
* A degenerate sub-expression is a part of the tree, that effectively does
* not contribute to the evaluation of the expression it appears in. An example
* of degenerate sub-expression is a BinaryOperator constructed with single
* operand or nested BinaryOperators, each with single operand. An
* expression involving a degenerate sub-expression is equivalent to a
* reduced expression with the degenerate sub-expression removed, for example
*
* LogicalAnd (operator)
* + LogicalOr (degenerate operator)
* | + LogicalAnd (degenerate operator)
* | + IsType('int') (terminal)
* + GreaterThan(10) (terminal)
*
* is equivalent to
*
* LogicalAnd (operator)
* + IsType('int') (terminal)
* + GreaterThan(10) (terminal)
*
* because the subexpression
*
* + LogicalOr
* + LogicalAnd
* + -
*
* is degenerate. Calling reduce() on the LogicalOr object above, as well
* as on LogicalAnd, shall return the IsType('int') instance.
*
* Other specific reductions can be implemented, for example cascade of
* LogicalNot operators
*
* + LogicalNot
* + LogicalNot
* +LogicalNot
* + IsTrue
*
* can be reduced to
*
* LogicalNot
* + IsTrue
*/
protected function reduce(): self
{
return $this;
}
}
PK [} - % src/Framework/Constraint/Callback.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @psalm-template CallbackInput of mixed
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class Callback extends Constraint
{
/**
* @var callable
*
* @psalm-var callable(CallbackInput $input): bool
*/
private $callback;
/** @psalm-param callable(CallbackInput $input): bool $callback */
public function __construct(callable $callback)
{
$this->callback = $callback;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is accepted by specified callback';
}
/**
* Evaluates the constraint for parameter $value. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*
* @psalm-param CallbackInput $other
*/
protected function matches($other): bool
{
return ($this->callback)($other);
}
}
PK [$1 . src/Framework/Constraint/Cardinality/Count.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function count;
use function is_array;
use function iterator_count;
use function sprintf;
use Countable;
use EmptyIterator;
use Generator;
use Iterator;
use IteratorAggregate;
use PHPUnit\Framework\Exception;
use Traversable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
class Count extends Constraint
{
/**
* @var int
*/
private $expectedCount;
public function __construct(int $expected)
{
$this->expectedCount = $expected;
}
public function toString(): string
{
return sprintf(
'count matches %d',
$this->expectedCount
);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @throws Exception
*/
protected function matches($other): bool
{
return $this->expectedCount === $this->getCountOf($other);
}
/**
* @throws Exception
*/
protected function getCountOf($other): ?int
{
if ($other instanceof Countable || is_array($other)) {
return count($other);
}
if ($other instanceof EmptyIterator) {
return 0;
}
if ($other instanceof Traversable) {
while ($other instanceof IteratorAggregate) {
try {
$other = $other->getIterator();
} catch (\Exception $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
}
$iterator = $other;
if ($iterator instanceof Generator) {
return $this->getCountOfGenerator($iterator);
}
if (!$iterator instanceof Iterator) {
return iterator_count($iterator);
}
$key = $iterator->key();
$count = iterator_count($iterator);
// Manually rewind $iterator to previous key, since iterator_count
// moves pointer.
if ($key !== null) {
$iterator->rewind();
while ($iterator->valid() && $key !== $iterator->key()) {
$iterator->next();
}
}
return $count;
}
return null;
}
/**
* Returns the total number of iterations from a generator.
* This will fully exhaust the generator.
*/
protected function getCountOfGenerator(Generator $generator): int
{
for ($count = 0; $generator->valid(); $generator->next()) {
$count++;
}
return $count;
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
return sprintf(
'actual size %d matches expected size %d',
(int) $this->getCountOf($other),
$this->expectedCount
);
}
}
PK [Qc 1 src/Framework/Constraint/Cardinality/LessThan.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class LessThan extends Constraint
{
/**
* @var float|int
*/
private $value;
/**
* @param float|int $value
*/
public function __construct($value)
{
$this->value = $value;
}
/**
* Returns a string representation of the constraint.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
return 'is less than ' . $this->exporter()->export($this->value);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return $this->value > $other;
}
}
PK [dn? ? 1 src/Framework/Constraint/Cardinality/SameSize.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class SameSize extends Count
{
public function __construct(iterable $expected)
{
parent::__construct((int) $this->getCountOf($expected));
}
}
PK [N 0 src/Framework/Constraint/Cardinality/IsEmpty.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function count;
use function gettype;
use function sprintf;
use function strpos;
use Countable;
use EmptyIterator;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsEmpty extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is empty';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
if ($other instanceof EmptyIterator) {
return true;
}
if ($other instanceof Countable) {
return count($other) === 0;
}
return empty($other);
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
$type = gettype($other);
return sprintf(
'%s %s %s',
strpos($type, 'a') === 0 || strpos($type, 'o') === 0 ? 'an' : 'a',
$type,
$this->toString()
);
}
}
PK [}Aq 4 src/Framework/Constraint/Cardinality/GreaterThan.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class GreaterThan extends Constraint
{
/**
* @var float|int
*/
private $value;
/**
* @param float|int $value
*/
public function __construct($value)
{
$this->value = $value;
}
/**
* Returns a string representation of the constraint.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
return 'is greater than ' . $this->exporter()->export($this->value);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return $this->value < $other;
}
}
PK [R$/ / 5 src/Framework/Constraint/Object/ClassHasAttribute.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function get_class;
use function is_object;
use function sprintf;
use PHPUnit\Framework\Exception;
use ReflectionClass;
use ReflectionException;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
class ClassHasAttribute extends Constraint
{
/**
* @var string
*/
private $attributeName;
public function __construct(string $attributeName)
{
$this->attributeName = $attributeName;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return sprintf(
'has attribute "%s"',
$this->attributeName
);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
try {
return (new ReflectionClass($other))->hasProperty($this->attributeName);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
return sprintf(
'%sclass "%s" %s',
is_object($other) ? 'object of ' : '',
is_object($other) ? get_class($other) : $other,
$this->toString()
);
}
protected function attributeName(): string
{
return $this->attributeName;
}
}
PK [B 6 src/Framework/Constraint/Object/ObjectHasAttribute.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use ReflectionObject;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
final class ObjectHasAttribute extends ClassHasAttribute
{
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return (new ReflectionObject($other))->hasProperty($this->attributeName());
}
}
PK [X_k k ; src/Framework/Constraint/Object/ClassHasStaticAttribute.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function sprintf;
use PHPUnit\Framework\Exception;
use ReflectionClass;
use ReflectionException;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @deprecated https://github.com/sebastianbergmann/phpunit/issues/4601
*/
final class ClassHasStaticAttribute extends ClassHasAttribute
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return sprintf(
'has static attribute "%s"',
$this->attributeName()
);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
try {
$class = new ReflectionClass($other);
if ($class->hasProperty($this->attributeName())) {
return $class->getProperty($this->attributeName())->isStatic();
}
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
return false;
}
}
PK [C5ج 0 src/Framework/Constraint/Object/ObjectEquals.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function get_class;
use function is_object;
use PHPUnit\Framework\ActualValueIsNotAnObjectException;
use PHPUnit\Framework\ComparisonMethodDoesNotAcceptParameterTypeException;
use PHPUnit\Framework\ComparisonMethodDoesNotDeclareBoolReturnTypeException;
use PHPUnit\Framework\ComparisonMethodDoesNotDeclareExactlyOneParameterException;
use PHPUnit\Framework\ComparisonMethodDoesNotDeclareParameterTypeException;
use PHPUnit\Framework\ComparisonMethodDoesNotExistException;
use ReflectionNamedType;
use ReflectionObject;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class ObjectEquals extends Constraint
{
/**
* @var object
*/
private $expected;
/**
* @var string
*/
private $method;
public function __construct(object $object, string $method = 'equals')
{
$this->expected = $object;
$this->method = $method;
}
public function toString(): string
{
return 'two objects are equal';
}
/**
* @throws ActualValueIsNotAnObjectException
* @throws ComparisonMethodDoesNotAcceptParameterTypeException
* @throws ComparisonMethodDoesNotDeclareBoolReturnTypeException
* @throws ComparisonMethodDoesNotDeclareExactlyOneParameterException
* @throws ComparisonMethodDoesNotDeclareParameterTypeException
* @throws ComparisonMethodDoesNotExistException
*/
protected function matches($other): bool
{
if (!is_object($other)) {
throw new ActualValueIsNotAnObjectException;
}
$object = new ReflectionObject($other);
if (!$object->hasMethod($this->method)) {
throw new ComparisonMethodDoesNotExistException(
get_class($other),
$this->method
);
}
/** @noinspection PhpUnhandledExceptionInspection */
$method = $object->getMethod($this->method);
if (!$method->hasReturnType()) {
throw new ComparisonMethodDoesNotDeclareBoolReturnTypeException(
get_class($other),
$this->method
);
}
$returnType = $method->getReturnType();
if (!$returnType instanceof ReflectionNamedType) {
throw new ComparisonMethodDoesNotDeclareBoolReturnTypeException(
get_class($other),
$this->method
);
}
if ($returnType->allowsNull()) {
throw new ComparisonMethodDoesNotDeclareBoolReturnTypeException(
get_class($other),
$this->method
);
}
if ($returnType->getName() !== 'bool') {
throw new ComparisonMethodDoesNotDeclareBoolReturnTypeException(
get_class($other),
$this->method
);
}
if ($method->getNumberOfParameters() !== 1 || $method->getNumberOfRequiredParameters() !== 1) {
throw new ComparisonMethodDoesNotDeclareExactlyOneParameterException(
get_class($other),
$this->method
);
}
$parameter = $method->getParameters()[0];
if (!$parameter->hasType()) {
throw new ComparisonMethodDoesNotDeclareParameterTypeException(
get_class($other),
$this->method
);
}
$type = $parameter->getType();
if (!$type instanceof ReflectionNamedType) {
throw new ComparisonMethodDoesNotDeclareParameterTypeException(
get_class($other),
$this->method
);
}
$typeName = $type->getName();
if ($typeName === 'self') {
$typeName = get_class($other);
}
if (!$this->expected instanceof $typeName) {
throw new ComparisonMethodDoesNotAcceptParameterTypeException(
get_class($other),
$this->method,
get_class($this->expected)
);
}
return $other->{$this->method}($this->expected);
}
protected function failureDescription($other): string
{
return $this->toString();
}
}
PK [Kx x , src/Framework/Constraint/Boolean/IsFalse.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsFalse extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is false';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return $other === false;
}
}
PK [*:fu u + src/Framework/Constraint/Boolean/IsTrue.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsTrue extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is true';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return $other === true;
}
}
PK [" ( src/Framework/Constraint/IsIdentical.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function get_class;
use function is_array;
use function is_object;
use function is_string;
use function sprintf;
use PHPUnit\Framework\ExpectationFailedException;
use SebastianBergmann\Comparator\ComparisonFailure;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsIdentical extends Constraint
{
/**
* @var mixed
*/
private $value;
public function __construct($value)
{
$this->value = $value;
}
/**
* Evaluates the constraint for parameter $other.
*
* If $returnResult is set to false (the default), an exception is thrown
* in case of a failure. null is returned otherwise.
*
* If $returnResult is true, the result of the evaluation is returned as
* a boolean value instead: true in case of success, false in case of a
* failure.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
{
$success = $this->value === $other;
if ($returnResult) {
return $success;
}
if (!$success) {
$f = null;
// if both values are strings, make sure a diff is generated
if (is_string($this->value) && is_string($other)) {
$f = new ComparisonFailure(
$this->value,
$other,
sprintf("'%s'", $this->value),
sprintf("'%s'", $other)
);
}
// if both values are array, make sure a diff is generated
if (is_array($this->value) && is_array($other)) {
$f = new ComparisonFailure(
$this->value,
$other,
$this->exporter()->export($this->value),
$this->exporter()->export($other)
);
}
$this->fail($other, $description, $f);
}
return null;
}
/**
* Returns a string representation of the constraint.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
if (is_object($this->value)) {
return 'is identical to an object of class "' .
get_class($this->value) . '"';
}
return 'is identical to ' . $this->exporter()->export($this->value);
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function failureDescription($other): string
{
if (is_object($this->value) && is_object($other)) {
return 'two variables reference the same object';
}
if (is_string($this->value) && is_string($other)) {
return 'two strings are identical';
}
if (is_array($this->value) && is_array($other)) {
return 'two arrays are identical';
}
return parent::failureDescription($other);
}
}
PK [dAg g 2 src/Framework/Constraint/Filesystem/FileExists.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function file_exists;
use function sprintf;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class FileExists extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'file exists';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return file_exists($other);
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
return sprintf(
'file "%s" exists',
$other
);
}
}
PK [
g g 2 src/Framework/Constraint/Filesystem/IsWritable.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_writable;
use function sprintf;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsWritable extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is writable';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return is_writable($other);
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
return sprintf(
'"%s" is writable',
$other
);
}
}
PK [Tg g 2 src/Framework/Constraint/Filesystem/IsReadable.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_readable;
use function sprintf;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsReadable extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is readable';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return is_readable($other);
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
return sprintf(
'"%s" is readable',
$other
);
}
}
PK [<+
l l 7 src/Framework/Constraint/Filesystem/DirectoryExists.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_dir;
use function sprintf;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class DirectoryExists extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'directory exists';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return is_dir($other);
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
return sprintf(
'directory "%s" exists',
$other
);
}
}
PK [>d d ' src/Framework/Constraint/IsAnything.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use PHPUnit\Framework\ExpectationFailedException;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsAnything extends Constraint
{
/**
* Evaluates the constraint for parameter $other.
*
* If $returnResult is set to false (the default), an exception is thrown
* in case of a failure. null is returned otherwise.
*
* If $returnResult is true, the result of the evaluation is returned as
* a boolean value instead: true in case of success, false in case of a
* failure.
*
* @throws ExpectationFailedException
*/
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
{
return $returnResult ? true : null;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is anything';
}
/**
* Counts the number of constraint elements.
*/
public function count(): int
{
return 0;
}
}
PK [Ӧ 7 src/Framework/Constraint/Exception/ExceptionMessage.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function sprintf;
use function strpos;
use Throwable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class ExceptionMessage extends Constraint
{
/**
* @var string
*/
private $expectedMessage;
public function __construct(string $expected)
{
$this->expectedMessage = $expected;
}
public function toString(): string
{
if ($this->expectedMessage === '') {
return 'exception message is empty';
}
return 'exception message contains ';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param Throwable $other
*/
protected function matches($other): bool
{
if ($this->expectedMessage === '') {
return $other->getMessage() === '';
}
return strpos((string) $other->getMessage(), $this->expectedMessage) !== false;
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
if ($this->expectedMessage === '') {
return sprintf(
"exception message is empty but is '%s'",
$other->getMessage()
);
}
return sprintf(
"exception message '%s' contains '%s'",
$other->getMessage(),
$this->expectedMessage
);
}
}
PK [R)܋ 0 src/Framework/Constraint/Exception/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function get_class;
use function sprintf;
use PHPUnit\Util\Filter;
use Throwable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class Exception extends Constraint
{
/**
* @var string
*/
private $className;
public function __construct(string $className)
{
$this->className = $className;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return sprintf(
'exception of type "%s"',
$this->className
);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return $other instanceof $this->className;
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
if ($other !== null) {
$message = '';
if ($other instanceof Throwable) {
$message = '. Message was: "' . $other->getMessage() . '" at'
. "\n" . Filter::getFilteredStacktrace($other);
}
return sprintf(
'exception of type "%s" matches expected exception "%s"%s',
get_class($other),
$this->className,
$message
);
}
return sprintf(
'exception of type "%s" is thrown',
$this->className
);
}
}
PK [ ' 4 src/Framework/Constraint/Exception/ExceptionCode.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function sprintf;
use Throwable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class ExceptionCode extends Constraint
{
/**
* @var int|string
*/
private $expectedCode;
/**
* @param int|string $expected
*/
public function __construct($expected)
{
$this->expectedCode = $expected;
}
public function toString(): string
{
return 'exception code is ';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param Throwable $other
*/
protected function matches($other): bool
{
return (string) $other->getCode() === (string) $this->expectedCode;
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function failureDescription($other): string
{
return sprintf(
'%s is equal to expected exception code %s',
$this->exporter()->export($other->getCode()),
$this->exporter()->export($this->expectedCode)
);
}
}
PK [S̨ H src/Framework/Constraint/Exception/ExceptionMessageRegularExpression.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function sprintf;
use Exception;
use PHPUnit\Util\RegularExpression as RegularExpressionUtil;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class ExceptionMessageRegularExpression extends Constraint
{
/**
* @var string
*/
private $expectedMessageRegExp;
public function __construct(string $expected)
{
$this->expectedMessageRegExp = $expected;
}
public function toString(): string
{
return 'exception message matches ';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param \PHPUnit\Framework\Exception $other
*
* @throws \PHPUnit\Framework\Exception
* @throws Exception
*/
protected function matches($other): bool
{
$match = RegularExpressionUtil::safeMatch($this->expectedMessageRegExp, $other->getMessage());
if ($match === false) {
throw new \PHPUnit\Framework\Exception(
"Invalid expected exception message regex given: '{$this->expectedMessageRegExp}'"
);
}
return $match === 1;
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*/
protected function failureDescription($other): string
{
return sprintf(
"exception message '%s' matches '%s'",
$other->getMessage(),
$this->expectedMessageRegExp
);
}
}
PK [y)@ B src/Framework/Constraint/String/StringMatchesFormatDescription.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use const DIRECTORY_SEPARATOR;
use function explode;
use function implode;
use function preg_match;
use function preg_quote;
use function preg_replace;
use function strtr;
use SebastianBergmann\Diff\Differ;
use SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class StringMatchesFormatDescription extends RegularExpression
{
/**
* @var string
*/
private $string;
public function __construct(string $string)
{
parent::__construct(
$this->createPatternFromFormat(
$this->convertNewlines($string)
)
);
$this->string = $string;
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return parent::matches(
$this->convertNewlines($other)
);
}
protected function failureDescription($other): string
{
return 'string matches format description';
}
protected function additionalFailureDescription($other): string
{
$from = explode("\n", $this->string);
$to = explode("\n", $this->convertNewlines($other));
foreach ($from as $index => $line) {
if (isset($to[$index]) && $line !== $to[$index]) {
$line = $this->createPatternFromFormat($line);
if (preg_match($line, $to[$index]) > 0) {
$from[$index] = $to[$index];
}
}
}
$this->string = implode("\n", $from);
$other = implode("\n", $to);
return (new Differ(new UnifiedDiffOutputBuilder("--- Expected\n+++ Actual\n")))->diff($this->string, $other);
}
private function createPatternFromFormat(string $string): string
{
$string = strtr(
preg_quote($string, '/'),
[
'%%' => '%',
'%e' => '\\' . DIRECTORY_SEPARATOR,
'%s' => '[^\r\n]+',
'%S' => '[^\r\n]*',
'%a' => '.+',
'%A' => '.*',
'%w' => '\s*',
'%i' => '[+-]?\d+',
'%d' => '\d+',
'%x' => '[0-9a-fA-F]+',
'%f' => '[+-]?\.?\d+\.?\d*(?:[Ee][+-]?\d+)?',
'%c' => '.',
]
);
return '/^' . $string . '$/s';
}
private function convertNewlines(string $text): string
{
return preg_replace('/\r\n/', "\n", $text);
}
}
PK [ 2 src/Framework/Constraint/String/StringContains.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function mb_stripos;
use function mb_strtolower;
use function sprintf;
use function strpos;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class StringContains extends Constraint
{
/**
* @var string
*/
private $string;
/**
* @var bool
*/
private $ignoreCase;
public function __construct(string $string, bool $ignoreCase = false)
{
$this->string = $string;
$this->ignoreCase = $ignoreCase;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
if ($this->ignoreCase) {
$string = mb_strtolower($this->string, 'UTF-8');
} else {
$string = $this->string;
}
return sprintf(
'contains "%s"',
$string
);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
if ('' === $this->string) {
return true;
}
if ($this->ignoreCase) {
/*
* We must use the multi byte safe version so we can accurately compare non latin upper characters with
* their lowercase equivalents.
*/
return mb_stripos($other, $this->string, 0, 'UTF-8') !== false;
}
/*
* Use the non multi byte safe functions to see if the string is contained in $other.
*
* This function is very fast and we don't care about the character position in the string.
*
* Additionally, we want this method to be binary safe so we can check if some binary data is in other binary
* data.
*/
return strpos($other, $this->string) !== false;
}
}
PK [D * src/Framework/Constraint/String/IsJson.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function json_decode;
use function json_last_error;
use function sprintf;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsJson extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is valid JSON';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
if ($other === '') {
return false;
}
json_decode($other);
if (json_last_error()) {
return false;
}
return true;
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function failureDescription($other): string
{
if ($other === '') {
return 'an empty string is valid JSON';
}
json_decode($other);
$error = (string) JsonMatchesErrorMessageProvider::determineJsonError(
(string) json_last_error()
);
return sprintf(
'%s is valid JSON (%s)',
$this->exporter()->shortenedExport($other),
$error
);
}
}
PK [ 5 src/Framework/Constraint/String/RegularExpression.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function preg_match;
use function sprintf;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
class RegularExpression extends Constraint
{
/**
* @var string
*/
private $pattern;
public function __construct(string $pattern)
{
$this->pattern = $pattern;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return sprintf(
'matches PCRE pattern "%s"',
$this->pattern
);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return preg_match($this->pattern, $other) > 0;
}
}
PK [QTC 2 src/Framework/Constraint/String/StringEndsWith.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function strlen;
use function substr;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class StringEndsWith extends Constraint
{
/**
* @var string
*/
private $suffix;
public function __construct(string $suffix)
{
$this->suffix = $suffix;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'ends with "' . $this->suffix . '"';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return substr($other, 0 - strlen($this->suffix)) === $this->suffix;
}
}
PK [ Xc% % 4 src/Framework/Constraint/String/StringStartsWith.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function strlen;
use function strpos;
use PHPUnit\Framework\InvalidArgumentException;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class StringStartsWith extends Constraint
{
/**
* @var string
*/
private $prefix;
public function __construct(string $prefix)
{
if (strlen($prefix) === 0) {
throw InvalidArgumentException::create(1, 'non-empty string');
}
$this->prefix = $prefix;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'starts with "' . $this->prefix . '"';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return strpos((string) $other, $this->prefix) === 0;
}
}
PK [v~. . < src/Framework/Constraint/Traversable/TraversableContains.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_array;
use function sprintf;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
abstract class TraversableContains extends Constraint
{
/**
* @var mixed
*/
private $value;
public function __construct($value)
{
$this->value = $value;
}
/**
* Returns a string representation of the constraint.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
return 'contains ' . $this->exporter()->export($this->value);
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function failureDescription($other): string
{
return sprintf(
'%s %s',
is_array($other) ? 'an array' : 'a traversable',
$this->toString()
);
}
protected function value()
{
return $this->value;
}
}
PK [ 4 src/Framework/Constraint/Traversable/ArrayHasKey.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function array_key_exists;
use function is_array;
use ArrayAccess;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class ArrayHasKey extends Constraint
{
/**
* @var int|string
*/
private $key;
/**
* @param int|string $key
*/
public function __construct($key)
{
$this->key = $key;
}
/**
* Returns a string representation of the constraint.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
return 'has the key ' . $this->exporter()->export($this->key);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
if (is_array($other)) {
return array_key_exists($this->key, $other);
}
if ($other instanceof ArrayAccess) {
return $other->offsetExists($this->key);
}
return false;
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*
* @param mixed $other evaluated value or object
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
protected function failureDescription($other): string
{
return 'an array ' . $this->toString();
}
}
PK [1 E src/Framework/Constraint/Traversable/TraversableContainsIdentical.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use SplObjectStorage;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class TraversableContainsIdentical extends TraversableContains
{
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
if ($other instanceof SplObjectStorage) {
return $other->contains($this->value());
}
foreach ($other as $element) {
if ($this->value() === $element) {
return true;
}
}
return false;
}
}
PK [H7 @ src/Framework/Constraint/Traversable/TraversableContainsOnly.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use PHPUnit\Framework\ExpectationFailedException;
use Traversable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class TraversableContainsOnly extends Constraint
{
/**
* @var Constraint
*/
private $constraint;
/**
* @var string
*/
private $type;
/**
* @throws \PHPUnit\Framework\Exception
*/
public function __construct(string $type, bool $isNativeType = true)
{
if ($isNativeType) {
$this->constraint = new IsType($type);
} else {
$this->constraint = new IsInstanceOf(
$type
);
}
$this->type = $type;
}
/**
* Evaluates the constraint for parameter $other.
*
* If $returnResult is set to false (the default), an exception is thrown
* in case of a failure. null is returned otherwise.
*
* If $returnResult is true, the result of the evaluation is returned as
* a boolean value instead: true in case of success, false in case of a
* failure.
*
* @param mixed|Traversable $other
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
{
$success = true;
foreach ($other as $item) {
if (!$this->constraint->evaluate($item, '', true)) {
$success = false;
break;
}
}
if ($returnResult) {
return $success;
}
if (!$success) {
$this->fail($other, $description);
}
return null;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'contains only values of type "' . $this->type . '"';
}
}
PK [g% dA A A src/Framework/Constraint/Traversable/TraversableContainsEqual.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use SplObjectStorage;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class TraversableContainsEqual extends TraversableContains
{
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
if ($other instanceof SplObjectStorage) {
return $other->contains($this->value());
}
foreach ($other as $element) {
/* @noinspection TypeUnsafeComparisonInspection */
if ($this->value() == $element) {
return true;
}
}
return false;
}
}
PK [cC
- src/Framework/Constraint/Equality/IsEqual.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_string;
use function sprintf;
use function strpos;
use function trim;
use PHPUnit\Framework\ExpectationFailedException;
use SebastianBergmann\Comparator\ComparisonFailure;
use SebastianBergmann\Comparator\Factory as ComparatorFactory;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsEqual extends Constraint
{
/**
* @var mixed
*/
private $value;
/**
* @var float
*/
private $delta;
/**
* @var bool
*/
private $canonicalize;
/**
* @var bool
*/
private $ignoreCase;
public function __construct($value, float $delta = 0.0, bool $canonicalize = false, bool $ignoreCase = false)
{
$this->value = $value;
$this->delta = $delta;
$this->canonicalize = $canonicalize;
$this->ignoreCase = $ignoreCase;
}
/**
* Evaluates the constraint for parameter $other.
*
* If $returnResult is set to false (the default), an exception is thrown
* in case of a failure. null is returned otherwise.
*
* If $returnResult is true, the result of the evaluation is returned as
* a boolean value instead: true in case of success, false in case of a
* failure.
*
* @throws ExpectationFailedException
*
* @return bool
*/
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
{
// If $this->value and $other are identical, they are also equal.
// This is the most common path and will allow us to skip
// initialization of all the comparators.
if ($this->value === $other) {
return true;
}
$comparatorFactory = ComparatorFactory::getInstance();
try {
$comparator = $comparatorFactory->getComparatorFor(
$this->value,
$other
);
$comparator->assertEquals(
$this->value,
$other,
$this->delta,
$this->canonicalize,
$this->ignoreCase
);
} catch (ComparisonFailure $f) {
if ($returnResult) {
return false;
}
throw new ExpectationFailedException(
trim($description . "\n" . $f->getMessage()),
$f
);
}
return true;
}
/**
* Returns a string representation of the constraint.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
$delta = '';
if (is_string($this->value)) {
if (strpos($this->value, "\n") !== false) {
return 'is equal to ';
}
return sprintf(
"is equal to '%s'",
$this->value
);
}
if ($this->delta != 0) {
$delta = sprintf(
' with delta <%F>',
$this->delta
);
}
return sprintf(
'is equal to %s%s',
$this->exporter()->export($this->value),
$delta
);
}
}
PK [BȮ 9 src/Framework/Constraint/Equality/IsEqualIgnoringCase.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_string;
use function sprintf;
use function strpos;
use function trim;
use PHPUnit\Framework\ExpectationFailedException;
use SebastianBergmann\Comparator\ComparisonFailure;
use SebastianBergmann\Comparator\Factory as ComparatorFactory;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsEqualIgnoringCase extends Constraint
{
/**
* @var mixed
*/
private $value;
public function __construct($value)
{
$this->value = $value;
}
/**
* Evaluates the constraint for parameter $other.
*
* If $returnResult is set to false (the default), an exception is thrown
* in case of a failure. null is returned otherwise.
*
* If $returnResult is true, the result of the evaluation is returned as
* a boolean value instead: true in case of success, false in case of a
* failure.
*
* @throws ExpectationFailedException
*/
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
{
// If $this->value and $other are identical, they are also equal.
// This is the most common path and will allow us to skip
// initialization of all the comparators.
if ($this->value === $other) {
return true;
}
$comparatorFactory = ComparatorFactory::getInstance();
try {
$comparator = $comparatorFactory->getComparatorFor(
$this->value,
$other
);
$comparator->assertEquals(
$this->value,
$other,
0.0,
false,
true
);
} catch (ComparisonFailure $f) {
if ($returnResult) {
return false;
}
throw new ExpectationFailedException(
trim($description . "\n" . $f->getMessage()),
$f
);
}
return true;
}
/**
* Returns a string representation of the constraint.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
if (is_string($this->value)) {
if (strpos($this->value, "\n") !== false) {
return 'is equal to ';
}
return sprintf(
"is equal to '%s'",
$this->value
);
}
return sprintf(
'is equal to %s',
$this->exporter()->export($this->value)
);
}
}
PK [`@p ; src/Framework/Constraint/Equality/IsEqualCanonicalizing.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_string;
use function sprintf;
use function strpos;
use function trim;
use PHPUnit\Framework\ExpectationFailedException;
use SebastianBergmann\Comparator\ComparisonFailure;
use SebastianBergmann\Comparator\Factory as ComparatorFactory;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsEqualCanonicalizing extends Constraint
{
/**
* @var mixed
*/
private $value;
public function __construct($value)
{
$this->value = $value;
}
/**
* Evaluates the constraint for parameter $other.
*
* If $returnResult is set to false (the default), an exception is thrown
* in case of a failure. null is returned otherwise.
*
* If $returnResult is true, the result of the evaluation is returned as
* a boolean value instead: true in case of success, false in case of a
* failure.
*
* @throws ExpectationFailedException
*/
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
{
// If $this->value and $other are identical, they are also equal.
// This is the most common path and will allow us to skip
// initialization of all the comparators.
if ($this->value === $other) {
return true;
}
$comparatorFactory = ComparatorFactory::getInstance();
try {
$comparator = $comparatorFactory->getComparatorFor(
$this->value,
$other
);
$comparator->assertEquals(
$this->value,
$other,
0.0,
true,
false
);
} catch (ComparisonFailure $f) {
if ($returnResult) {
return false;
}
throw new ExpectationFailedException(
trim($description . "\n" . $f->getMessage()),
$f
);
}
return true;
}
/**
* Returns a string representation of the constraint.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
if (is_string($this->value)) {
if (strpos($this->value, "\n") !== false) {
return 'is equal to ';
}
return sprintf(
"is equal to '%s'",
$this->value
);
}
return sprintf(
'is equal to %s',
$this->exporter()->export($this->value)
);
}
}
PK [_Ɯ
6 src/Framework/Constraint/Equality/IsEqualWithDelta.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function sprintf;
use function trim;
use PHPUnit\Framework\ExpectationFailedException;
use SebastianBergmann\Comparator\ComparisonFailure;
use SebastianBergmann\Comparator\Factory as ComparatorFactory;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsEqualWithDelta extends Constraint
{
/**
* @var mixed
*/
private $value;
/**
* @var float
*/
private $delta;
public function __construct($value, float $delta)
{
$this->value = $value;
$this->delta = $delta;
}
/**
* Evaluates the constraint for parameter $other.
*
* If $returnResult is set to false (the default), an exception is thrown
* in case of a failure. null is returned otherwise.
*
* If $returnResult is true, the result of the evaluation is returned as
* a boolean value instead: true in case of success, false in case of a
* failure.
*
* @throws ExpectationFailedException
*/
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
{
// If $this->value and $other are identical, they are also equal.
// This is the most common path and will allow us to skip
// initialization of all the comparators.
if ($this->value === $other) {
return true;
}
$comparatorFactory = ComparatorFactory::getInstance();
try {
$comparator = $comparatorFactory->getComparatorFor(
$this->value,
$other
);
$comparator->assertEquals(
$this->value,
$other,
$this->delta
);
} catch (ComparisonFailure $f) {
if ($returnResult) {
return false;
}
throw new ExpectationFailedException(
trim($description . "\n" . $f->getMessage()),
$f
);
}
return true;
}
/**
* Returns a string representation of the constraint.
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function toString(): string
{
return sprintf(
'is equal to %s with delta <%F>',
$this->exporter()->export($this->value),
$this->delta
);
}
}
PK [@lϔ * src/Framework/Constraint/Math/IsFinite.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_finite;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsFinite extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is finite';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return is_finite($other);
}
}
PK [k , src/Framework/Constraint/Math/IsInfinite.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_infinite;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsInfinite extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is infinite';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return is_infinite($other);
}
}
PK [ޜ ' src/Framework/Constraint/Math/IsNan.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_nan;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class IsNan extends Constraint
{
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
return 'is nan';
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @param mixed $other value or object to evaluate
*/
protected function matches($other): bool
{
return is_nan($other);
}
}
PK [ŝ' ' src/TextUI/TestRunner.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use const PHP_EOL;
use const PHP_SAPI;
use const PHP_VERSION;
use function array_diff;
use function array_map;
use function array_merge;
use function assert;
use function class_exists;
use function count;
use function dirname;
use function file_put_contents;
use function htmlspecialchars;
use function is_array;
use function is_int;
use function is_string;
use function mt_srand;
use function range;
use function realpath;
use function sort;
use function sprintf;
use function time;
use PHPUnit\Framework\Exception;
use PHPUnit\Framework\TestResult;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Runner\AfterLastTestHook;
use PHPUnit\Runner\BaseTestRunner;
use PHPUnit\Runner\BeforeFirstTestHook;
use PHPUnit\Runner\DefaultTestResultCache;
use PHPUnit\Runner\Extension\ExtensionHandler;
use PHPUnit\Runner\Filter\ExcludeGroupFilterIterator;
use PHPUnit\Runner\Filter\Factory;
use PHPUnit\Runner\Filter\IncludeGroupFilterIterator;
use PHPUnit\Runner\Filter\NameFilterIterator;
use PHPUnit\Runner\Hook;
use PHPUnit\Runner\NullTestResultCache;
use PHPUnit\Runner\ResultCacheExtension;
use PHPUnit\Runner\StandardTestSuiteLoader;
use PHPUnit\Runner\TestHook;
use PHPUnit\Runner\TestListenerAdapter;
use PHPUnit\Runner\TestSuiteLoader;
use PHPUnit\Runner\TestSuiteSorter;
use PHPUnit\Runner\Version;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\FilterMapper;
use PHPUnit\TextUI\XmlConfiguration\Configuration;
use PHPUnit\TextUI\XmlConfiguration\Loader;
use PHPUnit\TextUI\XmlConfiguration\PhpHandler;
use PHPUnit\Util\Filesystem;
use PHPUnit\Util\Log\JUnit;
use PHPUnit\Util\Log\TeamCity;
use PHPUnit\Util\Printer;
use PHPUnit\Util\TestDox\CliTestDoxPrinter;
use PHPUnit\Util\TestDox\HtmlResultPrinter;
use PHPUnit\Util\TestDox\TextResultPrinter;
use PHPUnit\Util\TestDox\XmlResultPrinter;
use PHPUnit\Util\XdebugFilterScriptGenerator;
use PHPUnit\Util\Xml\SchemaDetector;
use ReflectionClass;
use ReflectionException;
use SebastianBergmann\CodeCoverage\CodeCoverage;
use SebastianBergmann\CodeCoverage\Driver\Selector;
use SebastianBergmann\CodeCoverage\Exception as CodeCoverageException;
use SebastianBergmann\CodeCoverage\Filter as CodeCoverageFilter;
use SebastianBergmann\CodeCoverage\Report\Clover as CloverReport;
use SebastianBergmann\CodeCoverage\Report\Cobertura as CoberturaReport;
use SebastianBergmann\CodeCoverage\Report\Crap4j as Crap4jReport;
use SebastianBergmann\CodeCoverage\Report\Html\Facade as HtmlReport;
use SebastianBergmann\CodeCoverage\Report\PHP as PhpReport;
use SebastianBergmann\CodeCoverage\Report\Text as TextReport;
use SebastianBergmann\CodeCoverage\Report\Xml\Facade as XmlReport;
use SebastianBergmann\Comparator\Comparator;
use SebastianBergmann\Environment\Runtime;
use SebastianBergmann\Invoker\Invoker;
use SebastianBergmann\Timer\Timer;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TestRunner extends BaseTestRunner
{
public const SUCCESS_EXIT = 0;
public const FAILURE_EXIT = 1;
public const EXCEPTION_EXIT = 2;
/**
* @var CodeCoverageFilter
*/
private $codeCoverageFilter;
/**
* @var TestSuiteLoader
*/
private $loader;
/**
* @var ResultPrinter
*/
private $printer;
/**
* @var bool
*/
private $messagePrinted = false;
/**
* @var Hook[]
*/
private $extensions = [];
/**
* @var Timer
*/
private $timer;
public function __construct(TestSuiteLoader $loader = null, CodeCoverageFilter $filter = null)
{
if ($filter === null) {
$filter = new CodeCoverageFilter;
}
$this->codeCoverageFilter = $filter;
$this->loader = $loader;
$this->timer = new Timer;
}
/**
* @throws \PHPUnit\Runner\Exception
* @throws \PHPUnit\TextUI\XmlConfiguration\Exception
* @throws Exception
*/
public function run(TestSuite $suite, array $arguments = [], array $warnings = [], bool $exit = true): TestResult
{
if (isset($arguments['configuration'])) {
$GLOBALS['__PHPUNIT_CONFIGURATION_FILE'] = $arguments['configuration'];
}
$this->handleConfiguration($arguments);
$warnings = array_merge($warnings, $arguments['warnings']);
if (is_int($arguments['columns']) && $arguments['columns'] < 16) {
$arguments['columns'] = 16;
$tooFewColumnsRequested = true;
}
if (isset($arguments['bootstrap'])) {
$GLOBALS['__PHPUNIT_BOOTSTRAP'] = $arguments['bootstrap'];
}
if ($arguments['backupGlobals'] === true) {
$suite->setBackupGlobals(true);
}
if ($arguments['backupStaticAttributes'] === true) {
$suite->setBackupStaticAttributes(true);
}
if ($arguments['beStrictAboutChangesToGlobalState'] === true) {
$suite->setBeStrictAboutChangesToGlobalState(true);
}
if ($arguments['executionOrder'] === TestSuiteSorter::ORDER_RANDOMIZED) {
mt_srand($arguments['randomOrderSeed']);
}
if ($arguments['cacheResult']) {
if (!isset($arguments['cacheResultFile'])) {
if (isset($arguments['configurationObject'])) {
assert($arguments['configurationObject'] instanceof Configuration);
$cacheLocation = $arguments['configurationObject']->filename();
} else {
$cacheLocation = $_SERVER['PHP_SELF'];
}
$arguments['cacheResultFile'] = null;
$cacheResultFile = realpath($cacheLocation);
if ($cacheResultFile !== false) {
$arguments['cacheResultFile'] = dirname($cacheResultFile);
}
}
$cache = new DefaultTestResultCache($arguments['cacheResultFile']);
$this->addExtension(new ResultCacheExtension($cache));
}
if ($arguments['executionOrder'] !== TestSuiteSorter::ORDER_DEFAULT || $arguments['executionOrderDefects'] !== TestSuiteSorter::ORDER_DEFAULT || $arguments['resolveDependencies']) {
$cache = $cache ?? new NullTestResultCache;
$cache->load();
$sorter = new TestSuiteSorter($cache);
$sorter->reorderTestsInSuite($suite, $arguments['executionOrder'], $arguments['resolveDependencies'], $arguments['executionOrderDefects']);
$originalExecutionOrder = $sorter->getOriginalExecutionOrder();
unset($sorter);
}
if (is_int($arguments['repeat']) && $arguments['repeat'] > 0) {
$_suite = new TestSuite;
/* @noinspection PhpUnusedLocalVariableInspection */
foreach (range(1, $arguments['repeat']) as $step) {
$_suite->addTest($suite);
}
$suite = $_suite;
unset($_suite);
}
$result = $this->createTestResult();
$listener = new TestListenerAdapter;
$listenerNeeded = false;
foreach ($this->extensions as $extension) {
if ($extension instanceof TestHook) {
$listener->add($extension);
$listenerNeeded = true;
}
}
if ($listenerNeeded) {
$result->addListener($listener);
}
unset($listener, $listenerNeeded);
if ($arguments['convertDeprecationsToExceptions']) {
$result->convertDeprecationsToExceptions(true);
}
if (!$arguments['convertErrorsToExceptions']) {
$result->convertErrorsToExceptions(false);
}
if (!$arguments['convertNoticesToExceptions']) {
$result->convertNoticesToExceptions(false);
}
if (!$arguments['convertWarningsToExceptions']) {
$result->convertWarningsToExceptions(false);
}
if ($arguments['stopOnError']) {
$result->stopOnError(true);
}
if ($arguments['stopOnFailure']) {
$result->stopOnFailure(true);
}
if ($arguments['stopOnWarning']) {
$result->stopOnWarning(true);
}
if ($arguments['stopOnIncomplete']) {
$result->stopOnIncomplete(true);
}
if ($arguments['stopOnRisky']) {
$result->stopOnRisky(true);
}
if ($arguments['stopOnSkipped']) {
$result->stopOnSkipped(true);
}
if ($arguments['stopOnDefect']) {
$result->stopOnDefect(true);
}
if ($arguments['registerMockObjectsFromTestArgumentsRecursively']) {
$result->setRegisterMockObjectsFromTestArgumentsRecursively(true);
}
if ($this->printer === null) {
if (isset($arguments['printer'])) {
if ($arguments['printer'] instanceof ResultPrinter) {
$this->printer = $arguments['printer'];
} elseif (is_string($arguments['printer']) && class_exists($arguments['printer'], false)) {
try {
$reflector = new ReflectionClass($arguments['printer']);
if ($reflector->implementsInterface(ResultPrinter::class)) {
$this->printer = $this->createPrinter($arguments['printer'], $arguments);
}
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
}
} else {
$this->printer = $this->createPrinter(DefaultResultPrinter::class, $arguments);
}
}
if (isset($originalExecutionOrder) && $this->printer instanceof CliTestDoxPrinter) {
assert($this->printer instanceof CliTestDoxPrinter);
$this->printer->setOriginalExecutionOrder($originalExecutionOrder);
$this->printer->setShowProgressAnimation(!$arguments['noInteraction']);
}
$this->write(Version::getVersionString() . "\n");
foreach ($arguments['listeners'] as $listener) {
$result->addListener($listener);
}
$result->addListener($this->printer);
$coverageFilterFromConfigurationFile = false;
$coverageFilterFromOption = false;
$codeCoverageReports = 0;
if (isset($arguments['testdoxHTMLFile'])) {
$result->addListener(
new HtmlResultPrinter(
$arguments['testdoxHTMLFile'],
$arguments['testdoxGroups'],
$arguments['testdoxExcludeGroups']
)
);
}
if (isset($arguments['testdoxTextFile'])) {
$result->addListener(
new TextResultPrinter(
$arguments['testdoxTextFile'],
$arguments['testdoxGroups'],
$arguments['testdoxExcludeGroups']
)
);
}
if (isset($arguments['testdoxXMLFile'])) {
$result->addListener(
new XmlResultPrinter(
$arguments['testdoxXMLFile']
)
);
}
if (isset($arguments['teamcityLogfile'])) {
$result->addListener(
new TeamCity($arguments['teamcityLogfile'])
);
}
if (isset($arguments['junitLogfile'])) {
$result->addListener(
new JUnit(
$arguments['junitLogfile'],
$arguments['reportUselessTests']
)
);
}
if (isset($arguments['coverageClover'])) {
$codeCoverageReports++;
}
if (isset($arguments['coverageCobertura'])) {
$codeCoverageReports++;
}
if (isset($arguments['coverageCrap4J'])) {
$codeCoverageReports++;
}
if (isset($arguments['coverageHtml'])) {
$codeCoverageReports++;
}
if (isset($arguments['coveragePHP'])) {
$codeCoverageReports++;
}
if (isset($arguments['coverageText'])) {
$codeCoverageReports++;
}
if (isset($arguments['coverageXml'])) {
$codeCoverageReports++;
}
if ($codeCoverageReports > 0 || isset($arguments['xdebugFilterFile'])) {
if (isset($arguments['coverageFilter'])) {
if (!is_array($arguments['coverageFilter'])) {
$coverageFilterDirectories = [$arguments['coverageFilter']];
} else {
$coverageFilterDirectories = $arguments['coverageFilter'];
}
foreach ($coverageFilterDirectories as $coverageFilterDirectory) {
$this->codeCoverageFilter->includeDirectory($coverageFilterDirectory);
}
$coverageFilterFromOption = true;
}
if (isset($arguments['configurationObject'])) {
assert($arguments['configurationObject'] instanceof Configuration);
$codeCoverageConfiguration = $arguments['configurationObject']->codeCoverage();
if ($codeCoverageConfiguration->hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport()) {
$coverageFilterFromConfigurationFile = true;
(new FilterMapper)->map(
$this->codeCoverageFilter,
$codeCoverageConfiguration
);
}
}
}
if ($codeCoverageReports > 0) {
try {
if (isset($codeCoverageConfiguration) &&
($codeCoverageConfiguration->pathCoverage() || (isset($arguments['pathCoverage']) && $arguments['pathCoverage'] === true))) {
$codeCoverageDriver = (new Selector)->forLineAndPathCoverage($this->codeCoverageFilter);
} else {
$codeCoverageDriver = (new Selector)->forLineCoverage($this->codeCoverageFilter);
}
$codeCoverage = new CodeCoverage(
$codeCoverageDriver,
$this->codeCoverageFilter
);
if (isset($codeCoverageConfiguration) && $codeCoverageConfiguration->hasCacheDirectory()) {
$codeCoverage->cacheStaticAnalysis($codeCoverageConfiguration->cacheDirectory()->path());
}
if (isset($arguments['coverageCacheDirectory'])) {
$codeCoverage->cacheStaticAnalysis($arguments['coverageCacheDirectory']);
}
$codeCoverage->excludeSubclassesOfThisClassFromUnintentionallyCoveredCodeCheck(Comparator::class);
if ($arguments['strictCoverage']) {
$codeCoverage->enableCheckForUnintentionallyCoveredCode();
}
if (isset($arguments['ignoreDeprecatedCodeUnitsFromCodeCoverage'])) {
if ($arguments['ignoreDeprecatedCodeUnitsFromCodeCoverage']) {
$codeCoverage->ignoreDeprecatedCode();
} else {
$codeCoverage->doNotIgnoreDeprecatedCode();
}
}
if (isset($arguments['disableCodeCoverageIgnore'])) {
if ($arguments['disableCodeCoverageIgnore']) {
$codeCoverage->disableAnnotationsForIgnoringCode();
} else {
$codeCoverage->enableAnnotationsForIgnoringCode();
}
}
if (isset($arguments['configurationObject'])) {
$codeCoverageConfiguration = $arguments['configurationObject']->codeCoverage();
if ($codeCoverageConfiguration->hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport()) {
if ($codeCoverageConfiguration->includeUncoveredFiles()) {
$codeCoverage->includeUncoveredFiles();
} else {
$codeCoverage->excludeUncoveredFiles();
}
if ($codeCoverageConfiguration->processUncoveredFiles()) {
$codeCoverage->processUncoveredFiles();
} else {
$codeCoverage->doNotProcessUncoveredFiles();
}
}
}
if ($this->codeCoverageFilter->isEmpty()) {
if (!$coverageFilterFromConfigurationFile && !$coverageFilterFromOption) {
$warnings[] = 'No filter is configured, code coverage will not be processed';
} else {
$warnings[] = 'Incorrect filter configuration, code coverage will not be processed';
}
unset($codeCoverage);
}
} catch (CodeCoverageException $e) {
$warnings[] = $e->getMessage();
}
}
if ($arguments['verbose']) {
if (PHP_SAPI === 'phpdbg') {
$this->writeMessage('Runtime', 'PHPDBG ' . PHP_VERSION);
} else {
$runtime = 'PHP ' . PHP_VERSION;
if (isset($codeCoverageDriver)) {
$runtime .= ' with ' . $codeCoverageDriver->nameAndVersion();
}
$this->writeMessage('Runtime', $runtime);
}
if (isset($arguments['configurationObject'])) {
assert($arguments['configurationObject'] instanceof Configuration);
$this->writeMessage(
'Configuration',
$arguments['configurationObject']->filename()
);
}
foreach ($arguments['loadedExtensions'] as $extension) {
$this->writeMessage(
'Extension',
$extension
);
}
foreach ($arguments['notLoadedExtensions'] as $extension) {
$this->writeMessage(
'Extension',
$extension
);
}
}
if ($arguments['executionOrder'] === TestSuiteSorter::ORDER_RANDOMIZED) {
$this->writeMessage(
'Random Seed',
(string) $arguments['randomOrderSeed']
);
}
if (isset($tooFewColumnsRequested)) {
$warnings[] = 'Less than 16 columns requested, number of columns set to 16';
}
if ((new Runtime)->discardsComments()) {
$warnings[] = 'opcache.save_comments=0 set; annotations will not work';
}
if (isset($arguments['conflictBetweenPrinterClassAndTestdox'])) {
$warnings[] = 'Directives printerClass and testdox are mutually exclusive';
}
$warnings = array_merge($warnings, $suite->warnings());
sort($warnings);
foreach ($warnings as $warning) {
$this->writeMessage('Warning', $warning);
}
if (isset($arguments['configurationObject'])) {
assert($arguments['configurationObject'] instanceof Configuration);
if ($arguments['configurationObject']->hasValidationErrors()) {
if ((new SchemaDetector)->detect($arguments['configurationObject']->filename())->detected()) {
$this->writeMessage('Warning', 'Your XML configuration validates against a deprecated schema.');
$this->writeMessage('Suggestion', 'Migrate your XML configuration using "--migrate-configuration"!');
} else {
$this->write(
"\n Warning - The configuration file did not pass validation!\n The following problems have been detected:\n"
);
$this->write($arguments['configurationObject']->validationErrors());
$this->write("\n Test results may not be as expected.\n\n");
}
}
}
if (isset($arguments['xdebugFilterFile'], $codeCoverageConfiguration)) {
$this->write(PHP_EOL . 'Please note that --dump-xdebug-filter and --prepend are deprecated and will be removed in PHPUnit 10.' . PHP_EOL);
$script = (new XdebugFilterScriptGenerator)->generate($codeCoverageConfiguration);
if ($arguments['xdebugFilterFile'] !== 'php://stdout' && $arguments['xdebugFilterFile'] !== 'php://stderr' && !Filesystem::createDirectory(dirname($arguments['xdebugFilterFile']))) {
$this->write(sprintf('Cannot write Xdebug filter script to %s ' . PHP_EOL, $arguments['xdebugFilterFile']));
exit(self::EXCEPTION_EXIT);
}
file_put_contents($arguments['xdebugFilterFile'], $script);
$this->write(sprintf('Wrote Xdebug filter script to %s ' . PHP_EOL . PHP_EOL, $arguments['xdebugFilterFile']));
exit(self::SUCCESS_EXIT);
}
$this->write("\n");
if (isset($codeCoverage)) {
$result->setCodeCoverage($codeCoverage);
}
$result->beStrictAboutTestsThatDoNotTestAnything($arguments['reportUselessTests']);
$result->beStrictAboutOutputDuringTests($arguments['disallowTestOutput']);
$result->beStrictAboutTodoAnnotatedTests($arguments['disallowTodoAnnotatedTests']);
$result->beStrictAboutResourceUsageDuringSmallTests($arguments['beStrictAboutResourceUsageDuringSmallTests']);
if ($arguments['enforceTimeLimit'] === true && !(new Invoker)->canInvokeWithTimeout()) {
$this->writeMessage('Error', 'PHP extension pcntl is required for enforcing time limits');
}
$result->enforceTimeLimit($arguments['enforceTimeLimit']);
$result->setDefaultTimeLimit($arguments['defaultTimeLimit']);
$result->setTimeoutForSmallTests($arguments['timeoutForSmallTests']);
$result->setTimeoutForMediumTests($arguments['timeoutForMediumTests']);
$result->setTimeoutForLargeTests($arguments['timeoutForLargeTests']);
if (isset($arguments['forceCoversAnnotation']) && $arguments['forceCoversAnnotation'] === true) {
$result->forceCoversAnnotation();
}
$this->processSuiteFilters($suite, $arguments);
$suite->setRunTestInSeparateProcess($arguments['processIsolation']);
foreach ($this->extensions as $extension) {
if ($extension instanceof BeforeFirstTestHook) {
$extension->executeBeforeFirstTest();
}
}
$suite->run($result);
foreach ($this->extensions as $extension) {
if ($extension instanceof AfterLastTestHook) {
$extension->executeAfterLastTest();
}
}
$result->flushListeners();
$this->printer->printResult($result);
if (isset($codeCoverage)) {
if (isset($arguments['coverageClover'])) {
$this->codeCoverageGenerationStart('Clover XML');
try {
$writer = new CloverReport;
$writer->process($codeCoverage, $arguments['coverageClover']);
$this->codeCoverageGenerationSucceeded();
unset($writer);
} catch (CodeCoverageException $e) {
$this->codeCoverageGenerationFailed($e);
}
}
if (isset($arguments['coverageCobertura'])) {
$this->codeCoverageGenerationStart('Cobertura XML');
try {
$writer = new CoberturaReport;
$writer->process($codeCoverage, $arguments['coverageCobertura']);
$this->codeCoverageGenerationSucceeded();
unset($writer);
} catch (CodeCoverageException $e) {
$this->codeCoverageGenerationFailed($e);
}
}
if (isset($arguments['coverageCrap4J'])) {
$this->codeCoverageGenerationStart('Crap4J XML');
try {
$writer = new Crap4jReport($arguments['crap4jThreshold']);
$writer->process($codeCoverage, $arguments['coverageCrap4J']);
$this->codeCoverageGenerationSucceeded();
unset($writer);
} catch (CodeCoverageException $e) {
$this->codeCoverageGenerationFailed($e);
}
}
if (isset($arguments['coverageHtml'])) {
$this->codeCoverageGenerationStart('HTML');
try {
$writer = new HtmlReport(
$arguments['reportLowUpperBound'],
$arguments['reportHighLowerBound'],
sprintf(
' and PHPUnit %s',
Version::id()
)
);
$writer->process($codeCoverage, $arguments['coverageHtml']);
$this->codeCoverageGenerationSucceeded();
unset($writer);
} catch (CodeCoverageException $e) {
$this->codeCoverageGenerationFailed($e);
}
}
if (isset($arguments['coveragePHP'])) {
$this->codeCoverageGenerationStart('PHP');
try {
$writer = new PhpReport;
$writer->process($codeCoverage, $arguments['coveragePHP']);
$this->codeCoverageGenerationSucceeded();
unset($writer);
} catch (CodeCoverageException $e) {
$this->codeCoverageGenerationFailed($e);
}
}
if (isset($arguments['coverageText'])) {
if ($arguments['coverageText'] === 'php://stdout') {
$outputStream = $this->printer;
$colors = $arguments['colors'] && $arguments['colors'] !== DefaultResultPrinter::COLOR_NEVER;
} else {
$outputStream = new Printer($arguments['coverageText']);
$colors = false;
}
$processor = new TextReport(
$arguments['reportLowUpperBound'],
$arguments['reportHighLowerBound'],
$arguments['coverageTextShowUncoveredFiles'],
$arguments['coverageTextShowOnlySummary']
);
$outputStream->write(
$processor->process($codeCoverage, $colors)
);
}
if (isset($arguments['coverageXml'])) {
$this->codeCoverageGenerationStart('PHPUnit XML');
try {
$writer = new XmlReport(Version::id());
$writer->process($codeCoverage, $arguments['coverageXml']);
$this->codeCoverageGenerationSucceeded();
unset($writer);
} catch (CodeCoverageException $e) {
$this->codeCoverageGenerationFailed($e);
}
}
}
if ($exit) {
if (isset($arguments['failOnEmptyTestSuite']) && $arguments['failOnEmptyTestSuite'] === true && count($result) === 0) {
exit(self::FAILURE_EXIT);
}
if ($result->wasSuccessfulIgnoringWarnings()) {
if ($arguments['failOnRisky'] && !$result->allHarmless()) {
exit(self::FAILURE_EXIT);
}
if ($arguments['failOnWarning'] && $result->warningCount() > 0) {
exit(self::FAILURE_EXIT);
}
if ($arguments['failOnIncomplete'] && $result->notImplementedCount() > 0) {
exit(self::FAILURE_EXIT);
}
if ($arguments['failOnSkipped'] && $result->skippedCount() > 0) {
exit(self::FAILURE_EXIT);
}
exit(self::SUCCESS_EXIT);
}
if ($result->errorCount() > 0) {
exit(self::EXCEPTION_EXIT);
}
if ($result->failureCount() > 0) {
exit(self::FAILURE_EXIT);
}
}
return $result;
}
/**
* Returns the loader to be used.
*/
public function getLoader(): TestSuiteLoader
{
if ($this->loader === null) {
$this->loader = new StandardTestSuiteLoader;
}
return $this->loader;
}
public function addExtension(Hook $extension): void
{
$this->extensions[] = $extension;
}
/**
* Override to define how to handle a failed loading of
* a test suite.
*/
protected function runFailed(string $message): void
{
$this->write($message . PHP_EOL);
exit(self::FAILURE_EXIT);
}
private function createTestResult(): TestResult
{
return new TestResult;
}
private function write(string $buffer): void
{
if (PHP_SAPI !== 'cli' && PHP_SAPI !== 'phpdbg') {
$buffer = htmlspecialchars($buffer);
}
if ($this->printer !== null) {
$this->printer->write($buffer);
} else {
print $buffer;
}
}
/**
* @throws \PHPUnit\TextUI\XmlConfiguration\Exception
* @throws Exception
*/
private function handleConfiguration(array &$arguments): void
{
if (!isset($arguments['configurationObject']) && isset($arguments['configuration'])) {
$arguments['configurationObject'] = (new Loader)->load($arguments['configuration']);
}
if (!isset($arguments['warnings'])) {
$arguments['warnings'] = [];
}
$arguments['debug'] = $arguments['debug'] ?? false;
$arguments['filter'] = $arguments['filter'] ?? false;
$arguments['listeners'] = $arguments['listeners'] ?? [];
if (isset($arguments['configurationObject'])) {
(new PhpHandler)->handle($arguments['configurationObject']->php());
$codeCoverageConfiguration = $arguments['configurationObject']->codeCoverage();
if (!isset($arguments['noCoverage'])) {
if (!isset($arguments['coverageClover']) && $codeCoverageConfiguration->hasClover()) {
$arguments['coverageClover'] = $codeCoverageConfiguration->clover()->target()->path();
}
if (!isset($arguments['coverageCobertura']) && $codeCoverageConfiguration->hasCobertura()) {
$arguments['coverageCobertura'] = $codeCoverageConfiguration->cobertura()->target()->path();
}
if (!isset($arguments['coverageCrap4J']) && $codeCoverageConfiguration->hasCrap4j()) {
$arguments['coverageCrap4J'] = $codeCoverageConfiguration->crap4j()->target()->path();
if (!isset($arguments['crap4jThreshold'])) {
$arguments['crap4jThreshold'] = $codeCoverageConfiguration->crap4j()->threshold();
}
}
if (!isset($arguments['coverageHtml']) && $codeCoverageConfiguration->hasHtml()) {
$arguments['coverageHtml'] = $codeCoverageConfiguration->html()->target()->path();
if (!isset($arguments['reportLowUpperBound'])) {
$arguments['reportLowUpperBound'] = $codeCoverageConfiguration->html()->lowUpperBound();
}
if (!isset($arguments['reportHighLowerBound'])) {
$arguments['reportHighLowerBound'] = $codeCoverageConfiguration->html()->highLowerBound();
}
}
if (!isset($arguments['coveragePHP']) && $codeCoverageConfiguration->hasPhp()) {
$arguments['coveragePHP'] = $codeCoverageConfiguration->php()->target()->path();
}
if (!isset($arguments['coverageText']) && $codeCoverageConfiguration->hasText()) {
$arguments['coverageText'] = $codeCoverageConfiguration->text()->target()->path();
$arguments['coverageTextShowUncoveredFiles'] = $codeCoverageConfiguration->text()->showUncoveredFiles();
$arguments['coverageTextShowOnlySummary'] = $codeCoverageConfiguration->text()->showOnlySummary();
}
if (!isset($arguments['coverageXml']) && $codeCoverageConfiguration->hasXml()) {
$arguments['coverageXml'] = $codeCoverageConfiguration->xml()->target()->path();
}
}
$phpunitConfiguration = $arguments['configurationObject']->phpunit();
$arguments['backupGlobals'] = $arguments['backupGlobals'] ?? $phpunitConfiguration->backupGlobals();
$arguments['backupStaticAttributes'] = $arguments['backupStaticAttributes'] ?? $phpunitConfiguration->backupStaticAttributes();
$arguments['beStrictAboutChangesToGlobalState'] = $arguments['beStrictAboutChangesToGlobalState'] ?? $phpunitConfiguration->beStrictAboutChangesToGlobalState();
$arguments['cacheResult'] = $arguments['cacheResult'] ?? $phpunitConfiguration->cacheResult();
$arguments['colors'] = $arguments['colors'] ?? $phpunitConfiguration->colors();
$arguments['convertDeprecationsToExceptions'] = $arguments['convertDeprecationsToExceptions'] ?? $phpunitConfiguration->convertDeprecationsToExceptions();
$arguments['convertErrorsToExceptions'] = $arguments['convertErrorsToExceptions'] ?? $phpunitConfiguration->convertErrorsToExceptions();
$arguments['convertNoticesToExceptions'] = $arguments['convertNoticesToExceptions'] ?? $phpunitConfiguration->convertNoticesToExceptions();
$arguments['convertWarningsToExceptions'] = $arguments['convertWarningsToExceptions'] ?? $phpunitConfiguration->convertWarningsToExceptions();
$arguments['processIsolation'] = $arguments['processIsolation'] ?? $phpunitConfiguration->processIsolation();
$arguments['stopOnDefect'] = $arguments['stopOnDefect'] ?? $phpunitConfiguration->stopOnDefect();
$arguments['stopOnError'] = $arguments['stopOnError'] ?? $phpunitConfiguration->stopOnError();
$arguments['stopOnFailure'] = $arguments['stopOnFailure'] ?? $phpunitConfiguration->stopOnFailure();
$arguments['stopOnWarning'] = $arguments['stopOnWarning'] ?? $phpunitConfiguration->stopOnWarning();
$arguments['stopOnIncomplete'] = $arguments['stopOnIncomplete'] ?? $phpunitConfiguration->stopOnIncomplete();
$arguments['stopOnRisky'] = $arguments['stopOnRisky'] ?? $phpunitConfiguration->stopOnRisky();
$arguments['stopOnSkipped'] = $arguments['stopOnSkipped'] ?? $phpunitConfiguration->stopOnSkipped();
$arguments['failOnEmptyTestSuite'] = $arguments['failOnEmptyTestSuite'] ?? $phpunitConfiguration->failOnEmptyTestSuite();
$arguments['failOnIncomplete'] = $arguments['failOnIncomplete'] ?? $phpunitConfiguration->failOnIncomplete();
$arguments['failOnRisky'] = $arguments['failOnRisky'] ?? $phpunitConfiguration->failOnRisky();
$arguments['failOnSkipped'] = $arguments['failOnSkipped'] ?? $phpunitConfiguration->failOnSkipped();
$arguments['failOnWarning'] = $arguments['failOnWarning'] ?? $phpunitConfiguration->failOnWarning();
$arguments['enforceTimeLimit'] = $arguments['enforceTimeLimit'] ?? $phpunitConfiguration->enforceTimeLimit();
$arguments['defaultTimeLimit'] = $arguments['defaultTimeLimit'] ?? $phpunitConfiguration->defaultTimeLimit();
$arguments['timeoutForSmallTests'] = $arguments['timeoutForSmallTests'] ?? $phpunitConfiguration->timeoutForSmallTests();
$arguments['timeoutForMediumTests'] = $arguments['timeoutForMediumTests'] ?? $phpunitConfiguration->timeoutForMediumTests();
$arguments['timeoutForLargeTests'] = $arguments['timeoutForLargeTests'] ?? $phpunitConfiguration->timeoutForLargeTests();
$arguments['reportUselessTests'] = $arguments['reportUselessTests'] ?? $phpunitConfiguration->beStrictAboutTestsThatDoNotTestAnything();
$arguments['strictCoverage'] = $arguments['strictCoverage'] ?? $phpunitConfiguration->beStrictAboutCoversAnnotation();
$arguments['ignoreDeprecatedCodeUnitsFromCodeCoverage'] = $arguments['ignoreDeprecatedCodeUnitsFromCodeCoverage'] ?? $codeCoverageConfiguration->ignoreDeprecatedCodeUnits();
$arguments['disallowTestOutput'] = $arguments['disallowTestOutput'] ?? $phpunitConfiguration->beStrictAboutOutputDuringTests();
$arguments['disallowTodoAnnotatedTests'] = $arguments['disallowTodoAnnotatedTests'] ?? $phpunitConfiguration->beStrictAboutTodoAnnotatedTests();
$arguments['beStrictAboutResourceUsageDuringSmallTests'] = $arguments['beStrictAboutResourceUsageDuringSmallTests'] ?? $phpunitConfiguration->beStrictAboutResourceUsageDuringSmallTests();
$arguments['verbose'] = $arguments['verbose'] ?? $phpunitConfiguration->verbose();
$arguments['reverseDefectList'] = $arguments['reverseDefectList'] ?? $phpunitConfiguration->reverseDefectList();
$arguments['forceCoversAnnotation'] = $arguments['forceCoversAnnotation'] ?? $phpunitConfiguration->forceCoversAnnotation();
$arguments['disableCodeCoverageIgnore'] = $arguments['disableCodeCoverageIgnore'] ?? $codeCoverageConfiguration->disableCodeCoverageIgnore();
$arguments['registerMockObjectsFromTestArgumentsRecursively'] = $arguments['registerMockObjectsFromTestArgumentsRecursively'] ?? $phpunitConfiguration->registerMockObjectsFromTestArgumentsRecursively();
$arguments['noInteraction'] = $arguments['noInteraction'] ?? $phpunitConfiguration->noInteraction();
$arguments['executionOrder'] = $arguments['executionOrder'] ?? $phpunitConfiguration->executionOrder();
$arguments['resolveDependencies'] = $arguments['resolveDependencies'] ?? $phpunitConfiguration->resolveDependencies();
if (!isset($arguments['bootstrap']) && $phpunitConfiguration->hasBootstrap()) {
$arguments['bootstrap'] = $phpunitConfiguration->bootstrap();
}
if (!isset($arguments['cacheResultFile']) && $phpunitConfiguration->hasCacheResultFile()) {
$arguments['cacheResultFile'] = $phpunitConfiguration->cacheResultFile();
}
if (!isset($arguments['executionOrderDefects'])) {
$arguments['executionOrderDefects'] = $phpunitConfiguration->defectsFirst() ? TestSuiteSorter::ORDER_DEFECTS_FIRST : TestSuiteSorter::ORDER_DEFAULT;
}
if ($phpunitConfiguration->conflictBetweenPrinterClassAndTestdox()) {
$arguments['conflictBetweenPrinterClassAndTestdox'] = true;
}
$groupCliArgs = [];
if (!empty($arguments['groups'])) {
$groupCliArgs = $arguments['groups'];
}
$groupConfiguration = $arguments['configurationObject']->groups();
if (!isset($arguments['groups']) && $groupConfiguration->hasInclude()) {
$arguments['groups'] = $groupConfiguration->include()->asArrayOfStrings();
}
if (!isset($arguments['excludeGroups']) && $groupConfiguration->hasExclude()) {
$arguments['excludeGroups'] = array_diff($groupConfiguration->exclude()->asArrayOfStrings(), $groupCliArgs);
}
if (!isset($this->arguments['noExtensions'])) {
$extensionHandler = new ExtensionHandler;
foreach ($arguments['configurationObject']->extensions() as $extension) {
$extensionHandler->registerExtension($extension, $this);
}
foreach ($arguments['configurationObject']->listeners() as $listener) {
$arguments['listeners'][] = $extensionHandler->createTestListenerInstance($listener);
}
unset($extensionHandler);
}
foreach ($arguments['unavailableExtensions'] as $extension) {
$arguments['warnings'][] = sprintf(
'Extension "%s" is not available',
$extension
);
}
$loggingConfiguration = $arguments['configurationObject']->logging();
if (!isset($arguments['noLogging'])) {
if ($loggingConfiguration->hasText()) {
$arguments['listeners'][] = new DefaultResultPrinter(
$loggingConfiguration->text()->target()->path(),
true
);
}
if (!isset($arguments['teamcityLogfile']) && $loggingConfiguration->hasTeamCity()) {
$arguments['teamcityLogfile'] = $loggingConfiguration->teamCity()->target()->path();
}
if (!isset($arguments['junitLogfile']) && $loggingConfiguration->hasJunit()) {
$arguments['junitLogfile'] = $loggingConfiguration->junit()->target()->path();
}
if (!isset($arguments['testdoxHTMLFile']) && $loggingConfiguration->hasTestDoxHtml()) {
$arguments['testdoxHTMLFile'] = $loggingConfiguration->testDoxHtml()->target()->path();
}
if (!isset($arguments['testdoxTextFile']) && $loggingConfiguration->hasTestDoxText()) {
$arguments['testdoxTextFile'] = $loggingConfiguration->testDoxText()->target()->path();
}
if (!isset($arguments['testdoxXMLFile']) && $loggingConfiguration->hasTestDoxXml()) {
$arguments['testdoxXMLFile'] = $loggingConfiguration->testDoxXml()->target()->path();
}
}
$testdoxGroupConfiguration = $arguments['configurationObject']->testdoxGroups();
if (!isset($arguments['testdoxGroups']) && $testdoxGroupConfiguration->hasInclude()) {
$arguments['testdoxGroups'] = $testdoxGroupConfiguration->include()->asArrayOfStrings();
}
if (!isset($arguments['testdoxExcludeGroups']) && $testdoxGroupConfiguration->hasExclude()) {
$arguments['testdoxExcludeGroups'] = $testdoxGroupConfiguration->exclude()->asArrayOfStrings();
}
}
$extensionHandler = new ExtensionHandler;
foreach ($arguments['extensions'] as $extension) {
$extensionHandler->registerExtension($extension, $this);
}
unset($extensionHandler);
$arguments['backupGlobals'] = $arguments['backupGlobals'] ?? null;
$arguments['backupStaticAttributes'] = $arguments['backupStaticAttributes'] ?? null;
$arguments['beStrictAboutChangesToGlobalState'] = $arguments['beStrictAboutChangesToGlobalState'] ?? null;
$arguments['beStrictAboutResourceUsageDuringSmallTests'] = $arguments['beStrictAboutResourceUsageDuringSmallTests'] ?? false;
$arguments['cacheResult'] = $arguments['cacheResult'] ?? true;
$arguments['colors'] = $arguments['colors'] ?? DefaultResultPrinter::COLOR_DEFAULT;
$arguments['columns'] = $arguments['columns'] ?? 80;
$arguments['convertDeprecationsToExceptions'] = $arguments['convertDeprecationsToExceptions'] ?? false;
$arguments['convertErrorsToExceptions'] = $arguments['convertErrorsToExceptions'] ?? true;
$arguments['convertNoticesToExceptions'] = $arguments['convertNoticesToExceptions'] ?? true;
$arguments['convertWarningsToExceptions'] = $arguments['convertWarningsToExceptions'] ?? true;
$arguments['crap4jThreshold'] = $arguments['crap4jThreshold'] ?? 30;
$arguments['disallowTestOutput'] = $arguments['disallowTestOutput'] ?? false;
$arguments['disallowTodoAnnotatedTests'] = $arguments['disallowTodoAnnotatedTests'] ?? false;
$arguments['defaultTimeLimit'] = $arguments['defaultTimeLimit'] ?? 0;
$arguments['enforceTimeLimit'] = $arguments['enforceTimeLimit'] ?? false;
$arguments['excludeGroups'] = $arguments['excludeGroups'] ?? [];
$arguments['executionOrder'] = $arguments['executionOrder'] ?? TestSuiteSorter::ORDER_DEFAULT;
$arguments['executionOrderDefects'] = $arguments['executionOrderDefects'] ?? TestSuiteSorter::ORDER_DEFAULT;
$arguments['failOnIncomplete'] = $arguments['failOnIncomplete'] ?? false;
$arguments['failOnRisky'] = $arguments['failOnRisky'] ?? false;
$arguments['failOnSkipped'] = $arguments['failOnSkipped'] ?? false;
$arguments['failOnWarning'] = $arguments['failOnWarning'] ?? false;
$arguments['groups'] = $arguments['groups'] ?? [];
$arguments['noInteraction'] = $arguments['noInteraction'] ?? false;
$arguments['processIsolation'] = $arguments['processIsolation'] ?? false;
$arguments['randomOrderSeed'] = $arguments['randomOrderSeed'] ?? time();
$arguments['registerMockObjectsFromTestArgumentsRecursively'] = $arguments['registerMockObjectsFromTestArgumentsRecursively'] ?? false;
$arguments['repeat'] = $arguments['repeat'] ?? false;
$arguments['reportHighLowerBound'] = $arguments['reportHighLowerBound'] ?? 90;
$arguments['reportLowUpperBound'] = $arguments['reportLowUpperBound'] ?? 50;
$arguments['reportUselessTests'] = $arguments['reportUselessTests'] ?? true;
$arguments['reverseList'] = $arguments['reverseList'] ?? false;
$arguments['resolveDependencies'] = $arguments['resolveDependencies'] ?? true;
$arguments['stopOnError'] = $arguments['stopOnError'] ?? false;
$arguments['stopOnFailure'] = $arguments['stopOnFailure'] ?? false;
$arguments['stopOnIncomplete'] = $arguments['stopOnIncomplete'] ?? false;
$arguments['stopOnRisky'] = $arguments['stopOnRisky'] ?? false;
$arguments['stopOnSkipped'] = $arguments['stopOnSkipped'] ?? false;
$arguments['stopOnWarning'] = $arguments['stopOnWarning'] ?? false;
$arguments['stopOnDefect'] = $arguments['stopOnDefect'] ?? false;
$arguments['strictCoverage'] = $arguments['strictCoverage'] ?? false;
$arguments['testdoxExcludeGroups'] = $arguments['testdoxExcludeGroups'] ?? [];
$arguments['testdoxGroups'] = $arguments['testdoxGroups'] ?? [];
$arguments['timeoutForLargeTests'] = $arguments['timeoutForLargeTests'] ?? 60;
$arguments['timeoutForMediumTests'] = $arguments['timeoutForMediumTests'] ?? 10;
$arguments['timeoutForSmallTests'] = $arguments['timeoutForSmallTests'] ?? 1;
$arguments['verbose'] = $arguments['verbose'] ?? false;
if ($arguments['reportLowUpperBound'] > $arguments['reportHighLowerBound']) {
$arguments['reportLowUpperBound'] = 50;
$arguments['reportHighLowerBound'] = 90;
}
}
private function processSuiteFilters(TestSuite $suite, array $arguments): void
{
if (!$arguments['filter'] &&
empty($arguments['groups']) &&
empty($arguments['excludeGroups']) &&
empty($arguments['testsCovering']) &&
empty($arguments['testsUsing'])) {
return;
}
$filterFactory = new Factory;
if (!empty($arguments['excludeGroups'])) {
$filterFactory->addFilter(
new ReflectionClass(ExcludeGroupFilterIterator::class),
$arguments['excludeGroups']
);
}
if (!empty($arguments['groups'])) {
$filterFactory->addFilter(
new ReflectionClass(IncludeGroupFilterIterator::class),
$arguments['groups']
);
}
if (!empty($arguments['testsCovering'])) {
$filterFactory->addFilter(
new ReflectionClass(IncludeGroupFilterIterator::class),
array_map(
static function (string $name): string
{
return '__phpunit_covers_' . $name;
},
$arguments['testsCovering']
)
);
}
if (!empty($arguments['testsUsing'])) {
$filterFactory->addFilter(
new ReflectionClass(IncludeGroupFilterIterator::class),
array_map(
static function (string $name): string
{
return '__phpunit_uses_' . $name;
},
$arguments['testsUsing']
)
);
}
if ($arguments['filter']) {
$filterFactory->addFilter(
new ReflectionClass(NameFilterIterator::class),
$arguments['filter']
);
}
$suite->injectFilter($filterFactory);
}
private function writeMessage(string $type, string $message): void
{
if (!$this->messagePrinted) {
$this->write("\n");
}
$this->write(
sprintf(
"%-15s%s\n",
$type . ':',
$message
)
);
$this->messagePrinted = true;
}
private function createPrinter(string $class, array $arguments): ResultPrinter
{
$object = new $class(
(isset($arguments['stderr']) && $arguments['stderr'] === true) ? 'php://stderr' : null,
$arguments['verbose'],
$arguments['colors'],
$arguments['debug'],
$arguments['columns'],
$arguments['reverseList']
);
assert($object instanceof ResultPrinter);
return $object;
}
private function codeCoverageGenerationStart(string $format): void
{
$this->write(
sprintf(
"\nGenerating code coverage report in %s format ... ",
$format
)
);
$this->timer->start();
}
private function codeCoverageGenerationSucceeded(): void
{
$this->write(
sprintf(
"done [%s]\n",
$this->timer->stop()->asString()
)
);
}
private function codeCoverageGenerationFailed(\Exception $e): void
{
$this->write(
sprintf(
"failed [%s]\n%s\n",
$this->timer->stop()->asString(),
$e->getMessage()
)
);
}
}
PK [6o{n n src/TextUI/ResultPrinter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use PHPUnit\Framework\TestListener;
use PHPUnit\Framework\TestResult;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
interface ResultPrinter extends TestListener
{
public function printResult(TestResult $result): void;
public function write(string $buffer): void;
}
PK [h><6u 6u src/TextUI/Command.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use const PATH_SEPARATOR;
use const PHP_EOL;
use const STDIN;
use function array_keys;
use function assert;
use function class_exists;
use function copy;
use function extension_loaded;
use function fgets;
use function file_get_contents;
use function file_put_contents;
use function get_class;
use function getcwd;
use function ini_get;
use function ini_set;
use function is_array;
use function is_callable;
use function is_dir;
use function is_file;
use function is_string;
use function printf;
use function realpath;
use function sort;
use function sprintf;
use function stream_resolve_include_path;
use function strpos;
use function trim;
use function version_compare;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Runner\Extension\PharLoader;
use PHPUnit\Runner\StandardTestSuiteLoader;
use PHPUnit\Runner\TestSuiteLoader;
use PHPUnit\Runner\Version;
use PHPUnit\TextUI\CliArguments\Builder;
use PHPUnit\TextUI\CliArguments\Configuration;
use PHPUnit\TextUI\CliArguments\Exception as ArgumentsException;
use PHPUnit\TextUI\CliArguments\Mapper;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\FilterMapper;
use PHPUnit\TextUI\XmlConfiguration\Generator;
use PHPUnit\TextUI\XmlConfiguration\Loader;
use PHPUnit\TextUI\XmlConfiguration\Migrator;
use PHPUnit\TextUI\XmlConfiguration\PhpHandler;
use PHPUnit\Util\FileLoader;
use PHPUnit\Util\Filesystem;
use PHPUnit\Util\Printer;
use PHPUnit\Util\TextTestListRenderer;
use PHPUnit\Util\Xml\SchemaDetector;
use PHPUnit\Util\XmlTestListRenderer;
use ReflectionClass;
use SebastianBergmann\CodeCoverage\Filter;
use SebastianBergmann\CodeCoverage\StaticAnalysis\CacheWarmer;
use SebastianBergmann\Timer\Timer;
use Throwable;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
class Command
{
/**
* @var array
*/
protected $arguments = [];
/**
* @var array
*/
protected $longOptions = [];
/**
* @var bool
*/
private $versionStringPrinted = false;
/**
* @psalm-var list
*/
private $warnings = [];
/**
* @throws Exception
*/
public static function main(bool $exit = true): int
{
try {
return (new static)->run($_SERVER['argv'], $exit);
} catch (Throwable $t) {
throw new RuntimeException(
$t->getMessage(),
(int) $t->getCode(),
$t
);
}
}
/**
* @throws Exception
*/
public function run(array $argv, bool $exit = true): int
{
$this->handleArguments($argv);
$runner = $this->createRunner();
if ($this->arguments['test'] instanceof TestSuite) {
$suite = $this->arguments['test'];
} else {
$suite = $runner->getTest(
$this->arguments['test'],
$this->arguments['testSuffixes']
);
}
if ($this->arguments['listGroups']) {
return $this->handleListGroups($suite, $exit);
}
if ($this->arguments['listSuites']) {
return $this->handleListSuites($exit);
}
if ($this->arguments['listTests']) {
return $this->handleListTests($suite, $exit);
}
if ($this->arguments['listTestsXml']) {
return $this->handleListTestsXml($suite, $this->arguments['listTestsXml'], $exit);
}
unset($this->arguments['test'], $this->arguments['testFile']);
try {
$result = $runner->run($suite, $this->arguments, $this->warnings, $exit);
} catch (Throwable $t) {
print $t->getMessage() . PHP_EOL;
}
$return = TestRunner::FAILURE_EXIT;
if (isset($result) && $result->wasSuccessful()) {
$return = TestRunner::SUCCESS_EXIT;
} elseif (!isset($result) || $result->errorCount() > 0) {
$return = TestRunner::EXCEPTION_EXIT;
}
if ($exit) {
exit($return);
}
return $return;
}
/**
* Create a TestRunner, override in subclasses.
*/
protected function createRunner(): TestRunner
{
return new TestRunner($this->arguments['loader']);
}
/**
* Handles the command-line arguments.
*
* A child class of PHPUnit\TextUI\Command can hook into the argument
* parsing by adding the switch(es) to the $longOptions array and point to a
* callback method that handles the switch(es) in the child class like this
*
*
* longOptions['my-switch'] = 'myHandler';
* // my-secondswitch will accept a value - note the equals sign
* $this->longOptions['my-secondswitch='] = 'myOtherHandler';
* }
*
* // --my-switch -> myHandler()
* protected function myHandler()
* {
* }
*
* // --my-secondswitch foo -> myOtherHandler('foo')
* protected function myOtherHandler ($value)
* {
* }
*
* // You will also need this - the static keyword in the
* // PHPUnit\TextUI\Command will mean that it'll be
* // PHPUnit\TextUI\Command that gets instantiated,
* // not MyCommand
* public static function main($exit = true)
* {
* $command = new static;
*
* return $command->run($_SERVER['argv'], $exit);
* }
*
* }
*
*
* @throws Exception
*/
protected function handleArguments(array $argv): void
{
try {
$arguments = (new Builder)->fromParameters($argv, array_keys($this->longOptions));
} catch (ArgumentsException $e) {
$this->exitWithErrorMessage($e->getMessage());
}
assert(isset($arguments) && $arguments instanceof Configuration);
if ($arguments->hasGenerateConfiguration() && $arguments->generateConfiguration()) {
$this->generateConfiguration();
}
if ($arguments->hasAtLeastVersion()) {
if (version_compare(Version::id(), $arguments->atLeastVersion(), '>=')) {
exit(TestRunner::SUCCESS_EXIT);
}
exit(TestRunner::FAILURE_EXIT);
}
if ($arguments->hasVersion() && $arguments->version()) {
$this->printVersionString();
exit(TestRunner::SUCCESS_EXIT);
}
if ($arguments->hasCheckVersion() && $arguments->checkVersion()) {
$this->handleVersionCheck();
}
if ($arguments->hasHelp()) {
$this->showHelp();
exit(TestRunner::SUCCESS_EXIT);
}
if ($arguments->hasUnrecognizedOrderBy()) {
$this->exitWithErrorMessage(
sprintf(
'unrecognized --order-by option: %s',
$arguments->unrecognizedOrderBy()
)
);
}
if ($arguments->hasIniSettings()) {
foreach ($arguments->iniSettings() as $name => $value) {
ini_set($name, $value);
}
}
if ($arguments->hasIncludePath()) {
ini_set(
'include_path',
$arguments->includePath() . PATH_SEPARATOR . ini_get('include_path')
);
}
$this->arguments = (new Mapper)->mapToLegacyArray($arguments);
$this->handleCustomOptions($arguments->unrecognizedOptions());
$this->handleCustomTestSuite();
if (!isset($this->arguments['testSuffixes'])) {
$this->arguments['testSuffixes'] = ['Test.php', '.phpt'];
}
if (!isset($this->arguments['test']) && $arguments->hasArgument()) {
$this->arguments['test'] = realpath($arguments->argument());
if ($this->arguments['test'] === false) {
$this->exitWithErrorMessage(
sprintf(
'Cannot open file "%s".',
$arguments->argument()
)
);
}
}
if ($this->arguments['loader'] !== null) {
$this->arguments['loader'] = $this->handleLoader($this->arguments['loader']);
}
if (isset($this->arguments['configuration'])) {
if (is_dir($this->arguments['configuration'])) {
$candidate = $this->configurationFileInDirectory($this->arguments['configuration']);
if ($candidate !== null) {
$this->arguments['configuration'] = $candidate;
}
}
} elseif ($this->arguments['useDefaultConfiguration']) {
$candidate = $this->configurationFileInDirectory(getcwd());
if ($candidate !== null) {
$this->arguments['configuration'] = $candidate;
}
}
if ($arguments->hasMigrateConfiguration() && $arguments->migrateConfiguration()) {
if (!isset($this->arguments['configuration'])) {
print 'No configuration file found to migrate.' . PHP_EOL;
exit(TestRunner::EXCEPTION_EXIT);
}
$this->migrateConfiguration(realpath($this->arguments['configuration']));
}
if (isset($this->arguments['configuration'])) {
try {
$this->arguments['configurationObject'] = (new Loader)->load($this->arguments['configuration']);
} catch (Throwable $e) {
print $e->getMessage() . PHP_EOL;
exit(TestRunner::FAILURE_EXIT);
}
$phpunitConfiguration = $this->arguments['configurationObject']->phpunit();
(new PhpHandler)->handle($this->arguments['configurationObject']->php());
if (isset($this->arguments['bootstrap'])) {
$this->handleBootstrap($this->arguments['bootstrap']);
} elseif ($phpunitConfiguration->hasBootstrap()) {
$this->handleBootstrap($phpunitConfiguration->bootstrap());
}
if (!isset($this->arguments['stderr'])) {
$this->arguments['stderr'] = $phpunitConfiguration->stderr();
}
if (!isset($this->arguments['noExtensions']) && $phpunitConfiguration->hasExtensionsDirectory() && extension_loaded('phar')) {
$result = (new PharLoader)->loadPharExtensionsInDirectory($phpunitConfiguration->extensionsDirectory());
$this->arguments['loadedExtensions'] = $result['loadedExtensions'];
$this->arguments['notLoadedExtensions'] = $result['notLoadedExtensions'];
unset($result);
}
if (!isset($this->arguments['columns'])) {
$this->arguments['columns'] = $phpunitConfiguration->columns();
}
if (!isset($this->arguments['printer']) && $phpunitConfiguration->hasPrinterClass()) {
$file = $phpunitConfiguration->hasPrinterFile() ? $phpunitConfiguration->printerFile() : '';
$this->arguments['printer'] = $this->handlePrinter(
$phpunitConfiguration->printerClass(),
$file
);
}
if ($phpunitConfiguration->hasTestSuiteLoaderClass()) {
$file = $phpunitConfiguration->hasTestSuiteLoaderFile() ? $phpunitConfiguration->testSuiteLoaderFile() : '';
$this->arguments['loader'] = $this->handleLoader(
$phpunitConfiguration->testSuiteLoaderClass(),
$file
);
}
if (!isset($this->arguments['testsuite']) && $phpunitConfiguration->hasDefaultTestSuite()) {
$this->arguments['testsuite'] = $phpunitConfiguration->defaultTestSuite();
}
if (!isset($this->arguments['test'])) {
try {
$this->arguments['test'] = (new TestSuiteMapper)->map(
$this->arguments['configurationObject']->testSuite(),
$this->arguments['testsuite'] ?? ''
);
} catch (Exception $e) {
$this->printVersionString();
print $e->getMessage() . PHP_EOL;
exit(TestRunner::EXCEPTION_EXIT);
}
}
} elseif (isset($this->arguments['bootstrap'])) {
$this->handleBootstrap($this->arguments['bootstrap']);
}
if (isset($this->arguments['printer']) && is_string($this->arguments['printer'])) {
$this->arguments['printer'] = $this->handlePrinter($this->arguments['printer']);
}
if (isset($this->arguments['configurationObject'], $this->arguments['warmCoverageCache'])) {
$this->handleWarmCoverageCache($this->arguments['configurationObject']);
}
if (!isset($this->arguments['test'])) {
$this->showHelp();
exit(TestRunner::EXCEPTION_EXIT);
}
}
/**
* Handles the loading of the PHPUnit\Runner\TestSuiteLoader implementation.
*
* @deprecated see https://github.com/sebastianbergmann/phpunit/issues/4039
*/
protected function handleLoader(string $loaderClass, string $loaderFile = ''): ?TestSuiteLoader
{
$this->warnings[] = 'Using a custom test suite loader is deprecated';
if (!class_exists($loaderClass, false)) {
if ($loaderFile == '') {
$loaderFile = Filesystem::classNameToFilename(
$loaderClass
);
}
$loaderFile = stream_resolve_include_path($loaderFile);
if ($loaderFile) {
/**
* @noinspection PhpIncludeInspection
*
* @psalm-suppress UnresolvableInclude
*/
require $loaderFile;
}
}
if (class_exists($loaderClass, false)) {
try {
$class = new ReflectionClass($loaderClass);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
}
// @codeCoverageIgnoreEnd
if ($class->implementsInterface(TestSuiteLoader::class) && $class->isInstantiable()) {
$object = $class->newInstance();
assert($object instanceof TestSuiteLoader);
return $object;
}
}
if ($loaderClass == StandardTestSuiteLoader::class) {
return null;
}
$this->exitWithErrorMessage(
sprintf(
'Could not use "%s" as loader.',
$loaderClass
)
);
return null;
}
/**
* Handles the loading of the PHPUnit\Util\Printer implementation.
*
* @return null|Printer|string
*/
protected function handlePrinter(string $printerClass, string $printerFile = '')
{
if (!class_exists($printerClass, false)) {
if ($printerFile === '') {
$printerFile = Filesystem::classNameToFilename(
$printerClass
);
}
$printerFile = stream_resolve_include_path($printerFile);
if ($printerFile) {
/**
* @noinspection PhpIncludeInspection
*
* @psalm-suppress UnresolvableInclude
*/
require $printerFile;
}
}
if (!class_exists($printerClass)) {
$this->exitWithErrorMessage(
sprintf(
'Could not use "%s" as printer: class does not exist',
$printerClass
)
);
}
try {
$class = new ReflectionClass($printerClass);
// @codeCoverageIgnoreStart
} catch (\ReflectionException $e) {
throw new ReflectionException(
$e->getMessage(),
$e->getCode(),
$e
);
// @codeCoverageIgnoreEnd
}
if (!$class->implementsInterface(ResultPrinter::class)) {
$this->exitWithErrorMessage(
sprintf(
'Could not use "%s" as printer: class does not implement %s',
$printerClass,
ResultPrinter::class
)
);
}
if (!$class->isInstantiable()) {
$this->exitWithErrorMessage(
sprintf(
'Could not use "%s" as printer: class cannot be instantiated',
$printerClass
)
);
}
if ($class->isSubclassOf(ResultPrinter::class)) {
return $printerClass;
}
$outputStream = isset($this->arguments['stderr']) ? 'php://stderr' : null;
return $class->newInstance($outputStream);
}
/**
* Loads a bootstrap file.
*/
protected function handleBootstrap(string $filename): void
{
try {
FileLoader::checkAndLoad($filename);
} catch (Throwable $t) {
if ($t instanceof \PHPUnit\Exception) {
$this->exitWithErrorMessage($t->getMessage());
}
$this->exitWithErrorMessage(
sprintf(
'Error in bootstrap script: %s:%s%s%s%s',
get_class($t),
PHP_EOL,
$t->getMessage(),
PHP_EOL,
$t->getTraceAsString()
)
);
}
}
protected function handleVersionCheck(): void
{
$this->printVersionString();
$latestVersion = file_get_contents('https://phar.phpunit.de/latest-version-of/phpunit');
$isOutdated = version_compare($latestVersion, Version::id(), '>');
if ($isOutdated) {
printf(
'You are not using the latest version of PHPUnit.' . PHP_EOL .
'The latest version is PHPUnit %s.' . PHP_EOL,
$latestVersion
);
} else {
print 'You are using the latest version of PHPUnit.' . PHP_EOL;
}
exit(TestRunner::SUCCESS_EXIT);
}
/**
* Show the help message.
*/
protected function showHelp(): void
{
$this->printVersionString();
(new Help)->writeToConsole();
}
/**
* Custom callback for test suite discovery.
*/
protected function handleCustomTestSuite(): void
{
}
private function printVersionString(): void
{
if ($this->versionStringPrinted) {
return;
}
print Version::getVersionString() . PHP_EOL . PHP_EOL;
$this->versionStringPrinted = true;
}
private function exitWithErrorMessage(string $message): void
{
$this->printVersionString();
print $message . PHP_EOL;
exit(TestRunner::FAILURE_EXIT);
}
private function handleListGroups(TestSuite $suite, bool $exit): int
{
$this->printVersionString();
$this->warnAboutConflictingOptions(
'listGroups',
[
'filter',
'groups',
'excludeGroups',
'testsuite',
]
);
print 'Available test group(s):' . PHP_EOL;
$groups = $suite->getGroups();
sort($groups);
foreach ($groups as $group) {
if (strpos($group, '__phpunit_') === 0) {
continue;
}
printf(
' - %s' . PHP_EOL,
$group
);
}
if ($exit) {
exit(TestRunner::SUCCESS_EXIT);
}
return TestRunner::SUCCESS_EXIT;
}
/**
* @throws \PHPUnit\Framework\Exception
* @throws \PHPUnit\TextUI\XmlConfiguration\Exception
*/
private function handleListSuites(bool $exit): int
{
$this->printVersionString();
$this->warnAboutConflictingOptions(
'listSuites',
[
'filter',
'groups',
'excludeGroups',
'testsuite',
]
);
print 'Available test suite(s):' . PHP_EOL;
foreach ($this->arguments['configurationObject']->testSuite() as $testSuite) {
printf(
' - %s' . PHP_EOL,
$testSuite->name()
);
}
if ($exit) {
exit(TestRunner::SUCCESS_EXIT);
}
return TestRunner::SUCCESS_EXIT;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function handleListTests(TestSuite $suite, bool $exit): int
{
$this->printVersionString();
$this->warnAboutConflictingOptions(
'listTests',
[
'filter',
'groups',
'excludeGroups',
]
);
$renderer = new TextTestListRenderer;
print $renderer->render($suite);
if ($exit) {
exit(TestRunner::SUCCESS_EXIT);
}
return TestRunner::SUCCESS_EXIT;
}
/**
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
private function handleListTestsXml(TestSuite $suite, string $target, bool $exit): int
{
$this->printVersionString();
$this->warnAboutConflictingOptions(
'listTestsXml',
[
'filter',
'groups',
'excludeGroups',
]
);
$renderer = new XmlTestListRenderer;
file_put_contents($target, $renderer->render($suite));
printf(
'Wrote list of tests that would have been run to %s' . PHP_EOL,
$target
);
if ($exit) {
exit(TestRunner::SUCCESS_EXIT);
}
return TestRunner::SUCCESS_EXIT;
}
private function generateConfiguration(): void
{
$this->printVersionString();
print 'Generating phpunit.xml in ' . getcwd() . PHP_EOL . PHP_EOL;
print 'Bootstrap script (relative to path shown above; default: vendor/autoload.php): ';
$bootstrapScript = trim(fgets(STDIN));
print 'Tests directory (relative to path shown above; default: tests): ';
$testsDirectory = trim(fgets(STDIN));
print 'Source directory (relative to path shown above; default: src): ';
$src = trim(fgets(STDIN));
print 'Cache directory (relative to path shown above; default: .phpunit.cache): ';
$cacheDirectory = trim(fgets(STDIN));
if ($bootstrapScript === '') {
$bootstrapScript = 'vendor/autoload.php';
}
if ($testsDirectory === '') {
$testsDirectory = 'tests';
}
if ($src === '') {
$src = 'src';
}
if ($cacheDirectory === '') {
$cacheDirectory = '.phpunit.cache';
}
$generator = new Generator;
file_put_contents(
'phpunit.xml',
$generator->generateDefaultConfiguration(
Version::series(),
$bootstrapScript,
$testsDirectory,
$src,
$cacheDirectory
)
);
print PHP_EOL . 'Generated phpunit.xml in ' . getcwd() . '.' . PHP_EOL;
print 'Make sure to exclude the ' . $cacheDirectory . ' directory from version control.' . PHP_EOL;
exit(TestRunner::SUCCESS_EXIT);
}
private function migrateConfiguration(string $filename): void
{
$this->printVersionString();
if (!(new SchemaDetector)->detect($filename)->detected()) {
print $filename . ' does not need to be migrated.' . PHP_EOL;
exit(TestRunner::EXCEPTION_EXIT);
}
copy($filename, $filename . '.bak');
print 'Created backup: ' . $filename . '.bak' . PHP_EOL;
try {
file_put_contents(
$filename,
(new Migrator)->migrate($filename)
);
print 'Migrated configuration: ' . $filename . PHP_EOL;
} catch (Throwable $t) {
print 'Migration failed: ' . $t->getMessage() . PHP_EOL;
exit(TestRunner::EXCEPTION_EXIT);
}
exit(TestRunner::SUCCESS_EXIT);
}
private function handleCustomOptions(array $unrecognizedOptions): void
{
foreach ($unrecognizedOptions as $name => $value) {
if (isset($this->longOptions[$name])) {
$handler = $this->longOptions[$name];
}
$name .= '=';
if (isset($this->longOptions[$name])) {
$handler = $this->longOptions[$name];
}
if (isset($handler) && is_callable([$this, $handler])) {
$this->{$handler}($value);
unset($handler);
}
}
}
private function handleWarmCoverageCache(XmlConfiguration\Configuration $configuration): void
{
$this->printVersionString();
if (isset($this->arguments['coverageCacheDirectory'])) {
$cacheDirectory = $this->arguments['coverageCacheDirectory'];
} elseif ($configuration->codeCoverage()->hasCacheDirectory()) {
$cacheDirectory = $configuration->codeCoverage()->cacheDirectory()->path();
} else {
print 'Cache for static analysis has not been configured' . PHP_EOL;
exit(TestRunner::EXCEPTION_EXIT);
}
$filter = new Filter;
if ($configuration->codeCoverage()->hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport()) {
(new FilterMapper)->map(
$filter,
$configuration->codeCoverage()
);
} elseif (isset($this->arguments['coverageFilter'])) {
if (!is_array($this->arguments['coverageFilter'])) {
$coverageFilterDirectories = [$this->arguments['coverageFilter']];
} else {
$coverageFilterDirectories = $this->arguments['coverageFilter'];
}
foreach ($coverageFilterDirectories as $coverageFilterDirectory) {
$filter->includeDirectory($coverageFilterDirectory);
}
} else {
print 'Filter for code coverage has not been configured' . PHP_EOL;
exit(TestRunner::EXCEPTION_EXIT);
}
$timer = new Timer;
$timer->start();
print 'Warming cache for static analysis ... ';
(new CacheWarmer)->warmCache(
$cacheDirectory,
!$configuration->codeCoverage()->disableCodeCoverageIgnore(),
$configuration->codeCoverage()->ignoreDeprecatedCodeUnits(),
$filter
);
print 'done [' . $timer->stop()->asString() . ']' . PHP_EOL;
exit(TestRunner::SUCCESS_EXIT);
}
private function configurationFileInDirectory(string $directory): ?string
{
$candidates = [
$directory . '/phpunit.xml',
$directory . '/phpunit.xml.dist',
];
foreach ($candidates as $candidate) {
if (is_file($candidate)) {
return realpath($candidate);
}
}
return null;
}
/**
* @psalm-param "listGroups"|"listSuites"|"listTests"|"listTestsXml"|"filter"|"groups"|"excludeGroups"|"testsuite" $key
* @psalm-param list<"listGroups"|"listSuites"|"listTests"|"listTestsXml"|"filter"|"groups"|"excludeGroups"|"testsuite"> $keys
*/
private function warnAboutConflictingOptions(string $key, array $keys): void
{
$warningPrinted = false;
foreach ($keys as $_key) {
if (!empty($this->arguments[$_key])) {
printf(
'The %s and %s options cannot be combined, %s is ignored' . PHP_EOL,
$this->mapKeyToOptionForWarning($_key),
$this->mapKeyToOptionForWarning($key),
$this->mapKeyToOptionForWarning($_key)
);
$warningPrinted = true;
}
}
if ($warningPrinted) {
print PHP_EOL;
}
}
/**
* @psalm-param "listGroups"|"listSuites"|"listTests"|"listTestsXml"|"filter"|"groups"|"excludeGroups"|"testsuite" $key
*/
private function mapKeyToOptionForWarning(string $key): string
{
switch ($key) {
case 'listGroups':
return '--list-groups';
case 'listSuites':
return '--list-suites';
case 'listTests':
return '--list-tests';
case 'listTestsXml':
return '--list-tests-xml';
case 'filter':
return '--filter';
case 'groups':
return '--group';
case 'excludeGroups':
return '--exclude-group';
case 'testsuite':
return '--testsuite';
}
}
}
PK [&u u 7 src/TextUI/XmlConfiguration/TestSuite/TestDirectory.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use PHPUnit\Util\VersionComparisonOperator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class TestDirectory
{
/**
* @var string
*/
private $path;
/**
* @var string
*/
private $prefix;
/**
* @var string
*/
private $suffix;
/**
* @var string
*/
private $phpVersion;
/**
* @var VersionComparisonOperator
*/
private $phpVersionOperator;
public function __construct(string $path, string $prefix, string $suffix, string $phpVersion, VersionComparisonOperator $phpVersionOperator)
{
$this->path = $path;
$this->prefix = $prefix;
$this->suffix = $suffix;
$this->phpVersion = $phpVersion;
$this->phpVersionOperator = $phpVersionOperator;
}
public function path(): string
{
return $this->path;
}
public function prefix(): string
{
return $this->prefix;
}
public function suffix(): string
{
return $this->suffix;
}
public function phpVersion(): string
{
return $this->phpVersion;
}
public function phpVersionOperator(): VersionComparisonOperator
{
return $this->phpVersionOperator;
}
}
PK [drv v I src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class TestDirectoryCollectionIterator implements Countable, Iterator
{
/**
* @var TestDirectory[]
*/
private $directories;
/**
* @var int
*/
private $position;
public function __construct(TestDirectoryCollection $directories)
{
$this->directories = $directories->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->directories);
}
public function key(): int
{
return $this->position;
}
public function current(): TestDirectory
{
return $this->directories[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [m0n9 9 D src/TextUI/XmlConfiguration/TestSuite/TestFileCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class TestFileCollectionIterator implements Countable, Iterator
{
/**
* @var TestFile[]
*/
private $files;
/**
* @var int
*/
private $position;
public function __construct(TestFileCollection $files)
{
$this->files = $files->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->files);
}
public function key(): int
{
return $this->position;
}
public function current(): TestFile
{
return $this->files[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [G)Py 2 src/TextUI/XmlConfiguration/TestSuite/TestFile.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use PHPUnit\Util\VersionComparisonOperator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class TestFile
{
/**
* @var string
*/
private $path;
/**
* @var string
*/
private $phpVersion;
/**
* @var VersionComparisonOperator
*/
private $phpVersionOperator;
public function __construct(string $path, string $phpVersion, VersionComparisonOperator $phpVersionOperator)
{
$this->path = $path;
$this->phpVersion = $phpVersion;
$this->phpVersionOperator = $phpVersionOperator;
}
public function path(): string
{
return $this->path;
}
public function phpVersion(): string
{
return $this->phpVersion;
}
public function phpVersionOperator(): VersionComparisonOperator
{
return $this->phpVersionOperator;
}
}
PK [ [ A src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use Countable;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class TestDirectoryCollection implements Countable, IteratorAggregate
{
/**
* @var TestDirectory[]
*/
private $directories;
/**
* @param TestDirectory[] $directories
*/
public static function fromArray(array $directories): self
{
return new self(...$directories);
}
private function __construct(TestDirectory ...$directories)
{
$this->directories = $directories;
}
/**
* @return TestDirectory[]
*/
public function asArray(): array
{
return $this->directories;
}
public function count(): int
{
return count($this->directories);
}
public function getIterator(): TestDirectoryCollectionIterator
{
return new TestDirectoryCollectionIterator($this);
}
public function isEmpty(): bool
{
return $this->count() === 0;
}
}
PK [Z ; ; < src/TextUI/XmlConfiguration/TestSuite/TestFileCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use Countable;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class TestFileCollection implements Countable, IteratorAggregate
{
/**
* @var TestFile[]
*/
private $files;
/**
* @param TestFile[] $files
*/
public static function fromArray(array $files): self
{
return new self(...$files);
}
private function __construct(TestFile ...$files)
{
$this->files = $files;
}
/**
* @return TestFile[]
*/
public function asArray(): array
{
return $this->files;
}
public function count(): int
{
return count($this->files);
}
public function getIterator(): TestFileCollectionIterator
{
return new TestFileCollectionIterator($this);
}
public function isEmpty(): bool
{
return $this->count() === 0;
}
}
PK [6\ \ E src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class TestSuiteCollectionIterator implements Countable, Iterator
{
/**
* @var TestSuite[]
*/
private $testSuites;
/**
* @var int
*/
private $position;
public function __construct(TestSuiteCollection $testSuites)
{
$this->testSuites = $testSuites->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->testSuites);
}
public function key(): int
{
return $this->position;
}
public function current(): TestSuite
{
return $this->testSuites[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [Tp p = src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use Countable;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class TestSuiteCollection implements Countable, IteratorAggregate
{
/**
* @var TestSuite[]
*/
private $testSuites;
/**
* @param TestSuite[] $testSuites
*/
public static function fromArray(array $testSuites): self
{
return new self(...$testSuites);
}
private function __construct(TestSuite ...$testSuites)
{
$this->testSuites = $testSuites;
}
/**
* @return TestSuite[]
*/
public function asArray(): array
{
return $this->testSuites;
}
public function count(): int
{
return count($this->testSuites);
}
public function getIterator(): TestSuiteCollectionIterator
{
return new TestSuiteCollectionIterator($this);
}
public function isEmpty(): bool
{
return $this->count() === 0;
}
}
PK [a a 3 src/TextUI/XmlConfiguration/TestSuite/TestSuite.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class TestSuite
{
/**
* @var string
*/
private $name;
/**
* @var TestDirectoryCollection
*/
private $directories;
/**
* @var TestFileCollection
*/
private $files;
/**
* @var FileCollection
*/
private $exclude;
public function __construct(string $name, TestDirectoryCollection $directories, TestFileCollection $files, FileCollection $exclude)
{
$this->name = $name;
$this->directories = $directories;
$this->files = $files;
$this->exclude = $exclude;
}
public function name(): string
{
return $this->name;
}
public function directories(): TestDirectoryCollection
{
return $this->directories;
}
public function files(): TestFileCollection
{
return $this->files;
}
public function exclude(): FileCollection
{
return $this->exclude;
}
}
PK [+8x0 0 = src/TextUI/XmlConfiguration/Group/GroupCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class GroupCollectionIterator implements Countable, Iterator
{
/**
* @var Group[]
*/
private $groups;
/**
* @var int
*/
private $position;
public function __construct(GroupCollection $groups)
{
$this->groups = $groups->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->groups);
}
public function key(): int
{
return $this->position;
}
public function current(): Group
{
return $this->groups[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [&H + src/TextUI/XmlConfiguration/Group/Group.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Group
{
/**
* @var string
*/
private $name;
public function __construct(string $name)
{
$this->name = $name;
}
public function name(): string
{
return $this->name;
}
}
PK [A yX X , src/TextUI/XmlConfiguration/Group/Groups.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Groups
{
/**
* @var GroupCollection
*/
private $include;
/**
* @var GroupCollection
*/
private $exclude;
public function __construct(GroupCollection $include, GroupCollection $exclude)
{
$this->include = $include;
$this->exclude = $exclude;
}
public function hasInclude(): bool
{
return !$this->include->isEmpty();
}
public function include(): GroupCollection
{
return $this->include;
}
public function hasExclude(): bool
{
return !$this->exclude->isEmpty();
}
public function exclude(): GroupCollection
{
return $this->exclude;
}
}
PK [:P1 5 src/TextUI/XmlConfiguration/Group/GroupCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class GroupCollection implements IteratorAggregate
{
/**
* @var Group[]
*/
private $groups;
/**
* @param Group[] $groups
*/
public static function fromArray(array $groups): self
{
return new self(...$groups);
}
private function __construct(Group ...$groups)
{
$this->groups = $groups;
}
/**
* @return Group[]
*/
public function asArray(): array
{
return $this->groups;
}
/**
* @return string[]
*/
public function asArrayOfStrings(): array
{
$result = [];
foreach ($this->groups as $group) {
$result[] = $group->name();
}
return $result;
}
public function isEmpty(): bool
{
return empty($this->groups);
}
public function getIterator(): GroupCollectionIterator
{
return new GroupCollectionIterator($this);
}
}
PK [0] 0 src/TextUI/XmlConfiguration/Logging/TeamCity.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\Logging;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class TeamCity
{
/**
* @var File
*/
private $target;
public function __construct(File $target)
{
$this->target = $target;
}
public function target(): File
{
return $this->target;
}
}
PK [> - src/TextUI/XmlConfiguration/Logging/Junit.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\Logging;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Junit
{
/**
* @var File
*/
private $target;
public function __construct(File $target)
{
$this->target = $target;
}
public function target(): File
{
return $this->target;
}
}
PK [H , src/TextUI/XmlConfiguration/Logging/Text.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\Logging;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Text
{
/**
* @var File
*/
private $target;
public function __construct(File $target)
{
$this->target = $target;
}
public function target(): File
{
return $this->target;
}
}
PK [O
/ src/TextUI/XmlConfiguration/Logging/Logging.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\Logging;
use PHPUnit\TextUI\XmlConfiguration\Exception;
use PHPUnit\TextUI\XmlConfiguration\Logging\TestDox\Html as TestDoxHtml;
use PHPUnit\TextUI\XmlConfiguration\Logging\TestDox\Text as TestDoxText;
use PHPUnit\TextUI\XmlConfiguration\Logging\TestDox\Xml as TestDoxXml;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Logging
{
/**
* @var ?Junit
*/
private $junit;
/**
* @var ?Text
*/
private $text;
/**
* @var ?TeamCity
*/
private $teamCity;
/**
* @var ?TestDoxHtml
*/
private $testDoxHtml;
/**
* @var ?TestDoxText
*/
private $testDoxText;
/**
* @var ?TestDoxXml
*/
private $testDoxXml;
public function __construct(?Junit $junit, ?Text $text, ?TeamCity $teamCity, ?TestDoxHtml $testDoxHtml, ?TestDoxText $testDoxText, ?TestDoxXml $testDoxXml)
{
$this->junit = $junit;
$this->text = $text;
$this->teamCity = $teamCity;
$this->testDoxHtml = $testDoxHtml;
$this->testDoxText = $testDoxText;
$this->testDoxXml = $testDoxXml;
}
public function hasJunit(): bool
{
return $this->junit !== null;
}
public function junit(): Junit
{
if ($this->junit === null) {
throw new Exception('Logger "JUnit XML" is not configured');
}
return $this->junit;
}
public function hasText(): bool
{
return $this->text !== null;
}
public function text(): Text
{
if ($this->text === null) {
throw new Exception('Logger "Text" is not configured');
}
return $this->text;
}
public function hasTeamCity(): bool
{
return $this->teamCity !== null;
}
public function teamCity(): TeamCity
{
if ($this->teamCity === null) {
throw new Exception('Logger "Team City" is not configured');
}
return $this->teamCity;
}
public function hasTestDoxHtml(): bool
{
return $this->testDoxHtml !== null;
}
public function testDoxHtml(): TestDoxHtml
{
if ($this->testDoxHtml === null) {
throw new Exception('Logger "TestDox HTML" is not configured');
}
return $this->testDoxHtml;
}
public function hasTestDoxText(): bool
{
return $this->testDoxText !== null;
}
public function testDoxText(): TestDoxText
{
if ($this->testDoxText === null) {
throw new Exception('Logger "TestDox Text" is not configured');
}
return $this->testDoxText;
}
public function hasTestDoxXml(): bool
{
return $this->testDoxXml !== null;
}
public function testDoxXml(): TestDoxXml
{
if ($this->testDoxXml === null) {
throw new Exception('Logger "TestDox XML" is not configured');
}
return $this->testDoxXml;
}
}
PK [?4 3 src/TextUI/XmlConfiguration/Logging/TestDox/Xml.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\Logging\TestDox;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Xml
{
/**
* @var File
*/
private $target;
public function __construct(File $target)
{
$this->target = $target;
}
public function target(): File
{
return $this->target;
}
}
PK [ 4 src/TextUI/XmlConfiguration/Logging/TestDox/Text.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\Logging\TestDox;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Text
{
/**
* @var File
*/
private $target;
public function __construct(File $target)
{
$this->target = $target;
}
public function target(): File
{
return $this->target;
}
}
PK [%x: 4 src/TextUI/XmlConfiguration/Logging/TestDox/Html.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\Logging\TestDox;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Html
{
/**
* @var File
*/
private $target;
public function __construct(File $target)
{
$this->target = $target;
}
public function target(): File
{
return $this->target;
}
}
PK [Ǿ & src/TextUI/XmlConfiguration/Loader.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use const DIRECTORY_SEPARATOR;
use const PHP_VERSION;
use function assert;
use function defined;
use function dirname;
use function explode;
use function is_file;
use function is_numeric;
use function preg_match;
use function stream_resolve_include_path;
use function strlen;
use function strpos;
use function strtolower;
use function substr;
use function trim;
use DOMDocument;
use DOMElement;
use DOMNodeList;
use DOMXPath;
use PHPUnit\Runner\TestSuiteSorter;
use PHPUnit\Runner\Version;
use PHPUnit\TextUI\DefaultResultPrinter;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\CodeCoverage;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Filter\Directory as FilterDirectory;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Filter\DirectoryCollection as FilterDirectoryCollection;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Clover;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Cobertura;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Crap4j;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Html as CodeCoverageHtml;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Php as CodeCoveragePhp;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Text as CodeCoverageText;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Xml as CodeCoverageXml;
use PHPUnit\TextUI\XmlConfiguration\Logging\Junit;
use PHPUnit\TextUI\XmlConfiguration\Logging\Logging;
use PHPUnit\TextUI\XmlConfiguration\Logging\TeamCity;
use PHPUnit\TextUI\XmlConfiguration\Logging\TestDox\Html as TestDoxHtml;
use PHPUnit\TextUI\XmlConfiguration\Logging\TestDox\Text as TestDoxText;
use PHPUnit\TextUI\XmlConfiguration\Logging\TestDox\Xml as TestDoxXml;
use PHPUnit\TextUI\XmlConfiguration\Logging\Text;
use PHPUnit\TextUI\XmlConfiguration\TestSuite as TestSuiteConfiguration;
use PHPUnit\Util\TestDox\CliTestDoxPrinter;
use PHPUnit\Util\VersionComparisonOperator;
use PHPUnit\Util\Xml;
use PHPUnit\Util\Xml\Exception as XmlException;
use PHPUnit\Util\Xml\Loader as XmlLoader;
use PHPUnit\Util\Xml\SchemaFinder;
use PHPUnit\Util\Xml\Validator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Loader
{
/**
* @throws Exception
*/
public function load(string $filename): Configuration
{
try {
$document = (new XmlLoader)->loadFile($filename, false, true, true);
} catch (XmlException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
$xpath = new DOMXPath($document);
try {
$xsdFilename = (new SchemaFinder)->find(Version::series());
} catch (XmlException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
return new Configuration(
$filename,
(new Validator)->validate($document, $xsdFilename),
$this->extensions($filename, $xpath),
$this->codeCoverage($filename, $xpath, $document),
$this->groups($xpath),
$this->testdoxGroups($xpath),
$this->listeners($filename, $xpath),
$this->logging($filename, $xpath),
$this->php($filename, $xpath),
$this->phpunit($filename, $document),
$this->testSuite($filename, $xpath)
);
}
public function logging(string $filename, DOMXPath $xpath): Logging
{
if ($xpath->query('logging/log')->length !== 0) {
return $this->legacyLogging($filename, $xpath);
}
$junit = null;
$element = $this->element($xpath, 'logging/junit');
if ($element) {
$junit = new Junit(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
)
);
}
$text = null;
$element = $this->element($xpath, 'logging/text');
if ($element) {
$text = new Text(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
)
);
}
$teamCity = null;
$element = $this->element($xpath, 'logging/teamcity');
if ($element) {
$teamCity = new TeamCity(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
)
);
}
$testDoxHtml = null;
$element = $this->element($xpath, 'logging/testdoxHtml');
if ($element) {
$testDoxHtml = new TestDoxHtml(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
)
);
}
$testDoxText = null;
$element = $this->element($xpath, 'logging/testdoxText');
if ($element) {
$testDoxText = new TestDoxText(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
)
);
}
$testDoxXml = null;
$element = $this->element($xpath, 'logging/testdoxXml');
if ($element) {
$testDoxXml = new TestDoxXml(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
)
);
}
return new Logging(
$junit,
$text,
$teamCity,
$testDoxHtml,
$testDoxText,
$testDoxXml
);
}
public function legacyLogging(string $filename, DOMXPath $xpath): Logging
{
$junit = null;
$teamCity = null;
$testDoxHtml = null;
$testDoxText = null;
$testDoxXml = null;
$text = null;
foreach ($xpath->query('logging/log') as $log) {
assert($log instanceof DOMElement);
$type = (string) $log->getAttribute('type');
$target = (string) $log->getAttribute('target');
if (!$target) {
continue;
}
$target = $this->toAbsolutePath($filename, $target);
switch ($type) {
case 'plain':
$text = new Text(
new File($target)
);
break;
case 'junit':
$junit = new Junit(
new File($target)
);
break;
case 'teamcity':
$teamCity = new TeamCity(
new File($target)
);
break;
case 'testdox-html':
$testDoxHtml = new TestDoxHtml(
new File($target)
);
break;
case 'testdox-text':
$testDoxText = new TestDoxText(
new File($target)
);
break;
case 'testdox-xml':
$testDoxXml = new TestDoxXml(
new File($target)
);
break;
}
}
return new Logging(
$junit,
$text,
$teamCity,
$testDoxHtml,
$testDoxText,
$testDoxXml
);
}
private function extensions(string $filename, DOMXPath $xpath): ExtensionCollection
{
$extensions = [];
foreach ($xpath->query('extensions/extension') as $extension) {
assert($extension instanceof DOMElement);
$extensions[] = $this->getElementConfigurationParameters($filename, $extension);
}
return ExtensionCollection::fromArray($extensions);
}
private function getElementConfigurationParameters(string $filename, DOMElement $element): Extension
{
/** @psalm-var class-string $class */
$class = (string) $element->getAttribute('class');
$file = '';
$arguments = $this->getConfigurationArguments($filename, $element->childNodes);
if ($element->getAttribute('file')) {
$file = $this->toAbsolutePath(
$filename,
(string) $element->getAttribute('file'),
true
);
}
return new Extension($class, $file, $arguments);
}
private function toAbsolutePath(string $filename, string $path, bool $useIncludePath = false): string
{
$path = trim($path);
if (strpos($path, '/') === 0) {
return $path;
}
// Matches the following on Windows:
// - \\NetworkComputer\Path
// - \\.\D:
// - \\.\c:
// - C:\Windows
// - C:\windows
// - C:/windows
// - c:/windows
if (defined('PHP_WINDOWS_VERSION_BUILD') &&
($path[0] === '\\' || (strlen($path) >= 3 && preg_match('#^[A-Z]\:[/\\\]#i', substr($path, 0, 3))))) {
return $path;
}
if (strpos($path, '://') !== false) {
return $path;
}
$file = dirname($filename) . DIRECTORY_SEPARATOR . $path;
if ($useIncludePath && !is_file($file)) {
$includePathFile = stream_resolve_include_path($path);
if ($includePathFile) {
$file = $includePathFile;
}
}
return $file;
}
private function getConfigurationArguments(string $filename, DOMNodeList $nodes): array
{
$arguments = [];
if ($nodes->length === 0) {
return $arguments;
}
foreach ($nodes as $node) {
if (!$node instanceof DOMElement) {
continue;
}
if ($node->tagName !== 'arguments') {
continue;
}
foreach ($node->childNodes as $argument) {
if (!$argument instanceof DOMElement) {
continue;
}
if ($argument->tagName === 'file' || $argument->tagName === 'directory') {
$arguments[] = $this->toAbsolutePath($filename, (string) $argument->textContent);
} else {
$arguments[] = Xml::xmlToVariable($argument);
}
}
}
return $arguments;
}
private function codeCoverage(string $filename, DOMXPath $xpath, DOMDocument $document): CodeCoverage
{
if ($xpath->query('filter/whitelist')->length !== 0) {
return $this->legacyCodeCoverage($filename, $xpath, $document);
}
$cacheDirectory = null;
$pathCoverage = false;
$includeUncoveredFiles = true;
$processUncoveredFiles = false;
$ignoreDeprecatedCodeUnits = false;
$disableCodeCoverageIgnore = false;
$element = $this->element($xpath, 'coverage');
if ($element) {
$cacheDirectory = $this->getStringAttribute($element, 'cacheDirectory');
if ($cacheDirectory !== null) {
$cacheDirectory = new Directory(
$this->toAbsolutePath($filename, $cacheDirectory)
);
}
$pathCoverage = $this->getBooleanAttribute(
$element,
'pathCoverage',
false
);
$includeUncoveredFiles = $this->getBooleanAttribute(
$element,
'includeUncoveredFiles',
true
);
$processUncoveredFiles = $this->getBooleanAttribute(
$element,
'processUncoveredFiles',
false
);
$ignoreDeprecatedCodeUnits = $this->getBooleanAttribute(
$element,
'ignoreDeprecatedCodeUnits',
false
);
$disableCodeCoverageIgnore = $this->getBooleanAttribute(
$element,
'disableCodeCoverageIgnore',
false
);
}
$clover = null;
$element = $this->element($xpath, 'coverage/report/clover');
if ($element) {
$clover = new Clover(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
)
);
}
$cobertura = null;
$element = $this->element($xpath, 'coverage/report/cobertura');
if ($element) {
$cobertura = new Cobertura(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
)
);
}
$crap4j = null;
$element = $this->element($xpath, 'coverage/report/crap4j');
if ($element) {
$crap4j = new Crap4j(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
),
$this->getIntegerAttribute($element, 'threshold', 30)
);
}
$html = null;
$element = $this->element($xpath, 'coverage/report/html');
if ($element) {
$html = new CodeCoverageHtml(
new Directory(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputDirectory')
)
),
$this->getIntegerAttribute($element, 'lowUpperBound', 50),
$this->getIntegerAttribute($element, 'highLowerBound', 90)
);
}
$php = null;
$element = $this->element($xpath, 'coverage/report/php');
if ($element) {
$php = new CodeCoveragePhp(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
)
);
}
$text = null;
$element = $this->element($xpath, 'coverage/report/text');
if ($element) {
$text = new CodeCoverageText(
new File(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputFile')
)
),
$this->getBooleanAttribute($element, 'showUncoveredFiles', false),
$this->getBooleanAttribute($element, 'showOnlySummary', false)
);
}
$xml = null;
$element = $this->element($xpath, 'coverage/report/xml');
if ($element) {
$xml = new CodeCoverageXml(
new Directory(
$this->toAbsolutePath(
$filename,
(string) $this->getStringAttribute($element, 'outputDirectory')
)
)
);
}
return new CodeCoverage(
$cacheDirectory,
$this->readFilterDirectories($filename, $xpath, 'coverage/include/directory'),
$this->readFilterFiles($filename, $xpath, 'coverage/include/file'),
$this->readFilterDirectories($filename, $xpath, 'coverage/exclude/directory'),
$this->readFilterFiles($filename, $xpath, 'coverage/exclude/file'),
$pathCoverage,
$includeUncoveredFiles,
$processUncoveredFiles,
$ignoreDeprecatedCodeUnits,
$disableCodeCoverageIgnore,
$clover,
$cobertura,
$crap4j,
$html,
$php,
$text,
$xml
);
}
/**
* @deprecated
*/
private function legacyCodeCoverage(string $filename, DOMXPath $xpath, DOMDocument $document): CodeCoverage
{
$ignoreDeprecatedCodeUnits = $this->getBooleanAttribute(
$document->documentElement,
'ignoreDeprecatedCodeUnitsFromCodeCoverage',
false
);
$disableCodeCoverageIgnore = $this->getBooleanAttribute(
$document->documentElement,
'disableCodeCoverageIgnore',
false
);
$includeUncoveredFiles = true;
$processUncoveredFiles = false;
$element = $this->element($xpath, 'filter/whitelist');
if ($element) {
if ($element->hasAttribute('addUncoveredFilesFromWhitelist')) {
$includeUncoveredFiles = (bool) $this->getBoolean(
(string) $element->getAttribute('addUncoveredFilesFromWhitelist'),
true
);
}
if ($element->hasAttribute('processUncoveredFilesFromWhitelist')) {
$processUncoveredFiles = (bool) $this->getBoolean(
(string) $element->getAttribute('processUncoveredFilesFromWhitelist'),
false
);
}
}
$clover = null;
$cobertura = null;
$crap4j = null;
$html = null;
$php = null;
$text = null;
$xml = null;
foreach ($xpath->query('logging/log') as $log) {
assert($log instanceof DOMElement);
$type = (string) $log->getAttribute('type');
$target = (string) $log->getAttribute('target');
if (!$target) {
continue;
}
$target = $this->toAbsolutePath($filename, $target);
switch ($type) {
case 'coverage-clover':
$clover = new Clover(
new File($target)
);
break;
case 'coverage-cobertura':
$cobertura = new Cobertura(
new File($target)
);
break;
case 'coverage-crap4j':
$crap4j = new Crap4j(
new File($target),
$this->getIntegerAttribute($log, 'threshold', 30)
);
break;
case 'coverage-html':
$html = new CodeCoverageHtml(
new Directory($target),
$this->getIntegerAttribute($log, 'lowUpperBound', 50),
$this->getIntegerAttribute($log, 'highLowerBound', 90)
);
break;
case 'coverage-php':
$php = new CodeCoveragePhp(
new File($target)
);
break;
case 'coverage-text':
$text = new CodeCoverageText(
new File($target),
$this->getBooleanAttribute($log, 'showUncoveredFiles', false),
$this->getBooleanAttribute($log, 'showOnlySummary', false)
);
break;
case 'coverage-xml':
$xml = new CodeCoverageXml(
new Directory($target)
);
break;
}
}
return new CodeCoverage(
null,
$this->readFilterDirectories($filename, $xpath, 'filter/whitelist/directory'),
$this->readFilterFiles($filename, $xpath, 'filter/whitelist/file'),
$this->readFilterDirectories($filename, $xpath, 'filter/whitelist/exclude/directory'),
$this->readFilterFiles($filename, $xpath, 'filter/whitelist/exclude/file'),
false,
$includeUncoveredFiles,
$processUncoveredFiles,
$ignoreDeprecatedCodeUnits,
$disableCodeCoverageIgnore,
$clover,
$cobertura,
$crap4j,
$html,
$php,
$text,
$xml
);
}
/**
* If $value is 'false' or 'true', this returns the value that $value represents.
* Otherwise, returns $default, which may be a string in rare cases.
*
* @see \PHPUnit\TextUI\XmlConfigurationTest::testPHPConfigurationIsReadCorrectly
*
* @param bool|string $default
*
* @return bool|string
*/
private function getBoolean(string $value, $default)
{
if (strtolower($value) === 'false') {
return false;
}
if (strtolower($value) === 'true') {
return true;
}
return $default;
}
private function readFilterDirectories(string $filename, DOMXPath $xpath, string $query): FilterDirectoryCollection
{
$directories = [];
foreach ($xpath->query($query) as $directoryNode) {
assert($directoryNode instanceof DOMElement);
$directoryPath = (string) $directoryNode->textContent;
if (!$directoryPath) {
continue;
}
$directories[] = new FilterDirectory(
$this->toAbsolutePath($filename, $directoryPath),
$directoryNode->hasAttribute('prefix') ? (string) $directoryNode->getAttribute('prefix') : '',
$directoryNode->hasAttribute('suffix') ? (string) $directoryNode->getAttribute('suffix') : '.php',
$directoryNode->hasAttribute('group') ? (string) $directoryNode->getAttribute('group') : 'DEFAULT'
);
}
return FilterDirectoryCollection::fromArray($directories);
}
private function readFilterFiles(string $filename, DOMXPath $xpath, string $query): FileCollection
{
$files = [];
foreach ($xpath->query($query) as $file) {
$filePath = (string) $file->textContent;
if ($filePath) {
$files[] = new File($this->toAbsolutePath($filename, $filePath));
}
}
return FileCollection::fromArray($files);
}
private function groups(DOMXPath $xpath): Groups
{
return $this->parseGroupConfiguration($xpath, 'groups');
}
private function testdoxGroups(DOMXPath $xpath): Groups
{
return $this->parseGroupConfiguration($xpath, 'testdoxGroups');
}
private function parseGroupConfiguration(DOMXPath $xpath, string $root): Groups
{
$include = [];
$exclude = [];
foreach ($xpath->query($root . '/include/group') as $group) {
$include[] = new Group((string) $group->textContent);
}
foreach ($xpath->query($root . '/exclude/group') as $group) {
$exclude[] = new Group((string) $group->textContent);
}
return new Groups(
GroupCollection::fromArray($include),
GroupCollection::fromArray($exclude)
);
}
private function listeners(string $filename, DOMXPath $xpath): ExtensionCollection
{
$listeners = [];
foreach ($xpath->query('listeners/listener') as $listener) {
assert($listener instanceof DOMElement);
$listeners[] = $this->getElementConfigurationParameters($filename, $listener);
}
return ExtensionCollection::fromArray($listeners);
}
private function getBooleanAttribute(DOMElement $element, string $attribute, bool $default): bool
{
if (!$element->hasAttribute($attribute)) {
return $default;
}
return (bool) $this->getBoolean(
(string) $element->getAttribute($attribute),
false
);
}
private function getIntegerAttribute(DOMElement $element, string $attribute, int $default): int
{
if (!$element->hasAttribute($attribute)) {
return $default;
}
return $this->getInteger(
(string) $element->getAttribute($attribute),
$default
);
}
private function getStringAttribute(DOMElement $element, string $attribute): ?string
{
if (!$element->hasAttribute($attribute)) {
return null;
}
return (string) $element->getAttribute($attribute);
}
private function getInteger(string $value, int $default): int
{
if (is_numeric($value)) {
return (int) $value;
}
return $default;
}
private function php(string $filename, DOMXPath $xpath): Php
{
$includePaths = [];
foreach ($xpath->query('php/includePath') as $includePath) {
$path = (string) $includePath->textContent;
if ($path) {
$includePaths[] = new Directory($this->toAbsolutePath($filename, $path));
}
}
$iniSettings = [];
foreach ($xpath->query('php/ini') as $ini) {
assert($ini instanceof DOMElement);
$iniSettings[] = new IniSetting(
(string) $ini->getAttribute('name'),
(string) $ini->getAttribute('value')
);
}
$constants = [];
foreach ($xpath->query('php/const') as $const) {
assert($const instanceof DOMElement);
$value = (string) $const->getAttribute('value');
$constants[] = new Constant(
(string) $const->getAttribute('name'),
$this->getBoolean($value, $value)
);
}
$variables = [
'var' => [],
'env' => [],
'post' => [],
'get' => [],
'cookie' => [],
'server' => [],
'files' => [],
'request' => [],
];
foreach (['var', 'env', 'post', 'get', 'cookie', 'server', 'files', 'request'] as $array) {
foreach ($xpath->query('php/' . $array) as $var) {
assert($var instanceof DOMElement);
$name = (string) $var->getAttribute('name');
$value = (string) $var->getAttribute('value');
$force = false;
$verbatim = false;
if ($var->hasAttribute('force')) {
$force = (bool) $this->getBoolean($var->getAttribute('force'), false);
}
if ($var->hasAttribute('verbatim')) {
$verbatim = $this->getBoolean($var->getAttribute('verbatim'), false);
}
if (!$verbatim) {
$value = $this->getBoolean($value, $value);
}
$variables[$array][] = new Variable($name, $value, $force);
}
}
return new Php(
DirectoryCollection::fromArray($includePaths),
IniSettingCollection::fromArray($iniSettings),
ConstantCollection::fromArray($constants),
VariableCollection::fromArray($variables['var']),
VariableCollection::fromArray($variables['env']),
VariableCollection::fromArray($variables['post']),
VariableCollection::fromArray($variables['get']),
VariableCollection::fromArray($variables['cookie']),
VariableCollection::fromArray($variables['server']),
VariableCollection::fromArray($variables['files']),
VariableCollection::fromArray($variables['request']),
);
}
private function phpunit(string $filename, DOMDocument $document): PHPUnit
{
$executionOrder = TestSuiteSorter::ORDER_DEFAULT;
$defectsFirst = false;
$resolveDependencies = $this->getBooleanAttribute($document->documentElement, 'resolveDependencies', true);
if ($document->documentElement->hasAttribute('executionOrder')) {
foreach (explode(',', $document->documentElement->getAttribute('executionOrder')) as $order) {
switch ($order) {
case 'default':
$executionOrder = TestSuiteSorter::ORDER_DEFAULT;
$defectsFirst = false;
$resolveDependencies = true;
break;
case 'depends':
$resolveDependencies = true;
break;
case 'no-depends':
$resolveDependencies = false;
break;
case 'defects':
$defectsFirst = true;
break;
case 'duration':
$executionOrder = TestSuiteSorter::ORDER_DURATION;
break;
case 'random':
$executionOrder = TestSuiteSorter::ORDER_RANDOMIZED;
break;
case 'reverse':
$executionOrder = TestSuiteSorter::ORDER_REVERSED;
break;
case 'size':
$executionOrder = TestSuiteSorter::ORDER_SIZE;
break;
}
}
}
$printerClass = $this->getStringAttribute($document->documentElement, 'printerClass');
$testdox = $this->getBooleanAttribute($document->documentElement, 'testdox', false);
$conflictBetweenPrinterClassAndTestdox = false;
if ($testdox) {
if ($printerClass !== null) {
$conflictBetweenPrinterClassAndTestdox = true;
}
$printerClass = CliTestDoxPrinter::class;
}
$cacheResultFile = $this->getStringAttribute($document->documentElement, 'cacheResultFile');
if ($cacheResultFile !== null) {
$cacheResultFile = $this->toAbsolutePath($filename, $cacheResultFile);
}
$bootstrap = $this->getStringAttribute($document->documentElement, 'bootstrap');
if ($bootstrap !== null) {
$bootstrap = $this->toAbsolutePath($filename, $bootstrap);
}
$extensionsDirectory = $this->getStringAttribute($document->documentElement, 'extensionsDirectory');
if ($extensionsDirectory !== null) {
$extensionsDirectory = $this->toAbsolutePath($filename, $extensionsDirectory);
}
$testSuiteLoaderFile = $this->getStringAttribute($document->documentElement, 'testSuiteLoaderFile');
if ($testSuiteLoaderFile !== null) {
$testSuiteLoaderFile = $this->toAbsolutePath($filename, $testSuiteLoaderFile);
}
$printerFile = $this->getStringAttribute($document->documentElement, 'printerFile');
if ($printerFile !== null) {
$printerFile = $this->toAbsolutePath($filename, $printerFile);
}
return new PHPUnit(
$this->getBooleanAttribute($document->documentElement, 'cacheResult', true),
$cacheResultFile,
$this->getColumns($document),
$this->getColors($document),
$this->getBooleanAttribute($document->documentElement, 'stderr', false),
$this->getBooleanAttribute($document->documentElement, 'noInteraction', false),
$this->getBooleanAttribute($document->documentElement, 'verbose', false),
$this->getBooleanAttribute($document->documentElement, 'reverseDefectList', false),
$this->getBooleanAttribute($document->documentElement, 'convertDeprecationsToExceptions', false),
$this->getBooleanAttribute($document->documentElement, 'convertErrorsToExceptions', true),
$this->getBooleanAttribute($document->documentElement, 'convertNoticesToExceptions', true),
$this->getBooleanAttribute($document->documentElement, 'convertWarningsToExceptions', true),
$this->getBooleanAttribute($document->documentElement, 'forceCoversAnnotation', false),
$bootstrap,
$this->getBooleanAttribute($document->documentElement, 'processIsolation', false),
$this->getBooleanAttribute($document->documentElement, 'failOnEmptyTestSuite', false),
$this->getBooleanAttribute($document->documentElement, 'failOnIncomplete', false),
$this->getBooleanAttribute($document->documentElement, 'failOnRisky', false),
$this->getBooleanAttribute($document->documentElement, 'failOnSkipped', false),
$this->getBooleanAttribute($document->documentElement, 'failOnWarning', false),
$this->getBooleanAttribute($document->documentElement, 'stopOnDefect', false),
$this->getBooleanAttribute($document->documentElement, 'stopOnError', false),
$this->getBooleanAttribute($document->documentElement, 'stopOnFailure', false),
$this->getBooleanAttribute($document->documentElement, 'stopOnWarning', false),
$this->getBooleanAttribute($document->documentElement, 'stopOnIncomplete', false),
$this->getBooleanAttribute($document->documentElement, 'stopOnRisky', false),
$this->getBooleanAttribute($document->documentElement, 'stopOnSkipped', false),
$extensionsDirectory,
$this->getStringAttribute($document->documentElement, 'testSuiteLoaderClass'),
$testSuiteLoaderFile,
$printerClass,
$printerFile,
$this->getBooleanAttribute($document->documentElement, 'beStrictAboutChangesToGlobalState', false),
$this->getBooleanAttribute($document->documentElement, 'beStrictAboutOutputDuringTests', false),
$this->getBooleanAttribute($document->documentElement, 'beStrictAboutResourceUsageDuringSmallTests', false),
$this->getBooleanAttribute($document->documentElement, 'beStrictAboutTestsThatDoNotTestAnything', true),
$this->getBooleanAttribute($document->documentElement, 'beStrictAboutTodoAnnotatedTests', false),
$this->getBooleanAttribute($document->documentElement, 'beStrictAboutCoversAnnotation', false),
$this->getBooleanAttribute($document->documentElement, 'enforceTimeLimit', false),
$this->getIntegerAttribute($document->documentElement, 'defaultTimeLimit', 1),
$this->getIntegerAttribute($document->documentElement, 'timeoutForSmallTests', 1),
$this->getIntegerAttribute($document->documentElement, 'timeoutForMediumTests', 10),
$this->getIntegerAttribute($document->documentElement, 'timeoutForLargeTests', 60),
$this->getStringAttribute($document->documentElement, 'defaultTestSuite'),
$executionOrder,
$resolveDependencies,
$defectsFirst,
$this->getBooleanAttribute($document->documentElement, 'backupGlobals', false),
$this->getBooleanAttribute($document->documentElement, 'backupStaticAttributes', false),
$this->getBooleanAttribute($document->documentElement, 'registerMockObjectsFromTestArgumentsRecursively', false),
$conflictBetweenPrinterClassAndTestdox
);
}
private function getColors(DOMDocument $document): string
{
$colors = DefaultResultPrinter::COLOR_DEFAULT;
if ($document->documentElement->hasAttribute('colors')) {
/* only allow boolean for compatibility with previous versions
'always' only allowed from command line */
if ($this->getBoolean($document->documentElement->getAttribute('colors'), false)) {
$colors = DefaultResultPrinter::COLOR_AUTO;
} else {
$colors = DefaultResultPrinter::COLOR_NEVER;
}
}
return $colors;
}
/**
* @return int|string
*/
private function getColumns(DOMDocument $document)
{
$columns = 80;
if ($document->documentElement->hasAttribute('columns')) {
$columns = (string) $document->documentElement->getAttribute('columns');
if ($columns !== 'max') {
$columns = $this->getInteger($columns, 80);
}
}
return $columns;
}
private function testSuite(string $filename, DOMXPath $xpath): TestSuiteCollection
{
$testSuites = [];
foreach ($this->getTestSuiteElements($xpath) as $element) {
$exclude = [];
foreach ($element->getElementsByTagName('exclude') as $excludeNode) {
$excludeFile = (string) $excludeNode->textContent;
if ($excludeFile) {
$exclude[] = new File($this->toAbsolutePath($filename, $excludeFile));
}
}
$directories = [];
foreach ($element->getElementsByTagName('directory') as $directoryNode) {
assert($directoryNode instanceof DOMElement);
$directory = (string) $directoryNode->textContent;
if (empty($directory)) {
continue;
}
$prefix = '';
if ($directoryNode->hasAttribute('prefix')) {
$prefix = (string) $directoryNode->getAttribute('prefix');
}
$suffix = 'Test.php';
if ($directoryNode->hasAttribute('suffix')) {
$suffix = (string) $directoryNode->getAttribute('suffix');
}
$phpVersion = PHP_VERSION;
if ($directoryNode->hasAttribute('phpVersion')) {
$phpVersion = (string) $directoryNode->getAttribute('phpVersion');
}
$phpVersionOperator = new VersionComparisonOperator('>=');
if ($directoryNode->hasAttribute('phpVersionOperator')) {
$phpVersionOperator = new VersionComparisonOperator((string) $directoryNode->getAttribute('phpVersionOperator'));
}
$directories[] = new TestDirectory(
$this->toAbsolutePath($filename, $directory),
$prefix,
$suffix,
$phpVersion,
$phpVersionOperator
);
}
$files = [];
foreach ($element->getElementsByTagName('file') as $fileNode) {
assert($fileNode instanceof DOMElement);
$file = (string) $fileNode->textContent;
if (empty($file)) {
continue;
}
$phpVersion = PHP_VERSION;
if ($fileNode->hasAttribute('phpVersion')) {
$phpVersion = (string) $fileNode->getAttribute('phpVersion');
}
$phpVersionOperator = new VersionComparisonOperator('>=');
if ($fileNode->hasAttribute('phpVersionOperator')) {
$phpVersionOperator = new VersionComparisonOperator((string) $fileNode->getAttribute('phpVersionOperator'));
}
$files[] = new TestFile(
$this->toAbsolutePath($filename, $file),
$phpVersion,
$phpVersionOperator
);
}
$testSuites[] = new TestSuiteConfiguration(
(string) $element->getAttribute('name'),
TestDirectoryCollection::fromArray($directories),
TestFileCollection::fromArray($files),
FileCollection::fromArray($exclude)
);
}
return TestSuiteCollection::fromArray($testSuites);
}
/**
* @return DOMElement[]
*/
private function getTestSuiteElements(DOMXPath $xpath): array
{
/** @var DOMElement[] $elements */
$elements = [];
$testSuiteNodes = $xpath->query('testsuites/testsuite');
if ($testSuiteNodes->length === 0) {
$testSuiteNodes = $xpath->query('testsuite');
}
if ($testSuiteNodes->length === 1) {
$element = $testSuiteNodes->item(0);
assert($element instanceof DOMElement);
$elements[] = $element;
} else {
foreach ($testSuiteNodes as $testSuiteNode) {
assert($testSuiteNode instanceof DOMElement);
$elements[] = $testSuiteNode;
}
}
return $elements;
}
private function element(DOMXPath $xpath, string $element): ?DOMElement
{
$nodes = $xpath->query($element);
if ($nodes->length === 1) {
$node = $nodes->item(0);
assert($node instanceof DOMElement);
return $node;
}
return null;
}
}
PK [4d . src/TextUI/XmlConfiguration/PHP/PhpHandler.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use const PATH_SEPARATOR;
use function constant;
use function define;
use function defined;
use function getenv;
use function implode;
use function ini_get;
use function ini_set;
use function putenv;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class PhpHandler
{
public function handle(Php $configuration): void
{
$this->handleIncludePaths($configuration->includePaths());
$this->handleIniSettings($configuration->iniSettings());
$this->handleConstants($configuration->constants());
$this->handleGlobalVariables($configuration->globalVariables());
$this->handleServerVariables($configuration->serverVariables());
$this->handleEnvVariables($configuration->envVariables());
$this->handleVariables('_POST', $configuration->postVariables());
$this->handleVariables('_GET', $configuration->getVariables());
$this->handleVariables('_COOKIE', $configuration->cookieVariables());
$this->handleVariables('_FILES', $configuration->filesVariables());
$this->handleVariables('_REQUEST', $configuration->requestVariables());
}
private function handleIncludePaths(DirectoryCollection $includePaths): void
{
if (!$includePaths->isEmpty()) {
$includePathsAsStrings = [];
foreach ($includePaths as $includePath) {
$includePathsAsStrings[] = $includePath->path();
}
ini_set(
'include_path',
implode(PATH_SEPARATOR, $includePathsAsStrings) .
PATH_SEPARATOR .
ini_get('include_path')
);
}
}
private function handleIniSettings(IniSettingCollection $iniSettings): void
{
foreach ($iniSettings as $iniSetting) {
$value = $iniSetting->value();
if (defined($value)) {
$value = (string) constant($value);
}
ini_set($iniSetting->name(), $value);
}
}
private function handleConstants(ConstantCollection $constants): void
{
foreach ($constants as $constant) {
if (!defined($constant->name())) {
define($constant->name(), $constant->value());
}
}
}
private function handleGlobalVariables(VariableCollection $variables): void
{
foreach ($variables as $variable) {
$GLOBALS[$variable->name()] = $variable->value();
}
}
private function handleServerVariables(VariableCollection $variables): void
{
foreach ($variables as $variable) {
$_SERVER[$variable->name()] = $variable->value();
}
}
private function handleVariables(string $target, VariableCollection $variables): void
{
foreach ($variables as $variable) {
$GLOBALS[$target][$variable->name()] = $variable->value();
}
}
private function handleEnvVariables(VariableCollection $variables): void
{
foreach ($variables as $variable) {
$name = $variable->name();
$value = $variable->value();
$force = $variable->force();
if ($force || getenv($name) === false) {
putenv("{$name}={$value}");
}
$value = getenv($name);
if ($force || !isset($_ENV[$name])) {
$_ENV[$name] = $value;
}
}
}
}
PK [Q Q > src/TextUI/XmlConfiguration/PHP/VariableCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class VariableCollectionIterator implements Countable, Iterator
{
/**
* @var Variable[]
*/
private $variables;
/**
* @var int
*/
private $position;
public function __construct(VariableCollection $variables)
{
$this->variables = $variables->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->variables);
}
public function key(): int
{
return $this->position;
}
public function current(): Variable
{
return $this->variables[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [.kK K . src/TextUI/XmlConfiguration/PHP/IniSetting.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class IniSetting
{
/**
* @var string
*/
private $name;
/**
* @var string
*/
private $value;
public function __construct(string $name, string $value)
{
$this->name = $name;
$this->value = $value;
}
public function name(): string
{
return $this->name;
}
public function value(): string
{
return $this->value;
}
}
PK [`2 6 src/TextUI/XmlConfiguration/PHP/ConstantCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use Countable;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class ConstantCollection implements Countable, IteratorAggregate
{
/**
* @var Constant[]
*/
private $constants;
/**
* @param Constant[] $constants
*/
public static function fromArray(array $constants): self
{
return new self(...$constants);
}
private function __construct(Constant ...$constants)
{
$this->constants = $constants;
}
/**
* @return Constant[]
*/
public function asArray(): array
{
return $this->constants;
}
public function count(): int
{
return count($this->constants);
}
public function getIterator(): ConstantCollectionIterator
{
return new ConstantCollectionIterator($this);
}
}
PK [r 6 src/TextUI/XmlConfiguration/PHP/VariableCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use Countable;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class VariableCollection implements Countable, IteratorAggregate
{
/**
* @var Variable[]
*/
private $variables;
/**
* @param Variable[] $variables
*/
public static function fromArray(array $variables): self
{
return new self(...$variables);
}
private function __construct(Variable ...$variables)
{
$this->variables = $variables;
}
/**
* @return Variable[]
*/
public function asArray(): array
{
return $this->variables;
}
public function count(): int
{
return count($this->variables);
}
public function getIterator(): VariableCollectionIterator
{
return new VariableCollectionIterator($this);
}
}
PK [_
+ + 8 src/TextUI/XmlConfiguration/PHP/IniSettingCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use Countable;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class IniSettingCollection implements Countable, IteratorAggregate
{
/**
* @var IniSetting[]
*/
private $iniSettings;
/**
* @param IniSetting[] $iniSettings
*/
public static function fromArray(array $iniSettings): self
{
return new self(...$iniSettings);
}
private function __construct(IniSetting ...$iniSettings)
{
$this->iniSettings = $iniSettings;
}
/**
* @return IniSetting[]
*/
public function asArray(): array
{
return $this->iniSettings;
}
public function count(): int
{
return count($this->iniSettings);
}
public function getIterator(): IniSettingCollectionIterator
{
return new IniSettingCollectionIterator($this);
}
}
PK [)oh
h
' src/TextUI/XmlConfiguration/PHP/Php.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Php
{
/**
* @var DirectoryCollection
*/
private $includePaths;
/**
* @var IniSettingCollection
*/
private $iniSettings;
/**
* @var ConstantCollection
*/
private $constants;
/**
* @var VariableCollection
*/
private $globalVariables;
/**
* @var VariableCollection
*/
private $envVariables;
/**
* @var VariableCollection
*/
private $postVariables;
/**
* @var VariableCollection
*/
private $getVariables;
/**
* @var VariableCollection
*/
private $cookieVariables;
/**
* @var VariableCollection
*/
private $serverVariables;
/**
* @var VariableCollection
*/
private $filesVariables;
/**
* @var VariableCollection
*/
private $requestVariables;
public function __construct(DirectoryCollection $includePaths, IniSettingCollection $iniSettings, ConstantCollection $constants, VariableCollection $globalVariables, VariableCollection $envVariables, VariableCollection $postVariables, VariableCollection $getVariables, VariableCollection $cookieVariables, VariableCollection $serverVariables, VariableCollection $filesVariables, VariableCollection $requestVariables)
{
$this->includePaths = $includePaths;
$this->iniSettings = $iniSettings;
$this->constants = $constants;
$this->globalVariables = $globalVariables;
$this->envVariables = $envVariables;
$this->postVariables = $postVariables;
$this->getVariables = $getVariables;
$this->cookieVariables = $cookieVariables;
$this->serverVariables = $serverVariables;
$this->filesVariables = $filesVariables;
$this->requestVariables = $requestVariables;
}
public function includePaths(): DirectoryCollection
{
return $this->includePaths;
}
public function iniSettings(): IniSettingCollection
{
return $this->iniSettings;
}
public function constants(): ConstantCollection
{
return $this->constants;
}
public function globalVariables(): VariableCollection
{
return $this->globalVariables;
}
public function envVariables(): VariableCollection
{
return $this->envVariables;
}
public function postVariables(): VariableCollection
{
return $this->postVariables;
}
public function getVariables(): VariableCollection
{
return $this->getVariables;
}
public function cookieVariables(): VariableCollection
{
return $this->cookieVariables;
}
public function serverVariables(): VariableCollection
{
return $this->serverVariables;
}
public function filesVariables(): VariableCollection
{
return $this->filesVariables;
}
public function requestVariables(): VariableCollection
{
return $this->requestVariables;
}
}
PK [㢆 , src/TextUI/XmlConfiguration/PHP/Variable.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Variable
{
/**
* @var string
*/
private $name;
/**
* @var mixed
*/
private $value;
/**
* @var bool
*/
private $force;
public function __construct(string $name, $value, bool $force)
{
$this->name = $name;
$this->value = $value;
$this->force = $force;
}
public function name(): string
{
return $this->name;
}
public function value()
{
return $this->value;
}
public function force(): bool
{
return $this->force;
}
}
PK [Q Q > src/TextUI/XmlConfiguration/PHP/ConstantCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class ConstantCollectionIterator implements Countable, Iterator
{
/**
* @var Constant[]
*/
private $constants;
/**
* @var int
*/
private $position;
public function __construct(ConstantCollection $constants)
{
$this->constants = $constants->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->constants);
}
public function key(): int
{
return $this->position;
}
public function current(): Constant
{
return $this->constants[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [
G/9 9 , src/TextUI/XmlConfiguration/PHP/Constant.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Constant
{
/**
* @var string
*/
private $name;
/**
* @var mixed
*/
private $value;
public function __construct(string $name, $value)
{
$this->name = $name;
$this->value = $value;
}
public function name(): string
{
return $this->name;
}
public function value()
{
return $this->value;
}
}
PK [i"g g @ src/TextUI/XmlConfiguration/PHP/IniSettingCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class IniSettingCollectionIterator implements Countable, Iterator
{
/**
* @var IniSetting[]
*/
private $iniSettings;
/**
* @var int
*/
private $position;
public function __construct(IniSettingCollection $iniSettings)
{
$this->iniSettings = $iniSettings->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->iniSettings);
}
public function key(): int
{
return $this->position;
}
public function current(): IniSetting
{
return $this->iniSettings[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [NzQ < src/TextUI/XmlConfiguration/Migration/MigrationException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MigrationException extends RuntimeException implements \PHPUnit\Exception
{
}
PK [1 C src/TextUI/XmlConfiguration/Migration/MigrationBuilderException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MigrationBuilderException extends RuntimeException implements \PHPUnit\Exception
{
}
PK [μ M src/TextUI/XmlConfiguration/Migration/Migrations/IntroduceCoverageElement.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMDocument;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class IntroduceCoverageElement implements Migration
{
public function migrate(DOMDocument $document): void
{
$coverage = $document->createElement('coverage');
$document->documentElement->insertBefore(
$coverage,
$document->documentElement->firstChild
);
}
}
PK [ F src/TextUI/XmlConfiguration/Migration/Migrations/RemoveEmptyFilter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function sprintf;
use DOMDocument;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class RemoveEmptyFilter implements Migration
{
/**
* @throws MigrationException
*/
public function migrate(DOMDocument $document): void
{
$whitelist = $document->getElementsByTagName('whitelist')->item(0);
if ($whitelist instanceof DOMElement) {
$this->ensureEmpty($whitelist);
$whitelist->parentNode->removeChild($whitelist);
}
$filter = $document->getElementsByTagName('filter')->item(0);
if ($filter instanceof DOMElement) {
$this->ensureEmpty($filter);
$filter->parentNode->removeChild($filter);
}
}
/**
* @throws MigrationException
*/
private function ensureEmpty(DOMElement $element): void
{
if ($element->attributes->length > 0) {
throw new MigrationException(sprintf('%s element has unexpected attributes', $element->nodeName));
}
if ($element->getElementsByTagName('*')->length > 0) {
throw new MigrationException(sprintf('%s element has unexpected children', $element->nodeName));
}
}
}
PK [ ~$ $ H src/TextUI/XmlConfiguration/Migration/Migrations/CoveragePhpToReport.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class CoveragePhpToReport extends LogToReportMigration
{
protected function forType(): string
{
return 'coverage-php';
}
protected function toReportFormat(DOMElement $logNode): DOMElement
{
$php = $logNode->ownerDocument->createElement('php');
$php->setAttribute('outputFile', $logNode->getAttribute('target'));
return $php;
}
}
PK ['(^k k T src/TextUI/XmlConfiguration/Migration/Migrations/MoveWhitelistExcludesToCoverage.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function assert;
use function in_array;
use DOMDocument;
use DOMElement;
use PHPUnit\Util\Xml\SnapshotNodeList;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MoveWhitelistExcludesToCoverage implements Migration
{
/**
* @throws MigrationException
*/
public function migrate(DOMDocument $document): void
{
$whitelist = $document->getElementsByTagName('whitelist')->item(0);
if ($whitelist === null) {
return;
}
$excludeNodes = SnapshotNodeList::fromNodeList($whitelist->getElementsByTagName('exclude'));
if ($excludeNodes->count() === 0) {
return;
}
$coverage = $document->getElementsByTagName('coverage')->item(0);
if (!$coverage instanceof DOMElement) {
throw new MigrationException('Unexpected state - No coverage element');
}
$targetExclude = $coverage->getElementsByTagName('exclude')->item(0);
if ($targetExclude === null) {
$targetExclude = $coverage->appendChild(
$document->createElement('exclude')
);
}
foreach ($excludeNodes as $excludeNode) {
assert($excludeNode instanceof DOMElement);
foreach (SnapshotNodeList::fromNodeList($excludeNode->childNodes) as $child) {
if (!$child instanceof DOMElement || !in_array($child->nodeName, ['directory', 'file'], true)) {
continue;
}
$targetExclude->appendChild($child);
}
if ($excludeNode->getElementsByTagName('*')->count() !== 0) {
throw new MigrationException('Dangling child elements in exclude found.');
}
$whitelist->removeChild($excludeNode);
}
}
}
PK [4 I src/TextUI/XmlConfiguration/Migration/Migrations/CoverageHtmlToReport.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class CoverageHtmlToReport extends LogToReportMigration
{
protected function forType(): string
{
return 'coverage-html';
}
protected function toReportFormat(DOMElement $logNode): DOMElement
{
$html = $logNode->ownerDocument->createElement('html');
$html->setAttribute('outputDirectory', $logNode->getAttribute('target'));
$this->migrateAttributes($logNode, $html, ['lowUpperBound', 'highLowerBound']);
return $html;
}
}
PK [ڬw{ { K src/TextUI/XmlConfiguration/Migration/Migrations/CoverageCrap4jToReport.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class CoverageCrap4jToReport extends LogToReportMigration
{
protected function forType(): string
{
return 'coverage-crap4j';
}
protected function toReportFormat(DOMElement $logNode): DOMElement
{
$crap4j = $logNode->ownerDocument->createElement('crap4j');
$crap4j->setAttribute('outputFile', $logNode->getAttribute('target'));
$this->migrateAttributes($logNode, $crap4j, ['threshold']);
return $crap4j;
}
}
PK [ M src/TextUI/XmlConfiguration/Migration/Migrations/UpdateSchemaLocationTo93.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMDocument;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class UpdateSchemaLocationTo93 implements Migration
{
public function migrate(DOMDocument $document): void
{
$document->documentElement->setAttributeNS(
'http://www.w3.org/2001/XMLSchema-instance',
'xsi:noNamespaceSchemaLocation',
'https://schema.phpunit.de/9.3/phpunit.xsd'
);
}
}
PK [?" I src/TextUI/XmlConfiguration/Migration/Migrations/CoverageTextToReport.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class CoverageTextToReport extends LogToReportMigration
{
protected function forType(): string
{
return 'coverage-text';
}
protected function toReportFormat(DOMElement $logNode): DOMElement
{
$text = $logNode->ownerDocument->createElement('text');
$text->setAttribute('outputFile', $logNode->getAttribute('target'));
$this->migrateAttributes($logNode, $text, ['showUncoveredFiles', 'showOnlySummary']);
return $text;
}
}
PK [t鱕 ` src/TextUI/XmlConfiguration/Migration/Migrations/MoveAttributesFromFilterWhitelistToCoverage.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMDocument;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MoveAttributesFromFilterWhitelistToCoverage implements Migration
{
/**
* @throws MigrationException
*/
public function migrate(DOMDocument $document): void
{
$whitelist = $document->getElementsByTagName('whitelist')->item(0);
if (!$whitelist) {
return;
}
$coverage = $document->getElementsByTagName('coverage')->item(0);
if (!$coverage instanceof DOMElement) {
throw new MigrationException('Unexpected state - No coverage element');
}
$map = [
'addUncoveredFilesFromWhitelist' => 'includeUncoveredFiles',
'processUncoveredFilesFromWhitelist' => 'processUncoveredFiles',
];
foreach ($map as $old => $new) {
if (!$whitelist->hasAttribute($old)) {
continue;
}
$coverage->setAttribute($new, $whitelist->getAttribute($old));
$whitelist->removeAttribute($old);
}
}
}
PK [
C7 7 U src/TextUI/XmlConfiguration/Migration/Migrations/MoveAttributesFromRootToCoverage.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMDocument;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MoveAttributesFromRootToCoverage implements Migration
{
/**
* @throws MigrationException
*/
public function migrate(DOMDocument $document): void
{
$map = [
'disableCodeCoverageIgnore' => 'disableCodeCoverageIgnore',
'ignoreDeprecatedCodeUnitsFromCodeCoverage' => 'ignoreDeprecatedCodeUnits',
];
$root = $document->documentElement;
$coverage = $document->getElementsByTagName('coverage')->item(0);
if (!$coverage instanceof DOMElement) {
throw new MigrationException('Unexpected state - No coverage element');
}
foreach ($map as $old => $new) {
if (!$root->hasAttribute($old)) {
continue;
}
$coverage->setAttribute($new, $root->getAttribute($old));
$root->removeAttribute($old);
}
}
}
PK [
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function sprintf;
use DOMDocument;
use DOMElement;
use DOMXPath;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
abstract class LogToReportMigration implements Migration
{
/**
* @throws MigrationException
*/
public function migrate(DOMDocument $document): void
{
$coverage = $document->getElementsByTagName('coverage')->item(0);
if (!$coverage instanceof DOMElement) {
throw new MigrationException('Unexpected state - No coverage element');
}
$logNode = $this->findLogNode($document);
if ($logNode === null) {
return;
}
$reportChild = $this->toReportFormat($logNode);
$report = $coverage->getElementsByTagName('report')->item(0);
if ($report === null) {
$report = $coverage->appendChild($document->createElement('report'));
}
$report->appendChild($reportChild);
$logNode->parentNode->removeChild($logNode);
}
protected function migrateAttributes(DOMElement $src, DOMElement $dest, array $attributes): void
{
foreach ($attributes as $attr) {
if (!$src->hasAttribute($attr)) {
continue;
}
$dest->setAttribute($attr, $src->getAttribute($attr));
$src->removeAttribute($attr);
}
}
abstract protected function forType(): string;
abstract protected function toReportFormat(DOMElement $logNode): DOMElement;
private function findLogNode(DOMDocument $document): ?DOMElement
{
$logNode = (new DOMXPath($document))->query(
sprintf('//logging/log[@type="%s"]', $this->forType())
)->item(0);
if (!$logNode instanceof DOMElement) {
return null;
}
return $logNode;
}
}
PK [
D src/TextUI/XmlConfiguration/Migration/Migrations/ConvertLogTypes.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMDocument;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ConvertLogTypes implements Migration
{
public function migrate(DOMDocument $document): void
{
$logging = $document->getElementsByTagName('logging')->item(0);
if (!$logging instanceof DOMElement) {
return;
}
$types = [
'junit' => 'junit',
'teamcity' => 'teamcity',
'testdox-html' => 'testdoxHtml',
'testdox-text' => 'testdoxText',
'testdox-xml' => 'testdoxXml',
'plain' => 'text',
];
$logNodes = [];
foreach ($logging->getElementsByTagName('log') as $logNode) {
if (!isset($types[$logNode->getAttribute('type')])) {
continue;
}
$logNodes[] = $logNode;
}
foreach ($logNodes as $oldNode) {
$newLogNode = $document->createElement($types[$oldNode->getAttribute('type')]);
$newLogNode->setAttribute('outputFile', $oldNode->getAttribute('target'));
$logging->replaceChild($newLogNode, $oldNode);
}
}
}
PK [qQf f W src/TextUI/XmlConfiguration/Migration/Migrations/MoveWhitelistDirectoriesToCoverage.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMDocument;
use DOMElement;
use PHPUnit\Util\Xml\SnapshotNodeList;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MoveWhitelistDirectoriesToCoverage implements Migration
{
/**
* @throws MigrationException
*/
public function migrate(DOMDocument $document): void
{
$whitelist = $document->getElementsByTagName('whitelist')->item(0);
if ($whitelist === null) {
return;
}
$coverage = $document->getElementsByTagName('coverage')->item(0);
if (!$coverage instanceof DOMElement) {
throw new MigrationException('Unexpected state - No coverage element');
}
$include = $document->createElement('include');
$coverage->appendChild($include);
foreach (SnapshotNodeList::fromNodeList($whitelist->childNodes) as $child) {
if (!$child instanceof DOMElement || $child->nodeName !== 'directory') {
continue;
}
$include->appendChild($child);
}
}
}
PK [ }9 O src/TextUI/XmlConfiguration/Migration/Migrations/RemoveCacheTokensAttribute.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMDocument;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class RemoveCacheTokensAttribute implements Migration
{
public function migrate(DOMDocument $document): void
{
$root = $document->documentElement;
if ($root->hasAttribute('cacheTokens')) {
$root->removeAttribute('cacheTokens');
}
}
}
PK [=6 6 K src/TextUI/XmlConfiguration/Migration/Migrations/CoverageCloverToReport.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class CoverageCloverToReport extends LogToReportMigration
{
protected function forType(): string
{
return 'coverage-clover';
}
protected function toReportFormat(DOMElement $logNode): DOMElement
{
$clover = $logNode->ownerDocument->createElement('clover');
$clover->setAttribute('outputFile', $logNode->getAttribute('target'));
return $clover;
}
}
PK [LUO O C src/TextUI/XmlConfiguration/Migration/Migrations/RemoveLogTypes.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function assert;
use DOMDocument;
use DOMElement;
use PHPUnit\Util\Xml\SnapshotNodeList;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class RemoveLogTypes implements Migration
{
public function migrate(DOMDocument $document): void
{
$logging = $document->getElementsByTagName('logging')->item(0);
if (!$logging instanceof DOMElement) {
return;
}
foreach (SnapshotNodeList::fromNodeList($logging->getElementsByTagName('log')) as $logNode) {
assert($logNode instanceof DOMElement);
switch ($logNode->getAttribute('type')) {
case 'json':
case 'tap':
$logging->removeChild($logNode);
}
}
}
}
PK ["a) ) H src/TextUI/XmlConfiguration/Migration/Migrations/CoverageXmlToReport.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMElement;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class CoverageXmlToReport extends LogToReportMigration
{
protected function forType(): string
{
return 'coverage-xml';
}
protected function toReportFormat(DOMElement $logNode): DOMElement
{
$xml = $logNode->ownerDocument->createElement('xml');
$xml->setAttribute('outputDirectory', $logNode->getAttribute('target'));
return $xml;
}
}
PK [: > src/TextUI/XmlConfiguration/Migration/Migrations/Migration.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use DOMDocument;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
interface Migration
{
public function migrate(DOMDocument $document): void;
}
PK [ 49 9 : src/TextUI/XmlConfiguration/Migration/MigrationBuilder.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function array_key_exists;
use function sprintf;
use function version_compare;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class MigrationBuilder
{
private const AVAILABLE_MIGRATIONS = [
'8.5' => [
RemoveLogTypes::class,
],
'9.2' => [
RemoveCacheTokensAttribute::class,
IntroduceCoverageElement::class,
MoveAttributesFromRootToCoverage::class,
MoveAttributesFromFilterWhitelistToCoverage::class,
MoveWhitelistDirectoriesToCoverage::class,
MoveWhitelistExcludesToCoverage::class,
RemoveEmptyFilter::class,
CoverageCloverToReport::class,
CoverageCrap4jToReport::class,
CoverageHtmlToReport::class,
CoveragePhpToReport::class,
CoverageTextToReport::class,
CoverageXmlToReport::class,
ConvertLogTypes::class,
UpdateSchemaLocationTo93::class,
],
];
/**
* @throws MigrationBuilderException
*/
public function build(string $fromVersion): array
{
if (!array_key_exists($fromVersion, self::AVAILABLE_MIGRATIONS)) {
throw new MigrationBuilderException(
sprintf(
'Migration from schema version %s is not supported',
$fromVersion
)
);
}
$stack = [];
foreach (self::AVAILABLE_MIGRATIONS as $version => $migrations) {
if (version_compare($version, $fromVersion, '<')) {
continue;
}
foreach ($migrations as $migration) {
$stack[] = new $migration;
}
}
return $stack;
}
}
PK [.3& & 2 src/TextUI/XmlConfiguration/Migration/Migrator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function sprintf;
use PHPUnit\Util\Xml\Exception as XmlException;
use PHPUnit\Util\Xml\Loader as XmlLoader;
use PHPUnit\Util\Xml\SchemaDetector;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Migrator
{
/**
* @throws Exception
* @throws MigrationBuilderException
* @throws MigrationException
* @throws XmlException
*/
public function migrate(string $filename): string
{
$origin = (new SchemaDetector)->detect($filename);
if (!$origin->detected()) {
throw new Exception(
sprintf(
'"%s" is not a valid PHPUnit XML configuration file that can be migrated',
$filename,
)
);
}
$configurationDocument = (new XmlLoader)->loadFile(
$filename,
false,
true,
true
);
foreach ((new MigrationBuilder)->build($origin->version()) as $migration) {
$migration->migrate($configurationDocument);
}
$configurationDocument->formatOutput = true;
$configurationDocument->preserveWhiteSpace = false;
return $configurationDocument->saveXML();
}
}
PK [h% - src/TextUI/XmlConfiguration/Configuration.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\CodeCoverage;
use PHPUnit\TextUI\XmlConfiguration\Logging\Logging;
use PHPUnit\Util\Xml\ValidationResult;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Configuration
{
/**
* @var string
*/
private $filename;
/**
* @var ValidationResult
*/
private $validationResult;
/**
* @var ExtensionCollection
*/
private $extensions;
/**
* @var CodeCoverage
*/
private $codeCoverage;
/**
* @var Groups
*/
private $groups;
/**
* @var Groups
*/
private $testdoxGroups;
/**
* @var ExtensionCollection
*/
private $listeners;
/**
* @var Logging
*/
private $logging;
/**
* @var Php
*/
private $php;
/**
* @var PHPUnit
*/
private $phpunit;
/**
* @var TestSuiteCollection
*/
private $testSuite;
public function __construct(string $filename, ValidationResult $validationResult, ExtensionCollection $extensions, CodeCoverage $codeCoverage, Groups $groups, Groups $testdoxGroups, ExtensionCollection $listeners, Logging $logging, Php $php, PHPUnit $phpunit, TestSuiteCollection $testSuite)
{
$this->filename = $filename;
$this->validationResult = $validationResult;
$this->extensions = $extensions;
$this->codeCoverage = $codeCoverage;
$this->groups = $groups;
$this->testdoxGroups = $testdoxGroups;
$this->listeners = $listeners;
$this->logging = $logging;
$this->php = $php;
$this->phpunit = $phpunit;
$this->testSuite = $testSuite;
}
public function filename(): string
{
return $this->filename;
}
public function hasValidationErrors(): bool
{
return $this->validationResult->hasValidationErrors();
}
public function validationErrors(): string
{
return $this->validationResult->asString();
}
public function extensions(): ExtensionCollection
{
return $this->extensions;
}
public function codeCoverage(): CodeCoverage
{
return $this->codeCoverage;
}
public function groups(): Groups
{
return $this->groups;
}
public function testdoxGroups(): Groups
{
return $this->testdoxGroups;
}
public function listeners(): ExtensionCollection
{
return $this->listeners;
}
public function logging(): Logging
{
return $this->logging;
}
public function php(): Php
{
return $this->php;
}
public function phpunit(): PHPUnit
{
return $this->phpunit;
}
public function testSuite(): TestSuiteCollection
{
return $this->testSuite;
}
}
PK [E1 ) src/TextUI/XmlConfiguration/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Exception extends RuntimeException implements \PHPUnit\Exception
{
}
PK [o ) src/TextUI/XmlConfiguration/Generator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function str_replace;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Generator
{
/**
* @var string
*/
private const TEMPLATE = <<<'EOT'
{tests_directory}
{src_directory}
EOT;
public function generateDefaultConfiguration(string $phpunitVersion, string $bootstrapScript, string $testsDirectory, string $srcDirectory, string $cacheDirectory): string
{
return str_replace(
[
'{phpunit_version}',
'{bootstrap_script}',
'{tests_directory}',
'{src_directory}',
'{cache_directory}',
],
[
$phpunitVersion,
$bootstrapScript,
$testsDirectory,
$srcDirectory,
$cacheDirectory,
],
self::TEMPLATE
);
}
}
PK [j* 1 src/TextUI/XmlConfiguration/PHPUnit/Extension.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Extension
{
/**
* @var string
*
* @psalm-var class-string
*/
private $className;
/**
* @var string
*/
private $sourceFile;
/**
* @var array
*/
private $arguments;
/**
* @psalm-param class-string $className
*/
public function __construct(string $className, string $sourceFile, array $arguments)
{
$this->className = $className;
$this->sourceFile = $sourceFile;
$this->arguments = $arguments;
}
/**
* @psalm-return class-string
*/
public function className(): string
{
return $this->className;
}
public function hasSourceFile(): bool
{
return $this->sourceFile !== '';
}
public function sourceFile(): string
{
return $this->sourceFile;
}
public function hasArguments(): bool
{
return !empty($this->arguments);
}
public function arguments(): array
{
return $this->arguments;
}
}
PK [>H >H / src/TextUI/XmlConfiguration/PHPUnit/PHPUnit.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class PHPUnit
{
/**
* @var bool
*/
private $cacheResult;
/**
* @var ?string
*/
private $cacheResultFile;
/**
* @var int|string
*/
private $columns;
/**
* @var string
*/
private $colors;
/**
* @var bool
*/
private $stderr;
/**
* @var bool
*/
private $noInteraction;
/**
* @var bool
*/
private $verbose;
/**
* @var bool
*/
private $reverseDefectList;
/**
* @var bool
*/
private $convertDeprecationsToExceptions;
/**
* @var bool
*/
private $convertErrorsToExceptions;
/**
* @var bool
*/
private $convertNoticesToExceptions;
/**
* @var bool
*/
private $convertWarningsToExceptions;
/**
* @var bool
*/
private $forceCoversAnnotation;
/**
* @var ?string
*/
private $bootstrap;
/**
* @var bool
*/
private $processIsolation;
/**
* @var bool
*/
private $failOnEmptyTestSuite;
/**
* @var bool
*/
private $failOnIncomplete;
/**
* @var bool
*/
private $failOnRisky;
/**
* @var bool
*/
private $failOnSkipped;
/**
* @var bool
*/
private $failOnWarning;
/**
* @var bool
*/
private $stopOnDefect;
/**
* @var bool
*/
private $stopOnError;
/**
* @var bool
*/
private $stopOnFailure;
/**
* @var bool
*/
private $stopOnWarning;
/**
* @var bool
*/
private $stopOnIncomplete;
/**
* @var bool
*/
private $stopOnRisky;
/**
* @var bool
*/
private $stopOnSkipped;
/**
* @var ?string
*/
private $extensionsDirectory;
/**
* @var ?string
*
* @deprecated see https://github.com/sebastianbergmann/phpunit/issues/4039
*/
private $testSuiteLoaderClass;
/**
* @var ?string
*
* @deprecated see https://github.com/sebastianbergmann/phpunit/issues/4039
*/
private $testSuiteLoaderFile;
/**
* @var ?string
*/
private $printerClass;
/**
* @var ?string
*/
private $printerFile;
/**
* @var bool
*/
private $beStrictAboutChangesToGlobalState;
/**
* @var bool
*/
private $beStrictAboutOutputDuringTests;
/**
* @var bool
*/
private $beStrictAboutResourceUsageDuringSmallTests;
/**
* @var bool
*/
private $beStrictAboutTestsThatDoNotTestAnything;
/**
* @var bool
*/
private $beStrictAboutTodoAnnotatedTests;
/**
* @var bool
*/
private $beStrictAboutCoversAnnotation;
/**
* @var bool
*/
private $enforceTimeLimit;
/**
* @var int
*/
private $defaultTimeLimit;
/**
* @var int
*/
private $timeoutForSmallTests;
/**
* @var int
*/
private $timeoutForMediumTests;
/**
* @var int
*/
private $timeoutForLargeTests;
/**
* @var ?string
*/
private $defaultTestSuite;
/**
* @var int
*/
private $executionOrder;
/**
* @var bool
*/
private $resolveDependencies;
/**
* @var bool
*/
private $defectsFirst;
/**
* @var bool
*/
private $backupGlobals;
/**
* @var bool
*/
private $backupStaticAttributes;
/**
* @var bool
*/
private $registerMockObjectsFromTestArgumentsRecursively;
/**
* @var bool
*/
private $conflictBetweenPrinterClassAndTestdox;
public function __construct(bool $cacheResult, ?string $cacheResultFile, $columns, string $colors, bool $stderr, bool $noInteraction, bool $verbose, bool $reverseDefectList, bool $convertDeprecationsToExceptions, bool $convertErrorsToExceptions, bool $convertNoticesToExceptions, bool $convertWarningsToExceptions, bool $forceCoversAnnotation, ?string $bootstrap, bool $processIsolation, bool $failOnEmptyTestSuite, bool $failOnIncomplete, bool $failOnRisky, bool $failOnSkipped, bool $failOnWarning, bool $stopOnDefect, bool $stopOnError, bool $stopOnFailure, bool $stopOnWarning, bool $stopOnIncomplete, bool $stopOnRisky, bool $stopOnSkipped, ?string $extensionsDirectory, ?string $testSuiteLoaderClass, ?string $testSuiteLoaderFile, ?string $printerClass, ?string $printerFile, bool $beStrictAboutChangesToGlobalState, bool $beStrictAboutOutputDuringTests, bool $beStrictAboutResourceUsageDuringSmallTests, bool $beStrictAboutTestsThatDoNotTestAnything, bool $beStrictAboutTodoAnnotatedTests, bool $beStrictAboutCoversAnnotation, bool $enforceTimeLimit, int $defaultTimeLimit, int $timeoutForSmallTests, int $timeoutForMediumTests, int $timeoutForLargeTests, ?string $defaultTestSuite, int $executionOrder, bool $resolveDependencies, bool $defectsFirst, bool $backupGlobals, bool $backupStaticAttributes, bool $registerMockObjectsFromTestArgumentsRecursively, bool $conflictBetweenPrinterClassAndTestdox)
{
$this->cacheResult = $cacheResult;
$this->cacheResultFile = $cacheResultFile;
$this->columns = $columns;
$this->colors = $colors;
$this->stderr = $stderr;
$this->noInteraction = $noInteraction;
$this->verbose = $verbose;
$this->reverseDefectList = $reverseDefectList;
$this->convertDeprecationsToExceptions = $convertDeprecationsToExceptions;
$this->convertErrorsToExceptions = $convertErrorsToExceptions;
$this->convertNoticesToExceptions = $convertNoticesToExceptions;
$this->convertWarningsToExceptions = $convertWarningsToExceptions;
$this->forceCoversAnnotation = $forceCoversAnnotation;
$this->bootstrap = $bootstrap;
$this->processIsolation = $processIsolation;
$this->failOnEmptyTestSuite = $failOnEmptyTestSuite;
$this->failOnIncomplete = $failOnIncomplete;
$this->failOnRisky = $failOnRisky;
$this->failOnSkipped = $failOnSkipped;
$this->failOnWarning = $failOnWarning;
$this->stopOnDefect = $stopOnDefect;
$this->stopOnError = $stopOnError;
$this->stopOnFailure = $stopOnFailure;
$this->stopOnWarning = $stopOnWarning;
$this->stopOnIncomplete = $stopOnIncomplete;
$this->stopOnRisky = $stopOnRisky;
$this->stopOnSkipped = $stopOnSkipped;
$this->extensionsDirectory = $extensionsDirectory;
$this->testSuiteLoaderClass = $testSuiteLoaderClass;
$this->testSuiteLoaderFile = $testSuiteLoaderFile;
$this->printerClass = $printerClass;
$this->printerFile = $printerFile;
$this->beStrictAboutChangesToGlobalState = $beStrictAboutChangesToGlobalState;
$this->beStrictAboutOutputDuringTests = $beStrictAboutOutputDuringTests;
$this->beStrictAboutResourceUsageDuringSmallTests = $beStrictAboutResourceUsageDuringSmallTests;
$this->beStrictAboutTestsThatDoNotTestAnything = $beStrictAboutTestsThatDoNotTestAnything;
$this->beStrictAboutTodoAnnotatedTests = $beStrictAboutTodoAnnotatedTests;
$this->beStrictAboutCoversAnnotation = $beStrictAboutCoversAnnotation;
$this->enforceTimeLimit = $enforceTimeLimit;
$this->defaultTimeLimit = $defaultTimeLimit;
$this->timeoutForSmallTests = $timeoutForSmallTests;
$this->timeoutForMediumTests = $timeoutForMediumTests;
$this->timeoutForLargeTests = $timeoutForLargeTests;
$this->defaultTestSuite = $defaultTestSuite;
$this->executionOrder = $executionOrder;
$this->resolveDependencies = $resolveDependencies;
$this->defectsFirst = $defectsFirst;
$this->backupGlobals = $backupGlobals;
$this->backupStaticAttributes = $backupStaticAttributes;
$this->registerMockObjectsFromTestArgumentsRecursively = $registerMockObjectsFromTestArgumentsRecursively;
$this->conflictBetweenPrinterClassAndTestdox = $conflictBetweenPrinterClassAndTestdox;
}
public function cacheResult(): bool
{
return $this->cacheResult;
}
/**
* @psalm-assert-if-true !null $this->cacheResultFile
*/
public function hasCacheResultFile(): bool
{
return $this->cacheResultFile !== null;
}
/**
* @throws Exception
*/
public function cacheResultFile(): string
{
if (!$this->hasCacheResultFile()) {
throw new Exception('Cache result file is not configured');
}
return (string) $this->cacheResultFile;
}
public function columns()
{
return $this->columns;
}
public function colors(): string
{
return $this->colors;
}
public function stderr(): bool
{
return $this->stderr;
}
public function noInteraction(): bool
{
return $this->noInteraction;
}
public function verbose(): bool
{
return $this->verbose;
}
public function reverseDefectList(): bool
{
return $this->reverseDefectList;
}
public function convertDeprecationsToExceptions(): bool
{
return $this->convertDeprecationsToExceptions;
}
public function convertErrorsToExceptions(): bool
{
return $this->convertErrorsToExceptions;
}
public function convertNoticesToExceptions(): bool
{
return $this->convertNoticesToExceptions;
}
public function convertWarningsToExceptions(): bool
{
return $this->convertWarningsToExceptions;
}
public function forceCoversAnnotation(): bool
{
return $this->forceCoversAnnotation;
}
/**
* @psalm-assert-if-true !null $this->bootstrap
*/
public function hasBootstrap(): bool
{
return $this->bootstrap !== null;
}
/**
* @throws Exception
*/
public function bootstrap(): string
{
if (!$this->hasBootstrap()) {
throw new Exception('Bootstrap script is not configured');
}
return (string) $this->bootstrap;
}
public function processIsolation(): bool
{
return $this->processIsolation;
}
public function failOnEmptyTestSuite(): bool
{
return $this->failOnEmptyTestSuite;
}
public function failOnIncomplete(): bool
{
return $this->failOnIncomplete;
}
public function failOnRisky(): bool
{
return $this->failOnRisky;
}
public function failOnSkipped(): bool
{
return $this->failOnSkipped;
}
public function failOnWarning(): bool
{
return $this->failOnWarning;
}
public function stopOnDefect(): bool
{
return $this->stopOnDefect;
}
public function stopOnError(): bool
{
return $this->stopOnError;
}
public function stopOnFailure(): bool
{
return $this->stopOnFailure;
}
public function stopOnWarning(): bool
{
return $this->stopOnWarning;
}
public function stopOnIncomplete(): bool
{
return $this->stopOnIncomplete;
}
public function stopOnRisky(): bool
{
return $this->stopOnRisky;
}
public function stopOnSkipped(): bool
{
return $this->stopOnSkipped;
}
/**
* @psalm-assert-if-true !null $this->extensionsDirectory
*/
public function hasExtensionsDirectory(): bool
{
return $this->extensionsDirectory !== null;
}
/**
* @throws Exception
*/
public function extensionsDirectory(): string
{
if (!$this->hasExtensionsDirectory()) {
throw new Exception('Extensions directory is not configured');
}
return (string) $this->extensionsDirectory;
}
/**
* @psalm-assert-if-true !null $this->testSuiteLoaderClass
*
* @deprecated see https://github.com/sebastianbergmann/phpunit/issues/4039
*/
public function hasTestSuiteLoaderClass(): bool
{
return $this->testSuiteLoaderClass !== null;
}
/**
* @throws Exception
*
* @deprecated see https://github.com/sebastianbergmann/phpunit/issues/4039
*/
public function testSuiteLoaderClass(): string
{
if (!$this->hasTestSuiteLoaderClass()) {
throw new Exception('TestSuiteLoader class is not configured');
}
return (string) $this->testSuiteLoaderClass;
}
/**
* @psalm-assert-if-true !null $this->testSuiteLoaderFile
*
* @deprecated see https://github.com/sebastianbergmann/phpunit/issues/4039
*/
public function hasTestSuiteLoaderFile(): bool
{
return $this->testSuiteLoaderFile !== null;
}
/**
* @throws Exception
*
* @deprecated see https://github.com/sebastianbergmann/phpunit/issues/4039
*/
public function testSuiteLoaderFile(): string
{
if (!$this->hasTestSuiteLoaderFile()) {
throw new Exception('TestSuiteLoader sourcecode file is not configured');
}
return (string) $this->testSuiteLoaderFile;
}
/**
* @psalm-assert-if-true !null $this->printerClass
*/
public function hasPrinterClass(): bool
{
return $this->printerClass !== null;
}
/**
* @throws Exception
*/
public function printerClass(): string
{
if (!$this->hasPrinterClass()) {
throw new Exception('ResultPrinter class is not configured');
}
return (string) $this->printerClass;
}
/**
* @psalm-assert-if-true !null $this->printerFile
*/
public function hasPrinterFile(): bool
{
return $this->printerFile !== null;
}
/**
* @throws Exception
*/
public function printerFile(): string
{
if (!$this->hasPrinterFile()) {
throw new Exception('ResultPrinter sourcecode file is not configured');
}
return (string) $this->printerFile;
}
public function beStrictAboutChangesToGlobalState(): bool
{
return $this->beStrictAboutChangesToGlobalState;
}
public function beStrictAboutOutputDuringTests(): bool
{
return $this->beStrictAboutOutputDuringTests;
}
public function beStrictAboutResourceUsageDuringSmallTests(): bool
{
return $this->beStrictAboutResourceUsageDuringSmallTests;
}
public function beStrictAboutTestsThatDoNotTestAnything(): bool
{
return $this->beStrictAboutTestsThatDoNotTestAnything;
}
public function beStrictAboutTodoAnnotatedTests(): bool
{
return $this->beStrictAboutTodoAnnotatedTests;
}
public function beStrictAboutCoversAnnotation(): bool
{
return $this->beStrictAboutCoversAnnotation;
}
public function enforceTimeLimit(): bool
{
return $this->enforceTimeLimit;
}
public function defaultTimeLimit(): int
{
return $this->defaultTimeLimit;
}
public function timeoutForSmallTests(): int
{
return $this->timeoutForSmallTests;
}
public function timeoutForMediumTests(): int
{
return $this->timeoutForMediumTests;
}
public function timeoutForLargeTests(): int
{
return $this->timeoutForLargeTests;
}
/**
* @psalm-assert-if-true !null $this->defaultTestSuite
*/
public function hasDefaultTestSuite(): bool
{
return $this->defaultTestSuite !== null;
}
/**
* @throws Exception
*/
public function defaultTestSuite(): string
{
if (!$this->hasDefaultTestSuite()) {
throw new Exception('Default test suite is not configured');
}
return (string) $this->defaultTestSuite;
}
public function executionOrder(): int
{
return $this->executionOrder;
}
public function resolveDependencies(): bool
{
return $this->resolveDependencies;
}
public function defectsFirst(): bool
{
return $this->defectsFirst;
}
public function backupGlobals(): bool
{
return $this->backupGlobals;
}
public function backupStaticAttributes(): bool
{
return $this->backupStaticAttributes;
}
public function registerMockObjectsFromTestArgumentsRecursively(): bool
{
return $this->registerMockObjectsFromTestArgumentsRecursively;
}
public function conflictBetweenPrinterClassAndTestdox(): bool
{
return $this->conflictBetweenPrinterClassAndTestdox;
}
}
PK [ګ ; src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class ExtensionCollection implements IteratorAggregate
{
/**
* @var Extension[]
*/
private $extensions;
/**
* @param Extension[] $extensions
*/
public static function fromArray(array $extensions): self
{
return new self(...$extensions);
}
private function __construct(Extension ...$extensions)
{
$this->extensions = $extensions;
}
/**
* @return Extension[]
*/
public function asArray(): array
{
return $this->extensions;
}
public function getIterator(): ExtensionCollectionIterator
{
return new ExtensionCollectionIterator($this);
}
}
PK [a[H\ \ C src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class ExtensionCollectionIterator implements Countable, Iterator
{
/**
* @var Extension[]
*/
private $extensions;
/**
* @var int
*/
private $position;
public function __construct(ExtensionCollection $extensions)
{
$this->extensions = $extensions->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->extensions);
}
public function key(): int
{
return $this->position;
}
public function current(): Extension
{
return $this->extensions[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [b^Ob b F src/TextUI/XmlConfiguration/Filesystem/DirectoryCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class DirectoryCollectionIterator implements Countable, Iterator
{
/**
* @var Directory[]
*/
private $directories;
/**
* @var int
*/
private $position;
public function __construct(DirectoryCollection $directories)
{
$this->directories = $directories->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->directories);
}
public function key(): int
{
return $this->position;
}
public function current(): Directory
{
return $this->directories[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [` / src/TextUI/XmlConfiguration/Filesystem/File.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class File
{
/**
* @var string
*/
private $path;
public function __construct(string $path)
{
$this->path = $path;
}
public function path(): string
{
return $this->path;
}
}
PK [} 4 src/TextUI/XmlConfiguration/Filesystem/Directory.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Directory
{
/**
* @var string
*/
private $path;
public function __construct(string $path)
{
$this->path = $path;
}
public function path(): string
{
return $this->path;
}
}
PK [ 9 src/TextUI/XmlConfiguration/Filesystem/FileCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use Countable;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class FileCollection implements Countable, IteratorAggregate
{
/**
* @var File[]
*/
private $files;
/**
* @param File[] $files
*/
public static function fromArray(array $files): self
{
return new self(...$files);
}
private function __construct(File ...$files)
{
$this->files = $files;
}
/**
* @return File[]
*/
public function asArray(): array
{
return $this->files;
}
public function count(): int
{
return count($this->files);
}
public function getIterator(): FileCollectionIterator
{
return new FileCollectionIterator($this);
}
public function isEmpty(): bool
{
return $this->count() === 0;
}
}
PK [H4y y > src/TextUI/XmlConfiguration/Filesystem/DirectoryCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use Countable;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class DirectoryCollection implements Countable, IteratorAggregate
{
/**
* @var Directory[]
*/
private $directories;
/**
* @param Directory[] $directories
*/
public static function fromArray(array $directories): self
{
return new self(...$directories);
}
private function __construct(Directory ...$directories)
{
$this->directories = $directories;
}
/**
* @return Directory[]
*/
public function asArray(): array
{
return $this->directories;
}
public function count(): int
{
return count($this->directories);
}
public function getIterator(): DirectoryCollectionIterator
{
return new DirectoryCollectionIterator($this);
}
public function isEmpty(): bool
{
return $this->count() === 0;
}
}
PK [ % % A src/TextUI/XmlConfiguration/Filesystem/FileCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class FileCollectionIterator implements Countable, Iterator
{
/**
* @var File[]
*/
private $files;
/**
* @var int
*/
private $position;
public function __construct(FileCollection $files)
{
$this->files = $files->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->files);
}
public function key(): int
{
return $this->position;
}
public function current(): File
{
return $this->files[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [u : src/TextUI/XmlConfiguration/CodeCoverage/Report/Crap4j.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Crap4j
{
/**
* @var File
*/
private $target;
/**
* @var int
*/
private $threshold;
public function __construct(File $target, int $threshold)
{
$this->target = $target;
$this->threshold = $threshold;
}
public function target(): File
{
return $this->target;
}
public function threshold(): int
{
return $this->threshold;
}
}
PK [Tc = src/TextUI/XmlConfiguration/CodeCoverage/Report/Cobertura.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Cobertura
{
/**
* @var File
*/
private $target;
public function __construct(File $target)
{
$this->target = $target;
}
public function target(): File
{
return $this->target;
}
}
PK [;W 7 src/TextUI/XmlConfiguration/CodeCoverage/Report/Xml.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report;
use PHPUnit\TextUI\XmlConfiguration\Directory;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Xml
{
/**
* @var Directory
*/
private $target;
public function __construct(Directory $target)
{
$this->target = $target;
}
public function target(): Directory
{
return $this->target;
}
}
PK [D 8 src/TextUI/XmlConfiguration/CodeCoverage/Report/Text.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Text
{
/**
* @var File
*/
private $target;
/**
* @var bool
*/
private $showUncoveredFiles;
/**
* @var bool
*/
private $showOnlySummary;
public function __construct(File $target, bool $showUncoveredFiles, bool $showOnlySummary)
{
$this->target = $target;
$this->showUncoveredFiles = $showUncoveredFiles;
$this->showOnlySummary = $showOnlySummary;
}
public function target(): File
{
return $this->target;
}
public function showUncoveredFiles(): bool
{
return $this->showUncoveredFiles;
}
public function showOnlySummary(): bool
{
return $this->showOnlySummary;
}
}
PK [?!u : src/TextUI/XmlConfiguration/CodeCoverage/Report/Clover.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Clover
{
/**
* @var File
*/
private $target;
public function __construct(File $target)
{
$this->target = $target;
}
public function target(): File
{
return $this->target;
}
}
PK [\V 7 src/TextUI/XmlConfiguration/CodeCoverage/Report/Php.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report;
use PHPUnit\TextUI\XmlConfiguration\File;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Php
{
/**
* @var File
*/
private $target;
public function __construct(File $target)
{
$this->target = $target;
}
public function target(): File
{
return $this->target;
}
}
PK [ B 8 src/TextUI/XmlConfiguration/CodeCoverage/Report/Html.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report;
use PHPUnit\TextUI\XmlConfiguration\Directory;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Html
{
/**
* @var Directory
*/
private $target;
/**
* @var int
*/
private $lowUpperBound;
/**
* @var int
*/
private $highLowerBound;
public function __construct(Directory $target, int $lowUpperBound, int $highLowerBound)
{
$this->target = $target;
$this->lowUpperBound = $lowUpperBound;
$this->highLowerBound = $highLowerBound;
}
public function target(): Directory
{
return $this->target;
}
public function lowUpperBound(): int
{
return $this->lowUpperBound;
}
public function highLowerBound(): int
{
return $this->highLowerBound;
}
}
PK [L 9 src/TextUI/XmlConfiguration/CodeCoverage/FilterMapper.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage;
use SebastianBergmann\CodeCoverage\Filter;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class FilterMapper
{
public function map(Filter $filter, CodeCoverage $configuration): void
{
foreach ($configuration->directories() as $directory) {
$filter->includeDirectory(
$directory->path(),
$directory->suffix(),
$directory->prefix()
);
}
foreach ($configuration->files() as $file) {
$filter->includeFile($file->path());
}
foreach ($configuration->excludeDirectories() as $directory) {
$filter->excludeDirectory(
$directory->path(),
$directory->suffix(),
$directory->prefix()
);
}
foreach ($configuration->excludeFiles() as $file) {
$filter->excludeFile($file->path());
}
}
}
PK [!:y y 9 src/TextUI/XmlConfiguration/CodeCoverage/CodeCoverage.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage;
use function count;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Filter\DirectoryCollection;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Clover;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Cobertura;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Crap4j;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Html;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Php;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Text;
use PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Xml;
use PHPUnit\TextUI\XmlConfiguration\Directory;
use PHPUnit\TextUI\XmlConfiguration\Exception;
use PHPUnit\TextUI\XmlConfiguration\FileCollection;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class CodeCoverage
{
/**
* @var ?Directory
*/
private $cacheDirectory;
/**
* @var DirectoryCollection
*/
private $directories;
/**
* @var FileCollection
*/
private $files;
/**
* @var DirectoryCollection
*/
private $excludeDirectories;
/**
* @var FileCollection
*/
private $excludeFiles;
/**
* @var bool
*/
private $pathCoverage;
/**
* @var bool
*/
private $includeUncoveredFiles;
/**
* @var bool
*/
private $processUncoveredFiles;
/**
* @var bool
*/
private $ignoreDeprecatedCodeUnits;
/**
* @var bool
*/
private $disableCodeCoverageIgnore;
/**
* @var ?Clover
*/
private $clover;
/**
* @var ?Cobertura
*/
private $cobertura;
/**
* @var ?Crap4j
*/
private $crap4j;
/**
* @var ?Html
*/
private $html;
/**
* @var ?Php
*/
private $php;
/**
* @var ?Text
*/
private $text;
/**
* @var ?Xml
*/
private $xml;
public function __construct(?Directory $cacheDirectory, DirectoryCollection $directories, FileCollection $files, DirectoryCollection $excludeDirectories, FileCollection $excludeFiles, bool $pathCoverage, bool $includeUncoveredFiles, bool $processUncoveredFiles, bool $ignoreDeprecatedCodeUnits, bool $disableCodeCoverageIgnore, ?Clover $clover, ?Cobertura $cobertura, ?Crap4j $crap4j, ?Html $html, ?Php $php, ?Text $text, ?Xml $xml)
{
$this->cacheDirectory = $cacheDirectory;
$this->directories = $directories;
$this->files = $files;
$this->excludeDirectories = $excludeDirectories;
$this->excludeFiles = $excludeFiles;
$this->pathCoverage = $pathCoverage;
$this->includeUncoveredFiles = $includeUncoveredFiles;
$this->processUncoveredFiles = $processUncoveredFiles;
$this->ignoreDeprecatedCodeUnits = $ignoreDeprecatedCodeUnits;
$this->disableCodeCoverageIgnore = $disableCodeCoverageIgnore;
$this->clover = $clover;
$this->cobertura = $cobertura;
$this->crap4j = $crap4j;
$this->html = $html;
$this->php = $php;
$this->text = $text;
$this->xml = $xml;
}
/**
* @psalm-assert-if-true !null $this->cacheDirectory
*/
public function hasCacheDirectory(): bool
{
return $this->cacheDirectory !== null;
}
/**
* @throws Exception
*/
public function cacheDirectory(): Directory
{
if (!$this->hasCacheDirectory()) {
throw new Exception(
'No cache directory has been configured'
);
}
return $this->cacheDirectory;
}
public function hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport(): bool
{
return count($this->directories) > 0 || count($this->files) > 0;
}
public function directories(): DirectoryCollection
{
return $this->directories;
}
public function files(): FileCollection
{
return $this->files;
}
public function excludeDirectories(): DirectoryCollection
{
return $this->excludeDirectories;
}
public function excludeFiles(): FileCollection
{
return $this->excludeFiles;
}
public function pathCoverage(): bool
{
return $this->pathCoverage;
}
public function includeUncoveredFiles(): bool
{
return $this->includeUncoveredFiles;
}
public function ignoreDeprecatedCodeUnits(): bool
{
return $this->ignoreDeprecatedCodeUnits;
}
public function disableCodeCoverageIgnore(): bool
{
return $this->disableCodeCoverageIgnore;
}
public function processUncoveredFiles(): bool
{
return $this->processUncoveredFiles;
}
/**
* @psalm-assert-if-true !null $this->clover
*/
public function hasClover(): bool
{
return $this->clover !== null;
}
/**
* @throws Exception
*/
public function clover(): Clover
{
if (!$this->hasClover()) {
throw new Exception(
'Code Coverage report "Clover XML" has not been configured'
);
}
return $this->clover;
}
/**
* @psalm-assert-if-true !null $this->cobertura
*/
public function hasCobertura(): bool
{
return $this->cobertura !== null;
}
/**
* @throws Exception
*/
public function cobertura(): Cobertura
{
if (!$this->hasCobertura()) {
throw new Exception(
'Code Coverage report "Cobertura XML" has not been configured'
);
}
return $this->cobertura;
}
/**
* @psalm-assert-if-true !null $this->crap4j
*/
public function hasCrap4j(): bool
{
return $this->crap4j !== null;
}
/**
* @throws Exception
*/
public function crap4j(): Crap4j
{
if (!$this->hasCrap4j()) {
throw new Exception(
'Code Coverage report "Crap4J" has not been configured'
);
}
return $this->crap4j;
}
/**
* @psalm-assert-if-true !null $this->html
*/
public function hasHtml(): bool
{
return $this->html !== null;
}
/**
* @throws Exception
*/
public function html(): Html
{
if (!$this->hasHtml()) {
throw new Exception(
'Code Coverage report "HTML" has not been configured'
);
}
return $this->html;
}
/**
* @psalm-assert-if-true !null $this->php
*/
public function hasPhp(): bool
{
return $this->php !== null;
}
/**
* @throws Exception
*/
public function php(): Php
{
if (!$this->hasPhp()) {
throw new Exception(
'Code Coverage report "PHP" has not been configured'
);
}
return $this->php;
}
/**
* @psalm-assert-if-true !null $this->text
*/
public function hasText(): bool
{
return $this->text !== null;
}
/**
* @throws Exception
*/
public function text(): Text
{
if (!$this->hasText()) {
throw new Exception(
'Code Coverage report "Text" has not been configured'
);
}
return $this->text;
}
/**
* @psalm-assert-if-true !null $this->xml
*/
public function hasXml(): bool
{
return $this->xml !== null;
}
/**
* @throws Exception
*/
public function xml(): Xml
{
if (!$this->hasXml()) {
throw new Exception(
'Code Coverage report "XML" has not been configured'
);
}
return $this->xml;
}
}
PK [Pbv v O src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollectionIterator.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Filter;
use function count;
use function iterator_count;
use Countable;
use Iterator;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @template-implements Iterator
*/
final class DirectoryCollectionIterator implements Countable, Iterator
{
/**
* @var Directory[]
*/
private $directories;
/**
* @var int
*/
private $position;
public function __construct(DirectoryCollection $directories)
{
$this->directories = $directories->asArray();
}
public function count(): int
{
return iterator_count($this);
}
public function rewind(): void
{
$this->position = 0;
}
public function valid(): bool
{
return $this->position < count($this->directories);
}
public function key(): int
{
return $this->position;
}
public function current(): Directory
{
return $this->directories[$this->position];
}
public function next(): void
{
$this->position++;
}
}
PK [UT = src/TextUI/XmlConfiguration/CodeCoverage/Filter/Directory.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Filter;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Directory
{
/**
* @var string
*/
private $path;
/**
* @var string
*/
private $prefix;
/**
* @var string
*/
private $suffix;
/**
* @var string
*/
private $group;
public function __construct(string $path, string $prefix, string $suffix, string $group)
{
$this->path = $path;
$this->prefix = $prefix;
$this->suffix = $suffix;
$this->group = $group;
}
public function path(): string
{
return $this->path;
}
public function prefix(): string
{
return $this->prefix;
}
public function suffix(): string
{
return $this->suffix;
}
public function group(): string
{
return $this->group;
}
}
PK [fQ7 7 G src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollection.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Filter;
use function count;
use Countable;
use IteratorAggregate;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*
* @template-implements IteratorAggregate
*/
final class DirectoryCollection implements Countable, IteratorAggregate
{
/**
* @var Directory[]
*/
private $directories;
/**
* @param Directory[] $directories
*/
public static function fromArray(array $directories): self
{
return new self(...$directories);
}
private function __construct(Directory ...$directories)
{
$this->directories = $directories;
}
/**
* @return Directory[]
*/
public function asArray(): array
{
return $this->directories;
}
public function count(): int
{
return count($this->directories);
}
public function getIterator(): DirectoryCollectionIterator
{
return new DirectoryCollectionIterator($this);
}
}
PK [in ) src/TextUI/CliArguments/Configuration.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\CliArguments;
use PHPUnit\TextUI\XmlConfiguration\Extension;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*
* @psalm-immutable
*/
final class Configuration
{
/**
* @var ?string
*/
private $argument;
/**
* @var ?string
*/
private $atLeastVersion;
/**
* @var ?bool
*/
private $backupGlobals;
/**
* @var ?bool
*/
private $backupStaticAttributes;
/**
* @var ?bool
*/
private $beStrictAboutChangesToGlobalState;
/**
* @var ?bool
*/
private $beStrictAboutResourceUsageDuringSmallTests;
/**
* @var ?string
*/
private $bootstrap;
/**
* @var ?bool
*/
private $cacheResult;
/**
* @var ?string
*/
private $cacheResultFile;
/**
* @var ?bool
*/
private $checkVersion;
/**
* @var ?string
*/
private $colors;
/**
* @var null|int|string
*/
private $columns;
/**
* @var ?string
*/
private $configuration;
/**
* @var null|string[]
*/
private $coverageFilter;
/**
* @var ?string
*/
private $coverageClover;
/**
* @var ?string
*/
private $coverageCobertura;
/**
* @var ?string
*/
private $coverageCrap4J;
/**
* @var ?string
*/
private $coverageHtml;
/**
* @var ?string
*/
private $coveragePhp;
/**
* @var ?string
*/
private $coverageText;
/**
* @var ?bool
*/
private $coverageTextShowUncoveredFiles;
/**
* @var ?bool
*/
private $coverageTextShowOnlySummary;
/**
* @var ?string
*/
private $coverageXml;
/**
* @var ?bool
*/
private $pathCoverage;
/**
* @var ?string
*/
private $coverageCacheDirectory;
/**
* @var ?bool
*/
private $warmCoverageCache;
/**
* @var ?bool
*/
private $debug;
/**
* @var ?int
*/
private $defaultTimeLimit;
/**
* @var ?bool
*/
private $disableCodeCoverageIgnore;
/**
* @var ?bool
*/
private $disallowTestOutput;
/**
* @var ?bool
*/
private $disallowTodoAnnotatedTests;
/**
* @var ?bool
*/
private $enforceTimeLimit;
/**
* @var null|string[]
*/
private $excludeGroups;
/**
* @var ?int
*/
private $executionOrder;
/**
* @var ?int
*/
private $executionOrderDefects;
/**
* @var null|Extension[]
*/
private $extensions;
/**
* @var null|string[]
*/
private $unavailableExtensions;
/**
* @var ?bool
*/
private $failOnEmptyTestSuite;
/**
* @var ?bool
*/
private $failOnIncomplete;
/**
* @var ?bool
*/
private $failOnRisky;
/**
* @var ?bool
*/
private $failOnSkipped;
/**
* @var ?bool
*/
private $failOnWarning;
/**
* @var ?string
*/
private $filter;
/**
* @var ?bool
*/
private $generateConfiguration;
/**
* @var ?bool
*/
private $migrateConfiguration;
/**
* @var null|string[]
*/
private $groups;
/**
* @var null|string[]
*/
private $testsCovering;
/**
* @var null|string[]
*/
private $testsUsing;
/**
* @var ?bool
*/
private $help;
/**
* @var ?string
*/
private $includePath;
/**
* @var null|string[]
*/
private $iniSettings;
/**
* @var ?string
*/
private $junitLogfile;
/**
* @var ?bool
*/
private $listGroups;
/**
* @var ?bool
*/
private $listSuites;
/**
* @var ?bool
*/
private $listTests;
/**
* @var ?string
*/
private $listTestsXml;
/**
* @var ?string
*/
private $loader;
/**
* @var ?bool
*/
private $noCoverage;
/**
* @var ?bool
*/
private $noExtensions;
/**
* @var ?bool
*/
private $noInteraction;
/**
* @var ?bool
*/
private $noLogging;
/**
* @var ?string
*/
private $printer;
/**
* @var ?bool
*/
private $processIsolation;
/**
* @var ?int
*/
private $randomOrderSeed;
/**
* @var ?int
*/
private $repeat;
/**
* @var ?bool
*/
private $reportUselessTests;
/**
* @var ?bool
*/
private $resolveDependencies;
/**
* @var ?bool
*/
private $reverseList;
/**
* @var ?bool
*/
private $stderr;
/**
* @var ?bool
*/
private $strictCoverage;
/**
* @var ?bool
*/
private $stopOnDefect;
/**
* @var ?bool
*/
private $stopOnError;
/**
* @var ?bool
*/
private $stopOnFailure;
/**
* @var ?bool
*/
private $stopOnIncomplete;
/**
* @var ?bool
*/
private $stopOnRisky;
/**
* @var ?bool
*/
private $stopOnSkipped;
/**
* @var ?bool
*/
private $stopOnWarning;
/**
* @var ?string
*/
private $teamcityLogfile;
/**
* @var null|string[]
*/
private $testdoxExcludeGroups;
/**
* @var null|string[]
*/
private $testdoxGroups;
/**
* @var ?string
*/
private $testdoxHtmlFile;
/**
* @var ?string
*/
private $testdoxTextFile;
/**
* @var ?string
*/
private $testdoxXmlFile;
/**
* @var null|string[]
*/
private $testSuffixes;
/**
* @var ?string
*/
private $testSuite;
/**
* @var string[]
*/
private $unrecognizedOptions;
/**
* @var ?string
*/
private $unrecognizedOrderBy;
/**
* @var ?bool
*/
private $useDefaultConfiguration;
/**
* @var ?bool
*/
private $verbose;
/**
* @var ?bool
*/
private $version;
/**
* @var ?string
*/
private $xdebugFilterFile;
/**
* @param null|int|string $columns
*/
public function __construct(?string $argument, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticAttributes, ?bool $beStrictAboutChangesToGlobalState, ?bool $beStrictAboutResourceUsageDuringSmallTests, ?string $bootstrap, ?bool $cacheResult, ?string $cacheResultFile, ?bool $checkVersion, ?string $colors, $columns, ?string $configuration, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, ?string $coverageCacheDirectory, ?bool $warmCoverageCache, ?bool $debug, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $disallowTodoAnnotatedTests, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?array $extensions, ?array $unavailableExtensions, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?string $filter, ?bool $generateConfiguration, ?bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, ?bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, ?bool $listGroups, ?bool $listSuites, ?bool $listTests, ?string $listTestsXml, ?string $loader, ?bool $noCoverage, ?bool $noExtensions, ?bool $noInteraction, ?bool $noLogging, ?string $printer, ?bool $processIsolation, ?int $randomOrderSeed, ?int $repeat, ?bool $reportUselessTests, ?bool $resolveDependencies, ?bool $reverseList, ?bool $stderr, ?bool $strictCoverage, ?bool $stopOnDefect, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $teamcityLogfile, ?array $testdoxExcludeGroups, ?array $testdoxGroups, ?string $testdoxHtmlFile, ?string $testdoxTextFile, ?string $testdoxXmlFile, ?array $testSuffixes, ?string $testSuite, array $unrecognizedOptions, ?string $unrecognizedOrderBy, ?bool $useDefaultConfiguration, ?bool $verbose, ?bool $version, ?array $coverageFilter, ?string $xdebugFilterFile)
{
$this->argument = $argument;
$this->atLeastVersion = $atLeastVersion;
$this->backupGlobals = $backupGlobals;
$this->backupStaticAttributes = $backupStaticAttributes;
$this->beStrictAboutChangesToGlobalState = $beStrictAboutChangesToGlobalState;
$this->beStrictAboutResourceUsageDuringSmallTests = $beStrictAboutResourceUsageDuringSmallTests;
$this->bootstrap = $bootstrap;
$this->cacheResult = $cacheResult;
$this->cacheResultFile = $cacheResultFile;
$this->checkVersion = $checkVersion;
$this->colors = $colors;
$this->columns = $columns;
$this->configuration = $configuration;
$this->coverageFilter = $coverageFilter;
$this->coverageClover = $coverageClover;
$this->coverageCobertura = $coverageCobertura;
$this->coverageCrap4J = $coverageCrap4J;
$this->coverageHtml = $coverageHtml;
$this->coveragePhp = $coveragePhp;
$this->coverageText = $coverageText;
$this->coverageTextShowUncoveredFiles = $coverageTextShowUncoveredFiles;
$this->coverageTextShowOnlySummary = $coverageTextShowOnlySummary;
$this->coverageXml = $coverageXml;
$this->pathCoverage = $pathCoverage;
$this->coverageCacheDirectory = $coverageCacheDirectory;
$this->warmCoverageCache = $warmCoverageCache;
$this->debug = $debug;
$this->defaultTimeLimit = $defaultTimeLimit;
$this->disableCodeCoverageIgnore = $disableCodeCoverageIgnore;
$this->disallowTestOutput = $disallowTestOutput;
$this->disallowTodoAnnotatedTests = $disallowTodoAnnotatedTests;
$this->enforceTimeLimit = $enforceTimeLimit;
$this->excludeGroups = $excludeGroups;
$this->executionOrder = $executionOrder;
$this->executionOrderDefects = $executionOrderDefects;
$this->extensions = $extensions;
$this->unavailableExtensions = $unavailableExtensions;
$this->failOnEmptyTestSuite = $failOnEmptyTestSuite;
$this->failOnIncomplete = $failOnIncomplete;
$this->failOnRisky = $failOnRisky;
$this->failOnSkipped = $failOnSkipped;
$this->failOnWarning = $failOnWarning;
$this->filter = $filter;
$this->generateConfiguration = $generateConfiguration;
$this->migrateConfiguration = $migrateConfiguration;
$this->groups = $groups;
$this->testsCovering = $testsCovering;
$this->testsUsing = $testsUsing;
$this->help = $help;
$this->includePath = $includePath;
$this->iniSettings = $iniSettings;
$this->junitLogfile = $junitLogfile;
$this->listGroups = $listGroups;
$this->listSuites = $listSuites;
$this->listTests = $listTests;
$this->listTestsXml = $listTestsXml;
$this->loader = $loader;
$this->noCoverage = $noCoverage;
$this->noExtensions = $noExtensions;
$this->noInteraction = $noInteraction;
$this->noLogging = $noLogging;
$this->printer = $printer;
$this->processIsolation = $processIsolation;
$this->randomOrderSeed = $randomOrderSeed;
$this->repeat = $repeat;
$this->reportUselessTests = $reportUselessTests;
$this->resolveDependencies = $resolveDependencies;
$this->reverseList = $reverseList;
$this->stderr = $stderr;
$this->strictCoverage = $strictCoverage;
$this->stopOnDefect = $stopOnDefect;
$this->stopOnError = $stopOnError;
$this->stopOnFailure = $stopOnFailure;
$this->stopOnIncomplete = $stopOnIncomplete;
$this->stopOnRisky = $stopOnRisky;
$this->stopOnSkipped = $stopOnSkipped;
$this->stopOnWarning = $stopOnWarning;
$this->teamcityLogfile = $teamcityLogfile;
$this->testdoxExcludeGroups = $testdoxExcludeGroups;
$this->testdoxGroups = $testdoxGroups;
$this->testdoxHtmlFile = $testdoxHtmlFile;
$this->testdoxTextFile = $testdoxTextFile;
$this->testdoxXmlFile = $testdoxXmlFile;
$this->testSuffixes = $testSuffixes;
$this->testSuite = $testSuite;
$this->unrecognizedOptions = $unrecognizedOptions;
$this->unrecognizedOrderBy = $unrecognizedOrderBy;
$this->useDefaultConfiguration = $useDefaultConfiguration;
$this->verbose = $verbose;
$this->version = $version;
$this->xdebugFilterFile = $xdebugFilterFile;
}
public function hasArgument(): bool
{
return $this->argument !== null;
}
/**
* @throws Exception
*/
public function argument(): string
{
if ($this->argument === null) {
throw new Exception;
}
return $this->argument;
}
public function hasAtLeastVersion(): bool
{
return $this->atLeastVersion !== null;
}
/**
* @throws Exception
*/
public function atLeastVersion(): string
{
if ($this->atLeastVersion === null) {
throw new Exception;
}
return $this->atLeastVersion;
}
public function hasBackupGlobals(): bool
{
return $this->backupGlobals !== null;
}
/**
* @throws Exception
*/
public function backupGlobals(): bool
{
if ($this->backupGlobals === null) {
throw new Exception;
}
return $this->backupGlobals;
}
public function hasBackupStaticAttributes(): bool
{
return $this->backupStaticAttributes !== null;
}
/**
* @throws Exception
*/
public function backupStaticAttributes(): bool
{
if ($this->backupStaticAttributes === null) {
throw new Exception;
}
return $this->backupStaticAttributes;
}
public function hasBeStrictAboutChangesToGlobalState(): bool
{
return $this->beStrictAboutChangesToGlobalState !== null;
}
/**
* @throws Exception
*/
public function beStrictAboutChangesToGlobalState(): bool
{
if ($this->beStrictAboutChangesToGlobalState === null) {
throw new Exception;
}
return $this->beStrictAboutChangesToGlobalState;
}
public function hasBeStrictAboutResourceUsageDuringSmallTests(): bool
{
return $this->beStrictAboutResourceUsageDuringSmallTests !== null;
}
/**
* @throws Exception
*/
public function beStrictAboutResourceUsageDuringSmallTests(): bool
{
if ($this->beStrictAboutResourceUsageDuringSmallTests === null) {
throw new Exception;
}
return $this->beStrictAboutResourceUsageDuringSmallTests;
}
public function hasBootstrap(): bool
{
return $this->bootstrap !== null;
}
/**
* @throws Exception
*/
public function bootstrap(): string
{
if ($this->bootstrap === null) {
throw new Exception;
}
return $this->bootstrap;
}
public function hasCacheResult(): bool
{
return $this->cacheResult !== null;
}
/**
* @throws Exception
*/
public function cacheResult(): bool
{
if ($this->cacheResult === null) {
throw new Exception;
}
return $this->cacheResult;
}
public function hasCacheResultFile(): bool
{
return $this->cacheResultFile !== null;
}
/**
* @throws Exception
*/
public function cacheResultFile(): string
{
if ($this->cacheResultFile === null) {
throw new Exception;
}
return $this->cacheResultFile;
}
public function hasCheckVersion(): bool
{
return $this->checkVersion !== null;
}
/**
* @throws Exception
*/
public function checkVersion(): bool
{
if ($this->checkVersion === null) {
throw new Exception;
}
return $this->checkVersion;
}
public function hasColors(): bool
{
return $this->colors !== null;
}
/**
* @throws Exception
*/
public function colors(): string
{
if ($this->colors === null) {
throw new Exception;
}
return $this->colors;
}
public function hasColumns(): bool
{
return $this->columns !== null;
}
/**
* @throws Exception
*/
public function columns()
{
if ($this->columns === null) {
throw new Exception;
}
return $this->columns;
}
public function hasConfiguration(): bool
{
return $this->configuration !== null;
}
/**
* @throws Exception
*/
public function configuration(): string
{
if ($this->configuration === null) {
throw new Exception;
}
return $this->configuration;
}
public function hasCoverageFilter(): bool
{
return $this->coverageFilter !== null;
}
/**
* @throws Exception
*/
public function coverageFilter(): array
{
if ($this->coverageFilter === null) {
throw new Exception;
}
return $this->coverageFilter;
}
public function hasCoverageClover(): bool
{
return $this->coverageClover !== null;
}
/**
* @throws Exception
*/
public function coverageClover(): string
{
if ($this->coverageClover === null) {
throw new Exception;
}
return $this->coverageClover;
}
public function hasCoverageCobertura(): bool
{
return $this->coverageCobertura !== null;
}
/**
* @throws Exception
*/
public function coverageCobertura(): string
{
if ($this->coverageCobertura === null) {
throw new Exception;
}
return $this->coverageCobertura;
}
public function hasCoverageCrap4J(): bool
{
return $this->coverageCrap4J !== null;
}
/**
* @throws Exception
*/
public function coverageCrap4J(): string
{
if ($this->coverageCrap4J === null) {
throw new Exception;
}
return $this->coverageCrap4J;
}
public function hasCoverageHtml(): bool
{
return $this->coverageHtml !== null;
}
/**
* @throws Exception
*/
public function coverageHtml(): string
{
if ($this->coverageHtml === null) {
throw new Exception;
}
return $this->coverageHtml;
}
public function hasCoveragePhp(): bool
{
return $this->coveragePhp !== null;
}
/**
* @throws Exception
*/
public function coveragePhp(): string
{
if ($this->coveragePhp === null) {
throw new Exception;
}
return $this->coveragePhp;
}
public function hasCoverageText(): bool
{
return $this->coverageText !== null;
}
/**
* @throws Exception
*/
public function coverageText(): string
{
if ($this->coverageText === null) {
throw new Exception;
}
return $this->coverageText;
}
public function hasCoverageTextShowUncoveredFiles(): bool
{
return $this->coverageTextShowUncoveredFiles !== null;
}
/**
* @throws Exception
*/
public function coverageTextShowUncoveredFiles(): bool
{
if ($this->coverageTextShowUncoveredFiles === null) {
throw new Exception;
}
return $this->coverageTextShowUncoveredFiles;
}
public function hasCoverageTextShowOnlySummary(): bool
{
return $this->coverageTextShowOnlySummary !== null;
}
/**
* @throws Exception
*/
public function coverageTextShowOnlySummary(): bool
{
if ($this->coverageTextShowOnlySummary === null) {
throw new Exception;
}
return $this->coverageTextShowOnlySummary;
}
public function hasCoverageXml(): bool
{
return $this->coverageXml !== null;
}
/**
* @throws Exception
*/
public function coverageXml(): string
{
if ($this->coverageXml === null) {
throw new Exception;
}
return $this->coverageXml;
}
public function hasPathCoverage(): bool
{
return $this->pathCoverage !== null;
}
/**
* @throws Exception
*/
public function pathCoverage(): bool
{
if ($this->pathCoverage === null) {
throw new Exception;
}
return $this->pathCoverage;
}
public function hasCoverageCacheDirectory(): bool
{
return $this->coverageCacheDirectory !== null;
}
/**
* @throws Exception
*/
public function coverageCacheDirectory(): string
{
if ($this->coverageCacheDirectory === null) {
throw new Exception;
}
return $this->coverageCacheDirectory;
}
public function hasWarmCoverageCache(): bool
{
return $this->warmCoverageCache !== null;
}
/**
* @throws Exception
*/
public function warmCoverageCache(): bool
{
if ($this->warmCoverageCache === null) {
throw new Exception;
}
return $this->warmCoverageCache;
}
public function hasDebug(): bool
{
return $this->debug !== null;
}
/**
* @throws Exception
*/
public function debug(): bool
{
if ($this->debug === null) {
throw new Exception;
}
return $this->debug;
}
public function hasDefaultTimeLimit(): bool
{
return $this->defaultTimeLimit !== null;
}
/**
* @throws Exception
*/
public function defaultTimeLimit(): int
{
if ($this->defaultTimeLimit === null) {
throw new Exception;
}
return $this->defaultTimeLimit;
}
public function hasDisableCodeCoverageIgnore(): bool
{
return $this->disableCodeCoverageIgnore !== null;
}
/**
* @throws Exception
*/
public function disableCodeCoverageIgnore(): bool
{
if ($this->disableCodeCoverageIgnore === null) {
throw new Exception;
}
return $this->disableCodeCoverageIgnore;
}
public function hasDisallowTestOutput(): bool
{
return $this->disallowTestOutput !== null;
}
/**
* @throws Exception
*/
public function disallowTestOutput(): bool
{
if ($this->disallowTestOutput === null) {
throw new Exception;
}
return $this->disallowTestOutput;
}
public function hasDisallowTodoAnnotatedTests(): bool
{
return $this->disallowTodoAnnotatedTests !== null;
}
/**
* @throws Exception
*/
public function disallowTodoAnnotatedTests(): bool
{
if ($this->disallowTodoAnnotatedTests === null) {
throw new Exception;
}
return $this->disallowTodoAnnotatedTests;
}
public function hasEnforceTimeLimit(): bool
{
return $this->enforceTimeLimit !== null;
}
/**
* @throws Exception
*/
public function enforceTimeLimit(): bool
{
if ($this->enforceTimeLimit === null) {
throw new Exception;
}
return $this->enforceTimeLimit;
}
public function hasExcludeGroups(): bool
{
return $this->excludeGroups !== null;
}
/**
* @throws Exception
*/
public function excludeGroups(): array
{
if ($this->excludeGroups === null) {
throw new Exception;
}
return $this->excludeGroups;
}
public function hasExecutionOrder(): bool
{
return $this->executionOrder !== null;
}
/**
* @throws Exception
*/
public function executionOrder(): int
{
if ($this->executionOrder === null) {
throw new Exception;
}
return $this->executionOrder;
}
public function hasExecutionOrderDefects(): bool
{
return $this->executionOrderDefects !== null;
}
/**
* @throws Exception
*/
public function executionOrderDefects(): int
{
if ($this->executionOrderDefects === null) {
throw new Exception;
}
return $this->executionOrderDefects;
}
public function hasFailOnEmptyTestSuite(): bool
{
return $this->failOnEmptyTestSuite !== null;
}
/**
* @throws Exception
*/
public function failOnEmptyTestSuite(): bool
{
if ($this->failOnEmptyTestSuite === null) {
throw new Exception;
}
return $this->failOnEmptyTestSuite;
}
public function hasFailOnIncomplete(): bool
{
return $this->failOnIncomplete !== null;
}
/**
* @throws Exception
*/
public function failOnIncomplete(): bool
{
if ($this->failOnIncomplete === null) {
throw new Exception;
}
return $this->failOnIncomplete;
}
public function hasFailOnRisky(): bool
{
return $this->failOnRisky !== null;
}
/**
* @throws Exception
*/
public function failOnRisky(): bool
{
if ($this->failOnRisky === null) {
throw new Exception;
}
return $this->failOnRisky;
}
public function hasFailOnSkipped(): bool
{
return $this->failOnSkipped !== null;
}
/**
* @throws Exception
*/
public function failOnSkipped(): bool
{
if ($this->failOnSkipped === null) {
throw new Exception;
}
return $this->failOnSkipped;
}
public function hasFailOnWarning(): bool
{
return $this->failOnWarning !== null;
}
/**
* @throws Exception
*/
public function failOnWarning(): bool
{
if ($this->failOnWarning === null) {
throw new Exception;
}
return $this->failOnWarning;
}
public function hasFilter(): bool
{
return $this->filter !== null;
}
/**
* @throws Exception
*/
public function filter(): string
{
if ($this->filter === null) {
throw new Exception;
}
return $this->filter;
}
public function hasGenerateConfiguration(): bool
{
return $this->generateConfiguration !== null;
}
/**
* @throws Exception
*/
public function generateConfiguration(): bool
{
if ($this->generateConfiguration === null) {
throw new Exception;
}
return $this->generateConfiguration;
}
public function hasMigrateConfiguration(): bool
{
return $this->migrateConfiguration !== null;
}
/**
* @throws Exception
*/
public function migrateConfiguration(): bool
{
if ($this->migrateConfiguration === null) {
throw new Exception;
}
return $this->migrateConfiguration;
}
public function hasGroups(): bool
{
return $this->groups !== null;
}
/**
* @throws Exception
*/
public function groups(): array
{
if ($this->groups === null) {
throw new Exception;
}
return $this->groups;
}
public function hasTestsCovering(): bool
{
return $this->testsCovering !== null;
}
/**
* @throws Exception
*/
public function testsCovering(): array
{
if ($this->testsCovering === null) {
throw new Exception;
}
return $this->testsCovering;
}
public function hasTestsUsing(): bool
{
return $this->testsUsing !== null;
}
/**
* @throws Exception
*/
public function testsUsing(): array
{
if ($this->testsUsing === null) {
throw new Exception;
}
return $this->testsUsing;
}
public function hasHelp(): bool
{
return $this->help !== null;
}
/**
* @throws Exception
*/
public function help(): bool
{
if ($this->help === null) {
throw new Exception;
}
return $this->help;
}
public function hasIncludePath(): bool
{
return $this->includePath !== null;
}
/**
* @throws Exception
*/
public function includePath(): string
{
if ($this->includePath === null) {
throw new Exception;
}
return $this->includePath;
}
public function hasIniSettings(): bool
{
return $this->iniSettings !== null;
}
/**
* @throws Exception
*/
public function iniSettings(): array
{
if ($this->iniSettings === null) {
throw new Exception;
}
return $this->iniSettings;
}
public function hasJunitLogfile(): bool
{
return $this->junitLogfile !== null;
}
/**
* @throws Exception
*/
public function junitLogfile(): string
{
if ($this->junitLogfile === null) {
throw new Exception;
}
return $this->junitLogfile;
}
public function hasListGroups(): bool
{
return $this->listGroups !== null;
}
/**
* @throws Exception
*/
public function listGroups(): bool
{
if ($this->listGroups === null) {
throw new Exception;
}
return $this->listGroups;
}
public function hasListSuites(): bool
{
return $this->listSuites !== null;
}
/**
* @throws Exception
*/
public function listSuites(): bool
{
if ($this->listSuites === null) {
throw new Exception;
}
return $this->listSuites;
}
public function hasListTests(): bool
{
return $this->listTests !== null;
}
/**
* @throws Exception
*/
public function listTests(): bool
{
if ($this->listTests === null) {
throw new Exception;
}
return $this->listTests;
}
public function hasListTestsXml(): bool
{
return $this->listTestsXml !== null;
}
/**
* @throws Exception
*/
public function listTestsXml(): string
{
if ($this->listTestsXml === null) {
throw new Exception;
}
return $this->listTestsXml;
}
public function hasLoader(): bool
{
return $this->loader !== null;
}
/**
* @throws Exception
*/
public function loader(): string
{
if ($this->loader === null) {
throw new Exception;
}
return $this->loader;
}
public function hasNoCoverage(): bool
{
return $this->noCoverage !== null;
}
/**
* @throws Exception
*/
public function noCoverage(): bool
{
if ($this->noCoverage === null) {
throw new Exception;
}
return $this->noCoverage;
}
public function hasNoExtensions(): bool
{
return $this->noExtensions !== null;
}
/**
* @throws Exception
*/
public function noExtensions(): bool
{
if ($this->noExtensions === null) {
throw new Exception;
}
return $this->noExtensions;
}
public function hasExtensions(): bool
{
return $this->extensions !== null;
}
/**
* @throws Exception
*/
public function extensions(): array
{
if ($this->extensions === null) {
throw new Exception;
}
return $this->extensions;
}
public function hasUnavailableExtensions(): bool
{
return $this->unavailableExtensions !== null;
}
/**
* @throws Exception
*/
public function unavailableExtensions(): array
{
if ($this->unavailableExtensions === null) {
throw new Exception;
}
return $this->unavailableExtensions;
}
public function hasNoInteraction(): bool
{
return $this->noInteraction !== null;
}
/**
* @throws Exception
*/
public function noInteraction(): bool
{
if ($this->noInteraction === null) {
throw new Exception;
}
return $this->noInteraction;
}
public function hasNoLogging(): bool
{
return $this->noLogging !== null;
}
/**
* @throws Exception
*/
public function noLogging(): bool
{
if ($this->noLogging === null) {
throw new Exception;
}
return $this->noLogging;
}
public function hasPrinter(): bool
{
return $this->printer !== null;
}
/**
* @throws Exception
*/
public function printer(): string
{
if ($this->printer === null) {
throw new Exception;
}
return $this->printer;
}
public function hasProcessIsolation(): bool
{
return $this->processIsolation !== null;
}
/**
* @throws Exception
*/
public function processIsolation(): bool
{
if ($this->processIsolation === null) {
throw new Exception;
}
return $this->processIsolation;
}
public function hasRandomOrderSeed(): bool
{
return $this->randomOrderSeed !== null;
}
/**
* @throws Exception
*/
public function randomOrderSeed(): int
{
if ($this->randomOrderSeed === null) {
throw new Exception;
}
return $this->randomOrderSeed;
}
public function hasRepeat(): bool
{
return $this->repeat !== null;
}
/**
* @throws Exception
*/
public function repeat(): int
{
if ($this->repeat === null) {
throw new Exception;
}
return $this->repeat;
}
public function hasReportUselessTests(): bool
{
return $this->reportUselessTests !== null;
}
/**
* @throws Exception
*/
public function reportUselessTests(): bool
{
if ($this->reportUselessTests === null) {
throw new Exception;
}
return $this->reportUselessTests;
}
public function hasResolveDependencies(): bool
{
return $this->resolveDependencies !== null;
}
/**
* @throws Exception
*/
public function resolveDependencies(): bool
{
if ($this->resolveDependencies === null) {
throw new Exception;
}
return $this->resolveDependencies;
}
public function hasReverseList(): bool
{
return $this->reverseList !== null;
}
/**
* @throws Exception
*/
public function reverseList(): bool
{
if ($this->reverseList === null) {
throw new Exception;
}
return $this->reverseList;
}
public function hasStderr(): bool
{
return $this->stderr !== null;
}
/**
* @throws Exception
*/
public function stderr(): bool
{
if ($this->stderr === null) {
throw new Exception;
}
return $this->stderr;
}
public function hasStrictCoverage(): bool
{
return $this->strictCoverage !== null;
}
/**
* @throws Exception
*/
public function strictCoverage(): bool
{
if ($this->strictCoverage === null) {
throw new Exception;
}
return $this->strictCoverage;
}
public function hasStopOnDefect(): bool
{
return $this->stopOnDefect !== null;
}
/**
* @throws Exception
*/
public function stopOnDefect(): bool
{
if ($this->stopOnDefect === null) {
throw new Exception;
}
return $this->stopOnDefect;
}
public function hasStopOnError(): bool
{
return $this->stopOnError !== null;
}
/**
* @throws Exception
*/
public function stopOnError(): bool
{
if ($this->stopOnError === null) {
throw new Exception;
}
return $this->stopOnError;
}
public function hasStopOnFailure(): bool
{
return $this->stopOnFailure !== null;
}
/**
* @throws Exception
*/
public function stopOnFailure(): bool
{
if ($this->stopOnFailure === null) {
throw new Exception;
}
return $this->stopOnFailure;
}
public function hasStopOnIncomplete(): bool
{
return $this->stopOnIncomplete !== null;
}
/**
* @throws Exception
*/
public function stopOnIncomplete(): bool
{
if ($this->stopOnIncomplete === null) {
throw new Exception;
}
return $this->stopOnIncomplete;
}
public function hasStopOnRisky(): bool
{
return $this->stopOnRisky !== null;
}
/**
* @throws Exception
*/
public function stopOnRisky(): bool
{
if ($this->stopOnRisky === null) {
throw new Exception;
}
return $this->stopOnRisky;
}
public function hasStopOnSkipped(): bool
{
return $this->stopOnSkipped !== null;
}
/**
* @throws Exception
*/
public function stopOnSkipped(): bool
{
if ($this->stopOnSkipped === null) {
throw new Exception;
}
return $this->stopOnSkipped;
}
public function hasStopOnWarning(): bool
{
return $this->stopOnWarning !== null;
}
/**
* @throws Exception
*/
public function stopOnWarning(): bool
{
if ($this->stopOnWarning === null) {
throw new Exception;
}
return $this->stopOnWarning;
}
public function hasTeamcityLogfile(): bool
{
return $this->teamcityLogfile !== null;
}
/**
* @throws Exception
*/
public function teamcityLogfile(): string
{
if ($this->teamcityLogfile === null) {
throw new Exception;
}
return $this->teamcityLogfile;
}
public function hasTestdoxExcludeGroups(): bool
{
return $this->testdoxExcludeGroups !== null;
}
/**
* @throws Exception
*/
public function testdoxExcludeGroups(): array
{
if ($this->testdoxExcludeGroups === null) {
throw new Exception;
}
return $this->testdoxExcludeGroups;
}
public function hasTestdoxGroups(): bool
{
return $this->testdoxGroups !== null;
}
/**
* @throws Exception
*/
public function testdoxGroups(): array
{
if ($this->testdoxGroups === null) {
throw new Exception;
}
return $this->testdoxGroups;
}
public function hasTestdoxHtmlFile(): bool
{
return $this->testdoxHtmlFile !== null;
}
/**
* @throws Exception
*/
public function testdoxHtmlFile(): string
{
if ($this->testdoxHtmlFile === null) {
throw new Exception;
}
return $this->testdoxHtmlFile;
}
public function hasTestdoxTextFile(): bool
{
return $this->testdoxTextFile !== null;
}
/**
* @throws Exception
*/
public function testdoxTextFile(): string
{
if ($this->testdoxTextFile === null) {
throw new Exception;
}
return $this->testdoxTextFile;
}
public function hasTestdoxXmlFile(): bool
{
return $this->testdoxXmlFile !== null;
}
/**
* @throws Exception
*/
public function testdoxXmlFile(): string
{
if ($this->testdoxXmlFile === null) {
throw new Exception;
}
return $this->testdoxXmlFile;
}
public function hasTestSuffixes(): bool
{
return $this->testSuffixes !== null;
}
/**
* @throws Exception
*/
public function testSuffixes(): array
{
if ($this->testSuffixes === null) {
throw new Exception;
}
return $this->testSuffixes;
}
public function hasTestSuite(): bool
{
return $this->testSuite !== null;
}
/**
* @throws Exception
*/
public function testSuite(): string
{
if ($this->testSuite === null) {
throw new Exception;
}
return $this->testSuite;
}
public function unrecognizedOptions(): array
{
return $this->unrecognizedOptions;
}
public function hasUnrecognizedOrderBy(): bool
{
return $this->unrecognizedOrderBy !== null;
}
/**
* @throws Exception
*/
public function unrecognizedOrderBy(): string
{
if ($this->unrecognizedOrderBy === null) {
throw new Exception;
}
return $this->unrecognizedOrderBy;
}
public function hasUseDefaultConfiguration(): bool
{
return $this->useDefaultConfiguration !== null;
}
/**
* @throws Exception
*/
public function useDefaultConfiguration(): bool
{
if ($this->useDefaultConfiguration === null) {
throw new Exception;
}
return $this->useDefaultConfiguration;
}
public function hasVerbose(): bool
{
return $this->verbose !== null;
}
/**
* @throws Exception
*/
public function verbose(): bool
{
if ($this->verbose === null) {
throw new Exception;
}
return $this->verbose;
}
public function hasVersion(): bool
{
return $this->version !== null;
}
/**
* @throws Exception
*/
public function version(): bool
{
if ($this->version === null) {
throw new Exception;
}
return $this->version;
}
public function hasXdebugFilterFile(): bool
{
return $this->xdebugFilterFile !== null;
}
/**
* @throws Exception
*/
public function xdebugFilterFile(): string
{
if ($this->xdebugFilterFile === null) {
throw new Exception;
}
return $this->xdebugFilterFile;
}
}
PK [?B % src/TextUI/CliArguments/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\CliArguments;
use RuntimeException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Exception extends RuntimeException implements \PHPUnit\Exception
{
}
PK [3Q:- :- " src/TextUI/CliArguments/Mapper.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\CliArguments;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Mapper
{
/**
* @throws Exception
*/
public function mapToLegacyArray(Configuration $arguments): array
{
$result = [
'extensions' => [],
'listGroups' => false,
'listSuites' => false,
'listTests' => false,
'listTestsXml' => false,
'loader' => null,
'useDefaultConfiguration' => true,
'loadedExtensions' => [],
'unavailableExtensions' => [],
'notLoadedExtensions' => [],
];
if ($arguments->hasColors()) {
$result['colors'] = $arguments->colors();
}
if ($arguments->hasBootstrap()) {
$result['bootstrap'] = $arguments->bootstrap();
}
if ($arguments->hasCacheResult()) {
$result['cacheResult'] = $arguments->cacheResult();
}
if ($arguments->hasCacheResultFile()) {
$result['cacheResultFile'] = $arguments->cacheResultFile();
}
if ($arguments->hasColumns()) {
$result['columns'] = $arguments->columns();
}
if ($arguments->hasConfiguration()) {
$result['configuration'] = $arguments->configuration();
}
if ($arguments->hasCoverageCacheDirectory()) {
$result['coverageCacheDirectory'] = $arguments->coverageCacheDirectory();
}
if ($arguments->hasWarmCoverageCache()) {
$result['warmCoverageCache'] = $arguments->warmCoverageCache();
}
if ($arguments->hasCoverageClover()) {
$result['coverageClover'] = $arguments->coverageClover();
}
if ($arguments->hasCoverageCobertura()) {
$result['coverageCobertura'] = $arguments->coverageCobertura();
}
if ($arguments->hasCoverageCrap4J()) {
$result['coverageCrap4J'] = $arguments->coverageCrap4J();
}
if ($arguments->hasCoverageHtml()) {
$result['coverageHtml'] = $arguments->coverageHtml();
}
if ($arguments->hasCoveragePhp()) {
$result['coveragePHP'] = $arguments->coveragePhp();
}
if ($arguments->hasCoverageText()) {
$result['coverageText'] = $arguments->coverageText();
}
if ($arguments->hasCoverageTextShowUncoveredFiles()) {
$result['coverageTextShowUncoveredFiles'] = $arguments->hasCoverageTextShowUncoveredFiles();
}
if ($arguments->hasCoverageTextShowOnlySummary()) {
$result['coverageTextShowOnlySummary'] = $arguments->coverageTextShowOnlySummary();
}
if ($arguments->hasCoverageXml()) {
$result['coverageXml'] = $arguments->coverageXml();
}
if ($arguments->hasPathCoverage()) {
$result['pathCoverage'] = $arguments->pathCoverage();
}
if ($arguments->hasDebug()) {
$result['debug'] = $arguments->debug();
}
if ($arguments->hasHelp()) {
$result['help'] = $arguments->help();
}
if ($arguments->hasFilter()) {
$result['filter'] = $arguments->filter();
}
if ($arguments->hasTestSuite()) {
$result['testsuite'] = $arguments->testSuite();
}
if ($arguments->hasGroups()) {
$result['groups'] = $arguments->groups();
}
if ($arguments->hasExcludeGroups()) {
$result['excludeGroups'] = $arguments->excludeGroups();
}
if ($arguments->hasTestsCovering()) {
$result['testsCovering'] = $arguments->testsCovering();
}
if ($arguments->hasTestsUsing()) {
$result['testsUsing'] = $arguments->testsUsing();
}
if ($arguments->hasTestSuffixes()) {
$result['testSuffixes'] = $arguments->testSuffixes();
}
if ($arguments->hasIncludePath()) {
$result['includePath'] = $arguments->includePath();
}
if ($arguments->hasListGroups()) {
$result['listGroups'] = $arguments->listGroups();
}
if ($arguments->hasListSuites()) {
$result['listSuites'] = $arguments->listSuites();
}
if ($arguments->hasListTests()) {
$result['listTests'] = $arguments->listTests();
}
if ($arguments->hasListTestsXml()) {
$result['listTestsXml'] = $arguments->listTestsXml();
}
if ($arguments->hasPrinter()) {
$result['printer'] = $arguments->printer();
}
if ($arguments->hasLoader()) {
$result['loader'] = $arguments->loader();
}
if ($arguments->hasJunitLogfile()) {
$result['junitLogfile'] = $arguments->junitLogfile();
}
if ($arguments->hasTeamcityLogfile()) {
$result['teamcityLogfile'] = $arguments->teamcityLogfile();
}
if ($arguments->hasExecutionOrder()) {
$result['executionOrder'] = $arguments->executionOrder();
}
if ($arguments->hasExecutionOrderDefects()) {
$result['executionOrderDefects'] = $arguments->executionOrderDefects();
}
if ($arguments->hasExtensions()) {
$result['extensions'] = $arguments->extensions();
}
if ($arguments->hasUnavailableExtensions()) {
$result['unavailableExtensions'] = $arguments->unavailableExtensions();
}
if ($arguments->hasResolveDependencies()) {
$result['resolveDependencies'] = $arguments->resolveDependencies();
}
if ($arguments->hasProcessIsolation()) {
$result['processIsolation'] = $arguments->processIsolation();
}
if ($arguments->hasRepeat()) {
$result['repeat'] = $arguments->repeat();
}
if ($arguments->hasStderr()) {
$result['stderr'] = $arguments->stderr();
}
if ($arguments->hasStopOnDefect()) {
$result['stopOnDefect'] = $arguments->stopOnDefect();
}
if ($arguments->hasStopOnError()) {
$result['stopOnError'] = $arguments->stopOnError();
}
if ($arguments->hasStopOnFailure()) {
$result['stopOnFailure'] = $arguments->stopOnFailure();
}
if ($arguments->hasStopOnWarning()) {
$result['stopOnWarning'] = $arguments->stopOnWarning();
}
if ($arguments->hasStopOnIncomplete()) {
$result['stopOnIncomplete'] = $arguments->stopOnIncomplete();
}
if ($arguments->hasStopOnRisky()) {
$result['stopOnRisky'] = $arguments->stopOnRisky();
}
if ($arguments->hasStopOnSkipped()) {
$result['stopOnSkipped'] = $arguments->stopOnSkipped();
}
if ($arguments->hasFailOnEmptyTestSuite()) {
$result['failOnEmptyTestSuite'] = $arguments->failOnEmptyTestSuite();
}
if ($arguments->hasFailOnIncomplete()) {
$result['failOnIncomplete'] = $arguments->failOnIncomplete();
}
if ($arguments->hasFailOnRisky()) {
$result['failOnRisky'] = $arguments->failOnRisky();
}
if ($arguments->hasFailOnSkipped()) {
$result['failOnSkipped'] = $arguments->failOnSkipped();
}
if ($arguments->hasFailOnWarning()) {
$result['failOnWarning'] = $arguments->failOnWarning();
}
if ($arguments->hasTestdoxGroups()) {
$result['testdoxGroups'] = $arguments->testdoxGroups();
}
if ($arguments->hasTestdoxExcludeGroups()) {
$result['testdoxExcludeGroups'] = $arguments->testdoxExcludeGroups();
}
if ($arguments->hasTestdoxHtmlFile()) {
$result['testdoxHTMLFile'] = $arguments->testdoxHtmlFile();
}
if ($arguments->hasTestdoxTextFile()) {
$result['testdoxTextFile'] = $arguments->testdoxTextFile();
}
if ($arguments->hasTestdoxXmlFile()) {
$result['testdoxXMLFile'] = $arguments->testdoxXmlFile();
}
if ($arguments->hasUseDefaultConfiguration()) {
$result['useDefaultConfiguration'] = $arguments->useDefaultConfiguration();
}
if ($arguments->hasNoExtensions()) {
$result['noExtensions'] = $arguments->noExtensions();
}
if ($arguments->hasNoCoverage()) {
$result['noCoverage'] = $arguments->noCoverage();
}
if ($arguments->hasNoLogging()) {
$result['noLogging'] = $arguments->noLogging();
}
if ($arguments->hasNoInteraction()) {
$result['noInteraction'] = $arguments->noInteraction();
}
if ($arguments->hasBackupGlobals()) {
$result['backupGlobals'] = $arguments->backupGlobals();
}
if ($arguments->hasBackupStaticAttributes()) {
$result['backupStaticAttributes'] = $arguments->backupStaticAttributes();
}
if ($arguments->hasVerbose()) {
$result['verbose'] = $arguments->verbose();
}
if ($arguments->hasReportUselessTests()) {
$result['reportUselessTests'] = $arguments->reportUselessTests();
}
if ($arguments->hasStrictCoverage()) {
$result['strictCoverage'] = $arguments->strictCoverage();
}
if ($arguments->hasDisableCodeCoverageIgnore()) {
$result['disableCodeCoverageIgnore'] = $arguments->disableCodeCoverageIgnore();
}
if ($arguments->hasBeStrictAboutChangesToGlobalState()) {
$result['beStrictAboutChangesToGlobalState'] = $arguments->beStrictAboutChangesToGlobalState();
}
if ($arguments->hasDisallowTestOutput()) {
$result['disallowTestOutput'] = $arguments->disallowTestOutput();
}
if ($arguments->hasBeStrictAboutResourceUsageDuringSmallTests()) {
$result['beStrictAboutResourceUsageDuringSmallTests'] = $arguments->beStrictAboutResourceUsageDuringSmallTests();
}
if ($arguments->hasDefaultTimeLimit()) {
$result['defaultTimeLimit'] = $arguments->defaultTimeLimit();
}
if ($arguments->hasEnforceTimeLimit()) {
$result['enforceTimeLimit'] = $arguments->enforceTimeLimit();
}
if ($arguments->hasDisallowTodoAnnotatedTests()) {
$result['disallowTodoAnnotatedTests'] = $arguments->disallowTodoAnnotatedTests();
}
if ($arguments->hasReverseList()) {
$result['reverseList'] = $arguments->reverseList();
}
if ($arguments->hasCoverageFilter()) {
$result['coverageFilter'] = $arguments->coverageFilter();
}
if ($arguments->hasRandomOrderSeed()) {
$result['randomOrderSeed'] = $arguments->randomOrderSeed();
}
if ($arguments->hasXdebugFilterFile()) {
$result['xdebugFilterFile'] = $arguments->xdebugFilterFile();
}
return $result;
}
}
PK [#kf f # src/TextUI/CliArguments/Builder.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI\CliArguments;
use function array_map;
use function array_merge;
use function class_exists;
use function explode;
use function is_numeric;
use function str_replace;
use PHPUnit\Runner\TestSuiteSorter;
use PHPUnit\TextUI\DefaultResultPrinter;
use PHPUnit\TextUI\XmlConfiguration\Extension;
use PHPUnit\Util\Log\TeamCity;
use PHPUnit\Util\TestDox\CliTestDoxPrinter;
use SebastianBergmann\CliParser\Exception as CliParserException;
use SebastianBergmann\CliParser\Parser as CliParser;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Builder
{
private const LONG_OPTIONS = [
'atleast-version=',
'prepend=',
'bootstrap=',
'cache-result',
'do-not-cache-result',
'cache-result-file=',
'check-version',
'colors==',
'columns=',
'configuration=',
'coverage-cache=',
'warm-coverage-cache',
'coverage-filter=',
'coverage-clover=',
'coverage-cobertura=',
'coverage-crap4j=',
'coverage-html=',
'coverage-php=',
'coverage-text==',
'coverage-xml=',
'path-coverage',
'debug',
'disallow-test-output',
'disallow-resource-usage',
'disallow-todo-tests',
'default-time-limit=',
'enforce-time-limit',
'exclude-group=',
'extensions=',
'filter=',
'generate-configuration',
'globals-backup',
'group=',
'covers=',
'uses=',
'help',
'resolve-dependencies',
'ignore-dependencies',
'include-path=',
'list-groups',
'list-suites',
'list-tests',
'list-tests-xml=',
'loader=',
'log-junit=',
'log-teamcity=',
'migrate-configuration',
'no-configuration',
'no-coverage',
'no-logging',
'no-interaction',
'no-extensions',
'order-by=',
'printer=',
'process-isolation',
'repeat=',
'dont-report-useless-tests',
'random-order',
'random-order-seed=',
'reverse-order',
'reverse-list',
'static-backup',
'stderr',
'stop-on-defect',
'stop-on-error',
'stop-on-failure',
'stop-on-warning',
'stop-on-incomplete',
'stop-on-risky',
'stop-on-skipped',
'fail-on-empty-test-suite',
'fail-on-incomplete',
'fail-on-risky',
'fail-on-skipped',
'fail-on-warning',
'strict-coverage',
'disable-coverage-ignore',
'strict-global-state',
'teamcity',
'testdox',
'testdox-group=',
'testdox-exclude-group=',
'testdox-html=',
'testdox-text=',
'testdox-xml=',
'test-suffix=',
'testsuite=',
'verbose',
'version',
'whitelist=',
'dump-xdebug-filter=',
];
private const SHORT_OPTIONS = 'd:c:hv';
public function fromParameters(array $parameters, array $additionalLongOptions): Configuration
{
try {
$options = (new CliParser)->parse(
$parameters,
self::SHORT_OPTIONS,
array_merge(self::LONG_OPTIONS, $additionalLongOptions)
);
} catch (CliParserException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e
);
}
$argument = null;
$atLeastVersion = null;
$backupGlobals = null;
$backupStaticAttributes = null;
$beStrictAboutChangesToGlobalState = null;
$beStrictAboutResourceUsageDuringSmallTests = null;
$bootstrap = null;
$cacheResult = null;
$cacheResultFile = null;
$checkVersion = null;
$colors = null;
$columns = null;
$configuration = null;
$coverageCacheDirectory = null;
$warmCoverageCache = null;
$coverageFilter = null;
$coverageClover = null;
$coverageCobertura = null;
$coverageCrap4J = null;
$coverageHtml = null;
$coveragePhp = null;
$coverageText = null;
$coverageTextShowUncoveredFiles = null;
$coverageTextShowOnlySummary = null;
$coverageXml = null;
$pathCoverage = null;
$debug = null;
$defaultTimeLimit = null;
$disableCodeCoverageIgnore = null;
$disallowTestOutput = null;
$disallowTodoAnnotatedTests = null;
$enforceTimeLimit = null;
$excludeGroups = null;
$executionOrder = null;
$executionOrderDefects = null;
$extensions = [];
$unavailableExtensions = [];
$failOnEmptyTestSuite = null;
$failOnIncomplete = null;
$failOnRisky = null;
$failOnSkipped = null;
$failOnWarning = null;
$filter = null;
$generateConfiguration = null;
$migrateConfiguration = null;
$groups = null;
$testsCovering = null;
$testsUsing = null;
$help = null;
$includePath = null;
$iniSettings = [];
$junitLogfile = null;
$listGroups = null;
$listSuites = null;
$listTests = null;
$listTestsXml = null;
$loader = null;
$noCoverage = null;
$noExtensions = null;
$noInteraction = null;
$noLogging = null;
$printer = null;
$processIsolation = null;
$randomOrderSeed = null;
$repeat = null;
$reportUselessTests = null;
$resolveDependencies = null;
$reverseList = null;
$stderr = null;
$strictCoverage = null;
$stopOnDefect = null;
$stopOnError = null;
$stopOnFailure = null;
$stopOnIncomplete = null;
$stopOnRisky = null;
$stopOnSkipped = null;
$stopOnWarning = null;
$teamcityLogfile = null;
$testdoxExcludeGroups = null;
$testdoxGroups = null;
$testdoxHtmlFile = null;
$testdoxTextFile = null;
$testdoxXmlFile = null;
$testSuffixes = null;
$testSuite = null;
$unrecognizedOptions = [];
$unrecognizedOrderBy = null;
$useDefaultConfiguration = null;
$verbose = null;
$version = null;
$xdebugFilterFile = null;
if (isset($options[1][0])) {
$argument = $options[1][0];
}
foreach ($options[0] as $option) {
switch ($option[0]) {
case '--colors':
$colors = $option[1] ?: DefaultResultPrinter::COLOR_AUTO;
break;
case '--bootstrap':
$bootstrap = $option[1];
break;
case '--cache-result':
$cacheResult = true;
break;
case '--do-not-cache-result':
$cacheResult = false;
break;
case '--cache-result-file':
$cacheResultFile = $option[1];
break;
case '--columns':
if (is_numeric($option[1])) {
$columns = (int) $option[1];
} elseif ($option[1] === 'max') {
$columns = 'max';
}
break;
case 'c':
case '--configuration':
$configuration = $option[1];
break;
case '--coverage-cache':
$coverageCacheDirectory = $option[1];
break;
case '--warm-coverage-cache':
$warmCoverageCache = true;
break;
case '--coverage-clover':
$coverageClover = $option[1];
break;
case '--coverage-cobertura':
$coverageCobertura = $option[1];
break;
case '--coverage-crap4j':
$coverageCrap4J = $option[1];
break;
case '--coverage-html':
$coverageHtml = $option[1];
break;
case '--coverage-php':
$coveragePhp = $option[1];
break;
case '--coverage-text':
if ($option[1] === null) {
$option[1] = 'php://stdout';
}
$coverageText = $option[1];
$coverageTextShowUncoveredFiles = false;
$coverageTextShowOnlySummary = false;
break;
case '--coverage-xml':
$coverageXml = $option[1];
break;
case '--path-coverage':
$pathCoverage = true;
break;
case 'd':
$tmp = explode('=', $option[1]);
if (isset($tmp[0])) {
if (isset($tmp[1])) {
$iniSettings[$tmp[0]] = $tmp[1];
} else {
$iniSettings[$tmp[0]] = '1';
}
}
break;
case '--debug':
$debug = true;
break;
case 'h':
case '--help':
$help = true;
break;
case '--filter':
$filter = $option[1];
break;
case '--testsuite':
$testSuite = $option[1];
break;
case '--generate-configuration':
$generateConfiguration = true;
break;
case '--migrate-configuration':
$migrateConfiguration = true;
break;
case '--group':
$groups = explode(',', $option[1]);
break;
case '--exclude-group':
$excludeGroups = explode(',', $option[1]);
break;
case '--covers':
$testsCovering = array_map('strtolower', explode(',', $option[1]));
break;
case '--uses':
$testsUsing = array_map('strtolower', explode(',', $option[1]));
break;
case '--test-suffix':
$testSuffixes = explode(',', $option[1]);
break;
case '--include-path':
$includePath = $option[1];
break;
case '--list-groups':
$listGroups = true;
break;
case '--list-suites':
$listSuites = true;
break;
case '--list-tests':
$listTests = true;
break;
case '--list-tests-xml':
$listTestsXml = $option[1];
break;
case '--printer':
$printer = $option[1];
break;
case '--loader':
$loader = $option[1];
break;
case '--log-junit':
$junitLogfile = $option[1];
break;
case '--log-teamcity':
$teamcityLogfile = $option[1];
break;
case '--order-by':
foreach (explode(',', $option[1]) as $order) {
switch ($order) {
case 'default':
$executionOrder = TestSuiteSorter::ORDER_DEFAULT;
$executionOrderDefects = TestSuiteSorter::ORDER_DEFAULT;
$resolveDependencies = true;
break;
case 'defects':
$executionOrderDefects = TestSuiteSorter::ORDER_DEFECTS_FIRST;
break;
case 'depends':
$resolveDependencies = true;
break;
case 'duration':
$executionOrder = TestSuiteSorter::ORDER_DURATION;
break;
case 'no-depends':
$resolveDependencies = false;
break;
case 'random':
$executionOrder = TestSuiteSorter::ORDER_RANDOMIZED;
break;
case 'reverse':
$executionOrder = TestSuiteSorter::ORDER_REVERSED;
break;
case 'size':
$executionOrder = TestSuiteSorter::ORDER_SIZE;
break;
default:
$unrecognizedOrderBy = $order;
}
}
break;
case '--process-isolation':
$processIsolation = true;
break;
case '--repeat':
$repeat = (int) $option[1];
break;
case '--stderr':
$stderr = true;
break;
case '--stop-on-defect':
$stopOnDefect = true;
break;
case '--stop-on-error':
$stopOnError = true;
break;
case '--stop-on-failure':
$stopOnFailure = true;
break;
case '--stop-on-warning':
$stopOnWarning = true;
break;
case '--stop-on-incomplete':
$stopOnIncomplete = true;
break;
case '--stop-on-risky':
$stopOnRisky = true;
break;
case '--stop-on-skipped':
$stopOnSkipped = true;
break;
case '--fail-on-empty-test-suite':
$failOnEmptyTestSuite = true;
break;
case '--fail-on-incomplete':
$failOnIncomplete = true;
break;
case '--fail-on-risky':
$failOnRisky = true;
break;
case '--fail-on-skipped':
$failOnSkipped = true;
break;
case '--fail-on-warning':
$failOnWarning = true;
break;
case '--teamcity':
$printer = TeamCity::class;
break;
case '--testdox':
$printer = CliTestDoxPrinter::class;
break;
case '--testdox-group':
$testdoxGroups = explode(',', $option[1]);
break;
case '--testdox-exclude-group':
$testdoxExcludeGroups = explode(',', $option[1]);
break;
case '--testdox-html':
$testdoxHtmlFile = $option[1];
break;
case '--testdox-text':
$testdoxTextFile = $option[1];
break;
case '--testdox-xml':
$testdoxXmlFile = $option[1];
break;
case '--no-configuration':
$useDefaultConfiguration = false;
break;
case '--extensions':
foreach (explode(',', $option[1]) as $extensionClass) {
if (!class_exists($extensionClass)) {
$unavailableExtensions[] = $extensionClass;
continue;
}
$extensions[] = new Extension($extensionClass, '', []);
}
break;
case '--no-extensions':
$noExtensions = true;
break;
case '--no-coverage':
$noCoverage = true;
break;
case '--no-logging':
$noLogging = true;
break;
case '--no-interaction':
$noInteraction = true;
break;
case '--globals-backup':
$backupGlobals = true;
break;
case '--static-backup':
$backupStaticAttributes = true;
break;
case 'v':
case '--verbose':
$verbose = true;
break;
case '--atleast-version':
$atLeastVersion = $option[1];
break;
case '--version':
$version = true;
break;
case '--dont-report-useless-tests':
$reportUselessTests = false;
break;
case '--strict-coverage':
$strictCoverage = true;
break;
case '--disable-coverage-ignore':
$disableCodeCoverageIgnore = true;
break;
case '--strict-global-state':
$beStrictAboutChangesToGlobalState = true;
break;
case '--disallow-test-output':
$disallowTestOutput = true;
break;
case '--disallow-resource-usage':
$beStrictAboutResourceUsageDuringSmallTests = true;
break;
case '--default-time-limit':
$defaultTimeLimit = (int) $option[1];
break;
case '--enforce-time-limit':
$enforceTimeLimit = true;
break;
case '--disallow-todo-tests':
$disallowTodoAnnotatedTests = true;
break;
case '--reverse-list':
$reverseList = true;
break;
case '--check-version':
$checkVersion = true;
break;
case '--coverage-filter':
case '--whitelist':
if ($coverageFilter === null) {
$coverageFilter = [];
}
$coverageFilter[] = $option[1];
break;
case '--random-order':
$executionOrder = TestSuiteSorter::ORDER_RANDOMIZED;
break;
case '--random-order-seed':
$randomOrderSeed = (int) $option[1];
break;
case '--resolve-dependencies':
$resolveDependencies = true;
break;
case '--ignore-dependencies':
$resolveDependencies = false;
break;
case '--reverse-order':
$executionOrder = TestSuiteSorter::ORDER_REVERSED;
break;
case '--dump-xdebug-filter':
$xdebugFilterFile = $option[1];
break;
default:
$unrecognizedOptions[str_replace('--', '', $option[0])] = $option[1];
}
}
if (empty($extensions)) {
$extensions = null;
}
if (empty($unavailableExtensions)) {
$unavailableExtensions = null;
}
if (empty($iniSettings)) {
$iniSettings = null;
}
if (empty($coverageFilter)) {
$coverageFilter = null;
}
return new Configuration(
$argument,
$atLeastVersion,
$backupGlobals,
$backupStaticAttributes,
$beStrictAboutChangesToGlobalState,
$beStrictAboutResourceUsageDuringSmallTests,
$bootstrap,
$cacheResult,
$cacheResultFile,
$checkVersion,
$colors,
$columns,
$configuration,
$coverageClover,
$coverageCobertura,
$coverageCrap4J,
$coverageHtml,
$coveragePhp,
$coverageText,
$coverageTextShowUncoveredFiles,
$coverageTextShowOnlySummary,
$coverageXml,
$pathCoverage,
$coverageCacheDirectory,
$warmCoverageCache,
$debug,
$defaultTimeLimit,
$disableCodeCoverageIgnore,
$disallowTestOutput,
$disallowTodoAnnotatedTests,
$enforceTimeLimit,
$excludeGroups,
$executionOrder,
$executionOrderDefects,
$extensions,
$unavailableExtensions,
$failOnEmptyTestSuite,
$failOnIncomplete,
$failOnRisky,
$failOnSkipped,
$failOnWarning,
$filter,
$generateConfiguration,
$migrateConfiguration,
$groups,
$testsCovering,
$testsUsing,
$help,
$includePath,
$iniSettings,
$junitLogfile,
$listGroups,
$listSuites,
$listTests,
$listTestsXml,
$loader,
$noCoverage,
$noExtensions,
$noInteraction,
$noLogging,
$printer,
$processIsolation,
$randomOrderSeed,
$repeat,
$reportUselessTests,
$resolveDependencies,
$reverseList,
$stderr,
$strictCoverage,
$stopOnDefect,
$stopOnError,
$stopOnFailure,
$stopOnIncomplete,
$stopOnRisky,
$stopOnSkipped,
$stopOnWarning,
$teamcityLogfile,
$testdoxExcludeGroups,
$testdoxGroups,
$testdoxHtmlFile,
$testdoxTextFile,
$testdoxXmlFile,
$testSuffixes,
$testSuite,
$unrecognizedOptions,
$unrecognizedOrderBy,
$useDefaultConfiguration,
$verbose,
$version,
$coverageFilter,
$xdebugFilterFile
);
}
}
PK [374 4 src/TextUI/Help.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use const PHP_EOL;
use function count;
use function explode;
use function max;
use function preg_replace_callback;
use function str_pad;
use function str_repeat;
use function strlen;
use function wordwrap;
use PHPUnit\Util\Color;
use SebastianBergmann\Environment\Console;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Help
{
private const LEFT_MARGIN = ' ';
private const HELP_TEXT = [
'Usage' => [
['text' => 'phpunit [options] UnitTest.php'],
['text' => 'phpunit [options] '],
],
'Code Coverage Options' => [
['arg' => '--coverage-clover ', 'desc' => 'Generate code coverage report in Clover XML format'],
['arg' => '--coverage-cobertura ', 'desc' => 'Generate code coverage report in Cobertura XML format'],
['arg' => '--coverage-crap4j ', 'desc' => 'Generate code coverage report in Crap4J XML format'],
['arg' => '--coverage-html ', 'desc' => 'Generate code coverage report in HTML format'],
['arg' => '--coverage-php ', 'desc' => 'Export PHP_CodeCoverage object to file'],
['arg' => '--coverage-text=', 'desc' => 'Generate code coverage report in text format [default: standard output]'],
['arg' => '--coverage-xml ', 'desc' => 'Generate code coverage report in PHPUnit XML format'],
['arg' => '--coverage-cache ', 'desc' => 'Cache static analysis results'],
['arg' => '--warm-coverage-cache', 'desc' => 'Warm static analysis cache'],
['arg' => '--coverage-filter ', 'desc' => 'Include in code coverage analysis'],
['arg' => '--path-coverage', 'desc' => 'Perform path coverage analysis'],
['arg' => '--disable-coverage-ignore', 'desc' => 'Disable annotations for ignoring code coverage'],
['arg' => '--no-coverage', 'desc' => 'Ignore code coverage configuration'],
],
'Logging Options' => [
['arg' => '--log-junit ', 'desc' => 'Log test execution in JUnit XML format to file'],
['arg' => '--log-teamcity ', 'desc' => 'Log test execution in TeamCity format to file'],
['arg' => '--testdox-html ', 'desc' => 'Write agile documentation in HTML format to file'],
['arg' => '--testdox-text ', 'desc' => 'Write agile documentation in Text format to file'],
['arg' => '--testdox-xml ', 'desc' => 'Write agile documentation in XML format to file'],
['arg' => '--reverse-list', 'desc' => 'Print defects in reverse order'],
['arg' => '--no-logging', 'desc' => 'Ignore logging configuration'],
],
'Test Selection Options' => [
['arg' => '--list-suites', 'desc' => 'List available test suites'],
['arg' => '--testsuite ', 'desc' => 'Filter which testsuite to run'],
['arg' => '--list-groups', 'desc' => 'List available test groups'],
['arg' => '--group ', 'desc' => 'Only runs tests from the specified group(s)'],
['arg' => '--exclude-group ', 'desc' => 'Exclude tests from the specified group(s)'],
['arg' => '--covers ', 'desc' => 'Only runs tests annotated with "@covers "'],
['arg' => '--uses ', 'desc' => 'Only runs tests annotated with "@uses "'],
['arg' => '--list-tests', 'desc' => 'List available tests'],
['arg' => '--list-tests-xml ', 'desc' => 'List available tests in XML format'],
['arg' => '--filter ', 'desc' => 'Filter which tests to run'],
['arg' => '--test-suffix ', 'desc' => 'Only search for test in files with specified suffix(es). Default: Test.php,.phpt'],
],
'Test Execution Options' => [
['arg' => '--dont-report-useless-tests', 'desc' => 'Do not report tests that do not test anything'],
['arg' => '--strict-coverage', 'desc' => 'Be strict about @covers annotation usage'],
['arg' => '--strict-global-state', 'desc' => 'Be strict about changes to global state'],
['arg' => '--disallow-test-output', 'desc' => 'Be strict about output during tests'],
['arg' => '--disallow-resource-usage', 'desc' => 'Be strict about resource usage during small tests'],
['arg' => '--enforce-time-limit', 'desc' => 'Enforce time limit based on test size'],
['arg' => '--default-time-limit ', 'desc' => 'Timeout in seconds for tests without @small, @medium or @large'],
['arg' => '--disallow-todo-tests', 'desc' => 'Disallow @todo-annotated tests'],
['spacer' => ''],
['arg' => '--process-isolation', 'desc' => 'Run each test in a separate PHP process'],
['arg' => '--globals-backup', 'desc' => 'Backup and restore $GLOBALS for each test'],
['arg' => '--static-backup', 'desc' => 'Backup and restore static attributes for each test'],
['spacer' => ''],
['arg' => '--colors ', 'desc' => 'Use colors in output ("never", "auto" or "always")'],
['arg' => '--columns ', 'desc' => 'Number of columns to use for progress output'],
['arg' => '--columns max', 'desc' => 'Use maximum number of columns for progress output'],
['arg' => '--stderr', 'desc' => 'Write to STDERR instead of STDOUT'],
['arg' => '--stop-on-defect', 'desc' => 'Stop execution upon first not-passed test'],
['arg' => '--stop-on-error', 'desc' => 'Stop execution upon first error'],
['arg' => '--stop-on-failure', 'desc' => 'Stop execution upon first error or failure'],
['arg' => '--stop-on-warning', 'desc' => 'Stop execution upon first warning'],
['arg' => '--stop-on-risky', 'desc' => 'Stop execution upon first risky test'],
['arg' => '--stop-on-skipped', 'desc' => 'Stop execution upon first skipped test'],
['arg' => '--stop-on-incomplete', 'desc' => 'Stop execution upon first incomplete test'],
['arg' => '--fail-on-incomplete', 'desc' => 'Treat incomplete tests as failures'],
['arg' => '--fail-on-risky', 'desc' => 'Treat risky tests as failures'],
['arg' => '--fail-on-skipped', 'desc' => 'Treat skipped tests as failures'],
['arg' => '--fail-on-warning', 'desc' => 'Treat tests with warnings as failures'],
['arg' => '-v|--verbose', 'desc' => 'Output more verbose information'],
['arg' => '--debug', 'desc' => 'Display debugging information'],
['spacer' => ''],
['arg' => '--repeat ', 'desc' => 'Runs the test(s) repeatedly'],
['arg' => '--teamcity', 'desc' => 'Report test execution progress in TeamCity format'],
['arg' => '--testdox', 'desc' => 'Report test execution progress in TestDox format'],
['arg' => '--testdox-group', 'desc' => 'Only include tests from the specified group(s)'],
['arg' => '--testdox-exclude-group', 'desc' => 'Exclude tests from the specified group(s)'],
['arg' => '--no-interaction', 'desc' => 'Disable TestDox progress animation'],
['arg' => '--printer ', 'desc' => 'TestListener implementation to use'],
['spacer' => ''],
['arg' => '--order-by ', 'desc' => 'Run tests in order: default|defects|duration|no-depends|random|reverse|size'],
['arg' => '--random-order-seed ', 'desc' => 'Use a specific random seed for random order'],
['arg' => '--cache-result', 'desc' => 'Write test results to cache file'],
['arg' => '--do-not-cache-result', 'desc' => 'Do not write test results to cache file'],
],
'Configuration Options' => [
['arg' => '--prepend ', 'desc' => 'A PHP script that is included as early as possible'],
['arg' => '--bootstrap ', 'desc' => 'A PHP script that is included before the tests run'],
['arg' => '-c|--configuration ', 'desc' => 'Read configuration from XML file'],
['arg' => '--no-configuration', 'desc' => 'Ignore default configuration file (phpunit.xml)'],
['arg' => '--extensions ', 'desc' => 'A comma separated list of PHPUnit extensions to load'],
['arg' => '--no-extensions', 'desc' => 'Do not load PHPUnit extensions'],
['arg' => '--include-path ', 'desc' => 'Prepend PHP\'s include_path with given path(s)'],
['arg' => '-d ', 'desc' => 'Sets a php.ini value'],
['arg' => '--cache-result-file ', 'desc' => 'Specify result cache path and filename'],
['arg' => '--generate-configuration', 'desc' => 'Generate configuration file with suggested settings'],
['arg' => '--migrate-configuration', 'desc' => 'Migrate configuration file to current format'],
],
'Miscellaneous Options' => [
['arg' => '-h|--help', 'desc' => 'Prints this usage information'],
['arg' => '--version', 'desc' => 'Prints the version and exits'],
['arg' => '--atleast-version ', 'desc' => 'Checks that version is greater than min and exits'],
['arg' => '--check-version', 'desc' => 'Check whether PHPUnit is the latest version'],
],
];
/**
* @var int Number of columns required to write the longest option name to the console
*/
private $maxArgLength = 0;
/**
* @var int Number of columns left for the description field after padding and option
*/
private $maxDescLength;
/**
* @var bool Use color highlights for sections, options and parameters
*/
private $hasColor = false;
public function __construct(?int $width = null, ?bool $withColor = null)
{
if ($width === null) {
$width = (new Console)->getNumberOfColumns();
}
if ($withColor === null) {
$this->hasColor = (new Console)->hasColorSupport();
} else {
$this->hasColor = $withColor;
}
foreach (self::HELP_TEXT as $options) {
foreach ($options as $option) {
if (isset($option['arg'])) {
$this->maxArgLength = max($this->maxArgLength, isset($option['arg']) ? strlen($option['arg']) : 0);
}
}
}
$this->maxDescLength = $width - $this->maxArgLength - 4;
}
/**
* Write the help file to the CLI, adapting width and colors to the console.
*/
public function writeToConsole(): void
{
if ($this->hasColor) {
$this->writeWithColor();
} else {
$this->writePlaintext();
}
}
private function writePlaintext(): void
{
foreach (self::HELP_TEXT as $section => $options) {
print "{$section}:" . PHP_EOL;
if ($section !== 'Usage') {
print PHP_EOL;
}
foreach ($options as $option) {
if (isset($option['spacer'])) {
print PHP_EOL;
}
if (isset($option['text'])) {
print self::LEFT_MARGIN . $option['text'] . PHP_EOL;
}
if (isset($option['arg'])) {
$arg = str_pad($option['arg'], $this->maxArgLength);
print self::LEFT_MARGIN . $arg . ' ' . $option['desc'] . PHP_EOL;
}
}
print PHP_EOL;
}
}
private function writeWithColor(): void
{
foreach (self::HELP_TEXT as $section => $options) {
print Color::colorize('fg-yellow', "{$section}:") . PHP_EOL;
foreach ($options as $option) {
if (isset($option['spacer'])) {
print PHP_EOL;
}
if (isset($option['text'])) {
print self::LEFT_MARGIN . $option['text'] . PHP_EOL;
}
if (isset($option['arg'])) {
$arg = Color::colorize('fg-green', str_pad($option['arg'], $this->maxArgLength));
$arg = preg_replace_callback(
'/(<[^>]+>)/',
static function ($matches)
{
return Color::colorize('fg-cyan', $matches[0]);
},
$arg
);
$desc = explode(PHP_EOL, wordwrap($option['desc'], $this->maxDescLength, PHP_EOL));
print self::LEFT_MARGIN . $arg . ' ' . $desc[0] . PHP_EOL;
for ($i = 1; $i < count($desc); $i++) {
print str_repeat(' ', $this->maxArgLength + 3) . $desc[$i] . PHP_EOL;
}
}
}
print PHP_EOL;
}
}
}
PK [!H< H< # src/TextUI/DefaultResultPrinter.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use const PHP_EOL;
use function array_map;
use function array_reverse;
use function count;
use function floor;
use function implode;
use function in_array;
use function is_int;
use function max;
use function preg_split;
use function sprintf;
use function str_pad;
use function str_repeat;
use function strlen;
use function trim;
use function vsprintf;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\Exception;
use PHPUnit\Framework\InvalidArgumentException;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestFailure;
use PHPUnit\Framework\TestResult;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Framework\Warning;
use PHPUnit\Runner\PhptTestCase;
use PHPUnit\Util\Color;
use PHPUnit\Util\Printer;
use SebastianBergmann\Environment\Console;
use SebastianBergmann\Timer\ResourceUsageFormatter;
use SebastianBergmann\Timer\Timer;
use Throwable;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
class DefaultResultPrinter extends Printer implements ResultPrinter
{
public const EVENT_TEST_START = 0;
public const EVENT_TEST_END = 1;
public const EVENT_TESTSUITE_START = 2;
public const EVENT_TESTSUITE_END = 3;
public const COLOR_NEVER = 'never';
public const COLOR_AUTO = 'auto';
public const COLOR_ALWAYS = 'always';
public const COLOR_DEFAULT = self::COLOR_NEVER;
private const AVAILABLE_COLORS = [self::COLOR_NEVER, self::COLOR_AUTO, self::COLOR_ALWAYS];
/**
* @var int
*/
protected $column = 0;
/**
* @var int
*/
protected $maxColumn;
/**
* @var bool
*/
protected $lastTestFailed = false;
/**
* @var int
*/
protected $numAssertions = 0;
/**
* @var int
*/
protected $numTests = -1;
/**
* @var int
*/
protected $numTestsRun = 0;
/**
* @var int
*/
protected $numTestsWidth;
/**
* @var bool
*/
protected $colors = false;
/**
* @var bool
*/
protected $debug = false;
/**
* @var bool
*/
protected $verbose = false;
/**
* @var int
*/
private $numberOfColumns;
/**
* @var bool
*/
private $reverse;
/**
* @var bool
*/
private $defectListPrinted = false;
/**
* @var Timer
*/
private $timer;
/**
* Constructor.
*
* @param null|resource|string $out
* @param int|string $numberOfColumns
*
* @throws Exception
*/
public function __construct($out = null, bool $verbose = false, string $colors = self::COLOR_DEFAULT, bool $debug = false, $numberOfColumns = 80, bool $reverse = false)
{
parent::__construct($out);
if (!in_array($colors, self::AVAILABLE_COLORS, true)) {
throw InvalidArgumentException::create(
3,
vsprintf('value from "%s", "%s" or "%s"', self::AVAILABLE_COLORS)
);
}
if (!is_int($numberOfColumns) && $numberOfColumns !== 'max') {
throw InvalidArgumentException::create(5, 'integer or "max"');
}
$console = new Console;
$maxNumberOfColumns = $console->getNumberOfColumns();
if ($numberOfColumns === 'max' || ($numberOfColumns !== 80 && $numberOfColumns > $maxNumberOfColumns)) {
$numberOfColumns = $maxNumberOfColumns;
}
$this->numberOfColumns = $numberOfColumns;
$this->verbose = $verbose;
$this->debug = $debug;
$this->reverse = $reverse;
if ($colors === self::COLOR_AUTO && $console->hasColorSupport()) {
$this->colors = true;
} else {
$this->colors = (self::COLOR_ALWAYS === $colors);
}
$this->timer = new Timer;
$this->timer->start();
}
public function printResult(TestResult $result): void
{
$this->printHeader($result);
$this->printErrors($result);
$this->printWarnings($result);
$this->printFailures($result);
$this->printRisky($result);
if ($this->verbose) {
$this->printIncompletes($result);
$this->printSkipped($result);
}
$this->printFooter($result);
}
/**
* An error occurred.
*/
public function addError(Test $test, Throwable $t, float $time): void
{
$this->writeProgressWithColor('fg-red, bold', 'E');
$this->lastTestFailed = true;
}
/**
* A failure occurred.
*/
public function addFailure(Test $test, AssertionFailedError $e, float $time): void
{
$this->writeProgressWithColor('bg-red, fg-white', 'F');
$this->lastTestFailed = true;
}
/**
* A warning occurred.
*/
public function addWarning(Test $test, Warning $e, float $time): void
{
$this->writeProgressWithColor('fg-yellow, bold', 'W');
$this->lastTestFailed = true;
}
/**
* Incomplete test.
*/
public function addIncompleteTest(Test $test, Throwable $t, float $time): void
{
$this->writeProgressWithColor('fg-yellow, bold', 'I');
$this->lastTestFailed = true;
}
/**
* Risky test.
*/
public function addRiskyTest(Test $test, Throwable $t, float $time): void
{
$this->writeProgressWithColor('fg-yellow, bold', 'R');
$this->lastTestFailed = true;
}
/**
* Skipped test.
*/
public function addSkippedTest(Test $test, Throwable $t, float $time): void
{
$this->writeProgressWithColor('fg-cyan, bold', 'S');
$this->lastTestFailed = true;
}
/**
* A testsuite started.
*/
public function startTestSuite(TestSuite $suite): void
{
if ($this->numTests == -1) {
$this->numTests = count($suite);
$this->numTestsWidth = strlen((string) $this->numTests);
$this->maxColumn = $this->numberOfColumns - strlen(' / (XXX%)') - (2 * $this->numTestsWidth);
}
}
/**
* A testsuite ended.
*/
public function endTestSuite(TestSuite $suite): void
{
}
/**
* A test started.
*/
public function startTest(Test $test): void
{
if ($this->debug) {
$this->write(
sprintf(
"Test '%s' started\n",
\PHPUnit\Util\Test::describeAsString($test)
)
);
}
}
/**
* A test ended.
*/
public function endTest(Test $test, float $time): void
{
if ($this->debug) {
$this->write(
sprintf(
"Test '%s' ended\n",
\PHPUnit\Util\Test::describeAsString($test)
)
);
}
if (!$this->lastTestFailed) {
$this->writeProgress('.');
}
if ($test instanceof TestCase) {
$this->numAssertions += $test->getNumAssertions();
} elseif ($test instanceof PhptTestCase) {
$this->numAssertions++;
}
$this->lastTestFailed = false;
if ($test instanceof TestCase && !$test->hasExpectationOnOutput()) {
$this->write($test->getActualOutput());
}
}
protected function printDefects(array $defects, string $type): void
{
$count = count($defects);
if ($count == 0) {
return;
}
if ($this->defectListPrinted) {
$this->write("\n--\n\n");
}
$this->write(
sprintf(
"There %s %d %s%s:\n",
($count == 1) ? 'was' : 'were',
$count,
$type,
($count == 1) ? '' : 's'
)
);
$i = 1;
if ($this->reverse) {
$defects = array_reverse($defects);
}
foreach ($defects as $defect) {
$this->printDefect($defect, $i++);
}
$this->defectListPrinted = true;
}
protected function printDefect(TestFailure $defect, int $count): void
{
$this->printDefectHeader($defect, $count);
$this->printDefectTrace($defect);
}
protected function printDefectHeader(TestFailure $defect, int $count): void
{
$this->write(
sprintf(
"\n%d) %s\n",
$count,
$defect->getTestName()
)
);
}
protected function printDefectTrace(TestFailure $defect): void
{
$e = $defect->thrownException();
$this->write((string) $e);
while ($e = $e->getPrevious()) {
$this->write("\nCaused by\n" . trim((string) $e) . "\n");
}
}
protected function printErrors(TestResult $result): void
{
$this->printDefects($result->errors(), 'error');
}
protected function printFailures(TestResult $result): void
{
$this->printDefects($result->failures(), 'failure');
}
protected function printWarnings(TestResult $result): void
{
$this->printDefects($result->warnings(), 'warning');
}
protected function printIncompletes(TestResult $result): void
{
$this->printDefects($result->notImplemented(), 'incomplete test');
}
protected function printRisky(TestResult $result): void
{
$this->printDefects($result->risky(), 'risky test');
}
protected function printSkipped(TestResult $result): void
{
$this->printDefects($result->skipped(), 'skipped test');
}
protected function printHeader(TestResult $result): void
{
if (count($result) > 0) {
$this->write(PHP_EOL . PHP_EOL . (new ResourceUsageFormatter)->resourceUsage($this->timer->stop()) . PHP_EOL . PHP_EOL);
}
}
protected function printFooter(TestResult $result): void
{
if (count($result) === 0) {
$this->writeWithColor(
'fg-black, bg-yellow',
'No tests executed!'
);
return;
}
if ($result->wasSuccessfulAndNoTestIsRiskyOrSkippedOrIncomplete()) {
$this->writeWithColor(
'fg-black, bg-green',
sprintf(
'OK (%d test%s, %d assertion%s)',
count($result),
(count($result) === 1) ? '' : 's',
$this->numAssertions,
($this->numAssertions === 1) ? '' : 's'
)
);
return;
}
$color = 'fg-black, bg-yellow';
if ($result->wasSuccessful()) {
if ($this->verbose || !$result->allHarmless()) {
$this->write("\n");
}
$this->writeWithColor(
$color,
'OK, but incomplete, skipped, or risky tests!'
);
} else {
$this->write("\n");
if ($result->errorCount()) {
$color = 'fg-white, bg-red';
$this->writeWithColor(
$color,
'ERRORS!'
);
} elseif ($result->failureCount()) {
$color = 'fg-white, bg-red';
$this->writeWithColor(
$color,
'FAILURES!'
);
} elseif ($result->warningCount()) {
$color = 'fg-black, bg-yellow';
$this->writeWithColor(
$color,
'WARNINGS!'
);
}
}
$this->writeCountString(count($result), 'Tests', $color, true);
$this->writeCountString($this->numAssertions, 'Assertions', $color, true);
$this->writeCountString($result->errorCount(), 'Errors', $color);
$this->writeCountString($result->failureCount(), 'Failures', $color);
$this->writeCountString($result->warningCount(), 'Warnings', $color);
$this->writeCountString($result->skippedCount(), 'Skipped', $color);
$this->writeCountString($result->notImplementedCount(), 'Incomplete', $color);
$this->writeCountString($result->riskyCount(), 'Risky', $color);
$this->writeWithColor($color, '.');
}
protected function writeProgress(string $progress): void
{
if ($this->debug) {
return;
}
$this->write($progress);
$this->column++;
$this->numTestsRun++;
if ($this->column == $this->maxColumn || $this->numTestsRun == $this->numTests) {
if ($this->numTestsRun == $this->numTests) {
$this->write(str_repeat(' ', $this->maxColumn - $this->column));
}
$this->write(
sprintf(
' %' . $this->numTestsWidth . 'd / %' .
$this->numTestsWidth . 'd (%3s%%)',
$this->numTestsRun,
$this->numTests,
floor(($this->numTestsRun / $this->numTests) * 100)
)
);
if ($this->column == $this->maxColumn) {
$this->writeNewLine();
}
}
}
protected function writeNewLine(): void
{
$this->column = 0;
$this->write("\n");
}
/**
* Formats a buffer with a specified ANSI color sequence if colors are
* enabled.
*/
protected function colorizeTextBox(string $color, string $buffer): string
{
if (!$this->colors) {
return $buffer;
}
$lines = preg_split('/\r\n|\r|\n/', $buffer);
$padding = max(array_map('\strlen', $lines));
$styledLines = [];
foreach ($lines as $line) {
$styledLines[] = Color::colorize($color, str_pad($line, $padding));
}
return implode(PHP_EOL, $styledLines);
}
/**
* Writes a buffer out with a color sequence if colors are enabled.
*/
protected function writeWithColor(string $color, string $buffer, bool $lf = true): void
{
$this->write($this->colorizeTextBox($color, $buffer));
if ($lf) {
$this->write(PHP_EOL);
}
}
/**
* Writes progress with a color sequence if colors are enabled.
*/
protected function writeProgressWithColor(string $color, string $buffer): void
{
$buffer = $this->colorizeTextBox($color, $buffer);
$this->writeProgress($buffer);
}
private function writeCountString(int $count, string $name, string $color, bool $always = false): void
{
static $first = true;
if ($always || $count > 0) {
$this->writeWithColor(
$color,
sprintf(
'%s%s: %d',
!$first ? ', ' : '',
$name,
$count
),
false
);
$first = false;
}
}
}
PK [
src/TextUI/TestSuiteMapper.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use const PHP_VERSION;
use function explode;
use function in_array;
use function is_dir;
use function is_file;
use function strpos;
use function version_compare;
use PHPUnit\Framework\Exception as FrameworkException;
use PHPUnit\Framework\TestSuite as TestSuiteObject;
use PHPUnit\TextUI\XmlConfiguration\TestSuiteCollection;
use SebastianBergmann\FileIterator\Facade;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TestSuiteMapper
{
/**
* @throws RuntimeException
* @throws TestDirectoryNotFoundException
* @throws TestFileNotFoundException
*/
public function map(TestSuiteCollection $configuration, string $filter): TestSuiteObject
{
try {
$filterAsArray = $filter ? explode(',', $filter) : [];
$result = new TestSuiteObject;
foreach ($configuration as $testSuiteConfiguration) {
if (!empty($filterAsArray) && !in_array($testSuiteConfiguration->name(), $filterAsArray, true)) {
continue;
}
$testSuite = new TestSuiteObject($testSuiteConfiguration->name());
$testSuiteEmpty = true;
$exclude = [];
foreach ($testSuiteConfiguration->exclude()->asArray() as $file) {
$exclude[] = $file->path();
}
foreach ($testSuiteConfiguration->directories() as $directory) {
if (!version_compare(PHP_VERSION, $directory->phpVersion(), $directory->phpVersionOperator()->asString())) {
continue;
}
$files = (new Facade)->getFilesAsArray(
$directory->path(),
$directory->suffix(),
$directory->prefix(),
$exclude
);
if (!empty($files)) {
$testSuite->addTestFiles($files);
$testSuiteEmpty = false;
} elseif (strpos($directory->path(), '*') === false && !is_dir($directory->path())) {
throw new TestDirectoryNotFoundException($directory->path());
}
}
foreach ($testSuiteConfiguration->files() as $file) {
if (!is_file($file->path())) {
throw new TestFileNotFoundException($file->path());
}
if (!version_compare(PHP_VERSION, $file->phpVersion(), $file->phpVersionOperator()->asString())) {
continue;
}
$testSuite->addTestFile($file->path());
$testSuiteEmpty = false;
}
if (!$testSuiteEmpty) {
$result->addTest($testSuite);
}
}
return $result;
} catch (FrameworkException $e) {
throw new RuntimeException(
$e->getMessage(),
$e->getCode(),
$e
);
}
}
}
PK [d~
2 src/TextUI/Exception/TestFileNotFoundException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use function sprintf;
use RuntimeException;
/**
* @internal This interface is not covered by the backward compatibility promise for PHPUnit
*/
final class TestFileNotFoundException extends RuntimeException implements Exception
{
public function __construct(string $path)
{
parent::__construct(
sprintf(
'Test file "%s" not found',
$path
)
);
}
}
PK [Y0 ) src/TextUI/Exception/RuntimeException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
/**
* @internal This interface is not covered by the backward compatibility promise for PHPUnit
*/
final class RuntimeException extends \RuntimeException implements Exception
{
}
PK [iH " src/TextUI/Exception/Exception.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use Throwable;
/**
* @internal This interface is not covered by the backward compatibility promise for PHPUnit
*/
interface Exception extends Throwable
{
}
PK [ H 7 src/TextUI/Exception/TestDirectoryNotFoundException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use function sprintf;
use RuntimeException;
/**
* @internal This interface is not covered by the backward compatibility promise for PHPUnit
*/
final class TestDirectoryNotFoundException extends RuntimeException implements Exception
{
public function __construct(string $path)
{
parent::__construct(
sprintf(
'Test directory "%s" not found',
$path
)
);
}
}
PK []T , src/TextUI/Exception/ReflectionException.phpnu W+A
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use RuntimeException;
/**
* @internal This interface is not covered by the backward compatibility promise for PHPUnit
*/
final class ReflectionException extends RuntimeException implements Exception
{
}
PK [|l B B schema/9.2.xsdnu W+A
This Schema file defines the rules by which the XML configuration file of PHPUnit 9.2 may be structured.
Root Element
The main type specifying the document structure
PK [贅B B schema/8.5.xsdnu W+A
This Schema file defines the rules by which the XML configuration file of PHPUnit 8.5 may be structured.
Root Element
The main type specifying the document structure
PK [=߸6 6 ChangeLog-8.5.mdnu W+A # Changes in PHPUnit 8.5
All notable changes of the PHPUnit 8.5 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
## [8.5.33] - 2023-02-27
### Fixed
* [#5186](https://github.com/sebastianbergmann/phpunit/issues/5186): SBOM does not validate
## [8.5.32] - 2023-01-26
### Fixed
* [#5120](https://github.com/sebastianbergmann/phpunit/issues/5120): Test Runner incorrectly treats `--testsuite` and `--list-tests` as not combinable options
## [8.5.31] - 2022-10-28
### Fixed
* [#5076](https://github.com/sebastianbergmann/phpunit/issues/5076): Test Runner does not warn about conflicting options
## [8.5.30] - 2022-09-25
### Changed
* The configuration generator now asks for a cache directory
### Fixed
* [#4913](https://github.com/sebastianbergmann/phpunit/issues/4913): Failed `assert()` should show a backtrace
* [#4966](https://github.com/sebastianbergmann/phpunit/issues/4966): `TestCase::assertSame()` (and related exact comparisons) must compare `float` exactly
## [8.5.29] - 2022-08-22
### Changed
* [#5033](https://github.com/sebastianbergmann/phpunit/issues/5033): Do not depend on phpspec/prophecy
## [8.5.28] - 2022-07-29
### Fixed
* [#5015](https://github.com/sebastianbergmann/phpunit/pull/5015): Ukraine banner unreadable on black background
* [#5016](https://github.com/sebastianbergmann/phpunit/issues/5016): PHPUnit 8.5.27 does not work on PHP 7.2.0-7.2.18 and PHP 7.3.0-7.3.5
## [8.5.27] - 2022-06-19
### Fixed
* [#4950](https://github.com/sebastianbergmann/phpunit/issues/4950): False error on `atMost()` invocation rule without call
* [#4962](https://github.com/sebastianbergmann/phpunit/issues/4962): Ukraine banner unreadable on white background
## [8.5.26] - 2022-04-01
### Fixed
* [#4938](https://github.com/sebastianbergmann/phpunit/issues/4938): Test Double code generator does not handle `void` return type declaration on `__clone()` methods
## [8.5.25] - 2022-03-16
### Fixed
* [#4934](https://github.com/sebastianbergmann/phpunit/issues/4934): Code Coverage does not work with PHPUnit 8.5.24 PHAR on PHP 7
## [8.5.24] - 2022-03-05 - #StandWithUkraine
### Changed
* [#4874](https://github.com/sebastianbergmann/phpunit/pull/4874): `PHP_FLOAT_EPSILON` is now used instead of hardcoded `0.0000000001` in `PHPUnit\Framework\Constraint\IsIdentical`
### Fixed
* When the HTML code coverage report's configured low upper bound is larger than the high lower bound then the default values are used instead
## [8.5.23] - 2022-01-21
### Fixed
* [#4799](https://github.com/sebastianbergmann/phpunit/pull/4799): Memory leaks in `PHPUnit\Framework\TestSuite` class
* [#4857](https://github.com/sebastianbergmann/phpunit/pull/4857): Result of `debug_backtrace()` is not used correctly
## [8.5.22] - 2021-12-25
### Changed
* [#4812](https://github.com/sebastianbergmann/phpunit/issues/4812): Do not enforce time limits when a debugging session through DBGp is active
* [#4835](https://github.com/sebastianbergmann/phpunit/issues/4835): Support for `$GLOBALS['_composer_autoload_path']` introduced in Composer 2.2
### Fixed
* [#4840](https://github.com/sebastianbergmann/phpunit/pull/4840): TestDox prettifying for class names does not correctly handle diacritics
* [#4846](https://github.com/sebastianbergmann/phpunit/pull/4846): Composer proxy script is not ignored
## [8.5.21] - 2021-09-25
### Changed
* PHPUnit no longer converts PHP deprecations to exceptions by default (configure `convertDeprecationsToExceptions="true"` to enable this)
* The PHPUnit XML configuration file generator now configures `convertDeprecationsToExceptions="true"`
### Fixed
* [#4772](https://github.com/sebastianbergmann/phpunit/pull/4772): TestDox HTML report not displayed correctly when browser has custom colour settings
## [8.5.20] - 2021-08-31
### Fixed
* [#4751](https://github.com/sebastianbergmann/phpunit/issues/4751): Configuration validation fails when using brackets in glob pattern
## [8.5.19] - 2021-07-31
### Fixed
* [#4740](https://github.com/sebastianbergmann/phpunit/issues/4740): `phpunit.phar` does not work with PHP 8.1
## [8.5.18] - 2021-07-19
### Fixed
* [#4720](https://github.com/sebastianbergmann/phpunit/issues/4720): PHPUnit does not verify its own PHP extension requirements
## [8.5.17] - 2021-06-23
### Changed
* PHPUnit now errors out on startup when `PHP_VERSION` contains a value that is not compatible with `version_compare()`, for instance `X.Y.Z-(to be removed in future macOS)`
## [8.5.16] - 2021-06-05
### Changed
* The test result cache (the storage for which is implemented in `PHPUnit\Runner\DefaultTestResultCache`) no longer uses PHP's `serialize()` and `unserialize()` functions for persistence. It now uses a versioned JSON format instead that is independent of PHP implementation details (see [#3581](https://github.com/sebastianbergmann/phpunit/issues/3581) and [#4662](https://github.com/sebastianbergmann/phpunit/pull/4662) for examples why this is a problem). When PHPUnit tries to load the test result cache from a file that does not exist, or from a file that does not contain data in JSON format, or from a file that contains data in a JSON format version other than the one used by the currently running PHPUnit version, then this is considered to be a "cache miss". An empty `DefaultTestResultCache` object is created in this case. This should also prevent PHPUnit from crashing when trying to load a test result cache file created by a different version of PHPUnit (see [#4580](https://github.com/sebastianbergmann/phpunit/issues/4580) for example).
### Fixed
* [#4663](https://github.com/sebastianbergmann/phpunit/issues/4663): `TestCase::expectError()` works on PHP 7.3, but not on PHP >= 7.4
* [#4678](https://github.com/sebastianbergmann/phpunit/pull/4678): Stubbed methods with `iterable` return types should return empty array by default
* [#4692](https://github.com/sebastianbergmann/phpunit/issues/4692): Annotations in single-line doc-comments are not handled correctly
* [#4694](https://github.com/sebastianbergmann/phpunit/issues/4694): `TestCase::getMockFromWsdl()` does not work with PHP 8.1-dev
## [8.5.15] - 2021-03-17
### Fixed
* [#4591](https://github.com/sebastianbergmann/phpunit/issues/4591): TeamCity logger logs warnings as test failures
## [8.5.14] - 2021-01-17
### Fixed
* [#4535](https://github.com/sebastianbergmann/phpunit/issues/4535): `getMockFromWsdl()` does not handle methods that do not have parameters correctly
* [#4572](https://github.com/sebastianbergmann/phpunit/issues/4572): Schema validation does not work with `%xx` sequences in path to `phpunit.xsd`
* [#4575](https://github.com/sebastianbergmann/phpunit/issues/4575): PHPUnit 8.5 incompatibility with PHP 8.1
## [8.5.13] - 2020-12-01
### Fixed
* Running tests in isolated processes did not work with PHP 8 on Windows
## [8.5.12] - 2020-11-30
### Changed
* Changed PHP version constraint in `composer.json` from `^7.2` to `>=7.2` to allow the installation of PHPUnit 8.5 on PHP 8. Please note that the code coverage functionality is not available for PHPUnit 8.5 on PHP 8.
### Fixed
* [#4529](https://github.com/sebastianbergmann/phpunit/issues/4529): Debug mode of Xdebug 2 is not disabled for PHPT tests
## [8.5.11] - 2020-11-27
### Changed
* Bumped required version of `phpunit/php-code-coverage`
## [8.5.10] - 2020-11-27
### Added
* Support for Xdebug 3
### Fixed
* [#4516](https://github.com/sebastianbergmann/phpunit/issues/4516): `phpunit/phpunit-selenium` does not work with PHPUnit 8.5.9
## [8.5.9] - 2020-11-10
### Fixed
* [#3965](https://github.com/sebastianbergmann/phpunit/issues/3965): Process Isolation throws exceptions when PHPDBG is used
* [#4470](https://github.com/sebastianbergmann/phpunit/pull/4470): Infinite recursion when `--static-backup --strict-global-state` is used
## [8.5.8] - 2020-06-22
### Fixed
* [#4312](https://github.com/sebastianbergmann/phpunit/issues/4312): Fix for [#4299](https://github.com/sebastianbergmann/phpunit/issues/4299) breaks backward compatibility
## [8.5.7] - 2020-06-21
### Fixed
* [#4299](https://github.com/sebastianbergmann/phpunit/issues/4299): "No tests executed" does not always result in exit code `1`
* [#4306](https://github.com/sebastianbergmann/phpunit/issues/4306): Exceptions during code coverage driver initialization are not handled correctly
## [8.5.6] - 2020-06-15
### Fixed
* [#4211](https://github.com/sebastianbergmann/phpunit/issues/4211): `phpdbg_*()` functions are scoped to `PHPUnit\phpdbg_*()`
## [8.5.5] - 2020-05-22
### Fixed
* [#4033](https://github.com/sebastianbergmann/phpunit/issues/4033): Unexpected behaviour when `$GLOBALS` is deleted
## [8.5.4] - 2020-04-23
### Changed
* Changed how `PHPUnit\TextUI\Command` passes warnings to `PHPUnit\TextUI\TestRunner`
## [8.5.3] - 2020-03-31
### Fixed
* [#4017](https://github.com/sebastianbergmann/phpunit/issues/4017): Do not suggest refactoring to something that is also deprecated
* [#4133](https://github.com/sebastianbergmann/phpunit/issues/4133): `expectExceptionMessageRegExp()` has been removed in PHPUnit 9 without a deprecation warning being given in PHPUnit 8
* [#4139](https://github.com/sebastianbergmann/phpunit/issues/4139): Cannot double interfaces that declare a constructor with PHP 8
* [#4144](https://github.com/sebastianbergmann/phpunit/issues/4144): Empty objects are converted to empty arrays in JSON comparison failure diff
## [8.5.2] - 2020-01-08
### Removed
* `eval-stdin.php` has been removed, it was not used anymore since PHPUnit 7.2.7
## [8.5.1] - 2019-12-25
### Changed
* `eval-stdin.php` can now only be executed with `cli` and `phpdbg`
### Fixed
* [#3983](https://github.com/sebastianbergmann/phpunit/issues/3983): Deprecation warning given too eagerly
## [8.5.0] - 2019-12-06
### Added
* [#3911](https://github.com/sebastianbergmann/phpunit/issues/3911): Support combined use of `addMethods()` and `onlyMethods()`
* [#3949](https://github.com/sebastianbergmann/phpunit/issues/3949): Introduce specialized assertions `assertFileEqualsCanonicalizing()`, `assertFileEqualsIgnoringCase()`, `assertStringEqualsFileCanonicalizing()`, `assertStringEqualsFileIgnoringCase()`, `assertFileNotEqualsCanonicalizing()`, `assertFileNotEqualsIgnoringCase()`, `assertStringNotEqualsFileCanonicalizing()`, and `assertStringNotEqualsFileIgnoringCase()` as alternative to using `assertFileEquals()` etc. with optional parameters
### Changed
* [#3860](https://github.com/sebastianbergmann/phpunit/pull/3860): Deprecate invoking PHPUnit commandline test runner with just a class name
* [#3950](https://github.com/sebastianbergmann/phpunit/issues/3950): Deprecate optional parameters of `assertFileEquals()` etc.
* [#3955](https://github.com/sebastianbergmann/phpunit/issues/3955): Deprecate support for doubling multiple interfaces
### Fixed
* [#3953](https://github.com/sebastianbergmann/phpunit/issues/3953): Code Coverage for test executed in isolation does not work when the PHAR is used
* [#3967](https://github.com/sebastianbergmann/phpunit/issues/3967): Cannot double interface that extends interface that extends `\Throwable`
* [#3968](https://github.com/sebastianbergmann/phpunit/pull/3968): Test class run in a separate PHP process are passing when `exit` called inside
[8.5.33]: https://github.com/sebastianbergmann/phpunit/compare/8.5.32...8.5.33
[8.5.32]: https://github.com/sebastianbergmann/phpunit/compare/8.5.31...8.5.32
[8.5.31]: https://github.com/sebastianbergmann/phpunit/compare/8.5.30...8.5.31
[8.5.30]: https://github.com/sebastianbergmann/phpunit/compare/8.5.29...8.5.30
[8.5.29]: https://github.com/sebastianbergmann/phpunit/compare/8.5.28...8.5.29
[8.5.28]: https://github.com/sebastianbergmann/phpunit/compare/8.5.27...8.5.28
[8.5.27]: https://github.com/sebastianbergmann/phpunit/compare/8.5.26...8.5.27
[8.5.26]: https://github.com/sebastianbergmann/phpunit/compare/8.5.25...8.5.26
[8.5.25]: https://github.com/sebastianbergmann/phpunit/compare/8.5.24...8.5.25
[8.5.24]: https://github.com/sebastianbergmann/phpunit/compare/8.5.23...8.5.24
[8.5.23]: https://github.com/sebastianbergmann/phpunit/compare/8.5.22...8.5.23
[8.5.22]: https://github.com/sebastianbergmann/phpunit/compare/8.5.21...8.5.22
[8.5.21]: https://github.com/sebastianbergmann/phpunit/compare/8.5.20...8.5.21
[8.5.20]: https://github.com/sebastianbergmann/phpunit/compare/8.5.19...8.5.20
[8.5.19]: https://github.com/sebastianbergmann/phpunit/compare/8.5.18...8.5.19
[8.5.18]: https://github.com/sebastianbergmann/phpunit/compare/8.5.17...8.5.18
[8.5.17]: https://github.com/sebastianbergmann/phpunit/compare/8.5.16...8.5.17
[8.5.16]: https://github.com/sebastianbergmann/phpunit/compare/8.5.15...8.5.16
[8.5.15]: https://github.com/sebastianbergmann/phpunit/compare/8.5.14...8.5.15
[8.5.14]: https://github.com/sebastianbergmann/phpunit/compare/8.5.13...8.5.14
[8.5.13]: https://github.com/sebastianbergmann/phpunit/compare/8.5.12...8.5.13
[8.5.12]: https://github.com/sebastianbergmann/phpunit/compare/8.5.11...8.5.12
[8.5.11]: https://github.com/sebastianbergmann/phpunit/compare/8.5.10...8.5.11
[8.5.10]: https://github.com/sebastianbergmann/phpunit/compare/8.5.9...8.5.10
[8.5.9]: https://github.com/sebastianbergmann/phpunit/compare/8.5.8...8.5.9
[8.5.8]: https://github.com/sebastianbergmann/phpunit/compare/8.5.7...8.5.8
[8.5.7]: https://github.com/sebastianbergmann/phpunit/compare/8.5.6...8.5.7
[8.5.6]: https://github.com/sebastianbergmann/phpunit/compare/8.5.5...8.5.6
[8.5.5]: https://github.com/sebastianbergmann/phpunit/compare/8.5.4...8.5.5
[8.5.4]: https://github.com/sebastianbergmann/phpunit/compare/8.5.3...8.5.4
[8.5.3]: https://github.com/sebastianbergmann/phpunit/compare/8.5.2...8.5.3
[8.5.2]: https://github.com/sebastianbergmann/phpunit/compare/8.5.1...8.5.2
[8.5.1]: https://github.com/sebastianbergmann/phpunit/compare/8.5.0...8.5.1
[8.5.0]: https://github.com/sebastianbergmann/phpunit/compare/8.4.3...8.5.0
PK [X
composer.jsonnu W+A {
"name": "phpunit/phpunit",
"description": "The PHP Unit Testing framework.",
"type": "library",
"keywords": [
"phpunit",
"xunit",
"testing"
],
"homepage": "https://phpunit.de/",
"license": "BSD-3-Clause",
"authors": [
{
"name": "Sebastian Bergmann",
"email": "sebastian@phpunit.de",
"role": "lead"
}
],
"support": {
"issues": "https://github.com/sebastianbergmann/phpunit/issues",
"security": "https://github.com/sebastianbergmann/phpunit/security/policy"
},
"prefer-stable": true,
"require": {
"php": ">=7.3",
"ext-dom": "*",
"ext-json": "*",
"ext-libxml": "*",
"ext-mbstring": "*",
"ext-xml": "*",
"ext-xmlwriter": "*",
"doctrine/instantiator": "^1.3.1 || ^2",
"myclabs/deep-copy": "^1.10.1",
"phar-io/manifest": "^2.0.3",
"phar-io/version": "^3.0.2",
"phpunit/php-code-coverage": "^9.2.13",
"phpunit/php-file-iterator": "^3.0.5",
"phpunit/php-invoker": "^3.1.1",
"phpunit/php-text-template": "^2.0.3",
"phpunit/php-timer": "^5.0.2",
"sebastian/cli-parser": "^1.0.1",
"sebastian/code-unit": "^1.0.6",
"sebastian/comparator": "^4.0.8",
"sebastian/diff": "^4.0.3",
"sebastian/environment": "^5.1.3",
"sebastian/exporter": "^4.0.5",
"sebastian/global-state": "^5.0.1",
"sebastian/object-enumerator": "^4.0.3",
"sebastian/resource-operations": "^3.0.3",
"sebastian/type": "^3.2",
"sebastian/version": "^3.0.2"
},
"config": {
"platform": {
"php": "7.3.0"
},
"optimize-autoloader": true,
"sort-packages": true
},
"suggest": {
"ext-soap": "To be able to generate mocks based on WSDL files",
"ext-xdebug": "PHP extension that provides line coverage as well as branch and path coverage"
},
"bin": [
"phpunit"
],
"autoload": {
"classmap": [
"src/"
],
"files": [
"src/Framework/Assert/Functions.php"
]
},
"autoload-dev": {
"classmap": [
"tests/"
],
"files": [
"tests/_files/CoverageNamespacedFunctionTest.php",
"tests/_files/CoveredFunction.php",
"tests/_files/NamespaceCoveredFunction.php"
]
},
"extra": {
"branch-alias": {
"dev-master": "9.6-dev"
}
}
}
PK [Lw SECURITY.mdnu W+A # Security Policy
If you believe you have found a security vulnerability in PHPUnit, please report it to us through coordinated disclosure.
**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
Instead, please email `sebastian@phpunit.de`.
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
* The type of issue
* Full paths of source file(s) related to the manifestation of the issue
* The location of the affected source code (tag/branch/commit or direct URL)
* Any special configuration required to reproduce the issue
* Step-by-step instructions to reproduce the issue
* Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly.
## Web Context
PHPUnit is a framework for writing as well as a command-line tool for running tests. Writing and running tests is a development-time activity. There is no reason why PHPUnit should be installed on a webserver and/or in a production environment.
**If you upload PHPUnit to a webserver then your deployment process is broken. On a more general note, if your `vendor` directory is publicly accessible on your webserver then your deployment process is also broken.**
Please note that if you upload PHPUnit to a webserver "bad things" may happen. [You have been warned.](https://thephp.cc/articles/phpunit-a-security-risk)
PHPUnit is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using PHPUnit in an HTTP or web context or with untrusted input data is performed. PHPUnit might also contain functionality that intentionally exposes internal application data for debugging purposes.
If PHPUnit is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context.
Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes.
PK [- ChangeLog-9.6.mdnu W+A # Changes in PHPUnit 9.6
All notable changes of the PHPUnit 9.6 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
## [9.6.6] - 2023-03-27
### Fixed
* [#5270](https://github.com/sebastianbergmann/phpunit/issues/5270): `GlobalState::getIniSettingsAsString()` generates code that triggers warnings
## [9.6.5] - 2023-03-09
### Changed
* Backported the HTML and CSS improvements made to the `--testdox-html` from PHPUnit 10
### Fixed
* [#5205](https://github.com/sebastianbergmann/phpunit/issues/5205): Wrong default value for optional parameter of `PHPUnit\Util\Test::parseTestMethodAnnotations()` causes `ReflectionException`
## [9.6.4] - 2023-02-27
### Fixed
* [#5186](https://github.com/sebastianbergmann/phpunit/issues/5186): SBOM does not validate
## [9.6.3] - 2023-02-04
### Fixed
* [#5164](https://github.com/sebastianbergmann/phpunit/issues/5164): `markTestSkipped()` not handled correctly when called in "before first test" method
## [9.6.2] - 2023-02-04
### Fixed
* [#4618](https://github.com/sebastianbergmann/phpunit/issues/4618): Support for generators in `assertCount()` etc. is not marked as deprecated in PHPUnit 9.6
## [9.6.1] - 2023-02-03
### Fixed
* [#5073](https://github.com/sebastianbergmann/phpunit/issues/5073): `--no-extensions` CLI option only prevents extension PHARs from being loaded
* [#5160](https://github.com/sebastianbergmann/phpunit/issues/5160): Deprecate `assertClassHasAttribute()`, `assertClassNotHasAttribute()`, `assertClassHasStaticAttribute()`, `assertClassNotHasStaticAttribute()`, `assertObjectHasAttribute()`, `assertObjectNotHasAttribute()`, `classHasAttribute()`, `classHasStaticAttribute()`, and `objectHasAttribute()`
## [9.6.0] - 2023-02-03
### Changed
* [#5062](https://github.com/sebastianbergmann/phpunit/issues/5062): Deprecate `expectDeprecation()`, `expectDeprecationMessage()`, `expectDeprecationMessageMatches()`, `expectError()`, `expectErrorMessage()`, `expectErrorMessageMatches()`, `expectNotice()`, `expectNoticeMessage()`, `expectNoticeMessageMatches()`, `expectWarning()`, `expectWarningMessage()`, and `expectWarningMessageMatches()`
* [#5063](https://github.com/sebastianbergmann/phpunit/issues/5063): Deprecate `withConsecutive()`
* [#5064](https://github.com/sebastianbergmann/phpunit/issues/5064): Deprecate `PHPUnit\Framework\TestCase::getMockClass()`
* [#5132](https://github.com/sebastianbergmann/phpunit/issues/5132): Deprecate `Test` suffix for abstract test case classes
[9.6.6]: https://github.com/sebastianbergmann/phpunit/compare/9.6.5...9.6.6
[9.6.5]: https://github.com/sebastianbergmann/phpunit/compare/9.6.4...9.6.5
[9.6.4]: https://github.com/sebastianbergmann/phpunit/compare/9.6.3...9.6.4
[9.6.3]: https://github.com/sebastianbergmann/phpunit/compare/9.6.2...9.6.3
[9.6.2]: https://github.com/sebastianbergmann/phpunit/compare/9.6.1...9.6.2
[9.6.1]: https://github.com/sebastianbergmann/phpunit/compare/9.6.0...9.6.1
[9.6.0]: https://github.com/sebastianbergmann/phpunit/compare/9.5.28...9.6.0
PK [4;= DF DF phpunit.xsdnu W+A
This Schema file defines the rules by which the XML configuration file of PHPUnit 9.6 may be structured.
Root Element
The main type specifying the document structure
PK [$ LICENSEnu W+A BSD 3-Clause License
Copyright (c) 2001-2023, Sebastian Bergmann
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
PK [ z README.mdnu W+A PK [O .phpstorm.meta.phpnu W+A PK [ˊʜ
phpunitnu W+A PK []r8
c src/Util/Printer.phpnu W+A PK [T D! src/Util/ErrorHandler.phpnu W+A PK [q f1 src/Util/Type.phpnu W+A PK [If f F5 src/Util/Json.phpnu W+A PK [tqHH @ src/Util/Color.phpnu W+A PK [̹}-_
_
Q src/Util/Filter.phpnu W+A PK [i & _ src/Util/VersionComparisonOperator.phpnu W+A PK [/k- - e src/Util/Filesystem.phpnu W+A PK [ (" " @j src/Util/GlobalState.phpnu W+A PK [Cԓ src/Util/Xml.phpnu W+A PK [ , src/Util/Xml/FailedSchemaDetectionResult.phpnu W+A PK [ui 0 src/Util/Xml/SuccessfulSchemaDetectionResult.phpnu W+A PK [G src/Util/Xml/SchemaFinder.phpnu W+A PK [WY src/Util/Xml/Validator.phpnu W+A PK [ͼQ src/Util/Xml/SchemaDetector.phpnu W+A PK [ϸ8 ! * src/Util/Xml/ValidationResult.phpnu W+A PK [ Ob4 4 src/Util/Xml/Loader.phpnu W+A PK [2)cΟ & src/Util/Xml/SchemaDetectionResult.phpnu W+A PK [. src/Util/Xml/Exception.phpnu W+A PK [{G G ! src/Util/Xml/SnapshotNodeList.phpnu W+A PK [ H src/Util/Blacklist.phpnu W+A PK [' > src/Util/ExcludeList.phpnu W+A PK [/O " src/Util/PHP/DefaultPhpProcess.phpnu W+A PK [cϑ " 1 src/Util/PHP/WindowsPhpProcess.phpnu W+A PK [w+ + #
src/Util/PHP/AbstractPhpProcess.phpnu W+A PK [w^ȯ
( 6 src/Util/PHP/Template/TestCaseMethod.tplnu W+A PK [+U `
`
' D src/Util/PHP/Template/TestCaseClass.tplnu W+A PK [h" & yR src/Util/PHP/Template/PhptTestCase.tplnu W+A PK [#4 W src/Util/RegularExpression.phpnu W+A PK [)s Z src/Util/FileLoader.phpnu W+A PK [ǵNd Nd d src/Util/Test.phpnu W+A PK [.2 t src/Util/Exception.phpnu W+A PK [eF F src/Util/Annotation/DocBlock.phpnu W+A PK [Tsh
h
src/Util/Annotation/Registry.phpnu W+A PK [ ͳ ! src/Util/TextTestListRenderer.phpnu W+A PK [3\!% % ( # src/Util/XdebugFilterScriptGenerator.phpnu W+A PK [/+ /+ # + src/Util/TestDox/TestDoxPrinter.phpnu W+A PK [s,I
I
& V src/Util/TestDox/HtmlResultPrinter.phpnu W+A PK [{.- .- & /d src/Util/TestDox/CliTestDoxPrinter.phpnu W+A PK [5bS S " src/Util/TestDox/ResultPrinter.phpnu W+A PK [_D># ># # X src/Util/TestDox/NamePrettifier.phpnu W+A PK [(/ % src/Util/TestDox/XmlResultPrinter.phpnu W+A PK [w & src/Util/TestDox/TextResultPrinter.phpnu W+A PK [ \Y src/Util/Cloner.phpnu W+A PK [,u~G) G) src/Util/Log/TeamCity.phpnu W+A PK [Fk- - x src/Util/Log/JUnit.phpnu W+A PK [4/
M src/Util/XmlTestListRenderer.phpnu W+A PK [X $ X src/Util/InvalidDataSetException.phpnu W+A PK [o [ src/Util/Reflection.phpnu W+A PK [(3E a src/Exception.phpnu W+A PK [*E % c src/Runner/DefaultTestResultCache.phpnu W+A PK [DT^ T^ s src/Runner/PhptTestCase.phpnu W+A PK [@ & src/Runner/StandardTestSuiteLoader.phpnu W+A PK [
src/Runner/TestSuiteLoader.phpnu W+A PK [rv v " src/Runner/NullTestResultCache.phpnu W+A PK [ h src/Runner/BaseTestRunner.phpnu W+A PK [#z)
# src/Runner/Extension/PharLoader.phpnu W+A PK [wuS ) & src/Runner/Extension/ExtensionHandler.phpnu W+A PK [NM J src/Runner/Version.phpnu W+A PK [L"X X 0 src/Runner/Filter/IncludeGroupFilterIterator.phpnu W+A PK [ ) A src/Runner/Filter/GroupFilterIterator.phpnu W+A PK [ՂDY Y 0 src/Runner/Filter/ExcludeGroupFilterIterator.phpnu W+A PK [ <" src/Runner/Filter/Factory.phpnu W+A PK [X1q q ( ( src/Runner/Filter/NameFilterIterator.phpnu W+A PK [WP
P
# `7 src/Runner/ResultCacheExtension.phpnu W+A PK [k E src/Runner/Exception.phpnu W+A PK [?[% ( ,G src/Runner/Hook/AfterTestWarningHook.phpnu W+A PK [ 5D & J src/Runner/Hook/AfterRiskyTestHook.phpnu W+A PK [7 ' M src/Runner/Hook/BeforeFirstTestHook.phpnu W+A PK [Ԥ#Ŕ 9Q src/Runner/Hook/Hook.phpnu W+A PK [ T src/Runner/Hook/TestHook.phpnu W+A PK [sl % W src/Runner/Hook/AfterLastTestHook.phpnu W+A PK [F( ( ' ;Z src/Runner/Hook/TestListenerAdapter.phpnu W+A PK [ޗ ( j src/Runner/Hook/AfterSkippedTestHook.phpnu W+A PK [ & &n src/Runner/Hook/AfterTestErrorHook.phpnu W+A PK [t{5- + q src/Runner/Hook/AfterIncompleteTestHook.phpnu W+A PK [ 9 + u src/Runner/Hook/AfterSuccessfulTestHook.phpnu W+A PK [K ! ex src/Runner/Hook/AfterTestHook.phpnu W+A PK [x " t| src/Runner/Hook/BeforeTestHook.phpnu W+A PK [y3 ( src/Runner/Hook/AfterTestFailureHook.phpnu W+A PK [Y) src/Runner/TestResultCache.phpnu W+A PK [mV]i- - < src/Runner/TestSuiteSorter.phpnu W+A PK [}# 0 f src/Framework/InvalidParameterGroupException.phpnu W+A PK [J9 " src/Framework/Assert/Functions.phpnu W+A PK [! # B src/Framework/TestSuiteIterator.phpnu W+A PK [zۈ J src/Framework/Reorderable.phpnu W+A PK [(]A A 3 L src/Framework/TestListenerDefaultImplementation.phpnu W+A PK [k n n " R src/Framework/ExceptionWrapper.phpnu W+A PK [ ? ? ?a src/Framework/TestCase.phpnu W+A PK [WyVg * y src/Framework/ExecutionOrderDependency.phpnu W+A PK [iEw w $ src/Framework/IncompleteTestCase.phpnu W+A PK [H src/Framework/TestResult.phpnu W+A PK [ޢq q ! @ src/Framework/SkippedTestCase.phpnu W+A PK [h _ _ " jF src/Framework/Error/Deprecated.phpnu W+A PK [2`nl l H src/Framework/Error/Error.phpnu W+A PK [*[ [ J src/Framework/Error/Notice.phpnu W+A PK [Z@\ \ }L src/Framework/Error/Warning.phpnu W+A PK [j:V V (N src/Framework/Test.phpnu W+A PK [F $ P src/Framework/MockObject/Api/Api.phpnu W+A PK [ ' \ src/Framework/MockObject/Api/Method.phpnu W+A PK [\ ! _ src/Framework/MockObject/Stub.phpnu W+A PK [9, , 1 c src/Framework/MockObject/MethodNameConstraint.phpnu W+A PK [^ j j & g src/Framework/MockObject/MockTrait.phpnu W+A PK [
src/Framework/MockObject/Stub/ReturnSelf.phpnu W+A PK [P< + B
src/Framework/MockObject/Stub/Exception.phpnu W+A PK [53 2 F
src/Framework/MockObject/Stub/ConsecutiveCalls.phpnu W+A PK [V 1 K
src/Framework/MockObject/Stub/ReturnReference.phpnu W+A PK [
, >P
src/Framework/MockObject/Stub/ReturnStub.phpnu W+A PK [`i / yT
src/Framework/MockObject/ConfigurableMethod.phpnu W+A PK [? ) ^Y
src/Framework/MockObject/Builder/Stub.phpnu W+A PK [v 6 z\
src/Framework/MockObject/Builder/InvocationStubber.phpnu W+A PK [}" - b
src/Framework/MockObject/Builder/Identity.phpnu W+A PK [4
-j 4 e
src/Framework/MockObject/Builder/ParametersMatch.phpnu W+A PK [}l2O O 4 m
src/Framework/MockObject/Builder/MethodNameMatch.phpnu W+A PK [;[`@ @ 5 p
src/Framework/MockObject/Builder/InvocationMocker.phpnu W+A PK [i = ]
src/Framework/MockObject/Exception/BadMethodCallException.phpnu W+A PK [f f K
src/Framework/MockObject/Exception/MethodNameAlreadyConfiguredException.phpnu W+A PK [9 D
src/Framework/MockObject/Exception/MatchBuilderNotFoundException.phpnu W+A PK [a-^ ^ G
src/Framework/MockObject/Exception/MethodNameNotConfiguredException.phpnu W+A PK [% j j C
src/Framework/MockObject/Exception/CannotUseAddMethodsException.phpnu W+A PK [< I
src/Framework/MockObject/Exception/SoapExtensionNotAvailableException.phpnu W+A PK [66 ;
src/Framework/MockObject/Exception/UnknownTypeException.phpnu W+A PK [ H
src/Framework/MockObject/Exception/MatcherAlreadyRegisteredException.phpnu W+A PK [/_Wz z D C
src/Framework/MockObject/Exception/CannotUseOnlyMethodsException.phpnu W+A PK [ A A H 1
src/Framework/MockObject/Exception/MethodCannotBeConfiguredException.phpnu W+A PK [;ߑ ?
src/Framework/MockObject/Exception/DuplicateMethodException.phpnu W+A PK ["bB 7 Z
src/Framework/MockObject/Exception/RuntimeException.phpnu W+A PK [N, 0
src/Framework/MockObject/Exception/Exception.phpnu W+A PK [2 M M H
src/Framework/MockObject/Exception/ReturnValueNotConfiguredException.phpnu W+A PK [#ݡ5 < ~
src/Framework/MockObject/Exception/UnknownClassException.phpnu W+A PK [ G
src/Framework/MockObject/Exception/IncompatibleReturnValueException.phpnu W+A PK [q+k < F
src/Framework/MockObject/Exception/ClassIsFinalException.phpnu W+A PK [S A
src/Framework/MockObject/Exception/InvalidMethodNameException.phpnu W+A PK [ ?
src/Framework/MockObject/Exception/ClassIsReadonlyException.phpnu W+A PK ["o o Q O
src/Framework/MockObject/Exception/MethodParametersAlreadyConfiguredException.phpnu W+A PK [9"t B ?
src/Framework/MockObject/Exception/ClassAlreadyExistsException.phpnu W+A PK [U :
src/Framework/MockObject/Exception/ReflectionException.phpnu W+A PK [}- U
src/Framework/MockObject/Exception/ConfigurableMethodsAlreadyInitializedException.phpnu W+A PK [G7 < f
src/Framework/MockObject/Exception/UnknownTraitException.phpnu W+A PK [; U
src/Framework/MockObject/Exception/OriginalConstructorInvocationRequiredException.phpnu W+A PK ['# # &
src/Framework/MockObject/MockClass.phpnu W+A PK [F 6
src/Framework/SelfDescribing.phpnu W+A PK [Cŋ '
src/Framework/DataProviderTestSuite.phpnu W+A PK [r
'
src/Framework/SkippedTest.phpnu W+A PK [
src/Framework/TestBuilder.phpnu W+A PK [Z[ src/Framework/TestFailure.phpnu W+A PK [$F G src/Framework/IncompleteTest.phpnu W+A PK [ A R! src/Framework/Exception/ComparisonMethodDoesNotExistException.phpnu W+A PK [ P J% src/Framework/Exception/ComparisonMethodDoesNotDeclareParameterTypeException.phpnu W+A PK []N 5 |) src/Framework/Exception/NoChildTestSuiteException.phpnu W+A PK [ӏ 1 + src/Framework/Exception/SyntheticSkippedError.phpnu W+A PK [^sa a ! - src/Framework/Exception/Error.phpnu W+A PK [i & & * |0 src/Framework/Exception/SyntheticError.phpnu W+A PK [>G 4 5 src/Framework/Exception/PHPTAssertionFailedError.phpnu W+A PK [> O 9 src/Framework/Exception/ComparisonMethodDoesNotAcceptParameterTypeException.phpnu W+A PK [<߆] 1 = src/Framework/Exception/CodeCoverageException.phpnu W+A PK [j = ? src/Framework/Exception/ActualValueIsNotAnObjectException.phpnu W+A PK [f 1 )C src/Framework/Exception/SkippedTestSuiteError.phpnu W+A PK [=@ , `E src/Framework/Exception/SkippedTestError.phpnu W+A PK [U 8 G src/Framework/Exception/InvalidCoversTargetException.phpnu W+A PK [:t ' I src/Framework/Exception/OutputError.phpnu W+A PK [it ; K src/Framework/Exception/UnintentionallyCoveredCodeError.phpnu W+A PK [9d * M src/Framework/Exception/RiskyTestError.phpnu W+A PK [ % P src/Framework/Exception/Exception.phpnu W+A PK [p ; Y src/Framework/Exception/CoveredCodeNotExecutedException.phpnu W+A PK [ 8N Q (\ src/Framework/Exception/ComparisonMethodDoesNotDeclareBoolReturnTypeException.phpnu W+A PK [
% 4 S` src/Framework/Exception/InvalidArgumentException.phpnu W+A PK [ Jc c # e src/Framework/Exception/Warning.phpnu W+A PK [ ݘ V h src/Framework/Exception/ComparisonMethodDoesNotDeclareExactlyOneParameterException.phpnu W+A PK [R 8 l src/Framework/Exception/InvalidDataProviderException.phpnu W+A PK [1 < n src/Framework/Exception/MissingCoversAnnotationException.phpnu W+A PK [)R / q src/Framework/Exception/IncompleteTestError.phpnu W+A PK [ZYj j 0 Ds src/Framework/Exception/AssertionFailedError.phpnu W+A PK [Kyó 6 v src/Framework/Exception/ExpectationFailedException.phpnu W+A PK [x/ '{ src/Framework/ErrorTestCase.phpnu W+A PK [)0 l src/Framework/TestListener.phpnu W+A PK [d
o
o F src/Framework/Assert.phpnu W+A PK ['b ! src/Framework/WarningTestCase.phpnu W+A PK [8>i >i src/Framework/TestSuite.phpnu W+A PK [X1 . sd
src/Framework/Constraint/Type/IsInstanceOf.phpnu W+A PK [a7TE E ( Wm
src/Framework/Constraint/Type/IsType.phpnu W+A PK [w5Lu u (
src/Framework/Constraint/Type/IsNull.phpnu W+A PK [uXU
U
0
src/Framework/Constraint/Operator/LogicalNot.phpnu W+A PK [J 3 v
src/Framework/Constraint/Operator/UnaryOperator.phpnu W+A PK [V9( ( 0
src/Framework/Constraint/Operator/LogicalXor.phpnu W+A PK [] /
src/Framework/Constraint/Operator/LogicalOr.phpnu W+A PK [tJ 0 T
src/Framework/Constraint/Operator/LogicalAnd.phpnu W+A PK [≬ .
src/Framework/Constraint/Operator/Operator.phpnu W+A PK [ 4
src/Framework/Constraint/Operator/BinaryOperator.phpnu W+A PK [? ? ? <
src/Framework/Constraint/JsonMatchesErrorMessageProvider.phpnu W+A PK [J ( K
src/Framework/Constraint/JsonMatches.phpnu W+A PK [/g" g" '
src/Framework/Constraint/Constraint.phpnu W+A PK [} - % K
src/Framework/Constraint/Callback.phpnu W+A PK [$1 . src/Framework/Constraint/Cardinality/Count.phpnu W+A PK [Qc 1 % src/Framework/Constraint/Cardinality/LessThan.phpnu W+A PK [dn? ? 1 D src/Framework/Constraint/Cardinality/SameSize.phpnu W+A PK [N 0 src/Framework/Constraint/Cardinality/IsEmpty.phpnu W+A PK [}Aq 4 ! src/Framework/Constraint/Cardinality/GreaterThan.phpnu W+A PK [R$/ / 5 F& src/Framework/Constraint/Object/ClassHasAttribute.phpnu W+A PK [B 6 / src/Framework/Constraint/Object/ObjectHasAttribute.phpnu W+A PK [X_k k ; 3 src/Framework/Constraint/Object/ClassHasStaticAttribute.phpnu W+A PK [C5ج 0 : src/Framework/Constraint/Object/ObjectEquals.phpnu W+A PK [Kx x , L src/Framework/Constraint/Boolean/IsFalse.phpnu W+A PK [*:fu u + |P src/Framework/Constraint/Boolean/IsTrue.phpnu W+A PK [" ( LT src/Framework/Constraint/IsIdentical.phpnu W+A PK [dAg g 2 >c src/Framework/Constraint/Filesystem/FileExists.phpnu W+A PK [
g g 2 i src/Framework/Constraint/Filesystem/IsWritable.phpnu W+A PK [Tg g 2 n src/Framework/Constraint/Filesystem/IsReadable.phpnu W+A PK [<+
l l 7 t src/Framework/Constraint/Filesystem/DirectoryExists.phpnu W+A PK [>d d ' lz src/Framework/Constraint/IsAnything.phpnu W+A PK [Ӧ 7 ' src/Framework/Constraint/Exception/ExceptionMessage.phpnu W+A PK [R)܋ 0 m src/Framework/Constraint/Exception/Exception.phpnu W+A PK [ ' 4 X src/Framework/Constraint/Exception/ExceptionCode.phpnu W+A PK [S̨ H src/Framework/Constraint/Exception/ExceptionMessageRegularExpression.phpnu W+A PK [y)@ B src/Framework/Constraint/String/StringMatchesFormatDescription.phpnu W+A PK [ 2 4 src/Framework/Constraint/String/StringContains.phpnu W+A PK [D * s src/Framework/Constraint/String/IsJson.phpnu W+A PK [ 5 r src/Framework/Constraint/String/RegularExpression.phpnu W+A PK [QTC 2 src/Framework/Constraint/String/StringEndsWith.phpnu W+A PK [ Xc% % 4 g src/Framework/Constraint/String/StringStartsWith.phpnu W+A PK [v~. . < src/Framework/Constraint/Traversable/TraversableContains.phpnu W+A PK [ 4 src/Framework/Constraint/Traversable/ArrayHasKey.phpnu W+A PK [1 E src/Framework/Constraint/Traversable/TraversableContainsIdentical.phpnu W+A PK [H7 @ src/Framework/Constraint/Traversable/TraversableContainsOnly.phpnu W+A PK [g% dA A A Z src/Framework/Constraint/Traversable/TraversableContainsEqual.phpnu W+A PK [cC
- src/Framework/Constraint/Equality/IsEqual.phpnu W+A PK [BȮ 9 b src/Framework/Constraint/Equality/IsEqualIgnoringCase.phpnu W+A PK [`@p ; M src/Framework/Constraint/Equality/IsEqualCanonicalizing.phpnu W+A PK [_Ɯ
6 < src/Framework/Constraint/Equality/IsEqualWithDelta.phpnu W+A PK [@lϔ * L src/Framework/Constraint/Math/IsFinite.phpnu W+A PK [k , :$ src/Framework/Constraint/Math/IsInfinite.phpnu W+A PK [ޜ ' 2( src/Framework/Constraint/Math/IsNan.phpnu W+A PK [ŝ' ' , src/TextUI/TestRunner.phpnu W+A PK [6o{n n src/TextUI/ResultPrinter.phpnu W+A PK [h><6u 6u ; src/TextUI/Command.phpnu W+A PK [&u u 7 x src/TextUI/XmlConfiguration/TestSuite/TestDirectory.phpnu W+A PK [drv v I src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollectionIterator.phpnu W+A PK [m0n9 9 D src/TextUI/XmlConfiguration/TestSuite/TestFileCollectionIterator.phpnu W+A PK [G)Py 2 / src/TextUI/XmlConfiguration/TestSuite/TestFile.phpnu W+A PK [ [ A u src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollection.phpnu W+A PK [Z ; ; < src/TextUI/XmlConfiguration/TestSuite/TestFileCollection.phpnu W+A PK [6\ \ E & src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollectionIterator.phpnu W+A PK [Tp p = src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollection.phpnu W+A PK [a a 3 ԧ src/TextUI/XmlConfiguration/TestSuite/TestSuite.phpnu W+A PK [+8x0 0 = src/TextUI/XmlConfiguration/Group/GroupCollectionIterator.phpnu W+A PK [&H + 5 src/TextUI/XmlConfiguration/Group/Group.phpnu W+A PK [A yX X , ! src/TextUI/XmlConfiguration/Group/Groups.phpnu W+A PK [:P1 5 պ src/TextUI/XmlConfiguration/Group/GroupCollection.phpnu W+A PK [0] 0 src/TextUI/XmlConfiguration/Logging/TeamCity.phpnu W+A PK [> - src/TextUI/XmlConfiguration/Logging/Junit.phpnu W+A PK [H , * src/TextUI/XmlConfiguration/Logging/Text.phpnu W+A PK [O
/ O src/TextUI/XmlConfiguration/Logging/Logging.phpnu W+A PK [?4 3 src/TextUI/XmlConfiguration/Logging/TestDox/Xml.phpnu W+A PK [ 4 src/TextUI/XmlConfiguration/Logging/TestDox/Text.phpnu W+A PK [%x: 4 src/TextUI/XmlConfiguration/Logging/TestDox/Html.phpnu W+A PK [Ǿ & Q src/TextUI/XmlConfiguration/Loader.phpnu W+A PK [4d . src/TextUI/XmlConfiguration/PHP/PhpHandler.phpnu W+A PK [Q Q > src/TextUI/XmlConfiguration/PHP/VariableCollectionIterator.phpnu W+A PK [.kK K . x src/TextUI/XmlConfiguration/PHP/IniSetting.phpnu W+A PK [`2 6 ! src/TextUI/XmlConfiguration/PHP/ConstantCollection.phpnu W+A PK [r 6 src/TextUI/XmlConfiguration/PHP/VariableCollection.phpnu W+A PK [_
+ + 8 src/TextUI/XmlConfiguration/PHP/IniSettingCollection.phpnu W+A PK [)oh
h
' src/TextUI/XmlConfiguration/PHP/Php.phpnu W+A PK [㢆 , Q src/TextUI/XmlConfiguration/PHP/Variable.phpnu W+A PK [Q Q > src/TextUI/XmlConfiguration/PHP/ConstantCollectionIterator.phpnu W+A PK [
G/9 9 , S src/TextUI/XmlConfiguration/PHP/Constant.phpnu W+A PK [i"g g @ src/TextUI/XmlConfiguration/PHP/IniSettingCollectionIterator.phpnu W+A PK [NzQ < src/TextUI/XmlConfiguration/Migration/MigrationException.phpnu W+A PK [1 C & src/TextUI/XmlConfiguration/Migration/MigrationBuilderException.phpnu W+A PK [μ M src/TextUI/XmlConfiguration/Migration/Migrations/IntroduceCoverageElement.phpnu W+A PK [ F src/TextUI/XmlConfiguration/Migration/Migrations/RemoveEmptyFilter.phpnu W+A PK [ ~$ $ H src/TextUI/XmlConfiguration/Migration/Migrations/CoveragePhpToReport.phpnu W+A PK ['(^k k T % src/TextUI/XmlConfiguration/Migration/Migrations/MoveWhitelistExcludesToCoverage.phpnu W+A PK [4 I src/TextUI/XmlConfiguration/Migration/Migrations/CoverageHtmlToReport.phpnu W+A PK [ڬw{ { K src/TextUI/XmlConfiguration/Migration/Migrations/CoverageCrap4jToReport.phpnu W+A PK [ M src/TextUI/XmlConfiguration/Migration/Migrations/UpdateSchemaLocationTo93.phpnu W+A PK [?" I src/TextUI/XmlConfiguration/Migration/Migrations/CoverageTextToReport.phpnu W+A PK [t鱕 ` src/TextUI/XmlConfiguration/Migration/Migrations/MoveAttributesFromFilterWhitelistToCoverage.phpnu W+A PK [
C7 7 U src/TextUI/XmlConfiguration/Migration/Migrations/MoveAttributesFromRootToCoverage.phpnu W+A PK [ + src/TextUI/XmlConfiguration/Migration/Migrations/Migration.phpnu W+A PK [ 49 9 : J. src/TextUI/XmlConfiguration/Migration/MigrationBuilder.phpnu W+A PK [.3& & 2 6 src/TextUI/XmlConfiguration/Migration/Migrator.phpnu W+A PK [h% - u= src/TextUI/XmlConfiguration/Configuration.phpnu W+A PK [E1 ) J src/TextUI/XmlConfiguration/Exception.phpnu W+A PK [o ) L src/TextUI/XmlConfiguration/Generator.phpnu W+A PK [j* 1 U src/TextUI/XmlConfiguration/PHPUnit/Extension.phpnu W+A PK [>H >H / [ src/TextUI/XmlConfiguration/PHPUnit/PHPUnit.phpnu W+A PK [ګ ; } src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollection.phpnu W+A PK [a[H\ \ C } src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollectionIterator.phpnu W+A PK [b^Ob b F L src/TextUI/XmlConfiguration/Filesystem/DirectoryCollectionIterator.phpnu W+A PK [` / $ src/TextUI/XmlConfiguration/Filesystem/File.phpnu W+A PK [} 4 src/TextUI/XmlConfiguration/Filesystem/Directory.phpnu W+A PK [ 9 src/TextUI/XmlConfiguration/Filesystem/FileCollection.phpnu W+A PK [H4y y > src/TextUI/XmlConfiguration/Filesystem/DirectoryCollection.phpnu W+A PK [ % % A w src/TextUI/XmlConfiguration/Filesystem/FileCollectionIterator.phpnu W+A PK [u :
src/TextUI/XmlConfiguration/CodeCoverage/Report/Crap4j.phpnu W+A PK [Tc = src/TextUI/XmlConfiguration/CodeCoverage/Report/Cobertura.phpnu W+A PK [;W 7 [ src/TextUI/XmlConfiguration/CodeCoverage/Report/Xml.phpnu W+A PK [D 8 src/TextUI/XmlConfiguration/CodeCoverage/Report/Text.phpnu W+A PK [?!u : src/TextUI/XmlConfiguration/CodeCoverage/Report/Clover.phpnu W+A PK [\V 7 src/TextUI/XmlConfiguration/CodeCoverage/Report/Php.phpnu W+A PK [ B 8 X src/TextUI/XmlConfiguration/CodeCoverage/Report/Html.phpnu W+A PK [L 9 n src/TextUI/XmlConfiguration/CodeCoverage/FilterMapper.phpnu W+A PK [!:y y 9 src/TextUI/XmlConfiguration/CodeCoverage/CodeCoverage.phpnu W+A PK [Pbv v O
src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollectionIterator.phpnu W+A PK [UT = src/TextUI/XmlConfiguration/CodeCoverage/Filter/Directory.phpnu W+A PK [fQ7 7 G src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollection.phpnu W+A PK [in ) src/TextUI/CliArguments/Configuration.phpnu W+A PK [?B % src/TextUI/CliArguments/Exception.phpnu W+A PK [3Q:- :- " src/TextUI/CliArguments/Mapper.phpnu W+A PK [#kf f # x src/TextUI/CliArguments/Builder.phpnu W+A PK [374 4 Yh src/TextUI/Help.phpnu W+A PK [!H< H< # > src/TextUI/DefaultResultPrinter.phpnu W+A PK [
src/TextUI/TestSuiteMapper.phpnu W+A PK [d~
2 src/TextUI/Exception/TestFileNotFoundException.phpnu W+A PK [Y0 ) src/TextUI/Exception/RuntimeException.phpnu W+A PK [iH " src/TextUI/Exception/Exception.phpnu W+A PK [ H 7 src/TextUI/Exception/TestDirectoryNotFoundException.phpnu W+A PK []T , < src/TextUI/Exception/ReflectionException.phpnu W+A PK [|l B B ~ schema/9.2.xsdnu W+A PK [贅B B 7 schema/8.5.xsdnu W+A PK [=߸6 6 hz ChangeLog-8.5.mdnu W+A PK [X
` composer.jsonnu W+A PK [Lw SECURITY.mdnu W+A PK [- ChangeLog-9.6.mdnu W+A PK [4;= DF DF phpunit.xsdnu W+A PK [$ LICENSEnu W+A PK vv