Skip to content
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.

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

feat(sonarqube): jq filter for import to SonarQube #2044

Merged
merged 3 commits into from
Aug 23, 2022
Merged

feat(sonarqube): jq filter for import to SonarQube #2044

merged 3 commits into from
Aug 23, 2022

Conversation

apgrucza
Copy link
Contributor

I was unsure of where best in this repository to put this jq filter, so feel free to change to a different location.

For context, see stryker-mutator/stryker-js#3663


After `mutation-sonar.json` is generated, you can import it into SonarQube using the analysis parameter `sonar.externalIssuesReportPaths`. See [Generic Issue Import Format](https://docs.sonarqube.org/latest/analysis/generic-issue/) for more details.

Please note that:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should also add a note with:

"
There are a couple of limitations with importing external issues:

you can't manage them within SonarQube; for instance, there is no ability to mark them False Positive.
you can't manage the activation of the rules that raise these issues within SonarQube. External rules aren't visible on the Rules page or reflected in Quality Profiles.
External issues and the rules that raise them must be managed in the configuration of your linter.
"
See: https://docs.sonarqube.org/latest/analysis/generic-issue/

@@ -0,0 +1,17 @@
# SonarQube integration
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be placed in the docs/ folder, that way, it will also show up on the website :)

Copy link
Contributor Author

@apgrucza apgrucza Aug 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs/ folder is specific to Stryker, and I was trying to keep this jq filter independent of Stryker as it can be used with reports from any mutation testing framework that uses the schema in this repository. But I've now moved it into the docs/ folder anyway, as having this on the Stryker website would make it much more discoverable which is probably more important. Are any other changes required to get this published to the website?

@apgrucza apgrucza requested review from rouke-broersma and hugo-vrijswijk and removed request for rouke-broersma and hugo-vrijswijk August 21, 2022 12:08
Copy link
Member

@hugo-vrijswijk hugo-vrijswijk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! @rouke-broersma if you have no other comments we can merge this :)

@rouke-broersma rouke-broersma merged commit 36337c0 into stryker-mutator:master Aug 23, 2022
@hugo-vrijswijk
Copy link
Member

Now also live on the website :) https://stryker-mutator.io/docs/mutation-testing-elements/sonarqube-integration/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants