restful-test-instances

This project presents a several examples of the tests usage in relation to a spring rest service grouped by modules. Each module presents a small simple test instance of the rest service layer.

📇 Table of Contents

About
Features
Getting Started
Built With
Authors
Licensing

📖 About

This is a collection of small and focused instances - each covering a single and well defined approach in the area of the java application development grouped by modules. Each module is supposed to provide a separate simple instance. In this project each module presents a small simple instance of the unit test for the one java technology. For instance, configuration files, db layer tests, service layer tests, controller layser tests and integration tests. A strong focus of these is, of course, the different test approaches of the spring-boot RESTful API.

Modules

This project includes the follows modules:

restful-test-instances-organisations - this module is a simple spring-boot RESTful API which provides the create/read/update/delete operations for the manipulating organization entities;
restful-test-instances-db-local-test - this module presents unit tests of the API model layer. For this tests is used the local database;
restful-test-instances-db-embedded-test - this module presents unit tests of the API model layer. For this tests is used the embedded H2 database;
restful-test-instances-db-testcontainers-test - this module presents unit tests of the API model layer. For this tests is used the postgreSQL database on the docker container;
restful-test-instances-service-test - this module presents unit tests of the API service layer;

🎚 Features

The simple RESTful API which provides to create/read/update/delete operations.
A tests for the RESTful API part grouped by modules.

To Do

For more information on an upcoming development, please read the todo list.

Changelog

For more information on a releases, a features and a changes, please read the changelog notes.

🚦 Getting Started

These instructions allow to get a copy of this project and run it on a local machine.

Prerequisites

Before using it, make sure that follows software are installed on the local machine:

Oracle JDK 8+ - java development kit;
Maven 3+ - dependency management;
Docker Compose - tool for defining and running multi-container Docker applications.

If any of the listed software is not installed, then it can be installed by instruction as described below.

Oracle JDK 8+
- Install Oracle JDK 8+ according to instructions from an official instruction.
Maven 3+
- Install Maven 3+ according to instructions from an official source.
Docker Compose
- Install PostgreSQL 9+ according to instructions from an official source.

Installing

In order to install it is quite simple to clone or download this repository.

Cloning

For the cloning this repository to a local machine, just use the follows link:

https://github.com/ololx/restful-test-instances

Using

To use it is necessary to: 1 - To deploy the additional software. 2 - To build the project. 3 - To launch the instances.

Deploy the additional software

1 - To do the deployment of the additional software, execute docker compose in the root directory by the following command:

docker-compose up

2 - Wait for all software deployment to complete.

Building the project

To do the full build, execute maven goal install in the root directory by the following command:

mvn clean install

Building a single module

To do the full build, execute maven goal install in the module directory by the following command:

mvn clean install

Launching in command line

To do the full tests examples, execute maven goal test in the module directory by the following command:

mvn test

Launching in IDE

This is a multi-module project. Each model is supposed to provide a separate example. That's why when you're working with an individual module, there's no need to import all of them (or build all of them) - you can simply import that particular module in either Eclipse, NetBeanse or IntelliJ IDEA and run each example in IDE.

🛠 Built With

Oracle JDK - java development kit;
Maven - dependency management;
PostgreSQL 9+ - database management system;
Docker Compose - tool for defining and running multi-container Docker applications.

©️ Authors

Alexander A. Kropotin - project work - ololx.

🔏 Licensing

This project is licensed under the MIT license - see the lisence document for details.

innopolis-university-java-team/restful-test-instances