Skip to content

[PHPUnitBridge] When only ignoreFile is passed in SYMFONY_DEPRECATIONS_HELPER, deprecations no longer fail tests #45919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
mondrake opened this issue Apr 2, 2022 · 4 comments · Fixed by #45923
Closed

[PHPUnitBridge] When only ignoreFile is passed in SYMFONY_DEPRECATIONS_HELPER, deprecations no longer fail tests #45919

mondrake opened this issue Apr 2, 2022 · 4 comments · Fixed by #45923
Labels
Bug PhpUnitBridge Status: Needs Review

Comments

@mondrake
Copy link
Contributor

mondrake commented Apr 2, 2022

Symfony version(s) affected

6.1.0

Description

When only ignoreFile is passed in SYMFONY_DEPRECATIONS_HELPER, deprecations no longer fail tests, unless you also specifically set max[total]=0

How to reproduce

Use an env var like (from phpunit.xml)

<env name="SYMFONY_DEPRECATIONS_HELPER" value="ignoreFile=/var/www/d10/core/deprecation-ignore.txt"/>

Run tests that have unignored deprecations reported;

The exit code of PHPUnit is 0, not 1 as you would expect.

Add max[total]=0

<env name="SYMFONY_DEPRECATIONS_HELPER" value="max[total]=0&ignoreFile=/var/www/d10/core/deprecation-ignore.txt"/>

Rerun tests;

The exit code of PHPUnit is 1.

Possible Solution

No response

Additional Context

No response
@mondrake mondrake added the Bug label Apr 2, 2022
@mondrake mondrake mentioned this issue Apr 2, 2022
Merged
@nicolas-grekas
Copy link
Member

Doesn't #45921 also fix this?

@mondrake
Copy link
Contributor Author

mondrake commented Apr 3, 2022

Actually, this could well be working as designed.

When you do not set any SYMFONY_DEPRECATIONS_HELPER variable, the bridge ends up configured by

symfony/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler.php

Lines 268 to 270 in cfd44fb

if (!$mode) {
return $this->configuration = Configuration::fromNumber(0);
}

which is essentially as if configuring with SYMFONY_DEPRECATIONS_HELPER='strict' that sets max[total]=0

But when you pass a SYMFONY_DEPRECATIONS_HELPER='ignoreFile=xxx', the configuration is by

symfony/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler.php

Line 272 in cfd44fb

return $this->configuration = Configuration::fromUrlEncodedString((string) $mode);

which in turn sets the thresholds to 999999 in

symfony/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler/Configuration.php

Lines 97 to 101 in f97db87

foreach ($groups as $group) {
if (!isset($this->thresholds[$group])) {
$this->thresholds[$group] = 999999;
}
}

So, either we change the default threshold from 999999 to 0 to make 'strict' reporting the default when SYMFONY_DEPRECATIONS_HELPER is set but does not specifically set thresholds (but that will impact live testing, potentially), or we document that if you move from no use of SYMFONY_DEPRECATIONS_HELPER to using it to indicate the ignoreFile, then you also need to specifically set the max['whatever']=xx thresholds.

@nicolas-grekas
Copy link
Member

Good catch. That's a bug to me. Not setting any max should be the same as not setting SYMFONY_DEPRECATIONS_HELPER at all.

@mondrake
Copy link
Contributor Author

mondrake commented Apr 3, 2022

OK then, let's change the default.

@mondrake mondrake mentioned this issue Apr 3, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Bug PhpUnitBridge Status: Needs Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[PHPUnitBridge] Fix max threshold when only ignoreFile is set in SYMFONY_DEPRECATIONS_HELPER
3 participants
@nicolas-grekas @mondrake @carsonbot