Merge branch 'gh-398' into 1.2.x

Author: wilkinsona

spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/JsonFieldTypeResolver.java

@@ -38,7 +38,7 @@ JsonFieldType resolveFieldType(String path, Object payload) {
 				if (commonType == null) {
 					commonType = fieldType;
 				}
-				else if (fieldType != commonType) {
+				else if (fieldType != commonType && fieldType != JsonFieldType.NULL) {
 					return JsonFieldType.VARIES;
 				}
 			}

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

@@ -112,13 +112,73 @@ public void multipleFieldsWithDifferentTypes() throws IOException {
 	}
 
 	@Test
-	public void nonExistentFieldProducesIllegalArgumentException() throws IOException {
+	public void multipleFieldsWithDifferentTypesAndSometimesAbsent() throws IOException {
+		assertThat(
+				this.fieldTypeResolver.resolveFieldType("a[].id",
+						createPayload("{\"a\":[{\"id\":1},{\"id\":true}, { }]}")),
+				equalTo(JsonFieldType.VARIES));
+	}
+
+	@Test
+	public void multipleFieldsWhenSometimesAbsent() throws IOException {
+		assertThat(
+				this.fieldTypeResolver.resolveFieldType("a[].id",
+						createPayload("{\"a\":[{\"id\":1},{ }]}")),
+				equalTo(JsonFieldType.NUMBER));
+	}
+
+	@Test
+	public void multipleFieldsWithDifferentTypesAndSometimesNull() throws IOException {
+		assertThat(
+				this.fieldTypeResolver.resolveFieldType("a[].id",
+						createPayload(
+								"{\"a\":[{\"id\":1},{\"id\":true}, {\"id\":null}]}")),
+				equalTo(JsonFieldType.VARIES));
+	}
+
+	@Test
+	public void multipleFieldsWhenSometimesNull() throws IOException {
+		assertThat(
+				this.fieldTypeResolver.resolveFieldType("a[].id",
+						createPayload("{\"a\":[{\"id\":1},{\"id\":null}]}")),
+				equalTo(JsonFieldType.NUMBER));
+	}
+
+	@Test
+	public void multipleFieldsWhenEitherNullOrAbsent() throws IOException {
+		assertThat(
+				this.fieldTypeResolver.resolveFieldType("a[].id",
+						createPayload("{\"a\":[{},{\"id\":null}]}")),
+				equalTo(JsonFieldType.NULL));
+	}
+
+	@Test
+	public void multipleFieldsThatAreAllNull() throws IOException {
+		assertThat(
+				this.fieldTypeResolver.resolveFieldType("a[].id",
+						createPayload("{\"a\":[{\"id\":null},{\"id\":null}]}")),
+				equalTo(JsonFieldType.NULL));
+	}
+
+	@Test
+	public void nonExistentSingleFieldProducesFieldDoesNotExistException()
+			throws IOException {
 		this.thrownException.expect(FieldDoesNotExistException.class);
 		this.thrownException.expectMessage(
 				"The payload does not contain a field with the path 'a.b'");
 		this.fieldTypeResolver.resolveFieldType("a.b", createPayload("{\"a\":{}}"));
 	}
 
+	@Test
+	public void nonExistentMultipleFieldsProducesFieldDoesNotExistException()
+			throws IOException {
+		this.thrownException.expect(FieldDoesNotExistException.class);
+		this.thrownException.expectMessage(
+				"The payload does not contain a field with the path 'a[].b'");
+		this.fieldTypeResolver.resolveFieldType("a[].b",
+				createPayload("{\"a\":[{\"c\":1},{\"c\":2}]}"));
+	}
+
 	private void assertFieldType(JsonFieldType expectedType, String jsonValue)
 			throws IOException {
 		assertThat(this.fieldTypeResolver.resolveFieldType("field",

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

@@ -368,6 +368,20 @@ public void mapRequestWithVaryingKeysMatchedUsingWildcard() throws IOException {
 										.build());
 	}
 
+	@Test
+	public void requestWithArrayContainingFieldThatIsSometimesNull() throws IOException {
+		this.snippets.expectRequestFields()
+				.withContents(tableWithHeader("Path", "Type", "Description")
+						.row("`assets[].name`", "`String`", "one"));
+		new RequestFieldsSnippet(Arrays.asList(fieldWithPath("assets[].name")
+				.description("one").type(JsonFieldType.STRING)))
+						.document(this.operationBuilder.request("http://localhost")
+								.content("{\"assets\": [" + "{\"name\": \"sample1\"}, "
+										+ "{\"name\": null}, "
+										+ "{\"name\": \"sample2\"}]}")
+								.build());
+	}
+
 	private String escapeIfNecessary(String input) {
 		if (this.templateFormat.equals(TemplateFormats.markdown())) {
 			return input;

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

@@ -378,6 +378,20 @@ public void mapResponseWithVaryingKeysMatchedUsingWildcard() throws IOException
 										.build());
 	}
 
+	@Test
+	public void responseWithArrayContainingFieldThatIsSometimesNull() throws IOException {
+		this.snippets.expectResponseFields()
+				.withContents(tableWithHeader("Path", "Type", "Description")
+						.row("`assets[].name`", "`String`", "one"));
+		new ResponseFieldsSnippet(Arrays.asList(fieldWithPath("assets[].name")
+				.description("one").type(JsonFieldType.STRING)))
+						.document(this.operationBuilder.response()
+								.content("{\"assets\": [" + "{\"name\": \"sample1\"}, "
+										+ "{\"name\": null}, "
+										+ "{\"name\": \"sample2\"}]}")
+								.build());
+	}
+
 	private String escapeIfNecessary(String input) {
 		if (this.templateFormat.equals(TemplateFormats.markdown())) {
 			return input;