added errgroupcheck linter

Author: alexbagnolini

.golangci.next.reference.yml

@@ -324,6 +324,11 @@ linters-settings:
     # Default: false
     report-no-exported: false
 
+  errgroupcheck:
+    # Check if any sync.errgroup.Group instance is missing a call to the Wait() func.
+    # Default: true
+    require-wait: true
+
   errorlint:
     # Check whether fmt.Errorf uses the %w verb for formatting errors.
     # See the https://github.com/polyfloyd/go-errorlint for caveats.

go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/GaijinEntertainment/go-exhaustruct/v3 v3.3.0
 	github.com/OpenPeeDeeP/depguard/v2 v2.2.0
 	github.com/alecthomas/go-check-sumtype v0.1.4
+	github.com/alexbagnolini/errgroupcheck v0.1.2
 	github.com/alexkohler/nakedret/v2 v2.0.4
 	github.com/alexkohler/prealloc v1.0.0
 	github.com/alingse/asasalint v0.0.11

go.sum

@@ -312,6 +312,7 @@
             "durationcheck",
             "errcheck",
             "errchkjson",
+            "errgroupcheck",
             "errname",
             "errorlint",
             "execinquery",
@@ -865,6 +866,17 @@
             }
           }
         },
+        "errgroupcheck": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "require-wait": {
+              "description": "Check if any sync.errgroup.Group instance is missing a call to the Wait() func.",
+              "type": "boolean",
+              "default": true
+            }
+          }
+        },
         "errorlint": {
           "type": "object",
           "additionalProperties": false,

jsonschema/golangci.next.jsonschema.json

@@ -208,6 +208,7 @@ type LintersSettings struct {
 	DupWord         DupWordSettings
 	Errcheck        ErrcheckSettings
 	ErrChkJSON      ErrChkJSONSettings
+	ErrGroupCheck   ErrGroupCheckSettings
 	ErrorLint       ErrorLintSettings
 	Exhaustive      ExhaustiveSettings
 	Exhaustruct     ExhaustructSettings
@@ -382,6 +383,10 @@ type ErrChkJSONSettings struct {
 	ReportNoExported       bool `mapstructure:"report-no-exported"`
 }
 
+type ErrGroupCheckSettings struct {
+	RequireWait bool `mapstructure:"require-wait"`
+}
+
 type ErrorLintSettings struct {
 	Errorf                bool                 `mapstructure:"errorf"`
 	ErrorfMulti           bool                 `mapstructure:"errorf-multi"`

pkg/config/linters_settings.go

@@ -0,0 +1,33 @@
+package errgroupcheck
+
+import (
+	"github.com/alexbagnolini/errgroupcheck"
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/goanalysis"
+	"golang.org/x/tools/go/analysis"
+)
+
+func New(cfg *config.ErrGroupCheckSettings) *goanalysis.Linter {
+	var setts = errgroupcheck.DefaultSettings()
+
+	if cfg != nil {
+		setts.RequireWait = cfg.RequireWait
+	}
+
+	cfgMap := map[string]map[string]any{}
+
+	analyzer := errgroupcheck.NewAnalyzer(setts)
+
+	if cfg != nil {
+		cfgMap[analyzer.Name] = map[string]any{
+			"require-wait": cfg.RequireWait,
+		}
+	}
+
+	return goanalysis.NewLinter(
+		analyzer.Name,
+		analyzer.Doc,
+		[]*analysis.Analyzer{analyzer},
+		nil,
+	).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}

pkg/golinters/errgroupcheck/errgroupcheck.go

@@ -0,0 +1,11 @@
+package errgroupcheck
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

pkg/golinters/errgroupcheck/errgroupcheck_test.go

@@ -0,0 +1,101 @@
+//golangcitest:args -Eerrgroupcheck
+//golangcitest:config_path testdata/errgroupcheck_wait.yml
+package testdata
+
+import (
+	"context"
+
+	"golang.org/x/sync/errgroup"
+)
+
+func ErrgroupWithWait() {
+	eg := errgroup.Group{}
+
+	eg.Go(func() error {
+		return nil
+	})
+
+	eg.Go(func() error {
+		return nil
+	})
+
+	_ = eg.Wait()
+}
+
+func ErrgroupMissingWait() {
+	eg := errgroup.Group{} // want "errgroup 'eg' does not have Wait called"
+
+	eg.Go(func() error {
+		return nil
+	})
+
+	eg.Go(func() error {
+		return nil
+	})
+}
+
+func ErrgroupContextWithWait() {
+	eg, _ := errgroup.WithContext(context.Background())
+
+	eg.Go(func() error {
+		return nil
+	})
+
+	eg.Go(func() error {
+		return nil
+	})
+
+	_ = eg.Wait()
+}
+
+func ErrgroupContextMissingWait() {
+	eg, _ := errgroup.WithContext(context.Background()) // want "errgroup 'eg' does not have Wait called"
+
+	eg.Go(func() error {
+		return nil
+	})
+
+	eg.Go(func() error {
+		return nil
+	})
+}
+
+func ErrgroupMultipleScopesWithWait() {
+	eg := errgroup.Group{}
+
+	eg.Go(func() error {
+		return nil
+	})
+
+	eg.Go(func() error {
+		eg2 := errgroup.Group{}
+
+		eg2.Go(func() error {
+			return nil
+		})
+
+		return eg2.Wait()
+	})
+
+	_ = eg.Wait()
+}
+
+func ErrgroupMultipleScopesMissingWait() {
+	eg := errgroup.Group{}
+
+	eg.Go(func() error {
+		return nil
+	})
+
+	eg.Go(func() error {
+		eg2 := errgroup.Group{} // want "errgroup 'eg2' does not have Wait called"
+
+		eg2.Go(func() error {
+			return nil
+		})
+
+		return nil
+	})
+
+	_ = eg.Wait()
+}

pkg/golinters/errgroupcheck/testdata/errgroupcheck_wait.go

@@ -0,0 +1,3 @@
+linters-settings:
+  errgroupcheck:
+    require-wait: true

pkg/golinters/errgroupcheck/testdata/errgroupcheck_wait.yml

@@ -0,0 +1,5 @@
+module wait
+
+go 1.19
+
+require golang.org/x/sync v0.7.0