Merge pull request #28 from nimblehq/feature/migration

Setup migration

Author: gutakk

cmd/create_test.go

@@ -28,6 +28,26 @@ var _ = Describe("Create template", func() {
 		})
 	})
 
+	Context("given .env.example", func() {
+		It("contains project name at DATABASE_URL", func() {
+			content := tests.ReadFile(".env.example")
+
+			fileContainProjectName := strings.Contains(content, "DATABASE_URL=postgres://postgres:postgres@0.0.0.0:5432/test-gin-templates_development?sslmode=disable")
+
+			Expect(fileContainProjectName).To(BeTrue())
+		})
+	})
+
+	Context("given .env.test", func() {
+		It("contains project name at DATABASE_URL", func() {
+			content := tests.ReadFile(".env.test")
+
+			fileContainProjectName := strings.Contains(content, "DATABASE_URL=postgres://postgres:postgres@0.0.0.0:5433/test-gin-templates_test?sslmode=disable")
+
+			Expect(fileContainProjectName).To(BeTrue())
+		})
+	})
+
 	Context("given docker-compose.dev.yml", func() {
 		It("contains project name at container_name", func() {
 			content := tests.ReadFile("docker-compose.dev.yml")

{{cookiecutter.app_name}}/.env.example

@@ -0,0 +1 @@
+DATABASE_URL=postgres://postgres:postgres@0.0.0.0:5432/{{cookiecutter.app_name}}_development?sslmode=disable

{{cookiecutter.app_name}}/.env.test

@@ -0,0 +1 @@
+DATABASE_URL=postgres://postgres:postgres@0.0.0.0:5433/{{cookiecutter.app_name}}_test?sslmode=disable

{{cookiecutter.app_name}}/.github/workflows/test.yml

@@ -14,10 +14,16 @@ jobs:
         with:
           go-version: 1.16.x
 
+      - name: Create ENV file
+        run: cp ".env.example" ".env"
+
       - name: Linters
         uses: golangci/golangci-lint-action@v2
         with:
           version: v1.29
 
+      - name: Install dependencies
+        run: make install-dependencies
+
       - name: Test
         run: make test

{{cookiecutter.app_name}}/.gitignore

@@ -1 +1,2 @@
 tmp/
+.env

{{cookiecutter.app_name}}/Makefile

@@ -1,19 +1,48 @@
-.PHONY: env-setup env-teardown dev install-dependencies test
+include .env
+ifdef ENV
+include .env.$(ENV)
+endif
+
+.PHONY: env-setup env-teardown db/migrate db/rollback migration/create migration/status dev install-dependencies test wait-for-postgres
 
 env-setup:
 	docker-compose -f docker-compose.dev.yml up -d
 
 env-teardown:
 	docker-compose -f docker-compose.dev.yml down
 
-dev: env-setup
+db/migrate:
+	make wait-for-postgres
+	goose -dir database/migrations -table "migration_versions" postgres "$(DATABASE_URL)" up
+
+db/rollback:
+	make wait-for-postgres
+	goose -dir database/migrations -table "migration_versions" postgres "$(DATABASE_URL)" down
+
+migration/create:
+ifndef MIGRATION_NAME
+	$(error MIGRATION_NAME is required)
+endif
+	goose -dir database/migrations create $(MIGRATION_NAME) sql
+
+migration/status:
+	goose -dir database/migrations -table "migration_versions" postgres "$(DATABASE_URL)" status
+
+dev: 
+	make env-setup
+	make db/migrate
 	air -c cmd/api/.air.toml
 
 install-dependencies:
 	go get github.com/cosmtrek/air@v1.15.1
+	go get github.com/pressly/goose/cmd/goose
 	go mod tidy
 
 test:
 	docker-compose -f docker-compose.test.yml up -d
-	BRANCH=$(BRANCH) go test -v -p 1 -count=1 ./...
+	ENV=test make db/migrate
+	go test -v -p 1 -count=1 ./...
 	docker-compose -f docker-compose.test.yml down
+
+wait-for-postgres:
+	$(shell DATABASE_URL=$(DATABASE_URL) ./bin/wait-for-postgres.sh)

{{cookiecutter.app_name}}/README.md

@@ -12,17 +12,28 @@
 
 ### Development
 
+#### Create an ENV file
+
+To start the development server, `.env` file must be created.
+
+- Copy `.env.example` file and rename to `.env`
+
 #### Build dependencies
-[`air`](https://github.com/cosmtrek/air) is used for live reloading. It needs to be built as a binary file in `$GOPATH`.
 
+- [`air`](https://github.com/cosmtrek/air) is used for live reloading
+
+- [`goose`](https://github.com/pressly/goose) is used for database migration. 
+
+They need to be built as a binary file in `$GOPATH`.
 
-```sh
+
+```make
 make install-dependencies
 ```
 
 #### Start development server
 
-```sh
+```make
 make dev
 ```
 
@@ -32,6 +43,32 @@ The application runs locally at http://localhost:8080
 
 Execute all unit tests:
 
-```sh
+```make
 make test
 ```
+
+### Migration
+
+#### Create migration
+
+```make
+make migration/create MIGRATION_NAME={migration name}
+```
+
+#### List the migration status
+
+```make
+make migration/status
+```
+
+#### Migrate the database
+
+```make
+make db/migrate
+```
+
+#### Rollback the migration
+
+```make
+make db/rollback
+```

{{cookiecutter.app_name}}/bin/wait-for-postgres.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+set -e
+
+until psql $DATABASE_URL -c "\q" > /dev/null 2>&1; do
+  >&2 echo "Postgres is unavailable - sleeping"
+  sleep 1
+done