Merge pull request #6 from skantay/new

LGTM

Author: skantay

.github/workflows/github-actions.yaml

@@ -0,0 +1,33 @@
+name: Go
+
+on:
+ push:
+    branches:
+      - master
+      - main
+      - dev
+ pull_request:
+
+jobs:
+ build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.20'
+
+    - name: Install dependencies
+      run: go get -v -t -d ./...
+
+    - name: Run tests
+      run: go test -v ./...
+
+    - name: Run golangci-lint
+      uses: golangci/golangci-lint-action@v4
+      with:
+        version: v1.54
+        args: --timeout=30m

.gitignore

@@ -0,0 +1,19 @@
+FROM golang:alpine as modules
+COPY go.mod go.sum /modules/
+WORKDIR /modules
+RUN go mod download
+
+
+FROM golang:alpine as builder
+COPY --from=modules /go/pkg /go/pkg
+COPY . /app
+WORKDIR /app
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 \
+    go build -tags migrate -o /bin/app ./cmd/app
+
+FROM scratch
+COPY --from=builder /app/config /config
+COPY --from=builder /app/migrations /migrations
+COPY --from=builder /bin/app /app
+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
+CMD ["/app"]

Dockerfile

@@ -0,0 +1,41 @@
+include .env
+export
+
+compose-up: ### Run docker-compose
+	docker-compose up --build -d && docker-compose logs -f
+.PHONY: compose-up
+
+compose-down: ### Down docker-compose
+	docker-compose down --remove-orphans
+.PHONY: compose-down
+
+linter-golangci: ### check by golangci linter
+	golangci-lint run
+.PHONY: linter-golangci
+
+migrate-create:  ### create new migration
+	migrate create -ext sql -dir migrations '$(PROJECT_NAME)'
+.PHONY: migrate-create
+
+migrate-up: ### migration up
+	migrate -path migrations -database '$(PG_URL_LOCALHOST)?sslmode=disable' up
+.PHONY: migrate-up
+
+migrate-down: ### migration down
+	echo "y" | migrate -path migrations -database '$(PG_URL_LOCALHOST)?sslmode=disable' down
+.PHONY: migrate-down
+
+test: ### run test
+	go test -v ./...
+
+coverage-html: ### run test with coverage and open html report
+	go test -coverprofile=cvr.out ./...
+	go tool cover -html=cvr.out
+	rm cvr.out
+.PHONY: coverage-html
+
+coverage: ### run test with coverage
+	go test -coverprofile=cvr.out ./...
+	go tool cover -func=cvr.out
+	rm cvr.out
+.PHONY: coverage

Makefile

@@ -1,3 +1,19 @@
-# web-1-clean
+# {PROJECT NAME}
 
-## On development stage
+- description
+- used technologies
+- a little more precise description
+
+# Getting Started
+
+- instruction on how to start
+
+# Usage
+[ba](https://en.wikipedia.org/wiki/Brainfuck)
+- list/show available commands
+
+# Docs
+
+- swagger
+- erm
+- etc...

README.md

@@ -0,0 +1,8 @@
+version: '3'
+services:
+  app:
+    container_name: "{$PROJECT_NAME}"
+    build: .
+    env_file:
+      - .env
+    restart: always

cmd/.keep

@@ -1,3 +1,21 @@
-module github.com/skantay/service
+module github.com/skantay/rest-template
 
 go 1.20
+
+require github.com/jackc/pgconn v1.14.3
+
+require (
+	github.com/jackc/puddle/v2 v2.2.1 // indirect
+	golang.org/x/sync v0.6.0 // indirect
+)
+
+require (
+	github.com/jackc/chunkreader/v2 v2.0.1 // indirect
+	github.com/jackc/pgio v1.0.0 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgproto3/v2 v2.3.3 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20231201235250-de7065d80cb9 // indirect
+	github.com/jackc/pgx/v5 v5.5.5
+	golang.org/x/crypto v0.21.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+)

cmd/app/main.go

@@ -0,0 +1,51 @@
+package httpserver
+
+import (
+	"context"
+	"net/http"
+	"time"
+)
+
+type Server struct {
+	server          *http.Server
+	notify          chan error
+	shutdownTimeout time.Duration
+}
+
+func New(handler http.Handler, timeout map[string]time.Duration, addr string) *Server {
+	httpServer := &http.Server{
+		Handler:      handler,
+		ReadTimeout:  timeout["ReadTimeout"],
+		WriteTimeout: timeout["WriteTimeout"],
+		IdleTimeout:  timeout["IdleTimeout"],
+		Addr:         addr,
+	}
+
+	s := &Server{
+		server:          httpServer,
+		notify:          make(chan error, 1),
+		shutdownTimeout: timeout["shutdownTimeout"],
+	}
+
+	s.start()
+
+	return s
+}
+
+func (s *Server) start() {
+	go func() {
+		s.notify <- s.server.ListenAndServe()
+		close(s.notify)
+	}()
+}
+
+func (s *Server) Notify() <-chan error {
+	return s.notify
+}
+
+func (s *Server) Shutdown() error {
+	ctx, cancel := context.WithTimeout(context.Background(), s.shutdownTimeout)
+	defer cancel()
+
+	return s.server.Shutdown(ctx)
+}

config/.keep

@@ -0,0 +1,65 @@
+package postgres
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"time"
+
+	"github.com/jackc/pgx/v5"
+	"github.com/jackc/pgx/v5/pgconn"
+	"github.com/jackc/pgx/v5/pgxpool"
+)
+
+type PgxPool interface {
+	Close()
+	Acquire(ctx context.Context) (*pgxpool.Conn, error)
+	Exec(ctx context.Context, sql string, arguments ...any) (pgconn.CommandTag, error)
+	Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
+	QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
+	SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults
+	Begin(ctx context.Context) (pgx.Tx, error)
+	BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
+	CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, rowSrc pgx.CopyFromSource) (int64, error)
+	Ping(ctx context.Context) error
+}
+
+type Postgres struct {
+	MaxPoolSize  int
+	ConnAttempts int
+	ConnTimeout  time.Duration
+
+	Pool PgxPool
+}
+
+func New(url string, pg *Postgres) (*Postgres, error) {
+	poolConfig, err := pgxpool.ParseConfig(url)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse config: %w", err)
+	}
+
+	poolConfig.MaxConns = int32(pg.MaxPoolSize)
+
+	for pg.ConnAttempts > 0 {
+		pg.Pool, err = pgxpool.NewWithConfig(context.Background(), poolConfig)
+		if err == nil {
+			break
+		}
+
+		log.Printf("trying to connect to postgres, attempts left: %d", pg.ConnAttempts)
+		time.Sleep(pg.ConnTimeout)
+		pg.ConnAttempts--
+	}
+
+	if err != nil {
+		return nil, fmt.Errorf("failed to connect to postgres: %w", err)
+	}
+
+	return pg, nil
+}
+
+func (p *Postgres) Close() {
+	if p.Pool != nil {
+		p.Pool.Close()
+	}
+}