tests added with comments

marco76 · marco76 · commit 405878399159 · 2022-02-10T11:06:02.000+01:00
diff --git a/backend/pom.xml b/backend/pom.xml
@@ -24,7 +24,13 @@
         <artifactId>frontend</artifactId>
         <version>${project.version}</version>
         <type>jar</type>
+        <!-- we add optional to work with the backend package without building the frontend -->
+        <optional>true</optional>
     </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/backend/src/main/java/application.properties b/backend/src/main/java/application.properties
@@ -0,0 +1,2 @@
+# url of the development frontend
+app.dev.frontend.local=http://localhost:4200
diff --git a/backend/src/main/java/dev/marco/example/springboot/HelloController.java b/backend/src/main/java/dev/marco/example/springboot/HelloController.java
@@ -9,10 +9,12 @@
 import java.util.Map;
 
 @RestController
-// we allow localhost:4200 for testing purposes
-@CrossOrigin(origins = "http://localhost:4200")
+// we allow cors requests from our frontend environment
+// note the curly braces that creates an array of strings ... required by the annotation
+@CrossOrigin(origins =  {"${app.dev.frontend.local"})
 public class HelloController {
 
+    // simple GET response for our example purpose, we return a JSON structure
     @RequestMapping(value = "/message", produces = MediaType.APPLICATION_JSON_VALUE)
     public Map<String, String> index() {
         return Collections.singletonMap("message", "Greetings from Spring Boot!");
diff --git a/backend/src/test/java/dev/marco/example/springboot/HelloControllerEmbeddedServerTest.java b/backend/src/test/java/dev/marco/example/springboot/HelloControllerEmbeddedServerTest.java
@@ -0,0 +1,40 @@
+package dev.marco.example.springboot;
+
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.boot.web.server.LocalServerPort;
+
+/**
+ * The goal of this class is to show how the Embedded Server is used to test the REST service
+ */
+
+// SpringBootTest launch an instance of our application for tests purposes
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+class HelloControllerEmbeddedServerTest {
+
+    @Autowired
+    private HelloController helloController;
+
+    // inject the runtime port, it requires the webEnvironment
+    @LocalServerPort
+    private int port;
+
+    // we use TestRestTemplate, it's an alternative to RestTemplate specific for tests
+    // to use this template a webEnvironment is mandatory
+    @Autowired
+    private TestRestTemplate restTemplate;
+
+    @Test
+    void index() {
+        // we test that our controller is not null
+        Assertions.assertThat(helloController).isNotNull();
+    }
+
+    @Test
+    void indexResultTest() {
+        Assertions.assertThat(restTemplate.getForObject("http://localhost:" + port + "/message", String.class)).contains("from Spring Boot");
+    }
+}
diff --git a/backend/src/test/java/dev/marco/example/springboot/HelloControllerMockMvcTest.java b/backend/src/test/java/dev/marco/example/springboot/HelloControllerMockMvcTest.java
@@ -0,0 +1,32 @@
+package dev.marco.example.springboot;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.web.servlet.MockMvc;
+
+import static org.hamcrest.Matchers.containsString;
+import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+
+/**
+ * The goal of this class is to test the controller using a MockMvc object without embedded server
+ */
+@SpringBootTest
+@AutoConfigureMockMvc // we mock the http request and we don't need a server
+public class HelloControllerMockMvcTest {
+
+    @Autowired
+    private MockMvc mockMvc; // injected with @AutoConfigureMockMvc
+
+    @Test
+    public void shouldReturnOurText() throws Exception {
+        this.mockMvc
+                .perform(get("/message")) // perform a request that can be chained
+                .andDo(print()) // we log the result
+                .andExpect(content().string(containsString(" from Spring"))); // we check that the Body of the answer contains our expectation
+    }
+
+}
diff --git a/pom.xml b/pom.xml
@@ -29,5 +29,10 @@
             <artifactId>spring-boot-starter-web</artifactId>
             <version>2.4.3</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <version>2.4.3</version>
+        </dependency>
     </dependencies>
 </project>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# url of the development frontend`
	`2`	`+app.dev.frontend.local=http://localhost:4200`