Merge pull request #2 from etilite/dev

etilite · web-flow · commit b3a1c7ec0395 · 2024-05-10T20:10:58.000+03:00
feat: init v0.1.0
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -0,0 +1,55 @@
+name: docker push
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  docker:
+    permissions:
+      contents: read
+      packages: write
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            etilite/qr-coder
+          flavor: |
+            latest=false
+          tags: |
+            type=raw,value=development,enable=${{ github.event_name != 'release' }}
+            type=raw,value=latest,enable=${{ github.event_name == 'release' }}
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=sha,enable=true,priority=100,prefix=,suffix=,format=short
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build the Docker image and push
+        uses: docker/build-push-action@v5
+        with:
+          file: ./build/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            GIT_REF=${{ github.sha }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=min
+
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -0,0 +1,50 @@
+name: go build
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+
+  test:
+    strategy:
+      matrix:
+        go-version: ['1.22.3', 'stable']
+        os: [ ubuntu-latest, macos-13, windows-latest ]
+        targetplatform: [ x86, x64 ]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go ${{ matrix.go-version }}
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+          cache: false
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Lint
+        uses: golangci/golangci-lint-action@v3.3.1
+        with:
+          version: latest
+          args: --timeout 5m
+          skip-cache: true
+
+      - name: Test
+        run: go test -race -v -timeout 30m ./... -coverprofile ./coverage.txt
+
+      - name: Codecov
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          files: ./coverage.txt
+          slug: etilite/qr-coder
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/.idea
diff --git a/Makefile b/Makefile
@@ -0,0 +1,25 @@
+.PHONY: up down dev-up dev-down run test test-race clean
+
+up:
+	docker-compose --file ./build/docker-compose.yml up -d --remove-orphans
+
+down:
+	docker-compose --file ./build/docker-compose.yml down
+
+dev-up:
+	docker-compose --file ./build/docker-compose.yml up -d --build --remove-orphans
+
+dev-down:
+	docker-compose --file ./build/docker-compose.yml down --rmi all -v
+
+run:
+	CGO_ENABLED=0 go build -ldflags='-w -s' -o app ./cmd/qr-coder && HTTP_ADDR=:8080 ./app
+
+test:
+	go test -v -shuffle=on -count=2 -short -cover ./...
+
+test-race:
+	go test -race ./...
+
+clean:
+	rm app
diff --git a/README.md b/README.md
@@ -1,2 +1,26 @@
 # qr-coder
-Microservice to generate qr-code
+Microservice to generate QR-codes in png format.
+Text content is encoded in UTF-8.
+
+## Usage
+### Build project
+### Get docker Image
+You can use pre-built Docker images to run `qr-coder`
+```
+docker run -it --rm -d -p 8080:8080 --name qr-coder \
+  -e HTTP_ADDR=:8080 \
+  etilite/qr-coder:latest
+```
+
+#### request 
+`POST http://localhost:8080/generate`
+```json
+{
+    "size": 256,
+    "content": "https://github.com/etilite/qr-coder"
+}
+```
+#### response
+![response](https://github.com/etilite/qr-coder/assets/39223859/bd1c0946-905f-4244-9027-279e795bbdb3)
+
+png image
diff --git a/build/Dockerfile b/build/Dockerfile
@@ -0,0 +1,33 @@
+ARG GO_VERSION=1.22.3
+ARG DISTROLESS_IMAGE=gcr.io/distroless/static:nonroot
+############################
+# STEP 1 build executable binary
+############################
+FROM golang:${GO_VERSION} as builder
+
+# Ensure ca-certficates are up to date
+RUN update-ca-certificates
+
+WORKDIR /app/
+
+# use modules
+COPY go.mod go.sum ./
+
+ENV GO111MODULE=on
+RUN go mod download && go mod verify
+
+COPY . .
+
+# Build the static binary
+RUN CGO_ENABLED=0 go build \
+      -ldflags='-w -s -extldflags "-static"' -a \
+      -o app ./cmd/qr-coder
+
+############################
+# STEP 2 build a small image
+############################
+FROM ${DISTROLESS_IMAGE}
+
+COPY --from=builder --chown=nonroot:nonroot /app/app /app
+
+ENTRYPOINT ["/app"]
diff --git a/build/docker-compose.yml b/build/docker-compose.yml
@@ -0,0 +1,13 @@
+version: '3.8'
+
+services:
+  qr-coder:
+    image: etilite/qr-coder:latest
+    build:
+      context: ./../
+      dockerfile: ./build/Dockerfile
+    container_name: qr-coder
+    ports:
+      - "8080:8080"
+    environment:
+      - HTTP_ADDR=:8080
diff --git a/cmd/qr-coder/main.go b/cmd/qr-coder/main.go
@@ -0,0 +1,63 @@
+package main
+
+import (
+	"log/slog"
+	"os"
+	"os/signal"
+	"syscall"
+	"time"
+
+	"github.com/etilite/qr-coder/internal/app"
+	httpserver "github.com/etilite/qr-coder/internal/delivery/http"
+)
+
+const (
+	shutdownTime time.Duration = 10 * time.Second
+)
+
+func main() {
+	cfg := app.NewConfigFromEnv()
+
+	a := app.New(cfg)
+
+	server := httpserver.NewServer(cfg.HTTPAddr)
+
+	if err := a.Run(server); err != nil {
+		slog.Error("unable to start app", "error", err)
+		panic(err)
+	}
+
+	shutdown := make(chan bool)
+	gracefulStop(shutdown)
+	<-shutdown
+	slog.Info("signal caught, shutting down")
+
+	go aggressiveStop()
+
+	if err := a.Stop(); err != nil {
+		slog.Error("unable to stop app", "error", err)
+		panic(err)
+	}
+}
+
+func gracefulStop(shutdown chan<- bool) {
+	c := make(chan os.Signal)
+	signal.Notify(c,
+		syscall.SIGHUP,
+		syscall.SIGINT,
+		syscall.SIGTERM,
+		syscall.SIGQUIT)
+
+	go func() {
+		<-c
+		shutdown <- true
+	}()
+}
+
+func aggressiveStop() {
+	ticker := time.NewTicker(shutdownTime)
+	<-ticker.C
+
+	slog.Warn("application is aggressive stopped")
+	os.Exit(0)
+}
diff --git a/go.mod b/go.mod
@@ -0,0 +1,14 @@
+module github.com/etilite/qr-coder
+
+go 1.22
+
+require (
+	github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
+	github.com/stretchr/testify v1.9.0
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)
diff --git a/go.sum b/go.sum
@@ -0,0 +1,12 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e h1:MRM5ITcdelLK2j1vwZ3Je0FKVCfqOLp5zO6trqMLYs0=
+github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e/go.mod h1:XV66xRDqSt+GTGFMVlhk3ULuV0y9ZmzeVGR4mloJI3M=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/internal/app/app.go b/internal/app/app.go
@@ -0,0 +1,44 @@
+package app
+
+import (
+	"log/slog"
+)
+
+type service interface {
+	Run() error
+	Stop() error
+}
+
+type App struct {
+	logger   *slog.Logger
+	services []service
+}
+
+func New(cfg Config) *App {
+	return &App{
+		logger: slog.Default(),
+	}
+}
+
+func (app *App) Run(services ...service) error {
+	for _, srv := range services {
+		if err := srv.Run(); err != nil {
+			return err
+		}
+		app.services = append(app.services, srv)
+	}
+	app.logger.Info("app started")
+
+	return nil
+}
+
+func (app *App) Stop() error {
+	for _, srv := range app.services {
+		if err := srv.Stop(); err != nil {
+			return err
+		}
+	}
+	app.logger.Info("app stopped")
+
+	return nil
+}
diff --git a/internal/app/config.go b/internal/app/config.go
@@ -0,0 +1,18 @@
+package app
+
+import "os"
+
+type Config struct {
+	HTTPAddr string
+}
+
+func NewConfigFromEnv() Config {
+	config := Config{
+		HTTPAddr: ":8080",
+	}
+	httpAddr, ok := os.LookupEnv("HTTP_ADDR")
+	if ok {
+		config.HTTPAddr = httpAddr
+	}
+	return config
+}
diff --git a/internal/app/config_test.go b/internal/app/config_test.go
@@ -0,0 +1,25 @@
+package app
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestNewConfigFromEnv(t *testing.T) {
+	//t.Parallel()
+
+	t.Run("default http address", func(t *testing.T) {
+		//t.Parallel()
+		cfg := NewConfigFromEnv()
+
+		assert.Equal(t, ":8080", cfg.HTTPAddr)
+	})
+
+	t.Run("http address from env", func(t *testing.T) {
+		t.Setenv("HTTP_ADDR", ":7777")
+		cfg := NewConfigFromEnv()
+
+		assert.Equal(t, ":7777", cfg.HTTPAddr)
+	})
+}
diff --git a/internal/coder/coder.go b/internal/coder/coder.go
diff --git a/internal/delivery/http/handler.go b/internal/delivery/http/handler.go
diff --git a/internal/delivery/http/mux.go b/internal/delivery/http/mux.go
diff --git a/internal/delivery/http/server.go b/internal/delivery/http/server.go
