release: v2.4.0

Add possibility to check property name and value with toHaveProperties

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## [v2.3.0 (2023-04-03)](https://github.com/pestphp/pest/compare/v2.3.0...v2.4.0)
+
+### Added
+- `skipOnWindows()`, `skipOnMac()`, and `skipOnLinux()` ([#757](https://github.com/pestphp/pest/pull/757))
+- source architecture testing violation ([#1](https://github.com/pestphp/pest-plugin-arch/pull/1))((8e66263)[https://github.com/pestphp/pest-plugin-arch/commit/8e66263104304e99e3d6ceda25c7ed679b27fb03])
+- `toHaveProperties` may now also check values ([#760](https://github.com/pestphp/pest/pull/760))
+
+### Fixed
+- Tests on `tests/Helpers` directory not being executed ([#753](https://github.com/pestphp/pest/pull/753))
+- Teamcity count ([#747](https://github.com/pestphp/pest/pull/747))
+- Parallel executation when class extends class with same name ([#748](https://github.com/pestphp/pest/pull/748))
+- Wording on `uses()` hint ([#745](https://github.com/pestphp/pest/pull/745/files))
+
 ## [v2.3.0 (2023-03-28)](https://github.com/pestphp/pest/compare/v2.2.3...v2.3.0)
 
 ### Added

bin/worker.php

@@ -92,7 +92,7 @@ $bootPest = (static function (): void {
             exit;
         }
 
-        $exitCode = $application->runTest(trim($testPath));
+        $exitCode = $application->runTest(realpath(trim($testPath)));
 
         fwrite($statusFile, (string) $exitCode);
         fflush($statusFile);

composer.json

@@ -19,10 +19,10 @@
     "require": {
         "php": "^8.1.0",
         "brianium/paratest": "^7.1.2",
-        "nunomaduro/collision": "^7.3.3",
+        "nunomaduro/collision": "^7.4.0",
         "nunomaduro/termwind": "^1.15.1",
         "pestphp/pest-plugin": "^2.0.1",
-        "pestphp/pest-plugin-arch": "^2.0.2",
+        "pestphp/pest-plugin-arch": "^2.1.1",
         "phpunit/phpunit": "^10.0.19"
     },
     "conflict": {
@@ -41,6 +41,7 @@
     "autoload-dev": {
         "psr-4": {
             "Tests\\Fixtures\\Covers\\": "tests/Fixtures/Covers",
+            "Tests\\Fixtures\\Inheritance\\": "tests/Fixtures/Inheritance",
             "Tests\\": "tests/PHPUnit/"
         },
         "files": [
@@ -48,8 +49,8 @@
         ]
     },
     "require-dev": {
-        "pestphp/pest-dev-tools": "^2.5.0",
-        "symfony/process": "^6.2.7"
+        "pestphp/pest-dev-tools": "^2.6.0",
+        "symfony/process": "^6.2.8"
     },
     "minimum-stability": "stable",
     "config": {

overrides/Event/Value/ThrowableBuilder.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace PHPUnit\Event\Code;
+
+use NunoMaduro\Collision\Contracts\RenderableOnCollisionEditor;
+use PHPUnit\Event\NoPreviousThrowableException;
+use PHPUnit\Framework\Exception;
+use PHPUnit\Util\Filter;
+use PHPUnit\Util\ThrowableToStringMapper;
+
+/**
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ */
+final class ThrowableBuilder
+{
+    /**
+     * @throws Exception
+     * @throws NoPreviousThrowableException
+     */
+    public static function from(\Throwable $t): Throwable
+    {
+        $previous = $t->getPrevious();
+
+        if ($previous !== null) {
+            $previous = self::from($previous);
+        }
+
+        $trace = Filter::getFilteredStacktrace($t);
+
+        if ($t instanceof RenderableOnCollisionEditor && $frame = $t->toCollisionEditor()) {
+            $file = $frame->getFile();
+            $line = $frame->getLine();
+
+            $trace = "$file:$line\n$trace";
+        }
+
+        return new Throwable(
+            $t::class,
+            $t->getMessage(),
+            ThrowableToStringMapper::map($t),
+            $trace,
+            $previous
+        );
+    }
+}

phpunit.xml

@@ -18,6 +18,7 @@
       <directory suffix=".php">./tests</directory>
       <exclude>./tests/.snapshots</exclude>
       <exclude>./tests/.tests</exclude>
+      <exclude>./tests/Fixtures/Inheritance</exclude>
     </testsuite>
   </testsuites>
   <coverage>

src/Bootstrappers/BootOverrides.php

@@ -24,6 +24,7 @@ final class BootOverrides implements Bootstrapper
         'TextUI/Command/WarmCodeCoverageCacheCommand.php',
         'TextUI/Output/Default/ProgressPrinter/TestSkippedSubscriber.php',
         'TextUI/TestSuiteFilterProcessor.php',
+        'Event/Value/ThrowableBuilder.php',
     ];
 
     /**

src/Logging/TeamCity/Converter.php

@@ -166,6 +166,14 @@ final class Converter
         return $this->toRelativePath($path);
     }
 
+    /**
+     * Gets the test suite size.
+     */
+    public function getTestSuiteSize(TestSuite $testSuite): int
+    {
+        return $testSuite->count();
+    }
+
     /**
      * Transforms the given path in relative path.
      */

src/Logging/TeamCity/ServiceMessage.php

@@ -40,6 +40,13 @@ final class ServiceMessage
         ]);
     }
 
+    public static function testSuiteCount(int $count): self
+    {
+        return new self('testCount', [
+            'count' => $count,
+        ]);
+    }
+
     public static function testSuiteFinished(string $name): self
     {
         return new self('testSuiteFinished', [

src/Logging/TeamCity/TeamCityLogger.php

@@ -44,6 +44,8 @@ final class TeamCityLogger
 {
     private ?HRTime $time = null;
 
+    private bool $isSummaryTestCountPrinted = false;
+
     /**
      * @throws EventFacadeIsSealedException
      * @throws UnknownSubscriberTypeException
@@ -66,6 +68,15 @@ final class TeamCityLogger
         );
 
         $this->output($message);
+
+        if (! $this->isSummaryTestCountPrinted) {
+            $this->isSummaryTestCountPrinted = true;
+            $message = ServiceMessage::testSuiteCount(
+                $this->converter->getTestSuiteSize($event->testSuite())
+            );
+
+            $this->output($message);
+        }
     }
 
     public function testSuiteFinished(TestSuiteFinished $event): void

src/Mixins/Expectation.php

@@ -296,8 +296,8 @@ final class Expectation
      */
     public function toHaveProperties(iterable $names, string $message = ''): self
     {
-        foreach ($names as $name) {
-            $this->toHaveProperty($name, message: $message);
+        foreach ($names as $name => $value) {
+            is_int($name) ? $this->toHaveProperty($value, message: $message) : $this->toHaveProperty($name, $value, $message);
         }
 
         return $this;

src/PendingCalls/TestCall.php

@@ -172,6 +172,40 @@ final class TestCall
         return $this;
     }
 
+    /**
+     * Skips the current test if the given test is running on Windows.
+     */
+    public function skipOnWindows(): self
+    {
+        return $this->skipOn('Windows', 'This test is skipped on [Windows].');
+    }
+
+    /**
+     * Skips the current test if the given test is running on Mac OS.
+     */
+    public function skipOnMac(): self
+    {
+        return $this->skipOn('Darwin', 'This test is skipped on [Mac].');
+    }
+
+    /**
+     * Skips the current test if the given test is running on Linux.
+     */
+    public function skipOnLinux(): self
+    {
+        return $this->skipOn('Linux', 'This test is skipped on [Linux].');
+    }
+
+    /**
+     * Skips the current test if the given test is running on the given operating systems.
+     */
+    private function skipOn(string $osFamily, string $message): self
+    {
+        return PHP_OS_FAMILY === $osFamily
+            ? $this->skip($message)
+            : $this;
+    }
+
     /**
      * Sets the test as "todo".
      */

src/Pest.php

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

src/Support/Backtrace.php

@@ -30,7 +30,10 @@ final class Backtrace
 
             $traceFile = str_replace(DIRECTORY_SEPARATOR, '/', $trace[self::FILE]);
 
-            if (Str::endsWith($traceFile, 'overrides/Runner/TestSuiteLoader.php')) {
+            if (
+                Str::endsWith($traceFile, 'overrides/Runner/TestSuiteLoader.php') ||
+                Str::endsWith($traceFile, 'src/Bootstrappers/BootFiles.php')
+            ) {
                 break;
             }
 

src/Support/ExceptionTrace.php

@@ -33,7 +33,7 @@ final class ExceptionTrace
                 $message = str_replace(self::UNDEFINED_METHOD, 'Call to undefined method ', $message);
 
                 if (class_exists($class) && count(class_parents($class)) > 0 && array_values(class_parents($class))[0] === TestCase::class) {
-                    $message .= '. Did you forget to use the [uses()] function? https://pestphp.com/docs/configuring-tests';
+                    $message .= '. Did you forget to use the [uses()] function? Read more at: https://pestphp.com/docs/configuring-tests';
                 }
 
                 Reflection::setPropertyValue($throwable, 'message', $message);

tests/.snapshots/Failure.php.inc

@@ -1,4 +1,5 @@
 ##teamcity[testSuiteStarted name='Tests/tests/Failure' locationHint='file://tests/.tests/Failure.php' flowId='1234']
+##teamcity[testCount count='6' flowId='1234']
 ##teamcity[testStarted name='it can fail with comparison' locationHint='pest_qn://tests/.tests/Failure.php::it can fail with comparison' flowId='1234']
 ##teamcity[testFailed name='it can fail with comparison' message='Failed asserting that true matches expected false.' details='at src/Mixins/Expectation.php:343|nat src/Support/ExpectationPipeline.php:75|nat src/Support/ExpectationPipeline.php:79|nat src/Expectation.php:300|nat tests/.tests/Failure.php:6|nat src/Factories/TestCaseMethodFactory.php:100|nat src/Concerns/Testable.php:302|nat src/Support/ExceptionTrace.php:28|nat src/Concerns/Testable.php:302|nat src/Concerns/Testable.php:221|nat src/Kernel.php:86' type='comparisonFailure' actual='true' expected='false' flowId='1234']
 ##teamcity[testFinished name='it can fail with comparison' duration='100000' flowId='1234']

tests/.snapshots/SuccessOnly.php.inc

@@ -1,4 +1,5 @@
 ##teamcity[testSuiteStarted name='Tests/tests/SuccessOnly' locationHint='file://tests/.tests/SuccessOnly.php' flowId='1234']
+##teamcity[testCount count='2' flowId='1234']
 ##teamcity[testStarted name='it can pass with comparison' locationHint='pest_qn://tests/.tests/SuccessOnly.php::it can pass with comparison' flowId='1234']
 ##teamcity[testFinished name='it can pass with comparison' duration='100000' flowId='1234']
 ##teamcity[testStarted name='can also pass' locationHint='pest_qn://tests/.tests/SuccessOnly.php::can also pass' flowId='1234']

tests/.snapshots/allows-to-run-a-directory.txt

@@ -8,4 +8,10 @@
    PASS  Tests\Fixtures\ExampleTest
   ✓ it example 2
 
-  Tests:    2 skipped, 2 passed (2 assertions)
+   WARN  Tests\Fixtures\Inheritance\Base\ExampleTest
+  - example
+
+   PASS  Tests\Fixtures\Inheritance\ExampleTest
+  ✓ example
+
+  Tests:    3 skipped, 3 passed (3 assertions)

tests/.snapshots/collision-parallel.txt

@@ -1,5 +1,5 @@
 
-  ⨯.
+  .⨯.
   ────────────────────────────────────────────────────────────────────────────  
    FAILED  Tests\Fixtures\CollisionTest > error                     Exception   
   error
@@ -19,4 +19,4 @@
   2   src/Factories/TestCaseMethodFactory.php:100
 
 
-  Tests:    1 failed, 1 passed (1 assertions)
+  Tests:    1 failed, 2 passed (2 assertions)

tests/.snapshots/help-command.txt

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

tests/.snapshots/success.txt

@@ -673,6 +673,7 @@
   ✓ it throws error if method do not exist
   ✓ it can forward unexpected calls to any global function
   ✓ it can use helpers from helpers file
+  ✓ it can use helpers from helpers directory
 
    PASS  Tests\Features\HigherOrderTests
   ✓ it proxies calls to object
@@ -789,6 +790,9 @@
    PASS  Tests\Fixtures\ExampleTest
   ✓ it example 2
 
+   PASS  Tests\Helpers\TestInHelpers
+  ✓ it executes tests in the Helpers directory
+
    PASS  Tests\Hooks\AfterAllTest
   ✓ global afterAll execution order
   ✓ it only gets called once per file
@@ -864,6 +868,9 @@
   ✓ it throw expectation failed exception with string argument
   ✓ it throw expectation failed exception with array argument
 
+   PASS  Tests\Unit\Overrides\ThrowableBuilder
+  ✓ collision editor can be added to the stack trace
+
    PASS  Tests\Unit\Plugins\Environment
   ✓ environment is set to CI when --ci option is used
   ✓ environment is set to Local when --ci option is not used
@@ -988,6 +995,7 @@
 
    PASS  Tests\Visual\Parallel
   ✓ parallel
+  ✓ a parallel test can extend another test with same name
 
    PASS  Tests\Visual\SingleTestOrDirectory
   ✓ allows to run a single test
@@ -1008,4 +1016,4 @@
    PASS  Tests\Visual\Version
   ✓ visual snapshot of help command output
 
-  Tests:    2 deprecated, 3 warnings, 4 incomplete, 1 notice, 4 todos, 14 skipped, 705 passed (1706 assertions)
+  Tests:    2 deprecated, 3 warnings, 4 incomplete, 1 notice, 4 todos, 14 skipped, 709 passed (1717 assertions)

tests/.snapshots/version-command.txt

@@ -1,3 +1,3 @@
 
-  Pest Testing Framework 2.3.0.  
+  Pest Testing Framework 2.4.0.  
 

tests/Features/Expect/toHaveProperties.php

@@ -4,30 +4,49 @@ use PHPUnit\Framework\ExpectationFailedException;
 
 test('pass', function () {
     $object = new stdClass();
-    $object->name = 'Jhon';
+    $object->name = 'John';
     $object->age = 21;
 
-    expect($object)->toHaveProperties(['name', 'age']);
+    expect($object)
+        ->toHaveProperties(['name', 'age'])
+        ->toHaveProperties([
+            'name' => 'John',
+            'age' => 21,
+        ]);
 });
 
 test('failures', function () {
     $object = new stdClass();
-    $object->name = 'Jhon';
+    $object->name = 'John';
 
-    expect($object)->toHaveProperties(['name', 'age']);
+    expect($object)
+        ->toHaveProperties(['name', 'age'])
+        ->toHaveProperties([
+            'name' => 'John',
+            'age' => 21,
+        ]);
 })->throws(ExpectationFailedException::class);
 
 test('failures with custom message', function () {
     $object = new stdClass();
-    $object->name = 'Jhon';
+    $object->name = 'John';
 
-    expect($object)->toHaveProperties(['name', 'age'], 'oh no!');
+    expect($object)
+        ->toHaveProperties(['name', 'age'], 'oh no!')
+        ->toHaveProperties([
+            'name' => 'John',
+            'age' => 21,
+        ], 'oh no!');
 })->throws(ExpectationFailedException::class, 'oh no!');
 
 test('not failures', function () {
     $object = new stdClass();
-    $object->name = 'Jhon';
+    $object->name = 'John';
     $object->age = 21;
 
-    expect($object)->not->toHaveProperties(['name', 'age']);
+    expect($object)->not->toHaveProperties(['name', 'age'])
+        ->not->toHaveProperties([
+            'name' => 'John',
+            'age' => 21,
+        ]);
 })->throws(ExpectationFailedException::class);

tests/Features/Helpers.php

@@ -44,3 +44,5 @@ it('throws error if method do not exist', function () {
 it('can forward unexpected calls to any global function')->_assertThat();
 
 it('can use helpers from helpers file')->myAssertTrue(true);
+
+it('can use helpers from helpers directory')->myDirectoryAssertTrue(true);

tests/Fixtures/Inheritance/Base/ExampleTest.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Tests\Fixtures\Inheritance\Base;
+
+use PHPUnit\Framework\TestCase;
+
+class ExampleTest extends TestCase
+{
+    public function testExample()
+    {
+        $this->markTestSkipped();
+    }
+}

tests/Fixtures/Inheritance/ExampleTest.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Tests\Fixtures\Inheritance;
+
+class ExampleTest extends Base\ExampleTest
+{
+    public function testExample()
+    {
+        $this->assertTrue(true);
+    }
+}

tests/Helpers/Helper.php

@@ -0,0 +1,6 @@
+<?php
+
+function myDirectoryAssertTrue($value)
+{
+    test()->assertTrue($value);
+}

tests/Helpers/TestInHelpers.php

@@ -0,0 +1,5 @@
+<?php
+
+it('executes tests in the Helpers directory', function () {
+    expect(true)->toBeTrue();
+});

tests/Unit/Overrides/ThrowableBuilder.php

@@ -0,0 +1,28 @@
+<?php
+
+use NunoMaduro\Collision\Contracts\RenderableOnCollisionEditor;
+use PHPUnit\Event\Code\ThrowableBuilder;
+use Whoops\Exception\Frame;
+
+test('collision editor can be added to the stack trace', function () {
+    $exception = new class extends Exception implements RenderableOnCollisionEditor
+    {
+        public function __construct()
+        {
+            parent::__construct('test exception');
+        }
+
+        public function toCollisionEditor(): Frame
+        {
+            return new Frame([
+                'file' => __DIR__.'/../../Pest.php',
+                'line' => 5,
+            ]);
+        }
+    };
+
+    expect(str_replace(DIRECTORY_SEPARATOR, '/', ThrowableBuilder::from($exception)->stackTrace()))
+        ->toContain('tests/Unit/Overrides/../../Pest.php:5')
+        ->and(str_replace(DIRECTORY_SEPARATOR, '/', ThrowableBuilder::from(new Exception('test'))->stackTrace()))
+        ->toContain('tests/Unit/Overrides/ThrowableBuilder.php:26');
+});

tests/Unit/Support/ExceptionTrace.php

@@ -17,5 +17,5 @@ it('ensures the given closures reports the correct class name and suggests the [
     $this->get();
 })->throws(
     Error::class,
-    'Call to undefined method Tests\Unit\Support\ExceptionTrace::get(). Did you forget to use the [uses()] function? https://pestphp.com/docs/configuring-tests',
+    'Call to undefined method Tests\Unit\Support\ExceptionTrace::get(). Did you forget to use the [uses()] function? Read more at: https://pestphp.com/docs/configuring-tests',
 );

tests/Visual/Collision.php

@@ -39,4 +39,4 @@ test('collision', function (array $arguments) {
 })->with([
     [['']],
     [['--parallel']],
-])->skip(PHP_OS_FAMILY === 'Windows');
+])->skipOnWindows();

tests/Visual/Help.php

@@ -18,4 +18,4 @@ test('visual snapshot of help command output', function () {
     }
 
     expect($output())->toContain(file_get_contents($snapshot));
-})->skip(PHP_OS_FAMILY === 'Windows');
+})->skipOnWindows();

tests/Visual/Parallel.php

@@ -3,7 +3,9 @@
 use Symfony\Component\Process\Process;
 
 $run = function () {
-    $process = new Process(['php', 'bin/pest', '--parallel', '--processes=3', '--exclude-group=integration'], dirname(__DIR__, 2),
+    $process = new Process(
+        array_merge(['php', 'bin/pest', '--parallel', '--processes=3'], func_get_args()),
+        dirname(__DIR__, 2),
         ['COLLISION_PRINTER' => 'DefaultPrinter', 'COLLISION_IGNORE_DURATION' => 'true'],
     );
 
@@ -15,6 +17,11 @@ $run = function () {
 };
 
 test('parallel', function () use ($run) {
-    expect($run())->toContain('Tests:    2 deprecated, 3 warnings, 4 incomplete, 1 notice, 4 todos, 11 skipped, 694 passed (1692 assertions)')
+    expect($run('--exclude-group=integration'))
+        ->toContain('Tests:    2 deprecated, 3 warnings, 4 incomplete, 1 notice, 4 todos, 11 skipped, 697 passed (1702 assertions)')
         ->toContain('Parallel: 3 processes');
-})->skip(PHP_OS_FAMILY === 'Windows');
+})->skipOnWindows();
+
+test('a parallel test can extend another test with same name', function () use ($run) {
+    expect($run('tests/Fixtures/Inheritance'))->toContain('Tests:    1 skipped, 2 passed (2 assertions)');
+});

tests/Visual/SingleTestOrDirectory.php

@@ -24,11 +24,11 @@ $snapshot = function ($name) {
 
 test('allows to run a single test', function () use ($run, $snapshot) {
     expect($run('tests/Fixtures/DirectoryWithTests/ExampleTest.php'))->toContain($snapshot('allows-to-run-a-single-test'));
-})->skip(PHP_OS_FAMILY === 'Windows');
+})->skipOnWindows();
 
 test('allows to run a directory', function () use ($run, $snapshot) {
     expect($run('tests/Fixtures'))->toContain($snapshot('allows-to-run-a-directory'));
-})->skip(PHP_OS_FAMILY === 'Windows');
+})->skipOnWindows();
 
 it('disable decorating printer when colors is set to never', function () use ($snapshot) {
     $process = new Process([
@@ -40,4 +40,4 @@ it('disable decorating printer when colors is set to never', function () use ($s
     $process->run();
     $output = $process->getOutput();
     expect($output)->toContain($snapshot('disable-decorating-printer'));
-})->skip(PHP_OS_FAMILY === 'Windows');
+})->skipOnWindows();

tests/Visual/Success.php

@@ -41,4 +41,4 @@ test('visual snapshot of test suite on success', function () {
         expect(implode("\n", $output))->toContain(file_get_contents($snapshot));
     }
 })->skip(! getenv('REBUILD_SNAPSHOTS') && getenv('EXCLUDE'))
-    ->skip(PHP_OS_FAMILY === 'Windows');
+    ->skipOnWindows();

tests/Visual/Todo.php

@@ -26,8 +26,8 @@ $snapshot = function ($name) {
 
 test('todo', function () use ($run, $snapshot) {
     expect($run('--todos', false))->toContain($snapshot('todo'));
-})->skip(PHP_OS_FAMILY === 'Windows');
+})->skipOnWindows();
 
 test('todo in parallel', function () use ($run, $snapshot) {
     expect($run('--todos', true))->toContain($snapshot('todo'));
-})->skip(PHP_OS_FAMILY === 'Windows');
+})->skipOnWindows();

tests/Visual/Version.php

@@ -18,4 +18,4 @@ test('visual snapshot of help command output', function () {
     }
 
     expect($output())->toContain(file_get_contents($snapshot));
-})->skip(PHP_OS_FAMILY === 'Windows');
+})->skipOnWindows();