Upgrade to Spring REST Docs 2.0.3 (#306)

Spring REST Docs moved from Hamcrest to AssertJ: spring-projects/spring-restdocs@7431426

Author: fbenz

.travis.yml

@@ -13,8 +13,8 @@ cache:
   - $HOME/.gradle/caches/
   - $HOME/.gradle/wrapper/
 before_install:
-- mvn install:install-file -Dfile=lib/spring-restdocs-core-2.0.2.RELEASE-test.jar
-  -DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core -Dversion=2.0.2.RELEASE
+- mvn install:install-file -Dfile=lib/spring-restdocs-core-2.0.3.RELEASE-test.jar
+  -DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core -Dversion=2.0.3.RELEASE
   -Dpackaging=jar -Dclassifier=test
 script:
 - mvn install -B -V

lib/spring-restdocs-core-2.0.2.RELEASE-test.jar

@@ -48,7 +48,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory>
-        <spring-restdocs.version>2.0.2.RELEASE</spring-restdocs.version>
+        <spring-restdocs.version>2.0.3.RELEASE</spring-restdocs.version>
     </properties>
 
     <build>
@@ -273,7 +273,7 @@
             <dependency>
                 <groupId>com.fasterxml.jackson.core</groupId>
                 <artifactId>jackson-databind</artifactId>
-                <version>2.9.7</version>
+                <version>2.9.8</version>
             </dependency>
             <dependency>
                 <groupId>org.springframework</groupId>

lib/spring-restdocs-core-2.0.3.RELEASE-test.jar

@@ -103,6 +103,12 @@
             <version>9.0.12</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>2.9.1</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

pom.xml

@@ -7,9 +7,9 @@
  * 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.
@@ -20,10 +20,7 @@
 package capital.scalable.restdocs.hypermedia;
 
 import static capital.scalable.restdocs.SnippetRegistry.AUTO_EMBEDDED;
-import static java.util.Collections.singletonList;
-import static org.hamcrest.CoreMatchers.equalTo;
-import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertThat;
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
@@ -69,26 +66,27 @@ public void embedded() throws Exception {
         mockFieldComment(EmbeddedDocs.class, "embedded1", "Resource 1");
         mockFieldComment(EmbeddedDocs.class, "embedded2", "Resource 2");
 
-        this.snippets.expect(AUTO_EMBEDDED).withContents(
-                tableWithHeader("Path", "Type", "Optional", "Description")
-                        .row("embedded1", "Array[Object]", "true", "Resource 1.")
-                        .row("embedded2", "Object", "true", "Resource 2."));
-
         new EmbeddedSnippet().documentationType(EmbeddedDocs.class).document(operationBuilder
                 .attribute(HandlerMethod.class.getName(), handlerMethod)
                 .attribute(ObjectMapper.class.getName(), mapper)
                 .attribute(JavadocReader.class.getName(), javadocReader)
                 .attribute(ConstraintReader.class.getName(), constraintReader)
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_EMBEDDED)).is(
+                tableWithHeader("Path", "Type", "Optional", "Description")
+                        .row("embedded1", "Array[Object]", "true", "Resource 1.")
+                        .row("embedded2", "Object", "true", "Resource 2."));
     }
 
     @Test
     public void noHandlerMethod() throws Exception {
-        this.snippets.expect(AUTO_EMBEDDED).withContents(equalTo("No embedded resources."));
-
         new EmbeddedSnippet().document(operationBuilder
                 .attribute(ObjectMapper.class.getName(), mapper)
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_EMBEDDED))
+                .isEqualTo("No embedded resources.");
     }
 
     @Test
@@ -98,7 +96,7 @@ public void noContent() throws Exception {
         boolean hasContent = new EmbeddedSnippet().hasContent(operationBuilder
                 .attribute(HandlerMethod.class.getName(), handlerMethod)
                 .build());
-        assertThat(hasContent, is(false));
+        assertThat(hasContent).isFalse();
     }
 
     @Test
@@ -117,11 +115,6 @@ public void failOnUndocumentedFields() throws Exception {
                         .build());
     }
 
