feat: Add GitLab output format support to CLI. #474
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
raffaelecarelle
changed the title
micheleorselli
requested changes
Apr 1, 2025
raffaelecarelle
force-pushed
the
gitlab-output-format
branch
from
c3dcefb to
cefdf9a
Compare
|
@raffaelecarelle Apart from backward compatibility, do we have a good reason to maintain both a JSON format and a GitLab format? Does the current JSON format offer any advantages? |
|
Well, the GitLab format is specific to GitLab (initially I was the one who confused things, I apologize). Meanwhile, the JSON format can be used either by GitLab for other types of reports or also by other platforms like GitHub or SonarQube. I would keep both for greater flexibility, and to cover more use cases, but if it's more difficult then we can remove one of the two. |
This was referenced Apr 1, 2025
Introduced the "gitlab" format for CLI output, alongside existing "text" and "json" formats. This includes a new `GitlabPrinter` implementation, updates to the `PrinterFactory` and output option handling, as well as corresponding unit and E2E tests. The change enhances integration options, particularly for GitLab CI.
Introduced support for the GitLab-specific output format in the Check command and its end-to-end test suite. Modified the condition in the Check command to handle the GitLab format and added a corresponding test case to verify functionality for outputs with no errors.
Unified violation instantiation and assertion logic in tests, replacing mock-based violations with direct object creation. Simplified JSON output comparisons using `assertSame` with string literals. Updated `GitlabPrinter` to use relative paths for better clarity in output.
raffaelecarelle
force-pushed
the
gitlab-output-format
branch
from
cefdf9a to
c5b291e
Compare
Replaced the use of `Path::makeRelative` and `getPathFromFqcn` with the `getFilePath` method in the `Violation` class for path resolution. Removed unused `getPathFromFqcn` method and Symfony `Path` dependency. Updated test cases accordingly to reflect the changes.
micheleorselli
requested changes
Apr 6, 2025
Simplified the GitLabPrinter logic by removing unnecessary nesting and improving error handling structure. Updated related tests to match the refactored implementation, including hardcoding FQCN strings for mock violations. Cleaned up outdated test dependencies and adjusted JSON output formatting for consistency.
micheleorselli
approved these changes
Apr 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduced the "gitlab" format for CLI output, alongside existing "text" and "json" formats. This includes a new
GitlabPrinterimplementation, updates to thePrinterFactoryand output option handling, as well as corresponding unit and E2E tests. The change enhances integration options, particularly for GitLab CI.gitlab code quality format must have particular json format
see gitlab docs: https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format
this PR depends on #475