Java tutorial
/* * Copyright 2012-2016 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.boot.test.autoconfigure.web.servlet; import java.io.PrintStream; import java.io.PrintWriter; import java.io.StringWriter; import java.util.ArrayList; import java.util.Collection; import java.util.List; import javax.servlet.Filter; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.beans.factory.NoSuchBeanDefinitionException; import org.springframework.boot.web.servlet.DelegatingFilterProxyRegistrationBean; import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.boot.web.servlet.ServletContextInitializer; import org.springframework.boot.web.servlet.ServletContextInitializerBeans; import org.springframework.context.ApplicationContext; import org.springframework.context.ConfigurableApplicationContext; import org.springframework.test.web.servlet.MvcResult; import org.springframework.test.web.servlet.ResultHandler; import org.springframework.test.web.servlet.result.PrintingResultHandler; import org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder; import org.springframework.util.Assert; import org.springframework.util.CollectionUtils; import org.springframework.web.context.WebApplicationContext; /** * {@link MockMvcBuilderCustomizer} for a typical Spring Boot application. Usually applied * automatically via {@link AutoConfigureMockMvc @AutoConfigureMockMvc}, but may also be * used directly. * * @author Phillip Webb * @author Andy Wilkinson * @since 1.4.0 */ public class SpringBootMockMvcBuilderCustomizer implements MockMvcBuilderCustomizer { private final WebApplicationContext context; private boolean addFilters = true; private MockMvcPrint print = MockMvcPrint.DEFAULT; private boolean printOnlyOnFailure = true; /** * Create a new {@link SpringBootMockMvcBuilderCustomizer} instance. * @param context the source application context */ public SpringBootMockMvcBuilderCustomizer(WebApplicationContext context) { Assert.notNull(context, "Context must not be null"); this.context = context; } @Override public void customize(ConfigurableMockMvcBuilder<?> builder) { if (this.addFilters) { addFilters(builder); } ResultHandler printHandler = getPrintHandler(); if (printHandler != null) { builder.alwaysDo(printHandler); } } private ResultHandler getPrintHandler() { LinesWriter writer = getLinesWriter(); if (writer == null) { return null; } if (this.printOnlyOnFailure) { writer = new DeferredLinesWriter(this.context, writer); } return new LinesWritingResultHandler(writer); } private LinesWriter getLinesWriter() { if (this.print == MockMvcPrint.NONE) { return null; } if (this.print == MockMvcPrint.LOG_DEBUG) { return new LoggingLinesWriter(); } return new SystemLinesWriter(this.print); } private void addFilters(ConfigurableMockMvcBuilder<?> builder) { ServletContextInitializerBeans Initializers = new ServletContextInitializerBeans(this.context); for (ServletContextInitializer initializer : Initializers) { if (initializer instanceof FilterRegistrationBean) { addFilter(builder, (FilterRegistrationBean) initializer); } if (initializer instanceof DelegatingFilterProxyRegistrationBean) { addFilter(builder, (DelegatingFilterProxyRegistrationBean) initializer); } } } private void addFilter(ConfigurableMockMvcBuilder<?> builder, FilterRegistrationBean registration) { addFilter(builder, registration.getFilter(), registration.getUrlPatterns()); } private void addFilter(ConfigurableMockMvcBuilder<?> builder, DelegatingFilterProxyRegistrationBean registration) { addFilter(builder, registration.getFilter(), registration.getUrlPatterns()); } private void addFilter(ConfigurableMockMvcBuilder<?> builder, Filter filter, Collection<String> urls) { if (urls.isEmpty()) { builder.addFilters(filter); } else { builder.addFilter(filter, urls.toArray(new String[urls.size()])); } } public void setAddFilters(boolean addFilters) { this.addFilters = addFilters; } public boolean isAddFilters() { return this.addFilters; } public void setPrint(MockMvcPrint print) { this.print = print; } public MockMvcPrint getPrint() { return this.print; } public void setPrintOnlyOnFailure(boolean printOnlyOnFailure) { this.printOnlyOnFailure = printOnlyOnFailure; } public boolean isPrintOnlyOnFailure() { return this.printOnlyOnFailure; } /** * {@link ResultHandler} that prints {@link MvcResult} details to a given * {@link LinesWriter}. */ private static class LinesWritingResultHandler implements ResultHandler { private final LinesWriter writer; LinesWritingResultHandler(LinesWriter writer) { this.writer = writer; } @Override public void handle(MvcResult result) throws Exception { LinesPrintingResultHandler delegate = new LinesPrintingResultHandler(); delegate.handle(result); delegate.write(this.writer); } private static class LinesPrintingResultHandler extends PrintingResultHandler { protected LinesPrintingResultHandler() { super(new Printer()); } public void write(LinesWriter writer) { writer.write(((Printer) getPrinter()).getLines()); } private static class Printer implements ResultValuePrinter { private final List<String> lines = new ArrayList<String>(); @Override public void printHeading(String heading) { this.lines.add(""); this.lines.add(String.format("%s:", heading)); } @Override public void printValue(String label, Object value) { if (value != null && value.getClass().isArray()) { value = CollectionUtils.arrayToList(value); } this.lines.add(String.format("%17s = %s", label, value)); } public List<String> getLines() { return this.lines; } } } } /** * Strategy interface to write MVC result lines. */ interface LinesWriter { void write(List<String> lines); } /** * {@link LinesWriter} used to defer writing until errors are detected. * @see MockMvcPrintOnlyOnFailureTestExecutionListener */ static class DeferredLinesWriter implements LinesWriter { private static final String BEAN_NAME = DeferredLinesWriter.class.getName(); private final LinesWriter delegate; private final List<String> lines = new ArrayList<String>(); DeferredLinesWriter(WebApplicationContext context, LinesWriter delegate) { Assert.state(context instanceof ConfigurableApplicationContext, "A ConfigurableApplicationContext is required for printOnlyOnFailure"); ((ConfigurableApplicationContext) context).getBeanFactory().registerSingleton(BEAN_NAME, this); this.delegate = delegate; } @Override public void write(List<String> lines) { this.lines.addAll(lines); } public void writeDeferredResult() { this.delegate.write(this.lines); } public static DeferredLinesWriter get(ApplicationContext applicationContext) { try { return applicationContext.getBean(BEAN_NAME, DeferredLinesWriter.class); } catch (NoSuchBeanDefinitionException ex) { return null; } } } /** * {@link LinesWriter} to output results to the log. */ private static class LoggingLinesWriter implements LinesWriter { private static final Log logger = LogFactory.getLog("org.springframework.test.web.servlet.result"); @Override public void write(List<String> lines) { if (logger.isDebugEnabled()) { StringWriter stringWriter = new StringWriter(); PrintWriter printWriter = new PrintWriter(stringWriter); for (String line : lines) { printWriter.println(line); } logger.debug("MvcResult details:\n" + stringWriter); } } } /** * {@link LinesWriter} to output results to {@code System.out} or {@code System.err}. */ private static class SystemLinesWriter implements LinesWriter { private final MockMvcPrint print; SystemLinesWriter(MockMvcPrint print) { this.print = print; } @Override public void write(List<String> lines) { PrintStream printStream = getPrintStream(); for (String line : lines) { printStream.println(line); } } private PrintStream getPrintStream() { if (this.print == MockMvcPrint.SYSTEM_ERR) { return System.err; } return System.out; } } }