[bitbucket-code-report] Integration with Bitbucket Code Insights #769

taraspos · 2020-10-02T14:13:21Z

Updated Unreleased section in CHANGELOG or it's not notable changes.

This fixes #113 via integration with Bitbucket Code Insights and Bitbucket Pipelines.

See example project trane9991/reviewdog-example.

With the example PR trane9991/reviewdog-example PR#1.

Example report:

Example annotated diff in PR:

taraspos · 2020-10-02T14:15:31Z

I would keep it as a Draft for now and test it on my project to make sure no issue arises but would happy if this can be reviewed in meantime. 🐶

taraspos · 2020-10-02T14:21:38Z

Current implementation generates one report for all the runners in one project.
It might be a good idea to generate a report per runner to make it more similar to github integration.

taraspos · 2020-10-02T19:36:04Z

Did a change to create report per runner

cmd/reviewdog/main.go

service/bitbucket/annotator.go

Co-authored-by: haya14busa <hayabusa1419@gmail.com>

…master

create "pending" reports on tool start

taraspos · 2020-10-23T21:23:52Z

Hey, @haya14busa, all done! Please check if all looks good to you.

The last thing to decide, if we will keep the openapi package as part of reviewdog/reviewdog repo or let's create some separate one - reviewdog/bitbucket.

haya14busa · 2020-10-24T08:49:37Z

cmd/reviewdog/main.go

+		// filtering of annotations dividing them in two groups:
+		// - This pull request (10)
+		// - All (50)
+		log.Printf("reviewdog: [bitbucket-code-report] supports only with filter.ModeNoFilter for now\n")


Log this only if the filter mode is not default nor no-filter mode.

haya14busa · 2020-10-24T08:50:59Z

cmd/reviewdog/main.go

+	}
+
+	// if this is simple run, get the single tool name
+	if name := toolName(opt); len(name) > 0 {


[nit] name != ""

haya14busa · 2020-10-24T08:52:15Z

cmd/reviewdog/main.go

@@ -689,3 +750,26 @@ func buildRunnersMap(runners string) map[string]bool {
 	}
 	return m
 }
+
+func getRunnersList(opt *option, conf *project.Config) []string {
+	if len(opt.runners) > 0 { // if runners explicitly defined, use them


[optional] It's better to check the specified runner name is actually in the project config.

haya14busa · 2020-10-24T08:57:36Z

service/bitbucket/annotator.go

+	// hash the output of linter and use it as external id
+	a.SetExternalId(externalIDFromDiagnostic(c.Result.Diagnostic))
+	a.SetSummary(c.Result.Diagnostic.GetMessage())
+	a.SetDetails(fmt.Sprintf(`[%s] %s`, c.ToolName, c.Result.Diagnostic.GetMessage()))


[optinal] Does bitbucket support markdown? Then we may want to re-use this util func.

reviewdog/service/commentutil/commentutil.go

Lines 58 to 59 in 2b11a08

// MarkdownComment creates comment body markdown.

func MarkdownComment(c *reviewdog.Comment) string {

No, markdown isn't supported in the Code Reports, I tried :(

haya14busa · 2020-10-24T09:04:07Z

service/bitbucket/annotator_test.go

+
+			// create client
+			client := NewAPIClientWithConfigurations(&http.Client{Timeout: 1 * time.Second}, openapi.ServerConfiguration{URL: ts.URL})
+			bb := NewReportAnnotator(client, username, repo, commit, test.runnersList)


Can you fix this warning?

Using the variable on range scope `test` in function literal (scopelint)

haya14busa · 2020-10-24T09:04:39Z

service/bitbucket/annotator_test.go

+			ctx := context.Background()
+
+			for _, c := range test.comments {
+				// post comments


[super nit] I think this comment is redundant.

haya14busa · 2020-10-24T09:04:50Z

service/bitbucket/annotator_test.go

+					t.Error(err)
+				}
+			}
+			// flush comments


[super nit] I think this comment is redundant.

review-dog · 2020-10-24T09:20:52Z

Hi, @trane9991! We merged your PR to reviewdog! 🐶
Thank you for your contribution! ✨

We just invited you to join the @reviewdog organization on GitHub.
Accept the invite by visiting https://github.com/orgs/reviewdog/invitation.
By joining the team, you'll be a part of reviewdog community and can help the maintainance of reviewdog.

Thanks again!

haya14busa · 2020-10-24T09:21:31Z

The comments were mostly nitpicks, so I just fixed them and merged! Thank you for your contribution!

haya14busa · 2020-10-24T09:22:20Z

The last thing to decide, if we will keep the openapi package as part of reviewdog/reviewdog repo or let's create some separate one - reviewdog/bitbucket.

As the above ^^ comment, we invited you to the reviewdog org.
Can you create a repo for the bitbucket and create a pr to use it separately? Thanks!

taraspos · 2020-10-24T09:26:05Z

Thanks, amazing!

Can you create a repo for the bitbucket and create a pr to use it separately?

Will do so. Could we release v0.11.0 once it is done? :)

haya14busa · 2020-10-24T09:30:35Z

I have a plan to release a new version this weekend (hopefully).
It's mostly blocked by documentation for suggestion feature / rdformat, so I'd say creating a bitbucket is not release-blocking.

taraspos · 2020-10-24T09:32:03Z

Cool, anyway, I should be able to move the bitbucket to the separate repository right now.

taraspos · 2020-10-24T11:53:09Z

@haya14busa , I think you can add bitbucket tag here now :)

