Merge pull request #1365 from cloudflare/bb

Don't report annotations from unmodified rules

Author: prymitive

docs/changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.71.8
+
+### Fixed
+
+- Don't try to report problems to BitBucket for unmodified rules.
+
 ## v0.71.7
 
 ### Fixed

internal/discovery/git_branch_test.go

@@ -1218,6 +1218,55 @@ groups:
 				},
 			},
 		},
+		{
+			title: "rule comment modified",
+			setup: func(t *testing.T) {
+				commitFile(t, "rules.yml", `
+groups:
+- name: v1
+  rules:
+  - record: up:count
+    pint disable promql/series(up)
+    expr: sum(up)
+`, "v1")
+
+				_, err := git.RunGit("checkout", "-b", "v2")
+				require.NoError(t, err, "git checkout v2")
+
+				commitFile(t, "rules.yml", `
+groups:
+- name: v2
+  rules:
+  - record: up:count
+    # pint disable promql/series(up)
+    expr: sum(up)
+`, "v2")
+			},
+			finder: discovery.NewGitBranchFinder(git.RunGit, git.NewPathFilter(includeAll, nil, nil), "main", 4, parser.PrometheusSchema, model.UTF8Validation, nil),
+			entries: []discovery.Entry{
+				{
+					State: discovery.Added,
+					Path: discovery.Path{
+						Name:          "rules.yml",
+						SymlinkTarget: "rules.yml",
+					},
+					ModifiedLines: []int{6},
+					Rule:          mustParse(4, "  - record: up:count\n    # pint disable promql/series(up)\n    expr: sum(up)\n"),
+				},
+				{
+					State: discovery.Removed,
+					Path: discovery.Path{
+						Name:          "rules.yml",
+						SymlinkTarget: "rules.yml",
+					},
+					PathError: parser.ParseError{
+						Err:  errors.New("xxx"),
+						Line: 6,
+					},
+					ModifiedLines: []int{3, 6},
+				},
+			},
+		},
 	}
 
 	for _, tc := range testCases {

internal/reporter/bitbucket.go

@@ -155,6 +155,5 @@ func moveReportedLine(report Report) (reported, original int) {
 	if reported < 0 {
 		reported = 0
 	}
-
 	return reported, original
 }

internal/reporter/bitbucket_api.go

@@ -375,7 +375,12 @@ func (bb bitBucketAPI) createReport(summary Summary, commit string) error {
 func (bb bitBucketAPI) createAnnotations(summary Summary, commit string) error {
 	annotations := make([]BitBucketAnnotation, 0, len(summary.reports))
 	for _, report := range summary.reports {
-		annotations = append(annotations, reportToAnnotation(report))
+		ann := reportToAnnotation(report)
+		if !slices.Contains(report.ModifiedLines, ann.Line) {
+			slog.Warn("Annotation for unmodified line, skipping", slog.String("path", ann.Path), slog.Int("line", ann.Line))
+			continue
+		}
+		annotations = append(annotations, ann)
 	}
 
 	if len(annotations) == 0 {

internal/reporter/bitbucket_test.go

@@ -1935,6 +1935,53 @@ func TestBitBucketReporter(t *testing.T) {
 				return nil
 			},
 		},
+		{
+			description: "annotation on unmodified lines",
+			gitCmd:      fakeGit,
+			reports: []reporter.Report{
+				{
+					Path: discovery.Path{
+						SymlinkTarget: "foo.txt",
+						Name:          "foo.txt",
+					},
+					ModifiedLines: []int{},
+					Rule:          mockRules[1],
+					Problem: checks.Problem{
+						Lines: diags.LineRange{
+							First: 1,
+							Last:  1,
+						},
+						Reporter: "mock",
+						Summary:  "line is not part of the diff",
+						Severity: checks.Bug,
+					},
+				},
+			},
+			report: reporter.BitBucketReport{
+				Reporter: "Prometheus rule linter",
+				Title:    "pint v0.0.0",
+				Details:  reporter.BitBucketDescription,
+				Link:     "https://cloudflare.github.io/pint/",
+				Result:   "FAIL",
+				Data: []reporter.BitBucketReportData{
+					{Title: "Number of rules parsed", Type: reporter.NumberType, Value: float64(0)},
+					{Title: "Number of rules checked", Type: reporter.NumberType, Value: float64(0)},
+					{Title: "Number of problems found", Type: reporter.NumberType, Value: float64(1)},
+					{Title: "Number of offline checks", Type: reporter.NumberType, Value: float64(0)},
+					{Title: "Number of online checks", Type: reporter.NumberType, Value: float64(0)},
+					{Title: "Checks duration", Type: reporter.DurationType, Value: float64(0)},
+				},
+			},
+			annotations: reporter.BitBucketAnnotations{
+				Annotations: []reporter.BitBucketAnnotation{},
+			},
+			errorHandler: func(err error) error {
+				if err != nil {
+					return fmt.Errorf("Unpexpected error: %w", err)
+				}
+				return nil
+			},
+		},
 	}
 
 	for _, tc := range testCases {