Merge pull request #3019 from efficacy38/chore/clean-codes

chore: enable linter(golangci-lint)

Author: fiftin

.golangci.yml

@@ -0,0 +1,20 @@
+version: "2"
+
+run:
+  timeout: "240s"
+  # TODO: remove following line to make golangci return non-zero as lint were not passed
+  issues-exit-code: 0
+
+linters:
+  default: standard
+  disable:
+    - unused
+
+formatters:
+  enable:
+    - gofmt
+  settings:
+    gofmt:
+      rewrite-rules:
+        - pattern: 'interface{}'
+          replacement: 'any'

Taskfile.yml

@@ -110,18 +110,17 @@ tasks:
   lint:
     cmds:
       - task: lint:fe
-#      - task: lint:be
+      - task: lint:be
 
   lint:fe:
     dir: web
     cmds:
       - npm run lint
 
-#  lint:be:
-#    cmds:
-#      - golangci-lint run --disable goconst --timeout 240s ./...
-#      - go vet ./...
-#      - swagger validate ./api-docs.yml
+  lint:be:
+    cmds:
+      - golangci-lint run
+      - swagger validate ./api-docs.yml
 
   test:
     cmds:

api/apps.go

@@ -14,8 +14,8 @@ import (
 	"strings"
 )
 
