Review PR

.gitignore

@@ -17,6 +17,7 @@ cmd/gophermart/gophermart
 
 # Dependency directories (remove the comment below to include it)
 vendor/
+build/*
 
 # IDEs directories
 .idea

DRAFT.md

@@ -0,0 +1,212 @@
+# Gofermart
+
+## Use cases
+
+![Use cases](./use_cases.png "Use cases")
+<details>
+  <summary>plant uml code of image</summary>
+
+```puml
+@startuml
+skinparam actorStyle awesome
+
+legend right
+| Color           | Mean                         |
+|                  | to implement |
+|<#lightyellow>    | are not in the task                  |
+endlegend
+
+left to right direction
+
+actor "User" as U
+
+package "Система лояльности" as M {
+    usecase "регистрация/авторизация" as M_RA
+    usecase "отправить номер заказа"as M_SON
+    usecase "получить статус начисления по заказу" as M_GOS
+    usecase "списать балы" as M_DB
+    usecase "получить все списания" as M_DH
+}
+
+package "Система расчетов балов(aka accrual)" as ACR #lightyellow {
+    usecase "Зарегестрировать номер заказа" as A_RON
+    usecase "Расчитать балы лояльности по заказу" as A_CB
+}
+package "Online shop" as OS #lightyellow {
+    usecase "Купить" as OS_B
+}
+
+U ..> M_RA : 3
+U ..> M_SON : 4
+M_SON ..> A_CB : 5
+U ..> M_GOS : 6
+U ..> M_DB : 7
+U ..> OS_B : 1
+OS_B ..> A_RON : 2
+U ..> M_DH : 8
+
+@enduml
+```
+
+</details>
+
+## Model
+
+![Model](./model.png "Model")
+
+<details>
+  <summary>plant uml code of image</summary>
+
+```puml
+@startuml
+
+title model
+namespace Gofermart {
+    entity "User" as U {
+        id int
+        login string
+        pwd string
+    }
+    entity "Order" as O1 {
+        id int
+        userId int
+        orderNumber string
+        status int
+        accrualStatus: int
+        accrual Money
+        created_at datetime
+    }
+'    entity "BalanceAction" as BA {
+'        value uint
+'        type int (enum: \n\
+'        1 = пополнение на основе\n\
+'        добавление заказа;\n\
+'        2 = списание по инициативе\n\
+'        пользователя.\n)
+'        orderId int (default = 0 - нет заказа)
+'    }
+
+    entity "Withdrawal" as W {
+        id int
+        userId int
+        orderNumber string
+        amount Money
+        created_at datetime
+    }
+}
+
+namespace Accrual {
+    entity "Order" as O2 {
+        + orderNumber string
+        + status string
+        + accrual null|int
+    }
+}
+
+U "1" *-d- "many" O1 : create >
+'U "1" *-d- "many" BA : read >
+'O1 "1" -l- "1" BA : add >
+U "1" *-d- "many" W : create >
+
+O1 "1"--"1" O2 : read >
+
+@enduml
+```
+
+</details>
+
+## Classes
+![Classes](./classes.png "Classes")
+
+<details>
+  <summary>plant uml code of image</summary>
+
+```puml
+@startuml
+
+package "Business" as BL {
+    package "Services" as BL.S{
+        class "OrderService" as BL.S.OS  {
+            + AddOrder()
+            + GetAllOrdersByUserID()
+            + UpdateOrdersStatuses()
+        }
+        class "WithdrawalService" as BL.S.WS {
+            + AddWithdrawal()
+            + GetAllWithdrawalsByUserID()
+        }
+        class "UserService" as BL.S.US {
+            + CreateNewUser()
+            + GetUserIfPwdValid()
+            + GetBalance()
+        }
+
+        package "Contract" as BL.S.C {
+            interface "OrderRepositoryInterface" as BL.S.C.ORI {}
+            interface "UserRepositoryInterface" as BL.S.C.URI {}
+            interface "WithdrawalRepositoryInterface" as BL.S.C.WRI {}
+            BL.S.C.WRI -[hidden]-> BL.S.C.URI
+            BL.S.C.URI -[hidden]-> BL.S.C.ORI
+         }
+         BL.S.WS -[hidden]-> BL.S.US
+         BL.S.US -[hidden]-> BL.S.OS
+
+         BL.S.OS -o  BL.S.C.ORI
+         BL.S.WS -o  BL.S.C.WRI
+
+         BL.S.US -lo  BL.S.C.URI
+         BL.S.US -lo  BL.S.C.ORI
+         BL.S.US -lo  BL.S.C.WRI
+
+    }
+    package "Entities" as BL.E {
+'        class "User" as U {}
+'        class "Order" as O {}
+'        class "Withdrawal" as W {}
+'        U *-- O 
+'        note left on link : Заказ был\nдобавлен\nпользователем
+'        U *-- W 
+'        note left on link : Списание было\nдобавлено\nпользователем
+    }
+}
+class "UserController" as UC {
+    login()
+    register()
+    orderList()
+    addOrder()
+    balance()
+    withdraw()
+    withdrawalList()
+}
+
+package "Repositories" as R {
+    class "OrderRepository" as R.OR {}
+    class "UserRepository" as R.UR {}
+    class "WithdrawalRepository" as R.WR {}
+    R.WR -[hidden]-> R.UR
+    R.UR -[hidden]-> R.OR
+}
+
+BL.S -l-o UC
+BL.E o-- BL.S
+BL.S.C.ORI <|. R.OR 
+BL.S.C.URI <|. R.UR 
+BL.S.C.WRI <|. R.WR 
+
+@enduml
+```
+
+</details>
+
+## Status mapping on accrual
+
+NEW — заказ загружен в систему, но не попал в обработку;
+PROCESSING — вознаграждение за заказ рассчитывается; 200(REGISTERED|PROCESSING)
+INVALID — система расчёта вознаграждений отказала в расчёте; 200(INVALID), 204
+PROCESSED — данные по заказу проверены и информация о расчёте успешно получена. 200(PROCESSED) 
+
+### Accrual statuses
+REGISTERED — заказ зарегистрирован, но не начисление не рассчитано;
+INVALID — заказ не принят к расчёту, и вознаграждение не будет начислено;
+PROCESSING — расчёт начисления в процессе;
+PROCESSED — расчёт начисления окончен;

Makefile

@@ -0,0 +1,23 @@
+help: ## Display this help screen
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+test: test-unit test-func ## run all tests
+test-unit: ## run unit tests
+	go test -v ./tests/Unit/...
+	echo "\033[1;32mUNIT SUCCESS\033[0m"
+test-func: ## run functional tests. Be sure to up DB.
+	go test -v ./tests/Functional/...
+	echo "\033[1;32mFUNCTIONAL SUCCESS\033[0m"
+build-binary: ## build binary file of the application
+	go build -o ./build/gophermart ./cmd/gophermart/main.go
+run-binary: ## run binary file of the application
+	./build/gophermart
+docker-build-n-run: docker-build docker-run
+docker-build:
+	docker image rm gophermart-img || true
+	docker build -f docker-files/dev/gophermart/Dockerfile -t gophermart-img --target prod .
+docker-run:
+	docker run -it --rm gophermart-img
+mockgen: # generate mocks for project
+	mockgen -source ./internal/service/contracts.go -destination ./tests/mock/mock_service.go -package mock_contracts
+	mockgen -source ./pkg/contracts/logger_interface.go -destination ./tests/mock/pkg_contracts.go -package mock_contracts
+

cmd/gophermart/main.go

@@ -1,3 +1,39 @@
 package main
 
-func main() {}
+import (
+	"context"
+	_ "github.com/jackc/pgx/v5/stdlib"
+	"github.com/rs/zerolog"
+	"github.com/smamykin/gofermart/internal/container"
+	"github.com/smamykin/gofermart/pkg/utils"
+	"os"
+)
+
+var logger = zerolog.New(os.Stdout)
+
+func main() {
+
+	c, err := container.NewContainer(&logger)
+	if err != nil {
+		logger.Error().Err(err).Msgf("error while building container")
+		return
+	}
+	defer c.Close()
+
+	logger.Info().Msgf("service started with configuration %#v", c.Config())
+
+	ctx, cancel := context.WithCancel(context.Background())
+	go utils.InvokeFunctionWithInterval(ctx, c.Config().UpdateStatusInterval, func() {
+		logger.Info().Msgf("update of statuses is started")
+		err := c.OrderService().UpdateOrdersStatuses()
+		if err != nil {
+			logger.Error().Err(err).Msgf("cannot update status")
+			cancel()
+		}
+	})
+
+	err = c.Router().Run(c.Config().ServerAddr)
+	if err != nil {
+		logger.Error().Msgf("error while running server. error: %s\n", err.Error())
+	}
+}

docker-compose.yaml

@@ -0,0 +1,44 @@
+version: '3.5'
+services:
+  accrual:
+    build:
+      context: .
+      dockerfile: docker-files/dev/accrual/Dockerfile
+    depends_on:
+      - postgres
+    ports:
+      - "8080:8080"
+    environment:
+      DATABASE_URI: "postgres://postgres:postgres@postgres:5432/postgres"
+#      RUN_ADDRESS: "localhost:8080"
+  gophermart:
+    build:
+      context: .
+      dockerfile: docker-files/dev/gophermart/Dockerfile
+      target: dev
+    environment:
+      DATABASE_URI: "postgres://postgres:postgres@postgres:5432/postgres"
+      ACCRUAL_SYSTEM_ADDRESS: "http://accrual:8080"
+    volumes:
+      - ./:/app
+    depends_on:
+      - postgres
+    ports:
+      - "8888:8888"
+  postgres:
+    image: postgres:15-alpine3.17
+    ports:
+      - "54323:5432"
+    environment:
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_USER: postgres
+      PGDATA: /postgresql/data
+    volumes:
+      - pgdata:/postgresql/data:rw
+      # image runs any .sh, .sql, .sql.gz files in this directory (only if database is empty yet)
+      # Warning: scripts in /docker-entrypoint-initdb.d are only run if you start the container with a data directory that is empty; any pre-existing database will be left untouched on container startup. One common problem is that if one of your /docker-entrypoint-initdb.d scripts fails (which will cause the entrypoint script to exit) and your orchestrator restarts the container with the already initialized data directory, it will not continue on with your scripts.
+      - ./migrations/init:/docker-entrypoint-initdb.d
+
+volumes:
+  pgdata:
+    driver: local

docker-files/dev/accrual/Dockerfile

@@ -0,0 +1,12 @@
+FROM ubuntu:20.04
+
+COPY ./cmd/accrual/accrual_linux_amd64 /app/accrual/accrual_linux_amd64
+
+ENV RUN_ADDRESS=0.0.0.0:8080
+
+EXPOSE 8080
+
+WORKDIR /app
+
+
+CMD ["/app/accrual/accrual_linux_amd64", "-a", "$RUN_ADDRESS"]

docker-files/dev/gophermart/Dockerfile

@@ -0,0 +1,47 @@
+FROM golang:1.20-alpine3.17 as dev
+
+
+ENV UID=1000
+ENV GID=1000
+ENV USER=www-data
+ENV GROUP=www-data
+
+RUN apk add --update make
+
+RUN adduser -S $USER -G $GROUP
+
+RUN set -xe \
+    && apk --no-cache add shadow \
+    && usermod -u $UID $USER && groupmod -g $GID $GROUP \
+    && apk del shadow
+
+
+
+WORKDIR /app
+
+COPY go.mod ./
+COPY go.sum ./
+
+RUN go mod download
+COPY ./cmd ./cmd
+COPY ./internal ./internal
+COPY ./migrations ./migrations
+COPY ./pkg ./pkg
+COPY ./Makefile ./Makefile
+COPY ./build ./build
+
+RUN make build-binary
+
+RUN chown $USER:$GROUP . /tmp
+
+USER $USER
+
+EXPOSE 8080
+
+CMD [ "go", "run", "./cmd/gophermart/main.go"]
+
+FROM alpine:3.17 as prod
+
+COPY --from=dev /app/build/gophermart /gophermart
+
+CMD [ "/gophermart" ]