Fix validation issues and ignore some of them

Author: Matrix278

.golangci.yml

@@ -127,6 +127,15 @@ linters:
     - lll
     - depguard
     - revive
+    - wrapcheck
+    - tagliatelle
+    - exhaustruct
+    - testpackage
+    - mnd
+    - gochecknoinits
+    - gochecknoglobals
+    - forcetypeassert
+    - ireturn
 
 issues:
   max-same-issues: 0

controller/status_errors.go

@@ -1,6 +1,7 @@
 package controller
 
 import (
+	"errors"
 	"go-api-template/model"
 	"go-api-template/model/commonerrors"
 	"go-api-template/pkg/json"
@@ -105,7 +106,8 @@ func StatusForbidden(ctx *gin.Context, message string) {
 
 // handleCommonErrors handles common errors and returns appropriate HTTP status codes.
 func HandleCommonErrors(ctx *gin.Context, err error) {
-	if _, ok := err.(*commonerrors.CommonError); ok {
+	var commonErr *commonerrors.CommonError
+	if errors.As(err, &commonErr) {
 		StatusUnprocessableEntity(ctx, err)
 
 		return

controller/user_test.go

@@ -43,6 +43,7 @@ func (suite *UserTestSuite) TearDownTest() {
 }
 
 func Test_User_TestSuite(t *testing.T) {
+	t.Parallel() // Enable parallel execution
 	suite.Run(t, &UserTestSuite{})
 }
 
@@ -57,11 +58,11 @@ func (suite *UserTestSuite) Test_UserByID_ReturnsBadRequest_InCaseOfUserIDIsNotV
 	suite.controller.UserByID(suite.ctx)
 
 	// Assert
-	suite.Equal(http.StatusBadRequest, suite.responseRecorder.Code)
+	suite.Require().Equal(http.StatusBadRequest, suite.responseRecorder.Code)
 
 	var actualResponse model.BadRequestResponse
 	err := json.NewDecoder(suite.responseRecorder.Body).Decode(&actualResponse)
-	suite.NoError(err)
+	suite.Require().NoError(err)
 	suite.Equal(commonerrors.ErrInvalidUserID.Error(), actualResponse.Message)
 }
 
@@ -79,11 +80,11 @@ func (suite *UserTestSuite) Test_UserByID_ReturnsUnprocessableEntity_InCaseOfUse
 	suite.controller.UserByID(suite.ctx)
 
 	// Assert
-	suite.Equal(http.StatusUnprocessableEntity, suite.responseRecorder.Code)
+	suite.Require().Equal(http.StatusUnprocessableEntity, suite.responseRecorder.Code)
 
 	var actualResponse model.UnprocessableEntityResponse
 	err := json.NewDecoder(suite.responseRecorder.Body).Decode(&actualResponse)
-	suite.NoError(err)
+	suite.Require().NoError(err)
 	suite.Equal(commonerrors.ErrUserNotFound.Error(), actualResponse.Message)
 }
 
@@ -107,10 +108,10 @@ func (suite *UserTestSuite) Test_UserByID_ReturnsResponse_InCaseOfSuccess() {
 	suite.controller.UserByID(suite.ctx)
 
 	// Assert
-	suite.Equal(http.StatusOK, suite.responseRecorder.Code)
+	suite.Require().Equal(http.StatusOK, suite.responseRecorder.Code)
 
 	var actualResponse model.UserByIDResponse
 	err := json.NewDecoder(suite.responseRecorder.Body).Decode(&actualResponse)
-	suite.NoError(err)
+	suite.Require().NoError(err)
 	suite.Equal(expectedResponse, &actualResponse)
 }

middleware/router.go

@@ -1,9 +1,9 @@
 package middleware
 
 import (
-	"errors"
 	"go-api-template/configuration"
 	"go-api-template/controller"
+	"go-api-template/model/commonerrors"
 	"go-api-template/pkg/logger"
 
 	"github.com/gin-gonic/gin"
@@ -37,7 +37,7 @@ func authorizationHeaderRequired() gin.HandlerFunc {
 	return func(ctx *gin.Context) {
 		token := ctx.GetHeader("Authorization")
 		if token == "" {
-			controller.StatusUnauthorized(ctx, errors.New("authorization header required"))
+			controller.StatusUnauthorized(ctx, commonerrors.ErrAuthorizationHeaderRequired)
 			ctx.Abort()
 
 			return

model/commonerrors/errors.go

@@ -10,9 +10,12 @@ func (e *CommonError) Error() string {
 	return e.Err.Error()
 }
 
+//nolint: err113
 var (
-	ErrUserNotFound  = &CommonError{Err: errors.New("user not found")}
-	ErrInvalidUserID = &CommonError{Err: errors.New("invalid user ID")}
+	ErrFailed                      = &CommonError{Err: errors.New("failed")}
+	ErrUserNotFound                = &CommonError{Err: errors.New("user not found")}
+	ErrInvalidUserID               = &CommonError{Err: errors.New("invalid user ID")}
+	ErrAuthorizationHeaderRequired = &CommonError{Err: errors.New("authorization header required")}
 )
 
 // Add other common errors here

pkg/random/string.go

@@ -8,13 +8,13 @@ import (
 	uuid "github.com/nu7hatch/gouuid"
 )
 
-func String(n int) string {
-	bytes := make([]byte, n)
+func String(stringLength int) string {
+	bytes := make([]byte, stringLength)
 	if _, err := rand.Read(bytes); err != nil {
 		return ""
 	}
 
-	return hex.EncodeToString(bytes)[:n]
+	return hex.EncodeToString(bytes)[:stringLength]
 }
 
 func UUID4() strfmt.UUID4 {

repository/connection.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"go-api-template/configuration"
 	"go-api-template/pkg/logger"
+	"net"
 
 	"github.com/jmoiron/sqlx"
 	_ "github.com/lib/pq" // driver for PostgreSQL
@@ -14,28 +15,28 @@ type Connection struct {
 }
 
 func NewConnection(cfg *configuration.Env) *Connection {
-	psqlURL := fmt.Sprintf("postgres://%s:%s@%s:%s/%s?sslmode=%s",
+	hostPort := net.JoinHostPort(cfg.PostgresHost, cfg.PostgresPort)
+	psqlURL := fmt.Sprintf("postgres://%s:%s@%s/%s?sslmode=%s",
 		cfg.PostgresUser,
 		cfg.PostgresPassword,
-		cfg.PostgresHost,
-		cfg.PostgresPort,
+		hostPort,
 		cfg.PostgresDB,
 		cfg.PostgresSSLMode,
 	)
 
-	db, err := sqlx.Open("postgres", psqlURL)
+	database, err := sqlx.Open("postgres", psqlURL)
 	if err != nil {
 		logger.Fatalf("connecting to database failed. %v", err)
 	}
 
-	if err = db.Ping(); err != nil {
+	if err = database.Ping(); err != nil {
 		logger.Fatalf("connecting to database failed. %v", err)
 	}
 
 	logger.Infof("database connection established")
 
 	return &Connection{
-		db: db,
+		db: database,
 	}
 }
 

repository/user_test.go

@@ -2,7 +2,6 @@ package repository
 
 import (
 	"database/sql"
-	"errors"
 	"go-api-template/model/commonerrors"
 	"go-api-template/pkg/random"
 	"go-api-template/repository/model"
@@ -35,26 +34,29 @@ func (suite *UserTestSuite) SetupTest() {
 	suite.db = sqlx.NewDb(db, "sqlmock")
 	suite.repository = NewUser(suite.db)
 	suite.userID = random.UUID4()
-	suite.failedError = errors.New("failed")
+	suite.failedError = commonerrors.ErrFailed
 }
 
 func (suite *UserTestSuite) TearDownTest() {
-	suite.db.Close()
+	if err := suite.db.Close(); err != nil {
+		suite.T().Errorf("closing database connection failed. %v", err)
+	}
 }
 
 func Test_User_TestSuite(t *testing.T) {
+	t.Parallel() // Enable parallel execution
 	suite.Run(t, &UserTestSuite{})
 }
 
 func (suite *UserTestSuite) Test_Begin_ReturnsError_InCaseOfBeginFailed() {
 	// Arrange
-	suite.dbMock.ExpectBegin().WillReturnError(errors.New("failed"))
+	suite.dbMock.ExpectBegin().WillReturnError(suite.failedError)
 
 	// Act
 	_, err := suite.repository.Begin()
 
 	// Assert
-	suite.Error(err)
+	suite.Require().Error(err)
 }
 
 func (suite *UserTestSuite) Test_Begin_ReturnsTransaction_InCaseOfSuccess() {
@@ -65,7 +67,7 @@ func (suite *UserTestSuite) Test_Begin_ReturnsTransaction_InCaseOfSuccess() {
 	tx, err := suite.repository.Begin()
 
 	// Assert
-	suite.NoError(err)
+	suite.Require().NoError(err)
 	suite.NotNil(tx)
 }
 
@@ -75,13 +77,13 @@ func (suite *UserTestSuite) Test_SelectUserByFilter_ReturnsError_InCaseOfSelectF
 		ID: &suite.userID,
 	}
 
-	suite.dbMock.ExpectQuery("SELECT").WillReturnError(errors.New("failed"))
+	suite.dbMock.ExpectQuery("SELECT").WillReturnError(suite.failedError)
 
 	// Act
 	_, err := suite.repository.SelectUserByFilter(usersFilter)
 
 	// Assert
-	suite.Error(err)
+	suite.Require().Error(err)
 }
 
 func (suite *UserTestSuite) Test_SelectUserByFilter_ReturnsError_InCaseOfUserNotFound() {
@@ -96,7 +98,7 @@ func (suite *UserTestSuite) Test_SelectUserByFilter_ReturnsError_InCaseOfUserNot
 	_, err := suite.repository.SelectUserByFilter(usersFilter)
 
 	// Assert
-	suite.Error(err)
+	suite.Require().Error(err)
 	suite.Equal(commonerrors.ErrUserNotFound, err)
 }
 
@@ -114,7 +116,7 @@ func (suite *UserTestSuite) Test_SelectUserByFilter_ReturnsUser_InCaseOfSuccess(
 	user, err := suite.repository.SelectUserByFilter(usersFilter)
 
 	// Assert
-	suite.NoError(err)
+	suite.Require().NoError(err)
 	suite.NotNil(user)
 	suite.Equal(suite.userID, user.ID)
 }

service/user_test.go

@@ -1,7 +1,6 @@
 package service
 
 import (
-	"errors"
 	"go-api-template/model/commonerrors"
 	"go-api-template/pkg/random"
 	"go-api-template/repository"
@@ -32,14 +31,15 @@ func (suite *UserTestSuite) SetupTest() {
 	suite.userRepositoryMock = &repository.UserMock{}
 	suite.service = NewUser(suite.userRepositoryMock)
 	suite.userID = random.UUID4()
-	suite.failedError = errors.New("failed")
+	suite.failedError = commonerrors.ErrFailed
 }
 
 func (suite *UserTestSuite) TearDownTest() {
 	suite.userRepositoryMock.AssertExpectations(suite.T())
 }
 
 func Test_User_TestSuite(t *testing.T) {
+	t.Parallel() // Enable parallel execution
 	suite.Run(t, &UserTestSuite{})
 }
 
@@ -58,7 +58,7 @@ func (suite *UserTestSuite) Test_UserByID_ReturnsError_InCaseOfSelectUserByFilte
 	response, err := suite.service.UserByID(suite.ctx, suite.userID)
 
 	// Assert
-	suite.Nil(response)
+	suite.Require().Nil(response)
 
 	if suite.Error(err) {
 		suite.Equal(suite.failedError, err)
@@ -80,7 +80,7 @@ func (suite *UserTestSuite) Test_UserByID_ReturnsError_InCaseOfUserNotFound() {
 	response, err := suite.service.UserByID(suite.ctx, suite.userID)
 
 	// Assert
-	suite.Nil(response)
+	suite.Require().Nil(response)
 
 	if suite.Error(err) {
 		suite.Equal(commonerrors.ErrUserNotFound, err)
@@ -106,7 +106,7 @@ func (suite *UserTestSuite) Test_UserByID_ReturnsUser_InCaseOfSuccess() {
 	response, err := suite.service.UserByID(suite.ctx, suite.userID)
 
 	// Assert
-	suite.NoError(err)
+	suite.Require().NoError(err)
 
 	if suite.NotNil(response) {
 		suite.Equal(user.ID, response.User.ID)