Merge pull request #23 from go-park-mail-ru/TP-c01_ci-cd

Tp c01 ci cd

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: Start pinspire CI
+
+on:
+  workflow_dispatch: {}
+  push: {}
+  pull_request:
+    types: [opened, edited, reopened]
+    branches: [main, dev4]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get repository code
+        uses: actions/checkout@v4
+      - name: Test application
+        continue-on-error: true
+        run: go test ./...
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get repository code
+        uses: actions/checkout@v4
+      - name: Lint application
+        run: make lint
+  build:  
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get repository code
+        uses: actions/checkout@v4    
+      - name: Build application
+        run: make build_all

.github/workflows/deployment.yml

@@ -0,0 +1,61 @@
+name: Start Pinspire deployment
+
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - TP-c01_ci-cd
+      - dev4
+  pull_request:
+    types: [opened, edited, reopened]
+    branches: [main, dev4]
+
+jobs:
+  build_images:
+    runs-on: ubuntu-latest
+    steps:
+      - name: get repository code
+        uses: actions/checkout@v4
+      - name: Login to DockerHub Registry
+        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u ${{ secrets.DOCKERHUB_USERNAME }} --password-stdin
+      - name: Build docker images of services
+        run: |
+          docker build -t pinspireapp/main:latest -f deployments/Dockerfile.main . &
+          docker build -t pinspireapp/auth:latest -f deployments/Dockerfile.auth . &
+          docker build -t pinspireapp/realtime:latest -f deployments/Dockerfile.realtime . &
+          docker build -t pinspireapp/messenger:latest -f deployments/Dockerfile.messenger . &
+          for p in $(jobs -p); do wait "$p" || { echo "job $p failed" >&2; exit; }; done
+      - name: Push docker images
+        run: |
+          docker push pinspireapp/main:latest &
+          docker push pinspireapp/auth:latest &
+          docker push pinspireapp/realtime:latest &
+          docker push pinspireapp/messenger:latest &
+          for p in $(jobs -p); do wait "$p" || { echo "job $p failed" >&2; exit; }; done
+  
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build_images
+    steps:
+      - name: fetch changes
+        uses: appleboy/ssh-action@master
+        with:
+          host: pinspire.online
+          username: ${{ secrets.REMOTE_USERNAME }}
+          key: ${{ secrets.PRIVATE_KEY }}
+          script: |
+            cd ${{ secrets.PINSPIRE_BACKEND_PATH }}
+            sudo git switch TP-c01_ci-cd
+            sudo git pull
+      - name: deploy application
+        uses: appleboy/ssh-action@master
+        with:
+          host: pinspire.online
+          username: ${{ secrets.REMOTE_USERNAME }}
+          key: ${{ secrets.PRIVATE_KEY }}
+          script: |
+            cd ${{ secrets.PINSPIRE_BACKEND_PATH }}/deployments 
+            sudo docker compose down main_service auth_service realtime_service messenger_service
+            sudo docker rmi pinspireapp/main:latest pinspireapp/auth:latest pinspireapp/realtime:latest pinspireapp/messenger:latest
+            sudo docker compose -f docker-compose.yml -f compose.prod.yml up -d
+      

.gitignore

@@ -25,3 +25,5 @@ testdata/
 cert/
 .env
 redis.conf
+inventory
+script*

Makefile

@@ -1,12 +1,18 @@
 .PHONY: build run test test_with_coverage cleantest retest doc generate cover_all currcover
-.PHONY: build_auth  build_realtime build_messenger
+.PHONY: build_auth  build_realtime build_messenger build_all
+.PHONY: .install-linter lint lint-fast
 
 ENTRYPOINT=cmd/app/main.go
 DOC_DIR=./docs
 COV_OUT=coverage.out
 COV_HTML=coverage.html
 CURRCOVER=github.com/go-park-mail-ru/2023_2_OND_team/internal/pkg/delivery/http/v1
 
