Updates changelog

Fix/test key separator

CHANGELOG.md

@@ -4,6 +4,28 @@ 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/).
 
+## [v.1.3.2 (2021-06-07)](https://github.com/pestphp/pest/compare/v1.3.1...v1.3.2)
+### Fixed 
+- Test cases with the @ symbol in the directory fail ([#308](https://github.com/pestphp/pest/pull/308))
+
+## [v1.3.1 (2021-06-06)](https://github.com/pestphp/pest/compare/v1.3.0...v1.3.1)
+### Added
+- Added for PHPUnit 9.5.5 ([#310](https://github.com/pestphp/pest/pull/310))
+
+### Changed
+- Lock minimum Pest plugin versions ([#306](https://github.com/pestphp/pest/pull/306))
+
+## [v1.3.0 (2021-05-23)](https://github.com/pestphp/pest/compare/v1.2.1...v1.3.0)
+### Added
+- Named datasets no longer show the arguments ([#302](https://github.com/pestphp/pest/pull/302))
+
+### Fixed
+- Wraps global functions within `function_exists` ([#300](https://github.com/pestphp/pest/pull/300))
+
+## [v1.2.1 (2021-05-14)](https://github.com/pestphp/pest/compare/v1.2.0...v1.2.1)
+### Fixed
+- Laravel commands failing with new `--test-directory` option ([#297](https://github.com/pestphp/pest/pull/297))
+
 ## [v1.2.0 (2021-05-13)](https://github.com/pestphp/pest/compare/v1.1.0...v1.2.0)
 ### Added
 - Adds JUnit / Infection support ([#291](https://github.com/pestphp/pest/pull/291))

composer.json

@@ -21,9 +21,9 @@
         "nunomaduro/collision": "^5.0",
         "pestphp/pest-plugin": "^1.0",
         "pestphp/pest-plugin-coverage": "^1.0",
-        "pestphp/pest-plugin-expectations": "^1.0",
+        "pestphp/pest-plugin-expectations": "^1.3",
-        "pestphp/pest-plugin-init": "^1.0",
+        "pestphp/pest-plugin-init": "^1.1",
-        "phpunit/phpunit": ">= 9.3.7 <= 9.5.4"
+        "phpunit/phpunit": ">= 9.3.7 <= 9.5.5"
     },
     "autoload": {
         "psr-4": {
@@ -46,7 +46,6 @@
         "illuminate/console": "^8.32.1",
         "illuminate/support": "^8.32.1",
         "laravel/dusk": "^6.13.0",
-        "mockery/mockery": "^1.4.3",
         "pestphp/pest-dev-tools": "dev-master"
     },
     "minimum-stability": "dev",

src/Datasets.php

@@ -111,8 +111,10 @@ final class Datasets
     {
         $exporter = new Exporter();
 
-        $nameInsert = is_string($key) ? \sprintf('data set "%s" ', $key) : '';
+        if (is_int($key)) {
+            return \sprintf(' with (%s)', $exporter->shortenedRecursiveExport($data));
+        }
 
-        return \sprintf(' with %s(%s)', $nameInsert, $exporter->shortenedRecursiveExport($data));
+        return \sprintf(' with data set "%s"', $key);
     }
 }

src/Exceptions/MissingDependency.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Exceptions;
+
+use InvalidArgumentException;
+use NunoMaduro\Collision\Contracts\RenderlessEditor;
+use NunoMaduro\Collision\Contracts\RenderlessTrace;
+use Symfony\Component\Console\Exception\ExceptionInterface;
+
+/**
+ * @internal
+ */
+final class MissingDependency extends InvalidArgumentException implements ExceptionInterface, RenderlessEditor, RenderlessTrace
+{
+    /**
+     * Creates a new instance of missing dependency.
+     */
+    public function __construct(string $feature, string $dependency)
+    {
+        parent::__construct(sprintf('The feature "%s" requires "%s".', $feature, $dependency));
+    }
+}

src/Functions.php

@@ -12,95 +12,111 @@ use Pest\Support\HigherOrderTapProxy;
 use Pest\TestSuite;
 use PHPUnit\Framework\TestCase;
 
-/**
+if (!function_exists('beforeAll')) {
- * Runs the given closure before all tests in the current file.
+    /**
- */
+     * Runs the given closure before all tests in the current file.
-function beforeAll(Closure $closure): void
+     */
-{
+    function beforeAll(Closure $closure): void
-    TestSuite::getInstance()->beforeAll->set($closure);
+    {
-}
+        TestSuite::getInstance()->beforeAll->set($closure);
-
-/**
- * Runs the given closure before each test in the current file.
- *
- * @return BeforeEachCall|TestCase|mixed
- */
-function beforeEach(Closure $closure = null): BeforeEachCall
-{
-    $filename = Backtrace::file();
-
-    return new BeforeEachCall(TestSuite::getInstance(), $filename, $closure);
-}
-
-/**
- * Registers the given dataset.
- *
- * @param Closure|iterable<int|string, mixed> $dataset
- */
-function dataset(string $name, $dataset): void
-{
-    Datasets::set($name, $dataset);
-}
-
-/**
- * The uses function binds the given
- * arguments to test closures.
- */
-function uses(string ...$classAndTraits): UsesCall
-{
-    $filename = Backtrace::file();
-
-    return new UsesCall($filename, $classAndTraits);
-}
-
-/**
- * Adds the given closure as a test. The first argument
- * is the test description; the second argument is
- * a closure that contains the test expectations.
- *
- * @return TestCall|TestCase|mixed
- */
-function test(string $description = null, Closure $closure = null)
-{
-    if ($description === null && TestSuite::getInstance()->test !== null) {
-        return new HigherOrderTapProxy(TestSuite::getInstance()->test);
     }
-
-    $filename = Backtrace::testFile();
-
-    return new TestCall(TestSuite::getInstance(), $filename, $description, $closure);
 }
 
-/**
+if (!function_exists('beforeEach')) {
- * Adds the given closure as a test. The first argument
+    /**
- * is the test description; the second argument is
+     * Runs the given closure before each test in the current file.
- * a closure that contains the test expectations.
+     *
- *
+     * @return BeforeEachCall|TestCase|mixed
- * @return TestCall|TestCase|mixed
+     */
- */
+    function beforeEach(Closure $closure = null): BeforeEachCall
-function it(string $description, Closure $closure = null): TestCall
+    {
-{
+        $filename = Backtrace::file();
-    $description = sprintf('it %s', $description);
 
-    return test($description, $closure);
+        return new BeforeEachCall(TestSuite::getInstance(), $filename, $closure);
+    }
 }
 
-/**
+if (!function_exists('dataset')) {
- * Runs the given closure after each test in the current file.
+    /**
- *
+     * Registers the given dataset.
- * @return AfterEachCall|TestCase|mixed
+     *
- */
+     * @param Closure|iterable<int|string, mixed> $dataset
-function afterEach(Closure $closure = null): AfterEachCall
+     */
-{
+    function dataset(string $name, $dataset): void
-    $filename = Backtrace::file();
+    {
-
+        Datasets::set($name, $dataset);
-    return new AfterEachCall(TestSuite::getInstance(), $filename, $closure);
+    }
 }
 
-/**
+if (!function_exists('uses')) {
- * Runs the given closure after all tests in the current file.
+    /**
- */
+     * The uses function binds the given
-function afterAll(Closure $closure): void
+     * arguments to test closures.
-{
+     */
-    TestSuite::getInstance()->afterAll->set($closure);
+    function uses(string ...$classAndTraits): UsesCall
+    {
+        $filename = Backtrace::file();
+
+        return new UsesCall($filename, $classAndTraits);
+    }
+}
+
+if (!function_exists('test')) {
+    /**
+     * Adds the given closure as a test. The first argument
+     * is the test description; the second argument is
+     * a closure that contains the test expectations.
+     *
+     * @return TestCall|TestCase|mixed
+     */
+    function test(string $description = null, Closure $closure = null)
+    {
+        if ($description === null && TestSuite::getInstance()->test !== null) {
+            return new HigherOrderTapProxy(TestSuite::getInstance()->test);
+        }
+
+        $filename = Backtrace::testFile();
+
+        return new TestCall(TestSuite::getInstance(), $filename, $description, $closure);
+    }
+}
+
+if (!function_exists('it')) {
+    /**
+     * Adds the given closure as a test. The first argument
+     * is the test description; the second argument is
+     * a closure that contains the test expectations.
+     *
+     * @return TestCall|TestCase|mixed
+     */
+    function it(string $description, Closure $closure = null): TestCall
+    {
+        $description = sprintf('it %s', $description);
+
+        return test($description, $closure);
+    }
+}
+
+if (!function_exists('afterEach')) {
+    /**
+     * Runs the given closure after each test in the current file.
+     *
+     * @return AfterEachCall|TestCase|mixed
+     */
+    function afterEach(Closure $closure = null): AfterEachCall
+    {
+        $filename = Backtrace::file();
+
+        return new AfterEachCall(TestSuite::getInstance(), $filename, $closure);
+    }
+}
+
+if (!function_exists('afterAll')) {
+    /**
+     * Runs the given closure after all tests in the current file.
+     */
+    function afterAll(Closure $closure): void
+    {
+        TestSuite::getInstance()->afterAll->set($closure);
+    }
 }

src/Laravel/Commands/PestDatasetCommand.php

@@ -9,6 +9,7 @@ use Illuminate\Support\Facades\File;
 use Illuminate\Support\Str;
 use Pest\Exceptions\InvalidConsoleArgument;
 use function Pest\testDirectory;
+use Pest\TestSuite;
 
 /**
  * @internal
@@ -20,7 +21,8 @@ final class PestDatasetCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'pest:dataset {name : The name of the dataset}';
+    protected $signature = 'pest:dataset {name : The name of the dataset}
+                                         {--test-directory=tests : The name of the tests directory}';
 
     /**
      * The console command description.
@@ -34,6 +36,9 @@ final class PestDatasetCommand extends Command
      */
     public function handle(): void
     {
+        /* @phpstan-ignore-next-line */
+        TestSuite::getInstance(base_path(), $this->option('test-directory'));
+
         /** @var string $name */
         $name = $this->argument('name');
 

src/Laravel/Commands/PestInstallCommand.php

@@ -9,6 +9,7 @@ use Illuminate\Support\Facades\File;
 use Pest\Console\Thanks;
 use Pest\Exceptions\InvalidConsoleArgument;
 use function Pest\testDirectory;
+use Pest\TestSuite;
 
 /**
  * @internal
@@ -20,7 +21,7 @@ final class PestInstallCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'pest:install';
+    protected $signature = 'pest:install {--test-directory=tests : The name of the tests directory}';
 
     /**
      * The console command description.
@@ -34,6 +35,9 @@ final class PestInstallCommand extends Command
      */
     public function handle(): void
     {
+        /* @phpstan-ignore-next-line */
+        TestSuite::getInstance(base_path(), $this->option('test-directory'));
+
         /* @phpstan-ignore-next-line */
         $pest    = base_path(testDirectory('Pest.php'));
         $stubs   = 'stubs/Laravel';

src/Laravel/Commands/PestTestCommand.php

@@ -9,6 +9,7 @@ use Illuminate\Support\Facades\File;
 use Pest\Exceptions\InvalidConsoleArgument;
 use Pest\Support\Str;
 use function Pest\testDirectory;
+use Pest\TestSuite;
 
 /**
  * @internal
@@ -20,7 +21,7 @@ final class PestTestCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'pest:test {name : The name of the file} {--unit : Create a unit test} {--dusk : Create a Dusk test}';
+    protected $signature = 'pest:test {name : The name of the file} {--unit : Create a unit test} {--dusk : Create a Dusk test} {--test-directory=tests : The name of the tests directory}';
 
     /**
      * The console command description.
@@ -34,12 +35,16 @@ final class PestTestCommand extends Command
      */
     public function handle(): void
     {
+        /* @phpstan-ignore-next-line */
+        TestSuite::getInstance(base_path(), $this->option('test-directory'));
+
         /** @var string $name */
         $name = $this->argument('name');
 
         $type = ((bool) $this->option('unit')) ? 'Unit' : (((bool) $this->option('dusk')) ? 'Browser' : 'Feature');
 
-        $relativePath = sprintf(testDirectory('%s/%s.php'),
+        $relativePath = sprintf(
+            testDirectory('%s/%s.php'),
             $type,
             ucfirst($name)
         );

src/Pest.php

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

src/Repositories/AfterEachRepository.php

@@ -41,7 +41,6 @@ final class AfterEachRepository
 
         return ChainableClosure::from(function (): void {
             if (class_exists(Mockery::class)) {
-                /* @phpstan-ignore-next-line */
                 if ($container = Mockery::getContainer()) {
                     /* @phpstan-ignore-next-line */
                     $this->addToAssertionCount($container->mockery_getExpectationCount());

src/Repositories/TestRepository.php

@@ -19,6 +19,11 @@ use PHPUnit\Framework\TestCase;
  */
 final class TestRepository
 {
+    /**
+     * @var string
+     */
+    private const SEPARATOR = '>>>';
+
     /**
      * @var array<string, TestCaseFactory>
      */
@@ -50,7 +55,7 @@ final class TestRepository
             [$classOrTraits, $groups, $hooks] = $uses;
 
             $setClassName = function (TestCaseFactory $testCase, string $key) use ($path, $classOrTraits, $groups, $startsWith, $hooks): void {
-                [$filename] = explode('@', $key);
+                [$filename] = explode(self::SEPARATOR, $key);
 
                 if ((!is_dir($path) && $filename === $path) || (is_dir($path) && $startsWith($filename, $path))) {
                     foreach ($classOrTraits as $class) { /** @var string $class */
@@ -131,10 +136,10 @@ final class TestRepository
             throw ShouldNotHappen::fromMessage('Trying to create a test without description.');
         }
 
-        if (array_key_exists(sprintf('%s@%s', $test->filename, $test->description), $this->state)) {
+        if (array_key_exists(sprintf('%s%s%s', $test->filename, self::SEPARATOR, $test->description), $this->state)) {
             throw new TestAlreadyExist($test->filename, $test->description);
         }
 
-        $this->state[sprintf('%s@%s', $test->filename, $test->description)] = $test;
+        $this->state[sprintf('%s%s%s', $test->filename, self::SEPARATOR, $test->description)] = $test;
     }
 }

tests/.snapshots/success.txt

@@ -40,8 +40,8 @@
   ✓ 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 "one"
-  ✓ named datasets with data set "two" (2)
+  ✓ named datasets with data set "two"
   ✓ 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
@@ -63,6 +63,7 @@
   ✓ it allows to call underlying protected/private methods
   ✓ it throws error if method do not exist
   ✓ it can forward unexpected calls to any global function
+  ✓ it can use helpers from helpers file
 
    PASS  Tests\Features\HigherOrderTests
   ✓ it proxies calls to object
@@ -76,9 +77,6 @@
   ✓ it can call chained macro method
   ✓ it will throw exception from call if no macro exists
 
-   PASS  Tests\Features\Mocks
-  ✓ it has bar
-
    PASS  Tests\Features\PendingHigherOrderTests
   ✓ get 'foo' → get 'bar' → expect true → toBeTrue 
   ✓ get 'foo' → expect true → toBeTrue 
@@ -124,6 +122,10 @@
    PASS  Tests\PHPUnit\CustomAffixes\AdditionalFileExtensionspec
   ✓ it runs file names like `AdditionalFileExtension.spec.php`
 
+   PASS  Tests\PHPUnit\CustomAffixes\FolderWithAn\ExampleTest
+  ✓ custom traits can be used
+  ✓ trait applied in this file
+
    PASS  Tests\PHPUnit\CustomAffixes\ManyExtensionsclasstest
   ✓ it runs file names like `ManyExtensions.class.test.php`
 
@@ -170,7 +172,8 @@
   ✓ it outputs the help information when --help is used
 
    PASS  Tests\Unit\Datasets
-  ✓ it show the names of named datasets in their description
+  ✓ it show only the names of named datasets in their description
+  ✓ it show the actual dataset of non-named datasets in their description
 
    PASS  Tests\Unit\Plugins\Version
   ✓ it outputs the version when --version is used
@@ -221,5 +224,5 @@
   ✓ it is a test
   ✓ it uses correct parent class
 
-  Tests:  7 skipped, 119 passed
+  Tests:  7 skipped, 122 passed
   

tests/Features/Helpers.php

@@ -42,3 +42,5 @@ it('throws error if method do not exist', function () {
 })->throws(\ReflectionException::class, 'Call to undefined method PHPUnit\Framework\TestCase::name()');
 
 it('can forward unexpected calls to any global function')->_assertThat();
+
+it('can use helpers from helpers file')->myAssertTrue(true);

tests/Features/Mocks.php

@@ -1,17 +0,0 @@
-<?php
-
-use function Tests\mock;
-
-interface Foo
-{
-    public function bar(): int;
-}
-
-it('has bar', function () {
-    $mock = mock(Foo::class);
-    $mock->shouldReceive('bar')
-        ->times(1)
-        ->andReturn(2);
-
-    $mock->bar();
-});

tests/Helpers.php

@@ -1,11 +1,6 @@
 <?php
 
-namespace Tests;
+function myAssertTrue($value)
-
-use Mockery;
-use Mockery\MockInterface;
-
-function mock(string $class): MockInterface
 {
-    return Mockery::mock($class);
+    test()->assertTrue($value);
 }

tests/PHPUnit/CustomAffixes/FolderWithAn@/ExampleTest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+class MyCustomClassTest extends PHPUnit\Framework\TestCase
+{
+    public function assertTrueIsTrue()
+    {
+        $this->assertTrue(true);
+    }
+}
+
+uses(MyCustomClassTest::class);
+
+test('custom traits can be used', function () {
+    $this->assertTrueIsTrue();
+});
+
+test('trait applied in this file')->assertTrueIsTrue();

tests/Unit/Datasets.php

@@ -2,12 +2,22 @@
 
 use Pest\Datasets;
 
-it('show the names of named datasets in their description', function () {
+it('show only 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[0])->toBe('test description with data set "one"');
-    expect($descriptions[1])->toBe('test description with data set "two" (array(2))');
+    expect($descriptions[1])->toBe('test description with data set "two"');
+});
+
+it('show the actual dataset of non-named datasets in their description', function () {
+    $descriptions = array_keys(Datasets::resolve('test description', [
+        [1],
+        [[2]],
+    ]));
+
+    expect($descriptions[0])->toBe('test description with (1)');
+    expect($descriptions[1])->toBe('test description with (array(2))');
 });