From f4b1111aaf072cd7c0a0d590b27e4ed974a60385 Mon Sep 17 00:00:00 2001
From: Maxim Smakouz <m.smakouz@gmail.com>
Date: Thu, 28 Sep 2023 13:29:10 +0300
Subject: [PATCH] Add the ability to use setUp and tearDown methods in traits

---
 src/TestCase.php                              | 26 +++++++
 .../Fixture/Trait/WithMethodsTrait.php        | 21 ++++++
 .../TestCase/Fixture/Trait/WithSetUpTrait.php | 15 +++++
 .../Fixture/Trait/WithTearDownTrait.php       | 15 +++++
 .../Fixture/Trait/WithoutMethodsTrait.php     | 13 ++++
 tests/src/TestCase/Fixture/WithMethods.php    | 13 ++++
 tests/src/TestCase/Fixture/WithSetUp.php      | 13 ++++
 tests/src/TestCase/Fixture/WithTearDown.php   | 13 ++++
 tests/src/TestCase/Fixture/WithoutMethods.php | 13 ++++
 tests/src/TestCase/Fixture/WithoutTraits.php  | 11 +++
 tests/src/TestCase/TestCaseTest.php           | 67 +++++++++++++++++++
 11 files changed, 220 insertions(+)
 create mode 100644 tests/src/TestCase/Fixture/Trait/WithMethodsTrait.php
 create mode 100644 tests/src/TestCase/Fixture/Trait/WithSetUpTrait.php
 create mode 100644 tests/src/TestCase/Fixture/Trait/WithTearDownTrait.php
 create mode 100644 tests/src/TestCase/Fixture/Trait/WithoutMethodsTrait.php
 create mode 100644 tests/src/TestCase/Fixture/WithMethods.php
 create mode 100644 tests/src/TestCase/Fixture/WithSetUp.php
 create mode 100644 tests/src/TestCase/Fixture/WithTearDown.php
 create mode 100644 tests/src/TestCase/Fixture/WithoutMethods.php
 create mode 100644 tests/src/TestCase/Fixture/WithoutTraits.php
 create mode 100644 tests/src/TestCase/TestCaseTest.php

diff --git a/src/TestCase.php b/src/TestCase.php
index 22227e6..79f6bfa 100644
--- a/src/TestCase.php
+++ b/src/TestCase.php
@@ -83,6 +83,8 @@ protected function setUp(): void
             $variables = [...static::ENV, ...$this->getEnvVariablesFromConfig()];
             $this->initApp($variables);
         }
+
+        $this->setUpTraits();
     }
 
     public function beforeBooting(Closure $callback): void
@@ -168,6 +170,8 @@ protected function tearDown(): void
     {
         parent::tearDown();
 
+        $this->tearDownTraits();
+
         (new \ReflectionClass(ContainerScope::class))
             ->setStaticPropertyValue('container', null);
     }
@@ -195,4 +199,26 @@ protected function getTestAttributes(string $attribute, string $method = null):
             return [];
         }
     }
+
+    protected function setUpTraits(): void
+    {
+        $ref = new \ReflectionClass(static::class);
+
+        foreach ($ref->getTraits() as $trait) {
+            if (\method_exists($this, $method = 'setUp' . $trait->getShortName())) {
+                $this->{$method}();
+            }
+        }
+    }
+
+    protected function tearDownTraits(): void
+    {
+        $ref = new \ReflectionClass(static::class);
+
+        foreach ($ref->getTraits() as $trait) {
+            if (\method_exists($this, $method = 'tearDown' . $trait->getShortName())) {
+                $this->{$method}();
+            }
+        }
+    }
 }
