Bitbucket Cloud PR Decoration - Annotation summary is displaying a URL instead of the user message

[ksl67]

The message displayed in the annotation on the pull request is a URL which points to the issue in SonarQube.

This is because the summary field of the annotation body is serialising link. See screenshot.

public class CloudAnnotation extends CodeInsightsAnnotation {
    @JsonProperty("external_id")
    private final String externalId;
    @JsonProperty("summary")
    private final String link;
    @JsonProperty("annotation_type")
    private final String annotationType;

Is this intentional? Would it not be better to serialise the message instead? Then the analysis message is visible directly in the PR.

Furthermore, I can't see anywhere in the Bitbucket API where message is specified in annotation body.

public class CodeInsightsAnnotation {
    @JsonProperty("line")
    private final int line;
    @JsonProperty("message")
    private final String message;

Software Versions

• SonarQube Version: 8.1
• Plugin Version: [1.4.0]
  

[ksl67]

See issue #233.

[marvin-w]

Looks good for me!

[mc1arke]

Merged. Thanks for the contribution!

[tobilarscheid]

@mc1arke @ksl67 @marvin-w unfortunately since this change PR decoration fails with the following stracktrace for me:

sonarqube    | com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.BitbucketException: The field 'message' is required
sonarqube    | 	at com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.BitbucketServerClient.validate(BitbucketServerClient.java:189)
sonarqube    | 	at com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.client.BitbucketServerClient.uploadAnnotations(BitbucketServerClient.java:114)
sonarqube    | 	at com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.BitbucketPullRequestDecorator.updateAnnotations(BitbucketPullRequestDecorator.java:153)
sonarqube    | 	at com.github.mc1arke.sonarqube.plugin.ce.pullrequest.bitbucket.BitbucketPullRequestDecorator.decorateQualityGateStatus(BitbucketPullRequestDecorator.java:98)
sonarqube    | 	at com.github.mc1arke.sonarqube.plugin.ce.pullrequest.PullRequestPostAnalysisTask.finished(PullRequestPostAnalysisTask.java:160)

The Code Insights API expects the field to be called message: https://docs.atlassian.com/bitbucket-server/rest/7.7.0/bitbucket-code-insights-rest.html#idp12

Maybe an additional field for summary is needed?

[mKeRix]

I think there is a difference between Cloud and Server that went unnoticed in this PR - the Cloud API description lists the summary property, but not message property: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bcommit%7D/reports/%7BreportId%7D/annotations

[mossroy]

Many thanks for this fix.
I see there is a "backport candidate" label on this PR, but it doesn't seem to be backported for now
I think it would deserve to be included in a version 1.3.3, so that it works properly on the latest LTS version of SonarQube (7.9.x)

I have done this backport on branch release/1_3 (see https://github.com/mossroy/sonarqube-community-branch-plugin/tree/release/1_3 ), and tested it on SonarQube 7.9.5 : it works great.
Should I submit another PR for this backport?

[marvin-w]

Yes, please create a PR 👍

[mc1arke]

@mossroy You don't need to raise a pull request - I'll cherry-pick the commits when I come to do a release 😄

[marvin-w]

Well or that :) thanks!

[mossroy]

I've just created PR #277 : feel free to close it if you prefer to cherry-pick. It's indeed the exact same changes, but on branch release/1_3