guess deprecation frame before checking for ignored baseline

Author: soyuka

src/Runner/ErrorHandler.php

@@ -101,6 +101,12 @@ public function __invoke(int $errorNumber, string $errorString, string $errorFil
 
  $test = Event\Code\TestMethodBuilder::fromCallStack();
 
+ if ($errorNumber === E_USER_DEPRECATED) {
+ $deprecationFrame = $this->guessDeprecationFrame();
+ $errorFile = $deprecationFrame['file'] ?? $errorFile;
+ $errorLine = $deprecationFrame['line'] ?? $errorLine;
+ }
+
  $ignoredByBaseline = $this->ignoredByBaseline($errorFile, $errorLine, $errorString);
  $ignoredByTest = $test->metadata()->isIgnoreDeprecations()->isNotEmpty();
 
@@ -168,13 +174,11 @@ public function __invoke(int $errorNumber, string $errorString, string $errorFil
  break;
 
  case E_USER_DEPRECATED:
- $deprecationFrame = $this->guessDeprecationFrame();
-
  Event\Facade::emitter()->testTriggeredDeprecation(
  $test,
  $errorString,
- $deprecationFrame['file'] ?? $errorFile,
- $deprecationFrame['line'] ?? $errorLine,
+ $errorFile,
+ $errorLine,
  $suppressed,
  $ignoredByBaseline,
  $ignoredByTest,

tests/end-to-end/baseline/use-baseline-ignore-deprecation.phpt

@@ -0,0 +1,24 @@
+--TEST--
+phpunit --configuration ../_files/baseline/use-baseline-ignore-deprecation/phpunit.xml
+--FILE--
+<?php declare(strict_types=1);
+$_SERVER['argv'][] = '--do-not-cache-result';
+$_SERVER['argv'][] = '--configuration';
+$_SERVER['argv'][] = __DIR__ . '/../_files/baseline/use-baseline-ignore-deprecation/phpunit.xml';
+
+require_once __DIR__ . '/../../bootstrap.php';
+
+(new PHPUnit\TextUI\Application)->run($_SERVER['argv']);
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+Runtime: %s
+Configuration: %s
+
+. 1 / 1 (100%)
+
+Time: %s, Memory: %s
+
+OK (1 tests, 1 assertions)
+
+1 issues were ignored by baseline.

tests/end-to-end/deprecation-trigger/_files/deprecation-trigger-baseline-ignore/baseline.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<files version="1">
+ <file path="vendor/ThirdPartyClass.php">
+ <line number="4" hash="67f46da0ae62f1f93b33314db1c7a53dd56f4f49">
+ <issue><![CDATA[deprecation in third-party code]]></issue>
+ </line>
+ </file>
+</files>

tests/end-to-end/deprecation-trigger/_files/deprecation-trigger-baseline-ignore/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 ignoreSuppressionOfDeprecations="true" ignoreIndirectDeprecations="false" baseline="baseline.xml">
+ <include>
+ <directory>src</directory>
+ </include>
+
+ <deprecationTrigger>
+ <function>PHPUnit\TestFixture\BaselineIgnoreDeprecation\trigger_deprecation</function>
+ </deprecationTrigger>
+ </source>
+</phpunit>

tests/end-to-end/deprecation-trigger/_files/deprecation-trigger-baseline-ignore/src/FirstPartyClass.php

@@ -0,0 +1,20 @@
+<?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\BaselineIgnoreDeprecation;
+
+final class FirstPartyClass
+{
+ public function method(): true
+ {
+ (new ThirdPartyClass)->method();
+
+ return true;
+ }
+}

tests/end-to-end/deprecation-trigger/_files/deprecation-trigger-baseline-ignore/tests/FirstPartyClassTest.php

@@ -0,0 +1,20 @@
+<?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\BaselineIgnoreDeprecation;
+
+use PHPUnit\Framework\TestCase;
+
+final class FirstPartyClassTest extends TestCase
+{
+ public function testOne(): void
+ {
+ $this->assertTrue((new ThirdPartyClass)->anotherMethod());
+ }
+}

tests/end-to-end/deprecation-trigger/_files/deprecation-trigger-baseline-ignore/vendor/ThirdPartyClass.php

@@ -0,0 +1,12 @@
+<?php declare(strict_types=1);
+namespace PHPUnit\TestFixture\BaselineIgnoreDeprecation;
+
+trigger_deprecation('deprecation in third-party code');
+
+final class ThirdPartyClass
+{
+ public function anotherMethod(): true
+ {
+ return true;
+ }
+}

tests/end-to-end/deprecation-trigger/_files/deprecation-trigger-baseline-ignore/vendor/autoload.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+require __DIR__ . '/trigger_deprecation.php';
+
+spl_autoload_register(function ($class) {
+ $parts = explode('\\', $class);
+ $file = end($parts) . '.php';
+
+ match ($file) {
+ 'FirstPartyClass.php' => require __DIR__ . '/../src/' . $file,
+ 'ThirdPartyClass.php' => require __DIR__ . '/' . $file,
+ default => throw new LogicException
+ };
+});
+

tests/end-to-end/deprecation-trigger/_files/deprecation-trigger-baseline-ignore/vendor/trigger_deprecation.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+namespace PHPUnit\TestFixture\BaselineIgnoreDeprecation;
+
+function trigger_deprecation(string $message): void
+{
+ @trigger_error($message, E_USER_DEPRECATED);
+}

tests/end-to-end/deprecation-trigger/deprecation-trigger-baseline-ignore.phpt

@@ -0,0 +1,36 @@
+--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);
+$_SERVER['argv'][] = '--do-not-cache-result';
+$_SERVER['argv'][] = '--debug';
+$_SERVER['argv'][] = '--configuration';
+$_SERVER['argv'][] = __DIR__ . '/_files/deprecation-trigger-baseline-ignore';
+
+require __DIR__ . '/../../bootstrap.php';
+
+(new PHPUnit\TextUI\Application)->run($_SERVER['argv']);
+--EXPECTF--
+PHPUnit Started (%s)
+Test Runner Configured
+Bootstrap Finished (%sautoload.php)
+Event Facade Sealed
+Test Suite Loaded (1 test)
+Test Runner Started
+Test Suite Sorted
+Test Runner Execution Started (1 test)
+Test Suite Started (%sphpunit.xml, 1 test)
+Test Suite Started (default, 1 test)
+Test Suite Started (PHPUnit\TestFixture\BaselineIgnoreDeprecation\FirstPartyClassTest, 1 test)
+Test Preparation Started (PHPUnit\TestFixture\BaselineIgnoreDeprecation\FirstPartyClassTest::testOne)
+Test Prepared (PHPUnit\TestFixture\BaselineIgnoreDeprecation\FirstPartyClassTest::testOne)
+Test Triggered Deprecation (PHPUnit\TestFixture\BaselineIgnoreDeprecation\FirstPartyClassTest::testOne, issue triggered by third-party code, suppressed using operator, ignored by baseline) in %s:%d
+deprecation in third-party code
+Test Passed (PHPUnit\TestFixture\BaselineIgnoreDeprecation\FirstPartyClassTest::testOne)
+Test Finished (PHPUnit\TestFixture\BaselineIgnoreDeprecation\FirstPartyClassTest::testOne)
+Test Suite Finished (PHPUnit\TestFixture\BaselineIgnoreDeprecation\FirstPartyClassTest, 1 test)
+Test Suite Finished (default, 1 test)
+Test Suite Finished (%sphpunit.xml, 1 test)
+Test Runner Execution Finished
+Test Runner Finished
+PHPUnit Finished (Shell Exit Code: 0)