fix: generate baseline with relative path

Author: nikophil

src/Runner/Baseline/Exception/CannotWriteBaselineException.php

@@ -0,0 +1,22 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Runner\Baseline;
+
+use PHPUnit\Runner\Exception;
+use RuntimeException;
+
+/**
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ *
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ */
+final class CannotWriteBaselineException extends RuntimeException implements Exception
+{
+}

src/Runner/Baseline/Writer.php

@@ -12,6 +12,9 @@
 use function assert;
 use function dirname;
 use function file_put_contents;
+use function is_dir;
+use function realpath;
+use function sprintf;
 use XMLWriter;
 
 /**
@@ -23,10 +26,18 @@
 {
     /**
      * @param non-empty-string $baselineFile
+     *
+     * @throws CannotWriteBaselineException
      */
     public function write(string $baselineFile, Baseline $baseline): void
     {
-        $pathCalculator = new RelativePathCalculator(dirname($baselineFile));
+        $normalizedBaselineFile = realpath(dirname($baselineFile));
+
+        if ($normalizedBaselineFile === false || !is_dir($normalizedBaselineFile)) {
+            throw new CannotWriteBaselineException(sprintf('Cannot write baseline to "%s".', $baselineFile));
+        }
+
+        $pathCalculator = new RelativePathCalculator($normalizedBaselineFile);
 
         $writer = new XMLWriter;
 

tests/end-to-end/_files/baseline/generate-baseline-with-relative-directory/.gitignore

@@ -0,0 +1 @@
+baseline.xml

tests/end-to-end/_files/baseline/generate-baseline-with-relative-directory/phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="../../../../../phpunit.xsd"
+         cacheResult="false"
+>
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <source baseline="tests/baseline.xml">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>

tests/end-to-end/_files/baseline/generate-baseline-with-relative-directory/tests/Test.php

@@ -0,0 +1,25 @@
+<?php
+declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\TestFixture\Baseline;
+
+use const E_USER_DEPRECATED;
+use function trigger_error;
+use PHPUnit\Framework\TestCase;
+
+final class Test extends TestCase
+{
+    public function testDeprecation(): void
+    {
+        trigger_error('deprecation', E_USER_DEPRECATED);
+
+        $this->assertTrue(true);
+    }
+}

tests/end-to-end/baseline/generate-baseline-with-relative-directory.phpt

@@ -0,0 +1,43 @@
+--TEST--
+phpunit --configuration ../_files/baseline/generate-baseline-with-relative-directory/phpunit.xml --generate-baseline
+--FILE--
+<?php declare(strict_types=1);
+
+$baselineAbsolutePath = __DIR__ . '/../_files/baseline/generate-baseline-with-relative-directory/baseline.xml';
+$baseline = ltrim(str_replace(getcwd(), '', $baselineAbsolutePath), DIRECTORY_SEPARATOR);
+
+$_SERVER['argv'][] = '--do-not-cache-result';
+$_SERVER['argv'][] = '--generate-baseline';
+$_SERVER['argv'][] = $baseline;
+$_SERVER['argv'][] = '--configuration';
+$_SERVER['argv'][] = __DIR__ . '/../_files/baseline/generate-baseline-with-relative-directory/phpunit.xml';
+
+require_once __DIR__ . '/../../bootstrap.php';
+
+(new PHPUnit\TextUI\Application)->run($_SERVER['argv']);
+
+print file_get_contents($baseline);
+
+@unlink($baselineAbsolutePath);
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+Runtime: %s
+Configuration: %s
+
+D                                                                   1 / 1 (100%)
+
+Time: %s, Memory: %s
+
+OK, but there were issues!
+Tests: 1, Assertions: 1, Deprecations: 1.
+
+Baseline written to %sbaseline.xml.
+<?xml version="1.0"?>
+<files version="1">
+ <file path="tests/Test.php">
+  <line number="21" hash="a1022fb62c4705938dd2c6df5ff35b2621f9e97d">
+   <issue><![CDATA[deprecation]]></issue>
+  </line>
+ </file>
+</files>

tests/unit/Runner/Baseline/WriterTest.php

@@ -10,9 +10,13 @@
 namespace PHPUnit\Runner\Baseline;
 
 use const DIRECTORY_SEPARATOR;
+use function getcwd;
+use function ltrim;
 use function realpath;
+use function str_replace;
 use function unlink;
 use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Small;
 use PHPUnit\Framework\TestCase;
 
@@ -22,6 +26,15 @@ final class WriterTest extends TestCase
 {
     private string $target;
 
+    public static function baselinePathProvider(): iterable
+    {
+        $absoluteBaselinePath = __DIR__ . '/../../../_files/baseline/expected.xml';
+
+        yield [$absoluteBaselinePath];
+
+        yield [ltrim(str_replace(getcwd(), '', $absoluteBaselinePath), DIRECTORY_SEPARATOR)];
+    }
+
     protected function setUp(): void
     {
         $this->target = realpath(__DIR__ . '/../../../_files/baseline') . DIRECTORY_SEPARATOR . 'actual.xml';
@@ -32,11 +45,19 @@ protected function tearDown(): void
         @unlink($this->target);
     }
 
-    public function testWritesBaselineToFileInXmlFormat(): void
+    #[DataProvider('baselinePathProvider')]
+    public function testWritesBaselineToFileInXmlFormat(string $baselinePath): void
     {
         (new Writer)->write($this->target, $this->baseline());
 
-        $this->assertXmlFileEqualsXmlFile(__DIR__ . '/../../../_files/baseline/expected.xml', $this->target);
+        $this->assertXmlFileEqualsXmlFile($baselinePath, $this->target);
+    }
+
+    public function testItThrowsExceptionIfBaseLinePathDoesNotExists(): void
+    {
+        $this->expectException(CannotWriteBaselineException::class);
+
+        (new Writer)->write('/path/to/invalid', $this->baseline());
     }
 
     private function baseline(): Baseline