Test/cucumber get post (#42)

* feat(config_cucumber): add cucumber dependencies

* test(cucumber_get_post): add one integration test for post

* test(cucumber_get_post): exclude springintegration test file for sonar

* test(cucumber_get_post): add documentation to launch cucumber test

* test(cucumber_get_post): ajout des tests sur le get

* test(cucumber_get_post): use datatable instead of chaining And

* test(cucumber_get_post): suppression des librairies non utilisées

* test(cucumber_get_post): change schema.sql to use users instead of USERS

* test(cucumber_get_post): remove cucumber tests form sonar build

---------

Co-authored-by: Romain Vanhee <romain.vanhee@yrycom.com>

Author: profotoce59

.github/workflows/sonar.yaml

@@ -40,4 +40,4 @@ jobs:
           mkdir -p src/test/resources
           echo ${{ secrets.APPLICATION_TEST_PROPERTIES }} | base64 -d > src/test/resources/application-test.properties
           echo "spring.sql.init.mode=never" >> src/test/resources/application-test.properties
-          mvn clean verify sonar:sonar -DskipDocker=true -Dsonar.qualitygate.wait=true
+          mvn clean verify sonar:sonar -DskipDocker=true -Dsonar.qualitygate.wait=true -Dit.test="!CucumberIntegrationTest"

README.md

@@ -132,13 +132,16 @@ curl -X PUT "http://localhost:8080/random-users/1" \
 
 # With coverage report (target/site/jacoco/index.html)
 ./mvnw clean verify
+
+#cucumber tests
+./mvnw verify -DskipDocker=true -Dit.test=CucumberIntegrationTest
 ```
 
 **Test Stack:**
 - JUnit 5 - Testing framework
 - Mockito - Mocking
 - JaCoCo - Code coverage
-- Cucumber - BDD (planned)
+- Cucumber - BDD
 
 ---
 

pom.xml

@@ -30,6 +30,7 @@
 		<java.version>25</java.version>
 		<skipDocker>false</skipDocker>
 		<sonar.coverage.exclusions>**/*Application.java</sonar.coverage.exclusions>
+		<sonar.test.exclusions>**/feature/SpringIntegrationTest.java</sonar.test.exclusions>
 		<sonar.coverage.jacoco.xmlReportPaths>${project.build.directory}/site/jacoco/jacoco.xml</sonar.coverage.jacoco.xmlReportPaths>
 	</properties>
 	<dependencies>
@@ -83,9 +84,15 @@
 			<artifactId>spring-boot-starter-data-jdbc-test</artifactId>
 			<scope>test</scope>
 		</dependency>
+			<dependency>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-starter-webmvc-test</artifactId>
+				<scope>test</scope>
+			</dependency>
 		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-webmvc-test</artifactId>
+			<groupId>io.cucumber</groupId>
+			<artifactId>cucumber-spring</artifactId>
+			<version>7.14.0</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
@@ -96,16 +103,26 @@
 		</dependency>
 		<dependency>
 			<groupId>io.cucumber</groupId>
-			<artifactId>cucumber-junit</artifactId>
+			<artifactId>cucumber-junit-platform-engine</artifactId>
 			<version>7.14.0</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
-			<groupId>io.cucumber</groupId>
-			<artifactId>cucumber-spring</artifactId>
-			<version>7.14.0</version>
+			<groupId>org.junit.platform</groupId>
+			<artifactId>junit-platform-suite</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-restclient</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+
 	</dependencies>
 
 	<build>

src/main/java/com/xpeho/spring_boot_java_random_user/data/models/db/User.java

@@ -7,16 +7,23 @@
 @Table("users")
 public class User {
     @Id
+    @Column("id")
     private Long id;
+    @Column("gender")
     private String gender;
     @Column("firstname")
     private String firstname;
     @Column("lastname")
     private String lastname;
+    @Column("civility")
     private String civility;
+    @Column("email")
     private String email;
+    @Column("phone")
     private String phone;
+    @Column("picture")
     private String picture;
+    @Column("nationality")
     private String nationality;
 
     // Required by Spring Data JDBC to instantiate the entity via reflection

src/test/java/feature/CucumberIntegrationTest.java

@@ -0,0 +1,18 @@
+package feature;
+
+import org.junit.platform.suite.api.ConfigurationParameter;
+import org.junit.platform.suite.api.IncludeEngines;
+import org.junit.platform.suite.api.SelectClasspathResource;
+import org.junit.platform.suite.api.Suite;
+
+import static io.cucumber.junit.platform.engine.Constants.GLUE_PROPERTY_NAME;
+import static io.cucumber.junit.platform.engine.Constants.PLUGIN_PROPERTY_NAME;
+
+@Suite
+@IncludeEngines("cucumber")
+@SelectClasspathResource("features")
+@ConfigurationParameter(key = GLUE_PROPERTY_NAME, value = "feature")
+@ConfigurationParameter(key = PLUGIN_PROPERTY_NAME, value = "pretty")
+public class CucumberIntegrationTest {
+
+}

src/test/java/feature/SpringIntegrationTest.java

@@ -0,0 +1,49 @@
+package feature;
+
+import com.xpeho.spring_boot_java_random_user.SpringBootJavaRandomUserApplication;
+import io.cucumber.spring.CucumberContextConfiguration;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.resttestclient.TestRestTemplate;
+import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureTestRestTemplate;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.server.LocalServerPort;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.test.context.ActiveProfiles;
+
+@CucumberContextConfiguration
+@ActiveProfiles("test")
+@AutoConfigureTestRestTemplate
+@SpringBootTest(
+    classes = SpringBootJavaRandomUserApplication.class,
+    webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
+    properties = {
+        "spring.sql.init.mode=always",
+        "spring.sql.init.schema-locations=classpath:schema-h2.sql"
+    }
+)
+public class SpringIntegrationTest {
+
+    @Autowired
+    protected TestRestTemplate restTemplate;
+
+    @LocalServerPort
+    protected int port;
+
+    protected ResponseEntity<String> latestResponse;
+
+    protected void executeGet(String path) {
+        String url = "http://localhost:" + port + path;
+        latestResponse = restTemplate.getForEntity(url, String.class);
+    }
+
+    protected void executePost(String path, Object payload) {
+        String url = "http://localhost:" + port + path;
+        HttpHeaders headers = new HttpHeaders();
+        headers.setContentType(MediaType.APPLICATION_JSON);
+        HttpEntity<Object> request = new HttpEntity<>(payload, headers);
+        latestResponse = restTemplate.postForEntity(url, request, String.class);
+    }
+}

src/test/java/feature/StepDefinition.java

@@ -0,0 +1,82 @@
+package feature;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.xpeho.spring_boot_java_random_user.domain.entities.UserRequest;
+import io.cucumber.datatable.DataTable;
+import io.cucumber.java.en.And;
+import io.cucumber.java.en.Given;
+import io.cucumber.java.en.Then;
+import io.cucumber.java.en.When;
+
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class StepDefinition extends SpringIntegrationTest {
+
+    private final ObjectMapper objectMapper = new ObjectMapper();
+    private UserRequest payload;
+    private Long createdUserId;
+
+    @Given("a valid user payload for creation")
+    public void aValidUserPayloadForCreation() {
+        payload = new UserRequest(
+            "female",
+            "Emma",
+            "Stone",
+            "Ms",
+            "emma@example.com",
+            "0644444444",
+            "emma.jpg",
+            "FR"
+        );
+    }
+
+    @When("the client call to POST \\/random-users")
+    public void theClientCallToPostRandomUser() {
+        executePost("/random-users", payload);
+    }
+
+    @Then("the response status should be {int}")
+    public void theResponseStatusShouldBe(int expectedStatus) {
+        assertEquals(expectedStatus, latestResponse.getStatusCode().value());
+    }
+
+    @And("the user profile")
+    public void theUserProfile(DataTable table) throws Exception{
+        JsonNode body = objectMapper.readTree(latestResponse.getBody());
+        List<List<String>> rows = table.asLists(String.class);
+        for (List<String> row : rows) {
+            String field = row.get(0).trim();
+            String expected = row.get(1).trim();
+            JsonNode valueNode = body.get(field);
+            assertNotNull(valueNode);
+
+            if ("<generated_id>".equals(expected)) {
+                createdUserId = valueNode.asLong();
+                assertTrue(createdUserId > 0);
+                continue;
+            }
+            if ("<created_id>".equals(expected)) {
+                assertNotNull(createdUserId);
+                assertEquals(createdUserId.toString(), valueNode.asText());
+                continue;
+            }
+            assertEquals(expected, valueNode.asText());
+        }
+    }
+
+    @When("the client call to GET \\/random-users\\/{int}")
+    public void theClientCallToGetRandomUser(int id) {
+        executeGet("/random-users/" + id);
+    }
+
+    @When("the client call to GET the created user")
+    public void theClientCallToGetTheCreatedUser() {
+        assertNotNull(createdUserId, "No user was created before this step");
+        executeGet("/random-users/" + createdUserId);
+    }
+}

src/test/resources/features/create_user.feature

@@ -0,0 +1,9 @@
+Feature: Create user endpoint
+
+  Scenario: Create a user successfully
+    Given a valid user payload for creation
+    When the client call to POST /random-users
+    Then the response status should be 201
+    And the user profile
+      | id        | <generated_id> |
+      | firstname | Emma |

src/test/resources/features/get_user.feature

@@ -0,0 +1,17 @@
+Feature: Get user endpoint
+
+  Scenario: Get a user by ID after creation
+    Given a valid user payload for creation
+    When the client call to POST /random-users
+    Then the response status should be 201
+    And the user profile
+      | id | <generated_id> |
+    When the client call to GET the created user
+    Then the response status should be 200
+    And the user profile
+      | id        | <created_id> |
+      | firstname | Emma |
+
+  Scenario: Get a user that does not exist
+    When the client call to GET /random-users/999
+    Then the response status should be 404

src/test/resources/schema-h2.sql

@@ -0,0 +1,14 @@
+DROP TABLE IF EXISTS "users";
+
+CREATE TABLE IF NOT EXISTS "users"
+(
+    id          BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
+    gender      VARCHAR(20),
+    firstname   VARCHAR(100),
+    lastname    VARCHAR(100),
+    civility    VARCHAR(20),
+    email       VARCHAR(255),
+    phone       VARCHAR(50),
+    picture     VARCHAR(500),
+    nationality VARCHAR(10)
+);