Skip to content

Commit 9eea9eb

Browse files
nicolas-grekasnicolas-grekas
committed
[PhpUnitBridge] Enforce @-silencing of deprecation notices according to new policy
1 parent 338cd02 commit 9eea9eb

File tree

78 files changed

+26
-263
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+26
-263
lines changed

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

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
namespace Symfony\Bridge\PhpUnit;
1313

1414
/**
15-
* Catch deprecation notices and print a summary report at the end of the test suite
15+
* Catch deprecation notices and print a summary report at the end of the test suite.
1616
*
1717
* @author Nicolas Grekas <[email protected]>
1818
*/
@@ -26,9 +26,11 @@ public static function register($mode = false)
2626
return;
2727
}
2828
$deprecations = array(
29+
'unsilencedCount' => 0,
2930
'remainingCount' => 0,
3031
'legacyCount' => 0,
3132
'otherCount' => 0,
33+
'unsilenced' => array(),
3234
'remaining' => array(),
3335
'legacy' => array(),
3436
'other' => array(),
@@ -45,21 +47,25 @@ public static function register($mode = false)
4547
// No-op
4648
}
4749

48-
if (isset($trace[$i]['object']) || isset($trace[$i]['class'])) {
50+
if (0 !== error_reporting()) {
51+
$group = 'unsilenced';
52+
$ref = &$deprecations[$group][$msg]['count'];
53+
++$ref;
54+
} elseif (isset($trace[$i]['object']) || isset($trace[$i]['class'])) {
4955
$class = isset($trace[$i]['object']) ? get_class($trace[$i]['object']) : $trace[$i]['class'];
5056
$method = $trace[$i]['function'];
5157

5258
$group = 0 === strpos($method, 'testLegacy') || 0 === strpos($method, 'provideLegacy') || 0 === strpos($method, 'getLegacy') || strpos($class, '\Legacy') || in_array('legacy', \PHPUnit_Util_Test::getGroups($class, $method), true) ? 'legacy' : 'remaining';
5359

5460
if ('legacy' !== $group && 'weak' !== $mode) {
55-
$ref =& $deprecations[$group][$msg]['count'];
61+
$ref = &$deprecations[$group][$msg]['count'];
5662
++$ref;
57-
$ref =& $deprecations[$group][$msg][$class.'::'.$method];
63+
$ref = &$deprecations[$group][$msg][$class.'::'.$method];
5864
++$ref;
5965
}
6066
} else {
6167
$group = 'other';
62-
$ref =& $deprecations[$group][$msg]['count'];
68+
$ref = &$deprecations[$group][$msg]['count'];
6369
++$ref;
6470
}
6571
++$deprecations[$group.'Count'];
@@ -95,7 +101,7 @@ public static function register($mode = false)
95101
return $b['count'] - $a['count'];
96102
};
97103

