Merge pull request #1242 from cloudflare/exhaustruct

Enable exhaustruct linter

Author: prymitive

.golangci.yml

@@ -27,9 +27,14 @@ linters:
     - exptostd
     - nilnesserr
     - usetesting
+    - exhaustruct
 
 issues:
   max-same-issues: 0
+  exclude-rules:
+  - path: ^.*_test\.go$
+    linters:
+    - exhaustruct
 
 linters-settings:
   goimports:
@@ -40,3 +45,23 @@ linters-settings:
     enable-all: true
   nakedret:
     max-func-lines: 0
+  exhaustruct:
+    exclude:
+      - net/http\..+
+      - crypto/tls\..+
+      - encoding/xml\..+
+      - .+/checks\.badMatcher
+      - .+/checks\.Problem
+      - .+/checks\.exprProblem
+      - .+/checks\..+Settings
+      - .+/config\.Match
+      - .+/discovery\.Entry
+      - .+/parser\.Rule
+      - .+/parser\.ParseError
+      - .+/parser\.VectorSelector
+      - .+/promapi\.MetricTimeRange
+      - github.com/prometheus/.+\..+
+      - github.com/urfave/cli/.+
+      - gitlab.com/gitlab-org/api/.+
+      - github.com/google/go-github/.+
+      - github.com/hashicorp/hcl/.+

cmd/pint/ci.go

@@ -285,45 +285,20 @@ func logSeverityCounters(src map[checks.Severity]int) (attrs []any) {
 }
 
 func detectCI(cfg *config.CI) *config.CI {
-	var isNil, isDirty bool
-
-	if cfg == nil {
-		isNil = true
-		cfg = &config.CI{}
-	}
-
 	if bb := os.Getenv("GITHUB_BASE_REF"); bb != "" {
-		isDirty = true
 		cfg.BaseBranch = bb
 		slog.Debug("got base branch from GITHUB_BASE_REF env variable", slog.String("branch", bb))
 	}
-
-	if isNil && !isDirty {
-		return nil
-	}
 	return cfg
 }
 
 func detectRepository(cfg *config.Repository) *config.Repository {
-	var isNil, isDirty bool
-
-	if cfg == nil {
-		isNil = true
-		cfg = &config.Repository{}
-	}
-
 	if os.Getenv("GITHUB_ACTION") != "" {
-		isDirty = true
 		cfg.GitHub = detectGithubActions(cfg.GitHub)
 	}
-
 	if cfg != nil && cfg.GitHub != nil && cfg.GitHub.MaxComments == 0 {
 		cfg.GitHub.MaxComments = 50
 	}
-
-	if isNil && !isDirty {
-		return nil
-	}
 	return cfg
 }
 