diff --git a/tests/src/TestCase/Fixture/Trait/WithMethodsTrait.php b/tests/src/TestCase/Fixture/Trait/WithMethodsTrait.php
new file mode 100644
index 0000000..0b7fe3b
--- /dev/null
+++ b/tests/src/TestCase/Fixture/Trait/WithMethodsTrait.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture\Trait;
+
+trait WithMethodsTrait
+{
+    public bool $calledSetUp = false;
+    public bool $calledTearDown = false;
+
+    public function setUpWithMethodsTrait(): void
+    {
+        $this->calledSetUp = true;
+    }
+
+    public function tearDownWithMethodsTrait(): void
+    {
+        $this->calledTearDown = true;
+    }
+}
diff --git a/tests/src/TestCase/Fixture/Trait/WithSetUpTrait.php b/tests/src/TestCase/Fixture/Trait/WithSetUpTrait.php
new file mode 100644
index 0000000..bedf7ca
--- /dev/null
+++ b/tests/src/TestCase/Fixture/Trait/WithSetUpTrait.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture\Trait;
+
+trait WithSetUpTrait
+{
+    public bool $calledSetUp = false;
+
+    public function setUpWithSetUpTrait(): void
+    {
+        $this->calledSetUp = true;
+    }
+}
diff --git a/tests/src/TestCase/Fixture/Trait/WithTearDownTrait.php b/tests/src/TestCase/Fixture/Trait/WithTearDownTrait.php
new file mode 100644
index 0000000..7c26c6a
--- /dev/null
+++ b/tests/src/TestCase/Fixture/Trait/WithTearDownTrait.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture\Trait;
+
+trait WithTearDownTrait
+{
+    public bool $calledTearDown = false;
+
+    public function tearDownWithTearDownTrait(): void
+    {
+        $this->calledTearDown = true;
+    }
+}
diff --git a/tests/src/TestCase/Fixture/Trait/WithoutMethodsTrait.php b/tests/src/TestCase/Fixture/Trait/WithoutMethodsTrait.php
new file mode 100644
index 0000000..39236a9
--- /dev/null
+++ b/tests/src/TestCase/Fixture/Trait/WithoutMethodsTrait.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture\Trait;
+
+trait WithoutMethodsTrait
+{
+    public function isAvailable(): bool
+    {
+        return true;
+    }
+}
diff --git a/tests/src/TestCase/Fixture/WithMethods.php b/tests/src/TestCase/Fixture/WithMethods.php
new file mode 100644
index 0000000..b345f75
--- /dev/null
+++ b/tests/src/TestCase/Fixture/WithMethods.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture;
+
+use Spiral\Testing\TestCase;
+use Spiral\Testing\Tests\TestCase\Fixture\Trait\WithMethodsTrait;
+
+final class WithMethods extends TestCase
+{
+    use WithMethodsTrait;
+}
diff --git a/tests/src/TestCase/Fixture/WithSetUp.php b/tests/src/TestCase/Fixture/WithSetUp.php
new file mode 100644
index 0000000..ef70955
--- /dev/null
+++ b/tests/src/TestCase/Fixture/WithSetUp.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture;
+
+use Spiral\Testing\TestCase;
+use Spiral\Testing\Tests\TestCase\Fixture\Trait\WithSetUpTrait;
+
+final class WithSetUp extends TestCase
+{
+    use WithSetUpTrait;
+}
diff --git a/tests/src/TestCase/Fixture/WithTearDown.php b/tests/src/TestCase/Fixture/WithTearDown.php
new file mode 100644
index 0000000..7633df8
--- /dev/null
+++ b/tests/src/TestCase/Fixture/WithTearDown.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture;
+
+use Spiral\Testing\TestCase;
+use Spiral\Testing\Tests\TestCase\Fixture\Trait\WithTearDownTrait;
+
+final class WithTearDown extends TestCase
+{
+    use WithTearDownTrait;
+}
diff --git a/tests/src/TestCase/Fixture/WithoutMethods.php b/tests/src/TestCase/Fixture/WithoutMethods.php
new file mode 100644
index 0000000..0f1b5d1
--- /dev/null
+++ b/tests/src/TestCase/Fixture/WithoutMethods.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture;
+
+use Spiral\Testing\TestCase;
+use Spiral\Testing\Tests\TestCase\Fixture\Trait\WithoutMethodsTrait;
+
+final class WithoutMethods extends TestCase
+{
+    use WithoutMethodsTrait;
+}
diff --git a/tests/src/TestCase/Fixture/WithoutTraits.php b/tests/src/TestCase/Fixture/WithoutTraits.php
new file mode 100644
index 0000000..f906f07
--- /dev/null
+++ b/tests/src/TestCase/Fixture/WithoutTraits.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture;
+
+use Spiral\Testing\TestCase;
+
+final class WithoutTraits extends TestCase
+{
+}
diff --git a/tests/src/TestCase/TestCaseTest.php b/tests/src/TestCase/TestCaseTest.php
new file mode 100644
index 0000000..c5ed702
--- /dev/null
+++ b/tests/src/TestCase/TestCaseTest.php
@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase;
+
+use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
+use PHPUnit\Framework\TestCase;
+use Spiral\Testing\Tests\TestCase\Fixture\WithMethods;
+use Spiral\Testing\Tests\TestCase\Fixture\WithoutMethods;
+use Spiral\Testing\Tests\TestCase\Fixture\WithoutTraits;
+use Spiral\Testing\Tests\TestCase\Fixture\WithSetUp;
+use Spiral\Testing\Tests\TestCase\Fixture\WithTearDown;
+
+final class TestCaseTest extends TestCase
+{
+    #[DoesNotPerformAssertions]
+    public function testItDoesNotThrowWhenCallingSetUp(): void
+    {
+        $testCase = new WithoutTraits('foo');
+        $testCase->setUp();
+    }
+
+    #[DoesNotPerformAssertions]
+    public function testItDoesNotThrowWhenCallingTearDown(): void
+    {
+        $testCase = new WithoutTraits('foo');
+        $testCase->tearDown();
+    }
+
+    public function testTraitWithoutMethods(): void
+    {
+        $testCase = new WithoutMethods('foo');
+        $testCase->setUp();
+        $testCase->tearDown();
+
+        $this->assertTrue($testCase->isAvailable());
+    }
+
+    public function testTraitWithSetUp(): void
+    {
+        $testCase = new WithSetUp('foo');
+        $testCase->setUp();
+        $testCase->tearDown();
+
+        $this->assertTrue($testCase->calledSetUp);
+    }
+
+    public function testTraitWithTearDown(): void
+    {
+        $testCase = new WithTearDown('foo');
+        $testCase->setUp();
+        $testCase->tearDown();
+
+        $this->assertTrue($testCase->calledTearDown);
+    }
+
+    public function testTraitWithSetUpAndTearDownMethods(): void
+    {
+        $testCase = new WithMethods('foo');
+        $testCase->setUp();
+        $testCase->tearDown();
+
+        $this->assertTrue($testCase->calledSetUp);
+        $this->assertTrue($testCase->calledTearDown);
+    }
+}