refactor(testing): add NonCoroutine attribute for flexible test execution control (#7605)

Author: huangdijia

src/Attributes/NonCoroutine.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
+namespace Hyperf\Testing\Attributes;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)]
+class NonCoroutine
+{
+}

src/Concerns/RunTestsInCoroutine.php

@@ -14,17 +14,17 @@
 
 use Hyperf\Coordinator\Constants;
 use Hyperf\Coordinator\CoordinatorManager;
+use Hyperf\Testing\Attributes\NonCoroutine;
+use ReflectionClass;
 use Swoole\Coroutine;
 use Swoole\Timer;
 use Throwable;
 
 trait RunTestsInCoroutine
 {
-    protected bool $enableCoroutine = true;
-
     public function runBare(): void
     {
-        if ($this->enableCoroutine && extension_loaded('swoole') && Coroutine::getCid() === -1) {
+        if ($this->isCoroutineEnabled()) {
             $exception = null;
 
             /* @phpstan-ignore-next-line */
@@ -48,4 +48,23 @@ public function runBare(): void
 
         parent::runBare();
     }
+
+    private function isCoroutineEnabled(): bool
+    {
+        if (! extension_loaded('swoole') || Coroutine::getCid() !== -1) {
+            return false;
+        }
+
+        $refClass = new ReflectionClass(static::class);
+        foreach ($refClass->getAttributes(NonCoroutine::class) as $attribute) {
+            return false;
+        }
+
+        $refMethod = $refClass->getMethod($this->name());
+        foreach ($refMethod->getAttributes(NonCoroutine::class) as $attribute) {
+            return false;
+        }
+
+        return true;
+    }
 }

tests/AttributeOnClassTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
+namespace HyperfTest\Testing;
+
+use Hyperf\Coroutine\Coroutine;
+use Hyperf\Testing\Attributes\NonCoroutine;
+use Hyperf\Testing\Concerns\RunTestsInCoroutine;
+use PHPUnit\Framework\Attributes\Group;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+#[Group('NonCoroutine')]
+#[NonCoroutine]
+class AttributeOnClassTest extends TestCase
+{
+    use RunTestsInCoroutine;
+
+    public function testGetCoroutineStatus()
+    {
+        $this->assertFalse(Coroutine::inCoroutine());
+    }
+}

tests/AttributeOnMethodTest.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
+namespace HyperfTest\Testing;
+
+use Hyperf\Coroutine\Coroutine;
+use Hyperf\Testing\Attributes\NonCoroutine;
+use Hyperf\Testing\Concerns\RunTestsInCoroutine;
+use PHPUnit\Framework\Attributes\Group;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+#[Group('NonCoroutine')]
+class AttributeOnMethodTest extends TestCase
+{
+    use RunTestsInCoroutine;
+
+    #[NonCoroutine]
+    public function testWithNonCoroutineAttribute()
+    {
+        $this->assertFalse(Coroutine::inCoroutine());
+    }
+
+    public function testWithoutNonCoroutineAttribute()
+    {
+        $this->assertTrue(Coroutine::inCoroutine());
+    }
+}