Add cli --logger-gitlab options.

cmlara · Sep 28, 2023 · 2fc798d · 2fc798d
1 parent 4e9ea31
commit 2fc798d
Show file tree

Hide file tree

Showing 8 changed files with 191 additions and 4 deletions.
diff --git a/resources/schema.json b/resources/schema.json
@@ -98,7 +98,7 @@
                 },
                 "gitlab": {
                     "type": "string",
-                    "definition": "GitLab(Code Climate) code quality json file."
+                    "definition": "GitLab (Code Climate) code quality json file."
                 },
                 "summaryJson": {
                     "type": "string",

diff --git a/src/Command/RunCommand.php b/src/Command/RunCommand.php
@@ -125,6 +125,9 @@ final class RunCommand extends BaseCommand
     /** @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 @@ protected function configure(): void
                 '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 @@ private function createContainer(IO $io, LoggerInterface $logger): Container
         $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 @@ private function createContainer(IO $io, LoggerInterface $logger): Container
             $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)

diff --git a/src/Configuration/ConfigurationFactory.php b/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);
         }

diff --git a/src/Configuration/Entry/Logs.php b/src/Configuration/Entry/Logs.php
@@ -46,7 +46,7 @@ public function __construct(
         private ?string $htmlLogFilePath,
         private readonly ?string $summaryLogFilePath,
         private readonly ?string $jsonLogFilePath,
-        private readonly ?string $gitlabLogFilePath,
+        private ?string $gitlabLogFilePath,
         private readonly ?string $debugLogFilePath,
         private readonly ?string $perMutatorFilePath,
         private bool $useGitHubAnnotationsLogger,
@@ -81,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;

diff --git a/src/Container.php b/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

diff --git a/tests/benchmark/Tracing/provide-traces-closure.php b/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