-    private void mockOptionalMessage(Class<?> type, String fieldName, String comment) {
-        when(constraintReader.getOptionalMessages(type, fieldName))
-                .thenReturn(singletonList(comment));
-    }
-
     private void mockFieldComment(Class<?> type, String fieldName, String comment) {
         when(javadocReader.resolveFieldComment(type, fieldName))
                 .thenReturn(comment);

spring-auto-restdocs-core/pom.xml

@@ -7,9 +7,9 @@
  * 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.
@@ -20,10 +20,7 @@
 package capital.scalable.restdocs.hypermedia;
 
 import static capital.scalable.restdocs.SnippetRegistry.AUTO_LINKS;
-import static java.util.Collections.singletonList;
-import static org.hamcrest.CoreMatchers.equalTo;
-import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertThat;
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
@@ -67,26 +64,26 @@ public void links() throws Exception {
         mockFieldComment(LinksDocs.class, "link1", "Link 1");
         mockFieldComment(LinksDocs.class, "link2", "Link 2");
 
-        this.snippets.expect(AUTO_LINKS).withContents(
-                tableWithHeader("Path", "Optional", "Description")
-                        .row("link1", "true", "Link 1.")
-                        .row("link2", "true", "Link 2."));
-
         new LinksSnippet().documentationType(LinksDocs.class).document(operationBuilder
                 .attribute(HandlerMethod.class.getName(), handlerMethod)
                 .attribute(ObjectMapper.class.getName(), mapper)
                 .attribute(JavadocReader.class.getName(), javadocReader)
                 .attribute(ConstraintReader.class.getName(), constraintReader)
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_LINKS)).is(
+                tableWithHeader("Path", "Optional", "Description")
+                        .row("link1", "true", "Link 1.")
+                        .row("link2", "true", "Link 2."));
     }
 
     @Test
     public void noHandlerMethod() throws Exception {
-        this.snippets.expect(AUTO_LINKS).withContents(equalTo("No links."));
-
         new LinksSnippet().document(operationBuilder
                 .attribute(ObjectMapper.class.getName(), mapper)
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_LINKS)).isEqualTo("No links.");
     }
 
     @Test
@@ -96,7 +93,7 @@ public void noContent() throws Exception {
         boolean hasContent = new LinksSnippet().hasContent(operationBuilder
                 .attribute(HandlerMethod.class.getName(), handlerMethod)
                 .build());
-        assertThat(hasContent, is(false));
+        assertThat(hasContent).isFalse();
     }
 
     @Test
@@ -114,11 +111,6 @@ public void failOnUndocumentedFields() throws Exception {
                 .build());
     }
 
-    private void mockOptionalMessage(Class<?> type, String fieldName, String comment) {
-        when(constraintReader.getOptionalMessages(type, fieldName))
-                .thenReturn(singletonList(comment));
-    }
-
     private void mockFieldComment(Class<?> type, String fieldName, String comment) {
         when(javadocReader.resolveFieldComment(type, fieldName))
                 .thenReturn(comment);

spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/hypermedia/EmbeddedSnippetTest.java

@@ -7,9 +7,9 @@
  * 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.
@@ -20,7 +20,7 @@
 package capital.scalable.restdocs.misc;
 
 import static capital.scalable.restdocs.SnippetRegistry.AUTO_AUTHORIZATION;
-import static org.hamcrest.CoreMatchers.equalTo;
+import static org.assertj.core.api.Assertions.assertThat;
 
 import org.junit.Test;
 import org.springframework.restdocs.AbstractSnippetTests;
@@ -36,26 +36,25 @@ public AuthorizationSnippetTest(String name, TemplateFormat templateFormat) {
     public void authorization() throws Exception {
         String authorization = "User access token required.";
 
-        this.snippets.expect(AUTO_AUTHORIZATION)
-                .withContents(equalTo(authorization));
-
         new AuthorizationSnippet("Resource is public.")
                 .document(operationBuilder
                         .attribute(AuthorizationSnippet.class.getName(), authorization)
                         .request("http://localhost/test")
                         .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_AUTHORIZATION)).isEqualTo(authorization);
     }
 
     @Test
     public void defaultAuthorization() throws Exception {
         String defaultAuthorization = "Resource is public.";
 
-        this.snippets.expect(AUTO_AUTHORIZATION)
-                .withContents(equalTo(defaultAuthorization));
-
         new AuthorizationSnippet(defaultAuthorization)
                 .document(operationBuilder
                         .request("http://localhost/test")
                         .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_AUTHORIZATION))
+                .isEqualTo(defaultAuthorization);
     }
 }

spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/hypermedia/LinksSnippetTest.java

@@ -7,9 +7,9 @@
  * 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.
@@ -20,7 +20,7 @@
 package capital.scalable.restdocs.misc;
 
 import static capital.scalable.restdocs.SnippetRegistry.AUTO_DESCRIPTION;
