Support using @depends to depend on classes

src/Framework/DataProviderTestSuite.php

@@ -17,34 +17,56 @@
 final class DataProviderTestSuite extends TestSuite
 {
     /**
-     * @var string[]
+     * @var array<string>
      */
     private $dependencies = [];
 
     /**
-     * @param string[] $dependencies
+     * @param array<string> $dependencies
      */
     public function setDependencies(array $dependencies): void
     {
-        $this->dependencies = $dependencies;
+        $this->dependencies  = $dependencies;
+        $this->requiredTests = TestUtil::trimDependencyOptions($dependencies);
 
         foreach ($this->tests as $test) {
             if (!$test instanceof TestCase) {
+                // @codeCoverageIgnoreStart
                 continue;
+                // @codeCoverageIgnoreStart
             }
-
             $test->setDependencies($dependencies);
         }
     }
 
-    public function getDependencies(): array
+    /**
+     * @return array<callable-string>
+     */
+    public function provides(): array
     {
-        return $this->dependencies;
+        if ($this->providedTests !== null) {
+            return $this->providedTests;
+        }
+
+        $callableName = $this->getName();
+
+        if (\is_callable($callableName, true)) {
+            $this->providedTests = [$callableName];
+        } else {
+            $this->providedTests = [];
+        }
+
+        return $this->providedTests;
     }
 
-    public function hasDependencies(): bool
+    /**
+     * @return array<callable-string>
+     */
+    public function requires(): array
     {
-        return \count($this->dependencies) > 0;
+        // A DataProviderTestSuite does not have to traverse its child tests
+        // as these are inherited and cannot reference dataProvider rows directly
+        return $this->requiredTests ?? [];
     }
 
     /**

src/Framework/TestCase.php

@@ -104,6 +104,16 @@ abstract class TestCase extends Assert implements SelfDescribing, Test
      */
     protected $preserveGlobalState = true;
 
+    /**
+     * @var array<callable-string>
+     */
+    protected $providedTests = [];
+
+    /**
+     * @var array<callable-string>
+     */
+    protected $requiredTests = [];
+
     /**
      * @var bool
      */
@@ -150,7 +160,7 @@ abstract class TestCase extends Assert implements SelfDescribing, Test
     private $name = '';
 
     /**
-     * @var string[]
+     * @var array<string>
      */
     private $dependencies = [];
 
@@ -1157,32 +1167,24 @@ public function runBare(): void
     public function setName(string $name): void
     {
         $this->name = $name;
-    }
 
-    /**
-     * @param string[] $dependencies
-     *
-     * @internal This method is not covered by the backward compatibility promise for PHPUnit
-     */
-    public function setDependencies(array $dependencies): void
-    {
-        $this->dependencies = $dependencies;
-    }
+        // Normalized name for dependency resolver
+        $callableName = \get_class($this) . '::' . $name;
 
-    /**
-     * @internal This method is not covered by the backward compatibility promise for PHPUnit
-     */
-    public function getDependencies(): array
-    {
-        return $this->dependencies;
+        if (\is_callable($callableName, true)) {
+            $this->providedTests = [$callableName];
+        }
     }
 
     /**
+     * @param array<string> $dependencies
+     *
      * @internal This method is not covered by the backward compatibility promise for PHPUnit
      */
-    public function hasDependencies(): bool
+    public function setDependencies(array $dependencies): void
     {
-        return \count($this->dependencies) > 0;
+        $this->dependencies  = $dependencies;
+        $this->requiredTests = TestUtil::trimDependencyOptions($dependencies);
     }
 
     /**
@@ -1193,14 +1195,6 @@ public function setDependencyInput(array $dependencyInput): void
         $this->dependencyInput = $dependencyInput;
     }
 
-    /**
-     * @internal This method is not covered by the backward compatibility promise for PHPUnit
-     */
-    public function getDependencyInput(): array
-    {
-        return $this->dependencyInput;
-    }
-
     /**
      * @internal This method is not covered by the backward compatibility promise for PHPUnit
      */
@@ -1347,14 +1341,6 @@ public function usesDataProvider(): bool
         return !empty($this->data);
     }
 
