• 6 Cucumber
  • 6.1 Gherkin keywords
  • 6.2 Maven dependencies
  • 6.3 寫 Java code
  • 6.4 寫 Cucumber .feature 檔
  • 6.5 測試
    • 6.5.1 Eclipse 執行 JUnit test
    • 6.5.2 Maven CLI
  • 6.6 參考資料

1Feature: Keyword search with Google
2
3  Scenario: A Google text search
4    Given the web browser is displaying the Google Search home page
5    When I enter "cucumber" as the search keyword
6	And I click the Search button
7    Then search results for "cucumber" should be shown

1<parent>
2	<groupId>org.springframework.boot</groupId>
3	<artifactId>spring-boot-starter-parent</artifactId>
4	<version>3.2.3</version>
5</parent>
6
7<dependencyManagement>
8	<dependencies>
9		<dependency>
10			<groupId>io.cucumber</groupId>
11			<artifactId>cucumber-bom</artifactId>
12			<version>7.15.0</version>
13			<type>pom</type>
14			<scope>import</scope>
15		</dependency>
16	</dependencies>
17</dependencyManagement>
18
19<dependencies>
20	<dependency>
21		<groupId>org.springframework.boot</groupId>
22		<artifactId>spring-boot-starter-web</artifactId>
23	</dependency>
24
25	<!-- database -->
26	<dependency>
27		<groupId>org.springframework.boot</groupId>
28		<artifactId>spring-boot-starter-data-jpa</artifactId>
29	</dependency>
30	<dependency>
31		<groupId>com.mysql</groupId>
32		<artifactId>mysql-connector-j</artifactId>
33	</dependency>
34
35	<dependency>
36		<groupId>org.projectlombok</groupId>
37		<artifactId>lombok</artifactId>
38		<scope>provided</scope>
39	</dependency>
40
41	<dependency>
42		<groupId>org.apache.commons</groupId>
43		<artifactId>commons-lang3</artifactId>
44	</dependency>
45
46	<!-- testing -->
47	<dependency>
48		<groupId>org.springframework.boot</groupId>
49		<artifactId>spring-boot-starter-test</artifactId>
50		<scope>test</scope>
51	</dependency>
52	<dependency>
53		<groupId>com.h2database</groupId>
54		<artifactId>h2</artifactId>
55		<scope>test</scope>
56	</dependency>
57	<dependency>
58		<groupId>io.cucumber</groupId>
59		<artifactId>cucumber-java</artifactId>
60		<scope>test</scope>
61	</dependency>
62	<dependency>
63		<groupId>io.cucumber</groupId>
64		<artifactId>cucumber-junit</artifactId>
65		<scope>test</scope>
66	</dependency>
67	<dependency>
68		<groupId>io.cucumber</groupId>
69		<artifactId>cucumber-spring</artifactId>
70		<scope>test</scope>
71	</dependency>
72	<dependency>
73		<groupId>org.junit.vintage</groupId>
74		<artifactId>junit-vintage-engine</artifactId> <!-- JUnit 4 -->
75		<scope>test</scope>
76	</dependency>
77</dependencies>

• 我地既 BDD test 會用 H2 database，以免連線到真既 MySQL database。
• 我地用左 cucumber-bom 黎控制 Cucumber test dependencies 既版本號碼。
• 我地需要用返 JUnit 4，所以要加 junit-vintage-engine 既 test dependency。

• src/main/java
  • /code
    • /controller
      • UserController.java
    • /entity
      • UserEntity.java
    • /repo
      • UserRepo.java
    • /service
      • UserService.java
    • MainApplication.java
• src/test/java
  • /code
    • /user
      • CucumberSpringConfig.java
      • UserSteps.java
    • UserTest.java
• src/test/resources
  • /features
    • /user
      • basic.feature

