Feature/22-api-database

.github/workflows/build-test-scan-push-images.yml

@@ -24,6 +24,8 @@ jobs:
           # Add your images here (name of the component + directory that contains Dockerfile)
           - name: frontend
             directory: frontend
+          - name: api
+            directory: api
     runs-on: ubuntu-latest
     permissions:
       contents: write

.gitignore

@@ -1,3 +1,4 @@
 
 api/.idea/
-.idea/
+api/internal/
+.idea/

adrs/03052024-api-database.md

@@ -0,0 +1,24 @@
+# AD: Database for the Api
+**Decider:** Kai Pietruska
+
+## Context and Problem Statement
+Which database do we want to use to save the metadata of the games?
+
+## Decision Drivers
+We want to use a database to save the metadata of our games.
+It should be known to everyone, so that we don't have to learn how to work with it.
+
+
+## Considered Options
+- MySQL
+- Postgresql
+- SQLite
+- MongoDB
+- Apache Cassandra
+
+## Decision Outcome
+MySQL is for our use case sufficient and easy to use.
+
+
+## Consequences
+tbd

adrs/03052024-api-orm.md

@@ -0,0 +1,23 @@
+# AD: Object-Relational Mapper for the api
+**Decider:** Kai Pietruska
+
+## Context and Problem Statement
+What ORM do we use to implement our api?
+
+## Decision Drivers
+We want to use a ORM, so that we don't have to deal with raw SQL queries and we can modify our database easily.
+It should generate SQL queries from Go code, since we already have our Go code.
+
+## Considered Options
+- GORM
+- ent
+- gorp
+
+## Decision Outcome
+gorp because it is lightwight and brings all the features we need for our use case.
+GORM is nice but brings a lot of overhead and features we don't need.
+ent has a steep learning curve.
+
+
+## Consequences
+tbd

adrs/04052024-api-orm.md

@@ -0,0 +1,26 @@
+# AD: Object-Relational Mapper for the api
+**Decider:** Kai Pietruska
+
+## Context and Problem Statement
+What ORM do we use to implement our api?
+
+## Decision Drivers
+We want to use a ORM, so that we don't have to deal with raw SQL queries and we can modify our database easily.
+It should generate SQL queries from Go code, since we already have our Go code.
+
+## Considered Options
+- GORM
+- ent
+- gorp
+
+## Decision Outcome
+We don't use any GORM.
+
+gorp because it is lightwight and brings all the features we need for our use case, theoretically.
+In practical it already failed creating the database and it doesn't support UUID prmary keys out of the box.
+GORM is nice but brings a lot of overhead and features we don't need.
+ent has a steep learning curve.
+
+
+## Consequences
+tbd

api/.dockerignore

@@ -1,3 +1,5 @@
 config.yml
 README.md
-.idea
+.idea
+internal
+docker-compose.yml

api/Dockerfile

@@ -1,25 +1,29 @@
-FROM golang:1.22-alpine
-
+#Stage 1: Compile and build
+FROM golang:1.22-alpine as build
 # Set destination for COPY
 WORKDIR /app
-
 # Download Go modules
 COPY go.mod go.sum ./
 RUN go mod download
-
 # Add the directories which contain the golang scripts
 COPY . .
-COPY config.prod.yml ./config.yml
-
 # Build
 RUN CGO_ENABLED=0 GOOS=linux go build -C cmd -o /api
 
-# Optional:
-# To bind to a TCP port, runtime parameters must be supplied to the docker command.
-# But we can document in the Dockerfile what ports
-# the application is going to listen on by default.
-# https://docs.docker.com/reference/dockerfile/#expose
-EXPOSE 8080
+#Stage 2a: Run tests
+FROM golang:1.22-alpine as test
+WORKDIR /app
+COPY . .
+CMD ["go", "test", "./tests"]
 
