Update Pest.php

Improve exception output in teamcity printer

.github/workflows/changelog.yml

@@ -5,6 +5,7 @@ on:
     branches: [ master ]
     paths:
       - CHANGELOG.md
+      - .github/workflows/changelog.yml
   pull_request:
     branches: [ master ]
     paths:
@@ -13,19 +14,25 @@ jobs:
   build:
     runs-on: ubuntu-latest
 
+    if: github.repository == 'pestphp/pest'
+
     steps:
     - uses: actions/checkout@v2
+
     - name: Checkout website repository
       uses: actions/checkout@v2
       with:
         token: ${{ secrets.CHANGELOG_KEY }}
-        repository: pestphp/website
-        path: pestphp-website
+        repository: pestphp/docs
+        path: pestphp-docs
+        ref: master
+
     - name: Read CHANGELOG.md
       id: package
       uses: juliangruber/read-file-action@v1
       with:
         path: ./CHANGELOG.md
+
     - name: Add file headers
       uses: DamianReeves/write-file-action@v1.0
       with:
@@ -34,8 +41,6 @@ jobs:
           ---
           title: Changelog
           description: Changelog
-          extends: _layouts.documentation
-          section: content
           ---
           ${{ steps.package.outputs.content }}
 
@@ -43,14 +48,16 @@ jobs:
 
           Next section: [Upgrade Guide →](/docs/upgrade-guide)
         write-mode: overwrite
+
     - name: Copy CHANGELOG to website repository
-      run: cp CHANGELOG.md pestphp-website/source/docs/changelog.md
+      run: cp CHANGELOG.md pestphp-docs/changelog.md
+
     - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v2
+      uses: peter-evans/create-pull-request@v3
       with:
         token: ${{ secrets.CHANGELOG_KEY }}
         commit-message: Update changelog.md
         committer: GitHub Action <noreply@github.com>
         author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
         title: 'Update changelog.md'
-        path: ./pestphp-website
+        path: ./pestphp-docs

CHANGELOG.md