98-
foreach (array('remaining', 'legacy', 'other') as $group) {
104+
foreach (array('unsilenced', 'remaining', 'legacy', 'other') as $group) {
99105
if ($deprecations[$group.'Count']) {
100106
echo "\n", $colorize(sprintf('%s deprecation notices (%d)', ucfirst($group), $deprecations[$group.'Count']), 'legacy' !== $group), "\n";
101107

@@ -117,7 +123,7 @@ public static function register($mode = false)
117123
if (!empty($notices)) {
118124
echo "\n";
119125
}
120-
if ('weak' !== $mode && ($deprecations['remaining'] || $deprecations['other'])) {
126+
if ('weak' !== $mode && ($deprecations['unsilenced'] || $deprecations['remaining'] || $deprecations['other'])) {
121127
exit(1);
122128
}
123129
});

‎src/Symfony/Bridge/PhpUnit/README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,17 @@ It comes with the following features:
99
* auto-register `class_exists` to load Doctrine annotations;
1010
* print a user deprecation notices summary at the end of the test suite.
1111

12-
By default any non-legacy-tagged deprecation notice will make tests fail.
12+
By default any non-legacy-tagged or any non-@-silenced deprecation notices will
13+
make tests fail.
1314
This can be changed by setting the SYMFONY_DEPRECATIONS_HELPER environment
1415
variable to `weak`. This will make the bridge ignore deprecation notices and
1516
is useful to projects that must use deprecated interfaces for backward
1617
compatibility reasons.
1718

1819
A summary of deprecation notices is displayed at the end of the test suite:
1920

21+
* **Unsilenced** reports deprecation notices that were triggered without the
22+
recommended @-silencing operator;
2023
* **Legacy** deprecation notices denote tests that explicitly test some legacy
2124
interfaces. There are four ways to mark a test as legacy:
2225
- make its class start with the `Legacy` prefix;
@@ -35,6 +38,12 @@ Add this bridge to the `require-dev` section of your composer.json file
3538
When running `phpunit`, you will see a summary of deprecation notices at the end
3639
of the test suite.
3740

41+
Deprecation notices in the **Unsilenced** section should just be @-silenced:
42+
`@trigger_error('...', E_USER_DEPRECATED);`. Without the @-silencing operator,
43+
users would need to opt-out from deprecation notices. Silencing by default swaps
44+
this behavior and allows users to opt-in when they are ready to cope with them
45+
(by adding a custom error handler like the one provided by this bridge.)
46+
3847
Deprecation notices in the **Remaining/Other** section need some thought.
3948
You have to decide either to:
4049

‎src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/AbstractDescriptorTest.php‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,11 @@ public function getDescribeContainerBuilderTestData()
7272
*/
7373
public function testLegacyDescribeSynchronizedServiceDefinition(Definition $definition, $expectedDescription)
7474
{
75-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
76-
7775
$this->assertDescription($expectedDescription, $definition);
7876
}
7977

8078
public function provideLegacySynchronizedServiceDefinitionTestData()
8179
{
82-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
83-
8480
return $this->getDescriptionTestData(ObjectsProvider::getLegacyContainerDefinitions());
8581
}
8682

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/LegacyFragmentRendererPassTest.php‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@
2020
*/
2121
class LegacyFragmentRendererPassTest extends \PHPUnit_Framework_TestCase
2222
{
23-
protected function setUp()
24-
{
25-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
26-
}
27-
2823
/**
2924
* Tests that content rendering not implementing FragmentRendererInterface
3025
* trigger an exception.

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/LegacyTemplatingAssetHelperPassTest.php‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,6 @@
2121
*/
2222
class LegacyTemplatingAssetHelperPassTest extends \PHPUnit_Framework_TestCase
2323
{
24-
protected function setUp()
25-
{
26-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
27-
}
28-
2924
public function getScopesTests()
3025
{
3126
return array(

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,6 @@ public function testInvalidValueTrustedProxies()
9393
*/
9494
public function testLegacyInvalidValueAssets()
9595
{
96-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
97-
9896
$processor = new Processor();
9997
$configuration = new Configuration(true);
10098
$processor->processConfiguration($configuration, array(

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,6 @@ public function testTemplating()
208208
*/
209209
public function testLegacyTemplatingAssets()
210210
{
211-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
212-
213211
$this->checkAssetsPackages($this->createContainerFromFile('legacy_templating_assets'), true);
214212
}
215213

@@ -296,8 +294,6 @@ public function testValidation()
296294
*/
297295
public function testLegacyFullyConfiguredValidationService()
298296
{
299-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
300-
301297
if (!extension_loaded('apc')) {
302298
$this->markTestSkipped('The apc extension is not available.');
303299
}
@@ -399,8 +395,6 @@ public function testFormsCanBeEnabledWithoutCsrfProtection()
399395
*/
400396
public function testLegacyFormCsrfFieldNameCanBeSetUnderCsrfSettings()
401397
{
402-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
403-
404398
$container = $this->createContainerFromFile('form_csrf_sets_field_name');
405399

406400
$this->assertTrue($container->getParameter('form.type_extension.csrf.enabled'));
@@ -412,8 +406,6 @@ public function testLegacyFormCsrfFieldNameCanBeSetUnderCsrfSettings()
412406
*/
413407
public function testLegacyFormCsrfFieldNameUnderFormSettingsTakesPrecedence()
414408
{
415-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
416-
417409
$container = $this->createContainerFromFile('form_csrf_under_form_sets_field_name');
418410

419411
$this->assertTrue($container->getParameter('form.type_extension.csrf.enabled'));

‎src/Symfony/Bundle/FrameworkBundle/Tests/Fragment/LegacyContainerAwareHIncludeFragmentRendererTest.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ class LegacyContainerAwareHIncludeFragmentRendererTest extends TestCase
2222
{
2323
public function testRender()
2424
{
25-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
26-
2725
$container = $this->getMock('Symfony\Component\DependencyInjection\ContainerInterface');
2826
$container->expects($this->once())
2927
->method('get')

‎src/Symfony/Bundle/FrameworkBundle/Tests/Templating/GlobalVariablesTest.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ protected function setUp()
3131
*/
3232
public function testLegacyGetSecurity()
3333
{
34-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
35-
3634
$securityContext = $this->getMock('Symfony\Component\Security\Core\SecurityContextInterface');
3735

3836
$this->assertNull($this->globals->getSecurity());

‎src/Symfony/Bundle/FrameworkBundle/Tests/Templating/Helper/AssetsHelperTest.php‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ class AssetsHelperTest extends \PHPUnit_Framework_TestCase
2323
*/
2424
public function testLegacyGetUrl()
2525
{
26-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
27-
2826
$package = new Package(new StaticVersionStrategy('22', '%s?version=%s'));
2927
$packages = new Packages($package);
3028
$helper = new AssetsHelper($packages);
@@ -37,8 +35,6 @@ public function testLegacyGetUrl()
3735
*/
3836
public function testLegacyGetVersion()
3937
{
40-
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
41-
4238
$package = new Package(new StaticVersionStrategy('22'));
4339
$imagePackage = new Package(new StaticVersionStrategy('42'));
4440
$packages = new Packages($package, array('images' => $imagePackage));

0 commit comments

Comments
 (0)