products is a REST API for products able to consume that from a Kafka server
products persistence is a MondgoDB database.
To install it on Ubuntu follow the official instructions
Once installed, create a database and name it, for e.g. "products".
A nice tool to work with MongoDb is the MongoDB cli, robomongo
Packages of products are managed using dep
To install dep on a linux OS environment run
$ curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
Check here for more information on how to install dep
$ dep ensure -add github.com/pkg/errors # Get a package and add to dependencies
$ dep ensure # Install all packages and dependencies listed in Gopkg.toml
Check here for an unofficial concise guide to dep Check here for official documentation about dep
products uses Environment Variables(EV) to load some configurations prior ro run the application, these EV should be provided to the environment, e.g.:
export HOST=localhost:8069 ; export MONGO_HOST=mongodb://localhost:27017 ; export MONGO_DATABASE=products ; go run main.go
In order to perform some usefull tasks like running the server or running unit tests, a Makefile.dist is available. Copy Makefile.dist file:
cp Makefile.dist Makefile
Now it's possible to run the server by typing command
make run
This file may evolve, for e.g. due to new environment variables needed to the app. Just edit this file according to your specific needs and use it to create new commands.
products Api Documentation is written with Api Blueprint
To generate the api documentation it's used aglio
Both these dependencies are installed through npm. Install if it's not available in your OS. Once npm is installed, to install aglio run
$ npm install -g aglio
Find more about aglio here
To generate api Documentation, execute this command from the root folder
$ aglio -i docs/blueprint/index.apib -o docs/generated/docs.html
Docs will be available in {{root_path}}/docs/generated/docs.html
Both a Postman collection and a Postman environment is provided under
$ <project dir>/docs/postman
Unit Tests can be run using Go commands. Check here for official documentation about Go testing
But the easiest way is using provided Makefile command. To run all unit tests just type command
$ make test
To run all unit tests and get access to a coverage report
$ make cover
Coverage report will appear in a browser tab. Switch between files through the dropdown that will appear at the top of the page.
A nice way to debug your application is using VSCode debug features. A .vscode folder with launch configurations (launch.json) and IDE setting (settings.json) is provided.
In order to runn your application in debug mode:
- Hit Debug on VSCode left panel
- Select "Debug Program" from dropdown on top bar of Debug panel
- Hit "Play" Button
App will start in debug mode.
In order to debug unit tests, repeat the same steps but, on point 2., instead of choosing "Debug Program", choose "Launch Tests". An alternative to this is, on unit test file, click on actions suggested by VSCode. It will appear "run package tests | run file tests" on top of package name on function names. This will happen if Go extension is installed (ms-vscode.go).