This is a backend microservice which provides services to interact with 'orders'.

This is merely a very simple "entity-driven" microservice as it is just purely a CRUD wrapper.

Currently, this microservice allows users to:

• Create new items
• Fetch list of all items

This microservice connects to a NoSQL Key/Value Redis datastore.

• Java 8
• Spring:
  • Spring Boot
  • Spring Data Redis
  • Spring Security
    • JWT
• Redis
• Swagger
• Maven
• Docker:
  • Docker Compose
• RestAssured
• TestContainers

Run directly from your IDE or from CLI using following command:

./mvnw spring-boot:run

for the backed Redis datastore, launch a docker container for it (via Docker-Compose):

docker-compose up -d product-service-db-redis

You can run this microservice in "Development mode" which is a mode that allows firing up the Order Service tech stack. This mode can be used for simple demo with the team or for functional testing by QAs/Testers.

This sub project is docker-composed to achieve this:

docker-compose up -d --build

[TBD]

[TBD]

This following section explains the what/how of the project lifecycle phases.

Coding as you please.

Unit Testing is done using JUnit 5 which comes prebundled with Spring Boot.

Your IDE should provide first class support for writing the unit tests.

Run unit tests directly from IDE or from CLI using the following command:

./mvnw clean test

Using RestAssured to test the controller API endpoints in a fully integrated environment (i.e. the full Spring Application Context is started up).

Using the TestContainers project to launch docker container of Redis in order for Spring framework to connect to it in the tests.

./mvnw clean verify

First require to build a jar artifact:

./mvnw clean install

Then construct the Docker image:

docker build -t order-service .

You can access the documentation for the API using Swagger:

http:https://{order-service-url}:8082/swagger-ui.html

For doing functional testing of this microservice you can use a http client. I like to use Postman.

All of the API endpoints of this microservice are authenticated and thus require the user to be authorized to execute them. See Authenticated section below.

As this whole project uses JWT (JSON Web Tokens) for authentication, it is required to get a valid JWT token first from the User-Service.

User-Service maintains a list of valid users of the Sales Order System application so it is required to have a valid user to use for it to return a valid JWT token. If required, sign up a new user. Please see User Service for more details on this setup.

Once obtained a valid JWT token, first make a request to:

http:https://{user-service-url}:8080/authenticate

with the following body in request:

{
    "username": [a valid username here],
    "password": [a valid password here]
}

Http Client Postman handles most header defaults for you but if using other mechanism such as Curl then must ensure:

• Content-Type of 'application/json' is set