Add GitLab Code Quality check reports

Author: fabpot

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Add GitLab Code Quality reports to the diagnostics checker
 - Suppress code-qualified diagnostics with source comments
 - Honor router request context parameters in route diagnostics
 - Report Symfony branches outside the live supported range

README.md

@@ -91,9 +91,9 @@ symfony lsp:check
 
 You can also invoke a standalone installation directly with
 `symfony-lsp check`. The checker supports deterministic human, JSON, GitHub
-Actions and SARIF output, code-based failure policies, source-only analysis and
-occurrence-specific baselines. Running it with runtime indexing enabled executes
-application code.
+Actions, GitLab Code Quality and SARIF output, code-based failure policies,
+source-only analysis and occurrence-specific baselines. Running it with runtime
+indexing enabled executes application code.
 See the [headless diagnostics guide](docs/features/headless-diagnostics.rst) for
 configuration, CI examples and stable exit statuses.
 

docs/features/headless-diagnostics.rst

@@ -135,6 +135,25 @@ Use GitHub Actions annotations for pull request feedback:
 
     $ symfony-lsp check --format=github
 
+Publish diagnostics as a GitLab Code Quality report:
+
+.. code-block:: yaml
+
+    symfony-lsp:
+      stage: test
+      script:
+        - symfony lsp:check --format=gitlab > gl-code-quality-report.json
+      artifacts:
+        when: always
+        reports:
+          codequality: gl-code-quality-report.json
+
+GitLab reports map errors to ``major``, warnings to ``minor`` and information
+and hints to ``info``. They use repository-relative paths, one-based lines and
+occurrence-specific fingerprints. Invocation and operational failures still
+produce a valid JSON array, while the nonzero exit status and standard error
+identify the failed check.
+
 Generate a SARIF 2.1.0 report for code-scanning systems:
 
 .. code-block:: terminal
@@ -149,12 +168,13 @@ because their result set may be incomplete.
 
 Standard output contains only the selected report format. Operational details
 go to standard error. The Symfony CLI wrapper also keeps release-management
-and cache messages on standard error, so JSON, GitHub Actions and SARIF output
-remain safe to pipe from standard output. Add ``--verbose`` to human output to
-show sanitized exception classes and messages. GitHub annotations remain
-generic.
-Once JSON or SARIF is selected successfully, later invocation, configuration,
-indexing and internal failures still produce a valid structured report.
+and cache messages on standard error, so JSON, GitHub Actions, GitLab and SARIF
+output remain safe to pipe from standard output. Add ``--verbose`` to human
+output to show sanitized exception classes and messages. GitHub annotations
+remain generic.
+Once JSON, GitLab or SARIF is selected successfully, later invocation,
+configuration, indexing and internal failures still produce a valid structured
+report.
 
 Selecting Blocking Diagnostics
 ------------------------------

docs/index.rst

@@ -122,10 +122,10 @@ or CI:
 
     $ ./symfony-lsp check
 
-The command can produce human, JSON, GitHub Actions and SARIF reports, select
-blocking diagnostic codes and maintain an occurrence-specific baseline. Runtime
-analysis executes application code; pass ``--source-only`` when it must remain
-disabled.
+The command can produce human, JSON, GitHub Actions, GitLab Code Quality and
+SARIF reports, select blocking diagnostic codes and maintain an
+occurrence-specific baseline. Runtime analysis executes application code; pass
+``--source-only`` when it must remain disabled.
 See `Running Diagnostics Without an Editor`_ for configuration, output,
 baseline and exit-status details.
 

src/Check/CheckOptionsParser.php

