Filter stack trace based on configured deprecation trigger functions/methods

sebastianbergmann · sebastianbergmann · commit 66d3923f3806 · 2024-03-19T11:42:06.000+01:00
diff --git a/src/Runner/ErrorHandler.php b/src/Runner/ErrorHandler.php
@@ -25,6 +25,7 @@
 use const E_USER_NOTICE;
 use const E_USER_WARNING;
 use const E_WARNING;
+use function array_keys;
 use function array_values;
 use function assert;
 use function debug_backtrace;
@@ -56,6 +57,11 @@ final class ErrorHandler
     private readonly Source $source;
     private readonly SourceFilter $sourceFilter;
 
+    /**
+     * @psalm-var array{functions: list<non-empty-string>, methods: list<array{className: class-string, methodName: non-empty-string}>}
+     */
+    private ?array $deprecationTriggers = null;
+
     public static function instance(): self
     {
         return self::$instance ?? self::$instance = new self(Registry::get()->source());
@@ -218,6 +224,14 @@ public function useBaseline(Baseline $baseline): void
         $this->baseline = $baseline;
     }
 
+    /**
+     * @psalm-param array{functions: list<non-empty-string>, methods: list<array{className: class-string, methodName: non-empty-string}>} $deprecationTriggers
+     */
+    public function useDeprecationTriggers(array $deprecationTriggers): void
+    {
+        $this->deprecationTriggers = $deprecationTriggers;
+    }
+
     /**
      * @psalm-param non-empty-string $file
      * @psalm-param positive-int $line
@@ -274,6 +288,29 @@ private function cleanedTrace(): array
         // self::cleanedTrace(), self::trigger(), self::__invoke()
         unset($trace[0], $trace[1], $trace[2]);
 
+        foreach (array_keys($trace) as $frame) {
+            foreach ($this->deprecationTriggers['functions'] as $function) {
+                if (!isset($trace[$frame]['class']) &&
+                    isset($trace[$frame]['function']) &&
+                    $trace[$frame]['function'] === $function) {
+                    unset($trace[$frame]);
+
+                    continue 2;
+                }
+            }
+
+            foreach ($this->deprecationTriggers['methods'] as $method) {
+                if (isset($trace[$frame]['class']) &&
+                    $trace[$frame]['class'] === $method['className'] &&
+                    isset($trace[$frame]['function']) &&
+                    $trace[$frame]['function'] === $method['methodName']) {
+                    unset($trace[$frame]);
+
+                    continue 2;
+                }
+            }
+        }
+
         return array_values($trace);
     }
 }
diff --git a/src/TextUI/Application.php b/src/TextUI/Application.php
@@ -187,7 +187,7 @@ public function run(array $argv): int
 
             $baselineGenerator = $this->configureBaseline($configuration);
 
-            $this->validateDeprecationTriggers($configuration);
+            $this->configureDeprecationTriggers($configuration);
 
             EventFacade::instance()->seal();
 
@@ -702,8 +702,13 @@ private function filteredTests(Configuration $configuration, TestSuite $suite):
         return $suite->collect();
     }
 
-    private function validateDeprecationTriggers(Configuration $configuration): void
+    private function configureDeprecationTriggers(Configuration $configuration): void
     {
+        $deprecationTriggers = [
+            'functions' => [],
+            'methods'   => [],
+        ];
+
         foreach ($configuration->source()->deprecationTriggers()['functions'] as $function) {
             if (!function_exists($function)) {
                 EventFacade::emitter()->testRunnerTriggeredWarning(
@@ -712,7 +717,11 @@ private function validateDeprecationTriggers(Configuration $configuration): void
                         $function,
                     ),
                 );
+
+                continue;
             }
+
+            $deprecationTriggers['functions'][] = $function;
         }
 
         foreach ($configuration->source()->deprecationTriggers()['methods'] as $method) {
@@ -737,7 +746,16 @@ private function validateDeprecationTriggers(Configuration $configuration): void
                         $methodName,
                     ),
                 );
+
+                continue;
             }
+
+            $deprecationTriggers['methods'][] = [
+                'className'  => $className,
+                'methodName' => $methodName,
+            ];
         }
+
+        ErrorHandler::instance()->useDeprecationTriggers($deprecationTriggers);
     }
 }
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/phpunit.xml b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/phpunit.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="../../../../../phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+>
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <source>
+        <include>
+            <directory>src</directory>
+        </include>
+
+        <deprecationTrigger>
+            <function>PHPUnit\TestFixture\SelfDirectIndirect\trigger_deprecation</function>
+        </deprecationTrigger>
+    </source>
+</phpunit>
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/src/FirstPartyClass.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/src/FirstPartyClass.php
@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\TestFixture\SelfDirectIndirect;
+
+use function trigger_error;
+
+final class FirstPartyClass
+{
+    public function method(): true
+    {
+        (new ThirdPartyClass)->method();
+
+        @trigger_error('deprecation in first-party code', E_USER_DEPRECATED);
+
+        return true;
+    }
+}
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/tests/FirstPartyClassTest.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/tests/FirstPartyClassTest.php
@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\TestFixture\SelfDirectIndirect;
+
+use PHPUnit\Framework\TestCase;
+
+final class FirstPartyClassTest extends TestCase
+{
+    public function testOne(): void
+    {
+        $this->assertTrue((new FirstPartyClass)->method());
+    }
+
+    public function testTwo(): void
+    {
+        $this->assertTrue((new ThirdPartyClass)->anotherMethod());
+    }
+}
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/vendor/ThirdPartyClass.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/vendor/ThirdPartyClass.php
@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+namespace PHPUnit\TestFixture\SelfDirectIndirect;
+
+final class ThirdPartyClass
+{
+    public function method(): void
+    {
+        trigger_deprecation('deprecation in third-party code');
+    }
+
+    public function anotherMethod(): true
+    {
+        return (new FirstPartyClass)->method();
+    }
+}
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/vendor/autoload.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/vendor/autoload.php
@@ -0,0 +1,4 @@
+<?php declare(strict_types=1);
+require __DIR__ . '/../src/FirstPartyClass.php';
+require __DIR__ . '/ThirdPartyClass.php';
+require __DIR__ . '/trigger_deprecation.php';
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/vendor/trigger_deprecation.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-function/vendor/trigger_deprecation.php
@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+namespace PHPUnit\TestFixture\SelfDirectIndirect;
+
+function trigger_deprecation(string $message): void
+{
+    @trigger_error($message, E_USER_DEPRECATED);
+}
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/phpunit.xml b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/phpunit.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="../../../../../phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+>
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <source>
+        <include>
+            <directory>src</directory>
+        </include>
+
+        <deprecationTrigger>
+            <method>PHPUnit\TestFixture\SelfDirectIndirect\DeprecationTrigger::triggerDeprecation</method>
+        </deprecationTrigger>
+    </source>
+</phpunit>
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/src/FirstPartyClass.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/src/FirstPartyClass.php
@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\TestFixture\SelfDirectIndirect;
+
+use function trigger_error;
+
+final class FirstPartyClass
+{
+    public function method(): true
+    {
+        (new ThirdPartyClass)->method();
+
+        @trigger_error('deprecation in first-party code', E_USER_DEPRECATED);
+
+        return true;
+    }
+}
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/tests/FirstPartyClassTest.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/tests/FirstPartyClassTest.php
@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\TestFixture\SelfDirectIndirect;
+
+use PHPUnit\Framework\TestCase;
+
+final class FirstPartyClassTest extends TestCase
+{
+    public function testOne(): void
+    {
+        $this->assertTrue((new FirstPartyClass)->method());
+    }
+
+    public function testTwo(): void
+    {
+        $this->assertTrue((new ThirdPartyClass)->anotherMethod());
+    }
+}
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/vendor/DeprecationTrigger.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/vendor/DeprecationTrigger.php
@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+namespace PHPUnit\TestFixture\SelfDirectIndirect;
+
+final class DeprecationTrigger
+{
+    public static function triggerDeprecation(string $message): void
+    {
+        @trigger_error($message, E_USER_DEPRECATED);
+    }
+}
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/vendor/ThirdPartyClass.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/vendor/ThirdPartyClass.php
@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+namespace PHPUnit\TestFixture\SelfDirectIndirect;
+
+final class ThirdPartyClass
+{
+    public function method(): void
+    {
+        DeprecationTrigger::triggerDeprecation('deprecation in third-party code');
+    }
+
+    public function anotherMethod(): true
+    {
+        return (new FirstPartyClass)->method();
+    }
+}
diff --git a/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/vendor/autoload.php b/tests/end-to-end/self-direct-indirect/_files/deprecation-trigger-method/vendor/autoload.php
@@ -0,0 +1,4 @@
+<?php declare(strict_types=1);
+require __DIR__ . '/../src/FirstPartyClass.php';
+require __DIR__ . '/ThirdPartyClass.php';
+require __DIR__ . '/DeprecationTrigger.php';
diff --git a/tests/end-to-end/self-direct-indirect/deprecation-trigger-function.phpt b/tests/end-to-end/self-direct-indirect/deprecation-trigger-function.phpt
@@ -0,0 +1,54 @@
+--TEST--
+The right events are emitted in the right order for a test that runs code which triggers E_USER_DEPRECATED
+--FILE--
+<?php declare(strict_types=1);
+$traceFile = tempnam(sys_get_temp_dir(), __FILE__);
+
+$_SERVER['argv'][] = '--do-not-cache-result';
+$_SERVER['argv'][] = '--no-output';
+$_SERVER['argv'][] = '--log-events-text';
+$_SERVER['argv'][] = $traceFile;
+$_SERVER['argv'][] = '--configuration';
+$_SERVER['argv'][] = __DIR__ . '/_files/deprecation-trigger-function';
+
+require __DIR__ . '/../../bootstrap.php';
+
+(new PHPUnit\TextUI\Application)->run($_SERVER['argv']);
+
+print file_get_contents($traceFile);
+
+unlink($traceFile);
+--EXPECTF--
+PHPUnit Started (PHPUnit %s using %s)
+Test Runner Configured
+Bootstrap Finished (%sautoload.php)
+Test Suite Loaded (2 tests)
+Event Facade Sealed
+Test Runner Started
+Test Suite Sorted
+Test Runner Execution Started (2 tests)
+Test Suite Started (%sphpunit.xml, 2 tests)
+Test Suite Started (default, 2 tests)
+Test Suite Started (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest, 2 tests)
+Test Preparation Started (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testOne)
+Test Prepared (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testOne)
+Test Triggered Deprecation (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testOne, issue triggered by first-party code calling into third-party code, suppressed using operator)
+deprecation in third-party code
+Test Triggered Deprecation (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testOne, issue triggered by first-party code calling into first-party code, suppressed using operator)
+deprecation in first-party code
+Test Passed (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testOne)
+Test Finished (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testOne)
+Test Preparation Started (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testTwo)
+Test Prepared (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testTwo)
+Test Triggered Deprecation (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testTwo, issue triggered by first-party code calling into third-party code, suppressed using operator)
+deprecation in third-party code
+Test Triggered Deprecation (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testTwo, issue triggered by third-party code, suppressed using operator)
+deprecation in first-party code
+Test Passed (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testTwo)
+Test Finished (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest::testTwo)
+Test Suite Finished (PHPUnit\TestFixture\SelfDirectIndirect\FirstPartyClassTest, 2 tests)
+Test Suite Finished (default, 2 tests)
+Test Suite Finished (%sphpunit.xml, 2 tests)
+Test Runner Execution Finished
+Test Runner Finished
+PHPUnit Finished (Shell Exit Code: 0)
diff --git a/tests/end-to-end/self-direct-indirect/deprecation-trigger-method.phpt b/tests/end-to-end/self-direct-indirect/deprecation-trigger-method.phpt

Original file line number	Diff line number	Diff line change
`@@ -187,7 +187,7 @@ public function run(array $argv): int`
`187`	`187`
`188`	`188`	`$baselineGenerator = $this->configureBaseline($configuration);`
`189`	`189`
`190`		`- $this->validateDeprecationTriggers($configuration);`
	`190`	`+ $this->configureDeprecationTriggers($configuration);`
`191`	`191`
`192`	`192`	`EventFacade::instance()->seal();`
`193`	`193`
`@@ -702,8 +702,13 @@ private function filteredTests(Configuration $configuration, TestSuite $suite):`
`702`	`702`	`return $suite->collect();`
`703`	`703`	`}`
`704`	`704`
`705`		`- private function validateDeprecationTriggers(Configuration $configuration): void`
	`705`	`+ private function configureDeprecationTriggers(Configuration $configuration): void`
`706`	`706`	`{`
	`707`	`+ $deprecationTriggers = [`
	`708`	`+ 'functions' => [],`
	`709`	`+ 'methods' => [],`
	`710`	`+ ];`
	`711`	`+`
`707`	`712`	`foreach ($configuration->source()->deprecationTriggers()['functions'] as $function) {`
`708`	`713`	`if (!function_exists($function)) {`
`709`	`714`	`EventFacade::emitter()->testRunnerTriggeredWarning(`
`@@ -712,7 +717,11 @@ private function validateDeprecationTriggers(Configuration $configuration): void`
`712`	`717`	`$function,`
`713`	`718`	`),`
`714`	`719`	`);`
	`720`	`+`
	`721`	`+ continue;`
`715`	`722`	`}`
	`723`	`+`
	`724`	`+ $deprecationTriggers['functions'][] = $function;`
`716`	`725`	`}`
`717`	`726`
`718`	`727`	`foreach ($configuration->source()->deprecationTriggers()['methods'] as $method) {`
`@@ -737,7 +746,16 @@ private function validateDeprecationTriggers(Configuration $configuration): void`
`737`	`746`	`$methodName,`
`738`	`747`	`),`
`739`	`748`	`);`
	`749`	`+`
	`750`	`+ continue;`
`740`	`751`	`}`
	`752`	`+`
	`753`	`+ $deprecationTriggers['methods'][] = [`
	`754`	`+ 'className' => $className,`
	`755`	`+ 'methodName' => $methodName,`
	`756`	`+ ];`
`741`	`757`	`}`
	`758`	`+`
	`759`	`+ ErrorHandler::instance()->useDeprecationTriggers($deprecationTriggers);`
`742`	`760`	`}`
`743`	`761`	`}`