+PROJECT_DIR = $(shell pwd)
+PROJECT_BIN = $(PROJECT_DIR)/bin
+$(shell [ -f bin ] || mkdir -p $(PROJECT_BIN))
+GOLANGCI_LINT = $(PROJECT_BIN)/golangci-lint
+
 build:
 	go build -o bin/app cmd/app/*.go
 
@@ -19,6 +25,8 @@ build_realtime:
 build_messenger:
 	go build -o bin/messenger cmd/messenger/*.go
 
+build_all: build build_auth build_realtime build_messenger
+
 run: build
 	./bin/app
 
@@ -51,3 +59,11 @@ currcover:
 	go test -cover -v -coverprofile=cover.out ${CURRCOVER}
 	go tool cover -html=cover.out -o cover.html
 
+.install-linter:
+	[ -f $(PROJECT_BIN)/golangci-lint ] || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(PROJECT_BIN) v1.55.2
+
+lint: .install-linter
+	$(GOLANGCI_LINT) run ./... --config=configs/.golangci.yml
+
+lint-fast: .install-linter
+	$(GOLANGCI_LINT) run ./... --fast --config=configs/.golangci.yml

cmd/app/config.go

@@ -1,8 +1,12 @@
 package main
 
-import "github.com/go-park-mail-ru/2023_2_OND_team/internal/app"
+import (
+	"os"
+
+	"github.com/go-park-mail-ru/2023_2_OND_team/internal/app"
+)
 
 var configFiles = app.ConfigFiles{
 	ServerConfigFile: "configs/config.yml",
-	AddrAuthServer:   "localhost:8085",
+	AddrAuthServer:   os.Getenv("AUTH_SERVICE_HOST") + ":" + os.Getenv("AUTH_SERVICE_PORT"), // "localhost:8085",
 }

cmd/auth/config.go

@@ -3,6 +3,6 @@ package main
 import "github.com/go-park-mail-ru/2023_2_OND_team/internal/app/auth"
 
 var configAuth = auth.Config{
-	Addr:            "localhost:8085",
+	Addr:            "0.0.0.0:8085",
 	RedisFileConfig: "redis.conf",
 }

cmd/realtime/main.go

@@ -11,11 +11,13 @@ import (
 	grpcMetrics "github.com/go-park-mail-ru/2023_2_OND_team/internal/pkg/metrics/grpc"
 	"github.com/go-park-mail-ru/2023_2_OND_team/internal/pkg/middleware/grpc/interceptor"
 	"github.com/go-park-mail-ru/2023_2_OND_team/pkg/logger"
+	"github.com/joho/godotenv"
 )
 
-const _address = "localhost:8090"
+const _address = "0.0.0.0:8090"
 
 func main() {
+	godotenv.Load()
 	log, err := logger.New()
 	if err != nil {
 		fmt.Println(err)

configs/.golangci.yml

@@ -0,0 +1,206 @@
+# This code is licensed under the terms of the MIT license https://opensource.org/license/mit
+# Copyright (c) 2021 Marat Reymers
+
+## Golden config for golangci-lint v1.55.2
+#
+# This is the best config for golangci-lint based on my experience and opinion.
+# It is very strict, but not extremely strict.
+# Feel free to adapt and change it for your needs.
+
+run:
+  # Timeout for analysis, e.g. 30s, 5m.
+  # Default: 1m
+  timeout: 3m
+  skip-dirs:
+    - ..
+
+
+
+# This file contains only configs which differ from defaults.
+# All possible options can be found here https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
+linters-settings:
+  cyclop:
+    # The maximal code complexity to report.
+    # Default: 10
+    max-complexity: 30
+    # The maximal average package complexity.
+    # If it's higher than 0.0 (float) the check is enabled
+    # Default: 0.0
+    package-average: 10.0
+
+  errcheck:
+    # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
+    # Such cases aren't reported by default.
+    # Default: false
+    check-type-assertions: true
+
+  exhaustive:
+    # Program elements to check for exhaustiveness.
+    # Default: [ switch ]
+    check:
+      - switch
+      - map
+
+  exhaustruct:
+    # List of regular expressions to exclude struct packages and names from check.
+    # Default: []
+    exclude:
+      # std libs
+      - "^net/http.Client$"
+      - "^net/http.Cookie$"
+      - "^net/http.Request$"
+      - "^net/http.Response$"
+      - "^net/http.Server$"
+      - "^net/http.Transport$"
+      - "^net/url.URL$"
+      - "^os/exec.Cmd$"
+      - "^reflect.StructField$"
+      # public libs
+      - "^github.com/Shopify/sarama.Config$"
+      - "^github.com/Shopify/sarama.ProducerMessage$"
+      - "^github.com/mitchellh/mapstructure.DecoderConfig$"
+      - "^github.com/prometheus/client_golang/.+Opts$"
+      - "^github.com/spf13/cobra.Command$"
+      - "^github.com/spf13/cobra.CompletionOptions$"
+      - "^github.com/stretchr/testify/mock.Mock$"
+      - "^github.com/testcontainers/testcontainers-go.+Request$"
+      - "^github.com/testcontainers/testcontainers-go.FromDockerfile$"
+      - "^golang.org/x/tools/go/analysis.Analyzer$"
+      - "^google.golang.org/protobuf/.+Options$"
+      - "^gopkg.in/yaml.v3.Node$"
+
+  funlen:
+    # Checks the number of lines in a function.
+    # If lower than 0, disable the check.
+    # Default: 60
+    lines: 100
+    # Checks the number of statements in a function.
+    # If lower than 0, disable the check.
+    # Default: 40
+    statements: 50
+    # Ignore comments when counting lines.
+    # Default false
+    ignore-comments: true
+
+  gocognit:
+    # Minimal code complexity to report.
+    # Default: 30 (but we recommend 10-20)
+    min-complexity: 20
+
+  gocritic:
+    # Settings passed to gocritic.
+    # The settings key is the name of a supported gocritic checker.
+    # The list of supported checkers can be find in https://go-critic.github.io/overview.
+    settings:
+      captLocal:
+        # Whether to restrict checker to params only.
+        # Default: true
+        paramsOnly: false
+      underef:
+        # Whether to skip (*x).method() calls where x is a pointer receiver.
+        # Default: true
+        skipRecvDeref: false
+
+  gomnd:
+    # List of function patterns to exclude from analysis.
+    # Values always ignored: `time.Date`,
+    # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,
+    # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.
+    # Default: []
+    ignored-functions:
+      - flag.Arg
+      - flag.Duration.*
+      - flag.Float.*
+      - flag.Int.*
+      - flag.Uint.*
+      - os.Chmod
+      - os.Mkdir.*
+      - os.OpenFile
+      - os.WriteFile
+      - prometheus.ExponentialBuckets.*
+      - prometheus.LinearBuckets
+
+  gomodguard:
+    blocked:
+      # List of blocked modules.
+      # Default: []
+      modules:
+        - github.com/golang/protobuf:
+            recommendations:
+              - google.golang.org/protobuf
+            reason: "see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules"
+        - github.com/satori/go.uuid:
+            recommendations:
+              - github.com/google/uuid
+            reason: "satori's package is not maintained"
+        - github.com/gofrs/uuid:
+            recommendations:
+              - github.com/google/uuid
+            reason: "gofrs' package is not go module"
+
+  govet:
+    # Enable all analyzers.
+    # Default: false
+    enable-all: true
+    # Disable analyzers by name.
+    # Run `go tool vet help` to see all analyzers.
+    # Default: []
+    disable:
+      - fieldalignment # too strict
+    # Settings per analyzer.
+    settings:
+      shadow:
+        # Whether to be strict about shadowing; can be noisy.
+        # Default: false
+        strict: true
+
+  nakedret:
+    # Make an issue if func has more lines of code than this setting, and it has naked returns.
+    # Default: 30
+    max-func-lines: 0
+
+  nolintlint:
+    # Exclude following linters from requiring an explanation.
+    # Default: []
+    allow-no-explanation: [ funlen, gocognit, lll ]
+    # Enable to require an explanation of nonzero length after each nolint directive.
+    # Default: false
+    require-explanation: true
+    # Enable to require nolint directives to mention the specific linter being suppressed.
+    # Default: false
+    require-specific: true
+
+  rowserrcheck:
+    # database/sql is always checked
+    # Default: []
+    packages:
+      - github.com/jmoiron/sqlx
+
+  tenv:
+    # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
+    # Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
+    # Default: false
+    all: true
+
+
+issues:
+  # Maximum count of issues with the same text.
+  # Set to 0 to disable.
+  # Default: 3
+  exclude-use-default: true
+  max-same-issues: 50
+
+  exclude-rules:
+    - source: "(noinspection|TODO)"
+      linters: [ godot ]
+    - source: "//noinspection"
+      linters: [ gocritic ]
+    - path: "_test\\.go"
+      linters:
+        - bodyclose
+        - dupl
+        - funlen
+        - goconst
+        - gosec
+        - noctx
+        - wrapcheck

configs/config.yml

@@ -1,7 +1,7 @@
 app:
   server:
-    host: 127.0.0.1
+    host: 0.0.0.0
     port: 8080
-    https: false
+    https: true
     certFile: /home/ond_team/cert/fullchain.pem
     keyFile: /home/ond_team/cert/privkey.pem