Chore: Adhere To Awesome Go Guidelines

.github/workflows/tests.yml → .github/workflows/ci.yml

@@ -1,38 +1,18 @@
-name: Tests
+name: ci
 
 on:
   pull_request:
     paths-ignore:
       - '**.md'
       - 'docs/**'
-    branches:
-      - master
-
-  workflow_call:
-    inputs:
-      checkout-ref:
-        type: string
-        required: true
-    secrets:
-      github-token:
-        required: true
-      SOLUTIONS_TEAM_SLACK_WEBHOOK:
-        required: true
 
 jobs:
-  build:
-    name: Run Test Build All
+  build-all:
+    name: Test Build All Container Images
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Current Commit
-        if: github.event_name != 'workflow_call'
-        uses: actions/checkout@v2
-
-      - name: Checkout Using `checkout-ref`
-        if: github.event_name == 'workflow_call'
-        uses: actions/checkout@v2
-        with:
-          ref: ${{ inputs.checkout-ref }}
+        uses: actions/checkout@v3
 
       - name: Run Build All
         run: make test-build-all
@@ -50,20 +30,17 @@ jobs:
           username: "ci/cd-reporter"
           url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
           commit: true
-          token: ${{ secrets.GITHUB_TOKEN || secrets.github-token }}
-  test:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  run-tests:
     name: Run Automated Tests
+    needs: build-all
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - name: Checkout Current Commit
-        if: github.event_name != 'workflow_call'
-        uses: actions/checkout@v2
-
-      - name: Checkout Using `checkout-ref`
-        if: github.event_name == 'workflow_call'
-        uses: actions/checkout@v2
-        with:
-          ref: ${{ inputs.checkout-ref }}
+        uses: actions/checkout@v3
 
       - name: Run Automated Tests
         run: make test
@@ -81,4 +58,4 @@ jobs:
           username: "ci/cd-reporter"
           url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
           commit: true
