Take2

resources/schema.json

@@ -96,6 +96,10 @@
                     "type": "boolean",
                     "description": "GitHub Annotations for escaped Mutants in the added/modifies files"
                 },
+                "gitlab": {
+                    "type": "string",
+                    "definition": "GitLab (Code Climate) code quality json file."
+                },
                 "summaryJson": {
                     "type": "string",
                     "definition": "Summary JSON log file, which contains only the statistics from the complete JSON file."

src/Command/RunCommand.php

@@ -125,6 +125,9 @@
     /** @var string */
     private const OPTION_LOGGER_GITHUB = 'logger-github';
 
+    /** @var string */
+    private const OPTION_LOGGER_GITLAB = 'logger-gitlab';
+
     private const OPTION_LOGGER_HTML = 'logger-html';
 
     private const OPTION_USE_NOOP_MUTATORS = 'noop';
@@ -274,6 +277,12 @@
                 'Log escaped Mutants as GitHub Annotations (automatically detected on Github Actions itself, use <comment>true</comment> to force-enable or <comment>false</comment> to force-disable it).',
                 false
             )
+            ->addOption(
+                self::OPTION_LOGGER_GITLAB,
+                null,
+                InputOption::VALUE_OPTIONAL,
+                'Path to log escaped Mutants in the GitLab (Code Climate) JSON format.',
+            )
             ->addOption(
                 self::OPTION_LOGGER_HTML,
                 null,
@@ -404,6 +413,7 @@
         $testFramework = trim((string) $input->getOption(self::OPTION_TEST_FRAMEWORK));
         $testFrameworkExtraOptions = trim((string) $input->getOption(self::OPTION_TEST_FRAMEWORK_OPTIONS));
         $initialTestsPhpOptions = trim((string) $input->getOption(self::OPTION_INITIAL_TESTS_PHP_OPTIONS));
+        $gitlabFileLogPath = trim((string) $input->getOption(self::OPTION_LOGGER_GITLAB));
         $htmlFileLogPath = trim((string) $input->getOption(self::OPTION_LOGGER_HTML));
 
         /** @var string|null $minMsi */
@@ -489,6 +499,7 @@
             $isForGitDiffLines,
             $gitDiffBase,
             $this->getUseGitHubLogger($input),
+            $gitlabFileLogPath === '' ? Container::DEFAULT_GITLAB_LOGGER_PATH : $gitlabFileLogPath,
             $htmlFileLogPath === '' ? Container::DEFAULT_HTML_LOGGER_PATH : $htmlFileLogPath,
             (bool) $input->getOption(self::OPTION_USE_NOOP_MUTATORS),
             (bool) $input->getOption(self::OPTION_EXECUTE_ONLY_COVERING_TEST_CASES)

src/Configuration/ConfigurationFactory.php

@@ -108,6 +108,7 @@ public function create(
         bool $isForGitDiffLines,
         ?string $gitDiffBase,
         ?bool $useGitHubLogger,
+        ?string $gitlabLogFilePath,
         ?string $htmlLogFilePath,
         bool $useNoopMutators,
         bool $executeOnlyCoveringTestCases
@@ -140,7 +141,7 @@ public function create(
             ),
             $this->retrieveFilter($filter, $gitDiffFilter, $isForGitDiffLines, $gitDiffBase, $schema->getSource()->getDirectories()),
             $schema->getSource()->getExcludes(),
-            $this->retrieveLogs($schema->getLogs(), $configDir, $useGitHubLogger, $htmlLogFilePath),
+            $this->retrieveLogs($schema->getLogs(), $configDir, $useGitHubLogger, $gitlabLogFilePath, $htmlLogFilePath),
             $logVerbosity,
             $namespacedTmpDir,
             $this->retrievePhpUnit($schema, $configDir),
@@ -308,7 +309,7 @@ private function retrieveFilter(string $filter, ?string $gitDiffFilter, bool $is
         return $this->gitDiffFileProvider->provide($gitDiffFilter, $baseBranch, $sourceDirectories);
     }
 
-    private function retrieveLogs(Logs $logs, string $configDir, ?bool $useGitHubLogger, ?string $htmlLogFilePath): Logs
+    private function retrieveLogs(Logs $logs, string $configDir, ?bool $useGitHubLogger, ?string $gitlabLogFilePath, ?string $htmlLogFilePath): Logs
     {
         if ($useGitHubLogger === null) {
             $useGitHubLogger = $this->detectCiGithubActions();
@@ -318,6 +319,10 @@ private function retrieveLogs(Logs $logs, string $configDir, ?bool $useGitHubLog
             $logs->setUseGitHubAnnotationsLogger($useGitHubLogger);
         }
 
+        if ($gitlabLogFilePath !== null) {
+            $logs->setGitlabLogFilePath($gitlabLogFilePath);
+        }
+
         if ($htmlLogFilePath !== null) {
             $logs->setHtmlLogFilePath($htmlLogFilePath);
         }
@@ -327,6 +332,7 @@ private function retrieveLogs(Logs $logs, string $configDir, ?bool $useGitHubLog
             self::pathToAbsolute($logs->getHtmlLogFilePath(), $configDir),
             self::pathToAbsolute($logs->getSummaryLogFilePath(), $configDir),
             self::pathToAbsolute($logs->getJsonLogFilePath(), $configDir),
+            self::pathToAbsolute($logs->getGitlabLogFilePath(), $configDir),
             self::pathToAbsolute($logs->getDebugLogFilePath(), $configDir),
             self::pathToAbsolute($logs->getPerMutatorFilePath(), $configDir),
             $logs->getUseGitHubAnnotationsLogger(),

src/Configuration/Entry/Logs.php

@@ -46,6 +46,7 @@ public function __construct(
         private ?string $htmlLogFilePath,
         private readonly ?string $summaryLogFilePath,
         private readonly ?string $jsonLogFilePath,
+        private ?string $gitlabLogFilePath,
         private readonly ?string $debugLogFilePath,
         private readonly ?string $perMutatorFilePath,
         private bool $useGitHubAnnotationsLogger,
@@ -63,6 +64,7 @@ public static function createEmpty(): self
             null,
             null,
             null,
+            null,
             false,
             null,
             null
@@ -79,6 +81,11 @@ public function getHtmlLogFilePath(): ?string
         return $this->htmlLogFilePath;
     }
 
+    public function setGitlabLogFilePath(string $gitlabLogFilePath): void
+    {
+        $this->gitlabLogFilePath = $gitlabLogFilePath;
+    }
+
     public function setHtmlLogFilePath(string $htmlLogFilePath): void
     {
         $this->htmlLogFilePath = $htmlLogFilePath;
@@ -94,6 +101,11 @@ public function getJsonLogFilePath(): ?string
         return $this->jsonLogFilePath;
     }
 
+    public function getGitlabLogFilePath(): ?string
+    {
+        return $this->gitlabLogFilePath;
+    }
+
     public function getDebugLogFilePath(): ?string
     {
         return $this->debugLogFilePath;

src/Configuration/Schema/SchemaConfigurationFactory.php

@@ -85,6 +85,7 @@ private static function createLogs(stdClass $logs): Logs
             self::normalizeString($logs->html ?? null),
             self::normalizeString($logs->summary ?? null),
             self::normalizeString($logs->json ?? null),
+            self::normalizeString($logs->gitlab ?? null),
             self::normalizeString($logs->debug ?? null),
             self::normalizeString($logs->perMutator ?? null),
             $logs->github ?? false,

src/Container.php

@@ -173,6 +173,7 @@ final class Container
     public const DEFAULT_GIT_DIFF_LINES = false;
     public const DEFAULT_GIT_DIFF_BASE = null;
     public const DEFAULT_USE_GITHUB_LOGGER = null;
+    public const DEFAULT_GITLAB_LOGGER_PATH = null;
     public const DEFAULT_HTML_LOGGER_PATH = null;
     public const DEFAULT_USE_NOOP_MUTATORS = false;
     public const DEFAULT_EXECUTE_ONLY_COVERING_TEST_CASES = false;
@@ -588,6 +589,7 @@ public static function create(): self
             self::DEFAULT_GIT_DIFF_LINES,
             self::DEFAULT_GIT_DIFF_BASE,
             self::DEFAULT_USE_GITHUB_LOGGER,
+            self::DEFAULT_GITLAB_LOGGER_PATH,
             self::DEFAULT_HTML_LOGGER_PATH,
             self::DEFAULT_USE_NOOP_MUTATORS,
             self::DEFAULT_EXECUTE_ONLY_COVERING_TEST_CASES
@@ -622,6 +624,7 @@ public function withValues(
         bool $isForGitDiffLines,
         ?string $gitDiffBase,
         ?bool $useGitHubLogger,
+        ?string $gitlabLogFilePath,
         ?string $htmlLogFilePath,
         bool $useNoopMutators,
         bool $executeOnlyCoveringTestCases
@@ -690,6 +693,7 @@ public function withValues(
                 $isForGitDiffLines,
                 $gitDiffBase,
                 $useGitHubLogger,
+                $gitlabLogFilePath,
                 $htmlLogFilePath,
                 $useNoopMutators,
                 $executeOnlyCoveringTestCases

src/Logger/FileLoggerFactory.php

@@ -86,6 +86,8 @@ private function createLineLoggers(Logs $logConfig): iterable
 
         yield $logConfig->getJsonLogFilePath() => $this->createJsonLogger();
 
+        yield $logConfig->getGitlabLogFilePath() => $this->createGitlabLogger();
+
         yield $logConfig->getDebugLogFilePath() => $this->createDebugLogger();
 
         yield $logConfig->getPerMutatorFilePath() => $this->createPerMutatorLogger();
@@ -138,6 +140,11 @@ private function createJsonLogger(): LineMutationTestingResultsLogger
         );
     }
 
+    private function createGitlabLogger(): LineMutationTestingResultsLogger
+    {
+        return new GitLabCodeQualityLogger($this->resultsCollector);
+    }
+
     private function createGitHubAnnotationsLogger(): LineMutationTestingResultsLogger
     {
         return new GitHubAnnotationsLogger($this->resultsCollector);

src/Logger/GitLabCodeQualityLogger.php

@@ -0,0 +1,80 @@
+<?php
+/**
+ * This code is licensed under the BSD 3-Clause License.
+ *
+ * Copyright (c) 2017, Maks Rafalko
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+declare(strict_types=1);
+
+namespace Infection\Logger;
+
+use Infection\Metrics\ResultsCollector;
+use Infection\Str;
+use function json_encode;
+use const JSON_THROW_ON_ERROR;
+use function Safe\shell_exec;
+use Symfony\Component\Filesystem\Path;
+use function trim;
+
+/**
+ * @internal
+ */
+final class GitLabCodeQualityLogger implements LineMutationTestingResultsLogger
+{
+    public function __construct(private readonly ResultsCollector $resultsCollector)
+    {
+    }
+
+    public function getLogLines(): array
+    {
+        $lines = [];
+        $projectRootDirectory = trim(shell_exec('git rev-parse --show-toplevel'));
+
+        foreach ($this->resultsCollector->getEscapedExecutionResults() as $escapedExecutionResult) {
+            $lines[] = [
+                'type' => 'issue',
+                'fingerprint' => $escapedExecutionResult->getMutantHash(),
+                'check_name' => $escapedExecutionResult->getMutatorName(),
+                'description' => 'Escaped Mutant for Mutator ' . $escapedExecutionResult->getMutatorName(),
+                'content' => Str::convertToUtf8(Str::trimLineReturns($escapedExecutionResult->getMutantDiff())),
+                'categories' => ['Escaped Mutant'],
+                'location' => [
+                    'path' => Path::makeRelative($escapedExecutionResult->getOriginalFilePath(), $projectRootDirectory),
+                    'lines' => [
+                      'begin' => $escapedExecutionResult->getOriginalStartingLine(),
+                    ],
+                ],
+                'severity' => 'major',
+            ];
+        }
+
+        return [json_encode($lines, JSON_THROW_ON_ERROR)];
+    }
+}

tests/benchmark/Tracing/provide-traces-closure.php

@@ -71,6 +71,7 @@
     Container::DEFAULT_GIT_DIFF_LINES,
     Container::DEFAULT_GIT_DIFF_BASE,
     Container::DEFAULT_USE_GITHUB_LOGGER,
+    Container::DEFAULT_GITLAB_LOGGER_PATH,
     Container::DEFAULT_HTML_LOGGER_PATH,
     true,
     Container::DEFAULT_EXECUTE_ONLY_COVERING_TEST_CASES

tests/phpunit/Configuration/ConfigurationAssertions.php

@@ -102,6 +102,7 @@ private function assertConfigurationStateIs(
             $expectedLogs->getHtmlLogFilePath(),
             $expectedLogs->getSummaryLogFilePath(),
             $expectedLogs->getJsonLogFilePath(),
+            $expectedLogs->getGitlabLogFilePath(),
             $expectedLogs->getDebugLogFilePath(),
             $expectedLogs->getPerMutatorFilePath(),
             $expectedLogs->getUseGitHubAnnotationsLogger(),