add healthcheck and improve docker

Author: janishar

.env.example

@@ -13,11 +13,10 @@ DB_MIN_POOL_SIZE=2
 DB_MAX_POOL_SIZE=5
 DB_QUERY_TIMEOUT_SEC=60
 
-# To run migration on test database since 
-# docker load only from .env file
-TEST_DB_NAME=goserver_test_db
-TEST_DB_USER=goserver_test_db_user
-TEST_DB_USER_PWD=changeit
+# PostgreSQL Docker container variables
+POSTGRES_DB=goserver_dev_db
+POSTGRES_USER=goserver_dev_db_user
+POSTGRES_PASSWORD=changeit
 
 REDIS_HOST=redis
 REDIS_PORT=6379

.github/workflows/docker_compose.yml

@@ -22,8 +22,22 @@ jobs:
       run: docker compose build
     - name: Run docker images
       run: docker compose up -d
+    - name: Wait for API health
+      run: |
+        echo "Waiting for API to become healthy..."
+        for i in {1..30}; do
+          STATUS=$(docker inspect --format='{{.State.Health.Status}}' goserver-postgres)
+          if [ "$STATUS" = "healthy" ]; then
+            echo "API is healthy"
+            exit 0
+          fi
+          sleep 2
+        done
+        echo "API did not become healthy in time"
+        docker logs goserver-postgres
+        exit 1
     - name: Run tests
-      run: docker exec -t goserve_example_api_server_postgres go test -v ./...
+      run: docker exec -t goserver-postgres go test -v ./...
     - name: Clean up
       if: success() || failure()
       run: docker compose down --rmi all -v --remove-orphans

Dockerfile

@@ -1,6 +1,8 @@
 # Use Go v1.25.6 as the base image
 FROM golang:1.25.6-alpine
 
+RUN apk add --no-cache curl
+
 # Create a new user in the docker image
 RUN adduser --disabled-password --gecos '' gouser
 

README.md

@@ -128,7 +128,7 @@ docker compose up --build
 **5. Run Tests**
 
 ```bash
-docker exec -t goserve_example_api_server_postgres go test -v ./...
+docker exec -t goserver-postgres go test -v ./...
 ```
 
 If having any issue