@@ -4,7 +4,47 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+## [v0.3.11 (2020-11-09)](https://github.com/pestphp/pest/compare/v0.3.10...v0.3.11)
+### Changed
+- Improved the exception output for the TeamCity printer (usage with phpstorm plugin) ([#215](https://github.com/pestphp/pest/pull/215))
+
+## [v0.3.10 (2020-11-01)](https://github.com/pestphp/pest/compare/v0.3.9...v0.3.10)
+### Added
+- Add support for PHPUnit 9.4.2 ([d177ab5](https://github.com/pestphp/pest/commit/d177ab5ec2030c5bb8e418d10834c370c94c433d))
+
+## [v0.3.9 (2020-10-13)](https://github.com/pestphp/pest/compare/v0.3.8...v0.3.9)
+### Added
+- Add support for named datasets in description output ([#134](https://github.com/pestphp/pest/pull/134))
+- Add Pest version to `--help` output ([#203](https://github.com/pestphp/pest/pull/203))
+- Add support for PHPUnit 9.4.1 ([#207](https://github.com/pestphp/pest/pull/207))
+
+## [v0.3.8 (2020-10-03)](https://github.com/pestphp/pest/compare/v0.3.7...v0.3.8)
+### Added
+- Add support for PHPUnit 9.4.0 ([#199](https://github.com/pestphp/pest/pull/199))
+
+### Fixed
+- Fix chained higher order assertions returning void ([#196](https://github.com/pestphp/pest/pull/196))
+
+## [v0.3.7 (2020-09-30)](https://github.com/pestphp/pest/compare/v0.3.6...v0.3.7)
+### Added
+- Add support for PHPUnit 9.3.11 ([#193](https://github.com/pestphp/pest/pull/193))
+
+## [v0.3.6 (2020-09-21)](https://github.com/pestphp/pest/compare/v0.3.5...v0.3.6)
+### Added
+- `toMatch` expectation ([#191](https://github.com/pestphp/pest/pull/191))
+- `toMatchConstraint` expectation ([#190](https://github.com/pestphp/pest/pull/190))
+
+## [v0.3.5 (2020-09-16)](https://github.com/pestphp/pest/compare/v0.3.4...v0.3.5)
+### Added
+- `toStartWith` and `toEndWith` expectations ([#187](https://github.com/pestphp/pest/pull/187))
+
+## [v0.3.4 (2020-09-15)](https://github.com/pestphp/pest/compare/v0.3.3...v0.3.4)
+### Added
+- `toMatchObject` expectation ([4e184b2](https://github.com/pestphp/pest/commit/4e184b2f906c318a5e9cd38fe693cdab5c48d8a2))
+
+## [v0.3.3 (2020-09-13)](https://github.com/pestphp/pest/compare/v0.3.2...v0.3.3)
+### Added
+- `toHaveKeys` expectation ([204f343](https://github.com/pestphp/pest/commit/204f343831adc17bb3734553c24fac92d02f27c7))
 
 ## [v0.3.2 (2020-09-12)](https://github.com/pestphp/pest/compare/v0.3.1...v0.3.2)
 ### Added

composer.json

@@ -22,7 +22,7 @@
         "pestphp/pest-plugin": "^0.3",
         "pestphp/pest-plugin-coverage": "^0.3",
         "pestphp/pest-plugin-init": "^0.3",
-        "phpunit/phpunit": "9.3.7 || 9.3.8 || 9.3.9 || 9.3.10"
+        "phpunit/phpunit": ">= 9.3.7 <= 9.4.2"
     },
     "autoload": {
         "psr-4": {

phpunit.xml

@@ -8,8 +8,8 @@
             <directory suffix=".php">./tests</directory>
         </testsuite>
     </testsuites>
-    <coverage>
-        <include processUncoveredFiles="true">
+    <coverage processUncoveredFiles="true">
+        <include>
             <directory suffix=".php">./src</directory>
         </include>
     </coverage>

src/Console/Command.php

@@ -11,6 +11,8 @@ use Pest\Actions\ValidatesConfiguration;
 use Pest\Contracts\Plugins\AddsOutput;
 use Pest\Contracts\Plugins\HandlesArguments;
 use Pest\Plugin\Loader;
+use Pest\Plugins\Version;
+use Pest\Support\Container;
 use Pest\TestSuite;
 use PHPUnit\Framework\TestSuite as BaseTestSuite;
 use PHPUnit\TextUI\Command as BaseCommand;
@@ -139,4 +141,12 @@ final class Command extends BaseCommand
 
         exit($result);
     }
+
+    protected function showHelp(): void
+    {
+        /** @var Version $version */
+        $version = Container::getInstance()->get(Version::class);
+        $version->handleArguments(['--version']);
+        parent::showHelp();
+    }
 }

src/Datasets.php

@@ -77,10 +77,10 @@ final class Datasets
         $dataSetDescriptions = [];
         $dataSetValues       = [];
 
-        foreach ($data as $values) {
+        foreach ($data as $key => $values) {
             $values = is_array($values) ? $values : [$values];
 
-            $dataSetDescriptions[] = $description . self::getDataSetDescription($values);
+            $dataSetDescriptions[] = $description . self::getDataSetDescription($key, $values);
             $dataSetValues[]       = $values;
         }
 
@@ -104,12 +104,15 @@ final class Datasets
     }
 
     /**
+     * @param int|string        $key
      * @param array<int, mixed> $data
      */
-    private static function getDataSetDescription(array $data): string
+    private static function getDataSetDescription($key, array $data): string
     {
         $exporter = new Exporter();
 
-        return \sprintf(' with (%s)', $exporter->shortenedRecursiveExport($data));
+        $nameInsert = is_string($key) ? \sprintf('data set "%s" ', $key) : '';
+
+        return \sprintf(' with %s(%s)', $nameInsert, $exporter->shortenedRecursiveExport($data));
     }
 }

src/Expectation.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Pest;
 
 use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\Constraint\Constraint;
 
 /**
  * @internal
@@ -158,6 +159,26 @@ final class Expectation
         return $this;
     }
 
+    /**
+     * Asserts that the value starts with $expected.
+     */
+    public function toStartWith(string $expected): Expectation
+    {
+        Assert::assertStringStartsWith($expected, $this->value);
+
+        return $this;
+    }
+
+    /**
+     * Asserts that the value ends with $expected.
+     */
+    public function toEndWith(string $expected): Expectation
+    {
+        Assert::assertStringEndsWith($expected, $this->value);
+
+        return $this;
+    }
+
     /**
      * Asserts that $count matches the number of elements of the value.
      */
@@ -170,11 +191,20 @@ final class Expectation
 
     /**
      * Asserts that the value contains the property $name.
+     *
+     * @param mixed $value
      */
-    public function toHaveProperty(string $name): Expectation
+    public function toHaveProperty(string $name, $value = null): Expectation
     {
+        $this->toBeObject();
+
         Assert::assertTrue(property_exists($this->value, $name));
 
+        if (func_num_args() > 1) {
+            /* @phpstan-ignore-next-line */
+            Assert::assertEquals($value, $this->value->{$name});
+        }
+
         return $this;
     }
 
@@ -376,14 +406,30 @@ final class Expectation
 
     /**
      * Asserts that the value array has the provided $key.
+     *
+     * @param string|int $key
      */
-    public function toHaveKey(string $key): Expectation
+    public function toHaveKey($key): Expectation
     {
         Assert::assertArrayHasKey($key, $this->value);
 
         return $this;
     }
 
+    /**
+     * Asserts that the value array has the provided $keys.
+     *
+     * @param array<int, int|string> $keys
+     */
+    public function toHaveKeys(array $keys): Expectation
+    {
+        foreach ($keys as $key) {
+            $this->toHaveKey($key);
+        }
+
+        return $this;
+    }
+
     /**
      * Asserts that the value is a directory.
      */
@@ -444,6 +490,41 @@ final class Expectation
         return $this;
     }
 
+    /**
+     * Asserts that the value object matches a subset
+     * of the properties of an given object.
+     *
+     * @param array<string, mixed>|object $object
+     */
+    public function toMatchObject($object): Expectation
+    {
+        foreach ((array) $object as $property => $value) {
+            $this->toHaveProperty($property, $value);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Asserts that the value matches a regular expression.
+     */
+    public function toMatch(string $expression): Expectation
+    {
+        Assert::assertMatchesRegularExpression($expression, $this->value);
+
+        return $this;
+    }
+
+    /**
+     * Asserts that the value matches a constraint.
+     */
+    public function toMatchConstraint(Constraint $constraint): Expectation
+    {
+        Assert::assertThat($this->value, $constraint);
+
+        return $this;
+    }
+
     /**
      * Dynamically calls methods on the class without any arguments.
      *

src/OppositeExpectation.php

@@ -27,6 +27,26 @@ final class OppositeExpectation
         $this->original = $original;
     }
 
+    /**
+     * Asserts that the value array not has the provided $keys.
+     *
+     * @param array<int, int|string> $keys
+     */
+    public function toHaveKeys(array $keys): Expectation
+    {
+        foreach ($keys as $key) {
+            try {
+                $this->original->toHaveKey($key);
+            } catch (ExpectationFailedException $e) {
+                continue;
+            }
+
+            $this->throwExpectationFailedExpection('toHaveKey', [$key]);
+        }
+
+        return $this->original;
+    }
+
     /**
      * Handle dynamic method calls into the original expectation.
      *

src/Pest.php

@@ -6,5 +6,5 @@ namespace Pest;
 
 function version(): string
 {
-    return '0.3.1';
+    return '0.3.11';
 }

src/Support/HigherOrderMessageCollection.php

@@ -30,7 +30,7 @@ final class HigherOrderMessageCollection
     public function chain(object $target): void
     {
         foreach ($this->messages as $message) {
-            $target = $message->call($target);
+            $target = $message->call($target) ?? $target;
         }
     }
 

src/TeamCity.php

@@ -24,7 +24,6 @@ final class TeamCity extends DefaultResultPrinter
     private const DURATION            = 'duration';
     private const TEST_SUITE_STARTED  = 'testSuiteStarted';
     private const TEST_SUITE_FINISHED = 'testSuiteFinished';
-    private const TEST_FAILED         = 'testFailed';
 
     /** @var int */
     private $flowId;
@@ -149,19 +148,7 @@ final class TeamCity extends DefaultResultPrinter
      */
     public function addError(Test $test, Throwable $t, float $time): void
     {
-        if (!TeamCity::isPestTest($test)) {
-            $this->phpunitTeamCity->addError($test, $t, $time);
-
-            return;
-        }
-
-        $this->printEvent(
-            self::TEST_FAILED, [
-            self::NAME     => $test->getName(),
-            'message'      => $t->getMessage(),
-            'details'      => $t->getTraceAsString(),
-            self::DURATION => self::toMilliseconds($time),
-        ]);
+        $this->phpunitTeamCity->addError($test, $t, $time);
     }
 
     /**
@@ -171,19 +158,7 @@ final class TeamCity extends DefaultResultPrinter
      */
     public function addWarning(Test $test, Warning $e, float $time): void
     {
-        if (!TeamCity::isPestTest($test)) {
-            $this->phpunitTeamCity->addWarning($test, $e, $time);
-
-            return;
-        }
-
-        $this->printEvent(
-            self::TEST_FAILED, [
-            self::NAME     => $test->getName(),
-            'message'      => $e->getMessage(),
-            'details'      => $e->getTraceAsString(),
-            self::DURATION => self::toMilliseconds($time),
-        ]);
+        $this->phpunitTeamCity->addWarning($test, $e, $time);
     }
 
     public function addFailure(Test $test, AssertionFailedError $e, float $time): void

stubs/Laravel/phpunit.xml

@@ -12,10 +12,10 @@
             <directory suffix="Test.php">./tests/Feature</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
+    <coverage processUncoveredFiles="true">
+        <include>
             <directory suffix=".php">./app</directory>
             <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </coverage>
 </phpunit>

stubs/Lumen/phpunit.xml

@@ -9,9 +9,9 @@
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
+    <coverage processUncoveredFiles="true">
+        <include>
             <directory suffix=".php">./app</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </coverage>
 </phpunit>

tests/.snapshots/success.txt

@@ -155,6 +155,11 @@
   ✓ passes strings
   ✓ passes arrays
   ✓ failures
+  ✓ not failures
+
+   PASS  Tests\Expect\toEndWith
+  ✓ pass
+  ✓ failures
   ✓ not failures
 
    PASS  Tests\Expect\toEqual
@@ -180,11 +185,36 @@
    PASS  Tests\Expect\toHaveKey
   ✓ pass
   ✓ failures
+  ✓ not failures
+
+   PASS  Tests\Expect\toHaveKeys
+  ✓ pass
+  ✓ failures
   ✓ not failures
 
    PASS  Tests\Expect\toHaveProperty
   ✓ pass
   ✓ failures
+  ✓ not failures
+
+   PASS  Tests\Expect\toMatch
+  ✓ pass
+  ✓ failures
+  ✓ not failures
+
+   PASS  Tests\Expect\toMatchConstraint
+  ✓ pass
+  ✓ failures
+  ✓ not failures
+
+   PASS  Tests\Expect\toMatchObject
+  ✓ pass
+  ✓ failures
+  ✓ not failures
+
+   PASS  Tests\Expect\toStartWith
+  ✓ pass
+  ✓ failures
   ✓ not failures
 
    PASS  Tests\Features\AfterAll
@@ -225,6 +255,9 @@
   ✓ eager wrapped registered datasets with (1)
   ✓ eager wrapped registered datasets with (2)
   ✓ eager registered wrapped datasets did the job right
+  ✓ named datasets with data set "one" (1)
+  ✓ named datasets with data set "two" (2)
+  ✓ named datasets did the job right
   ✓ lazy named datasets with (Bar Object (...))
   ✓ it creates unique test case names with ('Name 1', Pest\Plugin Object (), true) #1
   ✓ it creates unique test case names with ('Name 1', Pest\Plugin Object (), true) #2
@@ -248,6 +281,7 @@
 
    PASS  Tests\Features\HigherOrderTests
   ✓ it proxies calls to object
+  ✓ it is capable doing multiple assertions
 
    PASS  Tests\Features\It
   ✓ it is a test
@@ -272,6 +306,7 @@
   - it skips with truthy closure condition
   ✓ it do not skips with falsy closure condition
   - it skips with condition and message → skipped because foo
+  - it skips when skip after assertion
 
    PASS  Tests\Features\Test
   ✓ a test
@@ -313,6 +348,9 @@
   ✓ it throws exception when `process isolation` is true
   ✓ it do not throws exception when `process isolation` is false
 
+   PASS  Tests\Unit\Datasets
+  ✓ it show the names of named datasets in their description
+
    PASS  Tests\Unit\Plugins\Version
   ✓ it outputs the version when --version is used
   ✓ it do not outputs version when --version is not used
@@ -353,5 +391,5 @@
   ✓ depends with defined arguments
   ✓ depends run test only once
 
-  Tests:  6 skipped, 208 passed
+  Tests:  7 skipped, 231 passed
   

tests/Expect/toEndWith.php

@@ -0,0 +1,15 @@
+<?php
+
+use PHPUnit\Framework\ExpectationFailedException;
+
+test('pass', function () {
+    expect('username')->toEndWith('name');
+});
+
+test('failures', function () {
+    expect('username')->toEndWith('password');
+})->throws(ExpectationFailedException::class);
+
+test('not failures', function () {
+    expect('username')->not->toEndWith('name');
+})->throws(ExpectationFailedException::class);

tests/Expect/toHaveKeys.php

@@ -0,0 +1,15 @@
+<?php
+
+use PHPUnit\Framework\ExpectationFailedException;
+
+test('pass', function () {
+    expect(['a' => 1, 'b', 'c' => 'world'])->toHaveKeys(['a', 'c']);
+});
+
+test('failures', function () {
+    expect(['a' => 1, 'b', 'c' => 'world'])->toHaveKeys(['a', 'd']);
+})->throws(ExpectationFailedException::class);
+
+test('not failures', function () {
+    expect(['a' => 1, 'hello' => 'world', 'c'])->not->toHaveKeys(['hello', 'c']);
+})->throws(ExpectationFailedException::class);

tests/Expect/toHaveProperty.php

@@ -2,11 +2,15 @@
 
 use PHPUnit\Framework\ExpectationFailedException;
 
-$obj      = new stdClass();
-$obj->foo = 'bar';
+$obj          = new stdClass();
+$obj->foo     = 'bar';
+$obj->fooNull = null;
 
 test('pass', function () use ($obj) {
     expect($obj)->toHaveProperty('foo');
+    expect($obj)->toHaveProperty('foo', 'bar');
+    expect($obj)->toHaveProperty('fooNull');
+    expect($obj)->toHaveProperty('fooNull', null);
 });
 
 test('failures', function () use ($obj) {

tests/Expect/toMatch.php

@@ -0,0 +1,15 @@
+<?php
+
+use PHPUnit\Framework\ExpectationFailedException;
+
+test('pass', function () {
+    expect('Hello World')->toMatch('/^hello wo.*$/i');
+});
+
+test('failures', function () {
+    expect('Hello World')->toMatch('/^hello$/i');
+})->throws(ExpectationFailedException::class);
+
+test('not failures', function () {
+    expect('Hello World')->not->toMatch('/^hello wo.*$/i');
+})->throws(ExpectationFailedException::class);

tests/Expect/toMatchConstraint.php

@@ -0,0 +1,16 @@
+<?php
+
+use PHPUnit\Framework\Constraint\IsTrue;
+use PHPUnit\Framework\ExpectationFailedException;
+
+test('pass', function () {
+    expect(true)->toMatchConstraint(new IsTrue());
+});
+
+test('failures', function () {
+    expect(false)->toMatchConstraint(new IsTrue());
+})->throws(ExpectationFailedException::class);
+
+test('not failures', function () {
+    expect(true)->not->toMatchConstraint(new IsTrue());
+})->throws(ExpectationFailedException::class);

tests/Expect/toMatchObject.php

@@ -0,0 +1,31 @@
+<?php
+
+use PHPUnit\Framework\ExpectationFailedException;
+
+beforeEach(function () {
+    $this->user = (object) [
+        'id'    => 1,
+        'name'  => 'Nuno',
+        'email' => 'enunomaduro@gmail.com',
+    ];
+});
+
+test('pass', function () {
+    expect($this->user)->toMatchObject([
+        'name'  => 'Nuno',
+        'email' => 'enunomaduro@gmail.com',
+    ]);
+});
+
+test('failures', function () {
+    expect($this->user)->toMatchObject([
+        'name'  => 'Not the same name',
+        'email' => 'enunomaduro@gmail.com',
+    ]);
+})->throws(ExpectationFailedException::class);
+
+test('not failures', function () {
+    expect($this->user)->not->toMatchObject([
+        'id' => 1,
+    ]);
+})->throws(ExpectationFailedException::class);

tests/Expect/toStartWith.php

@@ -0,0 +1,15 @@
+<?php
+
+use PHPUnit\Framework\ExpectationFailedException;
+
+test('pass', function () {
+    expect('username')->toStartWith('user');
+});
+
+test('failures', function () {
+    expect('username')->toStartWith('password');
+})->throws(ExpectationFailedException::class);
+
+test('not failures', function () {
+    expect('username')->not->toStartWith('user');
+})->throws(ExpectationFailedException::class);

tests/Features/Datasets.php

@@ -95,6 +95,18 @@ test('eager registered wrapped datasets did the job right', function () use ($st
     expect($state->text)->toBe('1212121212');
 });
 
+test('named datasets', function ($text) use ($state, $datasets) {
+    $state->text .= $text;
+    expect($datasets)->toContain([$text]);
+})->with([
+    'one' => [1],
+    'two' => [2],
+]);
+
+test('named datasets did the job right', function () use ($state) {
+    expect($state->text)->toBe('121212121212');
+});
+
 class Bar
 {
     public $name = 1;

tests/Features/HigherOrderTests.php

@@ -4,4 +4,8 @@ beforeEach()->assertTrue(true);
 
 it('proxies calls to object')->assertTrue(true);
 
+it('is capable doing multiple assertions')
+    ->assertTrue(true)
+    ->assertFalse(false);
+
 afterEach()->assertTrue(true);

tests/Features/Skip.php

@@ -27,3 +27,7 @@ it('do not skips with falsy closure condition')
 it('skips with condition and message')
     ->skip(true, 'skipped because foo')
     ->assertTrue(false);
+
+it('skips when skip after assertion')
+    ->assertTrue(true)
+    ->skip();

tests/Unit/Datasets.php

@@ -0,0 +1,13 @@
+<?php
+
+use Pest\Datasets;
+
+it('show the names of named datasets in their description', function () {
+    $descriptions = array_keys(Datasets::resolve('test description', [
+        'one' => [1],
+        'two' => [[2]],
+    ]));
+
+    expect($descriptions[0])->toBe('test description with data set "one" (1)');
+    expect($descriptions[1])->toBe('test description with data set "two" (array(2))');
+});