Closes #5720

Co-authored-by: Sebastian Bergmann <[email protected]>
Co-authored-by: Arne Blankerts <[email protected]>
Co-authored-by: Andreas Möller <[email protected]>
Co-authored-by: Sebastian Heuer <[email protected]>
Co-authored-by: Fabian Blechschmidt <[email protected]>
Co-authored-by: Frank Sons <[email protected]>

Author: 6 people

.psalm/baseline.xml

@@ -714,6 +714,8 @@
       <code><![CDATA[logEventsVerboseText]]></code>
       <code><![CDATA[logfileJunit]]></code>
       <code><![CDATA[logfileTeamcity]]></code>
+      <code><![CDATA[process]]></code>
+      <code><![CDATA[process]]></code>
     </MissingThrowsDocblock>
     <UnresolvableInclude>
       <code><![CDATA[include_once $filename]]></code>

ChangeLog-11.1.md

@@ -8,6 +8,7 @@ All notable changes of the PHPUnit 11.1 release series are documented in this fi
 
 * [#5175](https://github.com/sebastianbergmann/phpunit/issues/5175): `#[CoversMethod]` and `#[UsesMethod]` attributes for more fine-grained code coverage targeting
 * [#5696](https://github.com/sebastianbergmann/phpunit/pull/5696): `#[DisableReturnValueGenerationForTestDoubles]` attribute for disabling return value generation for test doubles created using `createMock()`, `createMockForIntersectionOfInterfaces()`, `createPartialMock()`, `createStub()`, and `createStubForIntersectionOfInterfaces()`
+* [#5720](https://github.com/sebastianbergmann/phpunit/issues/5720): Support filtering using `--filter`, `--exclude-filter`, `--group`, and `--exclude-group` when listing tests using `--list-tests` and `--list-tests-xml`
 * `--only-summary-for-coverage-text` CLI option to reduce the code coverage report in text format to a summary
 * `--show-uncovered-for-coverage-text` CLI option to expand the code coverage report in text format to include a list of uncovered files
 

src/Framework/TestSuite.php

@@ -305,6 +305,28 @@ public function groupDetails(): array
         return $this->groups;
     }
 
+    /**
+     * @psalm-return list<TestCase|PhptTestCase>
+     */
+    public function collect(): array
+    {
+        $tests = [];
+
+        foreach ($this as $test) {
+            if ($test instanceof self) {
+                $tests = array_merge($tests, $test->collect());
+
+                continue;
+            }
+
+            assert($test instanceof TestCase || $test instanceof PhptTestCase);
+
+            $tests[] = $test;
+        }
+
+        return $tests;
+    }
+
     /**
      * @throws CodeCoverageException
      * @throws Event\RuntimeException

src/TextUI/Application.php

@@ -20,6 +20,7 @@
 use PHPUnit\Event\EventFacadeIsSealedException;
 use PHPUnit\Event\Facade as EventFacade;
 use PHPUnit\Event\UnknownSubscriberTypeException;
+use PHPUnit\Framework\TestCase;
 use PHPUnit\Framework\TestSuite;
 use PHPUnit\Logging\EventLogger;
 use PHPUnit\Logging\JUnit\JunitXmlLogger;
@@ -38,6 +39,7 @@
 use PHPUnit\Runner\Extension\Facade as ExtensionFacade;
 use PHPUnit\Runner\Extension\PharLoader;
 use PHPUnit\Runner\GarbageCollection\GarbageCollectionHandler;
+use PHPUnit\Runner\PhptTestCase;
 use PHPUnit\Runner\ResultCache\DefaultResultCache;
 use PHPUnit\Runner\ResultCache\NullResultCache;
 use PHPUnit\Runner\ResultCache\ResultCache;
@@ -421,14 +423,24 @@ private function executeCommandsThatRequireTheTestSuite(Configuration $configura
         }
 
         if ($cliConfiguration->listTests()) {
-            $this->execute(new ListTestsAsTextCommand($testSuite));
+            $this->execute(
+                new ListTestsAsTextCommand(
+                    $this->filteredTests(
+                        $configuration,
+                        $testSuite,
+                    ),
+                ),
+            );
         }
 
         if ($cliConfiguration->hasListTestsXml()) {
             $this->execute(
                 new ListTestsAsXmlCommand(
+                    $this->filteredTests(
+                        $configuration,
+                        $testSuite,
+                    ),
                     $cliConfiguration->listTestsXml(),
-                    $testSuite,
                 ),
             );
         }
@@ -663,4 +675,14 @@ private function exitWithErrorMessage(string $message): never
 
         exit(Result::EXCEPTION);
     }
+
+    /**
+     * @psalm-return list<TestCase|PhptTestCase>
+     */
+    private function filteredTests(Configuration $configuration, TestSuite $suite): array
+    {
+        (new TestSuiteFilterProcessor)->process($configuration, $suite);
+
+        return $suite->collect();
+    }
 }

src/TextUI/Command/Commands/ListTestsAsTextCommand.php

@@ -12,30 +12,25 @@
 use function sprintf;
 use function str_replace;
 use PHPUnit\Framework\TestCase;
-use PHPUnit\Framework\TestSuite;
 use PHPUnit\Runner\PhptTestCase;
-use PHPUnit\TextUI\Configuration\Registry;
-use RecursiveIteratorIterator;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  */
 final readonly class ListTestsAsTextCommand implements Command
 {
-    private TestSuite $suite;
+    private array $tests;
 
-    public function __construct(TestSuite $suite)
+    public function __construct(array $tests)
     {
-        $this->suite = $suite;
+        $this->tests = $tests;
     }
 
     public function execute(): Result
     {
-        $buffer = $this->warnAboutConflictingOptions();
+        $buffer = 'Available test(s):' . PHP_EOL;
 
-        $buffer .= 'Available test(s):' . PHP_EOL;
-
-        foreach (new RecursiveIteratorIterator($this->suite) as $test) {
+        foreach ($this->tests as $test) {
             if ($test instanceof TestCase) {
                 $name = sprintf(
                     '%s::%s',
@@ -56,29 +51,4 @@ public function execute(): Result
 
         return Result::from($buffer);
     }
-
-    private function warnAboutConflictingOptions(): string
-    {
-        $buffer = '';
-
-        $configuration = Registry::get();
-
-        if ($configuration->hasFilter()) {
-            $buffer .= 'The --filter and --list-tests options cannot be combined, --filter is ignored' . PHP_EOL;
-        }
-
-        if ($configuration->hasGroups()) {
-            $buffer .= 'The --group and --list-tests options cannot be combined, --group is ignored' . PHP_EOL;
-        }
-
-        if ($configuration->hasExcludeGroups()) {
-            $buffer .= 'The --exclude-group and --list-tests options cannot be combined, --exclude-group is ignored' . PHP_EOL;
-        }
-
-        if (!empty($buffer)) {
-            $buffer .= PHP_EOL;
-        }
-
-        return $buffer;
-    }
 }

src/TextUI/Command/Commands/ListTestsAsXmlCommand.php

@@ -13,29 +13,25 @@
 use function ksort;
 use function sprintf;
 use PHPUnit\Framework\TestCase;
-use PHPUnit\Framework\TestSuite;
 use PHPUnit\Runner\PhptTestCase;
-use PHPUnit\TextUI\Configuration\Registry;
-use RecursiveIteratorIterator;
 use XMLWriter;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  */
 final readonly class ListTestsAsXmlCommand implements Command
 {
+    private array $tests;
     private string $filename;
-    private TestSuite $suite;
 
-    public function __construct(string $filename, TestSuite $suite)
+    public function __construct(array $tests, string $filename)
     {
+        $this->tests    = $tests;
         $this->filename = $filename;
-        $this->suite    = $suite;
     }
 
     public function execute(): Result
     {
-        $buffer = $this->warnAboutConflictingOptions();
         $writer = new XMLWriter;
 
         $writer->openMemory();
@@ -50,7 +46,7 @@ public function execute(): Result
         $currentTestClass = null;
         $groups           = [];
 
-        foreach (new RecursiveIteratorIterator($this->suite) as $test) {
+        foreach ($this->tests as $test) {
             if ($test instanceof TestCase) {
                 foreach ($test->groups() as $group) {
                     if (!isset($groups[$group])) {
@@ -121,36 +117,11 @@ public function execute(): Result
 
         file_put_contents($this->filename, $writer->outputMemory());
 
-        $buffer .= sprintf(
-            'Wrote list of tests that would have been run to %s' . PHP_EOL,
-            $this->filename,
+        return Result::from(
+            sprintf(
+                'Wrote list of tests that would have been run to %s' . PHP_EOL,
+                $this->filename,
+            ),
         );
-
-        return Result::from($buffer);
-    }
-
-    private function warnAboutConflictingOptions(): string
-    {
-        $buffer = '';
-
-        $configuration = Registry::get();
-
-        if ($configuration->hasFilter()) {
-            $buffer .= 'The --filter and --list-tests-xml options cannot be combined, --filter is ignored' . PHP_EOL;
-        }
-
-        if ($configuration->hasGroups()) {
-            $buffer .= 'The --group and --list-tests-xml options cannot be combined, --group is ignored' . PHP_EOL;
-        }
-
-        if ($configuration->hasExcludeGroups()) {
-            $buffer .= 'The --exclude-group and --list-tests-xml options cannot be combined, --exclude-group is ignored' . PHP_EOL;
-        }
-
-        if (!empty($buffer)) {
-            $buffer .= PHP_EOL;
-        }
-
-        return $buffer;
     }
 }

tests/end-to-end/_files/list-tests/ExampleTest.php

@@ -7,14 +7,22 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-namespace PHPUnit\TestFixture\ListTestsXml;
+namespace PHPUnit\TestFixture\ListingTestsAndGroups;
 
+use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\TestCase;
 
-final class AnotherExampleTest extends TestCase
+final class ExampleTest extends TestCase
 {
+    #[Group('one')]
     public function testOne(): void
     {
         $this->assertTrue(true);
     }
+
+    #[Group('two')]
+    public function testTwo(): void
+    {
+        $this->assertTrue(true);
+    }
 }