org.springframework.restdocs.mockmvc.RestDocumentationResultHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-restdocs-mockmvc Show documentation
Spring REST Docs MockMvc
There is a newer version: 3.0.3
Show newest version
/*
 * Copyright 2014-2015 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.mockmvc;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.restdocs.operation.Operation;
import org.springframework.restdocs.operation.OperationRequest;
import org.springframework.restdocs.operation.OperationResponse;
import org.springframework.restdocs.operation.StandardOperation;
import org.springframework.restdocs.operation.preprocess.OperationRequestPreprocessor;
import org.springframework.restdocs.operation.preprocess.OperationResponsePreprocessor;
import org.springframework.restdocs.snippet.Snippet;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.ResultHandler;
import org.springframework.util.Assert;

import static org.springframework.restdocs.mockmvc.IterableEnumeration.iterable;

/**
 * A Spring MVC Test {@code ResultHandler} for documenting RESTful APIs.
 *
 * @author Andy Wilkinson
 * @author Andreas Evers
 * @see MockMvcRestDocumentation#document(String, Snippet...)
 */
public class RestDocumentationResultHandler implements ResultHandler {

	private final List additionalSnippets;

	private final String identifier;

	private final OperationRequestPreprocessor requestPreprocessor;

	private final OperationResponsePreprocessor responsePreprocessor;

	private final List snippets;

	RestDocumentationResultHandler(String identifier, Snippet... snippets) {
		this(identifier, new IdentityOperationRequestPreprocessor(),
				new IdentityOperationResponsePreprocessor(), snippets);
	}

	RestDocumentationResultHandler(String identifier,
			OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) {
		this(identifier, requestPreprocessor, new IdentityOperationResponsePreprocessor(),
				snippets);
	}

	RestDocumentationResultHandler(String identifier,
			OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) {
		this(identifier, new IdentityOperationRequestPreprocessor(), responsePreprocessor,
				snippets);
	}

	RestDocumentationResultHandler(String identifier,
			OperationRequestPreprocessor requestPreprocessor,
			OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) {
		Assert.notNull(identifier, "identifier must be non-null");
		Assert.notNull(requestPreprocessor, "requestPreprocessor must be non-null");
		Assert.notNull(responsePreprocessor, "responsePreprocessor must be non-null");
		Assert.notNull(snippets, "snippets must be non-null");
		this.identifier = identifier;
		this.requestPreprocessor = requestPreprocessor;
		this.responsePreprocessor = responsePreprocessor;
		this.snippets = new ArrayList<>(Arrays.asList(snippets));
		this.additionalSnippets = new ArrayList<>();
	}

	@Override
	public void handle(MvcResult result) throws Exception {
		Map attributes = new HashMap<>();
		for (String name : iterable(result.getRequest().getAttributeNames())) {
			attributes.put(name, result.getRequest().getAttribute(name));
		}
		OperationRequest request = this.requestPreprocessor
				.preprocess(new MockMvcOperationRequestFactory()
						.createOperationRequest(result.getRequest()));

		OperationResponse response = this.responsePreprocessor
				.preprocess(new MockMvcOperationResponseFactory()
						.createOperationResponse(result.getResponse()));
		Operation operation = new StandardOperation(this.identifier, request, response,
				attributes);
		for (Snippet snippet : getSnippets(result)) {
			snippet.document(operation);
		}
	}

	/**
	 * Adds the given {@code snippets} such that that are documented when this result
	 * handler is called.
	 *
	 * @param snippets the snippets to add
	 * @return this {@code ResultDocumentationResultHandler}
	 */
	public RestDocumentationResultHandler snippets(Snippet... snippets) {
		this.additionalSnippets.addAll(Arrays.asList(snippets));
		return this;
	}

	@SuppressWarnings("unchecked")
	private List getSnippets(MvcResult result) {
		List combinedSnippets = new ArrayList<>(
				(List) result.getRequest().getAttribute(
						"org.springframework.restdocs.mockmvc.defaultSnippets"));
		combinedSnippets.addAll(this.snippets);
		combinedSnippets.addAll(this.additionalSnippets);
		this.additionalSnippets.clear();
		return combinedSnippets;
	}

	private static final class IdentityOperationRequestPreprocessor
			implements OperationRequestPreprocessor {

		@Override
		public OperationRequest preprocess(OperationRequest request) {
			return request;
		}

	}

	private static final class IdentityOperationResponsePreprocessor
			implements OperationResponsePreprocessor {

		@Override
		public OperationResponse preprocess(OperationResponse response) {
			return response;
		}

	}

}