haya14busa · 2020-10-24T12:07:14Z

Good idea. Done!

@haya14busa

https://github.com/reviewdog/reviewdog/tree/reviewdog:master # Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ### ✨ Release Note  ### 🚀 Enhancements - [reviewdog#888](reviewdog#888) Allow GitHub PR reporting for a forked repository iff it's triggered by `pull_request_target` ### 🐛 Fixes - ... ### 🚨 Breaking changes - ... --- ## [v0.11.0] - 2020-10-25 ### ✨ Release Note reviewdog v0.11 introduced [Reviewdog Diagnostic Format (RDFormat)](./README.md#reviewdog-diagnostic-format-rdformat) as generic machine-readable diagnostic format and it unlocks new rich features like code suggestions. ### 🚀 Enhancements - [reviewdog#629](reviewdog#629) Introduced Reviewdog Diagnostic Format. - [reviewdog#674](reviewdog#674) [reviewdog#703](reviewdog#703) Support rdjsonl/rdjson as input format - [reviewdog#680](reviewdog#680) github-pr-review: Support multiline comments - [reviewdog#675](reviewdog#675) [reviewdog#698](reviewdog#698) github-pr-review: Support suggested changes - [reviewdog#699](reviewdog#699) Support diff input format (`-f=diff`). Useful for suggested changes. - [reviewdog#700](reviewdog#700) Support to show code(rule), code URL and severity in GitHub and GitLab reporters. - [reviewdog#678](reviewdog#678) github-pr-review: Support Code Suggestions - Introduced [reviewdog/action-suggester](https://github.com/reviewdog/action-suggester) action. - Introduced [reviewdog/action-setup](https://github.com/reviewdog/action-setup) GitHub Action which installs reviewdog easily including nightly release. - [reviewdog#769](reviewdog#769) Integration with [Bitbucket Code Insights](https://support.atlassian.com/bitbucket-cloud/docs/code-insights/) and [Bitbucket Pipelines](https://bitbucket.org/product/ru/features/pipelines) --- ## [v0.10.2] - 2020-08-04 ### 🐛 Fixes - [reviewdog#709](reviewdog#709) Check for GITHUB_ACTIONS instead of GITHUB_ACTION --- ## [v0.10.1] - 2020-06-30 ### 🚀 Enhancements - [reviewdog#563](reviewdog#563) Use `CI_API_V4_URL` environment variable when present. ### 🐛 Fixes - [reviewdog#609](reviewdog#609) reviewdog command will fail with unexpected tool's error for github-check/github-pr-check reporters as well. ([@haya14busa]) - [reviewdog#603](reviewdog#603) Fixed detection of Pull Requests from forked repo. ([@haya14busa]) --- ## [v0.10.0] - 2020-05-07 ### ✨ Release Note With v0.10.0 release, now reviewdog can find issues outside diff by controlling filtering behavior with `-filter-mode`. Also, you can ensure to check reported results by exit 1 with `-fail-on-error`. Example ```shell $ cd subdir/ && reviewdog -filter-mode=file -fail-on-error -reporter=github-pr-review ``` ### 🚀 Enhancements - [reviewdog#446](reviewdog#446) Added `-fail-on-error` flag ([document](https://github.com/reviewdog/reviewdog/tree/e359505275143ec85e9b114fc1ab4a4e91d04fb5#exit-codes)) and improved exit code handling. ([@DmitryLanda](https://github.com/DmitryLanda), [@haya14busa]) - [reviewdog#187](reviewdog#187) Added `-filter-mode` flag [`added`, `diff_context`, `file`, `nofilter`] ([document](https://github.com/reviewdog/reviewdog/tree/e359505275143ec85e9b114fc1ab4a4e91d04fb5#filter-mode)) which controls how reviewdog filter results. ([@Le6ow5k1](https://github.com/Le6ow5k1), [@haya14busa]) - [reviewdog#69](reviewdog#69) Support gerrit! ([@staticmukesh](https://github.com/staticmukesh)) - [reviewdog#548](reviewdog#548) Introduced nightly release ([reviewdog/nightly](https://github.com/reviewdog/nightly)). ([@haya14busa]) ### 🐛 Fixes - [reviewdog#461](reviewdog#461) All reporters now supports sub-directory run. ([@haya14busa]) ### 🚨 Breaking changes - `github-check` reporter won't report results outside diff by default now. You need to use `-filter-mode=nofilter` to keep the same bahavior. --- See https://github.com/reviewdog/reviewdog/releases for older release note. [Unreleased]: reviewdog/reviewdog@v0.10.0...HEAD [v0.10.0]: reviewdog/reviewdog@v0.9.17...v0.10.0 [v0.10.1]: reviewdog/reviewdog@v0.10.0...v0.10.1 [v0.10.2]: reviewdog/reviewdog@v0.10.1...v0.10.2 [v0.11.0]: reviewdog/reviewdog@v0.10.2...v0.11.0 [@haya14busa]: https://github.com/haya14busa

