-
-
Notifications
You must be signed in to change notification settings - Fork 534
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for Bitbucket Code Insights
This change will add support for Bitbucket Code Insights in favor of regular comments when available. It will fall back on the comments strategy when the Code Insights is not available (it is supported in version 5.15 and later).
- Loading branch information
Showing
29 changed files
with
953 additions
and
1,186 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
235 changes: 235 additions & 0 deletions
235
...c1arke/sonarqube/plugin/ce/pullrequest/bitbucket/BitbucketServerPullRequestDecorator.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,235 @@ | ||
| /* | ||
| * Copyright (C) 2020 Mathias Åhsberg | ||
| * | ||
| * This program is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU Lesser General Public | ||
| * License as published by the Free Software Foundation; either | ||
| * version 3 of the License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public License | ||
| * along with this program; if not, write to the Free Software Foundation, | ||
| * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||
| * | ||
| */ | ||
| package com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket; | ||
|
|
||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.AnalysisDetails; | ||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.PullRequestBuildStatusDecorator; | ||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.UnifyConfiguration; | ||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.BitbucketClient; | ||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.BitbucketException; | ||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.model.Annotation; | ||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.model.CreateAnnotationsRequest; | ||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.model.CreateReportRequest; | ||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.model.DataValue; | ||
| import com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.model.ReportData; | ||
| import org.sonar.api.ce.posttask.QualityGate; | ||
| import org.sonar.api.issue.Issue; | ||
| import org.sonar.api.measures.CoreMetrics; | ||
| import org.sonar.api.rule.Severity; | ||
| import org.sonar.api.rules.RuleType; | ||
| import org.sonar.api.utils.log.Logger; | ||
| import org.sonar.api.utils.log.Loggers; | ||
| import org.sonar.ce.task.projectanalysis.component.Component; | ||
|
|
||
| import java.io.IOException; | ||
| import java.math.BigDecimal; | ||
| import java.util.ArrayList; | ||
| import java.util.Comparator; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import java.util.Set; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static java.lang.String.format; | ||
| import static java.util.stream.Collectors.toSet; | ||
|
|
||
| public class BitbucketServerPullRequestDecorator implements PullRequestBuildStatusDecorator { | ||
|
|
||
| public static final String PULL_REQUEST_BITBUCKET_URL = "com.github.mc1arke.sonarqube.plugin.branch.pullrequest.bitbucket.url"; | ||
|
|
||
| public static final String PULL_REQUEST_BITBUCKET_TOKEN = "com.github.mc1arke.sonarqube.plugin.branch.pullrequest.bitbucket.token"; | ||
|
|
||
| public static final String PULL_REQUEST_BITBUCKET_PROJECT_KEY = "sonar.pullrequest.bitbucket.projectKey"; | ||
|
|
||
| public static final String PULL_REQUEST_BITBUCKET_REPOSITORY_SLUG = "sonar.pullrequest.bitbucket.repositorySlug"; | ||
|
|
||
| public static final String PULL_REQUEST_BITBUCKET_USER_SLUG = "sonar.pullrequest.bitbucket.userSlug"; | ||
|
|
||
| private static final Logger LOGGER = Loggers.get(BitbucketServerPullRequestDecorator.class); | ||
|
|
||
| private static final int DEFAULT_MAX_ANNOTATIONS = 1000; | ||
|
|
||
| private static final List<String> OPEN_ISSUE_STATUSES = | ||
| Issue.STATUSES.stream().filter(s -> !Issue.STATUS_CLOSED.equals(s) && !Issue.STATUS_RESOLVED.equals(s)) | ||
| .collect(Collectors.toList()); | ||
|
|
||
| private final BitbucketClient client; | ||
|
|
||
| public BitbucketServerPullRequestDecorator(BitbucketClient client) { | ||
| this.client = client; | ||
| } | ||
|
|
||
| @Override | ||
| public String name() { | ||
| return "BitbucketServer"; | ||
| } | ||
|
|
||
| @Override | ||
| public void decorateQualityGateStatus(AnalysisDetails analysisDetails, UnifyConfiguration configuration) { | ||
| try { | ||
| if(!client.supportsCodeInsights()) { | ||
| LOGGER.warn("Your Bitbucket instances does not support the Code Insights API."); | ||
| return; | ||
| } | ||
| String project = configuration.getRequiredProperty(PULL_REQUEST_BITBUCKET_PROJECT_KEY); | ||
|
|
||
| String repo = configuration.getRequiredProperty(PULL_REQUEST_BITBUCKET_REPOSITORY_SLUG); | ||
| client.createReport(project, repo, | ||
| analysisDetails.getCommitSha(), | ||
| toReport(analysisDetails) | ||
| ); | ||
| updateAnnotations(project, repo, analysisDetails); | ||
| } catch (IOException e) { | ||
| LOGGER.error("Could not decorate pull request for project {}", analysisDetails.getAnalysisProjectKey(), e); | ||
| } | ||
| } | ||
|
|
||
| private CreateReportRequest toReport(AnalysisDetails analysisDetails) { | ||
| Map<RuleType, Long> rules = analysisDetails.countRuleByType(); | ||
|
|
||
| List<ReportData> reportData = new ArrayList<>(); | ||
| reportData.add(reliabilityReport(rules.get(RuleType.BUG))); | ||
| reportData.add(new ReportData("Code coverage", new DataValue.Percentage(newCoverage(analysisDetails)))); | ||
| reportData.add(securityReport(rules.get(RuleType.VULNERABILITY), rules.get(RuleType.SECURITY_HOTSPOT))); | ||
| reportData.add(new ReportData("Duplication", new DataValue.Percentage(newDuplication(analysisDetails)))); | ||
| reportData.add(maintainabilityReport(rules.get(RuleType.CODE_SMELL))); | ||
| reportData.add(new ReportData("Analysis details", new DataValue.Link("Go to SonarQube", analysisDetails.getDashboardUrl()))); | ||
|
|
||
| return new CreateReportRequest(reportData, | ||
| reportDescription(analysisDetails), | ||
| "SonarQube", | ||
| "SonarQube", | ||
| analysisDetails.getAnalysisDate().toInstant(), | ||
| analysisDetails.getDashboardUrl(), | ||
| format("%s/common/icon.png", analysisDetails.getBaseImageUrl()), | ||
| asInsightStatus(analysisDetails.getQualityGateStatus())); | ||
| } | ||
|
|
||
| private void updateAnnotations(String project, String repo, AnalysisDetails analysisDetails) throws IOException { | ||
| final AtomicInteger chunkCounter = new AtomicInteger(0); | ||
|
|
||
| client.deleteAnnotations(project, repo, analysisDetails.getCommitSha()); | ||
|
|
||
| Map<Object, Set<Annotation>> annotationChunks = analysisDetails.getPostAnalysisIssueVisitor().getIssues().stream() | ||
| .filter(i -> i.getComponent().getReportAttributes().getScmPath().isPresent()) | ||
| .filter(i -> i.getComponent().getType() == Component.Type.FILE) | ||
| .filter(i -> OPEN_ISSUE_STATUSES.contains(i.getIssue().status())) | ||
| .sorted(Comparator.comparing(a -> Severity.ALL.indexOf(a.getIssue().severity()))) | ||
| .map(componentIssue -> { | ||
| String path = componentIssue.getComponent().getReportAttributes().getScmPath().get(); | ||
| return new Annotation(componentIssue.getIssue().key(), | ||
| Optional.ofNullable(componentIssue.getIssue().getLine()).orElse(0), | ||
| analysisDetails.getIssueUrl(componentIssue.getIssue().key()), | ||
| componentIssue.getIssue().getMessage(), | ||
| path, | ||
| toBitbucketSeverity(componentIssue.getIssue().severity()), | ||
| toBitbucketType(componentIssue.getIssue().type())); | ||
| }).collect(Collectors.groupingBy(s -> chunkCounter.getAndIncrement() / DEFAULT_MAX_ANNOTATIONS, toSet())); | ||
|
|
||
| for (Set<Annotation> annotations : annotationChunks.values()) { | ||
| try { | ||
| client.createAnnotations(project, repo, analysisDetails.getCommitSha(), new CreateAnnotationsRequest(annotations)); | ||
| } catch (BitbucketException e) { | ||
| if (e.isError(BitbucketException.PAYLOAD_TOO_LARGE)) { | ||
| LOGGER.warn("The annotations will be truncated since the maximum number of annotations for this report has been reached."); | ||
| } else { | ||
| throw e; | ||
| } | ||
|
|
||
| } | ||
| } | ||
| } | ||
|
|
||
| private String asInsightStatus(QualityGate.Status status) { | ||
| return QualityGate.Status.ERROR.equals(status) ? "FAIL" : "PASS"; | ||
| } | ||
|
|
||
| private String toBitbucketSeverity(String severity) { | ||
| if (severity == null) { | ||
| return "LOW"; | ||
| } | ||
| switch (severity) { | ||
| case Severity.BLOCKER: | ||
| case Severity.CRITICAL: | ||
| return "HIGH"; | ||
| case Severity.MAJOR: | ||
| return "MEDIUM"; | ||
| default: | ||
| return "LOW"; | ||
| } | ||
| } | ||
|
|
||
| private String toBitbucketType(RuleType sonarqubeType) { | ||
| switch (sonarqubeType) { | ||
| case SECURITY_HOTSPOT: | ||
| case VULNERABILITY: | ||
| return "VULNERABILITY"; | ||
| case CODE_SMELL: | ||
| return "CODE_SMELL"; | ||
| case BUG: | ||
| return "BUG"; | ||
| default: | ||
| throw new IllegalStateException(format("%s is not a valid ruleType.", sonarqubeType)); | ||
| } | ||
| } | ||
|
|
||
| private ReportData securityReport(Long vulnerabilities, Long hotspots) { | ||
| String vulnerabilityDescription = vulnerabilities == 1 ? "Vulnerability" : "Vulnerabilities"; | ||
| String hotspotDescription = hotspots == 1 ? "Hotspot" : "Hotspots"; | ||
| String security = format("%d %s (and %d %s)", vulnerabilities, vulnerabilityDescription, hotspots, hotspotDescription); | ||
| return new ReportData("Security", new DataValue.Text(security)); | ||
| } | ||
|
|
||
| private ReportData reliabilityReport(Long bugs) { | ||
| String description = bugs == 1 ? "Bug" : "Bugs"; | ||
| return new ReportData("Reliability", new DataValue.Text(format("%d %s", bugs, description))); | ||
| } | ||
|
|
||
| private ReportData maintainabilityReport(Long codeSmells) { | ||
| String description = codeSmells == 1 ? "Code Smell" : "Code Smells"; | ||
| return new ReportData("Maintainability", new DataValue.Text(format("%d %s", codeSmells, description))); | ||
| } | ||
|
|
||
| private String reportDescription(AnalysisDetails details) { | ||
| String header = details.getQualityGateStatus() == QualityGate.Status.OK ? "Quality Gate passed" : "Quality Gate failed"; | ||
| String body = details.findFailedConditions().stream() | ||
| .map(AnalysisDetails::format) | ||
| .map(s -> format("- %s", s)) | ||
| .collect(Collectors.joining(System.lineSeparator())); | ||
| return format("%s%n%s", header, body); | ||
| } | ||
|
|
||
| private BigDecimal newCoverage(AnalysisDetails details) { | ||
| return details.findQualityGateCondition(CoreMetrics.NEW_COVERAGE_KEY) | ||
| .filter(condition -> condition.getStatus() != QualityGate.EvaluationStatus.NO_VALUE) | ||
| .map(QualityGate.Condition::getValue) | ||
| .map(BigDecimal::new) | ||
| .orElse(BigDecimal.ZERO); | ||
| } | ||
|
|
||
| private BigDecimal newDuplication(AnalysisDetails details) { | ||
| return details.findQualityGateCondition(CoreMetrics.NEW_DUPLICATED_LINES_DENSITY_KEY) | ||
| .filter(condition -> condition.getStatus() != QualityGate.EvaluationStatus.NO_VALUE) | ||
| .map(QualityGate.Condition::getValue) | ||
| .map(BigDecimal::new) | ||
| .orElse(BigDecimal.ZERO); | ||
| } | ||
| } |
Oops, something went wrong.