Merge pull request #6 from Hyperkid123/setup-postgres

Setup postgres connection via GORM

Author: Hyperkid123

.env.example

@@ -1,3 +1,9 @@
 # Copy this file to .env and fill in values as needed, this file contains default env values
 
 LOG_LEVEL=debug
+
+PGSQL_USER=widget-layout
+PGSQL_PASSWORD=widget-layout
+PGSQL_HOSTNAME=0.0.0.0
+PGSQL_PORT=5432
+PGSQL_DATABASE=widget-layout

Dockerfile

@@ -1,6 +1,7 @@
 FROM registry.access.redhat.com/ubi9/go-toolset:9.6-1749636489 AS builder
 COPY api api
 COPY pkg pkg
+COPY cmd cmd
 COPY go.mod go.mod
 COPY go.sum go.sum
 COPY main.go main.go
@@ -12,6 +13,7 @@ USER root
 RUN go get -d -v
 RUN make generate
 RUN CGO_ENABLED=1 go build -o /go/bin/widget-layout-backend 
+RUN CGO_ENABLED=1 go build -o /go/bin/widget-layout-backend-migrate cmd/database/migrate.go
 
 FROM registry.access.redhat.com/ubi9-minimal:latest
 
@@ -25,6 +27,7 @@ RUN mkdir -p /app/spec
 RUN chgrp -R 0 /app/spec && \
     chmod -R g=u /app/spec
 COPY --from=builder /go/bin/widget-layout-backend /app/widget-layout-backend
+COPY --from=builder /go/bin/widget-layout-backend-migrate /usr/bin
 # Spec is used for request payload validation
 COPY spec/openapi.yaml /app/spec/openapi.yaml
 

Makefile

@@ -1,12 +1,14 @@
-.PHONY: build dev generate
+.PHONY: build dev generate test infra migrate-db help
 
 help:
 	@echo "Available commands:"
-	@echo "  build     Build the widget-layout-backend binary"
-	@echo "  dev       Run the application in development mode"
-	@echo "  generate  Run go generate on all packages"
-	@echo "  test  		 Run all unit tests with coverage"
-	@echo "  help      Show this help message"
+	@echo "  build        Build the widget-layout-backend binary"
+	@echo "  dev          Run the application in development mode"
+	@echo "  generate     Run go generate on all packages"
+	@echo "  test         Run all unit tests with coverage"
+	@echo "  infra        Start local infrastructure with Docker Compose"
+	@echo "  migrate-db   Run the database migration script"
+	@echo "  help         Show this help message"
 
 build:
 	go build -o bin/widget-layout-backend .
@@ -19,4 +21,10 @@ generate:
 
 test:
 	go test -coverprofile=coverage.out ./... $(ARGS)
-	@go tool cover -html=coverage.out -o coverage.html
+	@go tool cover -html=coverage.out -o coverage.html
+
+infra:
+	docker-compose --env-file .env -f local/database-compose.yaml up
+
+migrate-db:
+	go run cmd/database/migrate.go

cmd/database/migrate.go

@@ -0,0 +1,42 @@
+package main
+
+import (
+	"github.com/RedHatInsights/widget-layout-backend/pkg/database"
+	"github.com/RedHatInsights/widget-layout-backend/pkg/models"
+	"github.com/joho/godotenv"
+	"github.com/sirupsen/logrus"
+	"gorm.io/gorm"
+	"gorm.io/gorm/logger"
+)
+
+func main() {
+	godotenv.Load()
+
+	// migrate models
+	tx := database.DB.Begin().Session(&gorm.Session{
+		Logger: logger.Default.LogMode(logger.Info),
+	})
+	// rollback changes
+	defer func() {
+		if r := recover(); r != nil {
+			logrus.Errorln("Migration failed:", r)
+			tx.Rollback()
+		}
+	}()
+
+	// migrate the base models
+	if err := tx.AutoMigrate(
+		&models.DashboardTemplate{},
+	); err != nil {
+		logrus.Errorln("Failed to migrate models:", err.Error())
+		tx.Rollback()
+		return
+	}
+
+	err := tx.Commit().Error
+	if err != nil {
+		logrus.Errorln("Failed to commit migration transaction:", err.Error())
+		return
+	}
+	logrus.Infoln("Database migration completed successfully")
+}

