Do not allow adding the same test to multiple test suites

sebastianbergmann · sebastianbergmann · commit 57e07eef9de8 · 2024-01-20T09:20:27.000+01:00
diff --git a/ChangeLog-11.0.md b/ChangeLog-11.0.md
@@ -21,6 +21,7 @@ All notable changes of the PHPUnit 11.0 release series are documented in this fi
 * [#5619](https://github.com/sebastianbergmann/phpunit/pull/5619): Check and restore error/exception global handlers
 * The format of the XML document generated using the `--list-tests-xml` CLI option has been changed
 * `small`, `medium`, and `large` can no longer be used as group names with the `#[Group]` attribute
+* A test can no longer be part of multiple test suites that are configured in the XML configuration file
 
 ### Deprecated
 
diff --git a/src/TextUI/Configuration/Xml/TestSuiteMapper.php b/src/TextUI/Configuration/Xml/TestSuiteMapper.php
@@ -14,8 +14,10 @@
 use function in_array;
 use function is_dir;
 use function is_file;
+use function sprintf;
 use function str_contains;
 use function version_compare;
+use PHPUnit\Event\Facade as EventFacade;
 use PHPUnit\Framework\Exception as FrameworkException;
 use PHPUnit\Framework\TestSuite as TestSuiteObject;
 use PHPUnit\TextUI\Configuration\TestSuiteCollection;
@@ -42,6 +44,7 @@ public function map(string $xmlConfigurationFile, TestSuiteCollection $configure
             $namesOfIncludedTestSuitesAsArray = $namesOfIncludedTestSuites ? explode(',', $namesOfIncludedTestSuites) : [];
             $excludedTestSuitesAsArray        = $namesOfExcludedTestSuites ? explode(',', $namesOfExcludedTestSuites) : [];
             $result                           = TestSuiteObject::empty($xmlConfigurationFile);
+            $processed                        = [];
 
             foreach ($configuredTestSuites as $configuredTestSuite) {
                 if (!empty($namesOfIncludedTestSuitesAsArray) && !in_array($configuredTestSuite->name(), $namesOfIncludedTestSuitesAsArray, true)) {
@@ -52,14 +55,15 @@ public function map(string $xmlConfigurationFile, TestSuiteCollection $configure
                     continue;
                 }
 
-                $exclude = [];
+                $testSuiteName = $configuredTestSuite->name();
+                $exclude       = [];
 
                 foreach ($configuredTestSuite->exclude()->asArray() as $file) {
                     $exclude[] = $file->path();
                 }
 
                 $testSuite = TestSuiteObject::empty($configuredTestSuite->name());
-                $processed = [];
+                $empty     = true;
 
                 foreach ($configuredTestSuite->directories() as $directory) {
                     if (!str_contains($directory->path(), '*') && !is_dir($directory->path())) {
@@ -81,10 +85,20 @@ public function map(string $xmlConfigurationFile, TestSuiteCollection $configure
 
                     foreach ($files as $file) {
                         if (isset($processed[$file])) {
+                            EventFacade::emitter()->testRunnerTriggeredWarning(
+                                sprintf(
+                                    'Cannot add file %s to test suite "%s" as it was already added to test suite "%s"',
+                                    $file,
+                                    $testSuiteName,
+                                    $processed[$file],
+                                ),
+                            );
+
                             continue;
                         }
 
-                        $processed[$file] = true;
+                        $processed[$file] = $testSuiteName;
+                        $empty            = false;
 
                         $testSuite->addTestFile($file, $groups);
                     }
@@ -100,15 +114,25 @@ public function map(string $xmlConfigurationFile, TestSuiteCollection $configure
                     }
 
                     if (isset($processed[$file->path()])) {
+                        EventFacade::emitter()->testRunnerTriggeredWarning(
+                            sprintf(
+                                'Cannot add file %s to test suite "%s" as it was already added to test suite "%s"',
+                                $file->path(),
+                                $testSuiteName,
+                                $processed[$file->path()],
+                            ),
+                        );
+
                         continue;
                     }
 
-                    $processed[$file->path()] = true;
+                    $processed[$file->path()] = $testSuiteName;
+                    $empty                    = false;
 
                     $testSuite->addTestFile($file->path(), $file->groups());
                 }
 
-                if (!empty($processed)) {
+                if (!$empty) {
                     $result->addTest($testSuite);
                 }
             }
diff --git a/tests/_files/DataProviderIssue2859/phpunit.xml b/tests/_files/DataProviderIssue2859/phpunit.xml
diff --git a/tests/end-to-end/_files/overlapping-testsuite-configuration/phpunit.xml b/tests/end-to-end/_files/overlapping-testsuite-configuration/phpunit.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="../../../../phpunit.xsd"
+>
+    <testsuites>
+        <testsuite name="one">
+            <directory>tests</directory>
+        </testsuite>
+
+        <testsuite name="two">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>
diff --git a/tests/end-to-end/_files/overlapping-testsuite-configuration/tests/ExampleTest.php b/tests/end-to-end/_files/overlapping-testsuite-configuration/tests/ExampleTest.php
@@ -7,20 +7,13 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-namespace PHPUnit\TestFixture\DataProviderIssue2859;
+namespace PHPUnit\TestFixture\OverlappingTestSuiteConfiguration;
 
-use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
-class TestWithDataProviderTest extends TestCase
+final class ExampleTest extends TestCase
 {
-    public static function provide(): array
-    {
-        return [[true]];
-    }
-
-    #[DataProvider('provide')]
-    public function testFirst($x): void
+    public function testOne(): void
     {
         $this->assertTrue(true);
     }
diff --git a/tests/end-to-end/cli/overlapping-testsuite-configuration.phpt b/tests/end-to-end/cli/overlapping-testsuite-configuration.phpt
@@ -0,0 +1,27 @@
+--TEST--
+A test file must not be in more than one test suite configured in the XML configuration file
+--FILE--
+<?php declare(strict_types=1);
+$_SERVER['argv'][] = '--do-not-cache-result';
+$_SERVER['argv'][] = '--configuration';
+$_SERVER['argv'][] = __DIR__ . '/../_files/overlapping-testsuite-configuration/phpunit.xml';
+
+require __DIR__ . '/../../bootstrap.php';
+
+(new PHPUnit\TextUI\Application)->run($_SERVER['argv']);
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+Runtime: %s
+Configuration: %soverlapping-testsuite-configuration%sphpunit.xml
+
+.                                                                   1 / 1 (100%)
+
+Time: %s, Memory: %s
+
+There was 1 PHPUnit test runner warning:
+
+1) Cannot add file %sExampleTest.php to test suite "two" as it was already added to test suite "one"
+
+WARNINGS!
+Tests: 1, Assertions: 1, Warnings: 1.
diff --git a/tests/end-to-end/generic/dataprovider-issue-2859.phpt b/tests/end-to-end/generic/dataprovider-issue-2859.phpt