@@ -342,7 +317,7 @@ func detectGithubActions(gh *config.GitHub) *config.GitHub {
 
 	if gh == nil {
 		isNil = true
-		gh = &config.GitHub{Timeout: time.Minute.String()}
+		gh = &config.GitHub{Timeout: time.Minute.String()} // nolint:exhaustruct
 	}
 
 	if repo := os.Getenv("GITHUB_REPOSITORY"); repo != "" {

cmd/pint/lint.go

@@ -192,6 +192,7 @@ func verifyOwners(entries []discovery.Entry, allowedOwners []*regexp.Regexp) (re
 				Path:          entry.Path,
 				ModifiedLines: entry.ModifiedLines,
 				Rule:          entry.Rule,
+				Owner:         "",
 				Problem: checks.Problem{
 					Lines:    entry.Rule.Lines,
 					Reporter: discovery.RuleOwnerComment,
@@ -211,6 +212,7 @@ func verifyOwners(entries []discovery.Entry, allowedOwners []*regexp.Regexp) (re
 			Path:          entry.Path,
 			ModifiedLines: entry.ModifiedLines,
 			Rule:          entry.Rule,
+			Owner:         "",
 			Problem: checks.Problem{
 				Lines:    entry.Rule.Lines,
 				Reporter: discovery.RuleOwnerComment,

cmd/pint/scan.go

@@ -102,7 +102,7 @@ func checkRules(ctx context.Context, workers int, isOffline bool, gen *config.Pr
 				checkList := cfg.GetChecksForEntry(ctx, gen, entry)
 				for _, check := range checkList {
 					checkIterationChecks.Inc()
-					if check.Meta().IsOnline {
+					if check.Meta().Online {
 						onlineChecksCount.Inc()
 					} else {
 						offlineChecksCount.Inc()

cmd/pint/tests/0025_config.txt

@@ -12,6 +12,7 @@ level=INFO msg="Loading configuration file" path=.pint.hcl
     "maxCommits": 20
   },
   "parser": {},
+  "repository": {},
   "checks": {
     "enabled": [
       "alerts/absent",

cmd/pint/tests/0083_github_action.txt

@@ -61,4 +61,3 @@ groups:
 
 -- src/.pint.hcl --
 repository {}
-

cmd/pint/tests/0113_config_env_expand.txt

@@ -17,6 +17,7 @@ level=INFO msg="Loading configuration file" path=.pint.hcl
       ".*"
     ]
   },
+  "repository": {},
   "checks": {
     "enabled": [
       "alerts/absent",

cmd/pint/tests/0122_lint_owner_allowed.txt

@@ -5,7 +5,7 @@ cmp stderr stderr.txt
 -- stderr.txt --
 level=INFO msg="Loading configuration file" path=.pint.hcl
 level=INFO msg="Finding all rules to check" paths=["rules"]
-level=INFO msg="Checking Prometheus rules" entries=5 workers=10 online=true
+level=INFO msg="Checking Prometheus rules" entries=6 workers=10 online=true
 rules/1.yml:4-5 Bug: `rule/owner` comments are required in all files, please add a `# pint file/owner $owner` somewhere in this file and/or `# pint rule/owner $owner` on top of each rule. (rule/owner)
  4 |   - alert: No Owner
  5 |     expr: up > 0
@@ -14,14 +14,18 @@ rules/1.yml:7-8 Bug: This rule is set as owned by `bob` but `bob` doesn't match
  7 |   - alert: Invalid
  8 |     expr: up == 0
 
+rules/1.yml:13-14 Bug: This rule is set as owned by `zed` but `zed` doesn't match any of the allowed owner values. (rule/owner)
+ 13 |   - alert: Owner Zed
+ 14 |     expr: up < 0
+
 rules/2.yml:4-5 Bug: `rule/owner` comments are required in all files, please add a `# pint file/owner $owner` somewhere in this file and/or `# pint rule/owner $owner` on top of each rule. (rule/owner)
  4 |   - alert: No Owner
  5 |     expr: up > 0
 
 rules/3.yml:1 Bug: This file is set as owned by `ax` but `ax` doesn't match any of the allowed owner values. (rule/owner)
  1 | # pint file/owner ax
 
-level=INFO msg="Problems found" Bug=4
+level=INFO msg="Problems found" Bug=5
 level=ERROR msg="Fatal error" err="found 1 problem(s) with severity Bug or higher"
 -- rules/1.yml --
 groups:
@@ -35,6 +39,9 @@ groups:
   # pint rule/owner alice
   - alert: Owner Alice
     expr: up > 0
+  # pint rule/owner zed
+  - alert: Owner Zed
+    expr: up < 0
 
 -- rules/2.yml --
 groups:

cmd/pint/watch.go

@@ -283,7 +283,7 @@ type problemCollector struct {
 }
 
 func newProblemCollector(cfg config.Config, f pathFinderFunc, minSeverity checks.Severity, maxProblems int) *problemCollector {
-	return &problemCollector{
+	return &problemCollector{ // nolint:exhaustruct
 		finder:     f,
 		cfg:        cfg,
 		fileOwners: map[string]string{},

go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/cespare/xxhash/v2 v2.3.0
 	github.com/gkampitakis/go-snaps v0.5.8
 	github.com/google/go-cmp v0.6.0
-	github.com/google/go-github/v63 v63.0.0
+	github.com/google/go-github/v68 v68.0.0
 	github.com/hashicorp/hcl/v2 v2.23.0
 	github.com/klauspost/compress v1.17.11
 	github.com/neilotoole/slogt v1.1.0