Merge pull request #464 from innogames/md_linter

Fix some linter warnings and deprecations

.air.toml

@@ -7,7 +7,7 @@ tmp_dir = "tmp"
   bin = "./tmp/main"
   cmd = "go build -o ./tmp/main cmd/bot/main.go"
   delay = 2500
-  exclude_dir = ["storage", "tmp", "vendor"]
+  exclude_dir = ["storage", "tmp", "vendor", "build", "docs", "examples"]
   exclude_file = []
   exclude_regex = ["_test.go"]
   exclude_unchanged = false

.golangci.yml

@@ -7,6 +7,7 @@ issues:
 
 linters:
   enable:
+    - asasalint
     - asciicheck
     - bodyclose
     - dogsled
@@ -16,6 +17,7 @@ linters:
     - exhaustive
     - exportloopref
     - gochecknoinits
+    - gocheckcompilerdirectives
     - gocritic
     - gocyclo
     - gofumpt
@@ -25,6 +27,8 @@ linters:
     - govet
     - importas
     - ineffassign
+    - loggercheck
+    - mirror
     - makezero
     - megacheck
     - misspell

Makefile

@@ -60,6 +60,6 @@ mocks: dep
 	go generate ./...
 
 # live reload, see https://github.com/cosmtrek/air
-air:
+run-live-reload:
 	command -v air || go install github.com/cosmtrek/air@latest
 	air

bot/storage/file.go

