Switch to Postgres (#64)

Also add a Dockerfile that can build a container image for the app.

Author: markuswustenberg

.circleci/config.yml

@@ -6,8 +6,10 @@ jobs:
   integration-test:
     docker:
       - image: circleci/golang:1.15
-      - image: cockroachdb/cockroach:v20.1.4
-        command: [start-single-node, --insecure, --listen-addr, ":26258"]
+      - image: postgres:12
+        environment:
+          POSTGRES_USER: ahead
+          POSTGRES_PASSWORD: 123
     environment:
       TEST_RESULTS: /tmp/test-results
     steps:
@@ -23,8 +25,8 @@ jobs:
           paths:
             - "/go/pkg/mod"
       - run:
-          name: Waiting for CockroachDB to be ready
-          command: dockerize -wait tcp://localhost:26258 -timeout 1m
+          name: Waiting for Postgres to be ready
+          command: dockerize -wait tcp://localhost:5432 -timeout 1m
       - run:
           name: Run tests
           command: |

.dockerignore

@@ -0,0 +1 @@
+/data/

.gitignore

@@ -1,8 +1,7 @@
 /ahead
 /cert.pem
-/certs/
-/cockroach-data/
 /cover.out
+/data/
 /generate_cert.go
 /key.pem
 /node_modules/

Dockerfile

@@ -0,0 +1,20 @@
+FROM golang:1.15-buster AS builder
+WORKDIR /src
+
+# Copy go.mod and go.sum first, to enable caching of dependencies even after local code changes
+COPY go.mod go.sum ./
+RUN go mod download -x
+
+COPY . ./
+RUN go build -v -o /bin/server cmd/server/*.go
+
+FROM debian:buster-slim
+RUN set -x && apt-get update && \
+  DEBIAN_FRONTEND=noninteractive apt-get install -y ca-certificates && \
+  rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+COPY development.toml ./
+COPY --from=builder /bin/server ./
+
+CMD ["./server", "-config", "development.toml"]

Makefile

@@ -1,12 +1,8 @@
-.PHONY: bindata build build-css certs clean cockroach-certs cockroach-sql cover down lint \
-	migrate-create migrate-goto migrate-up start test test-down test-integration test-up up
+.PHONY: build build-css certs clean cover down lint	migrate-create migrate-down migrate-goto migrate-up start test test-down test-integration test-up up up-build
 
 export NAME := ahead
 export VERSION := `git rev-parse --short HEAD`
-export MIGRATE_DB_URL := "cockroachdb://root@localhost:26257/${NAME}?sslmode=verify-full&sslcert=certs/client.root.crt&sslkey=certs/client.root.key&sslrootcert=certs/ca.crt"
-
-bindata:
-	go-bindata -nometadata -pkg storage -o storage/migrations.go -ignore '.*\.go' -ignore '.DS_Store' -prefix storage/migrations storage/migrations
+export MIGRATE_DB_URL := "postgres://${NAME}:123@localhost:5432/${NAME}?sslmode=disable"
 
 build:
 	sed -i.bak "s/VERSION/${VERSION}/g" cmd/server/version.go
@@ -21,19 +17,7 @@ certs: generate_cert.go
 	go run generate_cert.go --rsa-bits=2048 --host=localhost
 
 clean:
-	rm -rf certs
-	rm -rf cockroach-data
-
-cockroach-certs:
-	rm -rf certs
-	mkdir -p certs/my-safe-directory
-	cockroach cert create-ca --certs-dir=certs --ca-key=certs/my-safe-directory/ca.key
-	cockroach cert create-node db localhost 127.0.0.1 --certs-dir=certs --ca-key=certs/my-safe-directory/ca.key
-	cockroach cert create-client root --certs-dir=certs --ca-key=certs/my-safe-directory/ca.key
-	cockroach cert create-client ${NAME} --certs-dir=certs --ca-key=certs/my-safe-directory/ca.key
-
-cockroach-sql:
-	cockroach sql --certs-dir certs
+	rm -rf data
 
 cover:
 	go tool cover -html=cover.out
@@ -50,6 +34,9 @@ lint:
 migrate-create:
 	migrate create -ext sql -dir storage/migrations -seq $(name)
 
+migrate-down:
+	migrate -path storage/migrations -database ${MIGRATE_DB_URL} down
+
 migrate-goto:
 	migrate -path storage/migrations -database ${MIGRATE_DB_URL} goto $(version)
 
@@ -72,9 +59,9 @@ test-up:
 	docker-compose -p ${NAME}-test -f docker-compose-test.yaml up -d
 
 up:
-	mkdir -p cockroach-data
+	mkdir -p data
 	docker-compose -p ${NAME} up -d
-	sleep 1
-	cockroach sql --certs-dir certs -e "create database if not exists ${NAME};"
-	cockroach sql --certs-dir certs -e "create user if not exists ${NAME};"
-	cockroach sql --certs-dir certs -e "grant select, insert, update, delete on database ${NAME} to ${NAME};"
+
+up-build:
+	mkdir -p data
+	docker-compose -p ${NAME} up --build -d

README.md

@@ -8,7 +8,7 @@ A SaaS web app starter template written in Go.
 
 - Web app with best practice project layout and single-binary deployment
 - Stateless app ready for working behind a load balancer, such as [Caddy](https://caddyserver.com)
-- Storage using [CockroachDB](https://www.cockroachlabs.com) (but can be easily changed to another database system)
+- Storage using [Postgres](https://www.postgresql.org) (but can be easily changed to another database system)
 - Metrics using [Prometheus](https://prometheus.io)
 - Transactional emails using [Postmark](https://postmarkapp.com)
 - Unit and integration tests using [Docker Compose](https://docs.docker.com/compose/),

cmd/server/config.go

@@ -8,7 +8,6 @@ import (
 
 // Config holds configuration data read from a config file.
 type Config struct {
-	Name         string
 	ExternalHost string
 	ExternalPort int
 	InternalHost string

cmd/server/main.go

@@ -29,7 +29,6 @@ func main() {
 		ExternalPort: c.ExternalPort,
 		InternalHost: c.InternalHost,
 		InternalPort: c.InternalPort,
-		Name:         c.Name,
 		Version:      Version,
 		Cert:         c.Cert,
 		Key:          c.Key,
@@ -43,7 +42,6 @@ func main() {
 func createStorer(c Config, logger *log.Logger) *storage.Storer {
 	return storage.NewStorer(storage.NewStorerOptions{
 		Logger:   logger,
-		AppName:  c.Name,
 		User:     c.Storer.User,
 		Host:     c.Storer.Host,
 		Port:     c.Storer.Port,

development.toml

@@ -1,4 +1,3 @@
-Name = "ahead"
 ExternalHost = "localhost"
 ExternalPort = 2020
 InternalHost = "localhost"
@@ -7,10 +6,8 @@ Cert = "cert.pem"
 Key = "key.pem"
 
 [Storer]
-Host = "localhost"
-Port = 26257
 User = "ahead"
+Password = "123"
+Host = "localhost"
+Port = 5432
 Database = "ahead"
-Cert = "certs/client.ahead.crt"
-Key = "certs/client.ahead.key"
-RootCert = "certs/ca.crt"

docker-compose-test.yaml

@@ -1,7 +1,9 @@
-version: '3.7'
+version: '3.8'
 services:
   db:
-    command: start-single-node --insecure --listen-addr=0.0.0.0:26257
-    image: cockroachdb/cockroach:v20.1.4
+    image: postgres:12
+    environment:
+      POSTGRES_USER: ahead
+      POSTGRES_PASSWORD: 123
     ports:
-      - 26258:26257
+      - 5432:5432

docker-compose.yaml

@@ -1,14 +1,23 @@
-version: '3.7'
+version: '3.8'
 services:
   db:
-    command: start-single-node --certs-dir=/certs --store=/cockroach-data --listen-addr=0.0.0.0:26257
-    image: cockroachdb/cockroach:v20.1.4
+    image: postgres:12
+    environment:
+      POSTGRES_USER: ahead
+      POSTGRES_PASSWORD: 123
     ports:
-      - 26257:26257
+      - 5432:5432
     volumes:
       - type: bind
-        source: ./certs
-        target: /certs
-      - type: bind
-        source: ./cockroach-data
-        target: /cockroach-data
+        source: ./data
+        target: /var/lib/postgresql/data
+  app:
+    build:
+      context: ./
+      dockerfile: Dockerfile
+    ports:
+      - "2020:2020"
+      - "2021:2021"
+    depends_on:
+      - db
+    restart: always

docker.toml

@@ -0,0 +1,13 @@
+ExternalHost = "localhost"
+ExternalPort = 2020
+InternalHost = "localhost"
+InternalPort = 2021
+Cert = "cert.pem"
+Key = "key.pem"
+
+[Storer]
+User = "ahead"
+Password = "123"
+Host = "db"
+Port = 5432
+Database = "ahead"

storage/migrate.go

@@ -2,8 +2,8 @@ package storage
 
 import (
 	"github.com/golang-migrate/migrate/v4"
-	_ "github.com/golang-migrate/migrate/v4/database/cockroachdb"
-	"github.com/golang-migrate/migrate/v4/source/go_bindata"
+	_ "github.com/golang-migrate/migrate/v4/database/postgres"
+	_ "github.com/golang-migrate/migrate/v4/source/file"
 
 	"github.com/maragudk/go-ahead/errors2"
 )
@@ -37,17 +37,8 @@ func (s *Storer) MigrateDown() error {
 }
 
 func (s *Storer) getMigrator() (*migrate.Migrate, error) {
-	// From https://github.com/golang-migrate/migrate/tree/master/source/go_bindata
-	source := bindata.Resource(AssetNames(), func(name string) ([]byte, error) {
-		return Asset(name)
-	})
-	driver, err := bindata.WithInstance(source)
-	if err != nil {
-		return nil, errors2.Wrap(err, "could not create bindata source driver")
-	}
-	dataSourceName := s.createDataSourceName(true)
-	s.log.Println("Connecting on", dataSourceName)
-	m, err := migrate.NewWithSourceInstance("go-bindata", driver, dataSourceName)
+	dataSourceName := s.createDataSourceName()
+	m, err := migrate.New("file://migrations", dataSourceName)
 	if err != nil {
 		return nil, errors2.Wrap(err, "could not create migrator")
 	}

storage/migrate_test.go

@@ -25,9 +25,8 @@ func TestStorer_MigrateUp(t *testing.T) {
 }
 
 func TestStorer_MigrateDown(t *testing.T) {
-	t.Run("migrates down to version 1", func(t *testing.T) {
-		s, cleanup := storagetest.CreateRootStorer()
-		defer cleanup()
+	t.Run("migrates down", func(t *testing.T) {
+		s, _ := storagetest.CreateRootStorer()
 
 		err := s.MigrateDown()
 		require.NoError(t, err)