taraspos added 13 commits October 1, 2020 13:52

copied code generated from swagger

f04439a

initial client creation

f71f0c4

bitbucket repors logic implementation checkpoint

47878f1

Merge branch 'master' of github.com:Trane9991/reviewdog into master

fa93025

swagger problem fix

1543130

implementation auth, error handling, etc

3910131

add documentation

8f34185

fix default behaviour

b7687c1

refactor annotations creation

27aad3c

fix empty map

9c2ba40

remove version from readme example

7213571

fix anchor in readme

9980154

update unreleased section in changelog

5941ea4

taraspos added 9 commits October 2, 2020 17:32

fix typo

fabcbb8

disable staticheck for generated openapi code

fe9d381

fixes for linters

1d10d83

fix to disable staticcheck for /bitbucket/openapi

fed19cd

annotation fixes

dbb5627

manually fix generated code to pass staticcheck

5177d13

fmt generated code

c130370

report per tool

e276f5a

remove severity counter

727d81d

taraspos added 3 commits October 3, 2020 11:40

remove mentions of ReportTitle configuration

4c4d5ca

batch annotations send

af9b22f

make sure we don't have duplicated events

c4448f1

taraspos mentioned this pull request Oct 6, 2020

Publish image on docker hub reviewdog/action-languagetool#19

Open

create green report when no issues found from specific runner

cc04040

haya14busa reviewed Oct 19, 2020

View reviewed changes

cmd/reviewdog/main.go Show resolved Hide resolved

cmd/reviewdog/main.go Outdated Show resolved Hide resolved

service/bitbucket/annotator.go Show resolved Hide resolved

taraspos and others added 14 commits October 21, 2020 21:26

fix bitbucket example in readme

e8c02ab

Co-authored-by: haya14busa <hayabusa1419@gmail.com>

bitbucket-code-report readme improvements

f231e34

Merge branch 'master' of https://github.com/reviewdog/reviewdog into …

6082468

…master

Merge branch 'master' of github.com:Trane9991/reviewdog into master

3cdc676

smarter build list of runners

f18714f

create "pending" reports on tool start

use empty filter always, for bb for now

b637ba1

remove TODO switch

235ee85

get external id from diagnostics message

fb8bbc1

add different message for pending report type

131c2e0

fix report id generation

0466356

fix variable name

d53cc10

fix the no-filter mode for bitbucket pipeline, upadate docs

042a616

add tests for annotator

1c58436

add screenshots of the annotations to readme

2b11a08

taraspos requested a review from haya14busa October 23, 2020 21:21

haya14busa requested changes Oct 24, 2020

View reviewed changes

haya14busa merged commit 2b11a08 into reviewdog:master Oct 24, 2020

haya14busa mentioned this pull request Oct 24, 2020

Add BitBucket E2E testing flow #798

Open

5 tasks

taraspos mentioned this pull request Oct 24, 2020

replace local bitbucket/openapi package with external reviewdog/go-bitbucket #799

Merged

	// MarkdownComment creates comment body markdown.
	func MarkdownComment(c *reviewdog.Comment) string {

Uh oh!

[bitbucket-code-report] Integration with Bitbucket Code Insights #769

[bitbucket-code-report] Integration with Bitbucket Code Insights #769

Uh oh!

Conversation

taraspos commented Oct 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

taraspos commented Oct 2, 2020

Uh oh!

taraspos commented Oct 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

taraspos commented Oct 2, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

taraspos commented Oct 23, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

review-dog commented Oct 24, 2020

Uh oh!

haya14busa commented Oct 24, 2020

Uh oh!

haya14busa commented Oct 24, 2020

Uh oh!

taraspos commented Oct 24, 2020

Uh oh!

haya14busa commented Oct 24, 2020

Uh oh!

taraspos commented Oct 24, 2020

Uh oh!

taraspos commented Oct 24, 2020

Uh oh!

haya14busa commented Oct 24, 2020

Uh oh!

Uh oh!

taraspos commented Oct 2, 2020 •

edited

Loading

taraspos commented Oct 2, 2020 •

edited

Loading