@@ -143,7 +143,7 @@ If having any issue
 go mod tidy
 ```
 
-Keep the docker container for `postgres` and `redis` running and **stop** the `goserve_example_api_server_postgres` docker container
+Keep the docker container for `postgres` and `redis` running and **stop** the `goserver-postgres` docker container
 
 Change the following hosts in the **.env** and **.test.env**
 

api/health/controller.go

@@ -0,0 +1,34 @@
+package health
+
+import (
+	"github.com/afteracademy/goserve/v2/network"
+	"github.com/gin-gonic/gin"
+)
+
+type controller struct {
+	network.Controller
+	service Service
+}
+
+func NewController(
+	service Service,
+) network.Controller {
+	return &controller{
+		Controller: network.NewController("/health", nil, nil),
+		service:    service,
+	}
+}
+
+func (c *controller) MountRoutes(group *gin.RouterGroup) {
+	group.GET("/", c.getHealthHandler)
+}
+
+func (c *controller) getHealthHandler(ctx *gin.Context) {
+	health, err := c.service.CheckHealth()
+	if err != nil {
+		network.SendMixedError(ctx, err)
+		return
+	}
+
+	network.SendSuccessDataResponse(ctx, "success", health)
+}

api/health/dto/health_check.go

@@ -0,0 +1,10 @@
+package dto
+
+import (
+	"time"
+)
+
+type HealthCheck struct {
+	Timestamp time.Time `json:"timestamp" binding:"required"`
+	Status    string    `json:"status" binding:"required"`
+}

api/health/service.go

@@ -0,0 +1,26 @@
+package health
+
+import (
+	"time"
+
+	"github.com/afteracademy/goserve-example-api-server-postgres/api/health/dto"
+)
+
+type Service interface {
+	CheckHealth() (*dto.HealthCheck, error)
+}
+
+type service struct {
+}
+
+func NewService() Service {
+	return &service{}
+}
+
+func (s *service) CheckHealth() (*dto.HealthCheck, error) {
+	health := &dto.HealthCheck{
+		Timestamp: time.Now(),
+		Status:    "OK",
+	}
+	return health, nil
+}

docker-compose.yml

@@ -3,11 +3,19 @@ services:
     build:
       context: .
       dockerfile: Dockerfile
-    container_name: goserve_example_api_server_postgres
+    container_name: goserver-postgres
     restart: unless-stopped
     env_file: .env
     ports:
       - '${SERVER_PORT}:${SERVER_PORT}'
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8080/health"]
+      interval: 5s
+      timeout: 3s
+      retries: 10
+      start_period: 10s
+    networks:
+      - goserve-postgres-network
     depends_on:
       postgres:
         condition: service_healthy
@@ -18,17 +26,15 @@ services:
     image: postgres:18.1
     restart: unless-stopped
     env_file: .env
-    environment:
-      POSTGRES_DB: ${DB_NAME}
-      POSTGRES_USER: ${DB_USER}
-      POSTGRES_PASSWORD: ${DB_USER_PWD}
     ports:
       - '${DB_PORT}:5432'
     volumes:
       - dbdata:/data/db
       # optional pg seed scripts
       - ./.extra/setup/init-test-db.sql:/docker-entrypoint-initdb.d/init-test-db.sql:ro
       - ./.extra/setup/pgseed.sql:/docker-entrypoint-initdb.d/pgseed.sql:ro
+    networks:
+      - goserve-postgres-network
     healthcheck:
       test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$DB_NAME"]
       interval: 3s
@@ -44,6 +50,8 @@ services:
     command: redis-server --bind 0.0.0.0 --save 20 1 --loglevel warning --requirepass ${REDIS_PASSWORD}
     volumes:
       - cache:/data/cache
+    networks:
+      - goserve-postgres-network
     healthcheck:
       test: ["CMD-SHELL", "redis-cli -a ${REDIS_PASSWORD} ping | grep PONG"]
       interval: 5s
@@ -52,18 +60,23 @@ services:
 
   migrate:
     image: migrate/migrate
-    env_file: .env
+    env_file: .test.env
     volumes:
       - ./migrations:/migrations
     depends_on:
       postgres:
         condition: service_healthy
+    networks:
+      - goserve-postgres-network
+    entrypoint: ["/bin/sh", "-c"]
     command:
-      [
-        "-path", "/migrations",
-        "-database", "postgres://${TEST_DB_USER}:${TEST_DB_USER_PWD}@postgres:5432/${TEST_DB_NAME}?sslmode=disable",
-        "up"
-      ]
+      - |
+        migrate -path /migrations -database "postgres://$${DB_USER}:$${DB_USER_PWD}@postgres:5432/$${DB_NAME}?sslmode=disable" up
+
+networks:
+  goserve-postgres-network:
+    driver: bridge
+
 volumes:
   dbdata:
   cache:

startup/module.go

@@ -10,6 +10,7 @@ import (
 	"github.com/afteracademy/goserve-example-api-server-postgres/api/blog/editor"
 	"github.com/afteracademy/goserve-example-api-server-postgres/api/blogs"
 	"github.com/afteracademy/goserve-example-api-server-postgres/api/contact"
+	"github.com/afteracademy/goserve-example-api-server-postgres/api/health"
 	"github.com/afteracademy/goserve-example-api-server-postgres/api/user"
 	"github.com/afteracademy/goserve-example-api-server-postgres/config"
 	coreMW "github.com/afteracademy/goserve/v2/middleware"
@@ -21,13 +22,14 @@ import (
 type Module network.Module[module]
 
 type module struct {
-	Context     context.Context
-	Env         *config.Env
-	DB          postgres.Database
-	Store       redis.Store
-	UserService user.Service
-	AuthService auth.Service
-	BlogService blog.Service
+	Context       context.Context
+	Env           *config.Env
+	DB            postgres.Database
+	Store         redis.Store
+	UserService   user.Service
+	AuthService   auth.Service
+	BlogService   blog.Service
+	HealthService health.Service
 }
 
 func (m *module) GetInstance() *module {
@@ -36,6 +38,7 @@ func (m *module) GetInstance() *module {
 
 func (m *module) Controllers() []network.Controller {
 	return []network.Controller{
+		health.NewController(m.HealthService),
 		auth.NewController(m.AuthenticationProvider(), m.AuthorizationProvider(), m.AuthService),
 		user.NewController(m.AuthenticationProvider(), m.AuthorizationProvider(), m.UserService),
 		blog.NewController(m.AuthenticationProvider(), m.AuthorizationProvider(), m.BlogService),
@@ -66,14 +69,16 @@ func NewModule(context context.Context, env *config.Env, db postgres.Database, s
 	userService := user.NewService(db)
 	authService := auth.NewService(db, env, userService)
 	blogService := blog.NewService(db, store, userService)
+	healthService := health.NewService()
 
 	return &module{
-		Context:     context,
-		Env:         env,
-		DB:          db,
-		Store:       store,
-		UserService: userService,
-		AuthService: authService,
-		BlogService: blogService,
+		Context:       context,
+		Env:           env,
+		DB:            db,
+		Store:         store,
+		UserService:   userService,
+		AuthService:   authService,
+		BlogService:   blogService,
+		HealthService: healthService,
 	}
 }