Add better tests and improve CI pipeline

Author: TheEdgeOfRage

.github/workflows/dockerbuild.yaml

@@ -11,10 +11,36 @@ jobs:
     name: build
     runs-on: ubuntu-latest
     timeout-minutes: 10
+    services:
+      postgres:
+        image: postgres:18
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd "pg_isready -U postgres"
+          --health-interval 5s
+          --health-timeout 2s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
     steps:
       - name: Checkout
         uses: actions/checkout@v6
 
+      - name: go vet
+        run: go vet ./...
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v9
+        with:
+          version: v2.11.4
+
+      - name: Tests
+        run: |-
+          make migrate
+          make test
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v4
 

.gitignore

@@ -1,6 +1,9 @@
-# Binary
+# Build artifact
 /api
 
+# Tools
+bin/
+
 # Environment
 .env
 

.golangci.yaml

@@ -0,0 +1,45 @@
+version: "2"
+run:
+  go: "1.26"
+linters:
+  enable:
+    - forbidigo
+    - lll
+    - prealloc
+    - predeclared
+    - staticcheck
+  disable:
+    - errcheck
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - deadcode
+          - gosimple (megacheck)
+          - govet (vet, vetshadow)
+          - ineffassign
+          - lll
+          - revive
+          - staticcheck
+          - staticcheck (megacheck)
+          - structcheck
+          - unused (megacheck)
+          - varcheck
+        path: mocks/
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+  settings:
+    gci:
+      sections:
+        - standard
+        - default
+        - localmodule

Makefile

@@ -0,0 +1,19 @@
+.PHONY: all fmt lint test build
+
+bin:
+	mkdir bin
+bin/golangci-lint: bin
+	GOBIN=$(PWD)/bin go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.11.4
+
+fmt:
+	go mod tidy
+	bin/golangci-lint fmt
+
+lint: bin/golangci-lint
+	go mod tidy -diff
+	go vet ./...
+	bin/golangci-lint run
+	bin/golangci-lint fmt -d
+
+test:
+	go test -timeout=30s -race ./...

README.md

@@ -6,25 +6,25 @@ It is comprised of a cross-platform client written in Python which defers the ac
 
 ## Requirements
 
-- Go >= 1.24
+- Go >= 1.26
 - PostgreSQL
 
 ## Configuration
 
 Copy `.env-example` to `.env` and configure:
 
-| Key               | Default                 | Description                        |
-| ----------------- | ----------------------- | ---------------------------------- |
-| ENV               | production              | Set to development for debug mode  |
-| POSTGRES_USER     | pyazo                   | PostgreSQL username                |
-| POSTGRES_PASSWORD |                         | PostgreSQL password                |
-| POSTGRES_DB       | pyazo                   | Database name                      |
-| POSTGRES_HOST     | localhost               | Database host                      |
-| JWT_SECRET        |                         | JWT signing secret                 |
-| BLOCK_REGISTER    | true                    | Disable user registration          |
-| IMAGES_PATH       | /images                 | Image storage directory            |
-| CORS_ORIGIN       | https://app.pyazo.com   | Allowed CORS origin                |
-| PORT              | 8000                    | HTTP listen port                   |
+| Key               | Default               | Description                       |
+| ----------------- | --------------------- | --------------------------------- |
+| ENV               | production            | Set to development for debug mode |
+| POSTGRES_USER     | pyazo                 | PostgreSQL username               |
+| POSTGRES_PASSWORD |                       | PostgreSQL password               |
+| POSTGRES_DB       | pyazo                 | Database name                     |
+| POSTGRES_HOST     | localhost             | Database host                     |
+| JWT_SECRET        |                       | JWT signing secret                |
+| BLOCK_REGISTER    | true                  | Disable user registration         |
+| IMAGES_PATH       | /images               | Image storage directory           |
+| CORS_ORIGIN       | https://app.pyazo.com | Allowed CORS origin               |
+| PORT              | 8000                  | HTTP listen port                  |
 
 ## Development
 

cmd/main.go

@@ -2,44 +2,42 @@ package main
 
 import (
 	"context"
-	"log"
+	"log/slog"
+	"os"
 
-	"github.com/golang-migrate/migrate/v4"
-	_ "github.com/golang-migrate/migrate/v4/database/postgres"
-	"github.com/golang-migrate/migrate/v4/source/iofs"
 	"github.com/pyazo-screenshot/api/config"
 	"github.com/pyazo-screenshot/api/db"
 	pyhttp "github.com/pyazo-screenshot/api/http"
-	"github.com/pyazo-screenshot/api/migrations"
 )
 
 func main() {
-	cfg := config.Load()
-
-	runMigrations(cfg.DatabaseURL())
-
-	pool, err := db.NewPool(context.Background(), cfg.DatabaseURL())
+	cfg, err := config.Load()
 	if err != nil {
-		log.Fatal("failed to connect to database: ", err)
+		slog.Error("config", "error", err)
+		os.Exit(1)
 	}
-	defer pool.Close()
 
-	s := pyhttp.NewServer(pool, cfg)
-	log.Fatal(s.Router.Run(":" + cfg.Port))
-}
+	if cfg.Env == "production" {
+		slog.SetDefault(slog.New(slog.NewJSONHandler(os.Stdout, nil)))
+	}
 
