Skip to content

Include identifier in gitlab error format #4421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 3, 2025
+47 −3
Merged

Include identifier in gitlab error format #4421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/Command/ErrorFormatter/GitlabErrorFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
use function implode;

/**
* @see https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html#implementing-a-custom-tool
* @see https://docs.gitlab.com/ci/testing/code_quality#code-quality-report-format
*/
#[AutowiredService(name: 'errorFormatter.gitlab')]
final class GitlabErrorFormatter implements ErrorFormatter
Expand All @@ -32,6 +32,12 @@ public function formatErrors(AnalysisResult $analysisResult, Output $output): in
foreach ($analysisResult->getFileSpecificErrors() as $fileSpecificError) {
$error = [
'description' => $fileSpecificError->getMessage(),
// This field is intended to be shown in the GitLab code quality scan widget and mentioned in the GitLab docs.
// However, due to a regression in GitLab, it is currently not shown - see https://gitlab.com/gitlab-org/gitlab/-/issues/578172.
// There is no harm in having it here, and it allows users to work around the GitLab bug by post-processing the JSON file.
// For example, they might prepend `check_name` to `description`, causing GitLab to show the error identifier as part of the message.
// TODO: remove this comment once the GitLab bug is fixed
'check_name' => $fileSpecificError->getIdentifier(),
'fingerprint' => hash(
'sha256',
implode(
Expand Down
42 changes: 40 additions & 2 deletions ...nd/ErrorFormatter/GitlabFormatterTest.php → ...rorFormatter/GitlabErrorFormatterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
use PHPUnit\Framework\Attributes\DataProvider;
use function sprintf;

class GitlabFormatterTest extends ErrorFormatterTestCase
class GitlabErrorFormatterTest extends ErrorFormatterTestCase
{

public static function dataFormatterOutputProvider(): iterable
Expand All @@ -28,6 +28,7 @@ public static function dataFormatterOutputProvider(): iterable
'[
{
"description": "Foo",
"check_name": null,
"fingerprint": "e82b7e1f1d4255352b19ecefa9116a12f129c7edb4351cf2319285eccdb1565e",
"severity": "major",
"location": {
Expand Down Expand Up @@ -68,6 +69,7 @@ public static function dataFormatterOutputProvider(): iterable
'[
{
"description": "Bar\nBar2",
"check_name": null,
"fingerprint": "034b4afbfb347494c14e396ed8327692f58be4cd27e8aff5f19f4194934db7c9",
"severity": "major",
"location": {
Expand All @@ -79,6 +81,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Foo",
"check_name": null,
"fingerprint": "e82b7e1f1d4255352b19ecefa9116a12f129c7edb4351cf2319285eccdb1565e",
"severity": "major",
"location": {
Expand All @@ -90,6 +93,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Foo<Bar>",
"check_name": null,
"fingerprint": "d7002959fc192c81d51fc41b0a3f240617a1aa35361867b5e924ae8d7fec39cb",
"severity": "major",
"location": {
Expand All @@ -101,6 +105,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Bar\nBar2",
"check_name": null,
"fingerprint": "829f6c782152fdac840b39208c5b519d18e51bff2c601b6197812fffb8bcd9ed",
"severity": "major",
"location": {
Expand All @@ -121,6 +126,7 @@ public static function dataFormatterOutputProvider(): iterable
'[
{
"description": "Bar\nBar2",
"check_name": null,
"fingerprint": "034b4afbfb347494c14e396ed8327692f58be4cd27e8aff5f19f4194934db7c9",
"severity": "major",
"location": {
Expand All @@ -132,6 +138,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Foo",
"check_name": null,
"fingerprint": "e82b7e1f1d4255352b19ecefa9116a12f129c7edb4351cf2319285eccdb1565e",
"severity": "major",
"location": {
Expand All @@ -143,6 +150,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Bar\nBar2",
"check_name": null,
"fingerprint": "52d22d9e64bd6c6257b7a0d170ed8c99482043aeedd68c52bac081a80da9800a",
"severity": "major",
"location": {
Expand All @@ -154,6 +162,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Foo<Bar>",
"check_name": null,
"fingerprint": "d7002959fc192c81d51fc41b0a3f240617a1aa35361867b5e924ae8d7fec39cb",
"severity": "major",
"location": {
Expand All @@ -165,6 +174,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Bar\nBar2",
"check_name": null,
"fingerprint": "829f6c782152fdac840b39208c5b519d18e51bff2c601b6197812fffb8bcd9ed",
"severity": "major",
"location": {
Expand Down Expand Up @@ -216,6 +226,7 @@ public static function dataFormatterOutputProvider(): iterable
'[
{
"description": "Bar\nBar2",
"check_name": null,
"fingerprint": "034b4afbfb347494c14e396ed8327692f58be4cd27e8aff5f19f4194934db7c9",
"severity": "major",
"location": {
Expand All @@ -227,6 +238,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Foo",
"check_name": null,
"fingerprint": "e82b7e1f1d4255352b19ecefa9116a12f129c7edb4351cf2319285eccdb1565e",
"severity": "major",
"location": {
Expand All @@ -238,6 +250,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Foo<Bar>",
"check_name": null,
"fingerprint": "d7002959fc192c81d51fc41b0a3f240617a1aa35361867b5e924ae8d7fec39cb",
"severity": "major",
"location": {
Expand All @@ -249,6 +262,7 @@ public static function dataFormatterOutputProvider(): iterable
},
{
"description": "Bar\nBar2",
"check_name": null,
"fingerprint": "829f6c782152fdac840b39208c5b519d18e51bff2c601b6197812fffb8bcd9ed",
"severity": "major",
"location": {
Expand Down Expand Up @@ -280,15 +294,39 @@ public static function dataFormatterOutputProvider(): iterable
}
}
}
]',
];

yield [
'File error with identifier',
1,
[5, 1],
0,
'[
{
"description": "Foobar\\\\Buz",
"check_name": "foobar.buz",
"fingerprint": "5543f2fd4c455f26c1500342ec5045b08c99b7827ab35595151dd6e7715c079c",
"severity": "major",
"location": {
"path": "with space/and unicode \ud83d\ude03/project/foo.php",
"lines": {
"begin": 5
}
}
}
]',
];
}

/**
* @param array{int, int}|int $numFileErrors
*/
#[DataProvider('dataFormatterOutputProvider')]
public function testFormatErrors(
string $message,
int $exitCode,
int $numFileErrors,
array|int $numFileErrors,
int $numGenericErrors,
string $expected,
): void
Expand Down
Loading