Merge pull request #961 from bastien-phi/allow_multiple_hook_per_directory

[2.x] Allow define multiple hooks per directory

src/Repositories/TestRepository.php

@@ -25,7 +25,7 @@ final class TestRepository
     private array $testCases = [];
 
     /**
-     * @var array<string, array{0: array<int, string>, 1: array<int, string>, 2: array<int, string|Closure>}>
+     * @var array<string, array{0: array<int, string>, 1: array<int, string>, 2: array<int, array<int, string|Closure>>}>
      */
     private array $uses = [];
 
@@ -77,12 +77,17 @@ final class TestRepository
             throw new TestCaseClassOrTraitNotFound($classOrTrait);
         }
 
+        $hooks = array_map(fn (Closure $hook): array => [$hook], $hooks);
+
         foreach ($paths as $path) {
             if (array_key_exists($path, $this->uses)) {
                 $this->uses[$path] = [
                     [...$this->uses[$path][0], ...$classOrTraits],
                     [...$this->uses[$path][1], ...$groups],
-                    $this->uses[$path][2] + $hooks,
+                    array_map(
+                        fn (int $index): array => [...$this->uses[$path][2][$index] ?? [], ...($hooks[$index] ?? [])],
+                        range(0, 3),
+                    ),
                 ];
             } else {
                 $this->uses[$path] = [$classOrTraits, $groups, $hooks];
@@ -189,10 +194,11 @@ final class TestRepository
                     $method->groups = [...$groups, ...$method->groups];
                 }
 
-                $testCase->factoryProxies->add($testCase->filename, 0, '__addBeforeAll', [$hooks[0] ?? null]);
-                $testCase->factoryProxies->add($testCase->filename, 0, '__addBeforeEach', [$hooks[1] ?? null]);
-                $testCase->factoryProxies->add($testCase->filename, 0, '__addAfterEach', [$hooks[2] ?? null]);
-                $testCase->factoryProxies->add($testCase->filename, 0, '__addAfterAll', [$hooks[3] ?? null]);
+                foreach (['__addBeforeAll', '__addBeforeEach', '__addAfterEach', '__addAfterAll'] as $index => $name) {
+                    foreach ($hooks[$index] ?? [null] as $hook) {
+                        $testCase->factoryProxies->add($testCase->filename, 0, $name, [$hook]);
+                    }
+                }
             }
         }
 

tests/.snapshots/success.txt

@@ -154,6 +154,10 @@
   ✓ it can correctly resolve a bound dataset that returns an array with (Closure)
   ✓ it can correctly resolve a bound dataset that returns an array but wants to be spread with (Closure)
   ↓ forbids to define tests in Datasets dirs and Datasets.php files
+  ✓ it may be used with high order with dataset "formal"
+  ✓ it may be used with high order with dataset "informal"
+  ✓ it may be used with high order even when bound with dataset "formal"
+  ✓ it may be used with high order even when bound with dataset "informal"
 
    PASS  Tests\Features\Depends
   ✓ first
@@ -1134,9 +1138,17 @@
    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
+
    PASS  Tests\Hooks\AfterEachTest
   ✓ global afterEach execution order
 
+   PASS  Tests\Hooks\BeforeAllTest
+  ✓ global beforeAll execution order
+  ✓ it only gets called once per file
+
    PASS  Tests\Hooks\BeforeEachTest
   ✓ global beforeEach execution order
 
@@ -1377,4 +1389,4 @@
    WARN  Tests\Visual\Version
   - visual snapshot of help command output
 
-  Tests:    2 deprecated, 4 warnings, 5 incomplete, 2 notices, 13 todos, 20 skipped, 978 passed (2304 assertions)
+  Tests:    2 deprecated, 4 warnings, 5 incomplete, 2 notices, 13 todos, 20 skipped, 986 passed (2372 assertions)

tests/Hooks/AfterAllTest.php

@@ -0,0 +1,45 @@
+<?php
+
+uses()->afterAll(function () {
+    expect($_SERVER['globalHook'])
+        ->toHaveProperty('afterAll')
+        ->and($_SERVER['globalHook']->afterAll)
+        ->toBe(1)
+        ->and($_SERVER['globalHook']->calls)
+        ->afterAll
+        ->toBe(1);
+
+    $_SERVER['globalHook']->afterAll = 2;
+    $_SERVER['globalHook']->calls->afterAll++;
+});
+
+afterAll(function () {
+    expect($_SERVER['globalHook'])
+        ->toHaveProperty('afterAll')
+        ->and($_SERVER['globalHook']->afterAll)
+        ->toBe(1)
+        ->and($_SERVER['globalHook']->calls)
+        ->afterAll
+        ->toBe(2);
+
+    $_SERVER['globalHook']->afterAll = 2;
+    $_SERVER['globalHook']->calls->afterAll++;
+});
+
+test('global afterAll execution order', function () {
+    expect($_SERVER['globalHook'])
+        ->not()
+        ->toHaveProperty('afterAll')
+        ->and($_SERVER['globalHook']->calls)
+        ->afterAll
+        ->toBe(0);
+});
+
+it('only gets called once per file', function () {
+    expect($_SERVER['globalHook'])
+        ->not()
+        ->toHaveProperty('afterAll')
+        ->and($_SERVER['globalHook']->calls)
+        ->afterAll
+        ->toBe(0);
+});

tests/Hooks/AfterEachTest.php

