Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshka/junit-json-params
JUnit 5 JSON Parameterized Tests library
https://github.com/joshka/junit-json-params
java json jsonp junit-json junit5 parameterized-tests unit-testing
Last synced: 10 days ago
JSON representation
JUnit 5 JSON Parameterized Tests library
- Host: GitHub
- URL: https://github.com/joshka/junit-json-params
- Owner: joshka
- License: apache-2.0
- Created: 2018-02-04T23:42:36.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T07:08:57.000Z (14 days ago)
- Last Synced: 2024-10-23T10:14:59.571Z (13 days ago)
- Topics: java, json, jsonp, junit-json, junit5, parameterized-tests, unit-testing
- Language: Java
- Homepage: http://www.joshka.net/junit-json-params
- Size: 846 KB
- Stars: 57
- Watchers: 4
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# junit-json-params
A [Junit 5](http://junit.org/junit5/) library to provide annotations that load
data from JSON Strings or files in parameterized tests.
## Library status
> [!CAUTION]
>
> I haven't actively written any Java in about 2 years, so this is in the barely maintained bucket
> Please feel free to fork this it and release under a different namespace. I'm happy to slap a link
> to a maintained fork on this repo to point at the new code, but I don't have the inclination to
> maintain it myself.
## Project Info
[](https://central.sonatype.com/artifact/net.joshka/junit-json-params)
[](https://javadoc.io/doc/net.joshka/junit-json-params)
[](./LICENSE.txt) \
[](https://github.com/joshka/junit-json-params/actions/workflows/gradle.yml)
[](https://sonarcloud.io/project/overview?id=joshka_junit-json-params)
[](https://sonarcloud.io/component_measures?id=joshka_junit-json-params&metric=coverage&view=list)
## Installation
### Apache Maven
```xml
net.joshka
junit-json-params
5.10.2-r0
org.eclipse.parsson
parsson
1.1.1
```
### Gradle
```groovy
testImplementation 'net.joshka:junit-json-params:5.10.2-r0'
testImplementation 'org.eclipse.parsson:parsson:1.1.1'
```
## Examples
### `@JsonSource`
`@JsonSource` allows you to specify argument lists as JSON strings.
See [`JsonArgumentsProviderTest`](https://github.com/joshka/junit-json-params/blob/master/src/test/java/net/joshka/junit/json/params/JsonArgumentsProviderTest.java)
```java
import net.joshka.junit.json.params.JsonSource;
class JsonArgumentsProviderTest {
/**
* When passed {"key":"value"}, is executed a single time
* @param object the parsed JsonObject
*/
@ParameterizedTest
@JsonSource("{\"key\":\"value\"}")
@DisplayName("provides a single object")
void singleObject(JsonObject object) {
assertThat(object.getString("key")).isEqualTo("value");
}
/**
* When passed [{"key":"value1"},{"key","value2"}], is
* executed once per element of the array
* @param object the parsed JsonObject array element
*/
@ParameterizedTest
@JsonSource("[{\"key\":\"value1\"},{\"key\":\"value2\"}]")
@DisplayName("provides an array of objects")
void arrayOfObjects(JsonObject object) {
assertThat(object.getString("key")).startsWith("value");
}
/**
* When passed [1, 2], is executed once per array element
* @param number the parsed JsonNumber for each array element
*/
@ParameterizedTest
@JsonSource("[1,2]")
@DisplayName("provides an array of numbers")
void arrayOfNumbers(JsonNumber number) {
assertThat(number.intValue()).isPositive();
}
/**
* When passed ["value1","value2"], is executed once per array
* element
* @param string the parsed JsonString for each array element
*/
@ParameterizedTest
@JsonSource("[\"value1\",\"value2\"]")
@DisplayName("provides an array of strings")
void arrayOfStrings(JsonString string) {
assertThat(string.getString()).startsWith("value");
}
/**
* When passed {'key':'value'}, is executed a single time.
* This simplifies writing inline JSON strings
* @param object the parsed JsonObject
*/
@ParameterizedTest
@JsonSource("{'key':'value'}")
@DisplayName("handles simplified json")
void simplifiedJson(JsonObject object) {
assertThat(object.getString("key")).isEqualTo("value");
}
}
```
### `@JsonFileSource`
`@JsonFileSource` lets you use JSON files from the classpath. It supports
single objects and arrays of objects and JSON primitives (numbers and strings).
See [`JsonFileArgumentsProviderTest`](https://github.com/joshka/junit-json-params/blob/master/src/test/java/net/joshka/junit/json/params/JsonFileArgumentsProviderTest.java)
```java
import net.joshka.junit.json.params.JsonFileSource;
class JsonFileArgumentsProviderTest {
/**
* When passed {"key":"value"}, is executed a single time
* @param object the parsed JsonObject
*/
@ParameterizedTest
@JsonFileSource(resources = "/single-object.json")
@DisplayName("provides a single object")
void singleObject(JsonObject object) {
assertThat(object.getString("key")).isEqualTo("value");
}
/**
* When passed [{"key":"value1"},{"key","value2"}], is
* executed once per element of the array
* @param object the parsed JsonObject array element
*/
@ParameterizedTest
@JsonFileSource(resources = "/array-of-objects.json")
@DisplayName("provides an array of objects")
void arrayOfObjects(JsonObject object) {
assertThat(object.getString("key")).startsWith("value");
}
/**
* When passed [1, 2], is executed once per array element
* @param number the parsed JsonNumber for each array element
*/
@ParameterizedTest
@JsonFileSource(resources = "/array-of-numbers.json")
@DisplayName("provides an array of numbers")
void arrayOfNumbers(JsonNumber number) {
assertThat(number.intValue()).isPositive();
}
/**
* When passed ["value1","value2"], is executed once per array
* element
* @param string the parsed JsonString for each array element
*/
@ParameterizedTest
@JsonFileSource(resources = "/array-of-strings.json")
@DisplayName("provides an array of strings")
void arrayOfStrings(JsonString string) {
assertThat(string.getString()).startsWith("value");
}
}
```
## License
Copyright ©️ 2019-2024 Joshua McKinney
Code is under the [Apache License 2.0](LICENSE.txt)