-          token: ${{ secrets.GITHUB_TOKEN || secrets.github-token }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/coverage-badge.yml

@@ -0,0 +1,61 @@
+name: coverage-badge
+
+on:
+  push:
+    paths-ignore:
+      - 'Makefile'
+      - '**.md'
+      - 'docs/**'
+    branches: 
+      - master
+
+jobs:
+  gen-badge:
+    name: Generate Coverage Badge
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Current Commit
+        uses: actions/checkout@v3
+
+      - name: Generate Coverage Report
+        run: make test
+
+      - name: Install Go
+        uses: actions/[email protected]
+
+      - name: Install gobadge
+        run: go install github.com/AlexBeauchemin/gobadge@latest
+
+      - name: Generate Coverage Badge
+        run: |
+          # generate coverage badge
+          gobadge \
+            -filename=./.output/cov-report/coverage.out \
+            -green=80 \
+            -target=README.md \
+            -text=coverage \
+            -link=./.output/cov-report/coverage.out
+
+      - name: Auto Commit & Push Coverage Badge
+        uses: stefanzweifel/git-auto-commit-action@v4
+        id: auto-commit-action
+        with:
+          commit_message: "chore: update coverage report & apply coverage badge to README.md"
+          file_pattern: 'README.md .output/cov-report/coverage.out'
+
+      - name: Notify To Slack If Failed
+        uses: lazy-actions/[email protected]
+        if: failure()
+        with:
+          type: ${{ job.status }}
+          job_name: "*[hex-monscape]* ${{ github.job }}"
+          mention: "here"
+          mention_if: "failure"
+          channel: "#solutions-team-ci-cd"
+          icon_emoji: ":haraaj:"
+          username: "ci/cd-reporter"
+          url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
+          commit: true
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/deploy.yml

@@ -1,4 +1,4 @@
-name: Build & Deploy
+name: deploy
 
 on:
   push:
@@ -10,43 +10,51 @@ on:
       - master
 
 jobs:
-  run-test:
-    uses: ./.github/workflows/tests.yml
-    name: Run Tests
-    with:
-      checkout-ref: ${{ github.sha }}
-    secrets:
-      github-token: ${{ secrets.GITHUB_TOKEN }}
-      SOLUTIONS_TEAM_SLACK_WEBHOOK: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
-
   preparation:
-    name: Prepare Environment
-    needs: run-test
+    name: Prepare Deployment
     runs-on: ubuntu-latest
     outputs:
-      deploy-game: ${{ (steps.changes.outputs.lambda == 'true') || (steps.changes.outputs.all == 'true') }}
+      deploy-game: ${{ (steps.changes.outputs.deploy-game == 'true') }}
     steps:
-      - name: Checkout Latest Commit
-        uses: actions/checkout@v2
+      - name: Checkout Current Commit
+        uses: actions/checkout@v3
+
+      - name: Run Automated Tests
+        run: make test
+
       - name: Determine Changes
         uses: dorny/paths-filter@v2
         id: changes
         with:
           base: ${{ github.ref }}
           filters: |
-            all:
+            deploy-game:
               - "internal/**"
               - ".github/workflows/deploy-dev.yml"
               - ".github/workflows/run-tests.yml"
               - "go.mod"
               - "go.sum"
-            lambda:
               - "build/package/lambda/**"
               - "cmd/lambda/**"
               - "internal/driven/storage/dynamodb/**"
               - "deploy/aws/lambda/infras.yml"
               - "deploy/aws/lambda/service.yml"
 
+      - name: Notify To Slack If Failed
+        uses: lazy-actions/[email protected]
+        if: failure()
+        with:
+          type: ${{ job.status }}
+          job_name: "*[hex-monscape]* ${{ github.job }}"
+          mention: "here"
+          mention_if: "failure"
+          channel: "#solutions-team-ci-cd"
+          icon_emoji: ":haraaj:"
+          username: "ci/cd-reporter"
+          url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
+          commit: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+
   deploy-game:
     name: Deploy Game
     needs: preparation
@@ -57,7 +65,7 @@ jobs:
       INFRA_STACK_NAME_DEV: hex-monscape-infras
     steps:
       - name: Checkout Current Commit
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v1

.gitignore

@@ -1,3 +1,2 @@
 .vscode
-**/*.DS_Store
-.tmp
+**/*.DS_Store

.output/.gitignore

@@ -0,0 +1,4 @@
+*
+!.gitignore
+!cov-report/
+!cov-report/*

.output/cov-report/README.md

@@ -0,0 +1,5 @@
+# Coverage Report
+
+The [coverage.out](./coverage.out) file was generated by [this command](../../build/package/tests/Dockerfile#L11). It will be automatically updated when [ci.yaml](../../.github/workflows/ci.yml) workflow is triggered.
+
+The coverage report is one of the requirements for submitting this project to [Awesome Go](https://github.com/avelino/awesome-go).

.output/cov-report/coverage.out

@@ -0,0 +1,80 @@
+github.com/Haraj-backend/hex-monscape/internal/core/entity/battle.go:24:				PartnerAttack			80.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/battle.go:48:				PartnerSurrender		100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/battle.go:60:				EnemyAttack			80.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/battle.go:83:				IsEnded				100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/battle.go:90:				DecideTurn			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/battle.go:128:				Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/battle.go:133:				NewBattle			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/game.go:32:					Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/game.go:40:					AdvanceScenario			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/game.go:57:					IncBattleWon			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/game.go:62:					NewGame				100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/monster.go:14:				ResetBattleStats		0.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/monster.go:18:				IsDead				100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/monster.go:24:				InflictDamage			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/entity/monster.go:38:				max				66.7%
+github.com/Haraj-backend/hex-monscape/internal/core/service/battle/service.go:52:			StartBattle			75.0%
+github.com/Haraj-backend/hex-monscape/internal/core/service/battle/service.go:90:			GetBattle			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/service/battle/service.go:103:			getGameAndBattleInstance	72.7%
+github.com/Haraj-backend/hex-monscape/internal/core/service/battle/service.go:121:			DecideTurn			56.2%
+github.com/Haraj-backend/hex-monscape/internal/core/service/battle/service.go:146:			Attack				52.4%
+github.com/Haraj-backend/hex-monscape/internal/core/service/battle/service.go:178:			Surrender			66.7%
+github.com/Haraj-backend/hex-monscape/internal/core/service/battle/service.go:203:			Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/service/battle/service.go:208:			NewService			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/service/play/service.go:36:				GetAvailablePartners		75.0%
+github.com/Haraj-backend/hex-monscape/internal/core/service/play/service.go:44:				NewGame				69.2%
+github.com/Haraj-backend/hex-monscape/internal/core/service/play/service.go:71:				GetGame				83.3%
+github.com/Haraj-backend/hex-monscape/internal/core/service/play/service.go:88:				Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/core/service/play/service.go:93:				NewService			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/battlestrg/model.go:14:		toDDBKey			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/battlestrg/model.go:27:		toBattleRow			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/battlestrg/model.go:40:		toBattle			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/battlestrg/storage.go:19:	GetBattle			84.6%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/battlestrg/storage.go:46:	SaveBattle			83.3%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/battlestrg/storage.go:67:	Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/battlestrg/storage.go:72:	New				80.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/gamestrg/model.go:14:		toDDBKey			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/gamestrg/model.go:28:		toGameRow			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/gamestrg/model.go:39:		toGame				100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/gamestrg/storage.go:19:		GetGame				83.3%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/gamestrg/storage.go:44:		SaveGame			83.3%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/gamestrg/storage.go:64:		Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/gamestrg/storage.go:69:		New				80.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/monstrg/model.go:16:		toDDBKey			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/monstrg/model.go:21:		toMonsters			87.5%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/monstrg/storage.go:16:		New				80.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/monstrg/storage.go:33:		GetAvailablePartners		71.4%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/monstrg/storage.go:55:		GetPossibleEnemies		66.7%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/monstrg/storage.go:71:		GetPartner			81.8%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/dynamodb/monstrg/storage.go:99:		Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/battlestrg/storage.go:13:		GetBattle			75.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/battlestrg/storage.go:21:		SaveBattle			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/battlestrg/storage.go:26:		New				100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/gamestrg/storage.go:13:		GetGame				75.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/gamestrg/storage.go:21:		SaveGame			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/gamestrg/storage.go:26:		New				100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/monstrg/model.go:19:		toMonster			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/monstrg/storage.go:17:		GetAvailablePartners		100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/monstrg/storage.go:25:		GetPartner			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/monstrg/storage.go:33:		GetPossibleEnemies		100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/monstrg/storage.go:45:		Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/memory/monstrg/storage.go:49:		New				86.7%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/battlestrg/model.go:30:		ToBattle			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/battlestrg/model.go:65:		newBattleRow			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/battlestrg/storage.go:21:		Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/battlestrg/storage.go:25:		New				80.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/battlestrg/storage.go:34:		GetBattle			85.7%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/battlestrg/storage.go:46:		SaveBattle			83.3%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/gamestrg/model.go:17:		ToGame				100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/gamestrg/model.go:28:		NewGameRow			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/gamestrg/storage.go:21:		Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/gamestrg/storage.go:25:		New				80.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/gamestrg/storage.go:34:		GetGame				85.7%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/gamestrg/storage.go:67:		SaveGame			83.3%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/monstrg/storage.go:22:		Validate			100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/monstrg/storage.go:31:		New				80.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/monstrg/storage.go:40:		GetAvailablePartners		100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/monstrg/storage.go:44:		GetPossibleEnemies		100.0%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/monstrg/storage.go:48:		GetPartner			85.7%
+github.com/Haraj-backend/hex-monscape/internal/driven/storage/mysql/monstrg/storage.go:75:		getMonsterByRole		72.7%
+total:													(statements)			82.2%

README.md

@@ -1,6 +1,8 @@
 # Hex Monscape 👾
 
-[![Build & Deploy](https://github.com/Haraj-backend/hex-monscape/actions/workflows/deploy.yml/badge.svg)](https://github.com/Haraj-backend/hex-monscape/actions/workflows/deploy.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Go Report Card](https://goreportcard.com/badge/github.com/Haraj-backend/hex-monscape)](https://goreportcard.com/report/github.com/Haraj-backend/hex-monscape)
+[![Go Reference](https://pkg.go.dev/badge/github.com/Haraj-backend/hex-monscape.svg)](https://pkg.go.dev/github.com/Haraj-backend/hex-monscape)
+[![Go Report Card](https://goreportcard.com/badge/github.com/Haraj-backend/hex-monscape)](https://goreportcard.com/report/github.com/Haraj-backend/hex-monscape)
+[![coverage](https://img.shields.io/badge/coverage-82.2%25-brightgreen)](./.output/cov-report/coverage.out)
 
 Welcome to this repo!
 

build/package/server/.air.toml

@@ -1,9 +1,9 @@
 root = "."
-tmp_dir = ".tmp/air"
+tmp_dir = ".output/air"
 
 [build]
-  bin = "./.tmp/air/server"
-  cmd = "go build -o ./.tmp/air/server ./cmd/server/*.go"
+  bin = "./.output/air/server"
+  cmd = "go build -o ./.output/air/server ./cmd/server/*.go"
   delay = 1000
   exclude_dir = ["tmp", "vendor", "docs", "deploy"]
   exclude_file = []

build/package/server/Dockerfile

@@ -2,7 +2,7 @@ FROM golang:1.20.5-alpine3.18 as build
 WORKDIR /go/src/github.com/Haraj-backend/hex-monscape
 
 RUN go install github.com/cosmtrek/[email protected]
-RUN mkdir -p .tmp
+RUN mkdir -p .output
 
 COPY go.mod go.sum ./
 RUN go mod download -x

build/package/tests/Dockerfile

@@ -4,4 +4,8 @@ WORKDIR /go/src/github.com/Haraj-backend/hex-monscape
 COPY go.mod go.sum ./
 RUN go mod download -x
 
-COPY ./internal ./internal
+RUN mkdir -p .cov-report
+
+COPY ./internal ./internal
+
+CMD go test ./... -covermode=count -coverprofile=./.cov-report/coverage.out fmt && go tool cover -func=./.cov-report/coverage.out -o=./.cov-report/coverage.out

deploy/local/run/lambda/docker-compose.yml

@@ -27,7 +27,7 @@ services:
     volumes:
       - ../../../../internal:/go/src/github.com/Haraj-backend/hex-monscape/internal
       - ../../../../cmd/lambda:/go/src/github.com/Haraj-backend/hex-monscape/cmd/lambda
-      - ../../../../.tmp/go/pkg:/go/pkg
+      - ../../../../.output/go/pkg:/go/pkg
     environment:
       - LOCALSTACK_ENDPOINT=http://localstack:4566
       - DYNAMODB_BATTLE_TABLE=battle

deploy/local/run/rest-dynamodb/docker-compose.yml

@@ -29,7 +29,7 @@ services:
     volumes:
       - ../../../../internal:/go/src/github.com/Haraj-backend/hex-monscape/internal
       - ../../../../cmd/server:/go/src/github.com/Haraj-backend/hex-monscape/cmd/server
-      - ../../../../.tmp/go/pkg:/go/pkg
+      - ../../../../.output/go/pkg:/go/pkg
     environment:
       - STORAGE_TYPE=dynamodb
       - STORAGE_DYNAMODB_LOCALSTACK_ENDPOINT=http://localstack:4566

deploy/local/run/rest-memory/docker-compose.yml

@@ -11,7 +11,7 @@ services:
     volumes:
       - ../../../../internal:/go/src/github.com/Haraj-backend/hex-monscape/internal
       - ../../../../cmd/server:/go/src/github.com/Haraj-backend/hex-monscape/cmd/server
-      - ../../../../.tmp/go/pkg:/go/pkg
+      - ../../../../.output/go/pkg:/go/pkg
       - ./data.json:/data/data.json
     ports:
       - 9186:9186