bernardosecades/test

Test

Purchase Test

, _(*1)

Run project in your local

docker-compose up -d, _(*2)

You can check if all is running with:, _(*3)

docker-compose ps, _(*4)

Note: This will stop all containers and remove them (if you have some lock file with mysql problem):, _(*5)

docker stop $(docker ps -a -q) docker rm $(docker ps -a -q), _(*6)

BloomRPC:, _(*7)

localhost:3333, _(*8)

Load in BloomRPC the file proto/protobuf/api/purchase.proto:, _(*9)

, _(*10)

Structure folder project

.docker: we have dockerfiles for each binary, in this case only have api dockerfile, the worker folder is an example if we had other binaries., _(*11)

.github/workflows: we have the workflow test.yml with two jobs executing in the pipeline of github (execute in parallel: unit and e2e test), _(*12)

cmd: we have the main files for each binary, in this case only have api, the worker folder is an example if we had other binaries., _(*13)

platform: - k8s: here we have folder for kubernetes with helm chart files for integration and production environment. It is empty but is to show the structure of each microservice - local: here only we have the schema.sql loaded in docker-compose to use in local environment and in the pipeline of github., _(*14)

proto: we have proto file to define contracts, they are located in proto/protobuf and the folder proto/go contains protocol buffers compiled to go language., _(*15)

internal: we have controllers for grpc purchase service and the package purchase. As well we have kit package with helpers to work with uuids and load fixtures in E2E/Integration tests., _(*16)

Makefile

makefile help, _(*17)

makefile test-unit: execute inside of container test with tag: unit., _(*18)

makefile test-e2e: execute inside of container test with tag: e2e., _(*19)

makefile test-all: execute inside of container test with tag: unit and e2e., _(*20)

makefile lint: execut linter with fix to go language., _(*21)

Compile protocol buffers

we have the folder proto, this folder can be in other repository and use it like dependency but to simplify we have all in the same repository., _(*22)

Read readme file: README.md, _(*23)

Inside of the folder proto we have a Makefile so to compile the purchase.proto file:, _(*24)

cd proto make proto, _(*25)

And this will generate the folder proto/go/protobuf/api with file purchase.pb.go., _(*26)

Note: in this case we generate to go language but we can modify the Makefile to compile for java, phyton, ..., _(*27)