deletedGreetingOptional = greetingService.findOne(id);
- Assert.assertNull("failure - expected greeting to be deleted", deletedGreeting);
+ Assert.assertTrue("failure - expected greeting to be deleted", deletedGreetingOptional.isEmpty());
}
diff --git a/src/test/java/com/leanstacks/ws/util/BCryptPasswordEncoderUtil.java b/src/test/java/com/leanstacks/ws/util/BCryptPasswordEncoderUtil.java
index f934556..65f9dd7 100644
--- a/src/test/java/com/leanstacks/ws/util/BCryptPasswordEncoderUtil.java
+++ b/src/test/java/com/leanstacks/ws/util/BCryptPasswordEncoderUtil.java
@@ -4,8 +4,6 @@
import java.io.OutputStreamWriter;
import java.io.Writer;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
/**
@@ -24,11 +22,6 @@
*/
public class BCryptPasswordEncoderUtil {
- /**
- * The Logger for this Class.
- */
- private static final Logger logger = LoggerFactory.getLogger(BCryptPasswordEncoderUtil.class);
-
/**
* The format for encoder messages.
*/
@@ -54,8 +47,9 @@ public String encode(final String clearText) {
* Facilitates gathering user input and invoking the class behavior.
*
* @param args An array of command line input values. (not used)
+ * @throws IOException Thrown if performing IO operations fails.
*/
- public static void main(final String... args) {
+ public static void main(final String... args) throws IOException {
final BCryptPasswordEncoderUtil encoderUtil = new BCryptPasswordEncoderUtil();
@@ -73,32 +67,28 @@ public static void main(final String... args) {
* Writes a message to the console.
*
* @param str A String message value.
+ * @throws IOException Thrown if writing output fails.
*/
- private void write(final String str) {
-
- try {
- if (writer == null) {
- writer = new OutputStreamWriter(System.out);
- }
- writer.write(str);
- } catch (IOException ioe) {
- logger.error("Writer cannot write.", ioe);
- System.exit(1);
+ private void write(final String str) throws IOException {
+
+ if (writer == null) {
+ writer = new OutputStreamWriter(System.out);
}
+ writer.write(str);
+
}
/**
* Closes all system resources and prepares for application termination.
+ *
+ * @throws IOException Thrown if closing the output stream fails.
*/
- private void close() {
- try {
- if (writer != null) {
- writer.close();
- }
- } catch (IOException ioe) {
- logger.error("Problem closing resources.", ioe);
- System.exit(1);
+ private void close() throws IOException {
+
+ if (writer != null) {
+ writer.close();
}
+
}
}
diff --git a/src/test/java/com/leanstacks/ws/web/api/CreateGreetingDocTest.java b/src/test/java/com/leanstacks/ws/web/api/CreateGreetingDocTest.java
new file mode 100644
index 0000000..c90d2ea
--- /dev/null
+++ b/src/test/java/com/leanstacks/ws/web/api/CreateGreetingDocTest.java
@@ -0,0 +1,92 @@
+package com.leanstacks.ws.web.api;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.http.MediaType;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
+import org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders;
+import org.springframework.restdocs.payload.JsonFieldType;
+import org.springframework.restdocs.payload.PayloadDocumentation;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
+
+import com.leanstacks.ws.AbstractDocTest;
+import com.leanstacks.ws.RestControllerTest;
+
+/**
+ *
+ * Generate REST API documentation for the GreetingController.
+ *
+ *
+ * These tests utilize Spring's REST Docs Framework to generate API documentation. There is a separate test class
+ * responsible for unit testing functionality.
+ *
+ *
+ * @author Matt Warman
+ */
+@RunWith(SpringRunner.class)
+@RestControllerTest
+public class CreateGreetingDocTest extends AbstractDocTest {
+
+ /**
+ * The HTTP request body content.
+ */
+ private static final String REQUEST_BODY = "{ \"text\": \"Bonjour le monde!\" }";
+
+ @Override
+ public void doBeforeEachTest() {
+ // perform test initialization
+ }
+
+ @Override
+ public void doAfterEachTest() {
+ // perform test cleanup
+ }
+
+ /**
+ * Generate API documentation for POST /api/greetings.
+ *
+ * @throws Exception Thrown if documentation generation failure occurs.
+ */
+ @Test
+ public void documentCreateGreeting() throws Exception {
+
+ // Generate API Documentation
+ final MvcResult result = this.mockMvc
+ .perform(RestDocumentationRequestBuilders.post("/api/greetings").contentType(MediaType.APPLICATION_JSON)
+ .accept(MediaType.APPLICATION_JSON).content(REQUEST_BODY))
+ .andExpect(MockMvcResultMatchers.status().isCreated())
+ .andDo(MockMvcRestDocumentation.document("create-greeting",
+ PayloadDocumentation.relaxedRequestFields(PayloadDocumentation.fieldWithPath("text")
+ .description("The text.").type(JsonFieldType.STRING)),
+ PayloadDocumentation.relaxedResponseFields(
+ PayloadDocumentation
+ .fieldWithPath("id")
+ .description(
+ "The identifier. Used to reference specific greetings in API requests.")
+ .type(JsonFieldType.NUMBER),
+ PayloadDocumentation.fieldWithPath("referenceId")
+ .description("The supplementary identifier.").type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("text").description("The text.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("version").description("The entity version.")
+ .type(JsonFieldType.NUMBER),
+ PayloadDocumentation.fieldWithPath("createdBy").description("The entity creator.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("createdAt").description("The creation timestamp.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("updatedBy").description("The last modifier.")
+ .type(JsonFieldType.STRING).optional(),
+ PayloadDocumentation.fieldWithPath("updatedAt")
+ .description("The last modification timestamp.").type(JsonFieldType.STRING)
+ .optional())))
+ .andReturn();
+
+ // Perform a simple, standard JUnit assertion to satisfy PMD rule
+ Assert.assertEquals("failure - expected HTTP status 201", 201, result.getResponse().getStatus());
+
+ }
+
+}
diff --git a/src/test/java/com/leanstacks/ws/web/api/DeleteGreetingDocTest.java b/src/test/java/com/leanstacks/ws/web/api/DeleteGreetingDocTest.java
new file mode 100644
index 0000000..478024d
--- /dev/null
+++ b/src/test/java/com/leanstacks/ws/web/api/DeleteGreetingDocTest.java
@@ -0,0 +1,58 @@
+package com.leanstacks.ws.web.api;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
+import org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
+
+import com.leanstacks.ws.AbstractDocTest;
+import com.leanstacks.ws.RestControllerTest;
+
+/**
+ *
+ * Generate REST API documentation for the GreetingController.
+ *
+ *
+ * These tests utilize Spring's REST Docs Framework to generate API documentation. There is a separate test class
+ * responsible for unit testing functionality.
+ *
+ *
+ * @author Matt Warman
+ */
+@RunWith(SpringRunner.class)
+@RestControllerTest
+public class DeleteGreetingDocTest extends AbstractDocTest {
+
+ @Override
+ public void doBeforeEachTest() {
+ // perform test initialization
+ }
+
+ @Override
+ public void doAfterEachTest() {
+ // perform test cleanup
+ }
+
+ /**
+ * Generate API documentation for DELETE /api/greetings/{id}.
+ *
+ * @throws Exception Thrown if documentation generation failure occurs.
+ */
+ @Test
+ public void documentDeleteGreeting() throws Exception {
+
+ // Generate API Documentation
+ final MvcResult result = this.mockMvc.perform(RestDocumentationRequestBuilders.delete("/api/greetings/{id}", 1))
+ .andExpect(MockMvcResultMatchers.status().isNoContent())
+ .andDo(MockMvcRestDocumentation.document("delete-greeting")).andReturn();
+
+ // Perform a simple, standard JUnit assertion to satisfy PMD rule
+ Assert.assertEquals("failure - expected HTTP status 204", 204, result.getResponse().getStatus());
+
+ }
+
+}
diff --git a/src/test/java/com/leanstacks/ws/web/api/GetGreetingDocTest.java b/src/test/java/com/leanstacks/ws/web/api/GetGreetingDocTest.java
new file mode 100644
index 0000000..306a658
--- /dev/null
+++ b/src/test/java/com/leanstacks/ws/web/api/GetGreetingDocTest.java
@@ -0,0 +1,87 @@
+package com.leanstacks.ws.web.api;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.http.MediaType;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
+import org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders;
+import org.springframework.restdocs.payload.JsonFieldType;
+import org.springframework.restdocs.payload.PayloadDocumentation;
+import org.springframework.restdocs.request.RequestDocumentation;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
+
+import com.leanstacks.ws.AbstractDocTest;
+import com.leanstacks.ws.RestControllerTest;
+
+/**
+ *
+ * Generate REST API documentation for the GreetingController.
+ *
+ *
+ * These tests utilize Spring's REST Docs Framework to generate API documentation. There is a separate test class
+ * responsible for unit testing functionality.
+ *
+ *
+ * @author Matt Warman
+ */
+@RunWith(SpringRunner.class)
+@RestControllerTest
+public class GetGreetingDocTest extends AbstractDocTest {
+
+ @Override
+ public void doBeforeEachTest() {
+ // perform test initialization
+ }
+
+ @Override
+ public void doAfterEachTest() {
+ // perform test cleanup
+ }
+
+ /**
+ * Generate API documentation for GET /api/greetings/{id}.
+ *
+ * @throws Exception Thrown if documentation generation failure occurs.
+ */
+ @Test
+ public void documentGetGreeting() throws Exception {
+
+ // Generate API Documentation
+ final MvcResult result = this.mockMvc
+ .perform(RestDocumentationRequestBuilders
+ .get("/api/greetings/{id}", "0").accept(MediaType.APPLICATION_JSON))
+ .andExpect(MockMvcResultMatchers.status().isOk())
+ .andDo(MockMvcRestDocumentation.document("get-greeting",
+ RequestDocumentation.pathParameters(
+ RequestDocumentation.parameterWithName("id").description("The greeting identifier.")),
+ PayloadDocumentation.relaxedResponseFields(
+ PayloadDocumentation.fieldWithPath("id")
+ .description(
+ "The identifier. Used to reference specific greetings in API requests.")
+ .type(JsonFieldType.NUMBER),
+ PayloadDocumentation.fieldWithPath("referenceId")
+ .description("The supplementary identifier.").type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("text").description("The text.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("version").description("The entity version.")
+ .type(JsonFieldType.NUMBER),
+ PayloadDocumentation.fieldWithPath("createdBy").description("The entity creator.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("createdAt").description("The creation timestamp.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("updatedBy").description("The last modifier.")
+ .type(JsonFieldType.STRING).optional(),
+ PayloadDocumentation.fieldWithPath("updatedAt")
+ .description("The last modification timestamp.").type(JsonFieldType.STRING)
+ .optional())))
+ .andReturn();
+
+ // Perform a simple, standard JUnit assertion to satisfy PMD rule
+ Assert.assertEquals("failure - expected HTTP status 200", 200, result.getResponse().getStatus());
+
+ }
+
+}
diff --git a/src/test/java/com/leanstacks/ws/web/api/GetGreetingsDocTest.java b/src/test/java/com/leanstacks/ws/web/api/GetGreetingsDocTest.java
new file mode 100644
index 0000000..7b95b0c
--- /dev/null
+++ b/src/test/java/com/leanstacks/ws/web/api/GetGreetingsDocTest.java
@@ -0,0 +1,75 @@
+package com.leanstacks.ws.web.api;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.http.MediaType;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
+import org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders;
+import org.springframework.restdocs.payload.PayloadDocumentation;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
+
+import com.leanstacks.ws.AbstractDocTest;
+import com.leanstacks.ws.RestControllerTest;
+
+/**
+ *
+ * Generate REST API documentation for the GreetingController.
+ *
+ *
+ * These tests utilize Spring's REST Docs Framework to generate API documentation. There is a separate test class
+ * responsible for unit testing functionality.
+ *
+ *
+ * @author Matt Warman
+ */
+@RunWith(SpringRunner.class)
+@RestControllerTest
+public class GetGreetingsDocTest extends AbstractDocTest {
+
+ @Override
+ public void doBeforeEachTest() {
+ // perform test initialization
+ }
+
+ @Override
+ public void doAfterEachTest() {
+ // perform test cleanup
+ }
+
+ /**
+ * Generate API documentation for GET /api/greetings.
+ *
+ * @throws Exception Thrown if documentation generation failure occurs.
+ */
+ @Test
+ public void documentGetGreetings() throws Exception {
+
+ // Generate API Documentation
+ final MvcResult result = this.mockMvc
+ .perform(RestDocumentationRequestBuilders.get("/api/greetings").accept(MediaType.APPLICATION_JSON))
+ .andExpect(MockMvcResultMatchers.status().isOk())
+ .andDo(MockMvcRestDocumentation.document("get-greetings",
+ PayloadDocumentation.relaxedResponseFields(
+ PayloadDocumentation.fieldWithPath("[].id").description(
+ "The identifier. Used to reference specific greetings in API requests."),
+ PayloadDocumentation.fieldWithPath("[].referenceId")
+ .description("The supplementary identifier."),
+ PayloadDocumentation.fieldWithPath("[].text").description("The text."),
+ PayloadDocumentation.fieldWithPath("[].version").description("The entity version."),
+ PayloadDocumentation.fieldWithPath("[].createdBy").description("The entity creator."),
+ PayloadDocumentation.fieldWithPath("[].createdAt")
+ .description("The creation timestamp."),
+ PayloadDocumentation.fieldWithPath("[].updatedBy").description("The last modifier."),
+ PayloadDocumentation.fieldWithPath("[].updatedAt")
+ .description("The last modification timestamp."))))
+ .andReturn();
+
+ // Perform a simple, standard JUnit assertion to satisfy PMD rule
+ Assert.assertEquals("failure - expected HTTP status 200", 200, result.getResponse().getStatus());
+
+ }
+
+}
diff --git a/src/test/java/com/leanstacks/ws/web/api/GreetingControllerTest.java b/src/test/java/com/leanstacks/ws/web/api/GreetingControllerTest.java
index 9923d72..2fbde3e 100644
--- a/src/test/java/com/leanstacks/ws/web/api/GreetingControllerTest.java
+++ b/src/test/java/com/leanstacks/ws/web/api/GreetingControllerTest.java
@@ -6,7 +6,8 @@
import static org.mockito.Mockito.when;
import java.util.ArrayList;
-import java.util.Collection;
+import java.util.List;
+import java.util.Optional;
import org.junit.Assert;
import org.junit.Test;
@@ -92,11 +93,16 @@ public void doAfterEachTest() {
// perform test clean up
}
+ /**
+ * Test fetch collection of Greetings.
+ *
+ * @throws Exception Thrown if mocking failure occurs.
+ */
@Test
public void testGetGreetings() throws Exception {
// Create some test data
- final Collection list = getEntityListStubData();
+ final List list = getEntityListStubData();
// Stub the GreetingService.findAll method return value
when(greetingService.findAll()).thenReturn(list);
@@ -118,15 +124,20 @@ public void testGetGreetings() throws Exception {
}
+ /**
+ * Test fetch a Greeting by identifier.
+ *
+ * @throws Exception Thrown if mocking failure occurs.
+ */
@Test
public void testGetGreeting() throws Exception {
// Create some test data
final Long id = Long.valueOf(1);
- final Greeting entity = getEntityStubData();
+ final Optional greetingOptional = Optional.of(getEntityStubData());
// Stub the GreetingService.findOne method return value
- when(greetingService.findOne(id)).thenReturn(entity);
+ when(greetingService.findOne(id)).thenReturn(greetingOptional);
// Perform the behavior being tested
final MvcResult result = mvc
@@ -145,6 +156,11 @@ public void testGetGreeting() throws Exception {
Assert.assertTrue("failure - expected HTTP response body to have a value", !Strings.isNullOrEmpty(content));
}
+ /**
+ * Test fetch a Greeting with unknown identifier.
+ *
+ * @throws Exception Thrown if mocking failure occurs.
+ */
@Test
public void testGetGreetingNotFound() throws Exception {
@@ -152,7 +168,7 @@ public void testGetGreetingNotFound() throws Exception {
final Long id = Long.MAX_VALUE;
// Stub the GreetingService.findOne method return value
- when(greetingService.findOne(id)).thenReturn(null);
+ when(greetingService.findOne(id)).thenReturn(Optional.empty());
// Perform the behavior being tested
final MvcResult result = mvc
@@ -168,10 +184,15 @@ public void testGetGreetingNotFound() throws Exception {
// Perform standard JUnit assertions on the test results
Assert.assertEquals("failure - expected HTTP status 404", 404, status);
- Assert.assertTrue("failure - expected HTTP response body to be empty", Strings.isNullOrEmpty(content));
+ Assert.assertTrue("failure - expected HTTP response body to have a value", !Strings.isNullOrEmpty(content));
}
+ /**
+ * Test create a Greeting.
+ *
+ * @throws Exception Thrown if mocking failure occurs.
+ */
@Test
public void testCreateGreeting() throws Exception {
@@ -208,6 +229,11 @@ public void testCreateGreeting() throws Exception {
Assert.assertEquals("failure - expected text attribute match", entity.getText(), createdEntity.getText());
}
+ /**
+ * Test update a Greeting.
+ *
+ * @throws Exception Thrown if mocking failure occurs.
+ */
@Test
public void testUpdateGreeting() throws Exception {
@@ -245,6 +271,11 @@ public void testUpdateGreeting() throws Exception {
}
+ /**
+ * Test delete a Greeting.
+ *
+ * @throws Exception Thrown if mocking failure occurs.
+ */
@Test
public void testDeleteGreeting() throws Exception {
@@ -267,15 +298,20 @@ public void testDeleteGreeting() throws Exception {
}
+ /**
+ * Test sending email asynchronously.
+ *
+ * @throws Exception Thrown if mocking failure occurs.
+ */
@Test
public void testSendGreetingAsync() throws Exception {
// Create some test data
final Long id = Long.valueOf(1);
- final Greeting entity = getEntityStubData();
+ final Optional greetingOptional = Optional.of(getEntityStubData());
// Stub the GreetingService.findOne method return value
- when(greetingService.findOne(id)).thenReturn(entity);
+ when(greetingService.findOne(id)).thenReturn(greetingOptional);
// Perform the behavior being tested
final MvcResult result = mvc.perform(
@@ -297,8 +333,8 @@ public void testSendGreetingAsync() throws Exception {
Assert.assertTrue("failure - expected HTTP response body to have a value", !Strings.isNullOrEmpty(content));
}
- private Collection getEntityListStubData() {
- final Collection list = new ArrayList();
+ private List getEntityListStubData() {
+ final List list = new ArrayList();
list.add(getEntityStubData());
return list;
}
diff --git a/src/test/java/com/leanstacks/ws/web/api/SendGreetingDocTest.java b/src/test/java/com/leanstacks/ws/web/api/SendGreetingDocTest.java
new file mode 100644
index 0000000..f139b0f
--- /dev/null
+++ b/src/test/java/com/leanstacks/ws/web/api/SendGreetingDocTest.java
@@ -0,0 +1,90 @@
+package com.leanstacks.ws.web.api;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.http.MediaType;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
+import org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders;
+import org.springframework.restdocs.payload.JsonFieldType;
+import org.springframework.restdocs.payload.PayloadDocumentation;
+import org.springframework.restdocs.request.RequestDocumentation;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
+
+import com.leanstacks.ws.AbstractDocTest;
+import com.leanstacks.ws.RestControllerTest;
+
+/**
+ *
+ * Generate REST API documentation for the GreetingController.
+ *
+ *
+ * These tests utilize Spring's REST Docs Framework to generate API documentation. There is a separate test class
+ * responsible for unit testing functionality.
+ *
+ *
+ * @author Matt Warman
+ */
+@RunWith(SpringRunner.class)
+@RestControllerTest
+public class SendGreetingDocTest extends AbstractDocTest {
+
+ @Override
+ public void doBeforeEachTest() {
+ // perform test initialization
+ }
+
+ @Override
+ public void doAfterEachTest() {
+ // perform test cleanup
+ }
+
+ /**
+ * Generate API documentation for POST /api/greetings/{id}/send.
+ *
+ * @throws Exception Thrown if documentation generation failure occurs.
+ */
+ @Test
+ public void documentSendGreeting() throws Exception {
+
+ // Generate API Documentation
+ final MvcResult result = this.mockMvc
+ .perform(RestDocumentationRequestBuilders
+ .post("/api/greetings/{id}/send?wait=true", 1).accept(MediaType.APPLICATION_JSON))
+ .andExpect(MockMvcResultMatchers.status().isOk())
+ .andDo(MockMvcRestDocumentation.document("send-greeting",
+ RequestDocumentation.pathParameters(
+ RequestDocumentation.parameterWithName("id").description("The greeting identifier.")),
+ RequestDocumentation.requestParameters(RequestDocumentation.parameterWithName("wait")
+ .description("Optional. Boolean. Wait for email to be sent.").optional()),
+ PayloadDocumentation.relaxedResponseFields(
+ PayloadDocumentation
+ .fieldWithPath("id")
+ .description(
+ "The identifier. Used to reference specific greetings in API requests.")
+ .type(JsonFieldType.NUMBER),
+ PayloadDocumentation.fieldWithPath("referenceId")
+ .description("The supplementary identifier.").type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("text").description("The text.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("version").description("The entity version.")
+ .type(JsonFieldType.NUMBER),
+ PayloadDocumentation.fieldWithPath("createdBy").description("The entity creator.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("createdAt").description("The creation timestamp.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("updatedBy").description("The last modifier.")
+ .type(JsonFieldType.STRING).optional(),
+ PayloadDocumentation.fieldWithPath("updatedAt")
+ .description("The last modification timestamp.").type(JsonFieldType.STRING)
+ .optional())))
+ .andReturn();
+
+ // Perform a simple, standard JUnit assertion to satisfy PMD rule
+ Assert.assertEquals("failure - expected HTTP status 200", 200, result.getResponse().getStatus());
+
+ }
+
+}
diff --git a/src/test/java/com/leanstacks/ws/web/api/UpdateGreetingDocTest.java b/src/test/java/com/leanstacks/ws/web/api/UpdateGreetingDocTest.java
new file mode 100644
index 0000000..6b31a86
--- /dev/null
+++ b/src/test/java/com/leanstacks/ws/web/api/UpdateGreetingDocTest.java
@@ -0,0 +1,94 @@
+package com.leanstacks.ws.web.api;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.http.MediaType;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
+import org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders;
+import org.springframework.restdocs.payload.JsonFieldType;
+import org.springframework.restdocs.payload.PayloadDocumentation;
+import org.springframework.restdocs.request.RequestDocumentation;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
+
+import com.leanstacks.ws.AbstractDocTest;
+import com.leanstacks.ws.RestControllerTest;
+
+/**
+ *
+ * Generate REST API documentation for the GreetingController.
+ *
+ *
+ * These tests utilize Spring's REST Docs Framework to generate API documentation. There is a separate test class
+ * responsible for unit testing functionality.
+ *
+ *
+ * @author Matt Warman
+ */
+@RunWith(SpringRunner.class)
+@RestControllerTest
+public class UpdateGreetingDocTest extends AbstractDocTest {
+
+ /**
+ * The HTTP request body content.
+ */
+ private static final String REQUEST_BODY = "{ \"text\": \"Bonjour le monde!\" }";
+
+ @Override
+ public void doBeforeEachTest() {
+ // perform test initialization
+ }
+
+ @Override
+ public void doAfterEachTest() {
+ // perform test cleanup
+ }
+
+ /**
+ * Generate API documentation for PUT /api/greetings/{id}.
+ *
+ * @throws Exception Thrown if documentation generation failure occurs.
+ */
+ @Test
+ public void documentUpdateGreeting() throws Exception {
+
+ // Generate API Documentation
+ final MvcResult result = this.mockMvc.perform(RestDocumentationRequestBuilders.put("/api/greetings/{id}", 1)
+ .contentType(MediaType.APPLICATION_JSON).accept(MediaType.APPLICATION_JSON).content(REQUEST_BODY))
+ .andExpect(MockMvcResultMatchers.status().isOk())
+ .andDo(MockMvcRestDocumentation.document("update-greeting",
+ RequestDocumentation.pathParameters(
+ RequestDocumentation.parameterWithName("id").description("The greeting identifier.")),
+ PayloadDocumentation.relaxedRequestFields(PayloadDocumentation.fieldWithPath("text")
+ .description("The text.").type(JsonFieldType.STRING)),
+ PayloadDocumentation.relaxedResponseFields(
+ PayloadDocumentation
+ .fieldWithPath("id")
+ .description(
+ "The identifier. Used to reference specific greetings in API requests.")
+ .type(JsonFieldType.NUMBER),
+ PayloadDocumentation.fieldWithPath("referenceId")
+ .description("The supplementary identifier.").type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("text").description("The text.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("version").description("The entity version.")
+ .type(JsonFieldType.NUMBER),
+ PayloadDocumentation.fieldWithPath("createdBy").description("The entity creator.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("createdAt").description("The creation timestamp.")
+ .type(JsonFieldType.STRING),
+ PayloadDocumentation.fieldWithPath("updatedBy").description("The last modifier.")
+ .type(JsonFieldType.STRING).optional(),
+ PayloadDocumentation.fieldWithPath("updatedAt")
+ .description("The last modification timestamp.").type(JsonFieldType.STRING)
+ .optional())))
+ .andReturn();
+
+ // Perform a simple, standard JUnit assertion to satisfy PMD rule
+ Assert.assertEquals("failure - expected HTTP status 200", 200, result.getResponse().getStatus());
+
+ }
+
+}