Skip to content

Commit

Permalink
Add ability to extend TestCall to create custom chained helpers
Browse files Browse the repository at this point in the history
  • Loading branch information
JHWelch committed Oct 26, 2024
1 parent eaeb133 commit 3009567
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 2 deletions.
20 changes: 20 additions & 0 deletions src/PendingCalls/TestCall.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace Pest\PendingCalls;

use Closure;
use Pest\Concerns\Extendable;
use Pest\Concerns\Testable;
use Pest\Exceptions\InvalidArgumentException;
use Pest\Exceptions\TestDescriptionMissing;
Expand All @@ -31,6 +32,9 @@
final class TestCall // @phpstan-ignore-line
{
use Describable;
use Extendable {
extend as traitExtend;
}

/**
* The list of test case factory attributes.
Expand Down Expand Up @@ -643,9 +647,25 @@ public function __get(string $name): self
*/
public function __call(string $name, array $arguments): self
{
if (self::hasExtend($name)) {
$extend = self::$extends[$name]->bindTo($this, TestCall::class);

if ($extend != false) { // @pest-arch-ignore-line
return $extend(...$arguments);
}
}

return $this->addChain(Backtrace::file(), Backtrace::line(), $name, $arguments);
}

public function extend(string $name, Closure $extend): void
{
$this->traitExtend($name, $extend);

$this->description = "extend: $name";
$this->testCaseMethod->closure = fn (): null => null;
}

/**
* Add a chain to the test case factory. Omitting the arguments will treat it as a property accessor.
*
Expand Down
6 changes: 5 additions & 1 deletion tests/.snapshots/success.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1324,6 +1324,10 @@
✓ a test
✓ higher order message test

PASS Tests\Features\TestCallExtend
✓ it uses fooBar extension with ('foo')
✓ it uses fooBar extension with ('bar')

PASS Tests\Features\ThrowsNoExceptions
✓ it allows access to the underlying expectNotToPerformAssertions method
✓ it allows performing no expectations without being risky
Expand Down Expand Up @@ -1698,4 +1702,4 @@
WARN Tests\Visual\Version
- visual snapshot of help command output

Tests: 2 deprecated, 4 warnings, 5 incomplete, 2 notices, 38 todos, 33 skipped, 1144 passed (2736 assertions)
Tests: 2 deprecated, 4 warnings, 5 incomplete, 2 notices, 38 todos, 33 skipped, 1146 passed (2738 assertions)
17 changes: 17 additions & 0 deletions tests/Features/TestCallExtend.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

use function PHPUnit\Framework\assertTrue;

test()->extend('fooBar', function () {
return $this->with([
'foo',
'bar',
]);
});

it('uses fooBar extension', function ($value) {
assertTrue(in_array($value, [
'foo',
'bar',
]));
})->fooBar();
2 changes: 1 addition & 1 deletion tests/Visual/Parallel.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

test('parallel', function () use ($run) {
expect($run('--exclude-group=integration'))
->toContain('Tests: 2 deprecated, 4 warnings, 5 incomplete, 2 notices, 38 todos, 24 skipped, 1134 passed (2712 assertions)')
->toContain('Tests: 2 deprecated, 4 warnings, 5 incomplete, 2 notices, 38 todos, 24 skipped, 1136 passed (2714 assertions)')
->toContain('Parallel: 3 processes');
})->skipOnWindows();

Expand Down

0 comments on commit 3009567

Please sign in to comment.