Introduce RequestCookie to avoid core depending on the Servlet API

Closes gh-345

Author: wilkinsona

spring-restdocs-core/build.gradle

@@ -27,7 +27,6 @@ task jmustacheRepackJar(type: Jar) { repackJar ->
 dependencies {
 	compile 'com.fasterxml.jackson.core:jackson-databind'
 	compile 'org.springframework:spring-web'
-	compile 'javax.servlet:javax.servlet-api'
 	compile files(jmustacheRepackJar)
 	jarjar 'com.googlecode.jarjar:jarjar:1.3'
 	jmustache 'com.samskivert:jmustache@jar'

spring-restdocs-core/src/main/java/org/springframework/restdocs/cli/CliOperationRequest.java

@@ -25,13 +25,12 @@
 import java.util.Map.Entry;
 import java.util.Set;
 
-import javax.servlet.http.Cookie;
-
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 import org.springframework.restdocs.operation.OperationRequest;
 import org.springframework.restdocs.operation.OperationRequestPart;
 import org.springframework.restdocs.operation.Parameters;
+import org.springframework.restdocs.operation.RequestCookie;
 import org.springframework.util.Base64Utils;
 
 /**
@@ -128,7 +127,7 @@ public URI getUri() {
 	}
 
 	@Override
-	public Collection<Cookie> getCookies() {
+	public Collection<RequestCookie> getCookies() {
 		return this.delegate.getCookies();
 	}
 

spring-restdocs-core/src/main/java/org/springframework/restdocs/cli/CurlRequestSnippet.java

@@ -23,13 +23,12 @@
 import java.util.Map;
 import java.util.Map.Entry;
 
-import javax.servlet.http.Cookie;
-
 import org.springframework.http.HttpMethod;
 import org.springframework.restdocs.operation.Operation;
 import org.springframework.restdocs.operation.OperationRequest;
 import org.springframework.restdocs.operation.OperationRequestPart;
 import org.springframework.restdocs.operation.Parameters;
+import org.springframework.restdocs.operation.RequestCookie;
 import org.springframework.restdocs.snippet.Snippet;
 import org.springframework.restdocs.snippet.TemplatedSnippet;
 import org.springframework.util.CollectionUtils;
@@ -105,7 +104,7 @@ private String getOptions(Operation operation) {
 	private void writeCookies(CliOperationRequest request, PrintWriter printer) {
 		if (!CollectionUtils.isEmpty(request.getCookies())) {
 			StringBuilder cookiesBuilder = new StringBuilder();
-			for (Cookie cookie : request.getCookies()) {
+			for (RequestCookie cookie : request.getCookies()) {
 				if (cookiesBuilder.length() > 0) {
 					cookiesBuilder.append(";");
 				}

spring-restdocs-core/src/main/java/org/springframework/restdocs/cli/HttpieRequestSnippet.java

@@ -23,15 +23,14 @@
 import java.util.Map;
 import java.util.Map.Entry;
 
-import javax.servlet.http.Cookie;
-
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.MediaType;
 import org.springframework.restdocs.operation.Operation;
 import org.springframework.restdocs.operation.OperationRequest;
 import org.springframework.restdocs.operation.OperationRequestPart;
 import org.springframework.restdocs.operation.Parameters;
+import org.springframework.restdocs.operation.RequestCookie;
 import org.springframework.restdocs.snippet.Snippet;
 import org.springframework.restdocs.snippet.TemplatedSnippet;
 import org.springframework.util.StringUtils;
@@ -166,7 +165,7 @@ private void writeHeaders(OperationRequest request, PrintWriter writer) {
 	}
 
 	private void writeCookies(OperationRequest request, PrintWriter writer) {
-		for (Cookie cookie : request.getCookies()) {
+		for (RequestCookie cookie : request.getCookies()) {
 			writer.print(String.format(" 'Cookie:%s=%s'", cookie.getName(),
 					cookie.getValue()));
 		}

spring-restdocs-core/src/main/java/org/springframework/restdocs/http/HttpRequestSnippet.java

@@ -24,20 +24,18 @@
 import java.util.Map;
 import java.util.Map.Entry;
 
-import javax.servlet.http.Cookie;
-
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.MediaType;
 import org.springframework.restdocs.operation.Operation;
 import org.springframework.restdocs.operation.OperationRequest;
 import org.springframework.restdocs.operation.OperationRequestPart;
 import org.springframework.restdocs.operation.Parameters;
+import org.springframework.restdocs.operation.RequestCookie;
 import org.springframework.restdocs.snippet.Snippet;
 import org.springframework.restdocs.snippet.TemplatedSnippet;
 import org.springframework.util.StringUtils;
 
-
 /**
  * A {@link Snippet} that documents an HTTP request.
  *
@@ -116,8 +114,9 @@ private List<Map<String, String>> getHeaders(OperationRequest request) {
 			}
 		}
 
-		for (Cookie cookie : request.getCookies()) {
-			headers.add(header(HttpHeaders.COOKIE, String.format("%s=%s", cookie.getName(), cookie.getValue())));
+		for (RequestCookie cookie : request.getCookies()) {
+			headers.add(header(HttpHeaders.COOKIE,
+					String.format("%s=%s", cookie.getName(), cookie.getValue())));
 		}
 
 		if (requiresFormEncodingContentTypeHeader(request)) {

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/OperationRequest.java

@@ -19,8 +19,6 @@
 import java.net.URI;
 import java.util.Collection;
 
-import javax.servlet.http.Cookie;
-
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 
@@ -89,12 +87,12 @@ public interface OperationRequest {
 	URI getUri();
 
 	/**
-	 * Returns {@link Cookie Cookies} sent with the request. If no cookies were sent an
-	 * empty collection is returned.
+	 * Returns the {@link RequestCookie cookies} sent with the request. If no cookies were
+	 * sent an empty collection is returned.
 	 *
 	 * @return the cookies, never {@code null}
 	 * @since 1.2.0
 	 */
-	Collection<Cookie> getCookies();
+	Collection<RequestCookie> getCookies();
 
 }

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/OperationRequestFactory.java

@@ -20,8 +20,6 @@
 import java.util.Collection;
 import java.util.Collections;
 
-import javax.servlet.http.Cookie;
-
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 
@@ -48,8 +46,7 @@ public class OperationRequestFactory {
 	 */
 	public OperationRequest create(URI uri, HttpMethod method, byte[] content,
 			HttpHeaders headers, Parameters parameters,
-			Collection<OperationRequestPart> parts,
-			Collection<Cookie> cookies) {
+			Collection<OperationRequestPart> parts, Collection<RequestCookie> cookies) {
 		return new StandardOperationRequest(uri, method, content,
 				augmentHeaders(headers, uri, content), parameters, parts, cookies);
 	}
@@ -70,7 +67,8 @@ public OperationRequest create(URI uri, HttpMethod method, byte[] content,
 	public OperationRequest create(URI uri, HttpMethod method, byte[] content,
 			HttpHeaders headers, Parameters parameters,
 			Collection<OperationRequestPart> parts) {
-		return create(uri, method, content, headers, parameters, parts, Collections.<Cookie>emptyList());
+		return create(uri, method, content, headers, parameters, parts,
+				Collections.<RequestCookie>emptyList());
 	}
 
 	/**

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/RequestCookie.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2014-2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.restdocs.operation;
+
+/**
+ * A representation of a Cookie received in a request.
+ *
+ * @author Andy Wilkinson
+ * @since 1.2.0
+ */
+public final class RequestCookie {
+
+	private final String name;
+
+	private final String value;
+
+	/**
+	 * Creates a new {@code RequestCookie} with the given {@code name} and {@code value}.
+	 *
+	 * @param name the name of the cookie
+	 * @param value the value of the cookie
+	 */
+	public RequestCookie(String name, String value) {
+		this.name = name;
+		this.value = value;
+	}
+
+	/**
+	 * Returns the name of the cookie.
+	 *
+	 * @return the name
+	 */
+	public String getName() {
+		return this.name;
+	}
+
+	/**
+	 * Returns the value of the cookie.
+	 *
+	 * @return the value
+	 */
+	public String getValue() {
+		return this.value;
+	}
+
+}

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/StandardOperationRequest.java

@@ -20,8 +20,6 @@
 import java.util.Collection;
 import java.util.Collections;
 
-import javax.servlet.http.Cookie;
-
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 
@@ -41,7 +39,7 @@ class StandardOperationRequest extends AbstractOperationMessage
 
 	private URI uri;
 
-	private Collection<Cookie> cookies;
+	private Collection<RequestCookie> cookies;
 
 	/**
 	 * Creates a new request with the given {@code uri} and {@code method}. The request
@@ -58,7 +56,7 @@ class StandardOperationRequest extends AbstractOperationMessage
 	 */
 	StandardOperationRequest(URI uri, HttpMethod method, byte[] content,
 			HttpHeaders headers, Parameters parameters,
-			Collection<OperationRequestPart> parts, Collection<Cookie> cookies) {
+			Collection<OperationRequestPart> parts, Collection<RequestCookie> cookies) {
 		super(content, headers);
 		this.uri = uri;
 		this.method = method;
@@ -88,7 +86,7 @@ public URI getUri() {
 	}
 
 	@Override
-	public Collection<Cookie> getCookies() {
+	public Collection<RequestCookie> getCookies() {
 		return this.cookies;
 	}
 

spring-restdocs-core/src/test/java/org/springframework/restdocs/test/OperationBuilder.java

@@ -25,8 +25,6 @@
 import java.util.List;
 import java.util.Map;
 
-import javax.servlet.http.Cookie;
-
 import org.junit.runners.model.Statement;
 
 import org.springframework.http.HttpHeaders;
@@ -43,6 +41,7 @@
 import org.springframework.restdocs.operation.OperationResponse;
 import org.springframework.restdocs.operation.OperationResponseFactory;
 import org.springframework.restdocs.operation.Parameters;
+import org.springframework.restdocs.operation.RequestCookie;
 import org.springframework.restdocs.operation.StandardOperation;
 import org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolverFactory;
 import org.springframework.restdocs.snippet.StandardWriterResolver;
@@ -156,7 +155,7 @@ public final class OperationRequestBuilder {
 
 		private List<OperationRequestPartBuilder> partBuilders = new ArrayList<>();
 
-		private Collection<Cookie> cookies = new ArrayList<>();
+		private Collection<RequestCookie> cookies = new ArrayList<>();
 
 		private OperationRequestBuilder(String uri) {
 			this.requestUri = URI.create(uri);
@@ -215,7 +214,7 @@ public OperationRequestPartBuilder part(String name, byte[] content) {
 		}
 
 		public OperationRequestBuilder cookie(String name, String value) {
-			this.cookies.add(new Cookie(name, value));
+			this.cookies.add(new RequestCookie(name, value));
 			return this;
 		}
 

spring-restdocs-mockmvc/build.gradle

@@ -1,6 +1,7 @@
 description = 'Spring REST Docs MockMvc'
 
 dependencies {
+	compile 'javax.servlet:javax.servlet-api'
 	compile 'org.springframework:spring-test'
 	compile project(':spring-restdocs-core')
 	optional 'junit:junit'

spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/MockMvcRequestConverter.java

@@ -21,14 +21,12 @@
 import java.io.StringWriter;
 import java.net.URI;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map.Entry;
 
 import javax.servlet.ServletException;
-import javax.servlet.http.Cookie;
 import javax.servlet.http.Part;
 
 import org.springframework.http.HttpHeaders;
@@ -43,6 +41,7 @@
 import org.springframework.restdocs.operation.OperationRequestPartFactory;
 import org.springframework.restdocs.operation.Parameters;
 import org.springframework.restdocs.operation.RequestConverter;
+import org.springframework.restdocs.operation.RequestCookie;
 import org.springframework.util.FileCopyUtils;
 import org.springframework.util.StringUtils;
 import org.springframework.web.multipart.MultipartFile;
@@ -71,7 +70,7 @@ public OperationRequest convert(MockHttpServletRequest mockRequest) {
 			HttpHeaders headers = extractHeaders(mockRequest);
 			Parameters parameters = extractParameters(mockRequest);
 			List<OperationRequestPart> parts = extractParts(mockRequest);
-			Collection<Cookie> cookies = extractCookies(mockRequest);
+			Collection<RequestCookie> cookies = extractCookies(mockRequest);
 			String queryString = mockRequest.getQueryString();
 			if (!StringUtils.hasText(queryString)
 					&& "GET".equals(mockRequest.getMethod())) {
@@ -90,12 +89,16 @@ public OperationRequest convert(MockHttpServletRequest mockRequest) {
 		}
 	}
 
-	private Collection<Cookie> extractCookies(MockHttpServletRequest mockRequest) {
-		if (mockRequest.getCookies() != null) {
-			return Arrays.asList(mockRequest.getCookies());
+	private Collection<RequestCookie> extractCookies(MockHttpServletRequest mockRequest) {
+		if (mockRequest.getCookies() == null || mockRequest.getCookies().length == 0) {
+			return Collections.emptyList();
 		}
-
-		return Collections.emptyList();
+		List<RequestCookie> cookies = new ArrayList<>();
+		for (javax.servlet.http.Cookie servletCookie : mockRequest.getCookies()) {
+			cookies.add(
+					new RequestCookie(servletCookie.getName(), servletCookie.getValue()));
+		}
+		return cookies;
 	}
 
 	private List<OperationRequestPart> extractParts(MockHttpServletRequest servletRequest)