@@ -4,16 +4,16 @@ uses()->afterEach(function () {
     expect($this)
         ->toHaveProperty('ith')
         ->and($this->ith)
-        ->toBe(0);
+        ->toBe(1);
 
-    $this->ith = 1;
+    $this->ith = 2;
 });
 
 afterEach(function () {
     expect($this)
         ->toHaveProperty('ith')
         ->and($this->ith)
-        ->toBe(1);
+        ->toBe(2);
 });
 
 test('global afterEach execution order', function () {

tests/Hooks/BeforeAllTest.php

@@ -0,0 +1,55 @@
+<?php
+
+use Pest\Plugins\Parallel;
+use Pest\Support\Str;
+
+// HACK: we have to determine our $_SERVER['globalHook-]>calls baseline. This is because
+// two other tests are executed before this one due to filename ordering.
+$args = $_SERVER['argv'] ?? [];
+$single = (isset($args[1]) && Str::endsWith(__FILE__, $args[1])) || Parallel::isWorker();
+$offset = $single ? 0 : 2;
+
+uses()->beforeAll(function () use ($offset) {
+    expect($_SERVER['globalHook'])
+        ->toHaveProperty('beforeAll')
+        ->and($_SERVER['globalHook']->beforeAll)
+        ->toBe(1)
+        ->and($_SERVER['globalHook']->calls)
+        ->beforeAll
+        ->toBe(1 + $offset);
+
+    $_SERVER['globalHook']->beforeAll = 2;
+    $_SERVER['globalHook']->calls->beforeAll++;
+});
+
+beforeAll(function () use ($offset) {
+    expect($_SERVER['globalHook'])
+        ->toHaveProperty('beforeAll')
+        ->and($_SERVER['globalHook']->beforeAll)
+        ->toBe(2)
+        ->and($_SERVER['globalHook']->calls)
+        ->beforeAll
+        ->toBe(2 + $offset);
+
+    $_SERVER['globalHook']->beforeAll = 3;
+    $_SERVER['globalHook']->calls->beforeAll++;
+});
+
+test('global beforeAll execution order', function () use ($offset) {
+    expect($_SERVER['globalHook'])
+        ->toHaveProperty('beforeAll')
+        ->and($_SERVER['globalHook']->beforeAll)
+        ->toBe(3)
+        ->and($_SERVER['globalHook']->calls)
+        ->beforeAll
+        ->toBe(3 + $offset);
+});
+
+it('only gets called once per file', function () use ($offset) {
+    expect($_SERVER['globalHook'])
+        ->beforeAll
+        ->toBe(3)
+        ->and($_SERVER['globalHook']->calls)
+        ->beforeAll
+        ->toBe(3 + $offset);
+});

tests/Hooks/BeforeEachTest.php

@@ -1,15 +1,6 @@
 <?php
 
 uses()->beforeEach(function () {
-    expect($this)
-        ->toHaveProperty('baz')
-        ->and($this->baz)
-        ->toBe(0);
-
-    $this->baz = 1;
-});
-
-beforeEach(function () {
     expect($this)
         ->toHaveProperty('baz')
         ->and($this->baz)
@@ -18,9 +9,18 @@ beforeEach(function () {
     $this->baz = 2;
 });
 
-test('global beforeEach execution order', function () {
+beforeEach(function () {
     expect($this)
         ->toHaveProperty('baz')
         ->and($this->baz)
         ->toBe(2);
+
+    $this->baz = 3;
+});
+
+test('global beforeEach execution order', function () {
+    expect($this)
+        ->toHaveProperty('baz')
+        ->and($this->baz)
+        ->toBe(3);
 });

tests/Pest.php

@@ -33,6 +33,41 @@ uses()
     })
     ->in('Hooks');
 
+uses()
+    ->beforeEach(function () {
+        expect($this)
+            ->toHaveProperty('baz')
+            ->and($this->baz)
+            ->toBe(0);
+
+        $this->baz = 1;
+    })
+    ->beforeAll(function () {
+        expect($_SERVER['globalHook'])
+            ->toHaveProperty('beforeAll')
+            ->and($_SERVER['globalHook']->beforeAll)
+            ->toBe(0);
+
+        $_SERVER['globalHook']->beforeAll = 1;
+    })
+    ->afterEach(function () {
+        expect($this)
+            ->toHaveProperty('ith')
+            ->and($this->ith)
+            ->toBe(0);
+
+        $this->ith = 1;
+    })
+    ->afterAll(function () {
+        expect($_SERVER['globalHook'])
+            ->toHaveProperty('afterAll')
+            ->and($_SERVER['globalHook']->afterAll)
+            ->toBe(0);
+
+        $_SERVER['globalHook']->afterAll = 1;
+    })
+    ->in('Hooks');
+
 function helper_returns_string()
 {
     return 'string';

tests/Visual/Parallel.php

@@ -16,7 +16,7 @@ $run = function () {
 
 test('parallel', function () use ($run) {
     expect($run('--exclude-group=integration'))
-        ->toContain('Tests:    1 deprecated, 4 warnings, 5 incomplete, 2 notices, 13 todos, 16 skipped, 965 passed (2285 assertions)')
+        ->toContain('Tests:    1 deprecated, 4 warnings, 5 incomplete, 2 notices, 13 todos, 16 skipped, 973 passed (2353 assertions)')
         ->toContain('Parallel: 3 processes');
 })->skipOnWindows();