ci: configure lint and CI pipeline

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+env:
+  GO_VERSION: 1.24.10
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: Download Go modules
+        run: go mod tidy && go mod download
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Run tests
+        run: go test -v ./...
+
+      - name: Install golangci-lint
+        run: |
+          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v2.0.0
+
+      - name: Run golangci-lint
+        run: golangci-lint run ./...

.gitignore

@@ -20,9 +20,6 @@ go.work
 go.work.sum
 
 # Dependency directories (remove the comment below if you use Go modules)
-/go.sum
-/go.mod
-
 # IDE/editor specific files
 .vscode/
 .idea/

.golangci.yml

@@ -0,0 +1,80 @@
+version: 2
+
+output:
+  formats:
+    text:
+      path: stdout
+      print-linter-name: true
+      print-issued-lines: true
+linters:
+  default: all
+  disable:
+    - depguard
+    - err113
+    - exhaustive
+    - exhaustruct
+    - godot
+    - godox
+    - gomoddirectives
+    - ireturn
+    - lll
+    - musttag
+    - nlreturn
+    - nonamedreturns
+    - revive
+    - tagalign
+    - tagliatelle
+    - varnamelen
+    - wsl
+  settings:
+    gocritic:
+      enabled-tags:
+        - diagnostic
+        - experimental
+        - opinionated
+        - performance
+        - style
+    govet:
+      enable-all: true
+    misspell:
+      locale: US
+    staticcheck:
+      checks:
+        - all
+  exclusions:
+    generated: lax
+    rules:
+      - linters:
+          - errcheck
+          - gosec
+          - unparam
+        path: _test\.go
+      - linters:
+          - errcheck
+        path: _test\.go
+        text: Error return value of .((t|b|tb|f|g|gb)\.(Fatal|Fatalf|Skip|Skipf)|.*\.Errorf?|.*\.Fail(Now)?). is not checked
+      - linters:
+          - all
+        path: mocks/
+      - linters:
+          - all
+        path: docs/
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

Makefile

@@ -19,4 +19,7 @@ test:
 	@go test -timeout 30s -run ./...
 
 coverage:
-	@go test ./... -coverprofile=coverage.out
+	@go test ./... -coverprofile=coverage.out
+
+lint:
+	@golangci-lint run ./...

domain/entities/helpers/decode_short_url.go

@@ -13,7 +13,7 @@ func Base62Decode(shortURL string, salt string) int64 {
 		if index == -1 {
 			return 0
 		}
-		decoded = decoded*62 + int64(index)
+		decoded = decoded*base62 + int64(index)
 	}
 	return decoded
 }

domain/entities/helpers/encode_url.go

@@ -5,7 +5,11 @@ import (
 	"strings"
 )
 
