Do not convert PHP deprecations to exceptions by default

sebastianbergmann · Sep 25, 2021 · fac0262 · fac0262
1 parent 5089e6c
commit fac0262
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 6 deletions.
diff --git a/ChangeLog-8.5.md b/ChangeLog-8.5.md
@@ -4,6 +4,11 @@ All notable changes of the PHPUnit 8.5 release series are documented in this fil
 
 ## [8.5.21] - 2021-MM-DD
 
+### Changed
+
+* PHPUnit no longer converts PHP deprecations to exceptions by default (configure `convertDeprecationsToExceptions="true"` to enable this)
+* The PHPUnit XML configuration file generator now configures `convertDeprecationsToExceptions="true"`
+
 ### Fixed
 
 * [#4772](https://github.com/sebastianbergmann/phpunit/pull/4772): TestDox HTML report not displayed correctly when browser has custom colour settings

diff --git a/phpunit.xml b/phpunit.xml
@@ -2,6 +2,7 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="phpunit.xsd"
          bootstrap="tests/bootstrap.php"
+         convertDeprecationsToExceptions="true"
          colors="true"
          verbose="true">
     <testsuites>

diff --git a/phpunit.xsd b/phpunit.xsd
@@ -244,7 +244,7 @@
         <xs:attribute name="cacheTokens" type="xs:boolean" default="false"/>
         <xs:attribute name="colors" type="xs:boolean" default="false"/>
         <xs:attribute name="columns" type="columnsType" default="80"/>
-        <xs:attribute name="convertDeprecationsToExceptions" type="xs:boolean" default="true"/>
+        <xs:attribute name="convertDeprecationsToExceptions" type="xs:boolean" default="false"/>
         <xs:attribute name="convertErrorsToExceptions" type="xs:boolean" default="true"/>
         <xs:attribute name="convertNoticesToExceptions" type="xs:boolean" default="true"/>
         <xs:attribute name="convertWarningsToExceptions" type="xs:boolean" default="true"/>

diff --git a/src/Framework/TestResult.php b/src/Framework/TestResult.php
@@ -112,7 +112,7 @@ final class TestResult implements Countable
     /**
      * @var bool
      */
-    private $convertDeprecationsToExceptions = true;
+    private $convertDeprecationsToExceptions = false;
 
     /**
      * @var bool

diff --git a/src/TextUI/TestRunner.php b/src/TextUI/TestRunner.php
@@ -242,8 +242,8 @@ public function doRun(Test $suite, array $arguments = [], array $warnings = [],
 
         unset($listener, $listenerNeeded);
 
-        if (!$arguments['convertDeprecationsToExceptions']) {
-            $result->convertDeprecationsToExceptions(false);
+        if ($arguments['convertDeprecationsToExceptions']) {
+            $result->convertDeprecationsToExceptions(true);
         }
 
         if (!$arguments['convertErrorsToExceptions']) {
@@ -1245,7 +1245,7 @@ private function handleConfiguration(array &$arguments): void
         $arguments['cacheTokens']                                     = $arguments['cacheTokens'] ?? false;
         $arguments['colors']                                          = $arguments['colors'] ?? ResultPrinter::COLOR_DEFAULT;
         $arguments['columns']                                         = $arguments['columns'] ?? 80;
-        $arguments['convertDeprecationsToExceptions']                 = $arguments['convertDeprecationsToExceptions'] ?? true;
+        $arguments['convertDeprecationsToExceptions']                 = $arguments['convertDeprecationsToExceptions'] ?? false;
         $arguments['convertErrorsToExceptions']                       = $arguments['convertErrorsToExceptions'] ?? true;
         $arguments['convertNoticesToExceptions']                      = $arguments['convertNoticesToExceptions'] ?? true;
         $arguments['convertWarningsToExceptions']                     = $arguments['convertWarningsToExceptions'] ?? true;

diff --git a/src/Util/Configuration.php b/src/Util/Configuration.php
@@ -538,7 +538,7 @@ public function getPHPUnitConfiguration(): array
         if ($root->hasAttribute('convertDeprecationsToExceptions')) {
             $result['convertDeprecationsToExceptions'] = $this->getBoolean(
                 (string) $root->getAttribute('convertDeprecationsToExceptions'),
-                true
+                false
             );
         }
 

diff --git a/src/Util/ConfigurationGenerator.php b/src/Util/ConfigurationGenerator.php
@@ -29,6 +29,7 @@ final class ConfigurationGenerator
          beStrictAboutCoversAnnotation="true"
          beStrictAboutOutputDuringTests="true"
          beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
          verbose="true">
     <testsuites>
         <testsuite name="default">

diff --git a/tests/unit/Util/ConfigurationGeneratorTest.php b/tests/unit/Util/ConfigurationGeneratorTest.php
@@ -31,6 +31,7 @@ public function testGeneratesConfigurationCorrectly(): void
          beStrictAboutCoversAnnotation="true"
          beStrictAboutOutputDuringTests="true"
          beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
          verbose="true">
     <testsuites>
         <testsuite name="default">