[PHPUnitBridge] deprecations not enabled anymore when disabled=0

l-vo · l-vo · commit 6908e3d156a2 · 2020-09-01T15:29:20.000+02:00
Allow to pass 0 or 1 to "disabled" to be consistent with "verbose" key behavior
diff --git a/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler.php b/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler.php
@@ -49,8 +49,9 @@ public function __construct()
      * Registers and configures the deprecation handler.
      *
      * The mode is a query string with options:
-     *  - "disabled" to disable the deprecation handler
+     *  - "disabled" to enable/disable the deprecation handler
      *  - "verbose" to enable/disable displaying the deprecation report
+     *  - "quiet" to disable displaying the deprecation report only for some groups (i.e. quiet[]=other)
      *  - "max" to configure the number of deprecations to allow before exiting with a non-zero
      *    status code; it's an array with keys "total", "self", "direct" and "indirect"
      *
diff --git a/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler/Configuration.php b/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler/Configuration.php
@@ -166,30 +166,29 @@ public static function fromUrlEncodedString($serializedConfiguration)
             }
         }
 
-        if (isset($normalizedConfiguration['disabled'])) {
+        $normalizedConfiguration += [
+            'max' => [],
+            'disabled' => false,
+            'verbose' => true,
+            'quiet' => [],
+        ];
+
+        if ('' === $normalizedConfiguration['disabled'] || filter_var($normalizedConfiguration['disabled'], FILTER_VALIDATE_BOOLEAN)) {
             return self::inDisabledMode();
         }
 
         $verboseOutput = [];
-        if (!isset($normalizedConfiguration['verbose'])) {
-            $normalizedConfiguration['verbose'] = true;
-        }
-
         foreach (['unsilenced', 'direct', 'indirect', 'self', 'other'] as $group) {
-            $verboseOutput[$group] = (bool) $normalizedConfiguration['verbose'];
+            $verboseOutput[$group] = filter_var($normalizedConfiguration['verbose'], FILTER_VALIDATE_BOOLEAN);
         }
 
-        if (isset($normalizedConfiguration['quiet']) && \is_array($normalizedConfiguration['quiet'])) {
+        if (\is_array($normalizedConfiguration['quiet'])) {
             foreach ($normalizedConfiguration['quiet'] as $shushedGroup) {
                 $verboseOutput[$shushedGroup] = false;
             }
         }
 
-        return new self(
-            isset($normalizedConfiguration['max']) ? $normalizedConfiguration['max'] : [],
-            '',
-            $verboseOutput
-        );
+        return new self($normalizedConfiguration['max'], '', $verboseOutput);
     }
 
     /**
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/ConfigurationTest.php b/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/ConfigurationTest.php
@@ -176,10 +176,22 @@ public function testItCanTellWhetherToDisplayAStackTrace()
         $this->assertTrue($configuration->shouldDisplayStackTrace('interesting'));
     }
 
-    public function testItCanBeDisabled()
+    public function provideItCanBeDisabled(): array
     {
-        $configuration = Configuration::fromUrlEncodedString('disabled');
-        $this->assertFalse($configuration->isEnabled());
+        return [
+            ['disabled', false],
+            ['disabled=1', false],
+            ['disabled=0', true]
+        ];
+    }
+
+    /**
+     * @dataProvider provideItCanBeDisabled
+     */
+    public function testItCanBeDisabled(string $encodedString, bool $expectedEnabled)
+    {
+        $configuration = Configuration::fromUrlEncodedString($encodedString);
+        $this->assertSame($expectedEnabled, $configuration->isEnabled());
     }
 
     public function testItCanBeShushed()
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/disabled_1.phpt b/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/disabled_1.phpt
@@ -0,0 +1,37 @@
+--TEST--
+Test DeprecationErrorHandler in default mode
+--FILE--
+<?php
+
+$k = 'SYMFONY_DEPRECATIONS_HELPER';
+putenv($k.'='.$_SERVER[$k] = $_ENV[$k] = 'disabled=1');
+putenv($k);
+putenv('ANSICON');
+putenv('ConEmuANSI');
+putenv('TERM');
+
+$vendor = __DIR__;
+while (!file_exists($vendor.'/vendor')) {
+    $vendor = dirname($vendor);
+}
+define('PHPUNIT_COMPOSER_INSTALL', $vendor.'/vendor/autoload.php');
+require PHPUNIT_COMPOSER_INSTALL;
+require_once __DIR__.'/../../bootstrap.php';
+
+@trigger_error('root deprecation', E_USER_DEPRECATED);
+
+eval(<<<'EOPHP'
+namespace PHPUnit\Util;
+
+class Test
+{
+    public static function getGroups()
+    {
+        return array();
+    }
+}
+EOPHP
+);
+?>
+--EXPECTF--
+

Original file line number	Diff line number	Diff line change
`@@ -49,8 +49,9 @@ public function __construct()`
`49`	`49`	`* Registers and configures the deprecation handler.`
`50`	`50`	`*`
`51`	`51`	`* The mode is a query string with options:`
`52`		`- * - "disabled" to disable the deprecation handler`
	`52`	`+ * - "disabled" to enable/disable the deprecation handler`
`53`	`53`	`* - "verbose" to enable/disable displaying the deprecation report`
	`54`	`+ * - "quiet" to disable displaying the deprecation report only for some groups (i.e. quiet[]=other)`
`54`	`55`	`* - "max" to configure the number of deprecations to allow before exiting with a non-zero`
`55`	`56`	`* status code; it's an array with keys "total", "self", "direct" and "indirect"`
`56`	`57`	`*`
Original file line number	Diff line number	Diff line change
`@@ -166,30 +166,29 @@ public static function fromUrlEncodedString($serializedConfiguration)`
`166`	`166`	`}`
`167`	`167`	`}`
`168`	`168`
`169`		`- if (isset($normalizedConfiguration['disabled'])) {`
	`169`	`+ $normalizedConfiguration += [`
	`170`	`+ 'max' => [],`
	`171`	`+ 'disabled' => false,`
	`172`	`+ 'verbose' => true,`
	`173`	`+ 'quiet' => [],`
	`174`	`+ ];`
	`175`	`+`
	`176`	`+ if ('' === $normalizedConfiguration['disabled'] \|\| filter_var($normalizedConfiguration['disabled'], FILTER_VALIDATE_BOOLEAN)) {`
`170`	`177`	`return self::inDisabledMode();`
`171`	`178`	`}`
`172`	`179`
`173`	`180`	`$verboseOutput = [];`
`174`		`- if (!isset($normalizedConfiguration['verbose'])) {`
`175`		`- $normalizedConfiguration['verbose'] = true;`
`176`		`- }`
`177`		`-`
`178`	`181`	`foreach (['unsilenced', 'direct', 'indirect', 'self', 'other'] as $group) {`
`179`		`- $verboseOutput[$group] = (bool) $normalizedConfiguration['verbose'];`
	`182`	`+ $verboseOutput[$group] = filter_var($normalizedConfiguration['verbose'], FILTER_VALIDATE_BOOLEAN);`
`180`	`183`	`}`
`181`	`184`
`182`		`- if (isset($normalizedConfiguration['quiet']) && \is_array($normalizedConfiguration['quiet'])) {`
	`185`	`+ if (\is_array($normalizedConfiguration['quiet'])) {`
`183`	`186`	`foreach ($normalizedConfiguration['quiet'] as $shushedGroup) {`
`184`	`187`	`$verboseOutput[$shushedGroup] = false;`
`185`	`188`	`}`
`186`	`189`	`}`
`187`	`190`
`188`		`- return new self(`
`189`		`- isset($normalizedConfiguration['max']) ? $normalizedConfiguration['max'] : [],`
`190`		`- '',`
`191`		`- $verboseOutput`
`192`		`- );`
	`191`	`+ return new self($normalizedConfiguration['max'], '', $verboseOutput);`
`193`	`192`	`}`
`194`	`193`
`195`	`194`	`/**`