+#Stage 2b: Run Api
+FROM scratch as release
+#Copy config
+COPY config.deployment.yml ./config.yml
+#Copy migration scripts
+COPY migrations migrations
+#Copy build result to next stage
+COPY --from=build /api /api
+EXPOSE 8080
 # Run
 CMD ["/api"]

api/README.md

@@ -1,5 +1,4 @@
-## Build the docker container
-``docker build . -t api:latest ``
-## Run the docker container
-``docker run -p 8080:8080 -i api:latest``\
-The api will be exposed to port 8080, access it with `localhost:8080`.
+## TL;DR
+`` docker compose build; `` `` docker compose up ``
+
+The api will be exposed to port 8080, access it with `localhost:8080`. 

api/cmd/main.go

@@ -3,20 +3,23 @@ package main
 import (
 	"api/controllers"
 	"api/repositories"
+	"api/scripts"
 	"api/services"
+	"database/sql"
 	"fmt"
 	"github.com/gin-gonic/gin"
+	_ "github.com/go-sql-driver/mysql"
 	"github.com/spf13/viper"
 	"log"
 	"net/http"
 )
 
-func setupRouter() *gin.Engine {
+func setupRouter(db *sql.DB) *gin.Engine {
 	//Setup Gin
 	r := gin.Default()
 
 	//Setup Repositories
-	gamesRepository := repositories.GameRepository()
+	gamesRepository := repositories.GameRepository(db)
 	gamesService := services.GameService(gamesRepository)
 	gamesController := controllers.GameController(gamesService)
 
@@ -37,23 +40,43 @@ func setupRouter() *gin.Engine {
 	return r
 }
 
-func loadEnv() {
+func loadConfig() {
 	viper.SetConfigFile("config.yml")
 	err := viper.ReadInConfig()
 	if err != nil {
 		log.Fatal(err.Error())
 	}
 }
 
+func setupDatabase() *sql.DB {
+	//Create database if it is not existing yet.
+	//We might have to remove this if we use an azure database
+	scripts.CreateDatabaseIfNotExists(viper.GetString("DATABASE.NAME"))
+	//Connect to the database
+	db := scripts.ConnectToDatabase()
+	//Check if database is online
+	err := db.Ping()
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+	//Check if we have new migrations and apply them
+	scripts.MigrateDatabase(db)
+	return db
+}
+
 func main() {
-	//Load environment file
-	loadEnv()
+	//Load config file
+	loadConfig()
+
+	//Setup database
+	db := setupDatabase()
+	defer db.Close()
 
 	//Set Gin-gonic to debug or release mode
 	gin.SetMode(viper.GetString("GIN_MODE"))
 
 	//Setup Routes
-	r := setupRouter()
+	r := setupRouter(db)
 
 	// Listen and Server in 0.0.0.0:8080
 	r.Run(fmt.Sprintf(":%d", viper.GetInt("port")))

api/config.deployment.yml

@@ -0,0 +1,9 @@
+## PRODUCTIVE CONFIG
+PORT: 8080
+GIN_MODE: release #["release", "debug"]
+DATABASE:
+  NAME: api #database name
+  USER: root #This login name is just for local deployment. TODO set it in productive deployment
+  PASSWORD: Root#123 #This password is just for local deployment. TODO set it in productive deployment
+  HOST: mysql
+  PORT: 3306

api/config.yml

@@ -1,2 +1,9 @@
 PORT: 8080
 GIN_MODE: debug #["release", "debug"]
+DATABASE:
+  NAME: api #database name
+  USER: root #login name
+  PASSWORD: Root#123 #This password is of course not production. Just local deployment
+  HOST: localhost
+  PORT: 3306
+

api/controllers/gameController.go

@@ -3,6 +3,7 @@ package controllers
 import (
 	"api/dtos"
 	"api/services"
+	"database/sql"
 	"fmt"
 	"github.com/dranikpg/dto-mapper"
 	"github.com/gin-gonic/gin"
@@ -49,6 +50,10 @@ func (g gameController) GetGameById(c *gin.Context) {
 			c.JSON(http.StatusInternalServerError, gin.H{"message": err.Error()})
 			return
 		}
+		if game == nil {
+			c.JSON(http.StatusNotFound, gin.H{"message": "Game not found"})
+			return
+		}
 
 		//Map to dto
 		resultDto := dtos.GetGameByIdResponseBody{}
@@ -63,12 +68,18 @@ func (g gameController) GetGameById(c *gin.Context) {
 }
 
 func (g gameController) UploadGame(c *gin.Context) {
+
+	title := c.Query("title")
+	if len(title) == 0 {
+		c.JSON(http.StatusBadRequest, gin.H{"message": "Title is required"})
+	}
+
 	file, err := c.FormFile("file")
 	if err != nil {
 		c.JSON(http.StatusBadRequest, gin.H{"message": err.Error()})
 	}
 
-	_, err = g.service.Save(file)
+	_, err = g.service.Save(file, title)
 
 	if err != nil {
 		c.JSON(http.StatusInternalServerError, gin.H{"message": err.Error()})
@@ -83,6 +94,9 @@ func (g gameController) DeleteGameById(c *gin.Context) {
 	if _uuid != uuid.Nil {
 		err := g.service.Delete(_uuid)
 		if err != nil { //TODO handle different errors
+			if err == sql.ErrNoRows {
+				c.JSON(http.StatusNotFound, gin.H{"message": "Game not found"})
+			}
 			c.JSON(http.StatusInternalServerError, gin.H{"message": err.Error()})
 		} else {
 			c.Status(http.StatusNoContent)

api/docker-compose.yml

@@ -0,0 +1,39 @@
+#The docker-compose is for local deployment.
+#DON'T USE IT IN PRODUCTION IT CONTAINS HARDCODED PASSWORDS
+services:
+  mysql:
+    image: 'bitnami/mysql:8.3.0'
+    environment:
+      - MYSQL_ROOT_USER=root
+      - MYSQL_ROOT_PASSWORD=Root#123
+      - MYSQL_DATABASE=api
+    ports:
+      - "3306:3306"
+    volumes:
+      - ./internal/database:/bitnami/mysql/data
+    networks:
+      - api
+    healthcheck:
+      test: mysql --user=root --password=Root#123 -e 'SELECT * FROM mysql.time_zone'
+    restart: on-failure
+    #command: # fix from https://github.com/bitnami/containers/issues/44854#issuecomment-1800945882
+    #  - "/opt/bitnami/mysql/bin/mysqld"
+    #  - "--defaults-file=/opt/bitnami/mysql/conf/my.cnf"
+    #  - "--basedir=/opt/bitnami/mysql"
+    #  - "--datadir=/bitnami/mysql/data"
+    #  - "--socket=/opt/bitnami/mysql/tmp/mysql.sock"
+    #  - "--pid-file=/opt/bitnami/mysql/tmp/mysqld.pid"
+  api:
+    build: .
+    ports:
+      - "8080:8080"
+    restart: on-failure
+    networks:
+      - api
+    depends_on:
+      mysql:
+        condition: service_healthy
+
+networks:
+  api:
+    driver: bridge

api/go.mod

@@ -3,13 +3,16 @@ module api
 go 1.20
 
 require (
+	github.com/DATA-DOG/go-sqlmock v1.5.2
 	github.com/dranikpg/dto-mapper v0.2.1
 	github.com/gin-gonic/gin v1.9.1
+	github.com/go-sql-driver/mysql v1.8.1
 	github.com/google/uuid v1.4.0
 	github.com/spf13/viper v1.18.2
 )
 
 require (
+	filippo.io/edwards25519 v1.1.0 // indirect
 	github.com/bytedance/sonic v1.11.4 // indirect
 	github.com/cloudwego/base64x v0.1.1 // indirect
 	github.com/cloudwego/iasm v0.1.1 // indirect
@@ -48,6 +51,7 @@ require (
 	golang.org/x/sys v0.19.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
 	google.golang.org/protobuf v1.33.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )