[java] Java Cucumber에서 주석 작성 방법

15 Nov 2023

java

Java Cucumber는 BDD(Behavior-Driven Development) 프레임워크로, 테스트 케이스를 자연어로 작성할 수 있습니다. 이러한 자연어로 된 테스트 케이스를 작성할 때 주석은 중요한 역할을 합니다. 주석은 테스트 코드의 가독성을 높이고 유지 보수를 용이하게 만들어줍니다.

Java Cucumber에서는 다음과 같은 방법으로 주석을 작성할 수 있습니다:

단일 행 주석 (Single Line Comment): 이 주석은 한 줄에 작성하며, 코드 앞에 “//”를 사용하여 작성합니다.

// 이 테스트 케이스는 로그인 기능을 테스트합니다.
@실행
시나리오: 로그인 기능
    // Given-When-Then 형식의 스텝으로 테스트 스텝을 작성합니다.
    // Given: 초기 상태 설정
    Given 사용자가 로그인 화면에 접속했을 때
    // When: 어떤 동작을 수행
    When 사용자가 유효한 아이디와 비밀번호로 로그인을 시도하면
    // Then: 어떤 결과가 나와야 함
    Then 로그인이 성공해야 한다.

다중 행 주석 (Multi-line Comment): 이 주석은 여러 줄에 걸쳐 작성할 수 있으며, “/“와 “/” 사이에 작성합니다.

/*
이 테스트 케이스는 회원 가입 기능을 테스트합니다.
테스트 케이스의 Given-When-Then 형식에 맞게 주석을 작성합니다.
*/
@실행
시나리오: 회원 가입 기능
    /*
    Given: 초기 상태 설정
    사용자가 회원 가입 화면에 접속했을 때
    */
    Given 사용자가 회원 가입 화면에 접속했을 때
    /*
    When: 어떤 동작을 수행
    사용자가 필수 정보를 입력하고 회원 가입 버튼을 클릭하면
    */
    When 사용자가 필수 정보를 입력하고 회원 가입 버튼을 클릭하면
    /*
    Then: 어떤 결과가 나와야 함
    회원 가입이 성공해야 한다.
    */
    Then 회원 가입이 성공해야 한다.
*/

주석을 작성할 때는 주석의 목적을 명확히 하고 테스트 케이스의 요구사항과 일치하도록 작성해야 합니다. 주석을 통해 다른 사람들이 코드를 이해하고 유지 보수하는 데 도움을 줄 수 있습니다.

만약 추가적인 도움이 필요하다면 다음 링크를 참조하세요: