speed up CI and golangci-lint (#1070)

Run CI on mac os only with go1.13 and on windows only on go1.14.
Speed up tests. Introduce --allow-parallel-runners.
Block on parallel run lock 5s instead of 60s.
Don't invalidate analysis cache for minor config changes.

Author: jirfag

.github/workflows/pr.yml

@@ -23,17 +23,12 @@ jobs:
   tests-on-windows:
     needs: golangci-lint # run after golangci-lint action to not produce duplicated errors
     runs-on: windows-latest
-    strategy:
-      matrix:
-        golang:
-          - 1.13
-          - 1.14
     steps:
       - uses: actions/checkout@v2
       - name: Install Go
         uses: actions/setup-go@v2
         with:
-          go-version: ${{ matrix.golang }}
+          go-version: 1.14 # test only the latest go version to speed up CI
       - name: Run tests on Windows
         run: make.exe test
         continue-on-error: true
@@ -47,7 +42,11 @@ jobs:
           - 1.14
         os:
           - ubuntu-latest
-          - macos-latest
+        include:
+          - os: macos-latest
+            # test only the one go version on Mac OS to speed up CI
+            # TODO: use the latet go version after https://github.com/golang/go/issues/38824
+            golang: 1.13
     steps:
       - uses: actions/checkout@v2
       - name: Install Go

.golangci.example.yml

@@ -53,6 +53,10 @@ run:
   # the dependency descriptions in go.mod.
   modules-download-mode: readonly|release|vendor
 
+  # Allow multiple parallel golangci-lint instances running.
+  # If false (default) - golangci-lint acquires file lock on start.
+  allow-parallel-runners: false
+
 
 # output configuration options
 output:

Makefile

@@ -29,9 +29,7 @@ clean:
 test: export GOLANGCI_LINT_INSTALLED = true
 test: build
 	GL_TEST_RUN=1 ./golangci-lint run -v
-	GL_TEST_RUN=1 ./golangci-lint run --fast --no-config -v --skip-dirs 'test/testdata_etc,internal/(cache|renameio|robustio)'
-	GL_TEST_RUN=1 ./golangci-lint run --no-config -v --skip-dirs 'test/testdata_etc,internal/(cache|renameio|robustio)'
-	GL_TEST_RUN=1 go test -v ./...
+	GL_TEST_RUN=1 go test -v -parallel 2 ./...
 .PHONY: test
 
 test_race: build_race

README.md

@@ -546,6 +546,7 @@ Flags:
                                          - (^|/)builtin($|/)
                                         (default true)
       --skip-files strings             Regexps of files to skip
+      --allow-parallel-runners         Allow multiple parallel golangci-lint instances running. If false (default) - golangci-lint acquires file lock on start.
   -E, --enable strings                 Enable specific linter
   -D, --disable strings                Disable specific linter
       --disable-all                    Disable all linters
@@ -679,6 +680,10 @@ run:
   # the dependency descriptions in go.mod.
   modules-download-mode: readonly|release|vendor
 
+  # Allow multiple parallel golangci-lint instances running.
+  # If false (default) - golangci-lint acquires file lock on start.
+  allow-parallel-runners: false
+
 
 # output configuration options
 output:

internal/cache/cache_test.go

@@ -20,6 +20,8 @@ func init() {
 }
 
 func TestBasic(t *testing.T) {
+	t.Parallel()
+
 	dir, err := ioutil.TempDir("", "cachetest-")
 	if err != nil {
 		t.Fatal(err)
@@ -65,6 +67,8 @@ func TestBasic(t *testing.T) {
 }
 
 func TestGrowth(t *testing.T) {
+	t.Parallel()
+
 	dir, err := ioutil.TempDir("", "cachetest-")
 	if err != nil {
 		t.Fatal(err)
@@ -151,6 +155,8 @@ func dummyID(x int) [HashSize]byte {
 }
 
 func TestCacheTrim(t *testing.T) {
+	t.Parallel()
+
 	dir, err := ioutil.TempDir("", "cachetest-")
 	if err != nil {
 		t.Fatal(err)

pkg/commands/config.go

@@ -35,22 +35,32 @@ func (e *Executor) initConfig() {
 	cmd.AddCommand(pathCmd)
 }
 
+func (e *Executor) getUsedConfig() string {
+	usedConfigFile := viper.ConfigFileUsed()
+	if usedConfigFile == "" {
+		return ""
+	}
+
+	prettyUsedConfigFile, err := fsutils.ShortestRelPath(usedConfigFile, "")
+	if err != nil {
+		e.log.Warnf("Can't pretty print config file path: %s", err)
+		return usedConfigFile
+	}
+
+	return prettyUsedConfigFile
+}
+
 func (e *Executor) executePathCmd(_ *cobra.Command, args []string) {
 	if len(args) != 0 {
 		e.log.Fatalf("Usage: golangci-lint config path")
 	}
 
-	usedConfigFile := viper.ConfigFileUsed()
+	usedConfigFile := e.getUsedConfig()
 	if usedConfigFile == "" {
 		e.log.Warnf("No config file detected")
 		os.Exit(exitcodes.NoConfigFileDetected)
 	}
 
-	usedConfigFile, err := fsutils.ShortestRelPath(usedConfigFile, "")
-	if err != nil {
-		e.log.Warnf("Can't pretty print config file path: %s", err)
-	}
-
 	fmt.Println(usedConfigFile)
 	os.Exit(0)
 }

pkg/commands/executor.go

@@ -5,10 +5,10 @@ import (
 	"context"
 	"crypto/sha256"
 	"encoding/json"
-	"fmt"
 	"io"
 	"os"
 	"path/filepath"
+	"strings"
 	"time"
 
 	"github.com/fatih/color"
@@ -31,8 +31,9 @@ import (
 )
 
 type Executor struct {
-	rootCmd *cobra.Command
-	runCmd  *cobra.Command
+	rootCmd    *cobra.Command
+	runCmd     *cobra.Command
+	lintersCmd *cobra.Command
 
 	exitCode              int
 	version, commit, date string
@@ -55,6 +56,7 @@ type Executor struct {
 }
 
 func NewExecutor(version, commit, date string) *Executor {
+	startedAt := time.Now()
 	e := &Executor{
 		cfg:       config.NewDefault(),
 		version:   version,
@@ -66,9 +68,6 @@ func NewExecutor(version, commit, date string) *Executor {
 
 	e.debugf("Starting execution...")
 	e.log = report.NewLogWrapper(logutils.NewStderrLog(""), &e.reportData)
-	if ok := e.acquireFileLock(); !ok {
-		e.log.Fatalf("Parallel golangci-lint is running")
-	}
 
 	// to setup log level early we need to parse config from command line extra time to
 	// find `-v` option
@@ -121,6 +120,7 @@ func NewExecutor(version, commit, date string) *Executor {
 
 	// Slice options must be explicitly set for proper merging of config and command-line options.
 	fixSlicesFlags(e.runCmd.Flags())
+	fixSlicesFlags(e.lintersCmd.Flags())
 
 	e.EnabledLintersSet = lintersdb.NewEnabledSet(e.DBManager,
 		lintersdb.NewValidator(e.DBManager), e.log.Child("lintersdb"), e.cfg)
@@ -139,7 +139,7 @@ func NewExecutor(version, commit, date string) *Executor {
 	if err = e.initHashSalt(version); err != nil {
 		e.log.Fatalf("Failed to init hash salt: %s", err)
 	}
-	e.debugf("Initialized executor")
+	e.debugf("Initialized executor in %s", time.Since(startedAt))
 	return e
 }
 
@@ -191,27 +191,39 @@ func computeBinarySalt(version string) ([]byte, error) {
 }
 
 func computeConfigSalt(cfg *config.Config) ([]byte, error) {
-	configBytes, err := json.Marshal(cfg)
+	// We don't hash all config fields to reduce meaningless cache
+	// invalidations. At least, it has a huge impact on tests speed.
+
+	lintersSettingsBytes, err := json.Marshal(cfg.LintersSettings)
 	if err != nil {
-		return nil, errors.Wrap(err, "failed to json marshal config")
+		return nil, errors.Wrap(err, "failed to json marshal config linter settings")
 	}
 
+	var configData bytes.Buffer
+	configData.WriteString("linters-settings=")
+	configData.Write(lintersSettingsBytes)
+	configData.WriteString("\nbuild-tags=%s" + strings.Join(cfg.Run.BuildTags, ","))
+
 	h := sha256.New()
-	if n, err := h.Write(configBytes); n != len(configBytes) {
-		return nil, fmt.Errorf("failed to hash config bytes: wrote %d/%d bytes, error: %s", n, len(configBytes), err)
-	}
+	h.Write(configData.Bytes()) //nolint:errcheck
 	return h.Sum(nil), nil
 }
 
 func (e *Executor) acquireFileLock() bool {
+	if e.cfg.Run.AllowParallelRunners {
+		e.debugf("Parallel runners are allowed, no locking")
+		return true
+	}
+
 	lockFile := filepath.Join(os.TempDir(), "golangci-lint.lock")
 	e.debugf("Locking on file %s...", lockFile)
 	f := flock.New(lockFile)
-	ctx, finish := context.WithTimeout(context.Background(), time.Minute)
+	const totalTimeout = 5 * time.Second
+	const retryDelay = time.Second
+	ctx, finish := context.WithTimeout(context.Background(), totalTimeout)
 	defer finish()
 
-	timeout := time.Second * 3
-	if ok, _ := f.TryLockContext(ctx, timeout); !ok {
+	if ok, _ := f.TryLockContext(ctx, retryDelay); !ok {
 		return false
 	}
 
@@ -220,6 +232,10 @@ func (e *Executor) acquireFileLock() bool {
 }
 
 func (e *Executor) releaseFileLock() {
+	if e.cfg.Run.AllowParallelRunners {
+		return
+	}
+
 	if err := e.flock.Unlock(); err != nil {
 		e.debugf("Failed to unlock on file: %s", err)
 	}

pkg/commands/linters.go

@@ -11,13 +11,13 @@ import (
 )
 
 func (e *Executor) initLinters() {
-	lintersCmd := &cobra.Command{
+	e.lintersCmd = &cobra.Command{
 		Use:   "linters",
 		Short: "List current linters configuration",
 		Run:   e.executeLinters,
 	}
-	e.rootCmd.AddCommand(lintersCmd)
-	e.initRunConfiguration(lintersCmd)
+	e.rootCmd.AddCommand(e.lintersCmd)
+	e.initRunConfiguration(e.lintersCmd)
 }
 
 func (e *Executor) executeLinters(_ *cobra.Command, args []string) {

pkg/commands/root.go

@@ -73,7 +73,6 @@ func (e *Executor) persistentPostRun(_ *cobra.Command, _ []string) {
 		trace.Stop()
 	}
 
-	e.releaseFileLock()
 	os.Exit(e.exitCode)
 }
 

pkg/commands/run.go

@@ -106,6 +106,10 @@ func initFlagSet(fs *pflag.FlagSet, cfg *config.Config, m *lintersdb.Manager, is
 	fs.BoolVar(&rc.UseDefaultSkipDirs, "skip-dirs-use-default", true, getDefaultDirectoryExcludeHelp())
 	fs.StringSliceVar(&rc.SkipFiles, "skip-files", nil, wh("Regexps of files to skip"))
 
+	const allowParallelDesc = "Allow multiple parallel golangci-lint instances running. " +
+		"If false (default) - golangci-lint acquires file lock on start."
+	fs.BoolVar(&rc.AllowParallelRunners, "allow-parallel-runners", false, wh(allowParallelDesc))
+
 	// Linters settings config
 	lsc := &cfg.LintersSettings
 
@@ -251,6 +255,14 @@ func (e *Executor) initRun() {
 		Use:   "run",
 		Short: welcomeMessage,
 		Run:   e.executeRun,
+		PreRun: func(_ *cobra.Command, _ []string) {
+			if ok := e.acquireFileLock(); !ok {
+				e.log.Fatalf("Parallel golangci-lint is running")
+			}
+		},
+		PostRun: func(_ *cobra.Command, _ []string) {
+			e.releaseFileLock()
+		},
 	}
 	e.rootCmd.AddCommand(e.runCmd)