-import static org.hamcrest.CoreMatchers.equalTo;
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
@@ -43,13 +43,13 @@ public void description() throws Exception {
         mockMethodComment(TestResource.class, "testDescription", "sample method comment");
         mockMethodTag(TestResource.class, "testDescription", "deprecated", "");
 
-        this.snippets.expect(AUTO_DESCRIPTION).withContents(equalTo("Sample method comment."));
-
         new DescriptionSnippet().document(operationBuilder
                 .attribute(HandlerMethod.class.getName(), handlerMethod)
                 .attribute(JavadocReader.class.getName(), javadocReader)
                 .request("http://localhost/test")
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_DESCRIPTION)).isEqualTo("Sample method comment.");
     }
 
     @Test
@@ -58,14 +58,14 @@ public void descriptionWithDeprecated() throws Exception {
         mockMethodComment(TestResource.class, "testDescription", "sample method comment");
         mockMethodTag(TestResource.class, "testDescription", "deprecated", "use different one");
 
-        this.snippets.expect(AUTO_DESCRIPTION).withContents(equalTo(
-                "**Deprecated.** Use different one.\n\nSample method comment."));
-
         new DescriptionSnippet().document(operationBuilder
                 .attribute(HandlerMethod.class.getName(), handlerMethod)
                 .attribute(JavadocReader.class.getName(), javadocReader)
                 .request("http://localhost/test")
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_DESCRIPTION))
+                .isEqualTo("**Deprecated.** Use different one.\n\nSample method comment.");
     }
 
     @Test
@@ -74,23 +74,23 @@ public void descriptionWithSeeTag() throws Exception {
         mockMethodComment(TestResource.class, "testDescription", "sample method comment");
         mockMethodTag(TestResource.class, "testDescription", "see", "something");
 
-        this.snippets.expect(AUTO_DESCRIPTION).withContents(equalTo(
-                "Sample method comment.\n\nSee something."));
-
         new DescriptionSnippet().document(operationBuilder
                 .attribute(HandlerMethod.class.getName(), handlerMethod)
                 .attribute(JavadocReader.class.getName(), javadocReader)
                 .request("http://localhost/test")
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_DESCRIPTION))
+                .isEqualTo("Sample method comment.\n\nSee something.");
     }
 
     @Test
     public void noHandlerMethod() throws Exception {
-        this.snippets.expect(AUTO_DESCRIPTION).withContents(equalTo(""));
-
         new DescriptionSnippet().document(operationBuilder
                 .request("http://localhost/test")
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_DESCRIPTION)).isEqualTo("");
     }
 
     private void mockMethodComment(Class<TestResource> javaBaseClass, String methodName,

spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/misc/AuthorizationSnippetTest.java

@@ -7,9 +7,9 @@
  * 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.
@@ -21,7 +21,7 @@
 
 import static capital.scalable.restdocs.OperationAttributeHelper.REQUEST_PATTERN;
 import static capital.scalable.restdocs.SnippetRegistry.AUTO_METHOD_PATH;
-import static org.hamcrest.CoreMatchers.equalTo;
+import static org.assertj.core.api.Assertions.assertThat;
 
 import org.junit.Test;
 import org.springframework.restdocs.AbstractSnippetTests;
@@ -38,25 +38,25 @@ public MethodAndPathSnippetTest(String name, TemplateFormat templateFormat) {
     public void simpleRequest() throws Exception {
         HandlerMethod handlerMethod = new HandlerMethod(new TestResource(), "testMethod");
 
-        this.snippets.expect(AUTO_METHOD_PATH).withContents(equalTo("`POST /test`"));
-
         new MethodAndPathSnippet().document(operationBuilder
                 .attribute(HandlerMethod.class.getName(), handlerMethod)
                 .attribute(REQUEST_PATTERN, "/test")
                 .request("http://localhost/test")
                 .method("POST")
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_METHOD_PATH)).isEqualTo("`POST /test`");
     }
 
     @Test
     public void noHandlerMethod() throws Exception {
-        this.snippets.expect(AUTO_METHOD_PATH).withContents(equalTo("`POST /test`"));
-
         new MethodAndPathSnippet().document(operationBuilder
                 .attribute(REQUEST_PATTERN, "/test")
                 .request("http://localhost/test")
                 .method("POST")
                 .build());
+
+        assertThat(this.generatedSnippets.snippet(AUTO_METHOD_PATH)).isEqualTo("`POST /test`");
     }
 
     private static class TestResource {