@@ -1,7 +1,7 @@
 package storage
 
 import (
-	"io/ioutil"
+	"os"
 	"path/filepath"
 	"strings"
 
@@ -21,7 +21,7 @@ type fileStorage struct {
 
 func (s *fileStorage) GetKeys(collection string) ([]string, error) {
 	dir := filepath.Join(s.dir, collection)
-	files, _ := ioutil.ReadDir(dir)
+	files, _ := os.ReadDir(dir)
 
 	keys := make([]string, 0, len(files))
 

bot/storage/redis.go

@@ -18,31 +18,30 @@ type redisStorage struct {
 	client *redis.Client
 }
 
+var redisCtx = context.Background()
+
 func (s redisStorage) Write(collection, key string, v any) error {
 	data, err := json.Marshal(v)
 	if err != nil {
 		return err
 	}
 
-	ctx := context.Background()
-	s.client.HSet(ctx, collection, key, string(data))
+	s.client.HSet(redisCtx, collection, key, data)
 
 	return nil
 }
 
 func (s redisStorage) Read(collection, key string, v any) error {
-	ctx := context.Background()
-	res, err := s.client.HGet(ctx, collection, key).Result()
+	res, err := s.client.HGet(redisCtx, collection, key).Bytes()
 	if err != nil {
 		return err
 	}
 
-	return json.Unmarshal([]byte(res), v)
+	return json.Unmarshal(res, v)
 }
 
 func (s redisStorage) GetKeys(collection string) ([]string, error) {
-	ctx := context.Background()
-	res, err := s.client.HKeys(ctx, collection).Result()
+	res, err := s.client.HKeys(redisCtx, collection).Result()
 	if err != nil {
 		return nil, err
 	}
@@ -51,8 +50,5 @@ func (s redisStorage) GetKeys(collection string) ([]string, error) {
 }
 
 func (s redisStorage) Delete(collection, key string) error {
-	ctx := context.Background()
-	_, err := s.client.HDel(ctx, collection, key).Result()
-
-	return err
+	return s.client.HDel(redisCtx, collection, key).Err()
 }

command/clouds/aws/ecs.go

@@ -112,7 +112,8 @@ func ListServices(cluster string) ([]string, error) {
 
 func assertECS() *ecs.ECS {
 	if _ecs == nil {
-		_ecs = ecs.New(session.New(getServiceConfiguration()))
+		sess, _ := session.NewSession(getServiceConfiguration())
+		_ecs = ecs.New(sess)
 	}
 	return _ecs
 }
@@ -144,7 +145,7 @@ func ForceNewDeployment(clusterName string, serviceName string) error {
 		return err
 	}
 	if len(result.Services) == 0 {
-		return fmt.Errorf("Could not find service %s in cluster %s", serviceName, clusterName)
+		return fmt.Errorf("could not find service %s in cluster %s", serviceName, clusterName)
 	}
 
 	// Update Service

command/games/quiz.go

@@ -8,14 +8,14 @@ import (
 	"math/rand"
 	"net/http"
 	"strconv"
-
-	"github.com/slack-go/slack"
+	"time"
 
 	"github.com/innogames/slack-bot/v2/bot"
 	"github.com/innogames/slack-bot/v2/bot/matcher"
 	"github.com/innogames/slack-bot/v2/bot/msg"
 	"github.com/innogames/slack-bot/v2/client"
 	"github.com/pkg/errors"
+	"github.com/slack-go/slack"
 )
 
 const (
@@ -25,13 +25,21 @@ const (
 
 // NewQuizCommand returns a new quizCommand which is a small quiz game
 func NewQuizCommand(base bot.BaseCommand) bot.Command {
-	return &quizCommand{base, quiz{}, apiURL}
+	random := rand.New(rand.NewSource(time.Now().UnixNano())) //nolint:gosec
+
+	return &quizCommand{
+		base,
+		quiz{},
+		apiURL,
+		random,
+	}
 }
 
 type quizCommand struct {
 	bot.BaseCommand
 	quiz   quiz
 	apiURL string
+	rand   *rand.Rand
 }
 
 type question struct {
@@ -125,7 +133,7 @@ func (c *quizCommand) parseAnswers() {
 		answers := question.IncorrectAnswers
 		answers = append(answers, question.CorrectAnswer)
 
-		rand.Shuffle(len(answers), func(i, j int) {
+		c.rand.Shuffle(len(answers), func(i, j int) {
 			answers[i], answers[j] = answers[j], answers[i]
 		})
 

command/games/quiz_test.go

@@ -1,7 +1,6 @@
 package games
 
 import (
-	"math/rand"
 	"net/http"
 	"net/http/httptest"
 	"os"
@@ -17,8 +16,6 @@ func TestQuiz(t *testing.T) {
 	slackClient := &mocks.SlackClient{}
 	base := bot.BaseCommand{SlackClient: slackClient}
 
-	// mock test data
-	rand.Seed(2)
 	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		file, _ := os.ReadFile("./quiz_example.json")
 		w.Write(file)
@@ -28,6 +25,8 @@ func TestQuiz(t *testing.T) {
 
 	command := NewQuizCommand(base).(*quizCommand)
 	command.apiURL = ts.URL
+	command.rand.Seed(2) // we want always the same random in our test
+
 	commands := bot.Commands{}
 	commands.AddCommand(command)
 

command/pool/commands.go

@@ -14,7 +14,7 @@ func GetCommands(cfg *config.Pool, slackClient client.SlackClient) bot.Commands
 		return commands
 	}
 
-	p := GetNewPool(cfg)
+	p := getNewPool(cfg)
 
 	commands.AddCommand(
 		newPoolCommands(slackClient, cfg, p),

command/pool/commands_test.go

@@ -37,24 +37,22 @@ func TestPools(t *testing.T) {
 		commands := GetCommands(cfg, base)
 		assert.Equal(t, 1, len(commands.GetCommandNames()))
 
-		runCommand := func(message msg.Message) msg.Message {
+		runCommand := func(message msg.Message) {
 			actual := commands.Run(message)
 			assert.True(t, actual)
-
-			return message
 		}
 
 		// list
 		message := msg.Message{}
 		message.Text = "pool list"
 		mocks.AssertSlackMessage(slackClient, message, "*Available:*\n`server1`, `server2`\n\n*Used/Locked:*")
-		message = runCommand(message)
+		runCommand(message)
 
 		// lock
 		message = msg.Message{}
 		message.Text = "pool lock server1"
 		mocks.AssertSlackMessageRegexp(slackClient, message, "^`server1` is locked for you until")
-		message = runCommand(message)
+		runCommand(message)
 
 		// extend
 		message = msg.Message{}

command/pool/pool.go

@@ -39,8 +39,8 @@ type pool struct {
 	mu           sync.RWMutex
 }
 
-// GetNewPool create a new pool and initialize it by the local storage
-func GetNewPool(cfg *config.Pool) *pool {
+// getNewPool create a new pool and initialize it by the local storage
+func getNewPool(cfg *config.Pool) *pool {
 	var p pool
 
 	p.lockDuration = cfg.LockDuration
@@ -51,10 +51,6 @@ func GetNewPool(cfg *config.Pool) *pool {
 	}
 
 	keys, _ := storage.GetKeys(storageKey)
-	if len(keys) == 0 {
-		return &p
-	}
-
 	for _, key := range keys {
 		var lock ResourceLock
 		if err := storage.Read(storageKey, key, &lock); err != nil {

command/pool/pool_commands.go

@@ -29,9 +29,9 @@ func (c *poolCommands) IsEnabled() bool {
 	return c.config.IsEnabled()
 }
 
-// Matcher to handle commands
+// GetMatcher to handle commands
 func (c *poolCommands) GetMatcher() matcher.Matcher {
-	var resources []string
+	resources := make([]string, 0, len(c.config.Resources))
 	for _, res := range c.config.Resources {
 		resources = append(resources, res.Name)
 	}

command/pullrequest/pull_request.go

@@ -1,6 +1,7 @@
 package pullrequest
 
 import (
+	"errors"
 	"fmt"
 	"net"
 	"text/template"
@@ -13,7 +14,6 @@ import (
 	"github.com/innogames/slack-bot/v2/bot/util"
 	"github.com/innogames/slack-bot/v2/client"
 	"github.com/innogames/slack-bot/v2/command/queue"
-	"github.com/pkg/errors"
 	log "github.com/sirupsen/logrus"
 	"github.com/slack-go/slack"
 )
@@ -117,7 +117,8 @@ func (c command) watch(match matcher.Result, message msg.Message) {
 
 		// something failed while loading the PR data...retry if it was temporary, else quit watching
 		if err != nil {
-			if nerr, ok := err.(net.Error); ok && nerr.Timeout() {
+			var nerr net.Error
+			if errors.As(err, &nerr) && nerr.Timeout() {
 				time.Sleep(maxCheckInterval)
 				continue
 			}
@@ -127,7 +128,7 @@ func (c command) watch(match matcher.Result, message msg.Message) {
 				// reply error in new thread
 				c.ReplyError(
 					message,
-					errors.Wrapf(err, "Error while fetching PR data %d times in a row", currentErrorCount),
+					fmt.Errorf("error while fetching PR data %d times in a row: %w", currentErrorCount, err),
 				)
 				c.AddReaction(c.cfg.Reactions.Error, message)
 				return

command/random.go

@@ -6,11 +6,10 @@ import (
 	"text/template"
 	"time"
 
-	"github.com/innogames/slack-bot/v2/bot/util"
-
 	"github.com/innogames/slack-bot/v2/bot"
 	"github.com/innogames/slack-bot/v2/bot/matcher"
 	"github.com/innogames/slack-bot/v2/bot/msg"
+	"github.com/innogames/slack-bot/v2/bot/util"
 )
 
 // NewRandomCommand will reply a random entry

command/random_test.go

@@ -1,7 +1,6 @@
 package command
 
 import (
-	"math/rand"
 	"testing"
 
 	"github.com/innogames/slack-bot/v2/bot"
@@ -49,8 +48,6 @@ func TestRandom(t *testing.T) {
 	})
 
 	t.Run("pick random entry", func(t *testing.T) {
-		rand.Seed(1) // we want always the same random
-
 		message := msg.Message{}
 		message.Text = "random 4 5 6"
 

mocks/testing.go

@@ -1,11 +1,11 @@
 package mocks
 
 import (
+	"bytes"
 	"encoding/json"
 	"errors"
 	"fmt"
 	"regexp"
-	"strings"
 	"sync"
 	"testing"
 	"time"
@@ -160,7 +160,7 @@ func AssertContainsSlackBlocks(t *testing.T, slackClient *SlackClient, message m
 		expectedJSONBlock, err := json.Marshal(block)
 		assert.Nil(t, err)
 
-		if strings.Contains(string(givenJSON), string(expectedJSONBlock)) {
+		if bytes.Contains(givenJSON, expectedJSONBlock) {
 			// all good!
 			return true
 		}