Clean Arch Mini Project

This service for testing purposes, to make it easier to connect to other libraries will be using clean architecture

Documentation

Dependencies

1. golang 1.19
2. docker

Clean Architecture Guide

https://github.com/bxcodec/go-clean-arch

this service will have

1. Repository
2. Usecase
3. Domain
4. Controller

every detail that we need in the process will be added later

API contract

testing api documentation with go swagger

https://github.com/go-swagger/go-swagger

install using brew

brew tap go-swagger/go-swagger
brew install go-swagger

serve swagger

swagger serve ./swagger.yaml

Handler

echo

test http handler using echo https://echo.labstack.com/guide/

install

go get github.com/labstack/echo/v4

Testing tools

Testify

to helping assertions will using this tools install

https://github.com/stretchr/testify

Vektra Mockery

source https://github.com/vektra/mockery this libraries is to help making mock domain easier

install

docker pull vektra/mockery

generate mock

mockery --all --keeptree

gomonkey

to help mock method

install

go get github.com/agiledragon/gomonkey/v2@v2.2.0

the problem for monkey patch libraries is currently I can't find any compatible libraries for M1 arm64 architecture. I can use this by changing my goarch in environment variables to amd64, the cons is I can't debug it on VS code in VS code you can add this config in user settings json

"go.toolsEnvVars": {
        "GOARCH":"amd64"
},

Repository

go-chache

for simplicity running project will using in memory cache for testing

installation

go get github.com/patrickmn/go-cache

Sample Case

Booking System

This system will help to provide booking online

Installation

for running this program only need docker by this command

make docker-run
make docker-stop

postman collection link

data sample will be provided by link

the data from API will be breakdown like

    erDiagram
        book }o--o{ author : book_author
        book {
            string id
            string title
            int edition_count
        }
        author {
            string id
            string name
        }
        book }o--o{ subject : book_subject
        subject {
            int id
            string name
        }

        book }o--o{ booking : booking_book
        booking {
            int id
            string book_id
            int user_id
            int quantity
            timestamp book_at
            timestamp return_at
        }

        user }o--o{ booking : user_booking
        user {
            int id
            string name
        }

for simplicity I will remove user for a while

Booking process

    flowchart LR
        Start-->B{book exist?}
        subgraph ide1 [is available]
        B-- Yes-->C{quantity valid?}
        C-- Yes-->D{stock available}
        end
        D -- Yes --> CC[Booking Created ]
        B -- No --> DD[Return Error]
        C -- No --> DD
        D -- No --> DD
        CC -->Stop
        DD -->Stop