-    /**
-     * @internal This method is not covered by the backward compatibility promise for PHPUnit
-     */
-    public function dataDescription(): string
-    {
-        return \is_string($this->dataName) ? $this->dataName : '';
-    }
-
     /**
      * @return int|string
      *
@@ -1407,6 +1393,30 @@ public function addWarning(string $warning): void
         $this->warnings[] = $warning;
     }
 
+    /**
+     * Returns the normalized test name as class::method.
+     *
+     * @return array<callable-string>
+     */
+    public function provides(): array
+    {
+        return $this->providedTests;
+    }
+
+    /**
+     * Returns a list of normalized dependency names, class::method.
+     *
+     * This list can differ from the raw dependencies as the resolver has
+     * no need for the [!][shallow]clone prefix that is filtered out
+     * during normalization.
+     *
+     * @return array<callable-string>
+     */
+    public function requires(): array
+    {
+        return $this->requiredTests;
+    }
+
     /**
      * Override to run the test and assert its state.
      *
@@ -1942,89 +1952,99 @@ private function checkRequirements(): void
 
     private function handleDependencies(): bool
     {
-        if (!empty($this->dependencies) && !$this->inIsolation) {
-            $className  = \get_class($this);
-            $passed     = $this->result->passed();
-            $passedKeys = \array_keys($passed);
+        if ([] === $this->dependencies || $this->inIsolation) {
+            return true;
+        }
 
-            foreach ($passedKeys as $key => $value) {
-                $pos = \strpos($value, ' with data set');
+        $passed     = $this->result->passed();
+        $passedKeys = \array_keys($passed);
+        $numKeys    = \count($passedKeys);
 
-                if ($pos !== false) {
-                    $passedKeys[$key] = \substr($value, 0, $pos);
-                }
+        for ($i = 0; $i < $numKeys; $i++) {
+            $pos = \strpos($passedKeys[$i], ' with data set');
+
+            if ($pos !== false) {
+                $passedKeys[$i] = \substr($passedKeys[$i], 0, $pos);
             }
+        }
 
-            $passedKeys = \array_flip(\array_unique($passedKeys));
+        $passedKeys = \array_flip(\array_unique($passedKeys));
 
-            foreach ($this->dependencies as $dependency) {
-                $deepClone    = false;
-                $shallowClone = false;
+        foreach ($this->dependencies as $dependency) {
+            if ($dependency === '') {
+                $this->markSkippedForNotSpecifyingDependency();
+
+                return false;
+            }
+
+            if (\substr($dependency, -7) === '::class') {
+                $dependencyClassName = \substr($dependency, 0, -7);
 
-                if (empty($dependency)) {
-                    $this->markSkippedForNotSpecifyingDependency();
+                if (\array_search($dependencyClassName, $this->result->passedClasses()) === false) {
+                    $this->markSkippedForMissingDependency($dependency);
 
                     return false;
                 }
 
-                if (\strpos($dependency, 'clone ') === 0) {
-                    $deepClone  = true;
-                    $dependency = \substr($dependency, \strlen('clone '));
-                } elseif (\strpos($dependency, '!clone ') === 0) {
-                    $deepClone  = false;
-                    $dependency = \substr($dependency, \strlen('!clone '));
-                }
+                continue;
+            }
 
-                if (\strpos($dependency, 'shallowClone ') === 0) {
-                    $shallowClone = true;
-                    $dependency   = \substr($dependency, \strlen('shallowClone '));
-                } elseif (\strpos($dependency, '!shallowClone ') === 0) {
-                    $shallowClone = false;
-                    $dependency   = \substr($dependency, \strlen('!shallowClone '));
-                }
+            $deepClone    = false;
+            $shallowClone = false;
+
+            if (\strpos($dependency, 'clone ') === 0) {
+                $deepClone  = true;
+                $dependency = \substr($dependency, \strlen('clone '));
+            } elseif (\strpos($dependency, '!clone ') === 0) {
+                $deepClone  = false;
+                $dependency = \substr($dependency, \strlen('!clone '));
+            }
 
-                if (\strpos($dependency, '::') === false) {
-                    $dependency = $className . '::' . $dependency;
+            if (\strpos($dependency, 'shallowClone ') === 0) {
+                $shallowClone = true;
+                $dependency   = \substr($dependency, \strlen('shallowClone '));
+            } elseif (\strpos($dependency, '!shallowClone ') === 0) {
+                $shallowClone = false;
+                $dependency   = \substr($dependency, \strlen('!shallowClone '));
+            }
+
+            if (!isset($passedKeys[$dependency])) {
+                if (!$this->isCallableTestMethod($dependency)) {
+                    $this->markWarningForUncallableDependency($dependency);
+                } else {
+                    $this->markSkippedForMissingDependency($dependency);
                 }
 
-                if (!isset($passedKeys[$dependency])) {
-                    if (!$this->isCallableTestMethod($dependency)) {
-                        $this->warnAboutDependencyThatDoesNotExist($dependency);
-                    } else {
-                        $this->markSkippedForMissingDependency($dependency);
-                    }
+                return false;
+            }
+
+            if (isset($passed[$dependency])) {
+                if ($passed[$dependency]['size'] != \PHPUnit\Util\Test::UNKNOWN &&
+                    $this->getSize() != \PHPUnit\Util\Test::UNKNOWN &&
+                    $passed[$dependency]['size'] > $this->getSize()) {
+                    $this->result->addError(
+                        $this,
+                        new SkippedTestError(
+                            'This test depends on a test that is larger than itself.'
+                        ),
+                        0
+                    );
 
                     return false;
                 }
 
-                if (isset($passed[$dependency])) {
-                    if ($passed[$dependency]['size'] !== TestUtil::UNKNOWN &&
-                        $this->getSize() !== TestUtil::UNKNOWN &&
-                        $passed[$dependency]['size'] > $this->getSize()) {
-                        $this->result->addError(
-                            $this,
-                            new SkippedTestError(
-                                'This test depends on a test that is larger than itself.'
-                            ),
-                            0
-                        );
-
-                        return false;
-                    }
-
-                    if ($deepClone) {
-                        $deepCopy = new DeepCopy;
-                        $deepCopy->skipUncloneable(false);
+                if ($deepClone) {
+                    $deepCopy = new DeepCopy;
+                    $deepCopy->skipUncloneable(false);
 
-                        $this->dependencyInput[$dependency] = $deepCopy->copy($passed[$dependency]['result']);
-                    } elseif ($shallowClone) {
-                        $this->dependencyInput[$dependency] = clone $passed[$dependency]['result'];
-                    } else {
-                        $this->dependencyInput[$dependency] = $passed[$dependency]['result'];
-                    }
+                    $this->dependencyInput[$dependency] = $deepCopy->copy($passed[$dependency]['result']);
+                } elseif ($shallowClone) {
+                    $this->dependencyInput[$dependency] = clone $passed[$dependency]['result'];
                 } else {
-                    $this->dependencyInput[$dependency] = null;
+                    $this->dependencyInput[$dependency] = $passed[$dependency]['result'];
                 }
+            } else {
+                $this->dependencyInput[$dependency] = null;
             }
         }
 
@@ -2068,7 +2088,7 @@ private function markSkippedForMissingDependency(string $dependency): void
         $this->result->endTest($this, 0);
     }
 
-    private function warnAboutDependencyThatDoesNotExist(string $dependency): void
+    private function markWarningForUncallableDependency(string $dependency): void
     {
         $this->status = BaseTestRunner::STATUS_WARNING;