@@ -8,7 +8,7 @@
 
 final class CheckOptionsParser
 {
-    private const FORMATS = ['human', 'json', 'github', 'sarif'];
+    private const FORMATS = ['human', 'json', 'github', 'gitlab', 'sarif'];
 
     private const FLAG_OPTIONS = [
         '--help' => ['help', true],
@@ -236,7 +236,7 @@ private function positiveNumber(string $name, string $value): float
     private function format(?string $current, string $requested): string
     {
         if (!\in_array($requested, self::FORMATS, true)) {
-            throw new InvalidConfigurationException('The --format option must be human, json, github or sarif.');
+            throw new InvalidConfigurationException('The --format option must be human, json, github, gitlab or sarif.');
         }
         if (null !== $current && $current !== $requested) {
             throw new InvalidConfigurationException('The --format option cannot select more than one format.');

src/Check/CheckReportDiagnosticView.php

@@ -7,6 +7,7 @@ final class CheckReportDiagnosticView
     public function __construct(
         public readonly CheckDiagnostic $diagnostic,
         public readonly int $occurrence,
+        public readonly string $occurrenceFingerprint,
         public readonly string $feature,
         public readonly ?string $environment,
         public readonly ?string $analysisMode,

src/Check/CheckReportViewBuilder.php

@@ -23,6 +23,7 @@ public function build(CheckResult $result, int $exitCode): CheckReportView
             $diagnostics[] = new CheckReportDiagnosticView(
                 $diagnostic,
                 $occurrence->number,
+                hash('sha256', $diagnostic->fingerprint."\0".$occurrence->number),
                 strstr($diagnostic->code, '.', true) ?: $diagnostic->code,
                 $project?->environment,
                 $project?->mode,

src/Check/CheckReporter.php

@@ -5,6 +5,7 @@
 final class CheckReporter
 {
     public function __construct(
+        private readonly GitLabCheckReporter $gitLab,
         private readonly SarifCheckReporter $sarif,
         private readonly CheckReportViewBuilder $viewBuilder,
     ) {
@@ -17,6 +18,7 @@ public function render(CheckResult $result, string $format, bool $verbose, int $
         return match ($format) {
             'json' => $this->json($view),
             'github' => $this->github($view),
+            'gitlab' => $this->gitLab->render($view),
             'sarif' => $this->sarif->render($view),
             default => $this->human($view, $verbose),
         };
@@ -31,6 +33,7 @@ public function codes(array $codes, string $format): string
                 'diagnosticCodes' => $codes,
             ], \JSON_THROW_ON_ERROR | \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES)."\n",
             'sarif' => $this->sarif->codes($codes),
+            'gitlab' => $this->gitLab->codes(),
             'github' => implode('', array_map(
                 fn (string $code): string => \sprintf('::notice title=Symfony diagnostic code::%s%s', $this->escapeData($code), \PHP_EOL),
                 $codes,
@@ -45,7 +48,7 @@ public function help(): string
 Usage: symfony-lsp check [options] [files, directories or patterns]
 
 Options:
-  --format=human|json|github|sarif Select the report format
+  --format=human|json|github|gitlab|sarif Select the report format
   --workspace=PATH                 Set the workspace root
   --config=PATH                    Load a configuration file instead of .symfony-lsp.json
   --project-root=PATH              Select an explicit Symfony project root; repeatable

src/Check/GitLabCheckReporter.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Symfony\Lsp\Check;
+
+final class GitLabCheckReporter
+{
+    public function render(CheckReportView $view): string
+    {
+        return json_encode(array_map(static function (CheckReportDiagnosticView $diagnosticView): array {
+            $diagnostic = $diagnosticView->diagnostic;
+
+            return [
+                'description' => $diagnostic->message,
+                'check_name' => $diagnostic->code,
+                'fingerprint' => $diagnosticView->occurrenceFingerprint,
+                'severity' => match ($diagnostic->severity) {
+                    1 => 'major',
+                    2 => 'minor',
+                    default => 'info',
+                },
+                'location' => [
+                    'path' => $diagnostic->workspacePath,
+                    'lines' => ['begin' => $diagnostic->startLine + 1],
+                ],
+            ];
+        }, $view->diagnostics), \JSON_THROW_ON_ERROR | \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE | \JSON_INVALID_UTF8_SUBSTITUTE)."\n";
+    }
+
+    public function codes(): string
+    {
+        return "[]\n";
+    }
+}

src/Check/SarifCheckReporter.php

@@ -112,7 +112,7 @@ private function results(array $diagnostics): array
                     ],
                 ]],
                 'partialFingerprints' => [
-                    'symfonyLsp/v1' => hash('sha256', $diagnostic->fingerprint."\0".$diagnosticView->occurrence),
+                    'symfonyLsp/v1' => $diagnosticView->occurrenceFingerprint,
                 ],
                 'properties' => $properties,
             ];