这是indexloc提供的服务，不要输入任何密码
Skip to content

BAEL-8598 Add Rest Assured Body Assertions Example #17561

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
merged 1 commit into from
Sep 18, 2024
Merged

BAEL-8598 Add Rest Assured Body Assertions Example #17561

Show file tree
Hide file tree
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
32 changes: 32 additions & 0 deletions testing-modules/rest-assured/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,34 @@
<version>${scribejava.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.skyscreamer</groupId>
<artifactId>jsonassert</artifactId>
<version>${json.assert.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.javacrumbs.json-unit</groupId>
<artifactId>json-unit-assertj</artifactId>
<version>${json.unit.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.javacrumbs.json-unit</groupId>
<artifactId>json-unit</artifactId>
<version>${json.unit.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>uk.org.webcompere</groupId>
<artifactId>model-assert</artifactId>
<version>${model.assert.version}</version>
</dependency>
<dependency>
<groupId>uk.co.datumedge</groupId>
<artifactId>hamcrest-json</artifactId>
<version>${hamcrest.json.version}</version>
</dependency>
</dependencies>

<build>
Expand Down Expand Up @@ -198,6 +226,10 @@
<wiremock.version>3.9.1</wiremock.version>
<scribejava.version>2.5.3</scribejava.version>
<rest-assured.version>5.5.0</rest-assured.version>
<json.assert.version>1.5.3</json.assert.version>
<json.unit.version>3.4.1</json.unit.version>
<model.assert.version>1.0.3</model.assert.version>
<hamcrest.json.version>0.2</hamcrest.json.version>
</properties>

</project>
93 changes: 93 additions & 0 deletions ...ured/src/test/java/com/baeldung/restassured/assertjson/RestAssuredAssertJsonUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
package com.baeldung.restassured.assertjson;

import com.baeldung.restassured.assertjson.WebsitePojo.WebsiteText;
import org.assertj.core.util.Files;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

import java.io.File;

import static io.restassured.RestAssured.given;
import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
import static org.hamcrest.Matchers.equalTo;

class RestAssuredAssertJsonUnitTest extends WireMockTestBase {

@Test
void whenGetBody_thenCanCompareByFields() {
given()
.get("/static")
.then()
.body("name", equalTo("baeldung"))
.body("type", equalTo("website"))
.body("text.code", equalTo("java"))
.body("text.language", equalTo("english"));
}

@Test
void whenGetBody_thenCanCompareByWholeString() {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

assertThat(body)
.isEqualTo("{\"name\":\"baeldung\",\"type\":\"website\",\"text\":{\"language\":\"english\",\"code\":\"java\"}}");
}

@Test
void whenGetBody_thenCompareByWholeStringIsSensitiveToFieldOrder() {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

assertThat(body)
.isNotEqualTo("{\"type\":\"website\",\"name\":\"baeldung\",\"text\":{\"language\":\"english\",\"code\":\"java\"}}");
}

@Test
void whenGetBody_thenCanCompareByPojo() {
WebsitePojo body = given()
.get("/static")
.then()
.extract()
.body()
.as(WebsitePojo.class);

assertThat(body)
.isEqualTo(new WebsitePojo("baeldung", "website", new WebsiteText("english", "java")));
}

@Disabled("This test cannot predict UUID and timestamp")
@Test
void whenGetBody_thenCannotEasilyHandleUnpredictableValues() {
String body = given()
.get("/build")
.then()
.extract()
.body()
.asString();

assertThat(body)
.isEqualTo("{\"name\":\"baeldung\",\"type\":\"website\",\"text\":{\"language\":\"english\",\"code\":\"java\"}}");
}

@Disabled("Requires file to be in the exact correct format")
@Test
void whenGetBody_thenCannotEasilyCompareWithFile() {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

assertThat(body)
.isEqualTo(Files.contentOf(new File("src/test/resources/expected-website.json"), "UTF-8"));
}
}
44 changes: 44 additions & 0 deletions ...t/java/com/baeldung/restassured/assertjson/RestAssuredAssertJsonWithHamcrestUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package com.baeldung.restassured.assertjson;

import net.javacrumbs.jsonunit.core.Option;
import org.assertj.core.util.Files;
import org.junit.jupiter.api.Test;
import java.io.File;

import static io.restassured.RestAssured.given;
import static uk.co.datumedge.hamcrest.json.SameJSONAs.sameJSONAs;

import static net.javacrumbs.jsonunit.JsonMatchers.*;
import static uk.org.webcompere.modelassert.json.JsonAssertions.json;

class RestAssuredAssertJsonWithHamcrestUnitTest extends WireMockTestBase {

@Test
void whenGetBody_thenCanCompareChangeableFieldsByJsonAssertAgainstFileIgnoringAdditionalFields() {
given()
.get("/build")
.then()
.body(sameJSONAs(Files.contentOf(new File("src/test/resources/expected-website.json"), "UTF-8")).allowingExtraUnexpectedFields());
}

@Test
void whenGetBody_thenCanCompareChangeableFieldsByJsonUnitAgainstFileIgnoringAdditionalFields() {
given()
.get("/build")
.then()
.body(jsonEquals(Files.contentOf(new File("src/test/resources/expected-website.json"), "UTF-8")).when(Option.IGNORING_EXTRA_FIELDS));
}

@Test
void whenGetBody_thenCanCompareChangeableFieldsByModelAssertionAgainstFileWithPatterns() {
given()
.get("/build")
.then()
.body(json().where()
.keysInAnyOrder()
.path("build").matches("[0-9a-f-]+")
.path("timestamp").matches("[0-9:T.-]+")
.isEqualTo(new File("src/test/resources/expected-build.json")));
}

}
107 changes: 107 additions & 0 deletions ...java/com/baeldung/restassured/assertjson/RestAssuredAssertJsonWithJsonAssertUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
package com.baeldung.restassured.assertjson;

import org.assertj.core.util.Files;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.skyscreamer.jsonassert.Customization;
import org.skyscreamer.jsonassert.JSONAssert;
import org.skyscreamer.jsonassert.JSONCompareMode;
import org.skyscreamer.jsonassert.RegularExpressionValueMatcher;
import org.skyscreamer.jsonassert.comparator.CustomComparator;

import java.io.File;

import static io.restassured.RestAssured.given;

class RestAssuredAssertJsonWithJsonAssertUnitTest extends WireMockTestBase {

@Test
void whenGetBody_thenCanCompareByJsonAssert() throws Exception {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

JSONAssert.assertEquals("{\"name\":\"baeldung\",\"type\":\"website\",\"text\":{\"language\":\"english\",\"code\":\"java\"}}", body, JSONCompareMode.STRICT);
}

@Test
void whenGetBody_thenCanCompareByJsonAssertWithFieldsInDifferentOrder() throws Exception {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

JSONAssert.assertEquals("{\"type\":\"website\",\"name\":\"baeldung\",\"text\":{\"language\":\"english\",\"code\":\"java\"}}", body, JSONCompareMode.STRICT);
}

@Test
void whenGetBody_thenCanCompareByJsonAssertAgainstFile() throws Exception {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

JSONAssert.assertEquals(Files.contentOf(new File("src/test/resources/expected-website.json"), "UTF-8"), body, JSONCompareMode.STRICT);
}

@Test
void whenGetBody_thenCanCompareByJsonAssertAgainstFileDifferentOrder() throws Exception {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

JSONAssert.assertEquals(Files.contentOf(new File("src/test/resources/expected-website-different-field-order.json"), "UTF-8"), body, JSONCompareMode.STRICT);
}

@Disabled("This doesn't work because the file contains fields that change every time")
@Test
void whenGetBody_thenCannotCompareChangeableFieldsByJsonAssertAgainstFile() throws Exception {
String body = given()
.get("/build")
.then()
.extract()
.body()
.asString();

JSONAssert.assertEquals(Files.contentOf(new File("src/test/resources/expected-build.json"), "UTF-8"), body, JSONCompareMode.STRICT);
}

@Test
void whenGetBody_thenCanCompareChangeableFieldsByIgnoringExtraFields() throws Exception {
String body = given()
.get("/build")
.then()
.extract()
.body()
.asString();

JSONAssert.assertEquals(Files.contentOf(new File("src/test/resources/expected-website.json"), "UTF-8"), body, JSONCompareMode.LENIENT);
}

@Test
void whenGetBody_thenCanCompareChangeableFieldsByJsonAssertAgainstFile() throws Exception {
String body = given()
.get("/build")
.then()
.extract()
.body()
.asString();

JSONAssert.assertEquals(Files.contentOf(new File("src/test/resources/expected-build.json"), "UTF-8"), body,
new CustomComparator(JSONCompareMode.STRICT,
new Customization("build",
new RegularExpressionValueMatcher<>("[0-9a-f-]+")),
new Customization("timestamp",
new RegularExpressionValueMatcher<>(".+"))));
}
}
93 changes: 93 additions & 0 deletions ...t/java/com/baeldung/restassured/assertjson/RestAssuredAssertJsonWithJsonUnitUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
package com.baeldung.restassured.assertjson;

import net.javacrumbs.jsonunit.core.Option;
import org.assertj.core.util.Files;
import org.junit.jupiter.api.Test;


import java.io.File;

import static io.restassured.RestAssured.given;
import static net.javacrumbs.jsonunit.assertj.JsonAssertions.assertThatJson;

class RestAssuredAssertJsonWithJsonUnitUnitTest extends WireMockTestBase {

@Test
void whenGetBody_thenCanCompareByJsonUnit() {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

assertThatJson(body)
.isEqualTo("{\"name\":\"baeldung\",\"type\":\"website\",\"text\":{\"language\":\"english\",\"code\":\"java\"}}");
}

@Test
void whenGetBody_thenCanCompareByJsonUnitWithFieldsInDifferentOrder() {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

assertThatJson(body)
.isEqualTo("{\"type\":\"website\",\"name\":\"baeldung\",\"text\":{\"language\":\"english\",\"code\":\"java\"}}");
}

@Test
void whenGetBody_thenCanCompareByJsonUnitAgainstFile() {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

assertThatJson(body)
.isEqualTo(Files.contentOf(new File("src/test/resources/expected-website.json"), "UTF-8"));
}

@Test
void whenGetBody_thenCanCompareByJsonUnitAgainstFileDifferentOrder() {
String body = given()
.get("/static")
.then()
.extract()
.body()
.asString();

assertThatJson(body)
.isEqualTo(Files.contentOf(new File("src/test/resources/expected-website-different-field-order.json"), "UTF-8"));
}

@Test
void whenGetBody_thenCanCompareByJsonUnitAgainstUnpredictableFieldsByIgnoringExtraFields() {
String body = given()
.get("/build")
.then()
.extract()
.body()
.asString();

assertThatJson(body)
.when(Option.IGNORING_EXTRA_FIELDS)
.isEqualTo("{\"type\":\"website\",\"name\":\"baeldung\",\"text\":{\"language\":\"english\",\"code\":\"java\"}}");
}

@Test
void whenGetBody_thenCanCompareByJsonUnitAgainstUnpredictableFields() {
String body = given()
.get("/build")
.then()
.extract()
.body()
.asString();

assertThatJson(body)
.isEqualTo("{\"build\":\"${json-unit.regex}[0-9a-f-]+\",\"timestamp\":\"${json-unit.any-string}\",\"type\":\"website\",\"name\":\"baeldung\",\"text\":{\"language\":\"english\",\"code\":\"java\"}}");
}
}
Loading