-const base62Alphabet = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+const (
+	base62Alphabet = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+	base62         = 62
+	minEncodedLen  = 4
+)
 
 func Base62Encode(id int64, salt string) string {
 	alphabet := getShuffledAlphabet(salt)
@@ -16,14 +20,14 @@ func Base62Encode(id int64, salt string) string {
 		encoded = string(alphabet[0])
 	} else {
 		for num > 0 {
-			encoded = string(alphabet[num%62]) + encoded
-			num = num / 62
+			encoded = string(alphabet[num%base62]) + encoded
+			num /= base62
 		}
 	}
-	if len(encoded) < 4 {
-		encoded = strings.Repeat(string(alphabet[0]), 4-len(encoded)) + encoded
-	} else if len(encoded) > 4 {
-		encoded = encoded[:4]
+	if len(encoded) < minEncodedLen {
+		encoded = strings.Repeat(string(alphabet[0]), minEncodedLen-len(encoded)) + encoded
+	} else if len(encoded) > minEncodedLen {
+		encoded = encoded[:minEncodedLen]
 	}
 	return encoded
 }

domain/entities/helpers/encode_url_test.go

@@ -1,7 +1,9 @@
-package helpers
+package helpers_test
 
 import (
 	"testing"
+
+	"lnk/domain/entities/helpers"
 )
 
 func Test_Helper_Base62Encode(t *testing.T) {
@@ -24,7 +26,7 @@ func Test_Helper_Base62Encode(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		got := Base62Encode(test.id, salt)
+		got := helpers.Base62Encode(test.id, salt)
 		if got != test.want {
 			t.Errorf("Base62Encode(%d, %s) = %s, want %s", test.id, salt, got, test.want)
 		}

domain/entities/usecases/create_url.go

@@ -1,14 +1,15 @@
 package usecases
 
 import (
+	"context"
 	"fmt"
 
 	"lnk/domain/entities"
 	"lnk/domain/entities/helpers"
 )
 
-func (uc *UseCase) CreateShortURL(longURL string) (string, error) {
-	id, err := uc.redis.Incr(uc.ctx, uc.counterKey)
+func (uc *UseCase) CreateShortURL(ctx context.Context, longURL string) (string, error) {
+	id, err := uc.redis.Incr(ctx, uc.counterKey)
 	if err != nil {
 		return "", fmt.Errorf("failed to increment counter: %w", err)
 	}
@@ -20,9 +21,9 @@ func (uc *UseCase) CreateShortURL(longURL string) (string, error) {
 		LongURL:   longURL,
 	}
 
-	err = uc.repository.CreateURL(url)
+	err = uc.repository.CreateURL(ctx, url)
 	if err != nil {
-		return "", err
+		return "", fmt.Errorf("failed to create URL in repository: %w", err)
 	}
 
 	return shortCode, nil

domain/entities/usecases/create_url_test.go

@@ -1,8 +1,9 @@
-package usecases
+package usecases_test
 
 import (
 	"context"
 
+	"lnk/domain/entities/usecases"
 	"lnk/extensions/gocqltesting"
 	"lnk/extensions/redis/mocks"
 	"lnk/gateways/gocql/repositories"
@@ -22,24 +23,23 @@
 	ctx := context.Background()
 	logger := zap.NewNop()
 
-	repository := repositories.NewRepository(ctx, logger, session)
+	repository := repositories.NewRepository(logger, session)
 
 	mockRedis := mocks.NewMockRedis(t)
 	mockRedis.On("Incr", mock.Anything, mock.Anything).Return(int64(1), nil)
 
-	params := NewUseCaseParams{
-		Ctx:        ctx,
+	params := usecases.NewUseCaseParams{
 		Logger:     logger,
 		Repository: repository,
 		Redis:      mockRedis,
 		Salt:       "test",
 		CounterKey: "test",
 	}
 
-	useCase := NewUseCase(params)
+	useCase := usecases.NewUseCase(params)
 
 	longURL := "https://www.google.com"
-	shortCode, err := useCase.CreateShortURL(longURL)
+	shortCode, err := useCase.CreateShortURL(ctx, longURL)
 	require.NoError(t, err)
 	require.NotEmpty(t, shortCode)
 }

domain/entities/usecases/get_long_test.go

@@ -2,7 +2,7 @@
 
 import (
 	"context"
 	"lnk/domain/entities/usecases"
 	"lnk/extensions/gocqltesting"
 	"lnk/extensions/redis/mocks"
 	"lnk/gateways/gocql/repositories"
@@ -23,13 +23,12 @@
 	ctx := context.Background()
 	logger := zap.NewNop()
 
-	repository := repositories.NewRepository(ctx, logger, session)
+	repository := repositories.NewRepository(logger, session)
 
 	mockRedis := mocks.NewMockRedis(t)
 	mockRedis.On("Incr", mock.Anything, mock.Anything).Return(int64(1), nil)
 
 	params := usecases.NewUseCaseParams{
-		Ctx:        ctx,
 		Logger:     logger,
 		Repository: repository,
 		Redis:      mockRedis,
@@ -39,7 +38,7 @@
 
 	useCase := usecases.NewUseCase(params)
 
-	shortCode, err := useCase.CreateShortURL(url)
+	shortCode, err := useCase.CreateShortURL(ctx, url)
 	require.NoError(t, err)
 	require.NotEmpty(t, shortCode)
 
@@ -55,13 +54,11 @@
 	session, err := gocqltesting.NewDB(t, t.Name())
 	require.NoError(t, err)
 
-	ctx := context.Background()
 	logger := zap.NewNop()
 
-	repository := repositories.NewRepository(ctx, logger, session)
+	repository := repositories.NewRepository(logger, session)
 
 	params := usecases.NewUseCaseParams{
-		Ctx:        ctx,
 		Logger:     logger,
 		Repository: repository,
 	}

domain/entities/usecases/usecase.go

@@ -1,19 +1,16 @@
 package usecases
 
 import (
-	"context"
 	"errors"
 	"lnk/extensions/redis"
 	"lnk/gateways/gocql/repositories"
 
 	"go.uber.org/zap"
 )
 
-// ErrURLNotFound is returned when a URL is not found
 var ErrURLNotFound = errors.New("URL not found")
 
 type UseCase struct {
-	ctx        context.Context
 	logger     *zap.Logger
 	repository *repositories.Repository
 	redis      redis.Redis
@@ -22,7 +19,6 @@
 }
 
 type NewUseCaseParams struct {
-	Ctx        context.Context
 	Logger     *zap.Logger
 	Repository *repositories.Repository
 	Redis      redis.Redis
@@ -32,7 +28,6 @@
 
 func NewUseCase(params NewUseCaseParams) *UseCase {
 	return &UseCase{
-		ctx:        params.Ctx,
 		logger:     params.Logger,
 		repository: params.Repository,
 		redis:      params.Redis,

extensions/config/config.go

@@ -1,12 +1,14 @@
 package config
 
 import (
-	"lnk/extensions/logger"
-	"lnk/extensions/redis"
-	"lnk/gateways/gocql"
+	"fmt"
 
 	"github.com/joho/godotenv"
 	"github.com/kelseyhightower/envconfig"
+
+	"lnk/extensions/logger"
+	"lnk/extensions/redis"
+	"lnk/gateways/gocql"
 )
 
 type Config struct {
@@ -26,14 +28,14 @@
 func LoadConfig() (*Config, error) {
 	err := godotenv.Load()
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to load .env file: %w", err)
 	}
 	config := &Config{}
 	if err := envconfig.Process("", config); err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to process app config: %w", err)
 	}
 	if err := envconfig.Process("", &config.Gocql); err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to process gocql config: %w", err)
 	}
 	return config, nil
 }