Merge pull request #3146 from mdelapenya/testcontainer-recipe

feat: add recipe for local-development with testcontainers

Author: ReneWerner87

README.md

@@ -57,6 +57,7 @@ Here you can find the most **delicious** recipes to cook delicious meals using o
 - [I18n](./i18n/README.md) - Internationalization support.
 - [JWT](./jwt/README.md) - Using JSON Web Tokens (JWT) for authentication.
 - [Kubernetes](./k8s/README.md) - Deploying applications to Kubernetes.
+- [Local Development with Testcontainers](./local-development-testcontainers/README.md) - Local development with Testcontainers.
 - [Memgraph](./memgraph/README.md) - Using Memgraph.
 - [MinIO](./minio/README.md) - A simple application for uploading and downloading files from MinIO.
 - [MongoDB](./mongodb/README.md) - Connecting to a MongoDB database.

local-development-testcontainers/.air.conf

@@ -0,0 +1,47 @@
+# Config file for [Air](https://github.com/air-verse/air) in TOML format
+
+# Working directory
+# . or absolute path, please note that the directories following must be under root.
+root = "."
+tmp_dir = "tmp"
+
+[build]
+# Just plain old shell command. You could use `make` as well.
+cmd = "go build -tags dev -o ./todo-api ./main.go"
+# Binary file yields from `cmd`.
+bin = "todo-api"
+# Customize binary.
+full_bin = "APP_ENV=dev APP_USER=air godotenv -f .env ./todo-api"
+# Watch these filename extensions.
+include_ext = ["go", "tpl", "tmpl", "html", "mustache", "hbs", "pug"]
+# Ignore these filename extensions or directories.
+exclude_dir = ["tmp", "vendor", "node_modules"]
+# Watch these directories if you specified.
+include_dir = []
+# Exclude files.
+exclude_file = []
+# This log file places in your tmp_dir.
+log = "air.log"
+# It's not necessary to trigger build each time file changes if it's too frequent.
+delay = 1000 # ms
+# Stop running old binary when build errors occur.
+stop_on_error = true
+# Send Interrupt signal before killing process (windows does not support this feature)
+send_interrupt = true
+# Delay after sending Interrupt signal
+kill_delay = 500 # ms
+
+[log]
+# Show log time
+time = false
+
+[color]
+# Customize each part's color. If no color found, use the raw app log.
+main = "magenta"
+watcher = "cyan"
+build = "yellow"
+runner = "green"
+
+[misc]
+# Delete tmp directory on exit
+clean_on_exit = true

local-development-testcontainers/.env

@@ -0,0 +1,3 @@
+PORT=8000
+TOKEN_KEY=laksdjflkasjfwj92jfslj2qu0-9apsoifjk
+TESTCONTAINERS_RYUK_DISABLED=true

local-development-testcontainers/.gitignore

@@ -0,0 +1 @@
+todo-api

local-development-testcontainers/Dockerfile

@@ -0,0 +1,13 @@
+
+#build stage
+FROM golang:alpine AS builder
+WORKDIR /go/src/app
+COPY . .
+RUN go get -d -v . && go build -ldflags="-s -w" main.go
+
+#final stage
+FROM alpine:latest
+LABEL maintainer=mdelapenya version=0.0.1
+COPY --from=builder /go/src/app/main /main
+EXPOSE 4000
+ENTRYPOINT /main

local-development-testcontainers/README.md