1@CucumberContextConfiguration
2@SpringBootTest(
3    classes = MainApplication.class,
4    webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
5public class CucumberSpringConfig {
6
7}

1@RunWith(Cucumber.class)
2@CucumberOptions(
3    features = {
4        "src/test/resources/features"
5    },
6    glue = "code.user"
7)
8public class UserTest {
9
10}

1@Slf4j
2public class UserSteps {
3
4    @Autowired UserRepo userRepo;
5    @LocalServerPort int port;
6    RestClient client = RestClient.builder().build();
7
8    List<UserEntity> users;
9
10
11
12    @Given("{int} users have registered")
13    public void someNumberOfUsersHaveRegistered(int databaseUserCount) {
14
15        // 用呢句黎測試一下 "users" instance field 既 scope，我地會發現每次都係 print null。
16        System.out.println("Mick: " + users);
17
18        userRepo.deleteAll();
19
20        IntStream.rangeClosed(1, databaseUserCount)
21            .mapToObj(this::createTestUser).forEach(userRepo::save);
22
23        final long userCount = userRepo.count();
24
25        log.info("User table now has {} records.", userCount);
26    }
27
28    @When("I make a request to get all users")
29    public void makeRequestToGetAllUsers() {
30        users = client.get().uri(getUrl("/users")).retrieve()
31                    .body(new ParameterizedTypeReference<>() {});
32    }
33
34    @When("I make a request to get page {int} of all users with page size of {int}")
35    public void makeRequestToGetPageOfSomeNumberAllUsersWithPageSizeOfSomeNumber(int page, int size) throws Exception {
36        final JsonNode node = client.get().uri(getUrl(format("/users/paged?page=%d&size=%d", page, size))).retrieve()
37                    .body(JsonNode.class);
38        users = new JsonMapper().readerForListOf(UserEntity.class).readValue(node.get("content"));
39        users.forEach(System.out::println);
40    }
41
42    @Then("the response should give me exactly {int} users")
43    public void responseShouldReturnSomeNumberOfUsers(int userCount) {
44        assertEquals(userCount, users.size());
45    }
46
47    @Then("every user is different")
48    public void everyUserIsDifferent() {
49        final Set<Long> userIds = users.stream().map(UserEntity::getId).collect(Collectors.toSet());
50        assertEquals(users.size(), userIds.size());
51    }
52
53
54
55    private String getUrl(String path) {
56        return "http://localhost:" + port + path;
57    }
58
59    private UserEntity createTestUser(int id) {
60
61        final UserEntity user = new UserEntity();
62        user.setName(RandomStringUtils.randomAlphabetic(20));
63        user.setUserType("NORMAL");
64        user.setRegisterDatetime(new Timestamp(System.currentTimeMillis()));
65        user.setEmail(RandomStringUtils.randomAlphabetic(20) + "@example.com");
66
67        return user;
68    }
69}

• 我地喺 UserSteps 裡面寫既 @Given、@When、@Then method annotations 既 value 係對應返我地既 .feature 檔既 behavior 描述。
  • 其實全部 methods annotate 曬做 @Given、@When、@Then 既其中一種都可以，唔需要 exactly match .feature 檔裡面 scenario 既 keywords。
  • @Given、@When、@Then 可以用 {int}、{string} 之類既 placeholders 黎對應返 method arguments。
• 我地可以用 instance fields 黎喺同一個 scenario 裡面既 Given-When-Then 之間 share data。
  • 除非用到 Spring 既 annotations，否則一般既 instance fields 都會喺 scenario 開始既時候清除（null），例如 UserSteps 既 List<UserEntity> users。

1Feature: User features
2
3  Scenario Outline: Get All - <userCount> users when there are <userCount> users
4    Given <userCount> users have registered
5    When I make a request to get all users
6    Then the response should give me exactly <userCount> users
7    And every user is different
8
9    Examples:
10      | userCount |
11      |         0 |
12      |         1 |
13      |        10 |
14
15  Scenario Outline: Get All (Paged) - <expectedUserCount> users when getting page <page> with size of <size> when there are <userCount> users
16    Given <userCount> users have registered
17    When I make a request to get page <page> of all users with page size of <size>
18    Then the response should give me exactly <expectedUserCount> users
19    And every user is different
20
21    Examples:
22      | userCount | size | page | expectedUserCount |
23      |         0 |    0 |    0 |                 0 |
24      |         1 |    1 |    0 |                 1 |
25      |         5 |    3 |    0 |                 3 |
26      |         5 |    3 |    1 |                 2 |
27      |        50 |   23 |    0 |                23 |
28      |        50 |   23 |    1 |                23 |
29      |        50 |   23 |    2 |                 4 |

• Maven Surefire Plugin 有幾個默認既 test class naming patterns，如果我地既 test classes 唔 follow 呢啲 naming patterns，個 plugin 就會無視我地既 test classes。
  • 其中一個默認既 naming pattern 係 test class name 要帶有 Test 既 suffix，就好似我地既 UserTest 咁。

• BDD 101: Gherkin By Example
• Cucumber 官方文檔 - Gherkin Reference
• Cucumber 官方文檔 - Step Definitions
• Maven 官方文檔 - Inclusions and Exclusions of Tests
• Maven 官方文檔 - Using JUnit 5 Platform - Configuring JUnit Platform