deploy/clowdapp.yaml

@@ -24,6 +24,12 @@ objects:
                 - /api/widget-layout/v1/openapi.yaml
           podSpec:
             image: ${IMAGE}:${IMAGE_TAG}
+            initContainers:
+              - name: run-db-migration
+                command:
+                  - bash
+                  - -c
+                  - widget-layout-backend-migrate
             livenessProbe:
               failureThreshold: 3
               httpGet:

go.mod

@@ -8,11 +8,13 @@ require (
 	github.com/joho/godotenv v1.5.1
 	github.com/oapi-codegen/nethttp-middleware v1.1.2
 	github.com/oapi-codegen/oapi-codegen/v2 v2.4.1
-	github.com/oapi-codegen/runtime v1.1.1
+	github.com/oasdiff/yaml v0.0.0-20250309154309-f31be36b4037
 	github.com/prometheus/client_golang v1.22.0
 	github.com/redhatinsights/app-common-go v1.6.8
 	github.com/sirupsen/logrus v1.8.1
 	github.com/stretchr/testify v1.10.0
+	gorm.io/driver/postgres v1.6.0
+	gorm.io/gorm v1.30.0
 )
 
 require (
@@ -23,11 +25,16 @@ require (
 	github.com/go-openapi/jsonpointer v0.21.0 // indirect
 	github.com/go-openapi/swag v0.23.0 // indirect
 	github.com/gorilla/mux v1.8.1 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
+	github.com/jackc/pgx/v5 v5.6.0 // indirect
+	github.com/jackc/puddle/v2 v2.2.2 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
-	github.com/oasdiff/yaml v0.0.0-20250309154309-f31be36b4037 // indirect
 	github.com/oasdiff/yaml3 v0.0.0-20250309153720-d2182401db90 // indirect
 	github.com/perimeterx/marshmallow v1.1.5 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
@@ -36,7 +43,9 @@ require (
 	github.com/prometheus/procfs v0.15.1 // indirect
 	github.com/speakeasy-api/openapi-overlay v0.9.0 // indirect
 	github.com/vmware-labs/yaml-jsonpath v0.3.2 // indirect
+	golang.org/x/crypto v0.31.0 // indirect
 	golang.org/x/mod v0.17.0 // indirect
+	golang.org/x/sync v0.10.0 // indirect
 	golang.org/x/sys v0.30.0 // indirect
 	golang.org/x/text v0.21.0 // indirect
 	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect

go.sum

@@ -45,6 +45,18 @@ github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
 github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
 github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
+github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
+github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
+github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo=
+github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
+github.com/jackc/pgx/v5 v5.6.0 h1:SWJzexBzPL5jb0GEsrPMLIsi/3jOo7RHlzTjcAeDrPY=
+github.com/jackc/pgx/v5 v5.6.0/go.mod h1:DNZ/vlrUnhWCoFGxHAG8U2ljioxukquj7utPDgtQdTw=
+github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=
+github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
+github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
+github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc=
+github.com/jinzhu/now v1.1.5 h1:/o9tlHleP7gOFmsnYNz3RGnqzefHA47wQpKrrdTIwXQ=
+github.com/jinzhu/now v1.1.5/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8=
 github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
 github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
@@ -73,8 +85,6 @@ github.com/oapi-codegen/nethttp-middleware v1.1.2 h1:TQwEU3WM6ifc7ObBEtiJgbRPaCe
 github.com/oapi-codegen/nethttp-middleware v1.1.2/go.mod h1:5qzjxMSiI8HjLljiOEjvs4RdrWyMPKnExeFS2kr8om4=
 github.com/oapi-codegen/oapi-codegen/v2 v2.4.1 h1:ykgG34472DWey7TSjd8vIfNykXgjOgYJZoQbKfEeY/Q=
 github.com/oapi-codegen/oapi-codegen/v2 v2.4.1/go.mod h1:N5+lY1tiTDV3V1BeHtOxeWXHoPVeApvsvjJqegfoaz8=
-github.com/oapi-codegen/runtime v1.1.1 h1:EXLHh0DXIJnWhdRPN2w4MXAzFyE4CskzhNLUmtpMYro=
-github.com/oapi-codegen/runtime v1.1.1/go.mod h1:SK9X900oXmPWilYR5/WKPzt3Kqxn/uS/+lbpREv+eCg=
 github.com/oasdiff/yaml v0.0.0-20250309154309-f31be36b4037 h1:G7ERwszslrBzRxj//JalHPu/3yz+De2J+4aLtSRlHiY=
 github.com/oasdiff/yaml v0.0.0-20250309154309-f31be36b4037/go.mod h1:2bpvgLBZEtENV5scfDFEtB/5+1M4hkQhDQrccEJ/qGw=
 github.com/oasdiff/yaml3 v0.0.0-20250309153720-d2182401db90 h1:bQx3WeLcUWy+RletIKwUIt4x3t8n2SxavmoclizMb8c=
@@ -116,8 +126,10 @@ github.com/speakeasy-api/openapi-overlay v0.9.0 h1:Wrz6NO02cNlLzx1fB093lBlYxSI54
 github.com/speakeasy-api/openapi-overlay v0.9.0/go.mod h1:f5FloQrHA7MsxYg9djzMD5h6dxrHjVVByWKh7an8TRc=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/ugorji/go/codec v1.2.11 h1:BMaWp1Bb6fHwEtbplGBGJ498wD+LKlNSl25MjdZY4dU=
@@ -128,6 +140,8 @@ github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9dec
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U=
+golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
 golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA=
 golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
@@ -206,3 +220,7 @@ gopkg.in/yaml.v3 v3.0.0-20191026110619-0b21df46bc1d/go.mod h1:K4uyk7z7BCEPqu6E+C
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gorm.io/driver/postgres v1.6.0 h1:2dxzU8xJ+ivvqTRph34QX+WrRaJlmfyPqXmoGVjMBa4=
+gorm.io/driver/postgres v1.6.0/go.mod h1:vUw0mrGgrTK+uPHEhAdV4sfFELrByKVGnaVRkXDhtWo=
+gorm.io/gorm v1.30.0 h1:qbT5aPv1UH8gI99OsRlvDToLxW5zR7FzS9acZDOZcgs=
+gorm.io/gorm v1.30.0/go.mod h1:8Z33v652h4//uMA76KjeDH8mJXPm1QNCYrMeatR0DOE=

local/database-compose.yaml

@@ -0,0 +1,17 @@
+---
+services:
+  widget-layout-db:
+    image: quay.io/sclorg/postgresql-16-c9s:latest
+    restart: always
+    environment:
+    - POSTGRESQL_USER=${PGSQL_USER}
+    - POSTGRESQL_PASSWORD=${PGSQL_PASSWORD}
+    - POSTGRESQL_DATABASE=${PGSQL_DATABASE}
+    ports:
+    - "${PGSQL_PORT}:5432"
+    volumes:
+    - widget-layout:/var/lib/postgresql/data
+
+volumes:
+  widget-layout:
+    driver: local

pkg/config/config.go

@@ -1,20 +1,52 @@
 package config
 
 import (
+	"fmt"
 	"os"
+	"strconv"
 
 	"github.com/joho/godotenv"
 	clowder "github.com/redhatinsights/app-common-go/pkg/api/v1"
 )
 
+type DatabaseConfig struct {
+	DBHost        string
+	DBUser        string
+	DBPassword    string
+	DBPort        int
+	DBName        string
+	DBSSLMode     string
+	DBSSLRootCert string
+	DBDNS         string
+}
+
 type WidgetLayoutConfig struct {
-	LogLevel    string
-	WebPort     int
-	MetricsPort int
+	LogLevel       string
+	WebPort        int
+	MetricsPort    int
+	DatabaseConfig DatabaseConfig
 }
 
 var config *WidgetLayoutConfig
 
+// The location of certificates is dictated by Clowder
+const RdsCaLocation = "/app/rdsca.cert"
+
+func (c *WidgetLayoutConfig) getCert(cfg *clowder.AppConfig) string {
+	cert := ""
+	if cfg.Database.SslMode != "verify-full" {
+		return cert
+	}
+	if cfg.Database.RdsCa != nil {
+		err := os.WriteFile(RdsCaLocation, []byte(*cfg.Database.RdsCa), 0644)
+		if err != nil {
+			panic(err)
+		}
+		cert = RdsCaLocation
+	}
+	return cert
+}
+
 func init() {
 	godotenv.Load()
 	config = &WidgetLayoutConfig{}
@@ -28,9 +60,30 @@ func init() {
 		cfg := clowder.LoadedConfig
 		config.WebPort = *cfg.PublicPort
 		config.MetricsPort = cfg.MetricsPort
+		config.DatabaseConfig = DatabaseConfig{
+			DBHost:        cfg.Database.Hostname,
+			DBUser:        cfg.Database.Username,
+			DBPassword:    cfg.Database.Password,
+			DBPort:        cfg.Database.Port,
+			DBName:        cfg.Database.Name,
+			DBSSLMode:     cfg.Database.SslMode,
+			DBSSLRootCert: config.getCert(cfg),
+		}
+		config.DatabaseConfig.DBDNS = fmt.Sprintf("host=%v user=%v password=%v dbname=%v port=%v sslmode=%v", cfg.Database.Hostname, cfg.Database.Username, cfg.Database.Password, cfg.Database.Name, cfg.Database.Port, cfg.Database.SslMode)
 	} else {
 		config.WebPort = 8000
 		config.MetricsPort = 9000
+
+		// Make sure the .env file is loaded and has correct values!
+		config.DatabaseConfig.DBUser = os.Getenv("PGSQL_USER")
+		config.DatabaseConfig.DBPassword = os.Getenv("PGSQL_PASSWORD")
+		config.DatabaseConfig.DBHost = os.Getenv("PGSQL_HOSTNAME")
+		port, _ := strconv.Atoi(os.Getenv("PGSQL_PORT"))
+		config.DatabaseConfig.DBPort = port
+		config.DatabaseConfig.DBName = os.Getenv("PGSQL_DATABASE")
+		// Disable SSL mode for local development
+		config.DatabaseConfig.DBSSLMode = "disable"
+		config.DatabaseConfig.DBDNS = fmt.Sprintf("host=%v user=%v password=%v dbname=%v port=%v sslmode=%v", config.DatabaseConfig.DBHost, config.DatabaseConfig.DBUser, config.DatabaseConfig.DBPassword, config.DatabaseConfig.DBName, config.DatabaseConfig.DBPort, config.DatabaseConfig.DBSSLMode)
 	}
 }
 

pkg/database/database.go

@@ -0,0 +1,21 @@
+package database
+
+import (
+	"github.com/RedHatInsights/widget-layout-backend/pkg/config"
+	"github.com/joho/godotenv"
+	"gorm.io/driver/postgres"
+	"gorm.io/gorm"
+)
+
+var DB *gorm.DB
+
+func init() {
+	godotenv.Load()
+	cfg := config.GetConfig()
+	dns := cfg.DatabaseConfig.DBDNS
+	db, err := gorm.Open(postgres.Open(dns), &gorm.Config{})
+	if err != nil {
+		panic("failed to connect to database: " + err.Error())
+	}
+	DB = db
+}