Add Mutator information to GitHub annotation logger

* It will give more information about what Mutator is used and will be in line with other loggers * It will make it clear to understand why the diff can be empty, like in #1524 Fixes #1524
infection · Jul 21, 2021 · 896ca5a · 896ca5a
1 parent 8c97e07
commit 896ca5a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/src/Logger/GitHubAnnotationsLogger.php b/src/Logger/GitHubAnnotationsLogger.php
@@ -63,7 +63,7 @@ public function getLogLines(): array
             $error = [
                 'line' => $escapedExecutionResult->getOriginalStartingLine(),
                 'message' => <<<"TEXT"
-Escaped Mutant:
+Escaped Mutant for Mutator "{$escapedExecutionResult->getMutatorName()}":
 
 {$escapedExecutionResult->getMutantDiff()}
 TEXT

diff --git a/tests/phpunit/Logger/GitHubAnnotationsLoggerTest.php b/tests/phpunit/Logger/GitHubAnnotationsLoggerTest.php
@@ -68,8 +68,8 @@ public function metricsProvider(): iterable
         yield 'all mutations' => [
             $this->createCompleteResultsCollector(),
             [
-                "::warning file=foo/bar,line=9::Escaped Mutant:%0A%0A--- Original%0A+++ New%0A@@ @@%0A%0A- echo 'original';%0A+ echo 'escaped#1';%0A\n",
-                "::warning file=foo/bar,line=10::Escaped Mutant:%0A%0A--- Original%0A+++ New%0A@@ @@%0A%0A- echo 'original';%0A+ echo 'escaped#0';%0A\n",
+                "::warning file=foo/bar,line=9::Escaped Mutant for Mutator \"PregQuote\":%0A%0A--- Original%0A+++ New%0A@@ @@%0A%0A- echo 'original';%0A+ echo 'escaped#1';%0A\n",
+                "::warning file=foo/bar,line=10::Escaped Mutant for Mutator \"For_\":%0A%0A--- Original%0A+++ New%0A@@ @@%0A%0A- echo 'original';%0A+ echo 'escaped#0';%0A\n",
             ],
         ];
     }