release: v2.6.0

[2.x] allow to expect `toThrow` against an exception instance

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## [v2.5.2 (2023-04-19)](https://github.com/pestphp/pest/compare/v2.5.1...v2.5.2)
+
+### Chore
+- Removes `myclabs/php-enuma` dependency ([1a05df1](https://github.com/pestphp/pest/commit/1a05df14d0ce7d12583df26ff716807db6f81f13))
+
 ## [v2.5.1 (2023-04-18)](https://github.com/pestphp/pest/compare/v2.5.0...v2.5.1)
 
 ### Chore

composer.json

@@ -19,15 +19,15 @@
     "require": {
         "php": "^8.1.0",
         "brianium/paratest": "^7.1.3",
-        "nunomaduro/collision": "^7.5.0",
+        "nunomaduro/collision": "^7.5.2",
         "nunomaduro/termwind": "^1.15.1",
         "pestphp/pest-plugin": "^2.0.1",
-        "pestphp/pest-plugin-arch": "^2.1.1",
+        "pestphp/pest-plugin-arch": "^2.1.2",
-        "phpunit/phpunit": "^10.1.1"
+        "phpunit/phpunit": "^10.1.2"
     },
     "conflict": {
         "webmozart/assert": "<1.11.0",
-        "phpunit/phpunit": ">10.1.1"
+        "phpunit/phpunit": ">10.1.2"
     },
     "autoload": {
         "psr-4": {
@@ -49,8 +49,8 @@
         ]
     },
     "require-dev": {
-        "pestphp/pest-dev-tools": "^2.6.0",
+        "pestphp/pest-dev-tools": "^2.8.0",
-        "symfony/process": "^6.2.8"
+        "symfony/process": "^6.2.10"
     },
     "minimum-stability": "stable",
     "config": {

phpstan.neon

@@ -12,6 +12,7 @@ parameters:
     reportUnmatchedIgnoredErrors: true
 
     ignoreErrors:
+        - "#has a nullable return type declaration.#"
         - "#Language construct isset\\(\\) should not be used.#"
         - "#is not allowed to extend#"
         - "#is concrete, but does not have a Test suffix#"
@@ -20,4 +21,3 @@ parameters:
         - "# with null as default value#"
         - "#has parameter \\$closure with default value.#"
         - "#has parameter \\$description with default value.#"
-        - "#Method Pest\\\\Support\\\\Reflection::getParameterClassName\\(\\) has a nullable return type declaration.#"

src/Concerns/Testable.php

@@ -181,7 +181,7 @@ trait Testable
 
         parent::setUp();
 
-        $beforeEach = TestSuite::getInstance()->beforeEach->get(self::$__filename);
+        $beforeEach = TestSuite::getInstance()->beforeEach->get(self::$__filename)[1];
 
         if ($this->__beforeEach instanceof Closure) {
             $beforeEach = ChainableClosure::from($this->__beforeEach, $beforeEach);

src/Factories/TestCaseMethodFactory.php

@@ -90,7 +90,7 @@ final class TestCaseMethodFactory
         $method = $this;
 
         return function () use ($testCase, $method, $closure): mixed { // @phpstan-ignore-line
-        /* @var TestCase $this */
+            /* @var TestCase $this */
             $testCase->proxies->proxy($this);
             $method->proxies->proxy($this);
 

src/Functions.php

@@ -43,7 +43,7 @@ if (! function_exists('beforeEach')) {
     /**
      * Runs the given closure before each test in the current file.
      *
-     * @return HigherOrderTapProxy<TestCall|TestCase>|TestCall|mixed
+     * @return HigherOrderTapProxy<TestCall|TestCase>|TestCall|TestCase|mixed
      */
     function beforeEach(Closure $closure = null): BeforeEachCall
     {

src/Mixins/Expectation.php

@@ -842,7 +842,7 @@ final class Expectation
      * @param (Closure(Throwable): mixed)|string $exception
      * @return self<TValue>
      */
-    public function toThrow(callable|string $exception, string $exceptionMessage = null, string $message = ''): self
+    public function toThrow(callable|string|Throwable $exception, string $exceptionMessage = null, string $message = ''): self
     {
         $callback = NullClosure::create();
 
@@ -864,6 +864,15 @@ final class Expectation
         try {
             ($this->value)();
         } catch (Throwable $e) {
+
+            if ($exception instanceof Throwable) {
+                expect($e)
+                    ->toBeInstanceOf($exception::class, $message)
+                    ->and($e->getMessage())->toBe($exceptionMessage ?? $exception->getMessage(), $message);
+
+                return $this;
+            }
+
             if (! class_exists($exception)) {
                 if ($e instanceof Error && $e->getMessage() === "Class \"$exception\" not found") {
                     Assert::assertTrue(true);
@@ -888,7 +897,7 @@ final class Expectation
 
         Assert::assertTrue(true);
 
-        if (! class_exists($exception)) {
+        if (! $exception instanceof Throwable && ! class_exists($exception)) {
             throw new ExpectationFailedException("Exception with message \"$exception\" not thrown.");
         }
 

src/PendingCalls/BeforeEachCall.php

@@ -19,12 +19,17 @@ final class BeforeEachCall
     /**
      * Holds the before each closure.
      */
-    private readonly \Closure $closure;
+    private readonly Closure $closure;
 
     /**
-     * The calls that should be proxied.
+     * The test call proxies.
      */
-    private readonly HigherOrderMessageCollection $proxies;
+    private readonly HigherOrderMessageCollection $testCallProxies;
+
+    /**
+     * The test case proxies.
+     */
+    private readonly HigherOrderMessageCollection $testCaseProxies;
 
     /**
      * Creates a new Pending Call.
@@ -36,7 +41,8 @@ final class BeforeEachCall
     ) {
         $this->closure = $closure instanceof Closure ? $closure : NullClosure::create();
 
-        $this->proxies = new HigherOrderMessageCollection();
+        $this->testCallProxies = new HigherOrderMessageCollection();
+        $this->testCaseProxies = new HigherOrderMessageCollection();
     }
 
     /**
@@ -44,13 +50,16 @@ final class BeforeEachCall
      */
     public function __destruct()
     {
-        $proxies = $this->proxies;
+        $testCaseProxies = $this->testCaseProxies;
 
         $this->testSuite->beforeEach->set(
             $this->filename,
-            ChainableClosure::from(function () use ($proxies): void {
+            function (TestCall $testCall): void {
-                $proxies->chain($this);
+                $this->testCallProxies->chain($testCall);
-            }, $this->closure)
+            },
+            ChainableClosure::from(function () use ($testCaseProxies): void {
+                $testCaseProxies->chain($this);
+            }, $this->closure),
         );
     }
 
@@ -61,7 +70,13 @@ final class BeforeEachCall
      */
     public function __call(string $name, array $arguments): self
     {
-        $this->proxies
+        if (method_exists(TestCall::class, $name)) {
+            $this->testCallProxies->add(Backtrace::file(), Backtrace::line(), $name, $arguments);
+
+            return $this;
+        }
+
+        $this->testCaseProxies
             ->add(Backtrace::file(), Backtrace::line(), $name, $arguments);
 
         return $this;

src/PendingCalls/TestCall.php

@@ -40,12 +40,15 @@ final class TestCall
      */
     public function __construct(
         private readonly TestSuite $testSuite,
-        string $filename,
+        private readonly string $filename,
         string $description = null,
         Closure $closure = null
     ) {
         $this->testCaseMethod = new TestCaseMethodFactory($filename, $description, $closure);
+
         $this->descriptionLess = $description === null;
+
+        $this->testSuite->beforeEach->get($filename)[0]($this);
     }
 
     /**
@@ -167,7 +170,7 @@ final class TestCall
 
         $this->testCaseMethod
             ->chains
-            ->addWhen($condition, Backtrace::file(), Backtrace::line(), 'markTestSkipped', [$message]);
+            ->addWhen($condition, $this->filename, Backtrace::line(), 'markTestSkipped', [$message]);
 
         return $this;
     }

src/Pest.php

@@ -6,7 +6,7 @@ namespace Pest;
 
 function version(): string
 {
-    return '2.5.1';
+    return '2.6.0';
 }
 
 function testDirectory(string $file = ''): string

src/Plugins/Help.php

@@ -109,20 +109,16 @@ final class Help implements HandlesArguments
             ],
         ], ...$content['Execution']];
 
-        $content['Selection'] = array_merge([
+        $content['Selection'] = [[
-            [
+            'arg' => '--bail',
-                'arg' => '--bail',
+            'desc' => 'Stop execution upon first not-passed test',
-                'desc' => 'Stop execution upon first not-passed test',
+        ], [
-            ],
+            'arg' => '--todos',
-            [
+            'desc' => 'Output to standard output the list of todos',
-                'arg' => '--todos',
+        ], [
-                'desc' => 'Output to standard output the list of todos',
+            'arg' => '--retry',
-            ],
+            'desc' => 'Run non-passing tests first and stop execution upon first error or failure',
-            [
+        ], ...$content['Selection']];
-                'arg' => '--retry',
-                'desc' => 'Run non-passing tests first and stop execution upon first error or failure',
-            ],
-        ], $content['Selection']);
 
         $content['Reporting'] = [...$content['Reporting'], ...[
             [
@@ -131,16 +127,13 @@ final class Help implements HandlesArguments
             ],
         ]];
 
-        $content['Code Coverage'] = array_merge([
+        $content['Code Coverage'] = [[
-            [
+            'arg' => '--coverage ',
-                'arg' => '--coverage ',
+            'desc' => 'Generate code coverage report and output to standard output',
-                'desc' => 'Generate code coverage report and output to standard output',
+        ], [
-            ],
+            'arg' => '--coverage --min',
-            [
+            'desc' => 'Set the minimum required coverage percentage, and fail if not met',
-                'arg' => '--coverage --min',
+        ], ...$content['Code Coverage']];
-                'desc' => 'Set the minimum required coverage percentage, and fail if not met',
-            ],
-        ], $content['Code Coverage']);
 
         $content['Profiling'] = [
             [

src/Repositories/BeforeEachRepository.php

@@ -14,27 +14,34 @@ use Pest\Support\NullClosure;
 final class BeforeEachRepository
 {
     /**
-     * @var array<string, Closure>
+     * @var array<string, array{0: Closure, 1: Closure}>
      */
     private array $state = [];
 
     /**
      * Sets a before each closure.
      */
-    public function set(string $filename, Closure $closure): void
+    public function set(string $filename, Closure $beforeEachTestCall, Closure $beforeEachTestCase): void
     {
         if (array_key_exists($filename, $this->state)) {
             throw new BeforeEachAlreadyExist($filename);
         }
 
-        $this->state[$filename] = $closure;
+        $this->state[$filename] = [$beforeEachTestCall, $beforeEachTestCase];
     }
 
     /**
      * Gets a before each closure by the given filename.
+     *
+     * @return array{0: Closure, 1: Closure}
      */
-    public function get(string $filename): Closure
+    public function get(string $filename): array
     {
-        return $this->state[$filename] ?? NullClosure::create();
+        $closures = $this->state[$filename] ?? [];
+
+        return [
+            $closures[0] ?? NullClosure::create(),
+            $closures[1] ?? NullClosure::create(),
+        ];
     }
 }

src/Support/Backtrace.php

@@ -104,8 +104,6 @@ final class Backtrace
     {
         $trace = debug_backtrace(self::BACKTRACE_OPTIONS)[1];
 
-        assert(array_key_exists('line', $trace));
+        return $trace['line'] ?? 0;
-
-        return $trace['line'];
     }
 }

tests/.snapshots/help-command.txt

@@ -1,5 +1,5 @@
 
-  Pest Testing Framework 2.5.1.  
+  Pest Testing Framework 2.6.0.  
 
   USAGE: pest <file> [options]  
 

tests/.snapshots/success.txt

@@ -22,6 +22,22 @@
   ✓ it gets executed before each test
   ✓ it gets executed before each test once again
 
+   PASS  Tests\Features\BeforeEachProxiesToTestCallWithExpectations
+  ✓ runs 1
+  ✓ runs 2
+  ✓ runs 3
+
+   WARN  Tests\Features\BeforeEachProxiesToTestCallWithSkip
+  - does not run 1
+  - does not run 2
+  - does not run 3
+
+   TODO  Tests\Features\BeforeEachProxiesToTestCallWithTodo - 4 todos
+  ↓ is marked as todo 1
+  ↓ is marked as todo 2
+  ↓ is marked as todo 3
+  ↓ shouldBeMarkedAsTodo
+
    WARN  Tests\Features\Coverage
   ✓ it has plugin
   - it adds coverage if --coverage exist → Coverage is not available
@@ -152,7 +168,7 @@
   ✓ it uses correct parent class
 
    DEPR  Tests\Features\Deprecated
-  ! deprecated → str_contains(): Passing null to parameter #2 ($needle) of type string is deprecated // tests/Features/Deprecated.php:6
+  ! deprecated → str_contains(): Passing null to parameter #1 ($haystack) of type string is deprecated // tests/Features/Deprecated.php:6
   ✓ user deprecated
 
    PASS  Tests\Features\Exceptions
@@ -641,6 +657,7 @@
   ✓ failures 5
   ✓ failures 6
   ✓ failures 7
+  ✓ failures 8
   ✓ failures with custom message
   ✓ not failures
   ✓ closure missing parameter
@@ -1017,4 +1034,4 @@
    PASS  Tests\Visual\Version
   ✓ visual snapshot of help command output
 
-  Tests:    1 deprecated, 3 warnings, 4 incomplete, 1 notice, 4 todos, 14 skipped, 711 passed (1719 assertions)
+  Tests:    1 deprecated, 3 warnings, 4 incomplete, 1 notice, 8 todos, 17 skipped, 715 passed (1727 assertions)

tests/.snapshots/todo.txt

@@ -1,3 +1,9 @@
+   TODO  Tests\Features\BeforeEachProxiesToTestCallWithTodo - 4 todos
+  ↓ is marked as todo 1
+  ↓ is marked as todo 2
+  ↓ is marked as todo 3
+  ↓ shouldBeMarkedAsTodo
+
    TODO  Tests\Features\DatasetsTests - 1 todo
   ↓ forbids to define tests in Datasets dirs and Datasets.php files
 
@@ -9,4 +15,4 @@
    PASS  Tests\CustomTestCase\ExecutedTest
   ✓ that gets executed
 
-  Tests:    4 todos, 1 passed (1 assertions)
+  Tests:    8 todos, 1 passed (1 assertions)

tests/.snapshots/version-command.txt

@@ -1,3 +1,3 @@
 
-  Pest Testing Framework 2.5.1.  
+  Pest Testing Framework 2.6.0.  
 

tests/Features/BeforeEachProxiesToTestCallWithExpectations.php

@@ -0,0 +1,15 @@
+<?php
+
+beforeEach()->expect(true)->toBeTrue();
+
+test('runs 1', function () {
+    // This test did performs assertions...
+});
+
+test('runs 2', function () {
+    // This test did performs assertions...
+});
+
+test('runs 3', function () {
+    // This test did performs assertions...
+});

tests/Features/BeforeEachProxiesToTestCallWithSkip.php

@@ -0,0 +1,15 @@
+<?php
+
+beforeEach()->skip();
+
+test('does not run 1', function () {
+    $this->fail('This test should not run');
+});
+
+test('does not run 2', function () {
+    $this->fail('This test should not run');
+});
+
+test('does not run 3', function () {
+    $this->fail('This test should not run');
+});

tests/Features/BeforeEachProxiesToTestCallWithTodo.php

@@ -0,0 +1,15 @@
+<?php
+
+beforeEach()->todo();
+
+test('is marked as todo 1', function () {
+    $this->fail('This test should not run');
+});
+
+test('is marked as todo 2', function () {
+    $this->fail('This test should not run');
+});
+
+test('is marked as todo 3');
+
+test()->shouldBeMarkedAsTodo();

tests/Features/Expect/HigherOrder/methods.php

@@ -85,17 +85,17 @@ it('works with higher order tests')
 it('can use the scoped method to lock into the given level for expectations', function () {
     expect(new HasMethods())
         ->attributes()->scoped(fn ($attributes) => $attributes
-            ->name->toBe('Has Methods')
+        ->name->toBe('Has Methods')
-            ->quantity->toBe(20)
+        ->quantity->toBe(20)
         )
         ->name()->toBeString()->toBe('Has Methods')
         ->newInstance()->newInstance()->scoped(fn ($instance) => $instance
-            ->name()->toBe('Has Methods')
+        ->name()->toBe('Has Methods')
-            ->quantity()->toBe(20)
+        ->quantity()->toBe(20)
-            ->attributes()->scoped(fn ($attributes) => $attributes
+        ->attributes()->scoped(fn ($attributes) => $attributes
-                ->name->toBe('Has Methods')
+        ->name->toBe('Has Methods')
-                ->quantity->toBe(20)
+        ->quantity->toBe(20)
-            )
+        )
         );
 });
 

tests/Features/Expect/pipes.php

@@ -171,19 +171,19 @@ test('pipe works with negated expectation', function () use ($state) {
     $state->reset();
 
     expect($char)->not->toBe(new Char('B'))
-       ->and($state)
+        ->and($state)
-       ->runCount->toMatchArray([
+        ->runCount->toMatchArray([
-           'char' => 1,
+            'char' => 1,
-           'number' => 0,
+            'number' => 0,
-           'wildcard' => 0,
+            'wildcard' => 0,
-           'symbol' => 0,
+            'symbol' => 0,
-       ])
+        ])
-       ->appliedCount->toMatchArray([
+        ->appliedCount->toMatchArray([
-           'char' => 1,
+            'char' => 1,
-           'number' => 0,
+            'number' => 0,
-           'wildcard' => 0,
+            'wildcard' => 0,
-           'symbol' => 0,
+            'symbol' => 0,
-       ]);
+        ]);
 });
 
 test('interceptor is applied', function () use ($state) {

tests/Features/Expect/toThrow.php

@@ -2,6 +2,10 @@
 
 use PHPUnit\Framework\ExpectationFailedException;
 
+class CustomException extends Exception
+{
+}
+
 test('passes', function () {
     expect(function () {
         throw new RuntimeException();
@@ -33,6 +37,9 @@ test('passes', function () {
         throw new RuntimeException('actual message');
     })->toThrow(function (RuntimeException $e) {
     }, 'actual message');
+    expect(function () {
+        throw new CustomException('foo');
+    })->toThrow(new CustomException('foo'));
 });
 
 test('failures 1', function () {
@@ -79,6 +86,12 @@ test('failures 7', function () {
     })->toThrow(RuntimeException::class, 'expected message');
 })->throws(ExpectationFailedException::class);
 
+test('failures 8', function () {
+    expect(function () {
+        throw new CustomException('actual message');
+    })->toThrow(new CustomException('expected message'));
+})->throws(ExpectationFailedException::class);
+
 test('failures with custom message', function () {
     expect(function () {
         throw new RuntimeException('actual message');

tests/Visual/Parallel.php

@@ -18,7 +18,7 @@ $run = function () {
 
 test('parallel', function () use ($run) {
     expect($run('--exclude-group=integration'))
-        ->toContain('Tests:    1 deprecated, 3 warnings, 4 incomplete, 1 notice, 4 todos, 11 skipped, 699 passed (1704 assertions)')
+        ->toContain('Tests:    1 deprecated, 3 warnings, 4 incomplete, 1 notice, 8 todos, 14 skipped, 703 passed (1712 assertions)')
         ->toContain('Parallel: 3 processes');
 })->skipOnWindows();
 

tests/Visual/Todo.php

@@ -11,7 +11,9 @@ $run = function (string $target, bool $parallel) {
 
     expect($process->getExitCode())->toBe(0);
 
-    return preg_replace('#\\x1b[[][^A-Za-z]*[A-Za-z]#', '', $process->getOutput());
+    $outputContent = preg_replace('#\\x1b[[][^A-Za-z]*[A-Za-z]#', '', $process->getOutput());
+
+    return $outputContent;
 };
 
 $snapshot = function ($name) {