Add more test coverage

Author: prymitive

internal/reporter/comments_test.go

@@ -159,6 +159,41 @@ bar warning
 		meta: nil,
 	}
 
+	infoReport := Report{
+		Path: discovery.Path{
+			SymlinkTarget: "info.txt",
+			Name:          "info.txt",
+		},
+		Changes: discovery.Changes{
+			OldPath: "",
+			Lines:   git.LineNumbers{{Before: 0, After: 1}},
+		},
+		Rule: mockFile.Groups[0].Rules[0],
+		Problem: checks.Problem{
+			Reporter: "info",
+			Summary:  "info note",
+			Details:  "",
+			Lines:    diags.LineRange{First: 1, Last: 1},
+			Severity: checks.Information,
+			Anchor:   checks.AnchorAfter,
+		},
+	}
+	infoComment := ExistingComment{
+		path: "info.txt",
+		line: 1,
+		text: `:information_source: **Information** reported by [pint](https://cloudflare.github.io/pint/) **info** check.
+
+------
+
+info note
+
+------
+
+:information_source: To see documentation covering this check and instructions on how to resolve it [click here](https://cloudflare.github.io/pint/checks/info.html).
+`,
+		meta: nil,
+	}
+
 	type testCaseT struct {
 		commenter      Commenter
 		checkErr       func(t *testing.T, err error)
@@ -203,7 +238,7 @@ bar warning
 		},
 		{
 			description: "no-op when all comments already exist",
-			reports:     []Report{fooReport, barReport},
+			reports:     []Report{fooReport, barReport, infoReport},
 			commenter: testCommenter{
 				destinations: func(_ context.Context) ([]any, error) {
 					return []any{1}, nil
@@ -215,7 +250,7 @@ bar warning
 					return nil
 				},
 				list: func(_ context.Context, _ any) ([]ExistingComment, error) {
-					return []ExistingComment{fooComment, barComment}, nil
+					return []ExistingComment{fooComment, barComment, infoComment}, nil
 				},
 				create: func(_ context.Context, _ any, p PendingComment) error {
 					return fmt.Errorf("shouldn't try to create %s:%d", p.path, p.line)

internal/reporter/reporter_test.go

@@ -28,6 +28,11 @@ func TestReportIsEqual(t *testing.T) {
 			b:        Report{Path: discovery.Path{Name: "bar"}, Rule: parser.Rule{}},
 			expected: false,
 		},
+		{
+			a:        Report{Path: discovery.Path{Name: "foo", SymlinkTarget: "a"}, Rule: parser.Rule{}},
+			b:        Report{Path: discovery.Path{Name: "foo", SymlinkTarget: "b"}, Rule: parser.Rule{}},
+			expected: false,
+		},
 		{
 			a:        Report{Path: discovery.Path{Name: "foo"}, Rule: parser.Rule{}, Owner: "bob"},
 			b:        Report{Path: discovery.Path{Name: "foo"}, Rule: parser.Rule{}},
@@ -48,6 +53,18 @@ func TestReportIsEqual(t *testing.T) {
 			b:        Report{Path: discovery.Path{Name: "foo"}, Rule: parser.Rule{Lines: diags.LineRange{Last: 1}}, Problem: checks.Problem{Lines: diags.LineRange{Last: 1}}},
 			expected: false,
 		},
+		{
+			a:        Report{Path: discovery.Path{Name: "foo"}, Rule: parser.Rule{Lines: diags.LineRange{Last: 1}}, Problem: checks.Problem{Lines: diags.LineRange{Last: 2}}},
+			b:        Report{Path: discovery.Path{Name: "foo"}, Rule: parser.Rule{Lines: diags.LineRange{Last: 1}}, Problem: checks.Problem{Lines: diags.LineRange{Last: 1}}},
+			expected: false,
+		},
+		{
+			a: Report{Path: discovery.Path{Name: "foo"}, Rule: parser.Rule{}, Problem: checks.Problem{
+				Diagnostics: []diags.Diagnostic{{Message: "a"}},
+			}},
+			b:        Report{Path: discovery.Path{Name: "foo"}, Rule: parser.Rule{}, Problem: checks.Problem{}},
+			expected: false,
+		},
 		{
 			a:        Report{Path: discovery.Path{Name: "foo"}, Rule: parser.Rule{}, Problem: checks.Problem{Reporter: "a"}},
 			b:        Report{Path: discovery.Path{Name: "foo"}, Rule: parser.Rule{}, Problem: checks.Problem{Reporter: "b"}},
@@ -216,6 +233,62 @@ func TestReportIsSameIssue(t *testing.T) {
 			},
 			expected: false,
 		},
+		{
+			name: "different summary",
+			a: Report{
+				Problem: checks.Problem{
+					Reporter: "promql/series",
+					Summary:  "a",
+					Severity: checks.Warning,
+				},
+			},
+			b: Report{
+				Problem: checks.Problem{
+					Reporter: "promql/series",
+					Summary:  "b",
+					Severity: checks.Warning,
+				},
+			},
+			expected: false,
+		},
+		{
+			name: "different severity",
+			a: Report{
+				Problem: checks.Problem{
+					Reporter: "promql/series",
+					Summary:  "a",
+					Severity: checks.Warning,
+				},
+			},
+			b: Report{
+				Problem: checks.Problem{
+					Reporter: "promql/series",
+					Summary:  "a",
+					Severity: checks.Bug,
+				},
+			},
+			expected: false,
+		},
+		{
+			name: "different diagnostics",
+			a: Report{
+				Problem: checks.Problem{
+					Reporter:    "promql/series",
+					Summary:     "a",
+					Severity:    checks.Warning,
+					Diagnostics: []diags.Diagnostic{{Message: "x"}},
+				},
+			},
+			b: Report{
+				Problem: checks.Problem{
+					Reporter:    "promql/series",
+					Summary:     "a",
+					Severity:    checks.Warning,
+					Diagnostics: []diags.Diagnostic{{Message: "y"}},
+				},
+			},
+			expected: false,
+		},
 	}
 
 	for _, tc := range testCases {

internal/reporter/summary_test.go

@@ -3,9 +3,9 @@ package reporter
 import (
 	"testing"
 
-	"github.com/cloudflare/pint/internal/checks"
-
 	"github.com/stretchr/testify/require"
+
+	"github.com/cloudflare/pint/internal/checks"
 )
 
 func TestNewSummary(t *testing.T) {