-func structToFlatMap(obj interface{}) map[string]interface{} {
-	result := make(map[string]interface{})
+func structToFlatMap(obj any) map[string]any {
+	result := make(map[string]any)
 	val := reflect.ValueOf(obj)
 	typ := reflect.TypeOf(obj)
 
@@ -137,7 +137,7 @@ func deleteApp(w http.ResponseWriter, r *http.Request) {
 	w.WriteHeader(http.StatusNoContent)
 }
 
-func setAppOption(store db.Store, appID string, field string, val interface{}) error {
+func setAppOption(store db.Store, appID string, field string, val any) error {
 	key := "apps." + appID + "." + field
 
 	if val == nil {

api/auth.go

@@ -22,7 +22,7 @@ func getSession(r *http.Request) (*db.Session, bool) {
 		return nil, false
 	}
 
-	value := make(map[string]interface{})
+	value := make(map[string]any)
 	if err = util.Cookie.Decode("semaphore", cookie.Value, &value); err != nil {
 		//w.WriteHeader(http.StatusUnauthorized)
 		return nil, false

api/helpers/context.go

@@ -3,8 +3,8 @@ package helpers
 import (
 	"net/http"
 
-	"github.com/semaphoreui/semaphore/db"
 	"github.com/gorilla/context"
+	"github.com/semaphoreui/semaphore/db"
 )
 
 func UserFromContext(r *http.Request) *db.User {

api/helpers/helpers.go

@@ -71,10 +71,10 @@ func GetIntParam(name string, w http.ResponseWriter, r *http.Request) (int, erro
 }
 
 // H just a string-to-anything map
-type H map[string]interface{}
+type H map[string]any
 
 // Bind decodes json into object
-func Bind(w http.ResponseWriter, r *http.Request, out interface{}) bool {
+func Bind(w http.ResponseWriter, r *http.Request, out any) bool {
 	err := json.NewDecoder(r.Body).Decode(out)
 	if err != nil {
 		w.WriteHeader(http.StatusBadRequest)
@@ -84,7 +84,7 @@ func Bind(w http.ResponseWriter, r *http.Request, out interface{}) bool {
 }
 
 // WriteJSON writes object as JSON
-func WriteJSON(w http.ResponseWriter, code int, out interface{}) {
+func WriteJSON(w http.ResponseWriter, code int, out any) {
 	w.Header().Set("content-type", "application/json")
 	w.WriteHeader(code)
 

api/integration.go

@@ -217,7 +217,7 @@ func Match(matcher db.IntegrationMatcher, header http.Header, bodyBytes []byte)
 	return false
 }
 
-func MatchCompare(value interface{}, method db.IntegrationMatchMethodType, expected string) bool {
+func MatchCompare(value any, method db.IntegrationMatchMethodType, expected string) bool {
 
 	if intValue, ok := conv.ConvertFloatToIntIfPossible(value); ok {
 		value = intValue

api/login.go

@@ -9,7 +9,6 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"github.com/semaphoreui/semaphore/pkg/tz"
 	"net/http"
 	"net/url"
 	"os"
@@ -18,6 +17,8 @@ import (
 	"text/template"
 	"time"
 
+	"github.com/semaphoreui/semaphore/pkg/tz"
+
 	"github.com/coreos/go-oidc/v3/oidc"
 	"github.com/go-ldap/ldap/v3"
 	"github.com/gorilla/mux"
@@ -60,7 +61,7 @@ func tryFindLDAPUser(username, password string) (*db.User, error) {
 	if err != nil {
 		return nil, err
 	}
-	defer l.Close()
+	defer l.Close() //nolint:errcheck
 
 	// First bind with a read only user
 	if err = l.Bind(util.Config.LdapBindDN, util.Config.LdapBindPassword); err != nil {
@@ -137,7 +138,6 @@ func tryFindLDAPUser(username, password string) (*db.User, error) {
 	}
 
 	err = db.ValidateUser(ldapUser)
-
 	if err != nil {
 		jsonBytes, _ := json.Marshal(ldapUser)
 		log.Error("LDAP returned incorrect user data: " + string(jsonBytes))
@@ -171,14 +171,13 @@ func createSession(w http.ResponseWriter, r *http.Request, user db.User) {
 		VerificationMethod: verificationMethod,
 		Verified:           verified,
 	})
-
 	if err != nil {
 		log.Error(err)
 		helpers.WriteErrorStatus(w, "Failed to create session", http.StatusInternalServerError)
 		return
 	}
 
-	encoded, err := util.Cookie.Encode("semaphore", map[string]interface{}{
+	encoded, err := util.Cookie.Encode("semaphore", map[string]any{
 		"user":    user.ID,
 		"session": newSession.ID,
 	})
@@ -196,7 +195,6 @@ func createSession(w http.ResponseWriter, r *http.Request, user db.User) {
 
 func loginByPassword(store db.Store, login string, password string) (user db.User, err error) {
 	user, err = store.GetUserByLoginOrEmail(login, login)
-
 	if err != nil {
 		return
 	}
@@ -207,7 +205,6 @@ func loginByPassword(store db.Store, login string, password string) (user db.Use
 	}
 
 	err = bcrypt.CompareHashAndPassword([]byte(user.Password), []byte(password))
-
 	if err != nil {
 		err = db.ErrNotFound
 		return
@@ -364,7 +361,6 @@ func login(w http.ResponseWriter, r *http.Request) {
 // - 204 No Content: Logout successful.
 // - 500 Internal Server Error: An error occurred while expiring the session.
 func logout(w http.ResponseWriter, r *http.Request) {
-
 	if session, ok := getSession(r); ok {
 		err := helpers.Store(r).ExpireSession(session.UserID, session.ID)
 		if err != nil {
@@ -512,8 +508,7 @@ type claimResult struct {
 	email    string
 }
 
-func parseClaim(str string, claims map[string]interface{}) (string, bool) {
-
+func parseClaim(str string, claims map[string]any) (string, bool) {
 	for _, s := range strings.Split(str, "|") {
 		s = strings.TrimSpace(s)
 
@@ -523,7 +518,6 @@ func parseClaim(str string, claims map[string]interface{}) (string, bool) {
 
 		if strings.Contains(s, "{{") {
 			tpl, err := template.New("").Parse(s)
-
 			if err != nil {
 				return "", false
 			}
@@ -548,17 +542,17 @@ func parseClaim(str string, claims map[string]interface{}) (string, bool) {
 	return "", false
 }
 
-func prepareClaims(claims map[string]interface{}) {
+func prepareClaims(claims map[string]any) {
 	for k, v := range claims {
-		switch v.(type) {
+		switch v := v.(type) {
 		case float64:
-			f := v.(float64)
+			f := v
 			i := int64(f)
 			if float64(i) == f {
 				claims[k] = i
 			}
 		case float32:
-			f := v.(float32)
+			f := v
 			i := int64(f)
 			if float32(i) == f {
 				claims[k] = i
@@ -567,8 +561,7 @@ func prepareClaims(claims map[string]interface{}) {
 	}
 }
 
-func parseClaims(claims map[string]interface{}, provider util.ClaimsProvider) (res claimResult, err error) {
-
+func parseClaims(claims map[string]any, provider util.ClaimsProvider) (res claimResult, err error) {
 	var ok bool
 	res.email, ok = parseClaim(provider.GetEmailClaim(), claims)
 
@@ -591,7 +584,7 @@ func parseClaims(claims map[string]interface{}, provider util.ClaimsProvider) (r
 }
 
 func claimOidcUserInfo(userInfo *oidc.UserInfo, provider util.OidcProvider) (res claimResult, err error) {
-	claims := make(map[string]interface{})
+	claims := make(map[string]any)
 	if err = userInfo.Claims(&claims); err != nil {
 		return
 	}
@@ -602,7 +595,7 @@ func claimOidcUserInfo(userInfo *oidc.UserInfo, provider util.OidcProvider) (res
 }
 
 func claimOidcToken(idToken *oidc.IDToken, provider util.OidcProvider) (res claimResult, err error) {
-	claims := make(map[string]interface{})
+	claims := make(map[string]any)
 	if err = idToken.Claims(&claims); err != nil {
 		return
 	}
@@ -622,7 +615,6 @@ func getRandomProfileName() string {
 
 func getSecretFromFile(source string) (string, error) {
 	content, err := os.ReadFile(source)
-
 	if err != nil {
 		return "", err
 	}
@@ -691,7 +683,6 @@ func oidcRedirect(w http.ResponseWriter, r *http.Request) {
 		userInfo, err = _oidc.UserInfo(ctx, oauth2.StaticTokenSource(oauth2Token))
 
 		if err == nil {
-
 			if userInfo.Email == "" {
 				claims, err = claimOidcUserInfo(userInfo, provider)
 			} else {

api/login_test.go

@@ -5,7 +5,7 @@ import (
 )
 
 func TestParseClaim(t *testing.T) {
-	claims := map[string]interface{}{
+	claims := map[string]any{
 		"username": "fiftin",
 		"email":    "",
 		"id":       1234567,
@@ -23,7 +23,7 @@ func TestParseClaim(t *testing.T) {
 }
 
 func TestParseClaim2(t *testing.T) {
-	claims := map[string]interface{}{
+	claims := map[string]any{
 		"username": "fiftin",
 		"email":    "",
 		"id":       1234567,
@@ -41,7 +41,7 @@ func TestParseClaim2(t *testing.T) {
 }
 
 func TestParseClaim3(t *testing.T) {
-	claims := map[string]interface{}{
+	claims := map[string]any{
 		"username": "fiftin",
 		"email":    "",
 		"id":       1234567,
@@ -55,7 +55,7 @@ func TestParseClaim3(t *testing.T) {
 }
 
 func TestParseClaim4(t *testing.T) {
-	claims := map[string]interface{}{
+	claims := map[string]any{
 		"username": "fiftin",
 		"email":    "",
 		"id":       1234567,
@@ -69,7 +69,7 @@ func TestParseClaim4(t *testing.T) {
 }
 
 func TestParseClaim5(t *testing.T) {
-	claims := map[string]interface{}{
+	claims := map[string]any{
 		"username": "fiftin",
 		"email":    "",
 		"id":       123456757343.0,

api/options.go

@@ -1,9 +1,9 @@
 package api
 
 import (
+	"github.com/gorilla/context"
 	"github.com/semaphoreui/semaphore/api/helpers"
 	"github.com/semaphoreui/semaphore/db"
-	"github.com/gorilla/context"
 	"net/http"
 )