Extend linter rules (#1300)

- dupword checks for duplicate words in the source code
- durationcheck checks for two durations multiplied together
- forbidigo forbids identifiers
- mirror reports wrong mirror patterns of bytes/strings usage
- misspell finds commonly misspelled English words in comments
- predeclared finds code that shadows one of Go's predeclared identifiers
- thelper detects Go test helpers without t.Helper() call and checks the consistency of test helpers

management/server/account.go

@@ -1574,7 +1574,7 @@ func (am *DefaultAccountManager) GetAllConnectedPeers() (map[string]struct{}, er
 
 func isDomainValid(domain string) bool {
 	re := regexp.MustCompile(`^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$`)
-	return re.Match([]byte(domain))
+	return re.MatchString(domain)
 }
 
 // GetDNSDomain returns the configured dnsDomain

management/server/account_test.go

@@ -25,6 +25,7 @@ import (
 )
 
 func verifyCanAddPeerToAccount(t *testing.T, manager AccountManager, account *Account, userID string) {
+	t.Helper()
 	peer := &Peer{
 		Key:  "BhRPtynAAYRDy08+q4HTMsos8fs4plTP4NOSh7C1ry8=",
 		Name: "test-host@netbird.io",
@@ -52,6 +53,7 @@ func verifyCanAddPeerToAccount(t *testing.T, manager AccountManager, account *Ac
 }
 
 func verifyNewAccountHasDefaultFields(t *testing.T, account *Account, createdBy string, domain string, expectedUsers []string) {
+	t.Helper()
 	if len(account.Peers) != 0 {
 		t.Errorf("expected account to have len(Peers) = %v, got %v", 0, len(account.Peers))
 	}
@@ -1131,6 +1133,7 @@ func TestAccountManager_DeletePeer(t *testing.T) {
 }
 
 func getEvent(t *testing.T, accountID string, manager AccountManager, eventType activity.Activity) *activity.Event {
+	t.Helper()
 	for {
 		select {
 		case <-time.After(time.Second):
@@ -2038,6 +2041,7 @@ func TestAccount_UserGroupsRemoveFromPeers(t *testing.T) {
 }
 
 func createManager(t *testing.T) (*DefaultAccountManager, error) {
+	t.Helper()
 	store, err := createStore(t)
 	if err != nil {
 		return nil, err
@@ -2047,6 +2051,7 @@ func createManager(t *testing.T) (*DefaultAccountManager, error) {
 }
 
 func createStore(t *testing.T) (Store, error) {
+	t.Helper()
 	dataDir := t.TempDir()
 	store, err := NewStoreFromJson(dataDir, nil)
 	if err != nil {

management/server/dns_test.go

@@ -186,6 +186,7 @@ func TestGetNetworkMap_DNSConfigSync(t *testing.T) {
 }
 
 func createDNSManager(t *testing.T) (*DefaultAccountManager, error) {
+	t.Helper()
 	store, err := createDNSStore(t)
 	if err != nil {
 		return nil, err
@@ -195,6 +196,7 @@ func createDNSManager(t *testing.T) (*DefaultAccountManager, error) {
 }
 
 func createDNSStore(t *testing.T) (Store, error) {
+	t.Helper()
 	dataDir := t.TempDir()
 	store, err := NewStoreFromJson(dataDir, nil)
 	if err != nil {
@@ -205,6 +207,7 @@ func createDNSStore(t *testing.T) (Store, error) {
 }
 
 func initTestDNSAccount(t *testing.T, am *DefaultAccountManager) (*Account, error) {
+	t.Helper()
 	peer1 := &Peer{
 		Key:  dnsPeer1Key,
 		Name: "test-host1@netbird.io",

management/server/event_test.go

@@ -11,6 +11,7 @@ import (
 
 func generateAndStoreEvents(t *testing.T, manager *DefaultAccountManager, typ activity.Activity, initiatorID, targetID,
 	accountID string, count int) {
+	t.Helper()
 	for i := 0; i < count; i++ {
 		_, err := manager.eventStore.Save(&activity.Event{
 			Timestamp:   time.Now().UTC(),

management/server/file_store_test.go

@@ -580,6 +580,7 @@ func TestFileStore_SavePeerStatus(t *testing.T) {
 }
 
 func newStore(t *testing.T) *FileStore {
+	t.Helper()
 	store, err := NewFileStore(t.TempDir(), nil)
 	if err != nil {
 		t.Errorf("failed creating a new store")

management/server/http/groups_handler_test.go

@@ -230,7 +230,7 @@ func TestWriteGroup(t *testing.T) {
 			expectedBody:   false,
 		},
 		{
-			name:        "Write Group PUT not not change Issue",
+			name:        "Write Group PUT not change Issue",
 			requestType: http.MethodPut,
 			requestPath: "/api/groups/id-jwt-group",
 			requestBody: bytes.NewBuffer(

management/server/http/peers_handler_test.go

@@ -3,7 +3,6 @@ package http
 import (
 	"bytes"
 	"encoding/json"
-	"fmt"
 	"io"
 	"net"
 	"net/http"
@@ -232,7 +231,7 @@ func TestGetPeers(t *testing.T) {
 				}
 			}
 
-			fmt.Println(got)
+			t.Log(got)
 
 			assert.Equal(t, got.Name, tc.expectedPeer.Name)
 			assert.Equal(t, got.Version, tc.expectedPeer.Meta.WtVersion)

management/server/http/setupkeys_handler_test.go

@@ -220,6 +220,7 @@ func TestSetupKeysHandlers(t *testing.T) {
 }
 
 func assertKeys(t *testing.T, got *api.SetupKey, expected *api.SetupKey) {
+	t.Helper()
 	// this comparison is done manually because when converting to JSON dates formatted differently
 	// assert.Equal(t, got.UpdatedAt, tc.expectedSetupKey.UpdatedAt) //doesn't work
 	assert.WithinDurationf(t, got.UpdatedAt, expected.UpdatedAt, 0, "")

management/server/idp/auth0_test.go

@@ -65,6 +65,7 @@ func (mc *mockAuth0Credentials) Authenticate() (JWTToken, error) {
 }
 
 func newTestJWT(t *testing.T, expInt int) string {
+	t.Helper()
 	now := time.Now()
 	token := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
 		"iat": now.Unix(),

management/server/idp/okta.go

@@ -256,7 +256,6 @@ func (om *OktaManager) InviteUserByID(_ string) error {
 func (om *OktaManager) DeleteUser(userID string) error {
 	resp, err := om.client.User.DeactivateOrDeleteUser(context.Background(), userID, nil)
 	if err != nil {
-		fmt.Println(err.Error())
 		return err
 	}
 

management/server/jwtclaims/extractor_test.go

@@ -11,6 +11,7 @@ import (
 )
 
 func newTestRequestWithJWT(t *testing.T, claims AuthorizationClaims, audience string) *http.Request {
+	t.Helper()
 	const layout = "2006-01-02T15:04:05.999Z"
 
 	claimMaps := jwt.MapClaims{}
@@ -143,6 +144,7 @@ func TestExtractClaimsFromRequestContext(t *testing.T) {
 }
 
 func TestExtractClaimsSetOptions(t *testing.T) {
+	t.Helper()
 	type test struct {
 		name      string
 		extractor *ClaimsExtractor
@@ -153,6 +155,7 @@ func TestExtractClaimsSetOptions(t *testing.T) {
 		name:      "No custom options",
 		extractor: NewClaimsExtractor(),
 		check: func(t *testing.T, c test) {
+			t.Helper()
 			if c.extractor.authAudience != "" {
 				t.Error("audience should be empty")
 				return
@@ -172,6 +175,7 @@ func TestExtractClaimsSetOptions(t *testing.T) {
 		name:      "Custom audience",
 		extractor: NewClaimsExtractor(WithAudience("https://login/")),
 		check: func(t *testing.T, c test) {
+			t.Helper()
 			if c.extractor.authAudience != "https://login/" {
 				t.Errorf("audience expected %s, got %s", "https://login/", c.extractor.authAudience)
 				return
@@ -183,6 +187,7 @@ func TestExtractClaimsSetOptions(t *testing.T) {
 		name:      "Custom user id claim",
 		extractor: NewClaimsExtractor(WithUserIDClaim("customUserId")),
 		check: func(t *testing.T, c test) {
+			t.Helper()
 			if c.extractor.userIDClaim != "customUserId" {
 				t.Errorf("user id claim expected %s, got %s", "customUserId", c.extractor.userIDClaim)
 				return
@@ -199,6 +204,7 @@ func TestExtractClaimsSetOptions(t *testing.T) {
 				}
 			})),
 		check: func(t *testing.T, c test) {
+			t.Helper()
 			claims := c.extractor.FromRequestContext(&http.Request{})
 			if claims.UserId != "testCustomRequest" {
 				t.Errorf("user id claim expected %s, got %s", "testCustomRequest", claims.UserId)

management/server/management_proto_test.go

@@ -400,6 +400,7 @@ func TestServer_GetDeviceAuthorizationFlow(t *testing.T) {
 }
 
 func startManagement(t *testing.T, config *Config) (*grpc.Server, string, error) {
+	t.Helper()
 	lis, err := net.Listen("tcp", "localhost:0")
 	if err != nil {
 		return nil, "", err

management/server/mock_server/account_mock.go

@@ -355,7 +355,7 @@ func (am *MockAccountManager) UpdatePeerSSHKey(peerID string, sshKey string) err
 	if am.UpdatePeerSSHKeyFunc != nil {
 		return am.UpdatePeerSSHKeyFunc(peerID, sshKey)
 	}
-	return status.Errorf(codes.Unimplemented, "method UpdatePeerSSHKey is is not implemented")
+	return status.Errorf(codes.Unimplemented, "method UpdatePeerSSHKey is not implemented")
 }
 
 // UpdatePeer mocks UpdatePeerFunc function of the account manager
@@ -363,7 +363,7 @@ func (am *MockAccountManager) UpdatePeer(accountID, userID string, peer *server.
 	if am.UpdatePeerFunc != nil {
 		return am.UpdatePeerFunc(accountID, userID, peer)
 	}
-	return nil, status.Errorf(codes.Unimplemented, "method UpdatePeerFunc is is not implemented")
+	return nil, status.Errorf(codes.Unimplemented, "method UpdatePeerFunc is not implemented")
 }
 
 // CreateRoute mock implementation of CreateRoute from server.AccountManager interface

management/server/nameserver_test.go

@@ -741,6 +741,7 @@ func TestGetNameServerGroup(t *testing.T) {
 }
 
 func createNSManager(t *testing.T) (*DefaultAccountManager, error) {
+	t.Helper()
 	store, err := createNSStore(t)
 	if err != nil {
 		return nil, err
@@ -750,6 +751,7 @@ func createNSManager(t *testing.T) (*DefaultAccountManager, error) {
 }
 
 func createNSStore(t *testing.T) (Store, error) {
+	t.Helper()
 	dataDir := t.TempDir()
 	store, err := NewStoreFromJson(dataDir, nil)
 	if err != nil {
@@ -760,6 +762,7 @@ func createNSStore(t *testing.T) (Store, error) {
 }
 
 func initTestNSAccount(t *testing.T, am *DefaultAccountManager) (*Account, error) {
+	t.Helper()
 	peer1 := &Peer{
 		Key:  nsGroupPeer1Key,
 		Name: "test-host1@netbird.io",

management/server/route_test.go

@@ -1007,6 +1007,7 @@ func TestGetNetworkMap_RouteSync(t *testing.T) {
 }
 
 func createRouterManager(t *testing.T) (*DefaultAccountManager, error) {
+	t.Helper()
 	store, err := createRouterStore(t)
 	if err != nil {
 		return nil, err
@@ -1016,6 +1017,7 @@ func createRouterManager(t *testing.T) (*DefaultAccountManager, error) {
 }
 
 func createRouterStore(t *testing.T) (Store, error) {
+	t.Helper()
 	dataDir := t.TempDir()
 	store, err := NewStoreFromJson(dataDir, nil)
 	if err != nil {

management/server/setupkey_test.go

@@ -237,6 +237,7 @@ func TestSetupKey_IsValid(t *testing.T) {
 func assertKey(t *testing.T, key *SetupKey, expectedName string, expectedRevoke bool, expectedType string,
 	expectedUsedTimes int, expectedCreatedAt time.Time, expectedExpiresAt time.Time, expectedID string,
 	expectedUpdatedAt time.Time, expectedAutoGroups []string) {
+	t.Helper()
 	if key.Name != expectedName {
 		t.Errorf("expected setup key to have Name %v, got %v", expectedName, key.Name)
 	}

management/server/store_test.go

@@ -14,11 +14,13 @@ type benchCase struct {
 }
 
 var newFs = func(b *testing.B) Store {
+	b.Helper()
 	store, _ := NewFileStore(b.TempDir(), nil)
 	return store
 }
 
 var newSqlite = func(b *testing.B) Store {
+	b.Helper()
 	store, _ := NewSqliteStore(b.TempDir(), nil)
 	return store
 }

management/server/telemetry/grpc_metrics.go

@@ -116,6 +116,6 @@ func (grpcMetrics *GRPCMetrics) RegisterConnectedStreams(producer func() int64)
 }
 
 // UpdateChannelQueueLength update the histogram that keep distribution of the update messages channel queue
-func (metrics *GRPCMetrics) UpdateChannelQueueLength(len int) {
-	metrics.channelQueueLength.Record(metrics.ctx, int64(len))
+func (metrics *GRPCMetrics) UpdateChannelQueueLength(length int) {
+	metrics.channelQueueLength.Record(metrics.ctx, int64(length))
 }

management/server/turncredentials_test.go

@@ -4,9 +4,10 @@ import (
 	"crypto/hmac"
 	"crypto/sha1"
 	"encoding/base64"
-	"github.com/netbirdio/netbird/util"
 	"testing"
 	"time"
+
+	"github.com/netbirdio/netbird/util"
 )
 
 var TurnTestHost = &Host{
@@ -36,7 +37,7 @@ func TestTimeBasedAuthSecretsManager_GenerateCredentials(t *testing.T) {
 		t.Errorf("expected generated TURN password not to be empty, got empty")
 	}
 
-	validateMAC(credentials.Username, credentials.Password, []byte(secret), t)
+	validateMAC(t, credentials.Username, credentials.Password, []byte(secret))
 
 }
 
@@ -112,7 +113,8 @@ func TestTimeBasedAuthSecretsManager_CancelRefresh(t *testing.T) {
 	}
 }
 
-func validateMAC(username string, actualMAC string, key []byte, t *testing.T) {
+func validateMAC(t *testing.T, username string, actualMAC string, key []byte) {
+	t.Helper()
 	mac := hmac.New(sha1.New, key)
 
 	_, err := mac.Write([]byte(username))