Testing Microservices in Spring

This repository contains a Spring Boot application with lots of exemplary tests on different levels of the Test Pyramid. It shows an opinionated way to thoroughly test your spring application by demonstrating different types and levels of testing. You will find that some of the tests are duplicated along the test pyramid -- concepts that have already been tested in lower-level tests will be tested in more high-level tests. This contradicts the premise of the test pyramid. In this case it helps showcasing different kinds of tests which is the main goal of this repository.

Read the Blog Post

This repository is part of a series of blog posts I wrote about testing microservices. I highly recommend you read them to get a better feeling for what it takes to test microservices and how you can implement a reliable test suite for a Spring Boot microservice application.

Get started

1. Set an API Key as Environment Variable

In order to run the service, you need to set the WEATHER_API_KEY environment variable to a valid API key retrieved from ~~darksky.net~~ openweathermap.org.

Note: in a previous version this example used darksky.net as the weather API. Since they've shut down their API for public access, we've since switched over to openweathermap.org

A simple way is to rename the env.sample file to .env, fill in your API key from openweathermap.org and source it before running your application:

source .env

2. Start a PostgreSQL database

The easiest way is to use the provided startDatabase.sh script. This script starts a Docker container which contains a database with the following configuration:

port: 15432
username: testuser
password: password
database name: postgres

If you don't want to use the script make sure to have a database with the same configuration or modify your application.properties.

3. Run the Application

Once you've provided the API key and started a PostgreSQL database you can run the application using

./gradlew bootRun

The application will start on port 8080 so you can send a sample request to http://localhost:8080/hello to see if you're up and running.

Application Architecture

 ╭┄┄┄┄┄┄┄╮      ┌──────────┐      ┌──────────┐
 ┆   ☁   ┆  ←→  │    ☕     │  ←→  │    💾     │
 ┆  Web  ┆ HTTP │  Spring  │      │ Database │
 ╰┄┄┄┄┄┄┄╯      │  Service │      └──────────┘
                └──────────┘
                     ↑ JSON/HTTP
                     ↓
                ┌──────────┐
                │    ☁     │
                │ Weather  │
                │   API    │
                └──────────┘

The sample application is almost as easy as it gets. It stores Persons in an in-memory database (using Spring Data) and provides a REST interface with three endpoints:

GET /hello: Returns "Hello World!". Always.
GET /hello/{lastname}: Looks up the person with lastname as its last name and returns "Hello {Firstname} {Lastname}" if that person is found.
GET /weather: Calls a downstream weather API via HTTP and returns a summary for the current weather conditions in Hamburg, Germany

Internal Architecture

The Spring Service itself has a pretty common internal architecture:

Controller classes provide REST endpoints and deal with HTTP requests and responses
Repository classes interface with the database and take care of writing and reading data to/from persistent storage
Client classes talk to other APIs, in our case it fetches JSON via HTTP from the openweathermap.org weather API

Request  ┌────────── Spring Service ───────────┐
 ─────────→ ┌─────────────┐    ┌─────────────┐ │   ┌─────────────┐
 ←───────── │  Controller │ ←→ │  Repository │←──→ │  Database   │
Response │  └─────────────┘    └─────────────┘ │   └─────────────┘
         │         ↓                           │
         │    ┌──────────┐                     │
         │    │  Client  │                     │
         │    └──────────┘                     │
         └─────────│───────────────────────────┘
                   │
                   ↓   
              ┌──────────┐
              │    ☁     │
              │ Weather  │
              │   API    │
              └──────────┘

Test Layers

The example applicationn shows different test layers according to the Test Pyramid.

      ╱╲
  End-to-End
    ╱────╲
   ╱ Inte-╲
  ╱ gration╲
 ╱──────────╲
╱   Unit     ╲
──────────────

The base of the pyramid is made up of unit tests. They should make the biggest part of your automated test suite.

The next layer, integration tests, test all places where your application serializes or deserializes data. Your service's REST API, Repositories or calling third-party services are good examples. This codebase contains example for all of these tests.

 ╭┄┄┄┄┄┄┄╮      ┌──────────┐      ┌──────────┐
 ┆   ☁   ┆  ←→  │    ☕     │  ←→  │    💾     │
 ┆  Web  ┆      │  Spring  │      │ Database │
 ╰┄┄┄┄┄┄┄╯      │  Service │      └──────────┘
                └──────────┘

  │    Controller     │      Repository      │
  └─── Integration ───┴──── Integration ─────┘

  │                                          │
  └────────────── Acceptance ────────────────┘

 ┌─────────┐  ─┐
 │    ☁    │   │
 │ Weather │   │
 │   API   │   │
 │  Stub   │   │
 └─────────┘   │ Client
      ↑        │ Integration
      ↓        │ Test
 ┌──────────┐  │
 │    ☕     │  │
 │  Spring  │  │
 │  Service │  │
 └──────────┘ ─┘

Tools

You can find lots of different tools, frameworks and libraries being used in the different examples:

Spring Boot: application framework
JUnit: test runner
Hamcrest Matchers: assertions
Mockito: test doubles (mocks, stubs)
MockMVC: testing Spring MVC controllers
RestAssured: testing the service end to end via HTTP
Wiremock: provide HTTP stubs for downstream services

sinanulug34/spring-testing