Merge pull request #1091 from cloudflare/tests

Add more test coverage
cloudflare · Aug 27, 2024 · 80986de · 80986de
2 parents 654267a + 0db239f
commit 80986de
Show file tree

Hide file tree

Showing 16 changed files with 307 additions and 26 deletions.
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -9,7 +9,7 @@ permissions:
   pull-requests: write
 
 jobs:
-  test-go:
+  benchmark:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code

diff --git a/.github/workflows/compile.yml b/.github/workflows/compile.yml
@@ -13,6 +13,8 @@ on:
     types:
       - published
 
+permissions: read-all
+
 jobs:
   build:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/deps.yml b/.github/workflows/deps.yml
@@ -1,8 +1,7 @@
 name: "Dependency Review"
 on: [pull_request]
 
-permissions:
-  contents: read
+permissions: read-all
 
 jobs:
   dependency-review:

diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -11,8 +11,10 @@ on:
     types:
       - published
 
+permissions: read-all
+
 jobs:
-  amd64:
+  docker-amd64:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
@@ -27,7 +29,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: Build and push
+      - name: Build
         id: docker_build
         uses: docker/build-push-action@v6
         with:
@@ -36,7 +38,7 @@ jobs:
           platforms: linux/amd64
           push: false
 
-  arm64:
+  docker-arm64:
     if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     steps:
@@ -52,7 +54,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: Build and push
+      - name: Build
         id: docker_build
         uses: docker/build-push-action@v6
         with:

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,6 +1,8 @@
 name: Spellcheck
 on: [pull_request]
 
+permissions: read-all
+
 jobs:
   spellcheck:
     name: Spellcheck

diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -8,8 +8,10 @@ on:
     branches:
       - main
 
+permissions: read-all
+
 jobs:
-  test-go:
+  examples:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code

diff --git a/.github/workflows/go-mod-tidy.yml b/.github/workflows/go-mod-tidy.yml
@@ -8,6 +8,8 @@ on:
     branches:
       - main
 
+permissions: read-all
+
 jobs:
   go-mod-tidy:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/goreleaser.yml b/.github/workflows/goreleaser.yml
@@ -8,6 +8,8 @@ on:
     branches:
       - main
 
+permissions: read-all
+
 jobs:
   goreleaser-config:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -8,6 +8,8 @@ on:
     branches:
       - main
 
+permissions: read-all
+
 jobs:
   golangci-lint:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -19,7 +19,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build:
+  pages:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -8,6 +8,8 @@ on:
     branches:
       - main
 
+permissions: read-all
+
 jobs:
   test-go:
     runs-on: ubuntu-latest

