Introduce weak vendors mode

greg0ire · greg0ire · commit bd8f0b39ae9c · 2017-02-08T23:49:07.000+01:00
Deprecations coming from the vendors are segregated from other
deprecations. A new mode is introduced, in which deprecations coming
from the vendors are not taken into account when deciding to exit with
an error code.
diff --git a/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler.php b/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler.php
@@ -19,6 +19,7 @@
 class DeprecationErrorHandler
 {
     const MODE_WEAK = 'weak';
+    const MODE_WEAK_VENDORS = 'weak_vendors';
     const MODE_DISABLED = 'disabled';
 
     private static $isRegistered = false;
@@ -28,6 +29,7 @@ class DeprecationErrorHandler
      *
      * The following reporting modes are supported:
      * - use "weak" to hide the deprecation report but keep a global count;
+     * - use "weak_vendors" to act as "weak" but only for vendors;
      * - use "/some-regexp/" to stop the test suite whenever a deprecation
      *   message matches the given regular expression;
      * - use a number to define the upper bound of allowed deprecations,
@@ -50,7 +52,10 @@ public static function register($mode = 0)
             if (false === $mode) {
                 $mode = getenv('SYMFONY_DEPRECATIONS_HELPER');
             }
-            if (DeprecationErrorHandler::MODE_WEAK !== $mode && (!isset($mode[0]) || '/' !== $mode[0])) {
+            if (!in_array($mode, array(
+                DeprecationErrorHandler::MODE_WEAK,
+                DeprecationErrorHandler::MODE_WEAK_VENDORS
+            )) && (!isset($mode[0]) || '/' !== $mode[0])) {
                 $mode = preg_match('/^[1-9][0-9]*$/', $mode) ? (int) $mode : 0;
             }
 
@@ -67,6 +72,12 @@ public static function register($mode = 0)
             'legacy' => array(),
             'other' => array(),
         );
+        if (DeprecationErrorHandler::MODE_WEAK_VENDORS === $mode) {
+            $deprecations += array(
+                'remaining vendorCount' => 0,
+                'remaining vendor' => array(),
+            );
+        }
         $deprecationHandler = function ($type, $msg, $file, $line, $context) use (&$deprecations, $getMode) {
             $mode = $getMode();
             if ((E_USER_DEPRECATED !== $type && E_DEPRECATED !== $type) || DeprecationErrorHandler::MODE_DISABLED === $mode) {
@@ -76,6 +87,10 @@ public static function register($mode = 0)
             $trace = debug_backtrace(true);
             $group = 'other';
 
+            $isVendor = (strpos($file, '/vendor/') !== false);
+            $isWeak = DeprecationErrorHandler::MODE_WEAK === $mode ||
+                DeprecationErrorHandler::MODE_WEAK_VENDORS === $mode && $isVendor;
+
             $i = count($trace);
             while (1 < $i && (!isset($trace[--$i]['class']) || ('ReflectionMethod' === $trace[$i]['class'] || 0 === strpos($trace[$i]['class'], 'PHPUnit_')))) {
                 // No-op
@@ -94,6 +109,8 @@ public static function register($mode = 0)
                     || in_array('legacy', \PHPUnit_Util_Test::getGroups($class, $method), true)
                 ) {
                     $group = 'legacy';
+                } elseif (DeprecationErrorHandler::MODE_WEAK_VENDORS === $mode && $isVendor) {
+                    $group = 'remaining vendor';
                 } else {
                     $group = 'remaining';
                 }
@@ -112,13 +129,13 @@ public static function register($mode = 0)
 
                     exit(1);
                 }
-                if ('legacy' !== $group && DeprecationErrorHandler::MODE_WEAK !== $mode) {
+                if ('legacy' !== $group && !$isWeak) {
                     $ref = &$deprecations[$group][$msg]['count'];
                     ++$ref;
                     $ref = &$deprecations[$group][$msg][$class.'::'.$method];
                     ++$ref;
                 }
-            } elseif (DeprecationErrorHandler::MODE_WEAK !== $mode) {
+            } elseif (!$isWeak) {
                 $ref = &$deprecations[$group][$msg]['count'];
                 ++$ref;
             }
@@ -162,9 +179,15 @@ public static function register($mode = 0)
                     return $b['count'] - $a['count'];
                 };
 
-                foreach (array('unsilenced', 'remaining', 'legacy', 'other') as $group) {
+                $groups = array('unsilenced', 'remaining');
+                if (DeprecationErrorHandler::MODE_WEAK_VENDORS === $mode) {
+                    $groups[] = 'remaining vendor';
+                }
+                array_push($groups, 'legacy', 'other');
+
+                foreach ($groups as $group) {
                     if ($deprecations[$group.'Count']) {
-                        echo "\n", $colorize(sprintf('%s deprecation notices (%d)', ucfirst($group), $deprecations[$group.'Count']), 'legacy' !== $group), "\n";
+                        echo "\n", $colorize(sprintf('%s deprecation notices (%d)', ucfirst($group), $deprecations[$group.'Count']), !in_array($group, array('legacy', 'remaining vendor'), true)), "\n";
 
                         uasort($deprecations[$group], $cmp);
 
