{"id":1153,"date":"2022-01-02T14:20:36","date_gmt":"2022-01-02T21:20:36","guid":{"rendered":"https:\/\/bullyrooks.com\/?p=1153"},"modified":"2022-01-04T19:54:01","modified_gmt":"2022-01-05T02:54:01","slug":"cloud-kube-simple-rest-endpoint-and-test","status":"publish","type":"post","link":"https:\/\/bullyrooks.com\/index.php\/2022\/01\/02\/cloud-kube-simple-rest-endpoint-and-test\/","title":{"rendered":"Cloud Kube | Simple REST Endpoint and Test"},"content":{"rendered":"\n
In the previous article we created the skeleton repo and project. In this article we’ll be building a very basic endpoint and component test.<\/p>\n\n\n\n
Although I do hate hello world examples my intent is to get us to a point where we can focus on the build and deploy path. The easiest way to do that is via a basic microservice that we can validate our deployment with. Then we’ll iterate on our application behavior. A basic hello world endpoint will be sufficient for that. Additionally, this is how I would recommend building out any project that does not already have a build and deploy pipeline created.<\/p>\n\n\n\n
Create a Basic Microservice Endpoint<\/h2>\n\n\n\n
Create a new directory under src\/main\/java\/com\/bullyrooks\/cloud_application<\/code> called \/controller<\/code>. Create a new java class there called HelloWorldController<\/code>.<\/p>\n\n\n\n<\/figure>\n\n\n\n
Create a new directory under controller called \/dto<\/code> and create a new java class called HelloWorldResponse <\/code>in that directory.<\/p>\n\n\n\n<\/figure>\n\n\n\n
In HelloWorldResponse <\/code>add this code:<\/p>\n\n\n\n
@Data\n@NoArgsConstructor\n@AllArgsConstructor\n@Builder\npublic class HelloWorldResponse {\n private String message;\n}<\/code><\/pre>\n\n\n\n
In HelloWorldController <\/code>add this code:<\/p>\n\n\n\n
@RestController\npublic class HelloWorldController {\n\n @GetMapping(\"\/helloworld\")\n public HelloWorldResponse getHelloWorld(){\n return HelloWorldResponse.builder().message(\"Hello World!\").build();\n }\n}<\/code><\/pre>\n\n\n\n
Manual Testing<\/h2>\n\n\n\n
Start your application inside intellij. Intellij should have already created an executable configuration for spring boot. Click the green start arrow<\/p>\n\n\n\n<\/figure>\n\n\n\n
you should see it start up in the terminal<\/p>\n\n\n\n
2022-01-02 13:57:27.624 INFO 23284 --- [ restartedMain] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''\n2022-01-02 13:57:27.631 INFO 23284 --- [ restartedMain] c.b.cloud_application.CloudApplication : Started CloudApplication in 1.339 seconds (JVM running for 1.961)\n<\/code><\/pre>\n\n\n\n
And you should be able to hit your endpoint with a GET<\/code> at http:\/\/localhost:8080\/helloworld<\/code>. I recommend using postman<\/p>\n\n\n\n<\/figure>\n\n\n\n
Automated Testing<\/h2>\n\n\n\n
Stop your running application. Create a new directory called \/controller<\/code> under src\/test\/java\/com\/bullyrooks\/cloud_a<\/code>pplication. In that directory create a test class called HelloWorldControllerTest<\/code><\/p>\n\n\n\n
Add this code to that class:<\/p>\n\n\n\n
package com.bullyrooks.cloud_application.controller;\n\nimport com.bullyrooks.cloud_application.controller.dto.HelloWorldResponse;\nimport com.fasterxml.jackson.core.JsonProcessingException;\nimport lombok.extern.slf4j.Slf4j;\nimport org.junit.jupiter.api.Test;\nimport org.junit.jupiter.api.extension.ExtendWith;\nimport org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;\nimport org.springframework.boot.test.context.SpringBootTest;\nimport org.springframework.boot.web.server.LocalServerPort;\nimport org.springframework.http.HttpHeaders;\nimport org.springframework.http.MediaType;\nimport org.springframework.http.ResponseEntity;\nimport org.springframework.test.context.junit.jupiter.SpringExtension;\nimport org.springframework.web.client.RestTemplate;\n\nimport java.net.URI;\nimport java.net.URISyntaxException;\n\nimport static org.junit.jupiter.api.Assertions.assertEquals;\n\n@ExtendWith(SpringExtension.class)\n@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)\n@Slf4j\n@AutoConfigureMockMvc\npublic class HelloWorldControllerTest {\n @LocalServerPort\n int randomServerPort;\n\n @Test\n void testAddCustomerSuccess() throws URISyntaxException, JsonProcessingException {\n RestTemplate restTemplate = new RestTemplate();\n String baseUrl = \"http:\/\/localhost:\" + randomServerPort + \"\/helloworld\";\n URI uri = new URI(baseUrl);\n\n HttpHeaders headers = new HttpHeaders();\n headers.set(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE);\n\n ResponseEntity<HelloWorldResponse> result = restTemplate.getForEntity(uri, HelloWorldResponse.class);\n\n \/\/Verify request succeed\n assertEquals(200, result.getStatusCodeValue());\n HelloWorldResponse response = result.getBody();\n assertEquals(\"Hello World!\", response.getMessage());\n }\n}\n\n<\/code><\/pre>\n\n\n\n
Right click on your test class and select Run HelloWorldControllerTest<\/code><\/p>\n\n\n\n<\/figure>\n\n\n\n
You should see it pass<\/p>\n\n\n\n<\/figure>\n\n\n\n
This is a good place to stop. Lets get this up on a branch.<\/p>\n\n\n\n
$ git checkout -b microservice_dev\nSwitched to a new branch 'microservice_dev'\n\n$ git add .\n\n$ git commit -m \"endpoint and test\"\n[microservice_dev 655eb72] endpoint and test\n 4 files changed, 76 insertions(+), 1 deletion(-)\n create mode 100644 src\/main\/java\/com\/bullyrooks\/cloud_application\/controller\/HelloWorldController.java\n create mode 100644 src\/main\/java\/com\/bullyrooks\/cloud_application\/controller\/dto\/HelloWorldResponse.java\n create mode 100644 src\/test\/java\/com\/bullyrooks\/cloud_application\/controller\/HelloWorldControllerTest.java\n\n$ git push --set-upstream origin microservice_dev\nEnumerating objects: 31, done.\nCounting objects: 100% (31\/31), done.\nDelta compression using up to 4 threads\nCompressing objects: 100% (13\/13), done.\nWriting objects: 100% (20\/20), 2.30 KiB | 1.15 MiB\/s, done.\nTotal 20 (delta 2), reused 0 (delta 0), pack-reused 0\nremote: Resolving deltas: 100% (2\/2), completed with 2 local objects.\nremote: \nremote: Create a pull request for 'microservice_dev' on GitHub by visiting:\nremote: https:\/\/github.com\/bullyrooks\/cloud_application\/pull\/new\/microservice_dev\nremote:\nTo github.com-bullyrook:bullyrooks\/cloud_application.git\n * [new branch] microservice_dev -> microservice_dev\nBranch 'microservice_dev' set up to track remote branch 'microservice_dev' from 'origin'.<\/code><\/pre>\n\n\n\n
We’re not going to push to main just yet. I want to keep this work on a feature branch for now so that I can build out my CICD pipeline.<\/p>\n","protected":false},"excerpt":{"rendered":"
\nIn the previous article we created the skeleton repo and project. In…\n<\/div>\n
![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/01\/image-8.png?resize=360%2C181&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/01\/image-9.png?resize=224%2C102&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/01\/image-10.png?resize=212%2C30&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/01\/image-11.png?resize=534%2C417&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/01\/image-12.png?resize=481%2C405&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/01\/image-13.png?resize=368%2C116&ssl=1\")
<\/figure>\n\n\n\n