Architecture

In this project structure, the cmd directory contains the entry point of the application, which is the main.go file. The internal directory contains the implementation details of the application, which are divided into three layers:

• api: The api layer contains the input/output logic of the application
• domain: The domain layer contains the business logic and entities of the application
• infrastructure: The infrastructure layer contains the implementation details

Tools

• Make build tool.
• Gin HTTP Web Framework.
• pgx for PostgreSQL Driver.
• Migrate Database migrations CLI.
• Testify Test framework.
• GoMock Mocking framework.
• Github Runner For CI/CD deployment and test.
• Swaggo for generate RESTful API documentation with Swagger 2.0.

Technical Test

1. Create CRUD

Run Product Store Server

First configure environment variable on your local machine or update it on Makefile and app.env, then do db migration for initial db setup

make migrate-up

It will setup db and also insert 20 random product. Then run server

make run

After running the application on localhost visit http://localhost:8080/swagger/index.html#/ for swagger doc of the project, or get the raw swagger json and yaml from docs directory

Test

make test

Please check internal/infrastructure/datastore/pg/brand_test.go for unit test, and internal/api/web/brand_test.go for HTTP API test. Test will be performed automatically on Github Runner, where it will also setup postgresql db test.

Note: As it is a assessment, I am doing here only one test.

2.Product Listing

{{baseUrl}}/v1/products endpoint is exposed for product listing with all criteria implemented

3.Product Listing

{{baseUrl}}/v1/categories endpoint is exposed for category tree with all criteria implemented

4.Run LRU

make lru

For more detail, see internal/domain/algo/lru_test.go

Other Instructions:

• Dockerfile is available on cmd/server/Dockerfile
• Instruction about run this project is available on this README.md
• All API Endpoints, Request Body, Query Params, and Response format are available on docs directory and also available on swagger endpoint
• All the PostgreSQL schema is available on docs directory

SQL Schema

Migrations

run (if not installed)

go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest

To create a new migration

migrate create -ext sql -dir database/migrations -seq name_for_migration

and then edit the new files in /database/migrations.

make migrate-up

for db tear-down

make migrate-down

Schema Dump (if use docker)

docker exec pg-docker pg_dump -U postgres --schema-only --verbose -s technoStore > ts_ddl.sql

GoMock: for mocking definitions

Install gomock

go install go.uber.org/mock/mockgen@latest

Generate mock datastore definition implementation

make mock-db

API(Swagger doc generation)

make swag

Deployment

Docker build

docker build --progress=plain -f ./cmd/server/Dockerfile -t techno-store:latest -t techno-store:0.1 .