Use `@<data-set-name>` format (compatible with `--filter` CLI option) in defect messages #6272

staabm · 2025-07-12T09:55:27Z

After this PR the default phpunit result printer will format errors the same way the --filter CLI option expects them.

that way the user can copy/paste the tool output and re-use it as the CLI filter option value:

phpunit output for numbered datasets:

There was 1 failure:

1) testSuiteSorterDefectsWithDataProviderTest::testOne#1 with data (false)
Failed asserting that false is true.

CLI option for numbered datasets:
--filter "testSuiteSorterDefectsWithDataProviderTest::testOne#1"

phpunit output for named datasets:

There was 1 failure:

1) testSuiteSorterDefectsWithDataProviderTest::testOne@data-set with data (false)
Failed asserting that false is true.

CLI option for named datasets:
--filter "testSuiteSorterDefectsWithDataProviderTest::testOne@data-set"

staabm · 2025-07-12T10:04:31Z

src/Framework/TestCase.php

    /**
     * @internal This method is not covered by the backward compatibility promise for PHPUnit
     */
    final public function dataSetAsString(): string


since TestDox formatter does not use the className::methodName <dataset> format, I did not change the format in this method itself but created a new dataSetAsFilterString for use only in the default-printer

staabm · 2025-07-12T10:04:50Z

commit 1&2 are pure refactoring. the actual change is in commit 3

This PR was merged into the 7.4 branch. Discussion ---------- run tests with PHPUnit 12.3 | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | | License | MIT The test updates reflect the following changes in PHPUnit 12.2 and 12.3: - a warning is emitted when a data provider provides data sets that have more values than the test method consuming the data set - the format in which data sets are displayed in test reports has changed affecting the modified test in the PhpUnitBridge (see sebastianbergmann/phpunit#6272) - errors triggered in the `tearDown()` method of skipped tests are no longer silence affecting the modified tests in the Form component where the `$defaultLocale` property is not initialised (see sebastianbergmann/phpunit#6281) Commits ------- cf7e41e run tests with PHPUnit 12.3

This PR was merged into the 7.4 branch. Discussion ---------- run tests with PHPUnit 12.3 | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | | License | MIT The test updates reflect the following changes in PHPUnit 12.2 and 12.3: - a warning is emitted when a data provider provides data sets that have more values than the test method consuming the data set - the format in which data sets are displayed in test reports has changed affecting the modified test in the PhpUnitBridge (see sebastianbergmann/phpunit#6272) - errors triggered in the `tearDown()` method of skipped tests are no longer silence affecting the modified tests in the Form component where the `$defaultLocale` property is not initialised (see sebastianbergmann/phpunit#6281) Commits ------- cf7e41e1092 run tests with PHPUnit 12.3

As far as I can tell the goal was to change the test name printed by the default printer to make it easier to copy-paste it into --filter. Example: 1) PHPUnit\TestFixture\DataProviderFilterTest::testFalse@other false test2 with data (false) Into: --filter 'testFalse@other false test2' However, the PR changed the test name more broadly than necessary. This broke --filter pattern used by PHPStorm. E.g: --filter '/PHPUnit\\TestFixture\\DataProviderFilterTest::testFalse with data set \"other false test\"$/'

It was broken by PR sebastianbergmann#6272. As far as I can tell the goal was to change the test name printed by the default printer to make it easier to copy-paste it into --filter. Example: 1) PHPUnit\TestFixture\DataProviderFilterTest::testFalse@other false test2 with data (false) Into: --filter 'testFalse@other false test2' However, the PR changed the test name more broadly than necessary. This broke --filter pattern used by PHPStorm. E.g: --filter '/PHPUnit\\TestFixture\\DataProviderFilterTest::testFalse with data set \"other false test\"$/'

It was broken by PR #6272. As far as I can tell the goal was to change the test name printed by the default printer to make it easier to copy-paste it into --filter. Example: 1) PHPUnit\TestFixture\DataProviderFilterTest::testFalse@other false test2 with data (false) Into: --filter 'testFalse@other false test2' However, the PR changed the test name more broadly than necessary. This broke --filter pattern used by PHPStorm. E.g: --filter '/PHPUnit\\TestFixture\\DataProviderFilterTest::testFalse with data set \"other false test\"$/'

staabm added 3 commits July 12, 2025 11:25

Simplify TestCase->dataSetAsString()

2ae35dd

Refactor: extract dataSetAsFilterString

43469ae

Use "@<data-set-name>" --filter CLI option compatible error format

59ee1ef

staabm commented Jul 12, 2025

View reviewed changes

staabm marked this pull request as ready for review July 12, 2025 10:04

staabm added 2 commits July 12, 2025 12:15

added more tests

32769ea

naming

c5e600a

sebastianbergmann added this to the PHPUnit 12.3 milestone Jul 12, 2025

sebastianbergmann added type/enhancement A new idea that should be implemented feature/test-runner CLI test runner feature/data-provider Data Providers feature/configuration/cli labels Jul 12, 2025

sebastianbergmann merged commit ff57330 into sebastianbergmann:main Jul 12, 2025
25 checks passed

staabm deleted the data-filter branch July 12, 2025 11:07

sebastianbergmann changed the title ~~Use "@<data-set-name>" --filter CLI option compatible error format~~ Use @<data-set-name> format (compatible with --filter CLI option) in defect messages Jul 12, 2025

sourcery-ai bot mentioned this pull request Jul 12, 2025

[pull] main from sebastianbergmann:main Stars1233/phpunit#31

Merged

flohw mentioned this pull request Aug 1, 2025

Latest update of phpunit could make the dataset undetactable and fail zenstruck/browser#176

Open

staabm mentioned this pull request Aug 2, 2025

Make the --filter option shorter for PHPUnit infection/infection#1548

Merged

xabbuh mentioned this pull request Aug 12, 2025

run tests with PHPUnit 12.3 symfony/symfony#61390

Merged

schlndh mentioned this pull request Sep 12, 2025

--filter format used by PhpStorm stopped working #6364

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Use `@<data-set-name>` format (compatible with `--filter` CLI option) in defect messages #6272

Use `@<data-set-name>` format (compatible with `--filter` CLI option) in defect messages #6272

Uh oh!

staabm commented Jul 12, 2025 •

edited

Loading

Uh oh!

staabm Jul 12, 2025 •

edited

Loading

Uh oh!

staabm commented Jul 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Use @<data-set-name> format (compatible with --filter CLI option) in defect messages #6272

Use @<data-set-name> format (compatible with --filter CLI option) in defect messages #6272

Uh oh!

Conversation

staabm commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

staabm Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

staabm commented Jul 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Use `@<data-set-name>` format (compatible with `--filter` CLI option) in defect messages #6272

Use `@<data-set-name>` format (compatible with `--filter` CLI option) in defect messages #6272

staabm commented Jul 12, 2025 •

edited

Loading

staabm Jul 12, 2025 •

edited

Loading