-func runMigrations(databaseURL string) {
-	source, err := iofs.New(migrations.FS, ".")
-	if err != nil {
-		log.Fatal("failed to read migrations: ", err)
+	if err := db.RunMigrations(cfg.DatabaseURL()); err != nil {
+		slog.Error("failed to run migrations", "error", err)
+		os.Exit(1)
 	}
 
-	m, err := migrate.NewWithSourceInstance("iofs", source, databaseURL)
+	pool, err := db.NewPool(context.Background(), cfg.DatabaseURL())
 	if err != nil {
-		log.Fatal("failed to create migrate instance: ", err)
+		slog.Error("failed to connect to database", "error", err)
+		os.Exit(1)
 	}
+	defer pool.Close()
 
-	if err := m.Up(); err != nil && err != migrate.ErrNoChange {
-		log.Fatal("failed to run migrations: ", err)
+	s := pyhttp.NewServer(pool, cfg)
+	addr := ":" + cfg.Port
+	slog.Info("server starting", "addr", addr)
+	if err := s.Router.Run(addr); err != nil {
+		slog.Error("server failed", "error", err)
+		os.Exit(1)
 	}
 }

compose.yaml

@@ -2,13 +2,8 @@ services:
   db:
     image: postgres:18
     environment:
-      POSTGRES_USER: pyazo
-      POSTGRES_PASSWORD: pyazo
-      POSTGRES_DB: pyazo
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: postgres
     ports:
       - 127.0.0.1:5432:5432
-    volumes:
-      - db:/var/lib/postgresql
-
-volumes:
-  db:

config/config.go

@@ -19,29 +19,42 @@ type Config struct {
 	Port             string
 }
 
-func Load() *Config {
-	return &Config{
-		Env:              getenv("ENV", "production"),
-		PostgresUser:     getenv("POSTGRES_USER", "pyazo"),
-		PostgresPassword: getenv("POSTGRES_PASSWORD", ""),
-		PostgresDB:       getenv("POSTGRES_DB", "pyazo"),
-		PostgresHost:     getenv("POSTGRES_HOST", "localhost"),
-		JWTSecret:        getenv("JWT_SECRET", ""),
-		BlockRegister:    strings.ToLower(getenv("BLOCK_REGISTER", "true")) != "false",
-		ImagesPath:       getenv("IMAGES_PATH", "/images"),
-		CORSOrigin:       getenv("CORS_ORIGIN", "https://app.pyazo.com"),
-		Port:             getenv("PORT", "8000"),
+func Load() (*Config, error) {
+	var missing []string
+	cfg := &Config{
+		Env:              optional("ENV", "production"),
+		PostgresUser:     optional("POSTGRES_USER", "pyazo"),
+		PostgresPassword: required("POSTGRES_PASSWORD", &missing),
+		PostgresDB:       optional("POSTGRES_DB", "pyazo"),
+		PostgresHost:     optional("POSTGRES_HOST", "localhost"),
+		JWTSecret:        required("JWT_SECRET", &missing),
+		BlockRegister:    strings.ToLower(optional("BLOCK_REGISTER", "true")) != "false",
+		ImagesPath:       optional("IMAGES_PATH", "/images"),
+		CORSOrigin:       optional("CORS_ORIGIN", "https://app.pyazo.com"),
+		Port:             optional("PORT", "8000"),
 	}
+	if len(missing) > 0 {
+		return nil, fmt.Errorf("missing required env vars: %s", strings.Join(missing, ", "))
+	}
+	return cfg, nil
 }
 
-func (c *Config) DatabaseURL() string {
-	return fmt.Sprintf("postgres://%s:%s@%s:5432/%s?sslmode=disable",
-		c.PostgresUser, c.PostgresPassword, c.PostgresHost, c.PostgresDB)
+func required(key string, missing *[]string) string {
+	v := os.Getenv(key)
+	if v == "" {
+		*missing = append(*missing, key)
+	}
+	return v
 }
 
-func getenv(key, fallback string) string {
+func optional(key, fallback string) string {
 	if v := os.Getenv(key); v != "" {
 		return v
 	}
 	return fallback
 }
+
+func (c *Config) DatabaseURL() string {
+	return fmt.Sprintf("postgres://%s:%s@%s:5432/%s?sslmode=disable",
+		c.PostgresUser, c.PostgresPassword, c.PostgresHost, c.PostgresDB)
+}

db/db.go

@@ -25,7 +25,15 @@ type Image struct {
 }
 
 func NewPool(ctx context.Context, databaseURL string) (*pgxpool.Pool, error) {
-	return pgxpool.New(ctx, databaseURL)
+	pool, err := pgxpool.New(ctx, databaseURL)
+	if err != nil {
+		return nil, err
+	}
+	if err := pool.Ping(ctx); err != nil {
+		pool.Close()
+		return nil, err
+	}
+	return pool, nil
 }
 
 func GetUserByUsername(ctx context.Context, pool *pgxpool.Pool, username string) (*User, error) {

db/migrate.go

@@ -0,0 +1,26 @@
+package db
+
+import (
+	"github.com/golang-migrate/migrate/v4"
+	_ "github.com/golang-migrate/migrate/v4/database/postgres"
+	"github.com/golang-migrate/migrate/v4/source/iofs"
+
+	"github.com/pyazo-screenshot/api/migrations"
+)
+
+func RunMigrations(databaseURL string) error {
+	source, err := iofs.New(migrations.FS, ".")
+	if err != nil {
+		return err
+	}
+
+	m, err := migrate.NewWithSourceInstance("iofs", source, databaseURL)
+	if err != nil {
+		return err
+	}
+
+	if err := m.Up(); err != nil && err != migrate.ErrNoChange {
+		return err
+	}
+	return nil
+}