@@ -0,0 +1,67 @@
+---
+title: Todo App + Auth + GORM + Testcontainers
+keywords: [todo app, gorm, authentication, testcontainers, postgres]
+description: A Todo application with authentication using GORM and Postgres.
+---
+
+# Todo App with Auth using GORM and Testcontainers
+
+[![Github](https://img.shields.io/static/v1?label=&message=Github&color=2ea44f&style=for-the-badge&logo=github)](https://github.com/gofiber/recipes/tree/master/todo-app-testcontainers-postgres) [![StackBlitz](https://img.shields.io/static/v1?label=&message=StackBlitz&color=2ea44f&style=for-the-badge&logo=StackBlitz)](https://stackblitz.com/github.com/gofiber/recipes/tree/master/todo-app-testcontainers-postgres)
+
+This project demonstrates a Todo application with authentication using GORM and Testcontainers.
+
+The database is a Postgres instance created using the GoFiber's [Testcontainers Service module](https://github.com/gofiber/contrib/testcontainers). The instance is reused across multiple runs of the application, allowing to develop locally without having to wait for the database to be ready.
+
+When using the `air` command to run the application, the database is automatically started alongside the Fiber application, and it's automatically stopped when the air command is interrupted.
+
+## Prerequisites
+
+Ensure you have the following installed and available in your `GOPATH`:
+
+- Golang
+- [Air](https://github.com/air-verse/air) for hot reloading
+
+## Installation
+
+1. Clone the repository:
+    ```sh
+    git clone https://github.com/gofiber/recipes.git
+    cd recipes/todo-app-testcontainers-postgres
+    ```
+
+2. Install dependencies:
+    ```sh
+    go get
+    ```
+
+## Running the Application
+
+1. Start the application:
+    ```sh
+    air
+    ```
+
+## Environment Variables
+
+Create a `.env` file in the root directory and add the following variables:
+
+```shell
+# PORT returns the server listening port
+# default: 8000
+PORT=
+
+# DB returns the name of the sqlite database
+# default: postgres://postgres:postgres@localhost:5432/postgres?sslmode=disable
+
+# TOKENKEY returns the jwt token secret
+TOKENKEY=
+
+# TOKENEXP returns the jwt token expiration duration.
+# Should be time.ParseDuration string. Source: https://golang.org/pkg/time/#ParseDuration
+# default: 10h
+TOKENEXP=
+
+# TESTCONTAINERS_RYUK_DISABLED disables the Ryuk container, to avoid removing the database container when the application is stopped.
+# default: true
+TESTCONTAINERS_RYUK_DISABLED=true
+```

local-development-testcontainers/app/dal/todo.dal.go

@@ -0,0 +1,44 @@
+package dal
+
+import (
+	"gorm.io/gorm"
+)
+
+// Todo struct defines the Todo Model
+type Todo struct {
+	gorm.Model
+	Task      string  `gorm:"not null"`
+	Completed bool    `gorm:"default:false"`
+	User      *uint64 `gorm:"index,not null"`
+	// this is a pointer because int == 0,
+}
+
+// CreateTodo create a todo entry in the todo's table
+func CreateTodo(db *gorm.DB, todo *Todo) *gorm.DB {
+	return db.Create(todo)
+}
+
+// FindTodo finds a todo with given condition
+func FindTodo(db *gorm.DB, dest interface{}, conds ...interface{}) *gorm.DB {
+	return db.Model(&Todo{}).Take(dest, conds...)
+}
+
+// FindTodoByUser finds a todo with given todo and user identifier
+func FindTodoByUser(db *gorm.DB, dest interface{}, todoIden interface{}, userIden interface{}) *gorm.DB {
+	return FindTodo(db, dest, "todos.id = ? AND todos.user = ?", todoIden, userIden)
+}
+
+// FindTodosByUser finds the todos with user's identifier given
+func FindTodosByUser(db *gorm.DB, dest interface{}, userIden interface{}) *gorm.DB {
+	return db.Model(&Todo{}).Find(dest, "todos.user = ?", userIden)
+}
+
+// DeleteTodo deletes a todo from todos' table with the given todo and user identifier
+func DeleteTodo(db *gorm.DB, todoIden interface{}, userIden interface{}) *gorm.DB {
+	return db.Unscoped().Delete(&Todo{}, "todos.id = ? AND todos.user = ?", todoIden, userIden)
+}
+
+// UpdateTodo allows to update the todo with the given todoID and userID
+func UpdateTodo(db *gorm.DB, todoIden interface{}, userIden interface{}, data interface{}) *gorm.DB {
+	return db.Model(&Todo{}).Where("todos.id = ? AND todos.user = ?", todoIden, userIden).Updates(data)
+}

local-development-testcontainers/app/dal/todo.dal_test.go

@@ -0,0 +1,121 @@
+package dal_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	tc "github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/modules/postgres"
+
+	"local-development/testcontainers/app/dal"
+	"local-development/testcontainers/config/database"
+)
+
+func TestTodos(t *testing.T) {
+	pgCtr, err := postgres.Run(
+		context.Background(),
+		"postgres:16",
+		postgres.WithDatabase("todos"),
+		postgres.WithUsername("todos"),
+		postgres.WithPassword("todos"),
+		postgres.BasicWaitStrategies(),
+	)
+	tc.CleanupContainer(t, pgCtr)
+	require.NoError(t, err)
+
+	connString, err := pgCtr.ConnectionString(context.Background())
+	require.NoError(t, err)
+
+	db, err := database.New(connString)
+	require.NoError(t, err)
+
+	err = db.AutoMigrate(&dal.User{}, &dal.Todo{})
+	require.NoError(t, err)
+
+	user := &dal.User{
+		Name:     "John Doe",
+		Email:    "[email protected]",
+		Password: "password",
+	}
+	result := dal.CreateUser(db, user)
+	require.NoError(t, result.Error)
+
+	// Make sure that gorm.Model.ID is uint64, which could happen
+	// if the machine compiling the code has multiple versions of gorm.
+	uid := uint64(user.ID)
+
+	result = result.Scan(&user)
+	require.NoError(t, result.Error)
+
+	t.Run("create", func(t *testing.T) {
+		result := dal.CreateTodo(db, &dal.Todo{
+			Task: "Buy groceries",
+			User: &uid,
+		})
+		require.NoError(t, result.Error)
+
+		todo1 := &dal.Todo{}
+		result = result.Scan(todo1)
+		require.NoError(t, result.Error)
+
+		// create a second todo
+		result = dal.CreateTodo(db, &dal.Todo{
+			Task: "Clean the swimming pool",
+			User: &uid,
+		})
+		require.NoError(t, result.Error)
+
+		t.Run("find", func(t *testing.T) {
+			result := dal.FindTodo(db, &dal.Todo{}, "todos.task = ?", "Buy groceries")
+			require.NoError(t, result.Error)
+			require.Equal(t, int64(1), result.RowsAffected)
+
+			t.Run("todos-by-user", func(t *testing.T) {
+				result := dal.FindTodosByUser(db, &[]dal.Todo{}, uid)
+				require.NoError(t, result.Error)
+				require.Equal(t, int64(2), result.RowsAffected)
+			})
+
+			t.Run("todo-by-user", func(t *testing.T) {
+				result := dal.FindTodoByUser(db, &[]dal.Todo{}, todo1.ID, uid)
+				require.NoError(t, result.Error)
+				require.Equal(t, int64(1), result.RowsAffected)
+
+				todo := &dal.Todo{}
+				result = result.Scan(todo)
+				require.NoError(t, result.Error)
+				require.Equal(t, todo1.ID, todo.ID)
+			})
+		})
+
+		t.Run("update", func(t *testing.T) {
+			result := dal.FindTodo(db, &dal.Todo{}, "todos.task = ?", "Buy a new car")
+			require.Error(t, result.Error)
+			require.Zero(t, result.RowsAffected)
+
+			result = dal.UpdateTodo(db, todo1.ID, &uid, &dal.Todo{Task: "Buy a new car"})
+			require.NoError(t, result.Error)
+
+			result = dal.FindTodo(db, &dal.Todo{}, "todos.task = ?", "Buy a new car")
+			require.NoError(t, result.Error)
+			require.Equal(t, int64(1), result.RowsAffected)
+		})
+
+		t.Run("delete", func(t *testing.T) {
+			result := dal.CreateTodo(db, &dal.Todo{
+				Task: "do the house cleaning",
+				User: &uid,
+			})
+			require.NoError(t, result.Error)
+
+			todo := &dal.Todo{}
+			result = result.Scan(todo)
+			require.NoError(t, result.Error)
+
+			result = dal.DeleteTodo(db, todo.ID, &uid)
+			require.NoError(t, result.Error)
+			require.Equal(t, int64(1), result.RowsAffected)
+		})
+	})
+}

local-development-testcontainers/app/dal/user.dal.go

@@ -0,0 +1,29 @@
+package dal
+
+import (
+	"gorm.io/gorm"
+)
+
+// User struct defines the user
+type User struct {
+	gorm.Model
+	Name     string
+	Email    string `gorm:"uniqueIndex;not null"`
+	Password string `gorm:"not null"`
+	Todos    []Todo `gorm:"foreignKey:User"`
+}
+
+// CreateUser create a user entry in the user's table
+func CreateUser(db *gorm.DB, user *User) *gorm.DB {
+	return db.Create(user)
+}
+
+// FindUser searches the user's table with the condition given
+func FindUser(db *gorm.DB, dest interface{}, conds ...interface{}) *gorm.DB {
+	return db.Model(&User{}).Take(dest, conds...)
+}
+
+// FindUserByEmail searches the user's table with the email given
+func FindUserByEmail(db *gorm.DB, dest interface{}, email string) *gorm.DB {
+	return FindUser(db, dest, "email = ?", email)
+}