random-luck

🍀 RANDOM LUCK

This project was created for learning purposes and is a lucky random number generator for Mega Sena

Some tools used do not represent the best choice, they were only used for learning purposes. For example the application can be run as an API where the return will be a JSON or it can be run as a Web where the template package was used

🧰 Dependencies

• Go 1.19+
• Docker
• Docker-compose
• Nginx
• GNU make
• Direnv
  • This is not mandatory but is a easily way to control your environment variable for each project without configuring the variables globally
• Golangci-lint
• Godoc
• Govulncheck
• Viper
  • Configuration solution
• Cobra
  • Library for creating CLI applications
• Gin web framework
• Testify
  • Tools for testifying
• Zap logger
• HTTP expect
  • Used to API test
• Sonarqube

🛠️ Useful commands

You can run the command below to see all the useful commands available and your goals.

make help

help: show this help
setup: run the command mod download and tidy from Go
fmt: run go formatter recursively on all files
lint: run all linters configured
vulncheck: run all vulnerability checks
tests: run all unit tests
pipeline: run all necessary steps to go through the pipeline
cover: run the command tool cover to open coverage file as HTML
sonarqube-up: start sonarqube container
sonarqube-down: stop sonarqube container
sonarqube-analysis: run sonar scanner
build: create an executable of the application
run-api: build project and run the API using the built binary
run-web: build project and run the Web using the built binary
compose-ps: list all containers running
compose-up: start the API
compose-down: stop the API
clean: run the go clean command and removes the application binary
doc: run the project documentation using HTTP

⚙️ Running the Application

To run the project locally you need to export some environment variables and this can be done using direnv. You can export the variables below.

NGINX_PORT='80'
LOG_LEVEL='ERROR'

SONAR_PORT='9000'
SONAR_HOST='http://localhost:9000'
SONAR_LOGIN='admin'
SONAR_PASSWORD='admin'
SONAR_BINARY='sonar-scanner.bat'

If you want to run the application as an API, you need to export the environment variable COMMAND='api', but if you want to run it as a Web, you need to export it as COMMAND='web'. You can do this using direnv.

After exporting the environment variables, you can run the make compose-up command and the application will run on Docker.

• When running as an API, the application will be accessible at http://localhost/process and needs to fill in two parameters:

  • amount_of_games (must be greater than zero)
  • amount_of_numbers_per_game (must be greater than or equal to six and less than or equal to nine)

  curl --location --request GET 'http://localhost/process?amount_of_games=1&amount_of_numbers_per_game=6'
  

• When running as Web the application will be accessible at http://localhost/index and the same parameters as above need to be filled in, but you will do this by following the HTML form.

If you prefer to run outside of docker, just run make run-api(accessible at http://localhost:8888/process) or make run-web (accessible at http://localhost:8888/index).

🪲 Debugging

• If you want to debug the application, in your IDE you need to set the command to api or web as the application is using cobra library.

📜 Running Internal Documentation

You can do this by running the make doc command and going to the address http://localhost:6060.

🎯 How to run sonarqube locally

The project is set up to run sonarqube locally and has three commands in the Makefile. The sonarqube will be downloaded by Docker, but you need to install sonar-scanner following your operating system.

To run sonarqube locally, you need to export the following environment variables. You can do this using direnv.

SONAR_PORT='9000'
SONAR_HOST='http://localhost:9000'
SONAR_LOGIN='admin'
SONAR_PASSWORD='admin'
SONAR_BINARY='Here you need to fill it according to your operational system. Example: sonar-scanner for Linux/MacOS or sonar-scanner.bat for Windows'

After installing and configuring sonar-scanner in $PATH(if needed) you will be able to run the commands below. By running the make sonarqube-up and make sonarqube-analysis commands you can open the http://localhost:9000 address in your browser and login and password as admin(perhaps sonarqube may prompt you to change your password).

sonarqube-up: start sonarqube container
sonarqube-analysis: run sonar scanner
sonarqube-down: stop sonarqube container

🤞 Good Luck...