Add support for documenting request part payload fields

See gh-270

spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/RequestPartsFieldsSnippetFailureTests.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2014-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.payload;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Collections;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+
+import org.springframework.restdocs.snippet.SnippetException;
+import org.springframework.restdocs.templates.TemplateFormats;
+import org.springframework.restdocs.test.ExpectedSnippet;
+import org.springframework.restdocs.test.OperationBuilder;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.hamcrest.CoreMatchers.startsWith;
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+
+/**
+ * Tests for failures when rendering {@link RequestPartFieldsSnippet} due to missing or
+ * undocumented fields.
+ *
+ * @author Mathieu Pousse
+ */
+public class RequestPartsFieldsSnippetFailureTests {
+
+	@Rule
+	public ExpectedSnippet snippet = new ExpectedSnippet(TemplateFormats.asciidoctor());
+
+	@Rule
+	public ExpectedException thrown = ExpectedException.none();
+
+	@Test
+	public void undocumentedRequestPartField() throws IOException {
+		this.thrown.expect(SnippetException.class);
+		this.thrown.expectMessage(startsWith(
+				"The following parts of the payload were not" + " documented:"));
+		new RequestPartFieldsSnippet("part", Collections.<FieldDescriptor>emptyList())
+				.document(new OperationBuilder("undocumented-request-field",
+						this.snippet.getOutputDirectory()).request("http://localhost")
+								.part("part", "{\"a\": 5}".getBytes()).build());
+	}
+
+	@Test
+	public void missingRequestPartField() throws IOException {
+		this.thrown.expect(SnippetException.class);
+		this.thrown.expectMessage(startsWith(
+				"The following parts of the payload were not" + " documented:"));
+		new RequestPartFieldsSnippet("part", Arrays.asList(fieldWithPath("b").description("one")))
+				.document(new OperationBuilder("undocumented-request-field",
+						this.snippet.getOutputDirectory()).request("http://localhost")
+						.part("part", "{\"a\": 5}".getBytes()).build());
+	}
+
+	@Test
+	public void missingRequestPart() throws IOException {
+		this.thrown.expect(SnippetException.class);
+		this.thrown.expectMessage(equalTo("Request parts with the following names were not found in the request: another"));
+		new RequestPartFieldsSnippet("another", Arrays.asList(fieldWithPath("a.b").description("one")))
+				.document(new OperationBuilder("missing-request-fields",
+						this.snippet.getOutputDirectory()).request("http://localhost")
+						.part("part", "{\"a\": {\"b\": 5}}".getBytes()).build());
+	}
+
+}

spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/RequestPartsFieldsSnippetTests.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2014-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.payload;
+
+import java.io.IOException;
+import java.util.Arrays;
+
+import org.junit.Test;
+
+import org.springframework.restdocs.AbstractSnippetTests;
+import org.springframework.restdocs.templates.TemplateFormat;
+
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+
+/**
+ * Tests for {@link RequestPartFieldsSnippet}.
+ *
+ * @author Mathieu Pousse
+ */
+public class RequestPartsFieldsSnippetTests extends AbstractSnippetTests {
+
+	public RequestPartsFieldsSnippetTests(String name, TemplateFormat templateFormat) {
+		super(name, templateFormat);
+	}
+
+	@Test
+	public void mapRequestWithFields() throws IOException {
+		this.snippet.expectRequestFields("map-request-parts-with-fields")
+				.withContents(tableWithHeader("Path", "Type", "Description")
+						.row("`a.b`", "`Number`", "one").row("`a.c`", "`String`", "two")
+						.row("`a`", "`Object`", "three"));
+
+		new RequestPartFieldsSnippet("part", Arrays.asList(fieldWithPath("a.b").description("one"),
+				fieldWithPath("a.c").description("two"),
+				fieldWithPath("a").description("three")))
+						.document(operationBuilder("map-request-parts-with-fields")
+								.request("http://localhost")
+								.part("part", "{\"a\": {\"b\": 5, \"c\": \"charlie\"}}".getBytes())
+								.build());
+	}
+
+}