Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't report removed rules on syntax errors #1025

Merged
merged 1 commit into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## v0.61.2

### Fixed

- Fixed false positive reports about removed rules when running `pint ci` on a branch that
contains YAML syntax errors.

## v0.61.1

### Fixed
Expand Down
23 changes: 22 additions & 1 deletion internal/discovery/git_branch.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ func (f GitBranchFinder) Find(allEntries []Entry) (entries []Entry, err error) {
if err != nil {
return nil, fmt.Errorf("invalid file syntax: %w", err)
}

failedEntries := entriesWithPathErrors(entriesAfter)

slog.Debug(
"Parsing git file change",
slog.Any("commits", change.Commits),
Expand Down Expand Up @@ -134,7 +137,7 @@ func (f GitBranchFinder) Find(allEntries []Entry) (entries []Entry, err error) {
me.after.ModifiedLines = commonLines(change.Body.ModifiedLines, me.after.ModifiedLines)
}
entries = append(entries, me.after)
case me.hasBefore && !me.hasAfter:
case me.hasBefore && !me.hasAfter && len(failedEntries) == 0:
me.before.State = Removed
ml := commonLines(change.Body.ModifiedLines, me.before.ModifiedLines)
if len(ml) > 0 {
Expand All @@ -149,6 +152,15 @@ func (f GitBranchFinder) Find(allEntries []Entry) (entries []Entry, err error) {
slog.String("modifiedLines", output.FormatLineRangeString(me.before.ModifiedLines)),
)
entries = append(entries, me.before)
case me.hasBefore && !me.hasAfter && len(failedEntries) > 0:
slog.Debug(
"Rule not present on HEAD branch but there are parse errors",
slog.String("name", me.before.Rule.Name()),
slog.String("state", me.before.State.String()),
slog.String("path", me.before.Path.Name),
slog.String("ruleLines", me.before.Rule.Lines.String()),
slog.String("modifiedLines", output.FormatLineRangeString(me.before.ModifiedLines)),
)
default:
slog.Warn(
"Unknown rule state",
Expand Down Expand Up @@ -325,3 +337,12 @@ func countCommits(changes []*git.FileChange) int {
}
return len(commits)
}

func entriesWithPathErrors(entries []Entry) (match []Entry) {
for _, entry := range entries {
if entry.PathError != nil {
match = append(match, entry)
}
}
return match
}
54 changes: 54 additions & 0 deletions internal/discovery/git_branch_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1017,6 +1017,60 @@ groups:
},
},
},
{
title: "rule broken",
setup: func(t *testing.T) {
commitFile(t, "rules.yml", `
groups:
- name: v1
rules:
- record: rule1
expr: sum(up)
- record: rule2
expr: sum(up)
- record: rule3
expr: sum(up)
- record: rule4
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: rule1
expr: sum(up)
- record: rule2
expr: sum(up)
- record: rule3
expr: sum(up)
+
sum(up)
- record: rule4
expr: sum(up)
- record: rule5
expr: sum(up)
`, "v2")
},
finder: discovery.NewGitBranchFinder(git.RunGit, git.NewPathFilter(includeAll, nil, nil), "main", 4),
entries: []discovery.Entry{
{
State: discovery.Added,
Path: discovery.Path{
Name: "rules.yml",
SymlinkTarget: "rules.yml",
},
ModifiedLines: []int{3, 11, 12, 13, 14, 15, 16},
PathError: parser.ParseError{
Line: 11,
Err: errors.New("could not find expected ':'"),
},
},
},
},
}

for _, tc := range testCases {
Expand Down