Polish RestDocumentationConfigurer and improve its test coverage
This commit is contained in:
Andy Wilkinson
@@ -0,0 +1,180 @@
|
||||
/*
|
||||
* 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.restdocs.config;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.hamcrest.Matchers;
|
||||
import org.junit.Test;
|
||||
import org.springframework.restdocs.RestDocumentationContext;
|
||||
import org.springframework.restdocs.curl.CurlDocumentation;
|
||||
import org.springframework.restdocs.curl.CurlRequestSnippet;
|
||||
import org.springframework.restdocs.http.HttpRequestSnippet;
|
||||
import org.springframework.restdocs.http.HttpResponseSnippet;
|
||||
import org.springframework.restdocs.snippet.Snippet;
|
||||
import org.springframework.restdocs.snippet.SnippetFormats;
|
||||
import org.springframework.restdocs.snippet.StandardWriterResolver;
|
||||
import org.springframework.restdocs.snippet.WriterResolver;
|
||||
import org.springframework.restdocs.templates.TemplateEngine;
|
||||
import org.springframework.restdocs.templates.mustache.MustacheTemplateEngine;
|
||||
|
||||
import static org.hamcrest.CoreMatchers.equalTo;
|
||||
import static org.hamcrest.CoreMatchers.instanceOf;
|
||||
import static org.hamcrest.CoreMatchers.is;
|
||||
import static org.hamcrest.Matchers.contains;
|
||||
import static org.hamcrest.Matchers.hasEntry;
|
||||
import static org.junit.Assert.assertThat;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
/**
|
||||
* Tests for {@link RestDocumentationConfigurer}.
|
||||
*
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
public class RestDocumentationConfigurerTests {
|
||||
|
||||
private final TestRestDocumentationConfigurer configurer = new TestRestDocumentationConfigurer();
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Test
|
||||
public void defaultConfiguration() {
|
||||
RestDocumentationContext context = new RestDocumentationContext(null, null, null);
|
||||
Map<String, Object> configuration = new HashMap<>();
|
||||
this.configurer.apply(configuration, context);
|
||||
assertThat(
|
||||
configuration,
|
||||
hasEntry(equalTo(TemplateEngine.class.getName()),
|
||||
instanceOf(MustacheTemplateEngine.class)));
|
||||
assertThat(
|
||||
configuration,
|
||||
hasEntry(equalTo(WriterResolver.class.getName()),
|
||||
instanceOf(StandardWriterResolver.class)));
|
||||
assertThat(
|
||||
configuration,
|
||||
hasEntry(equalTo("org.springframework.restdocs.defaultSnippets"),
|
||||
instanceOf(List.class)));
|
||||
List<Snippet> defaultSnippets = (List<Snippet>) configuration
|
||||
.get("org.springframework.restdocs.defaultSnippets");
|
||||
assertThat(
|
||||
defaultSnippets,
|
||||
contains(instanceOf(CurlRequestSnippet.class),
|
||||
instanceOf(HttpRequestSnippet.class),
|
||||
instanceOf(HttpResponseSnippet.class)));
|
||||
assertThat(
|
||||
configuration,
|
||||
hasEntry(equalTo(SnippetConfiguration.class.getName()),
|
||||
instanceOf(SnippetConfiguration.class)));
|
||||
SnippetConfiguration snippetConfiguration = (SnippetConfiguration) configuration
|
||||
.get(SnippetConfiguration.class.getName());
|
||||
assertThat(snippetConfiguration.getEncoding(), is(equalTo("UTF-8")));
|
||||
assertThat(snippetConfiguration.getFormat(),
|
||||
is(equalTo(SnippetFormats.asciidoctor())));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void customTemplateEngine() {
|
||||
RestDocumentationContext context = new RestDocumentationContext(null, null, null);
|
||||
Map<String, Object> configuration = new HashMap<>();
|
||||
TemplateEngine templateEngine = mock(TemplateEngine.class);
|
||||
this.configurer.templateEngine(templateEngine).apply(configuration, context);
|
||||
assertThat(configuration, Matchers.<String, Object>hasEntry(
|
||||
TemplateEngine.class.getName(), templateEngine));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void customWriterResolver() {
|
||||
RestDocumentationContext context = new RestDocumentationContext(null, null, null);
|
||||
Map<String, Object> configuration = new HashMap<>();
|
||||
WriterResolver writerResolver = mock(WriterResolver.class);
|
||||
this.configurer.writerResolver(writerResolver).apply(configuration, context);
|
||||
assertThat(configuration, Matchers.<String, Object>hasEntry(
|
||||
WriterResolver.class.getName(), writerResolver));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void customDefaultSnippets() {
|
||||
RestDocumentationContext context = new RestDocumentationContext(null, null, null);
|
||||
Map<String, Object> configuration = new HashMap<>();
|
||||
this.configurer.snippets().withDefaults(CurlDocumentation.curlRequest())
|
||||
.apply(configuration, context);
|
||||
assertThat(
|
||||
configuration,
|
||||
hasEntry(equalTo("org.springframework.restdocs.defaultSnippets"),
|
||||
instanceOf(List.class)));
|
||||
@SuppressWarnings("unchecked")
|
||||
List<Snippet> defaultSnippets = (List<Snippet>) configuration
|
||||
.get("org.springframework.restdocs.defaultSnippets");
|
||||
assertThat(defaultSnippets, contains(instanceOf(CurlRequestSnippet.class)));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void customSnippetEncoding() {
|
||||
RestDocumentationContext context = new RestDocumentationContext(null, null, null);
|
||||
Map<String, Object> configuration = new HashMap<>();
|
||||
this.configurer.snippets().withEncoding("ISO 8859-1")
|
||||
.apply(configuration, context);
|
||||
assertThat(
|
||||
configuration,
|
||||
hasEntry(equalTo(SnippetConfiguration.class.getName()),
|
||||
instanceOf(SnippetConfiguration.class)));
|
||||
SnippetConfiguration snippetConfiguration = (SnippetConfiguration) configuration
|
||||
.get(SnippetConfiguration.class.getName());
|
||||
assertThat(snippetConfiguration.getEncoding(), is(equalTo("ISO 8859-1")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void customSnippetFormat() {
|
||||
RestDocumentationContext context = new RestDocumentationContext(null, null, null);
|
||||
Map<String, Object> configuration = new HashMap<>();
|
||||
this.configurer.snippets().withFormat(SnippetFormats.markdown())
|
||||
.apply(configuration, context);
|
||||
assertThat(
|
||||
configuration,
|
||||
hasEntry(equalTo(SnippetConfiguration.class.getName()),
|
||||
instanceOf(SnippetConfiguration.class)));
|
||||
SnippetConfiguration snippetConfiguration = (SnippetConfiguration) configuration
|
||||
.get(SnippetConfiguration.class.getName());
|
||||
assertThat(snippetConfiguration.getFormat(),
|
||||
is(equalTo(SnippetFormats.markdown())));
|
||||
}
|
||||
|
||||
private static final class TestRestDocumentationConfigurer
|
||||
extends
|
||||
RestDocumentationConfigurer<TestSnippetConfigurer, TestRestDocumentationConfigurer> {
|
||||
|
||||
private final TestSnippetConfigurer snippetConfigurer = new TestSnippetConfigurer(
|
||||
this);
|
||||
|
||||
@Override
|
||||
public TestSnippetConfigurer snippets() {
|
||||
return this.snippetConfigurer;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private static final class TestSnippetConfigurer extends
|
||||
SnippetConfigurer<TestRestDocumentationConfigurer, TestSnippetConfigurer> {
|
||||
|
||||
private TestSnippetConfigurer(TestRestDocumentationConfigurer parent) {
|
||||
super(parent);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user