Skip to content

Commit 774bed3

Browse files
committed
Raise the minimum version of REST Assured to 4.4
Closes gh-752
1 parent d742ad1 commit 774bed3

File tree

44 files changed

+84
-83
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+84
-83
lines changed

build.gradle

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ plugins {
77
allprojects {
88
group = "org.springframework.restdocs"
99
repositories {
10+
mavenLocal()
1011
mavenCentral()
1112
maven { url "https://repo.spring.io/snapshot" }
1213
}

docs/src/docs/asciidoc/getting-started.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Spring REST Docs has the following minimum requirements:
7979
* Java 8
8080
* Spring Framework 5 (5.0.2 or later)
8181

82-
Additionally, the `spring-restdocs-restassured` module requires REST Assured 3.0.
82+
Additionally, the `spring-restdocs-restassured` module requires REST Assured 4 (4.4 or later).
8383

8484
[[getting-started-build-configuration]]
8585
=== Build configuration
@@ -345,7 +345,7 @@ include::{examples-dir}/com/example/restassured/ExampleApplicationTests.java[tag
345345
<1> REST Assured is configured by adding a `RestAssuredRestDocumentationConfigurer` as a
346346
`Filter`. You can obtain an instance of this class from the static
347347
`documentationConfiguration()` method on `RestAssuredRestDocumentation` in the
348-
`org.springframework.restdocs.restassured3` package.
348+
`org.springframework.restdocs.restassured` package.
349349
====
350350

351351
The configurer applies sensible defaults and also provides an API for customizing the
@@ -438,7 +438,7 @@ include::{examples-dir}/com/example/restassured/ExampleApplicationJUnit5Tests.ja
438438
<1> REST Assured is configured by adding a `RestAssuredRestDocumentationConfigurer` as a
439439
`Filter`. You can obtain an instance of this class from the static
440440
`documentationConfiguration()` method on `RestAssuredRestDocumentation` in the
441-
`org.springframework.restdocs.restassured3` package.
441+
`org.springframework.restdocs.restassured` package.
442442
====
443443

444444
The configurer applies sensible defaults and also provides an API for customizing the
@@ -545,7 +545,7 @@ include::{examples-dir}/com/example/restassured/InvokeService.java[tags=invoke-s
545545
(which is located beneath the configured output directory). The snippets are written by
546546
a `RestDocumentationFilter`. You can obtain an instance of this class from the static
547547
`document` method on `RestAssuredRestDocumentation` in the
548-
`org.springframework.restdocs.restassured3` package.
548+
`org.springframework.restdocs.restassured` package.
549549
<4> Invoke the root (`/`) of the service.
550550
<5> Assert that the service produce the expected response.
551551
====

docs/src/docs/asciidoc/introduction.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ configure Spring REST Docs to use Markdown.
1313
Spring REST Docs uses snippets produced by tests written with Spring MVC's
1414
{spring-framework-docs}/testing.html#spring-mvc-test-framework[test framework], Spring
1515
WebFlux's {spring-framework-docs}/testing.html#webtestclient[`WebTestClient`] or
16-
http://rest-assured.io[REST Assured 3]. This test-driven approach helps to guarantee
16+
http://rest-assured.io[REST Assured 4]. This test-driven approach helps to guarantee
1717
the accuracy of your service's documentation. If a snippet is incorrect, the test that
1818
produces it fails.
1919

docs/src/test/java/com/example/restassured/CustomDefaultOperationPreprocessors.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
2727
import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
28-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
28+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
2929

3030
public class CustomDefaultOperationPreprocessors {
3131

docs/src/test/java/com/example/restassured/CustomDefaultSnippets.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import org.springframework.restdocs.JUnitRestDocumentation;
2525

2626
import static org.springframework.restdocs.cli.CliDocumentation.curlRequest;
27-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
27+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
2828

2929
public class CustomDefaultSnippets {
3030

docs/src/test/java/com/example/restassured/CustomEncoding.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
import org.springframework.restdocs.JUnitRestDocumentation;
2525

26-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
26+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
2727

2828
public class CustomEncoding {
2929

docs/src/test/java/com/example/restassured/CustomFormat.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import org.springframework.restdocs.JUnitRestDocumentation;
2525
import org.springframework.restdocs.templates.TemplateFormats;
2626

27-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
27+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
2828

2929
public class CustomFormat {
3030

docs/src/test/java/com/example/restassured/EveryTestPreprocessing.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links;
3030
import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
3131
import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
32-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
33-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
32+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
33+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
3434

3535
public class EveryTestPreprocessing {
3636

docs/src/test/java/com/example/restassured/ExampleApplicationJUnit5Tests.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import org.springframework.restdocs.RestDocumentationContextProvider;
2525
import org.springframework.restdocs.RestDocumentationExtension;
2626

27-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
27+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
2828

2929
@ExtendWith(RestDocumentationExtension.class)
3030
public class ExampleApplicationJUnit5Tests {

docs/src/test/java/com/example/restassured/ExampleApplicationTestNgTests.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
import org.springframework.restdocs.ManualRestDocumentation;
2727

28-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
28+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
2929

3030
public class ExampleApplicationTestNgTests {
3131

docs/src/test/java/com/example/restassured/ExampleApplicationTests.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
import org.springframework.restdocs.JUnitRestDocumentation;
2525

26-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
26+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
2727

2828
public class ExampleApplicationTests {
2929

docs/src/test/java/com/example/restassured/HttpHeaders.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import static org.springframework.restdocs.headers.HeaderDocumentation.headerWithName;
2424
import static org.springframework.restdocs.headers.HeaderDocumentation.requestHeaders;
2525
import static org.springframework.restdocs.headers.HeaderDocumentation.responseHeaders;
26-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
26+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
2727

2828
public class HttpHeaders {
2929

docs/src/test/java/com/example/restassured/Hypermedia.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.halLinks;
2424
import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
2525
import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links;
26-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
26+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
2727

2828
public class Hypermedia {
2929

docs/src/test/java/com/example/restassured/InvokeService.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import io.restassured.specification.RequestSpecification;
2121

2222
import static org.hamcrest.CoreMatchers.is;
23-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
23+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
2424

2525
public class InvokeService {
2626

docs/src/test/java/com/example/restassured/ParameterizedOutput.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323

2424
import org.springframework.restdocs.JUnitRestDocumentation;
2525

26-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
27-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
26+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
27+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
2828

2929
public class ParameterizedOutput {
3030

docs/src/test/java/com/example/restassured/PathParameters.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import static org.hamcrest.CoreMatchers.is;
2323
import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
2424
import static org.springframework.restdocs.request.RequestDocumentation.pathParameters;
25-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
25+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
2626

2727
public class PathParameters {
2828

docs/src/test/java/com/example/restassured/Payload.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import static org.springframework.restdocs.payload.PayloadDocumentation.responseBody;
3030
import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
3131
import static org.springframework.restdocs.payload.PayloadDocumentation.subsectionWithPath;
32-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
32+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
3333
import static org.springframework.restdocs.snippet.Attributes.attributes;
3434
import static org.springframework.restdocs.snippet.Attributes.key;
3535

docs/src/test/java/com/example/restassured/PerTestPreprocessing.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
2525
import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
2626
import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
27-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
27+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
2828

2929
public class PerTestPreprocessing {
3030

docs/src/test/java/com/example/restassured/RequestParameters.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import static org.hamcrest.CoreMatchers.is;
2323
import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
2424
import static org.springframework.restdocs.request.RequestDocumentation.requestParameters;
25-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
25+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
2626

2727
public class RequestParameters {
2828

docs/src/test/java/com/example/restassured/RequestPartPayload.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
2828
import static org.springframework.restdocs.payload.PayloadDocumentation.requestPartBody;
2929
import static org.springframework.restdocs.payload.PayloadDocumentation.requestPartFields;
30-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
30+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
3131

3232
public class RequestPartPayload {
3333

docs/src/test/java/com/example/restassured/RequestParts.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import static org.hamcrest.CoreMatchers.is;
2323
import static org.springframework.restdocs.request.RequestDocumentation.partWithName;
2424
import static org.springframework.restdocs.request.RequestDocumentation.requestParts;
25-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
25+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
2626

2727
public class RequestParts {
2828

docs/src/test/java/com/example/restassured/RestAssuredSnippetReuse.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
import static org.hamcrest.CoreMatchers.is;
2424
import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
25-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
25+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
2626

2727
public class RestAssuredSnippetReuse extends SnippetReuse {
2828

samples/rest-assured/build.gradle

+3-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ ext {
2424
}
2525

2626
ext['spring-restdocs.version'] = '3.0.0-SNAPSHOT'
27+
ext['rest-assured.version'] = '4.4.0'
28+
ext['groovy.version'] = '3.0.8'
2729

2830
configurations {
2931
asciidoctorExtensions
@@ -34,7 +36,7 @@ dependencies {
3436

3537
implementation 'org.springframework.boot:spring-boot-starter-web'
3638

37-
testImplementation 'io.rest-assured:rest-assured:3.0.2'
39+
testImplementation 'io.rest-assured:rest-assured:4.4.0'
3840
testImplementation('org.junit.vintage:junit-vintage-engine') {
3941
exclude group: 'org.hamcrest', module: 'hamcrest-core'
4042
}

samples/rest-assured/src/test/java/com/example/restassured/SampleRestAssuredApplicationTests.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2018 the original author or authors.
2+
* Copyright 2014-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -20,8 +20,8 @@
2020
import static org.hamcrest.CoreMatchers.is;
2121
import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest;
2222
import static org.springframework.restdocs.operation.preprocess.Preprocessors.modifyUris;
23-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
24-
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
23+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
24+
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
2525

2626
import org.junit.Before;
2727
import org.junit.Rule;

settings.gradle

+9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
pluginManagement {
22
repositories {
3+
mavenLocal()
34
mavenCentral()
45
maven { url "https://repo.spring.io/plugins-release-local" }
6+
maven { url "https://repo.spring.io/snapshot" }
57
gradlePluginPortal()
68
}
9+
resolutionStrategy {
10+
eachPlugin {
11+
if (requested.id.id == "io.spring.javaformat") {
12+
useModule "io.spring.javaformat:spring-javaformat-gradle-plugin:${requested.version}"
13+
}
14+
}
15+
}
716
}
817

918
plugins {

spring-restdocs-platform/build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ dependencies {
1414
api("javax.servlet:javax.servlet-api:3.1.0")
1515
api("javax.validation:validation-api:2.0.0.Final")
1616
api("junit:junit:4.12")
17-
api("io.rest-assured:rest-assured:3.0.7")
17+
api("io.rest-assured:rest-assured:4.4.0")
1818
api("org.apache.pdfbox:pdfbox:2.0.7")
1919
api("org.assertj:assertj-core:3.11.1")
2020
api("org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.18")

spring-restdocs-restassured/build.gradle

-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
plugins {
2-
id "io.spring.compatibility-test" version "0.0.1"
32
id "java-library"
43
id "maven-publish"
54
}
@@ -22,10 +21,3 @@ dependencies {
2221
testImplementation("org.hamcrest:hamcrest-library")
2322
testImplementation("org.mockito:mockito-core")
2423
}
25-
26-
compatibilityTest {
27-
dependency("REST Assured") { restAssured ->
28-
restAssured.groupId = "io.rest-assured"
29-
restAssured.versions = ["4.0.0", "4.1.2", "4.2.0", "4.3.1"]
30-
}
31-
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2019 the original author or authors.
2+
* Copyright 2014-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package org.springframework.restdocs.restassured3;
17+
package org.springframework.restdocs.restassured;
1818

1919
import io.restassured.filter.Filter;
2020
import io.restassured.filter.FilterContext;
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2019 the original author or authors.
2+
* Copyright 2014-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package org.springframework.restdocs.restassured3;
17+
package org.springframework.restdocs.restassured;
1818

1919
import java.io.File;
2020
import java.io.IOException;
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2019 the original author or authors.
2+
* Copyright 2014-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package org.springframework.restdocs.restassured3;
17+
package org.springframework.restdocs.restassured;
1818

1919
import io.restassured.http.Header;
2020
import io.restassured.response.Response;
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2019 the original author or authors.
2+
* Copyright 2014-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package org.springframework.restdocs.restassured3;
17+
package org.springframework.restdocs.restassured;
1818

1919
import org.springframework.restdocs.RestDocumentationContextProvider;
2020
import org.springframework.restdocs.generate.RestDocumentationGenerator;
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2019 the original author or authors.
2+
* Copyright 2014-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package org.springframework.restdocs.restassured3;
17+
package org.springframework.restdocs.restassured;
1818

1919
import java.util.HashMap;
2020
import java.util.Map;

0 commit comments

Comments
 (0)