Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wavesoftware/java-gasper
Very simple integration testing JUnit harness for 'java -jar' servers like WildFly Swarm and Spring Boot
https://github.com/wavesoftware/java-gasper
Last synced: about 12 hours ago
JSON representation
Very simple integration testing JUnit harness for 'java -jar' servers like WildFly Swarm and Spring Boot
- Host: GitHub
- URL: https://github.com/wavesoftware/java-gasper
- Owner: wavesoftware
- License: apache-2.0
- Created: 2016-03-05T13:13:38.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-01-06T18:04:01.000Z (11 months ago)
- Last Synced: 2024-10-19T03:18:27.535Z (about 1 month ago)
- Language: Java
- Homepage: http://wavesoftware.github.io/java-gasper
- Size: 96.7 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gasper!
[](https://travis-ci.org/wavesoftware/java-gasper) [](https://coveralls.io/github/wavesoftware/java-gasper?branch=develop) [](https://www.codacy.com/app/krzysztof-suszynski/java-gasper) [](https://sonar.wavesoftware.pl/dashboard?id=pl.wavesoftware%3Agasper) [](https://sonar.wavesoftware.pl/dashboard?id=pl.wavesoftware%3Agasper) [](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22pl.wavesoftware%22%20AND%20a%3A%22gasper%22) [](https://gitter.im/wavesoftware/java-gasper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Gasper is a very simple integration testing JUnit harness for `java -jar` servers like [WildFly Swarm](http://wildfly-swarm.io/) and [Spring Boot](http://projects.spring.io/spring-boot/).
[](http://wildfly-swarm.io/) [](http://projects.spring.io/spring-boot/)
Gasper provides a simple to use JUnit `TestRule` that can be used to build integration tests with simple apps, like REST micro-services. You can configure Gasper easily with a builder interface. Gasper will start the application before test class and stop it after tests completes.
Gasper supports currently only [Maven](https://maven.apache.org/). The `pom.xml` file is used to read project configuration achieving zero configuration operation.
## Usage
Gasper utilize your packaged application. It It means it should be used in integration tests that run after application is being packaged by build tool (Maven). Add this code to your `pom.xml` file (if you didn't done that before):
```xml
[..]
[..]
org.apache.maven.plugins
maven-failsafe-plugin
2.19.1
integration-test
verify
[..]
[..]
```
Place your integration tests in classes that ends with `*IT` or `*ITest`.
### WildFly Swarm configuration
```java
@ClassRule
public static Gasper gasper = Gasper.configurations()
.wildflySwarm()
.build();
```
### Spring Boot configuration
```java
@ClassRule
public static Gasper gasper = Gasper.configurations()
.springBoot()
.build();
```
Before running `GasperBuilder.build()` method, you can reconfigure those default configurations to your needs.
### Example test method (Unirest + JSONAssert)
Gasper is best to use with libraries like [Unirest](http://unirest.io/java.html) for fetching data and asserting HTTP/S statuses and [JSON Assert](https://github.com/marcingrzejszczak/jsonassert) to validate correctness of JSON output for REST services.
```java
@Test
public void testGetRoot() throws UnirestException {
// given
String address = gasper.getAddress(); // Address to deployed app, running live on random port
String expectedMessage = "WildFly Swarm!";
// when
HttpResponse response = Unirest.get(address).asString();
// then
assertThat(response.getStatus()).isEqualTo(200);
assertThat(response.getBody()).field("hello").isEqualTo(expectedMessage); // JSON Assert
}
```
### Additional configuration
To configure Gasper use `GasperBuilder` interface, for ex.:
```java
private final int port = 11909;
private final String webContext = "/test";
private final String systemPropertyForPort = "swarm.http.port";
@ClassRule
public static Gasper gasper = Gasper.configure()
.silentGasperMessages()
.usingSystemPropertyForPort(systemPropertyForPort)
.withSystemProperty("swarm.context.path", webContext)
.withSystemProperty(systemPropertyForPort, String.valueOf(port))
.withJVMOptions("-server", "-Xms1G", "-Xmx1G", "-XX:+UseConcMarkSweepGC")
.withMaxStartupTime(100)
.withMaxDeploymentTime(20)
.withEnvironmentVariable("jdbc.password", "S3CreT!1")
.withTestApplicationLoggingOnConsole()
.usingPomFile(Paths.get("pom.xml"))
.withArtifactPackaging("jar")
.waitForWebContext(webContext)
.withArtifactClassifier("swarm")
.usingWebContextChecker(GasperBuilderTest::checkContext)
.withPort(port)
.build();
```
## Installation
### Maven
```xml
pl.wavesoftware
gasper
1.0.0
test
```
## Contributing
Contributions are welcome!
To contribute, follow the standard [git flow](http://danielkummer.github.io/git-flow-cheatsheet/) of:
1. Fork it
1. Create your feature branch (`git checkout -b feature/my-new-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin feature/my-new-feature`)
1. Create new Pull Request
Even if you can't contribute code, if you have an idea for an improvement please open an [issue](https://github.com/wavesoftware/java-gasper/issues).
## Requirements
* Java 8
* Maven 3
## Releases
* `1.0.0` - codename: *SkyMango*
* First publicly available release