Merge pull request #62 from spiral/feature/setup-traits

Adding the ability to use setUp and tearDown methods in traits

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,35 @@ protected function getTestAttributes(string $attribute, string $method = null):
             return [];
         }
     }
+
+    protected function setUpTraits(): void
+    {
+        $this->runTraitSetUpOrTearDown('setUp');
+    }
+
+    protected function tearDownTraits(): void
+    {
+        $this->runTraitSetUpOrTearDown('tearDown');
+    }
+
+    private function runTraitSetUpOrTearDown(string $method): void
+    {
+        $ref = new \ReflectionClass(static::class);
+
+        foreach ($ref->getTraits() as $trait) {
+            if (\method_exists($this, $name = $method . $trait->getShortName())) {
+                $this->{$name}();
+            }
+        }
+
+        while($parent = $ref->getParentClass()) {
+            foreach ($parent->getTraits() as $trait) {
+                if (\method_exists($this, $name = $method . $trait->getShortName())) {
+                    $this->{$name}();
+                }
+            }
+
+            $ref = $parent;
+        }
+    }
 }

tests/src/TestCase/Fixture/OtherParentClass.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture;
+
+class OtherParentClass extends ParentClass
+{
+}

tests/src/TestCase/Fixture/ParentClass.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;
+
+class ParentClass extends TestCase
+{
+    use WithMethodsTrait;
+}

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;
+    }
+}

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;
+    }
+}

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;
+    }
+}

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;
+    }
+}

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;
+}

tests/src/TestCase/Fixture/WithMethodsInNestedParent.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture;
+
+final class WithMethodsInNestedParent extends OtherParentClass
+{
+}

tests/src/TestCase/Fixture/WithMethodsInParent.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Testing\Tests\TestCase\Fixture;
+
+final class WithMethodsInParent extends ParentClass
+{
+}

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;
+}

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;
+}

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;
+}

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
+{
+}

tests/src/TestCase/TestCaseTest.php

@@ -0,0 +1,95 @@
+<?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\WithMethodsInNestedParent;
+use Spiral\Testing\Tests\TestCase\Fixture\WithMethodsInParent;
+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
+     */
+    #[DoesNotPerformAssertions]
+    public function testItDoesNotThrowWhenCallingSetUp(): void
+    {
+        $testCase = new WithoutTraits('foo');
+        $testCase->setUp();
+    }
+
+    /**
+     * @doesNotPerformAssertions
+     */
+    #[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);
+    }
+
+    public function testTraitWithSetUpAndTearDownMethodsInParentClass(): void
+    {
+        $testCase = new WithMethodsInParent('foo');
+        $testCase->setUp();
+        $testCase->tearDown();
+
+        $this->assertTrue($testCase->calledSetUp);
+        $this->assertTrue($testCase->calledTearDown);
+    }
+
+    public function testTraitWithSetUpAndTearDownMethodsInNestedParentClass(): void
+    {
+        $testCase = new WithMethodsInNestedParent('foo');
+        $testCase->setUp();
+        $testCase->tearDown();
+
+        $this->assertTrue($testCase->calledSetUp);
+        $this->assertTrue($testCase->calledTearDown);
+    }
+}