EcommerceApp

KO | EN

gitlite — search

#javascript #php #python #java #library #dotfiles #deprecated #ruby #objective-c #ios #go #nodejs

★ 39 Open GitHub ↗

QA Strategy for microservices with Synchronous and Asynchronous communication

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![](https://github.com/teixeira-fernando/EcommerceApp/workflows/JavaCIMaven/badge.svg)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=teixeira-fernando_EcommerceApp&metric=coverage)](https://sonarcloud.io/dashboard?id=teixeira-fernando_EcommerceApp)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=teixeira-fernando_EcommerceApp&metric=bugs)](https://sonarcloud.io/dashboard?id=teixeira-fernando_EcommerceApp)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=teixeira-fernando_EcommerceApp&metric=sqale_index)](https://sonarcloud.io/dashboard?id=teixeira-fernando_EcommerceApp)

![Can I Deploy - Inventory](https://teixeirafernando.pactflow.io/pacticipants/InventoryModule/branches/master/latest-version/can-i-deploy/to-environment/production/badge)

[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=teixeira-fernando_EcommerceApp)](https://sonarcloud.io/dashboard?id=teixeira-fernando_EcommerceApp)

# E-commerce App - Exploring QA strategies for microservices with Synchronous and Asynchronous communication

The initial objective of this project was to further study the differences in the development and implementation of quality strategies for microservices with synchronous and asynchronous communication. I decided to do all the development of the application and the tests from scratch to be able to better observe some details in practice.

## Microservices

* Shop
* Inventory
* Shipment

![alt text](https://raw.githubusercontent.com/teixeira-fernando/EcommerceApp/master/images/EcommerceappDiagram.png "EcommerceApp modules communication")

## Requirements to run it locally

To run it locally, you have two options:

* To Run it using Docker, you need only Docker and Docker compose installed on your machine
* To run using your IDE, you need Java 17 and Maven configured on your machine

## Instructions to run the project

The docker-compose file contains the pre-requisites to run the application: MongoDB and Kafka

It's also necessary to generate some dependencies jars from the modules:

```
mvn clean install
```

Now, you can bring up the docker-compose:

```
docker-compose up -d
```

Or you can also run each application module individually:

Run Inventory:

```
mvn -f inventory/ spring-boot:run 
```

Run Shop:

```
mvn -f shop/ spring-boot:run 
```

Run Shipment:

```
mvn -f shipment/ spring-boot:run 
```

## QA Strategy

* Unit Tests: Junit5 and Mockito
* Integration tests: Spring Boot Test, WireMock and EmbeddedKafka (when testing asynchronous events)
* Quality Metrics:
 * Mutation Tests/Mutation Coverage: PITest
 * Code Coverage: Jacoco
 * Technical Debt, Code Smells and other complementary metrics : Sonar Cloud
* Contract tests: Pact framework
* Continuous Integration: This project uses Github Action for Continuous Integration, where it executes all the tests and Sonar Cloud Analysis for every pull request, making easier the process of integration of every new code, also facilitating the process of Code Review.

## Development technology stack

* Development:
  * Spring Boot 
  * Java 17
  * Maven
* Kafka
* MongoDB
* Github Actions
* Docker

## Pipeline configuration

This repository includes 2 pipelines.

* PR_Pipeline: Runs a build for every created PR, executing the different test suites of the project and validating the code quality of the introduced changes
* release-pipeline: Run after every merge to master branch. It does the release process, including creating and publishing docker images for every project module, tagging the pacts, etc.

## Instructions for contract tests with Pact

This project contains contract tests using Pact. You need to setup your [PactFlow](https://pactflow.io/) account in order to use it.

PS: Be aware of some environment variables you may need to run some of the commands below and also the pipeline:

* PACT_BROKER_URL
  * Correspond to the url of your personal pact flow account
* PACT_BROKER_TOKEN
  * Correspond to the token from your pact flow account with full rights to read and write
* PACT_BROKER_HOST
  * Correspond to the host value of your Pact flow account

### Running the pact tests locally

Besides the CI configuration where the tests are configured to run. You can also run them locally. You need first to also set some of the variables mentioned above.

Then you can go to the producer module and execute the contract tests, to generate the contracts. The pact files will be
written in the target/pact folder. It is configured to automatically publish the pacts into the pact broker.

``` 
mvn -f {folder}/ -Dtest=**/contract/*ConsumerPact test
```

If you want to manually publish the pacts into the pact broker, you can execute the following command:

``` 
mvn pact:publish 
```

Then you can run the contract tests in the provider side, where it is already configured to get it from the pact broker

``` 
mvn -f {folder}/ -Dtest=**/contract/*ProviderPact test
```

## Other info and Utilities

* Install and activate Intellij plugin to format on IDE:
    * https://plugins.jetbrains.com/plugin/8527-google-java-format

* There is a swagger documentation configured for each module. After running the desired module, you can navigate
  to: http://localhost:{port}/swagger-ui/

* Check code Style:

``` 
mvn spotless::check (in the sub-module directory)
```

* Apply code Style:

``` 
mvn spotless::apply (in the sub-module directory)
```

# Articles with more info related to this project

https://medium.com/assertqualityassurance/creating-a-test-strategy-for-asynchronous-microservices-applications-1397f7755e85

EcommerceApp

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README