init

Author: belito3

.idea/go-api-codebase.iml

@@ -0,0 +1,25 @@
+FROM alpine:latest
+
+# Set the Current Working Directory inside the container
+WORKDIR /app
+
+# Build Args
+ARG LOG_DIR=/app/logs
+
+# Create Log Directory
+RUN mkdir -p ${LOG_DIR}
+
+# Environment Variables
+ENV LOG_FILE_LOCATION=${LOG_DIR}/app.log
+
+# Copy the source from the current directory to the Working Directory inside the container
+# Copy binary file
+COPY main  .
+# Copy config file
+COPY app/config/config.yaml .
+
+# Declare volumes to mount
+VOLUME [${LOG_DIR}]
+
+# Command to run the executable
+CMD ["./main", "--config", "./config.yaml"]

.idea/modules.xml

@@ -0,0 +1,25 @@
+postgres:
+	docker run --name postgres12 -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=secret -d postgres:12-alpine
+
+createdb:
+	docker exec -it postgres12 createdb --username=root --owner=root simple_bank
+
+dropdb:
+	docker exec -it postgres12 dropdb simple_bank
+
+migrateup:
+	migrate -path db/migration -database "postgresql://root:secret@localhost:5432/simple_bank?sslmode=disable" -verbose up
+
+migratedown:
+	migrate -path db/migration -database "postgresql://root:secret@localhost:5432/simple_bank?sslmode=disable" -verbose down
+
+build:
+	export CGO_ENABLED=0 && go build -o main .
+
+docker_build:
+	make build && docker build -t api-codebase-go:latest .
+
+docker_run:
+	docker-compose up
+
+.PHONY: postgres createdb dropdb migrateup migratedown build docker_build docker_run

.idea/vcs.xml

@@ -0,0 +1,22 @@
+# codebase_go_api
+- Install go-migrate: https://github.com/golang-migrate/migrate/tree/master/cmd/migrate
+- Install postgres and create db
+```
+ make posgres
+ make createdb
+ make migrateup
+```
+
+- Run
+```
+    make docker_build  // build docker with binary file
+    make docker_run    // run docker-compose
+```
+- Test
+```
+   curl -d '{"owner": "cathy", "balance": 150, "currency": "EUR"}' -H "Content-Type: application/json" -X POST http://localhost:8000/api/v1/account/add
+```
+- Update config in file /config/config.yaml
+
+### References
+1. [go-database-sql](http://go-database-sql.org/retrieving.html)

.idea/workspace.xml

@@ -0,0 +1,131 @@
+package app
+
+import (
+	"context"
+	"github.com/belito3/go-api-codebase/app/config"
+	"github.com/belito3/go-api-codebase/app/service"
+	"github.com/belito3/go-api-codebase/app/util"
+	"github.com/belito3/go-api-codebase/pkg/logger"
+	"go.uber.org/dig"
+	"os"
+	"os/signal"
+	"sync/atomic"
+	"syscall"
+	"time"
+)
+
+type options struct {
+	ConfigFile	string
+	Version		string
+}
+
+// Option
+type Option func(*options)
+
+// SetConfigFile
+func SetConfigFile(s string) Option {
+	return func(o *options) {
+		o.ConfigFile = s
+	}
+}
+
+// SetVersion
+func SetVersion(s string) Option {
+	return func(o *options) {
+		o.Version = s
+	}
+}
+
+// Run server
+func Run(ctx context.Context, opts ...Option) error {
+	var state int32 = 1
+	sc := make(chan os.Signal, 1)
+	// kill (no param) default send syscall.SIGTERM
+	// kill -2 is syscall.SIGINT
+	// kill -9 is syscall.SIGKILL but can't be catch, so don't need add it
+	// SIGHUP: (signal hang up) sent to a process when its controlling terminal is closed, such as daemons
+	// SIGINT: Ctrl-C sends an INT signal ("interrupt")
+	// SIGTERM: signal is sent to a proc ess to request its  termination, allows process releasing releasing resources and saving state
+	// SIGKILL: sent to a process to cause it to terminate immediately (kill), can't perform any clean-up upon receiving this signal
+	// SIGQUIT: when user requests that the process quit and perform a core dump
+	signal.Notify(sc, syscall.SIGHUP, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
+	cleanFunc, err := Init(ctx, opts...)
+	if err != nil {
+		return err
+	}
+
+	EXIT:
+		for {
+			sig := <- sc
+			logger.Printf(ctx, "Received a signal[%s]", sig.String())
+			switch sig {
+			case syscall.SIGQUIT, syscall.SIGTERM, syscall.SIGINT:
+				atomic.CompareAndSwapInt32(&state, 1, 0)
+				break EXIT
+			case syscall.SIGHUP:
+			default:
+				break EXIT
+			}
+		}
+
+		cleanFunc()
+		logger.Printf(ctx, "Service exit")
+		time.Sleep(time.Second)
+		os.Exit(int(atomic.LoadInt32(&state)))
+		return nil
+}
+
+// Init
+func Init(ctx context.Context, opts ...Option) (func(), error) {
+	var o options
+	for _, opt := range opts {
+		opt(&o)
+	}
+
+	// Init global config
+	config.Init(o.ConfigFile)
+	config.PrintWithJSON()
+	logger.Printf(ctx, "Service started, running mode：%s，version number：%s，process number：%d", config.C.RunMode, o.Version, os.Getpid())
+
+	// Initialize trace_id for node that app is running
+	// TODO: uuid, object, snowflake
+	util.InitID()
+
+	// Init logger
+	setupLogger()
+
+	container, containerCall := BuildContainer()
+
+	httpServerCleanFunc := InitHTTPServer(ctx, container)
+
+	return func() {
+		httpServerCleanFunc()
+		containerCall()
+	}, nil
+}
+
+
+func BuildContainer() (*dig.Container, func()) {
+	container := dig.New()
+
+	// store DB
+	storeCall, err := InitStore(container)
+	handleError(err)
+
+	// register service
+	err = service.Inject(container)
+	handleError(err)
+
+	return container, func() {
+		if storeCall != nil {
+			storeCall()
+		}
+	}
+}
+
+func handleError(err error) {
+	if err != nil {
+		panic(err)
+	}
+}
+