Skip to content

Update README.md #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rammrain merged 1 commit into from
Apr 15, 2024
Merged

Update README.md #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 27 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,28 @@
# Bitweb Test Library
# Bitweb Spring Core Test library

Given library has helper functions that make it abit easier to test various functionality
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/ee.bitweb/spring-test-core/badge.svg)](https://mvnrepository.com/artifact/ee.bitweb/spring-test-core)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=BitWeb_java-test-core-lib&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=BitWeb_java-test-core-lib)

## Mock server
Given library has helper functions that make it a bit easier to test various functionality.

## Usage

```
// https://mvnrepository.com/artifact/ee.bitweb/spring-test-core
testImplementation group: 'ee.bitweb', name: 'spring-test-core', version: '2.0.0'
```

Review available versions in [Maven Central](https://mvnrepository.com/artifact/ee.bitweb/spring-test-core).

## Documentation

### Mock server

Introducing new class `ee.bitweb.http.server.mock.MockServer` which enables for easier handling of `org.mockserver.integration.ClientAndServer`.
If registered as a JUnit extension, it will control the typical lifecycle of the ClientAndServer class for each class.
Server instance is started on random port and it can be injected to your properties for seamless integration.

### Memory footprint
#### Memory footprint

Using MockServer for each test class can and will affect Spring context, since each Mock Server injects own properties into it.
This is dirty the context and force Spring to rebuild the context. Contexts are held in a Context Cache.
Expand All @@ -20,7 +34,7 @@ will be overridden in the cache.
To reduce the cache size, create a spring.properties file in test scope resources directory. Inside that file add property
`spring.test.context.cache.maxSize=2`.

### Example of general setup
#### Example of general setup

```
@SpringBootTest(classes = {TestSpringApplication.class})
Expand All @@ -39,7 +53,7 @@ class HammasBookingApiCreateBookingTest {
}
```

### Example definition of mock request
#### Example definition of mock request

```
server.mock(
Expand All @@ -55,7 +69,7 @@ For reach request mock, you have specify the HTTP method and path where the requ
These parameters can be supplied to constructor as default values, then you don't have to specify these
values for every test.

## MockMvc Response expectation helpers
### MockMvc Response expectation helpers

Given library provides a set of assertion helpers that correspond to the typical responses defined in
[Bitweb core library](https://bitbucket.bitweb.ee/projects/BITWEB/repos/java-core-lib/browse)
Expand All @@ -78,6 +92,12 @@ Example usage:
);
```

## Release notes

### 2.0.0

Update dependencies for Spring Framework 6

### 1.2.2

Fixed all dependency versions
Expand Down