Closes #6588

Author: sebastianbergmann

ChangeLog-13.2.md

@@ -25,6 +25,7 @@ All notable changes of the PHPUnit 13.2 release series are documented in this fi
 * [#6575](https://github.com/sebastianbergmann/phpunit/issues/6575): `--list-test-ids` CLI option and enhance `--filter` CLI option to support test ID syntax
 * [#6577](https://github.com/sebastianbergmann/phpunit/issues/6577): `--run-test-id <test-id>` CLI option that accepts a single test ID for exact matching
 * [#6579](https://github.com/sebastianbergmann/phpunit/pull/6579): Properly handle issues triggered outside of tests
+* [#6588](https://github.com/sebastianbergmann/phpunit/issues/6588): Canonicalize baseline
 * The `executionOrder` attribute in the XML configuration file now accepts `defects` combined with any main order, as well as three-way combinations of `depends`/`no-depends`, `defects`, and a main order (for example, `depends,defects,duration-ascending`)
 
 ### Changed

src/Runner/Baseline/Baseline.php

@@ -9,6 +9,10 @@
  */
 namespace PHPUnit\Runner\Baseline;
 
+use function ksort;
+use function strcmp;
+use function usort;
+
 /**
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
  *
@@ -56,6 +60,21 @@ public function has(Issue $issue): bool
      */
     public function groupedByFileAndLine(): array
     {
-        return $this->issues;
+        $issues = $this->issues;
+
+        ksort($issues);
+
+        foreach ($issues as &$lines) {
+            ksort($lines);
+
+            foreach ($lines as &$issuesOnLine) {
+                usort(
+                    $issuesOnLine,
+                    static fn (Issue $a, Issue $b): int => strcmp($a->description(), $b->description()),
+                );
+            }
+        }
+
+        return $issues;
     }
 }

tests/_files/baseline/AnotherFileWithIssues.php

@@ -0,0 +1,11 @@
+<?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.
+ */
+$x = $y;
+$y = $z;

tests/unit/Runner/Baseline/BaselineTest.php

@@ -9,6 +9,7 @@
  */
 namespace PHPUnit\Runner\Baseline;
 
+use function array_keys;
 use function realpath;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Group;
@@ -45,6 +46,27 @@ public function testGroupsIssuesByFileAndLine(): void
         $this->assertTrue($this->issue()->equals($line[0]));
     }
 
+    public function testCanonicalizesIssuesByFileLineAndDescription(): void
+    {
+        $fileA = realpath(__DIR__ . '/../../../_files/baseline/AnotherFileWithIssues.php');
+        $fileB = realpath(__DIR__ . '/../../../_files/baseline/FileWithIssues.php');
+
+        $baseline = new Baseline;
+
+        $baseline->add(Issue::from($fileB, 11, null, 'Undefined variable $c'));
+        $baseline->add(Issue::from($fileB, 10, null, 'b: Undefined variable $b'));
+        $baseline->add(Issue::from($fileB, 10, null, 'a: Undefined variable $b'));
+        $baseline->add(Issue::from($fileA, 10, null, 'Undefined variable $y'));
+
+        $issues = $baseline->groupedByFileAndLine();
+
+        $this->assertSame([$fileA, $fileB], array_keys($issues));
+        $this->assertSame([10, 11], array_keys($issues[$fileB]));
+
+        $this->assertSame('a: Undefined variable $b', $issues[$fileB][10][0]->description());
+        $this->assertSame('b: Undefined variable $b', $issues[$fileB][10][1]->description());
+    }
+
     public function testCanBeQueried(): void
     {
         $baseline = new Baseline;