city-route-calculator

This system is provided by two main micro-services. Both written in Java with Spring Boot framework.

Both microservices are projected to be a docker image, but you can also start in a local way for better debbugging and fast response.

You can find two main subfolders here, each one being a separated micro-service.

cities-registry
route-calculator

NOTE: Route-calculator will rely on informations provided from cities-registry, if cities-registry is not available, route-calculator have a circuit-breaker mechanism that prevent user to have some mistaken error information, so a default fallback method is triggered returning no path available, when cities-registry is reachable again, everything starts to work properly again.

Project details

Scope and definitions

There are two micro-services in this project, cities-registry and route-calculator.

The cities-registry is responsible to list all available cities and connections between cities. In this micro-service users can list, insert and delete new cities and new connections. In each connection user can inform the time to travel between any connection.

The route-calculator is responsible to calculate a route from any given city to another and show the info in two ways, it shows the minimum path in connections and also shows the minimum time to travel from a city to another (it also show the path that is made to have the minimum time)

All routes calculated in the route-calculator are using Dijkstra Algorithm

Build and process

This project is using travis to ensure all builds are passing. Also it uses codebeat to have a static analysis tool to indicate where the code could be improved.

HTTPS communication

All data is handled with https connections, even between services. The route-calculator have the cities-registry certificate and validate it to certify that the connection is done with the right certificate, in this way if some other service try to act as a fake cities-registry, the certificate validation will not allow the route-calculator to communicate with a 'alien' cities-registry.

To see how its done, you can see the implementation on the class:

route-calculator/src/main/java/com/marcelofrau/springboot/routecalculator/configuration/SSLVerificationConfig.java

Authentication

To authenticate you can use the user:

username: user, password: user (with the role USER)
username: admin, password: admin (with the role ADMIN)
username: route-calculator, password: route-calculator (with the role USER, but is intended to be used internally in the route-calculator service)

The role USER

Users with the role USER can read all the data from all the micro-services, but they have no permission to include or delete any data.

The role ADMIN

Users with the role ADMIN can do all the stuff, list, include, delete any data.

Running in docker with docker-compose

To start using the docker-compose.yaml you must run the following commands:

Accessing the microservices (in docker environment)

To access each micro-service you can access directly in your browser. But if you want to test the API is strongly recommended that you have a tool like Postman or Insomnia to test the provided REST API services.

Building and running all micro-services (using docker-compose)

To start every micro-service using the docker-compose.yml file, you can do it using the following commands:

./gradlew dockerBuild
docker-compose build
docker-compose up

Two main services will be open, one in a 8443 port and another in 8444, you can check more info below on how to access each micro-service.

NOTE: Please run the commands above in the root folder of this project.

cities-registry (docker build)

If you want you can start each service individually in docker. You can achieve that using the following command:

cd cities-registry
./gradlew dockerRun

route-calculator (docker build)

If you want you can start each service individually in docker. You can achieve that using the following command:

cd route-calculator
./gradlew dockerRun

Accessing the micro-services (docker)

NOTE: Please replace 192.168.99.100 with your docker ip.

cities-registry (docker access)

cities-registry access the API (docker access)

cities-registry access the Documentation API (Swagger UI Interface, docker access)

https://192.168.99.100:8444/swagger-ui.html

route-calculator (docker access)

To see all the available usage, please refer to the Swagger Documentation API

route-calculator access the API (docker access)

https://192.168.99.100:8443/calculate-route/

route-calculator access the Documentation API (Swagger UI Interface, docker access)

https://192.168.99.100:8443/swagger-ui.html

Running without docker (locally)

Follow the below instructions to start each microservice in a local way. In this way you can debug more easily and test a local configurations in your environment. This is intended to have a better and a fast way to develop the micro-services, but the main intention is to run it in a dockerized way. If you want please see the section above of this one explaining on how to run in docker.

Building and running (local)

To build you must be on a environment with JDK8 installed. This is the only pre-requisite. Take note that if you are using Windows environment, the initial executable ./gradlew must be run as gradlew.bat

You will only be able to run the route-calculator micro-service if you also starts the cities-registry. Too see how you can access API documentations or the services itself, please reach the accessing the micro-services section.