Compare commits

...

21 Commits

Author SHA1 Message Date
d060742eb6 Upgrade nunomaduro/collision to version 11.0.0 2026-04-12 16:09:59 +01:00
13c322bab3 ci: fixes incorrectCasing test 2026-04-10 20:51:40 +01:00
3855249ce9 feat: adds --flaky cli option 2026-04-10 20:03:50 +01:00
f528bd8427 feat: adds flaky 2026-04-10 19:52:31 +01:00
acd8aafa63 fix: printer with --colors 2026-04-10 19:21:49 +01:00
e8d630e774 fix: printer with --colors 2026-04-10 19:21:41 +01:00
b6385dc865 fix: namespaces on toBeCasedCorrectly 2026-04-10 19:21:31 +01:00
02dc8d7bcc chore: bumps deps 2026-04-10 19:21:18 +01:00
729f18a152 fix: stacktrace with nested with calls 2026-04-10 17:25:05 +01:00
bdf60cea91 Merge pull request #1565 from louisbels/fix-dataset-method-chaining
fix: dataset inheritance with method chaining (beforeEach()->with(), describe()->with())
2026-04-10 17:05:25 +01:00
3a8ee8291c Merge pull request #1628 from DevDavido/patch-1
fix: Parameter closure this type annotations in Functions
2026-04-10 16:58:39 +01:00
654cb726c9 Merge branch '4.x' into patch-1 2026-04-10 16:58:26 +01:00
bce26aeaad Merge pull request #1634 from dbpolito/dataset_named_params
Dataset Named Parameters
2026-04-10 16:54:57 +01:00
5948bcd71e chore: type improvements 2026-04-10 16:50:10 +01:00
8dddb47ad5 Merge branch '4.x' into fix-dataset-method-chaining 2026-04-10 11:41:13 +01:00
be3ff37517 Merge branch '4.x' of https://github.com/pestphp/pest into dataset_named_params 2026-03-26 18:08:26 -03:00
b081584ab6 Improvements 2026-02-11 18:09:09 -03:00
6966802afc Cleanup 2026-02-11 18:02:21 -03:00
c61dcad42b Dataset Named Parameters 2026-02-11 17:57:07 -03:00
ec3e0b2d33 fix: Parameter closure this type annotations in Functions.php 2026-02-09 20:48:56 +01:00
26345fd9f4 fix: dataset inheritance with method chaining (beforeEach()->with(), describe()->with())
Fixes issue where datasets were not applied when using method chaining patterns
like beforeEach()->with([...]) or describe()->with([...]) inside nested describe blocks.

Root cause: Multiple functions were using Backtrace::file() which returns the
immediate caller's filename. This breaks when called through method chaining
because the backtrace returns internal Pest files instead of the test file.

Solution: Use Backtrace::testFile() which walks the entire backtrace to find
the actual test file being executed. This matches the pattern already used by
test() and describe() functions.

Changes in src/Functions.php:
- beforeEach(): Use testFile() to fix beforeEach()->with() pattern
- afterEach(): Use testFile() for consistency with beforeEach()
- beforeAll(): Use testFile() for better error messages
- afterAll(): Use testFile() for better error messages
- pest(): Use testFile() to fix pest()->beforeEach() pattern
- uses(): Use testFile() for consistency with pest()
- covers(): Use testFile() for correct test file context
- mutates(): Use testFile() for correct test file context

Changes in src/PendingCalls/DescribeCall.php:
- __destruct(): Force BeforeEachCall destructor before test creation
- __call(): Use $this->filename instead of Backtrace, more efficient
- __call(): Properly merge describing context for nested describe blocks

