First Iteration

.github/workflows/e2e-tests.yml

@@ -0,0 +1,83 @@
+name: e2e tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+
+  e2etests:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:16.1
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+      redis:
+        image: redis:7
+        ports:
+          - 6379:6379
+
+      minio:
+        image: minio/minio:edge-cicd
+        options: --health-cmd "curl -s http://localhost:9000/minio/health/live"
+        env:
+          MINIO_ROOT_USER: admin
+          MINIO_ROOT_PASSWORD: password
+        ports:
+          - 9000:9000
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: setup db
+        env:
+          PGPASSWORD: postgres
+        run: |
+          psql -h localhost -p 5432  -U postgres -f ./docker/compose/initdb/0001_init.sql
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: install deps
+        run: go mod download
+
+      - name: run tests
+        run: |
+          go test -v -count=1 -cover -coverpkg=./... -coverprofile=profile.cov --tags e2e ./...
+          go tool cover -func=profile.cov
+          go tool cover -func=profile.cov -o=coverage.out
+
+      - name: coverage badge
+        uses: tj-actions/coverage-badge-go@v2
+        with:
+          filename: coverage.out
+
+      - name: verify changed files
+        uses: tj-actions/verify-changed-files@v17
+        id: verify-changed-files
+        with:
+          files: README.md
+
+      - name: push badge
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add README.md
+          git commit -m "chore: update coverage badge"
+          git push

.gitignore

@@ -20,6 +20,8 @@ vendor/
 
 # Reports
 report.xml
+profile.cov
+coverage.html
 
 .DS_Store
 

.mockery.yml

@@ -0,0 +1,11 @@
+quiet: False
+disable-version-string: True
+with-expecter: True
+mockname: "Mock{{.InterfaceName}}"
+filename: "mock_{{.InterfaceName|lower}}_test.go"
+outpkg: "{{.PackageName}}"
+dir: "{{.InterfaceDir}}"
+packages:
+  github.com/adwski/vidi/internal/api/video:
+    interfaces:
+      Store: {}

Makefile

@@ -1,9 +1,24 @@
+.PHONY: mock
+mock:
+	find . -type f -name "mock_*" -exec rm -rf {} +
+	mockery
+
 .PHONY: docker-dev
 docker-dev:
 	cd docker/compose ;\
 	docker compose up -d
 	docker ps
 
+docker-infra:
+	cd docker/compose ;\
+	docker compose -f docker-compose.infra.yml up -d
+	docker ps
+
+docker-infra-clean:
+	cd docker/compose ;\
+	docker compose -f docker-compose.infra.yml down -v
+	docker ps
+
 docker-dev-build:
 	cd docker/compose ;\
 	docker compose up -d --build
@@ -32,3 +47,19 @@ statictest:
 
 test-nginx:
 	docker run --rm -it --entrypoint nginx -v ./docker/compose/nginx.conf:/etc/nginx/nginx.conf nginx:1.25.3-bookworm -t
+
+.PHONY: unittests
+unittests:
+	go test -v -count=1 ./...
+
+.PHONY: cover
+cover:
+	go tool cover -html profile.cov -o coverage.html
+
+
+.PHONY: test-all
+test-all: docker-infra
+	go test -v -count=1 -cover -coverpkg=./... -coverprofile=profile.cov --tags e2e ./...
+	go tool cover -func profile.cov
+	$(MAKE) cover
+	$(MAKE) docker-infra-clean

README.md

@@ -1,5 +1,7 @@
 ## Vidi
 
+![Coverage](https://img.shields.io/badge/Coverage-80.4%25-brightgreen)
+
 WIP
 
 This is a final project for Yandex Practicum's Go Course.
@@ -30,6 +32,17 @@ make docker-dev
 make docker-dev-clean
 ```
 
+### Tests
+
+```bash
+# run unit tests
+make unittests
+
+# run unit and end2end tests
+# docker compose project should be stopped (it will be ran by the command)
+make test-all
+```
+
 ### Happy Path
 
 User interaction flow is described [here](./docs/happy_path.md).

docker/compose/.env

@@ -1,2 +1,2 @@
 COMPOSE_PROJECT_NAME=vidi-dev
-COMPOSE_FILE=docker-compose.infra.yml:docker-compose.api.yml:docker-compose.media.yml
+COMPOSE_FILE=docker-compose.infra.yml:docker-compose.api.yml:docker-compose.media.yml:docker-compose.nginx.yml

docker/compose/docker-compose.api.yml

@@ -18,7 +18,6 @@ services:
     environment:
       VIDI_API_PREFIX: /api/users
       VIDI_DATABASE_DSN: postgres://userapi:userapi@postgres:5432/userapi?sslmode=disable
-      VIDI_DATABASE_SALT: q1w2e3r4t5
       VIDI_SERVER_ADDRESS: ":8080"
     expose:
       - 8080

docker/compose/docker-compose.infra.yml

@@ -8,18 +8,6 @@ x-logging: &logging
     max-file: "5"
 
 services:
-  nginx:
-    logging: *logging
-    restart: unless-stopped
-    image: nginx:1.25.3-bookworm
-    volumes:
-      - "./nginx.conf:/etc/nginx/nginx.conf:ro"
-      - "./player:/var/www/player:ro"
-    ports:
-      - "8080:80"
-    networks:
-      - vidi
-
   minio:
     logging: *logging
     restart: unless-stopped
@@ -48,7 +36,7 @@ services:
       - "vidi-db:/var/lib/postgresql/data"
       - "./initdb:/docker-entrypoint-initdb.d:ro"
     ports:
-      - "5400:5432"
+      - "5432:5432"
     networks:
       - vidi
 

docker/compose/docker-compose.nginx.yml

@@ -0,0 +1,26 @@
+---
+version: "3.8"
+
+x-logging: &logging
+  driver: "json-file"
+  options:
+    max-size: "100k"
+    max-file: "5"
+
+services:
+  nginx:
+    logging: *logging
+    restart: unless-stopped
+    image: nginx:1.25.3-bookworm
+    volumes:
+      - "./nginx.conf:/etc/nginx/nginx.conf:ro"
+      - "./player:/var/www/player:ro"
+    ports:
+      - "8080:80"
+    networks:
+      - vidi
+
+networks:
+  vidi:
+    name: vidi-net
+    driver: bridge