diff --git a/cmd/pint/scan.go b/cmd/pint/scan.go
@@ -65,8 +65,6 @@ func checkRules(ctx context.Context, workers int, isOffline bool, gen *config.Pr
 	go func() {
 		for _, entry := range entries {
 			switch {
-			case entry.State == discovery.Excluded:
-				continue
 			case entry.PathError != nil && entry.State == discovery.Removed:
 				continue
 			case entry.Rule.Error.Err != nil && entry.State == discovery.Removed:

diff --git a/internal/discovery/discovery.go b/internal/discovery/discovery.go
@@ -45,8 +45,6 @@ func (c ChangeType) String() string {
 		return "removed"
 	case Moved:
 		return "moved"
-	case Excluded:
-		return "excluded"
 	default:
 		return "---"
 	}
@@ -63,7 +61,6 @@ const (
 	Modified
 	Removed
 	Moved
-	Excluded
 )
 
 type Path struct {

diff --git a/internal/discovery/git_branch.go b/internal/discovery/git_branch.go
@@ -105,7 +105,7 @@ func (f GitBranchFinder) Find(allEntries []Entry) (entries []Entry, err error) {
 			case me.hasBefore && me.hasAfter:
 				switch {
 				case me.isIdentical && !me.wasMoved:
-					me.after.State = Excluded
+					me.after.State = Noop
 					me.after.ModifiedLines = []int{}
 					slog.Debug(
 						"Rule content was not modified on HEAD, identical rule present before",

diff --git a/internal/discovery/git_branch_test.go b/internal/discovery/git_branch_test.go
@@ -206,7 +206,7 @@ groups:
 			finder: discovery.NewGitBranchFinder(git.RunGit, git.NewPathFilter(includeAll, nil, nil), "main", 4),
 			entries: []discovery.Entry{
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -472,7 +472,7 @@ groups:
 					Rule:          mustParse(6, "- record: up:count:2a\n  expr: count(up)\n"),
 				},
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -535,7 +535,7 @@ groups:
 					Rule:          mustParse(1, "- alert: rule1\n  expr: sum(foo) by(job)\n  for: 0s\n"),
 				},
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -566,7 +566,7 @@ groups:
 			finder: discovery.NewGitBranchFinder(git.RunGit, git.NewPathFilter(includeAll, nil, includeAll), "main", 4),
 			entries: []discovery.Entry{
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -606,7 +606,7 @@ groups:
 			finder: discovery.NewGitBranchFinder(git.RunGit, git.NewPathFilter(includeAll, nil, includeAll), "main", 4),
 			entries: []discovery.Entry{
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -650,7 +650,7 @@ groups:
 			finder: discovery.NewGitBranchFinder(git.RunGit, git.NewPathFilter(includeAll, nil, includeAll), "main", 4),
 			entries: []discovery.Entry{
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -659,7 +659,7 @@ groups:
 					Rule:          mustParse(1, "- alert: rule1\n  expr: sum(foo) by(job)\n"),
 				},
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -756,7 +756,7 @@ groups:
 			finder: discovery.NewGitBranchFinder(git.RunGit, git.NewPathFilter(includeAll, nil, includeAll), "main", 4),
 			entries: []discovery.Entry{
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -765,7 +765,7 @@ groups:
 					Rule:          mustParse(1, "- alert: rule1\n  expr: sum(foo) by(job)\n"),
 				},
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -887,7 +887,7 @@ groups:
 			finder: discovery.NewGitBranchFinder(git.RunGit, git.NewPathFilter(includeAll, nil, includeAll), "main", 4),
 			entries: []discovery.Entry{
 				{
-					State: discovery.Excluded,
+					State: discovery.Noop,
 					Path: discovery.Path{
 						Name:          "rules.yml",
 						SymlinkTarget: "rules.yml",
@@ -1127,6 +1127,83 @@ groups:
 				},
 			},
 		},
+		{
+			title: "add two dups",
+			setup: func(t *testing.T) {
+				commitFile(t, "rules.yml", `
+- alert: rule1
+  expr: sum(foo) by(job)
+- alert: rule2
+  expr: sum(foo) by(job)
+- alert: rule3
+  expr: sum(foo) by(job)
+`, "v1")
+
+				_, err := git.RunGit("checkout", "-b", "v2")
+				require.NoError(t, err, "git checkout v2")
+
+				commitFile(t, "rules.yml", `
+- alert: rule1
+  expr: sum(foo) by(job)
+- alert: rule2
+  expr: sum(foo) by(job)
+- alert: rule3
+  expr: sum(foo) by(job)
+- alert: rule1
+  expr: sum(foo) by(job)
+- alert: rule1
+  expr: sum(foo) by(job)
+`, "v2")
+			},
+			finder: discovery.NewGitBranchFinder(git.RunGit, git.NewPathFilter(includeAll, nil, includeAll), "main", 4),
+			entries: []discovery.Entry{
+				{
+					State: discovery.Noop,
+					Path: discovery.Path{
+						Name:          "rules.yml",
+						SymlinkTarget: "rules.yml",
+					},
+					ModifiedLines: []int{},
+					Rule:          mustParse(1, "- alert: rule1\n  expr: sum(foo) by(job)\n"),
+				},
+				{
+					State: discovery.Noop,
+					Path: discovery.Path{
+						Name:          "rules.yml",
+						SymlinkTarget: "rules.yml",
+					},
+					ModifiedLines: []int{},
+					Rule:          mustParse(3, "- alert: rule2\n  expr: sum(foo) by(job)\n"),
+				},
+				{
+					State: discovery.Noop,
+					Path: discovery.Path{
+						Name:          "rules.yml",
+						SymlinkTarget: "rules.yml",
+					},
+					ModifiedLines: []int{},
+					Rule:          mustParse(5, "- alert: rule3\n  expr: sum(foo) by(job)\n"),
+				},
+				{
+					State: discovery.Added,
+					Path: discovery.Path{
+						Name:          "rules.yml",
+						SymlinkTarget: "rules.yml",
+					},
+					ModifiedLines: []int{8, 9},
+					Rule:          mustParse(7, "- alert: rule1\n  expr: sum(foo) by(job)\n"),
+				},
+				{
+					State: discovery.Added,
+					Path: discovery.Path{
+						Name:          "rules.yml",
+						SymlinkTarget: "rules.yml",
+					},
+					ModifiedLines: []int{10, 11},
+					Rule:          mustParse(9, "- alert: rule1\n  expr: sum(foo) by(job)\n"),
+				},
+			},
+		},
 	}
 
 	for _, tc := range testCases {