Fixes patterns:
- beforeEach()->with([...])
- describe()->with([...])
- pest()->beforeEach()->with([...]

Tests passing:
- tests/Features/Describe.php (all dataset tests)
- tests/Hooks/BeforeEachTest.php (global hook execution)
- tests/Features/Expect/toMatchSnapshot.php (28 tests)
2025-11-05 17:46:52 +01:00
31 changed files with 1054 additions and 150 deletions

View File

@ -10,6 +10,7 @@ use Pest\TestCaseMethodFilters\AssigneeTestCaseFilter;
use Pest\TestCaseMethodFilters\IssueTestCaseFilter;
use Pest\TestCaseMethodFilters\NotesTestCaseFilter;
use Pest\TestCaseMethodFilters\PrTestCaseFilter;
use Pest\TestCaseMethodFilters\FlakyTestCaseFilter;
use Pest\TestCaseMethodFilters\TodoTestCaseFilter;
use Pest\TestSuite;
use Symfony\Component\Console\Input\ArgvInput;
@ -23,6 +24,7 @@ use Symfony\Component\Console\Output\ConsoleOutput;
$dirty = false;
$todo = false;
$flaky = false;
$notes = false;
foreach ($arguments as $key => $value) {
@ -57,6 +59,11 @@ use Symfony\Component\Console\Output\ConsoleOutput;
unset($arguments[$key]);
}
if ($value === '--flaky') {
$flaky = true;
unset($arguments[$key]);
}
if ($value === '--notes') {
$notes = true;
unset($arguments[$key]);
@ -150,6 +157,10 @@ use Symfony\Component\Console\Output\ConsoleOutput;
$testSuite->tests->addTestCaseMethodFilter(new TodoTestCaseFilter);
}
if ($flaky) {
$testSuite->tests->addTestCaseMethodFilter(new FlakyTestCaseFilter);
}
if ($notes) {
$testSuite->tests->addTestCaseMethodFilter(new NotesTestCaseFilter);
}

View File

@ -19,10 +19,10 @@
"require": {
"php": "^8.3.0",
"brianium/paratest": "^7.20.0",
"nunomaduro/collision": "^8.9.3",
"nunomaduro/collision": "^11.0.0",
"nunomaduro/termwind": "^2.4.0",
"pestphp/pest-plugin": "^4.0.0",
"pestphp/pest-plugin-arch": "^4.0.0",
"pestphp/pest-plugin-arch": "^4.0.2",
"pestphp/pest-plugin-mutate": "^4.0.1",
"pestphp/pest-plugin-profanity": "^4.2.1",
"phpunit/phpunit": "^12.5.16",
@ -50,11 +50,15 @@
"Tests\\Fixtures\\Arch\\": "tests/Fixtures/Arch",
"Tests\\": "tests/PHPUnit/"
},
"classmap": [
"tests/Fixtures/Arch/ToBeCasedCorrectly/IncorrectCasing/incorrectCasing.php"
],
"files": [
"tests/Autoload.php"
]
},
"require-dev": {
"mrpunyapal/peststan": "^0.2.5",
"pestphp/pest-dev-tools": "^4.1.0",
"pestphp/pest-plugin-browser": "^4.3.1",
"pestphp/pest-plugin-type-coverage": "^4.0.4",

View File

@ -1,11 +1,5 @@
parameters:
ignoreErrors:
-
message: '#^Parameter \#1 of callable callable\(Pest\\Expectation\<string\|null\>\)\: Pest\\Arch\\Contracts\\ArchExpectation expects Pest\\Expectation\<string\|null\>, Pest\\Expectation\<string\|null\> given\.$#'
identifier: argument.type
count: 1
path: src/ArchPresets/AbstractPreset.php
-
message: '#^Trait Pest\\Concerns\\Expectable is used zero times and is not analysed\.$#'
identifier: trait.unused
@ -24,12 +18,6 @@ parameters:
count: 1
path: src/Concerns/Testable.php
-
message: '#^Loose comparison using \!\= between \(Closure\|null\) and false will always evaluate to false\.$#'
identifier: notEqual.alwaysFalse
count: 1
path: src/Expectation.php
-
message: '#^Method Pest\\Expectation\:\:and\(\) should return Pest\\Expectation\<TAndValue\> but returns \(Pest\\Expectation&TAndValue\)\|Pest\\Expectation\<TAndValue of mixed\>\.$#'
identifier: return.type
@ -102,78 +90,12 @@ parameters:
count: 1
path: src/PendingCalls/TestCall.php
-
message: '#^Parameter \#1 \$argv of class Symfony\\Component\\Console\\Input\\ArgvInput constructor expects list\<string\>\|null, array\<int, string\> given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel.php
-
message: '#^Parameter \#13 \$testRunnerTriggeredDeprecationEvents of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\Event\\TestRunner\\DeprecationTriggered\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#14 \$testRunnerTriggeredWarningEvents of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\Event\\TestRunner\\WarningTriggered\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#15 \$errors of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\TestRunner\\TestResult\\Issues\\Issue\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#16 \$deprecations of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\TestRunner\\TestResult\\Issues\\Issue\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#17 \$notices of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\TestRunner\\TestResult\\Issues\\Issue\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#18 \$warnings of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\TestRunner\\TestResult\\Issues\\Issue\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#19 \$phpDeprecations of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\TestRunner\\TestResult\\Issues\\Issue\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#20 \$phpNotices of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\TestRunner\\TestResult\\Issues\\Issue\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#21 \$phpWarnings of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\TestRunner\\TestResult\\Issues\\Issue\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#4 \$testErroredEvents of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\Event\\Test\\AfterLastTestMethodErrored\|PHPUnit\\Event\\Test\\BeforeFirstTestMethodErrored\|PHPUnit\\Event\\Test\\Errored\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#5 \$testFailedEvents of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\Event\\Test\\Failed\>, array given\.$#'
identifier: argument.type
count: 1
path: src/Plugins/Parallel/Paratest/WrapperRunner.php
-
message: '#^Parameter \#7 \$testSuiteSkippedEvents of class PHPUnit\\TestRunner\\TestResult\\TestResult constructor expects list\<PHPUnit\\Event\\TestSuite\\Skipped\>, array given\.$#'
identifier: argument.type

View File

@ -0,0 +1,5 @@
services:
-
class: Pest\PHPStan\HigherOrderExpectationTypeExtension
tags:
- phpstan.broker.expressionTypeResolverExtension

View File

@ -1,5 +1,7 @@
includes:
- phpstan-baseline.neon
- phpstan-pest-extension.neon
- vendor/mrpunyapal/peststan/extension.neon
parameters:
level: 7
@ -7,6 +9,3 @@ parameters:
- src
reportUnmatchedIgnoredErrors: false
ignoreErrors:
- "#type mixed is not subtype of native#"

View File

@ -53,7 +53,7 @@ abstract class AbstractPreset // @pest-arch-ignore-line
/**
* Runs the given callback for each namespace.
*
* @param callable(Expectation<string|null>): ArchExpectation ...$callbacks
* @param callable(Expectation<string>): ArchExpectation ...$callbacks
*/
final public function eachUserNamespace(callable ...$callbacks): void
{

View File

@ -14,6 +14,8 @@ use Pest\Support\Reflection;
use Pest\Support\Shell;
use Pest\TestSuite;
use PHPUnit\Framework\Attributes\PostCondition;
use PHPUnit\Framework\IncompleteTest;
use PHPUnit\Framework\SkippedTest;
use PHPUnit\Framework\TestCase;
use ReflectionException;
use ReflectionFunction;
@ -328,7 +330,80 @@ trait Testable
$arguments = $this->__resolveTestArguments($args);
$this->__ensureDatasetArgumentNameAndNumberMatches($arguments);
return $this->__callClosure($closure, $arguments);
$method = TestSuite::getInstance()->tests->get(self::$__filename)->getMethod($this->name());
if ($method->flakyTries === null) {
return $this->__callClosure($closure, $arguments);
}
$lastException = null;
$initialProperties = get_object_vars($this);
for ($attempt = 1; $attempt <= $method->flakyTries; $attempt++) {
try {
return $this->__callClosure($closure, $arguments);
} catch (Throwable $e) {
if ($e instanceof SkippedTest
|| $e instanceof IncompleteTest
|| $this->__isExpectedException($e)) {
throw $e;
}
$lastException = $e;
if ($attempt < $method->flakyTries) {
if ($this->__snapshotChanges !== []) {
throw $e;
}
$this->tearDown();
Closure::bind(fn (): array => $this->mockObjects = [], $this, TestCase::class)();
foreach (array_keys(array_diff_key(get_object_vars($this), $initialProperties)) as $property) {
unset($this->{$property});
}
$hasOutputExpectation = Closure::bind(fn (): bool => is_string($this->outputExpectedString) || is_string($this->outputExpectedRegex), $this, TestCase::class)();
if ($hasOutputExpectation) {
ob_clean();
}
$this->setUp();
}
}
}
throw $lastException;
}
/**
* Determines if the given exception matches PHPUnit's expected exception.
*/
private function __isExpectedException(Throwable $e): bool
{
$read = fn (string $property): mixed => Closure::bind(fn () => $this->{$property}, $this, TestCase::class)();
$expectedClass = $read('expectedException');
if ($expectedClass !== null) {
return $e instanceof $expectedClass;
}
$expectedMessage = $read('expectedExceptionMessage');
if ($expectedMessage !== null) {
return str_contains($e->getMessage(), (string) $expectedMessage);
}
$expectedCode = $read('expectedExceptionCode');
if ($expectedCode !== null) {
return $e->getCode() === $expectedCode;
}
return false;
}
/**
@ -350,7 +425,8 @@ trait Testable
}
$underlyingTest = Reflection::getFunctionVariable($this->__test, 'closure');
$testParameterTypes = array_values(Reflection::getFunctionArguments($underlyingTest));
$testParameterTypesByName = Reflection::getFunctionArguments($underlyingTest);
$testParameterTypes = array_values($testParameterTypesByName);
if (count($arguments) !== 1) {
foreach ($arguments as $argumentIndex => $argumentValue) {
@ -358,7 +434,11 @@ trait Testable
continue;
}
if (in_array($testParameterTypes[$argumentIndex], [Closure::class, 'callable', 'mixed'])) {
$parameterType = is_string($argumentIndex)
? $testParameterTypesByName[$argumentIndex]
: $testParameterTypes[$argumentIndex];
if (in_array($parameterType, [Closure::class, 'callable', 'mixed'])) {
continue;
}
@ -384,7 +464,7 @@ trait Testable
return [$boundDatasetResult];
}
return array_values($boundDatasetResult);
return $boundDatasetResult;
}
/**

View File

@ -688,7 +688,7 @@ final class Expectation
return false;
}
foreach (Composer::userNamespacesWithDirectories() as $directory => $namespace) {
foreach (Composer::allNamespacesWithDirectories() as $directory => $namespace) {
if (str_starts_with($realPath, $directory)) {
$relativePath = substr($realPath, strlen($directory) + 1);
$relativePath = explode('.', $relativePath)[0];

View File

@ -50,6 +50,11 @@ final class TestCaseMethodFactory
*/
public int $repetitions = 1;
/**
* The test's number of flaky retry tries.
*/
public ?int $flakyTries = null;
/**
* Determines if the test is a "todo".
*/

View File

@ -4,7 +4,6 @@ declare(strict_types=1);
use Pest\Browser\Api\ArrayablePendingAwaitablePage;
use Pest\Browser\Api\PendingAwaitablePage;
use Pest\Concerns\Expectable;
use Pest\Configuration;
use Pest\Exceptions\AfterAllWithinDescribe;
use Pest\Exceptions\BeforeAllWithinDescribe;
@ -48,7 +47,7 @@ if (! function_exists('beforeAll')) {
function beforeAll(Closure $closure): void
{
if (DescribeCall::describing() !== []) {
$filename = Backtrace::file();
$filename = Backtrace::testFile();
throw new BeforeAllWithinDescribe($filename);
}
@ -61,13 +60,11 @@ if (! function_exists('beforeEach')) {
/**
* Runs the given closure before each test in the current file.
*
* @param-closure-this TestCase $closure
*
* @return HigherOrderTapProxy<Expectable|TestCall|TestCase>|Expectable|TestCall|TestCase|mixed
* @param-closure-this TestCall $closure
*/
function beforeEach(?Closure $closure = null): BeforeEachCall
{
$filename = Backtrace::file();
$filename = Backtrace::testFile();
return new BeforeEachCall(TestSuite::getInstance(), $filename, $closure);
}
@ -92,8 +89,6 @@ if (! function_exists('describe')) {
* Adds the given closure as a group of tests. The first argument
* is the group description; the second argument is a closure
* that contains the group tests.
*
* @return HigherOrderTapProxy<Expectable|TestCall|TestCase>|Expectable|TestCall|TestCase|mixed
*/
function describe(string $description, Closure $tests): DescribeCall
{
@ -112,7 +107,7 @@ if (! function_exists('uses')) {
*/
function uses(string ...$classAndTraits): UsesCall
{
$filename = Backtrace::file();
$filename = Backtrace::testFile();
return new UsesCall($filename, array_values($classAndTraits));
}
@ -124,7 +119,7 @@ if (! function_exists('pest')) {
*/
function pest(): Configuration
{
return new Configuration(Backtrace::file());
return new Configuration(Backtrace::testFile());
}
}
@ -134,9 +129,9 @@ if (! function_exists('test')) {
* is the test description; the second argument is
* a closure that contains the test expectations.
*
* @param-closure-this TestCase $closure
* @param-closure-this TestCall $closure
*
* @return Expectable|TestCall|TestCase|mixed
* @return ($description is string ? TestCall : HigherOrderTapProxy|TestCall)
*/
function test(?string $description = null, ?Closure $closure = null): HigherOrderTapProxy|TestCall
{
@ -156,34 +151,23 @@ if (! function_exists('it')) {
* is the test description; the second argument is
* a closure that contains the test expectations.
*
* @param-closure-this TestCase $closure
*
* @return Expectable|TestCall|TestCase|mixed
* @param-closure-this TestCall $closure
*/
function it(string $description, ?Closure $closure = null): TestCall
{
$description = sprintf('it %s', $description);
/** @var TestCall $test */
$test = test($description, $closure);
return $test;
return test($description, $closure);
}
}
if (! function_exists('todo')) {
/**
* Creates a new test that is marked as "todo".
*
* @return Expectable|TestCall|TestCase|mixed
*/
function todo(string $description): TestCall
{
$test = test($description);
assert($test instanceof TestCall);
return $test->todo();
return test($description)->todo();
}
}
@ -191,13 +175,11 @@ if (! function_exists('afterEach')) {
/**
* Runs the given closure after each test in the current file.
*
* @param-closure-this TestCase $closure
*
* @return Expectable|HigherOrderTapProxy<Expectable|TestCall|TestCase>|TestCall|mixed
* @param-closure-this TestCall $closure
*/
function afterEach(?Closure $closure = null): AfterEachCall
{
$filename = Backtrace::file();
$filename = Backtrace::testFile();
return new AfterEachCall(TestSuite::getInstance(), $filename, $closure);
}
@ -210,7 +192,7 @@ if (! function_exists('afterAll')) {
function afterAll(Closure $closure): void
{
if (DescribeCall::describing() !== []) {
$filename = Backtrace::file();
$filename = Backtrace::testFile();
throw new AfterAllWithinDescribe($filename);
}
@ -227,7 +209,7 @@ if (! function_exists('covers')) {
*/
function covers(array|string ...$classesOrFunctions): void
{
$filename = Backtrace::file();
$filename = Backtrace::testFile();
$beforeEachCall = (new BeforeEachCall(TestSuite::getInstance(), $filename));
@ -256,7 +238,7 @@ if (! function_exists('mutates')) {
*/
function mutates(array|string ...$targets): void
{
$filename = Backtrace::file();
$filename = Backtrace::testFile();
$beforeEachCall = (new BeforeEachCall(TestSuite::getInstance(), $filename));
$beforeEachCall->group('__pest_mutate_only');

View File

@ -0,0 +1,57 @@
<?php
declare(strict_types=1);
namespace Pest\PHPStan;
use Pest\Expectations\HigherOrderExpectation;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Identifier;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Type\ExpressionTypeResolverExtension;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
/**
* Prevents native declared properties of HigherOrderExpectation (like $original,
* $expectation, $opposite, $shouldReset) from being incorrectly resolved as
* higher-order value property accesses by downstream ExpressionTypeResolverExtensions.
*
* This extension must be registered BEFORE the peststan HigherOrderExpectationTypeExtension.
*
* @internal
*/
final readonly class HigherOrderExpectationTypeExtension implements ExpressionTypeResolverExtension
{
public function __construct(
private ReflectionProvider $reflectionProvider,
) {}
public function getType(Expr $expr, Scope $scope): ?Type
{
if (! $expr instanceof PropertyFetch || ! $expr->name instanceof Identifier) {
return null;
}
$varType = $scope->getType($expr->var);
if (! (new ObjectType(HigherOrderExpectation::class))->isSuperTypeOf($varType)->yes()) {
return null;
}
if (! $this->reflectionProvider->hasClass(HigherOrderExpectation::class)) {
return null;
}
$propertyName = $expr->name->name;
$classReflection = $this->reflectionProvider->getClass(HigherOrderExpectation::class);
if (! $classReflection->hasNativeProperty($propertyName)) {
return null;
}
return $varType->getProperty($propertyName, $scope)->getReadableType();
}
}

View File

@ -5,7 +5,6 @@ declare(strict_types=1);
namespace Pest\PendingCalls;
use Closure;
use Pest\Support\Backtrace;
use Pest\Support\Description;
use Pest\TestSuite;
@ -53,7 +52,11 @@ final class DescribeCall
*/
public function __destruct()
{
unset($this->currentBeforeEachCall);
// Ensure BeforeEachCall destructs before creating tests
// by moving to local scope and clearing the reference
$beforeEach = $this->currentBeforeEachCall;
$this->currentBeforeEachCall = null;
unset($beforeEach); // Trigger destructor immediately
self::$describing[] = $this->description;
@ -71,12 +74,13 @@ final class DescribeCall
*/
public function __call(string $name, array $arguments): self
{
$filename = Backtrace::file();
if (! $this->currentBeforeEachCall instanceof BeforeEachCall) {
$this->currentBeforeEachCall = new BeforeEachCall(TestSuite::getInstance(), $filename);
$this->currentBeforeEachCall = new BeforeEachCall(TestSuite::getInstance(), $this->filename);
$this->currentBeforeEachCall->describing[] = $this->description;
$this->currentBeforeEachCall->describing = array_merge(
DescribeCall::describing(),
[$this->description]
);
}
$this->currentBeforeEachCall->{$name}(...$arguments);

View File

@ -412,6 +412,20 @@ final class TestCall // @phpstan-ignore-line
return $this;
}
/**
* Marks the test as flaky, retrying it up to the given number of times.
*/
public function flaky(int $tries = 3): self
{
if ($tries < 1) {
throw new InvalidArgumentException('The number of tries must be greater than 0.');
}
$this->testCaseMethod->flakyTries = $tries;
return $this;
}
/**
* Marks the test as "todo".
*/

View File

@ -152,6 +152,9 @@ final readonly class Help implements HandlesArguments
], [
'arg' => '--dirty',
'desc' => 'Only run tests that have uncommitted changes according to Git',
], [
'arg' => '--flaky',
'desc' => 'Output to standard output tests marked as flaky',
], ...$content['Selection']];
$content['Reporting'] = [...$content['Reporting'], ...[

View File

@ -34,7 +34,7 @@ final class Parallel implements HandlesArguments
/**
* @var string[]
*/
private const array UNSUPPORTED_ARGUMENTS = ['--todo', '--todos', '--retry', '--notes', '--issue', '--pr', '--pull-request'];
private const array UNSUPPORTED_ARGUMENTS = ['--todo', '--todos', '--retry', '--notes', '--issue', '--pr', '--pull-request', '--flaky'];
/**
* Whether the given command line arguments indicate that the test suite should be run in parallel.

View File

@ -81,7 +81,9 @@ final class ResultPrinter
public function flush(): void {}
};
$this->compactPrinter = CompactPrinter::default();
$this->compactPrinter = CompactPrinter::default(
decorated: ! in_array('--colors=never', $_SERVER['argv'] ?? [], true),
);
if (! $this->options->configuration->hasLogfileTeamcity()) {
return;

View File

@ -62,12 +62,12 @@ final class CompactPrinter
/**
* Creates a new instance of the Compact Printer.
*/
public static function default(): self
public static function default(bool $decorated = true): self
{
return new self(
terminal(),
new ConsoleOutput(decorated: true),
new Style(new ConsoleOutput(decorated: true)),
new ConsoleOutput(decorated: $decorated),
new Style(new ConsoleOutput(decorated: $decorated)),
terminal()->width() - 4,
);
}

View File

@ -23,7 +23,9 @@ final class Backtrace
$current = null;
foreach (debug_backtrace(self::BACKTRACE_OPTIONS) as $trace) {
assert(array_key_exists(self::FILE, $trace));
if (array_key_exists(self::FILE, $trace) === false) {
break;
}
$traceFile = str_replace(DIRECTORY_SEPARATOR, '/', $trace[self::FILE]);

View File

@ -0,0 +1,19 @@
<?php
declare(strict_types=1);
namespace Pest\TestCaseMethodFilters;
use Pest\Contracts\TestCaseMethodFilter;
use Pest\Factories\TestCaseMethodFactory;
final readonly class FlakyTestCaseFilter implements TestCaseMethodFilter
{
/**
* Filter the test case methods.
*/
public function accept(TestCaseMethodFactory $factory): bool
{
return $factory->flakyTries !== null;
}
}

View File

@ -28,6 +28,7 @@
--pull-request Output to standard output tests with the given pull request number (alias for --pr)
--retry Run non-passing tests first and stop execution upon first error or failure
--dirty ...... Only run tests that have uncommitted changes according to Git
--flaky .................... Output to standard output tests marked as flaky
--all .................... Ignore test selection from XML configuration file
--list-suites ................................... List available test suites
--testsuite [name] ......... Only run tests from the specified test suite(s)
@ -130,6 +131,8 @@
CODE COVERAGE OPTIONS:
--coverage ..... Generate code coverage report and output to standard output
--coverage --min Set the minimum required coverage percentage, and fail if not met
--coverage --exactly Set the exact required coverage percentage, and fail if not met
--coverage --only-covered Hide files with 0% coverage from the code coverage report
--coverage-clover [file] Write code coverage report in Clover XML format to file
--coverage-openclover [file] Write code coverage report in OpenClover XML format to file
--coverage-cobertura [file] Write code coverage report in Cobertura XML format to file

View File

@ -15,6 +15,9 @@
↓ todo on describe → should not fail
↓ todo on describe → should run
TODO Tests\Features\Flaky - 1 todo
↓ it does not retry todo tests
TODO Tests\Features\Todo - 29 todos
↓ something todo later
↓ something todo later chained
@ -81,6 +84,6 @@
PASS Tests\CustomTestCase\ParentTest
✓ override method
Tests: 39 todos, 3 passed (21 assertions)
Tests: 40 todos, 3 passed (21 assertions)
Duration: x.xxs

View File

@ -15,6 +15,9 @@
↓ todo on describe → should not fail
↓ todo on describe → should run
TODO Tests\Features\Flaky - 1 todo
↓ it does not retry todo tests
TODO Tests\Features\Todo - 29 todos
↓ something todo later
↓ something todo later chained
@ -81,6 +84,6 @@
PASS Tests\CustomTestCase\ParentTest
✓ override method
Tests: 39 todos, 3 passed (21 assertions)
Tests: 40 todos, 3 passed (21 assertions)
Duration: x.xxs

View File

@ -15,6 +15,9 @@
↓ todo on describe → should not fail
↓ todo on describe → should run
TODO Tests\Features\Flaky - 1 todo
↓ it does not retry todo tests
TODO Tests\Features\Todo - 29 todos
↓ something todo later
↓ something todo later chained
@ -81,6 +84,6 @@
PASS Tests\CustomTestCase\ParentTest
✓ override method
Tests: 39 todos, 3 passed (21 assertions)
Tests: 40 todos, 3 passed (21 assertions)
Duration: x.xxs

View File

@ -15,6 +15,9 @@
↓ todo on describe → should not fail
↓ todo on describe → should run
TODO Tests\Features\Flaky - 1 todo
↓ it does not retry todo tests
TODO Tests\Features\Todo - 29 todos
↓ something todo later
↓ something todo later chained
@ -81,6 +84,6 @@
PASS Tests\CustomTestCase\ParentTest
✓ override method
Tests: 39 todos, 3 passed (21 assertions)
Tests: 40 todos, 3 passed (21 assertions)
Duration: x.xxs

View File

@ -95,6 +95,48 @@
PASS Tests\Features\Covers\TraitCoverage
✓ it uses the correct PHPUnit attribute for trait
PASS Tests\Features\DatasetMethodChaining
✓ beforeEach()->with() applies dataset to tests → receives the dataset value with (10)
✓ beforeEach()->with() applies dataset to tests → it also receives the dataset value in it() with (10)
✓ beforeEach()->with() with multiple dataset values → receives each value from the dataset with (1)
✓ beforeEach()->with() with multiple dataset values → receives each value from the dataset with (2)
✓ beforeEach()->with() with multiple dataset values → receives each value from the dataset with (3)
✓ beforeEach()->with() with keyed dataset → receives keyed dataset values with dataset "first"
✓ beforeEach()->with() with keyed dataset → receives keyed dataset values with dataset "second"
✓ beforeEach()->with() with closure dataset → receives values from closure dataset with (100)
✓ beforeEach()->with() with closure dataset → receives values from closure dataset with (200)
✓ describe()->with() passes dataset to tests → receives the dataset value with (42)
✓ describe()->with() passes dataset to tests → it also receives it in it() with (42)
✓ describe()->with() with multiple values → receives each value with (5)
✓ describe()->with() with multiple values → receives each value with (10)
✓ describe()->with() with multiple values → receives each value with (15)
✓ describe()->with() with keyed dataset → receives keyed values with dataset "alpha"
✓ describe()->with() with keyed dataset → receives keyed values with dataset "beta"
✓ describe()->with() with closure dataset → receives closure dataset values with (7)
✓ describe()->with() with closure dataset → receives closure dataset values with (14)
✓ outer with dataset → inner without dataset → inherits outer dataset with (1)
✓ nested describe blocks with datasets at multiple levels → level 1 → receives level 1 dataset with (10)
✓ nested describe blocks with datasets at multiple levels → level 1 → level 2 → receives datasets from all ancestor levels with (10) / (20)
✓ deeply nested describe with datasets → a → b → c → receives all ancestor datasets with (1) / (2) / (3)
✓ beforeEach()->with() combined with test->with() → receives both datasets as cross product with (10) / (1)
✓ beforeEach()->with() combined with test->with() → receives both datasets as cross product with (10) / (2)
✓ describe()->with() combined with test->with() → receives both datasets with (5) / (50)
✓ describe()->with() combined with test->with() → receives both datasets with (5) / (60)
✓ beforeEach closure and beforeEach()->with() coexist → has both the closure state and dataset with (99)
✓ beforeEach()->with() does not interfere with closure hooks → closures run in order and dataset is applied with (42)
✓ first describe with dataset → gets its own dataset with (111)
✓ second describe with different dataset → gets its own dataset, not the sibling with (222)
✓ third describe without dataset → has no dataset leaking from siblings
✓ describe()->with() with beforeEach closure → both hook and dataset work with (77)
✓ describe()->with() with afterEach closure → dataset is available and afterEach runs with (88)
✓ multiple tests share the same beforeEach dataset → first test gets the dataset with (33)
✓ multiple tests share the same beforeEach dataset → second test also gets the dataset with (33)
✓ multiple tests share the same beforeEach dataset → it third test with it() also gets the dataset with (33)
✓ outer describe → inner describe with dataset on hook → inherits outer beforeEach and has inner dataset with (55)
✓ outer describe → outer test is unaffected by inner dataset
✓ describe()->with() preserves depends → first with (9)
✓ describe()->with() preserves depends → second with (9)
PASS Tests\Features\DatasetsTests - 1 todo
✓ it throws exception if dataset does not exist
✓ it throws exception if dataset already exist
@ -215,6 +257,20 @@
✓ it may be used with high order after describe block with dataset "formal"
✓ it may be used with high order after describe block with dataset "informal"
✓ after describe block with named dataset with ('after')
✓ named parameters match by parameter name with ('Taylor', 'taylor@laravel.com')
✓ named parameters work with multiple dataset items with ('Taylor', 'taylor@laravel.com')
✓ named parameters work with multiple dataset items with ('James', 'james@laravel.com')
✓ named parameters work in different order than closure params with ('a', 'b', 'c')
✓ named parameters work with named dataset keys with dataset "taylor"
✓ named parameters work with named dataset keys with dataset "james"
✓ named parameters work with closures that should be resolved with (Closure Object (), Closure Object ())
✓ named parameters work with closure type hints with ('Taylor', Closure Object ())
✓ named parameters work with registered datasets with ('Taylor', 'taylor@laravel.com')
✓ named parameters work with registered datasets with ('James', 'james@laravel.com')
✓ named parameters work with bound closure returning associative array with (Closure Object ())
✓ dataset items can mix named and sequential styles with ('Taylor', 'taylor@laravel.com')
✓ dataset items can mix named and sequential styles with ('James', 'james@laravel.com') #1
✓ dataset items can mix named and sequential styles with ('James', 'james@laravel.com') #2
PASS Tests\Features\Depends
✓ first
@ -1073,6 +1129,40 @@
✓ it may return a file path
✓ it may throw an exception if the file does not exist
WARN Tests\Features\Flaky - 1 todo
✓ it passes on first try
✓ it passes on a subsequent try
✓ it has a default of 3 tries
✓ it succeeds on the last possible try
✓ it works with tries of 1
✓ it retries assertion failures
✓ it works with a dataset with (1)
✓ it works with a dataset with (2)
✓ it works with a dataset with (3)
✓ it retries each dataset independently with ('alpha')
✓ it retries each dataset independently with ('beta')
✓ within a describe block → it retries inside describe
✓ lifecycle hooks with flaky → it re-runs beforeEach on each retry
✓ afterEach with flaky → it runs afterEach between retries
- it does not retry skipped tests → intentionally skipped
✓ it works with repeat and flaky @ repetition 1 of 2
✓ it works with repeat and flaky @ repetition 2 of 2
✓ it works as higher order test
✓ it fails after exhausting all retries
✓ it throws when tries is less than 1
✓ it throws when tries is negative
↓ it does not retry todo tests
✓ it retries php errors
✓ it works with throws and flaky
✓ it does not retry expected exceptions
✓ it does not retry fails()
✓ it retries unexpected exceptions even with throws set
✓ it does not leak mock objects between retries
✓ it does not stop retrying when snapshot changes are absent
✓ it does not leak dynamic properties between retries
✓ it clears output buffer between retries when expectOutputString is used
✓ it preserves output between retries when no output expectation is set
WARN Tests\Features\Helpers
✓ it can set/get properties on $this
! it gets null if property do not exist → Undefined property Tests\Features\Helpers::$wqdwqdqw
@ -1772,9 +1862,9 @@
PASS Tests\Visual\Help
✓ visual snapshot of help command output
WARN Tests\Visual\JUnit
PASS Tests\Visual\JUnit
✓ junit output
- junit with parallel → Not working yet
junit with parallel
PASS Tests\Visual\Parallel
✓ parallel
@ -1813,4 +1903,4 @@
✓ pass with dataset with ('my-datas-set-value')
✓ within describe → pass with dataset with ('my-datas-set-value')
Tests: 2 deprecated, 4 warnings, 5 incomplete, 2 notices, 39 todos, 35 skipped, 1211 passed (2847 assertions)
Tests: 2 deprecated, 4 warnings, 5 incomplete, 2 notices, 40 todos, 35 skipped, 1296 passed (2977 assertions)

View File

@ -0,0 +1,5 @@
<?php
it('fails after exhausting all retries', function () {
throw new Exception('Always fails');
})->flaky(tries: 2);

View File

@ -0,0 +1,287 @@
<?php
/**
* Tests for dataset method chaining with hooks and describe blocks.
*
* Covers the fix from PR #1565: beforeEach()->with(), describe()->with(),
* and nested describe blocks with datasets.
*/
// ---------------------------------------------------------------
// beforeEach()->with() inside describe blocks
// ---------------------------------------------------------------
describe('beforeEach()->with() applies dataset to tests', function () {
beforeEach()->with([10]);
test('receives the dataset value', function ($value) {
expect($value)->toBe(10);
});
it('also receives the dataset value in it()', function ($value) {
expect($value)->toBe(10);
});
});
describe('beforeEach()->with() with multiple dataset values', function () {
beforeEach()->with([1, 2, 3]);
test('receives each value from the dataset', function ($value) {
expect($value)->toBeIn([1, 2, 3]);
});
});
describe('beforeEach()->with() with keyed dataset', function () {
beforeEach()->with(['first' => [10], 'second' => [20]]);
test('receives keyed dataset values', function ($value) {
expect($value)->toBeIn([10, 20]);
});
});
describe('beforeEach()->with() with closure dataset', function () {
beforeEach()->with(function () {
yield [100];
yield [200];
});
test('receives values from closure dataset', function ($value) {
expect($value)->toBeIn([100, 200]);
});
});
// ---------------------------------------------------------------
// describe()->with() method chaining
// ---------------------------------------------------------------
describe('describe()->with() passes dataset to tests', function () {
test('receives the dataset value', function ($value) {
expect($value)->toBe(42);
});
it('also receives it in it()', function ($value) {
expect($value)->toBe(42);
});
})->with([42]);
describe('describe()->with() with multiple values', function () {
test('receives each value', function ($value) {
expect($value)->toBeIn([5, 10, 15]);
});
})->with([5, 10, 15]);
describe('describe()->with() with keyed dataset', function () {
test('receives keyed values', function ($value) {
expect($value)->toBeIn([100, 200]);
});
})->with(['alpha' => [100], 'beta' => [200]]);
describe('describe()->with() with closure dataset', function () {
test('receives closure dataset values', function ($value) {
expect($value)->toBeIn([7, 14]);
});
})->with(function () {
yield [7];
yield [14];
});
// ---------------------------------------------------------------
// Nested describe blocks with datasets
// ---------------------------------------------------------------
describe('outer with dataset', function () {
describe('inner without dataset', function () {
test('inherits outer dataset', function (...$args) {
expect($args)->toBe([1]);
});
});
})->with([1]);
describe('nested describe blocks with datasets at multiple levels', function () {
describe('level 1', function () {
test('receives level 1 dataset', function (...$args) {
expect($args)->toBe([10]);
});
describe('level 2', function () {
test('receives datasets from all ancestor levels', function (...$args) {
expect($args)->toBe([10, 20]);
});
})->with([20]);
})->with([10]);
});
describe('deeply nested describe with datasets', function () {
describe('a', function () {
describe('b', function () {
describe('c', function () {
test('receives all ancestor datasets', function (...$args) {
expect($args)->toBe([1, 2, 3]);
});
})->with([3]);
})->with([2]);
})->with([1]);
});
// ---------------------------------------------------------------
// Combining hook datasets with test-level datasets
// ---------------------------------------------------------------
describe('beforeEach()->with() combined with test->with()', function () {
beforeEach()->with([10]);
test('receives both datasets as cross product', function ($hookValue, $testValue) {
expect($hookValue)->toBe(10);
expect($testValue)->toBeIn([1, 2]);
})->with([1, 2]);
});
describe('describe()->with() combined with test->with()', function () {
test('receives both datasets', function ($describeValue, $testValue) {
expect($describeValue)->toBe(5);
expect($testValue)->toBeIn([50, 60]);
})->with([50, 60]);
})->with([5]);
// ---------------------------------------------------------------
// beforeEach()->with() combined with beforeEach closure
// ---------------------------------------------------------------
describe('beforeEach closure and beforeEach()->with() coexist', function () {
beforeEach(function () {
$this->setupValue = 'initialized';
});
beforeEach()->with([99]);
test('has both the closure state and dataset', function ($value) {
expect($this->setupValue)->toBe('initialized');
expect($value)->toBe(99);
});
});
describe('beforeEach()->with() does not interfere with closure hooks', function () {
beforeEach(function () {
$this->counter = 1;
});
beforeEach(function () {
$this->counter++;
});
beforeEach()->with([42]);
test('closures run in order and dataset is applied', function ($value) {
expect($this->counter)->toBe(2);
expect($value)->toBe(42);
});
});
// ---------------------------------------------------------------
// Dataset isolation between describe blocks
// ---------------------------------------------------------------
describe('first describe with dataset', function () {
beforeEach()->with([111]);
test('gets its own dataset', function ($value) {
expect($value)->toBe(111);
});
});
describe('second describe with different dataset', function () {
beforeEach()->with([222]);
test('gets its own dataset, not the sibling', function ($value) {
expect($value)->toBe(222);
});
});
describe('third describe without dataset', function () {
test('has no dataset leaking from siblings', function () {
expect(true)->toBeTrue();
});
});
// ---------------------------------------------------------------
// describe()->with() combined with beforeEach hooks
// ---------------------------------------------------------------
describe('describe()->with() with beforeEach closure', function () {
beforeEach(function () {
$this->hookRan = true;
});
test('both hook and dataset work', function ($value) {
expect($this->hookRan)->toBeTrue();
expect($value)->toBe(77);
});
})->with([77]);
describe('describe()->with() with afterEach closure', function () {
afterEach(function () {
expect($this->value)->toBe(88);
});
test('dataset is available and afterEach runs', function ($value) {
$this->value = $value;
expect($value)->toBe(88);
});
})->with([88]);
// ---------------------------------------------------------------
// Multiple tests in a describe with beforeEach()->with()
// ---------------------------------------------------------------
describe('multiple tests share the same beforeEach dataset', function () {
beforeEach()->with([33]);
test('first test gets the dataset', function ($value) {
expect($value)->toBe(33);
});
test('second test also gets the dataset', function ($value) {
expect($value)->toBe(33);
});
it('third test with it() also gets the dataset', function ($value) {
expect($value)->toBe(33);
});
});
// ---------------------------------------------------------------
// Nested describe with beforeEach()->with() at inner level
// ---------------------------------------------------------------
describe('outer describe', function () {
beforeEach(function () {
$this->outer = true;
});
describe('inner describe with dataset on hook', function () {
beforeEach()->with([55]);
test('inherits outer beforeEach and has inner dataset', function ($value) {
expect($this->outer)->toBeTrue();
expect($value)->toBe(55);
});
});
test('outer test is unaffected by inner dataset', function () {
expect($this->outer)->toBeTrue();
});
});
// ---------------------------------------------------------------
// describe()->with() with depends
// ---------------------------------------------------------------
describe('describe()->with() preserves depends', function () {
test('first', function ($value) {
expect($value)->toBe(9);
});
test('second', function ($value) {
expect($value)->toBe(9);
})->depends('first');
})->with([9]);

View File

@ -457,3 +457,88 @@ dataset('after-describe', ['after']);
test('after describe block with named dataset', function (...$args) {
expect($args)->toBe(['after']);
})->with('after-describe');
test('named parameters match by parameter name', function (string $email, string $name) {
expect($name)->toBe('Taylor');
expect($email)->toBe('taylor@laravel.com');
})->with([
['name' => 'Taylor', 'email' => 'taylor@laravel.com'],
]);
test('named parameters work with multiple dataset items', function (string $email, string $name) {
expect($name)->toBeString();
expect($email)->toContain('@');
})->with([
['name' => 'Taylor', 'email' => 'taylor@laravel.com'],
['name' => 'James', 'email' => 'james@laravel.com'],
]);
test('named parameters work in different order than closure params', function (string $third, string $first, string $second) {
expect($first)->toBe('a');
expect($second)->toBe('b');
expect($third)->toBe('c');
})->with([
['first' => 'a', 'second' => 'b', 'third' => 'c'],
]);
test('named parameters work with named dataset keys', function (string $email, string $name) {
expect($name)->toBeString();
expect($email)->toContain('@');
})->with([
'taylor' => ['name' => 'Taylor', 'email' => 'taylor@laravel.com'],
'james' => ['name' => 'James', 'email' => 'james@laravel.com'],
]);
test('named parameters work with closures that should be resolved', function (string $email, string $name) {
expect($name)->toBe('bar');
expect($email)->toBe('bar@example.com');
})->with([
[
'name' => function () {
return $this->foo;
},
'email' => function () {
return $this->foo.'@example.com';
},
],
]);
test('named parameters work with closure type hints', function (Closure $callback, string $name) {
expect($name)->toBe('Taylor');
expect($callback())->toBe('resolved');
})->with([
[
'name' => 'Taylor',
'callback' => function () {
return 'resolved';
},
],
]);
dataset('named-params-dataset', [
['name' => 'Taylor', 'email' => 'taylor@laravel.com'],
['name' => 'James', 'email' => 'james@laravel.com'],
]);
test('named parameters work with registered datasets', function (string $email, string $name) {
expect($name)->toBeString();
expect($email)->toContain('@');
})->with('named-params-dataset');
test('named parameters work with bound closure returning associative array', function (string $email, string $name) {
expect($name)->toBe('bar');
expect($email)->toBe('test@example.com');
})->with([
function () {
return ['name' => $this->foo, 'email' => 'test@example.com'];
},
]);
test('dataset items can mix named and sequential styles', function (string $name, string $email) {
expect($name)->toBeString();
expect($email)->toContain('@');
})->with([
['name' => 'Taylor', 'email' => 'taylor@laravel.com'],
['James', 'james@laravel.com'],
['James', 'email' => 'james@laravel.com'],
]);

300
tests/Features/Flaky.php Normal file
View File

@ -0,0 +1,300 @@
<?php
use Symfony\Component\Process\Process;
it('passes on first try', function () {
expect(true)->toBeTrue();
})->flaky();
it('passes on a subsequent try', function () {
$file = sys_get_temp_dir().'/pest_flaky_'.crc32(__FILE__.__LINE__);
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
throw new Exception('Flaky failure');
}
@unlink($file);
expect(true)->toBeTrue();
})->flaky(tries: 3);
it('has a default of 3 tries', function () {
expect(true)->toBeTrue();
})->flaky();
it('succeeds on the last possible try', function () {
$file = sys_get_temp_dir().'/pest_flaky_last_try';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 3) {
throw new Exception('Not yet');
}
@unlink($file);
expect(true)->toBeTrue();
})->flaky(tries: 3);
it('works with tries of 1', function () {
expect(true)->toBeTrue();
})->flaky(tries: 1);
it('retries assertion failures', function () {
$file = sys_get_temp_dir().'/pest_flaky_assertion';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
expect(false)->toBeTrue();
}
@unlink($file);
expect(true)->toBeTrue();
})->flaky(tries: 3);
it('works with a dataset', function (int $number) {
expect($number)->toBeGreaterThan(0);
})->flaky(tries: 2)->with([1, 2, 3]);
it('retries each dataset independently', function (string $label) {
$file = sys_get_temp_dir().'/pest_flaky_dataset_'.md5($label);
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
throw new Exception("Flaky for $label");
}
@unlink($file);
expect(true)->toBeTrue();
})->flaky(tries: 3)->with(['alpha', 'beta']);
describe('within a describe block', function () {
it('retries inside describe', function () {
$file = sys_get_temp_dir().'/pest_flaky_describe';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
throw new Exception('Flaky inside describe');
}
@unlink($file);
expect(true)->toBeTrue();
})->flaky(tries: 2);
});
describe('lifecycle hooks with flaky', function () {
beforeEach(function () {
$this->setupCount = ($this->setupCount ?? 0) + 1;
});
it('re-runs beforeEach on each retry', function () {
$file = sys_get_temp_dir().'/pest_flaky_lifecycle';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
throw new Exception('Flaky lifecycle');
}
@unlink($file);
// After retry: setUp ran for initial + retry = setupCount should be 2
expect($this->setupCount)->toBe(2);
})->flaky(tries: 3);
});
describe('afterEach with flaky', function () {
$state = new stdClass;
$state->teardownCount = 0;
afterEach(function () use ($state) {
$state->teardownCount++;
});
it('runs afterEach between retries', function () use ($state) {
$file = sys_get_temp_dir().'/pest_flaky_aftereach';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
throw new Exception('Flaky afterEach');
}
@unlink($file);
// tearDown was called once between retries
expect($state->teardownCount)->toBe(1);
})->flaky(tries: 3);
});
it('does not retry skipped tests')
->skip('intentionally skipped')
->flaky(tries: 3);
it('works with repeat and flaky', function () {
expect(true)->toBeTrue();
})->repeat(times: 2)->flaky(tries: 2);
it('works as higher order test')
->assertTrue(true)
->flaky(tries: 2);
it('fails after exhausting all retries', function () {
$process = new Process(
['php', 'bin/pest', 'tests/.tests/FlakyFailure.php'],
dirname(__DIR__, 2),
['COLLISION_PRINTER' => 'DefaultPrinter', 'COLLISION_IGNORE_DURATION' => 'true'],
);
$process->run();
expect($process->getExitCode())->not->toBe(0);
expect(removeAnsiEscapeSequences($process->getOutput()))
->toContain('FAILED')
->toContain('Always fails');
});
it('throws when tries is less than 1', function () {
it('invalid', function () {})->flaky(tries: 0);
})->throws(InvalidArgumentException::class, 'The number of tries must be greater than 0.');
it('throws when tries is negative', function () {
it('invalid negative', function () {})->flaky(tries: -1);
})->throws(InvalidArgumentException::class, 'The number of tries must be greater than 0.');
it('does not retry todo tests')
->todo()
->flaky(tries: 3);
it('retries php errors', function () {
$file = sys_get_temp_dir().'/pest_flaky_error';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
throw new TypeError('type error');
}
@unlink($file);
expect(true)->toBeTrue();
})->flaky(tries: 3);
it('works with throws and flaky', function () {
throw new RuntimeException('Expected exception');
})->throws(RuntimeException::class, 'Expected exception')->flaky(tries: 2);
it('does not retry expected exceptions', function () {
// If flaky retried this, the temp file counter would reach 2 and
// the test would NOT throw — causing PHPUnit's "expected exception
// was not raised" to fail. The test passes only if we don't retry.
$file = sys_get_temp_dir().'/pest_flaky_expected';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count >= 2) {
@unlink($file);
// Second call means flaky retried — don't throw, which will FAIL
// because PHPUnit expects the exception
return;
}
@unlink($file);
throw new RuntimeException('Expected on first attempt');
})->throws(RuntimeException::class)->flaky(tries: 3);
it('does not retry fails()', function () {
$this->fail('Expected failure');
})->fails('Expected failure')->flaky(tries: 2);
it('retries unexpected exceptions even with throws set', function () {
$file = sys_get_temp_dir().'/pest_flaky_unexpected';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
throw new LogicException('Unexpected flaky error');
}
@unlink($file);
throw new RuntimeException('Expected exception');
})->throws(RuntimeException::class)->flaky(tries: 3);
it('does not leak mock objects between retries', function () {
$mock = $this->createMock(Countable::class);
$mock->expects($this->once())->method('count')->willReturn(1);
$file = sys_get_temp_dir().'/pest_flaky_mock';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
@unlink(sys_get_temp_dir().'/pest_flaky_mock'); // clean before retry writes again
file_put_contents($file, '1');
throw new Exception('Flaky mock failure');
}
@unlink($file);
// Call mock — only the mock from THIS attempt should be verified
expect($mock->count())->toBe(1);
})->flaky(tries: 3);
it('does not stop retrying when snapshot changes are absent', function () {
// Ensures the snapshot guard only triggers when __snapshotChanges is non-empty
$file = sys_get_temp_dir().'/pest_flaky_no_snapshot';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
throw new Exception('No snapshots here');
}
@unlink($file);
expect(true)->toBeTrue();
})->flaky(tries: 3);
it('does not leak dynamic properties between retries', function () {
$file = sys_get_temp_dir().'/pest_flaky_props';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
$this->leakedProperty = 'from attempt 1';
throw new Exception('Flaky props');
}
@unlink($file);
expect(isset($this->leakedProperty))->toBeFalse();
})->flaky(tries: 3);
it('clears output buffer between retries when expectOutputString is used', function () {
$file = sys_get_temp_dir().'/pest_flaky_output';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
$this->expectOutputString('clean');
if ($count < 2) {
echo 'stale';
throw new Exception('Flaky output');
}
@unlink($file);
echo 'clean';
})->flaky(tries: 3);
it('preserves output between retries when no output expectation is set', function () {
$file = sys_get_temp_dir().'/pest_flaky_output_no_expect';
$count = file_exists($file) ? (int) file_get_contents($file) : 0;
file_put_contents($file, (string) ++$count);
if ($count < 2) {
echo 'from attempt 1';
throw new Exception('Flaky output no expect');
}
@unlink($file);
// Output from attempt 1 is still in the buffer
$this->expectOutputString('from attempt 1');
})->flaky(tries: 3);

View File

@ -60,20 +60,17 @@ test('junit with parallel', function () use ($normalizedPath, $run) {
expect($result['testsuite']['@attributes'])
->name->toBe('Tests\tests\SuccessOnly')
->file->toBe($normalizedPath('tests/.tests/SuccessOnly.php'))
->tests->toBe('2')
->assertions->toBe('2')
->tests->toBe('1')
->assertions->toBe('1')
->errors->toBe('0')
->failures->toBe('0')
->skipped->toBe('0');
expect($result['testsuite']['testcase'])
->toHaveCount(2);
expect($result['testsuite']['testcase'][0]['@attributes'])
expect($result['testsuite']['testcase']['@attributes'])
->name->toBe('it can pass with comparison')
->file->toBe($normalizedPath('tests/.tests/SuccessOnly.php::it can pass with comparison'))
->class->toBe('Tests\tests\SuccessOnly')
->classname->toBe('Tests.tests.SuccessOnly')
->assertions->toBe('1')
->time->toStartWith('0.0');
})->skip('Not working yet');
});

View File

@ -15,8 +15,24 @@ $run = function () {
};
test('parallel', function () use ($run) {
expect($run('--exclude-group=integration'))
->toContain('Tests: 2 deprecated, 4 warnings, 5 incomplete, 3 notices, 39 todos, 26 skipped, 1196 passed (2809 assertions)')
$output = $run('--exclude-group=integration');
if (getenv('REBUILD_SNAPSHOTS')) {
preg_match('/Tests:\s+(.+\(\d+ assertions\))/', $output, $matches);
$file = file_get_contents(__FILE__);
$file = preg_replace(
'/\$expected = \'.*?\';/',
"\$expected = '2 deprecated, 4 warnings, 5 incomplete, 3 notices, 40 todos, 27 skipped, 1280 passed (2926 assertions)';",
$file,
);
file_put_contents(__FILE__, $file);
}
$expected = '2 deprecated, 4 warnings, 5 incomplete, 3 notices, 40 todos, 27 skipped, 1280 passed (2926 assertions)';
expect($output)
->toContain("Tests: {$expected}")
->toContain('Parallel: 3 processes');
})->skipOnWindows();