[Spring] 테스트 코드 작성

📝 테스트 코드

테스트 코드는 단위 기능이 제대로 작동되는지 확인하기 위해 작성한다.

테스트 코드에는 실행 단계, 검증 단계가 있다.

실행 단계의 결과를 actual 인자에 넣고 비교 로직(matcher)를 넣어서 검증 단계에서 실행 단계가 예상한 대로, 개발자가 생각한 대로 동작하는지 검증한다. 

 

스프링 기준으로 테스트 코드를 작성하여 검증하는 과정을 작성해보았다.

 

 

📝 Dependency 추가 (Maven)

		<!-- Test -->
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.13.2</version>
			<scope>test</scope>
		</dependency>   
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-test</artifactId>
			<version>${org.springframework-version}</version>
			<scope>test</scope>
		</dependency>     
		<dependency>
			<groupId>de.flapdoodle.embed</groupId>
			<artifactId>de.flapdoodle.embed.mongo</artifactId>
			<version>3.3.0</version>
			<scope>test</scope>
		</dependency>

• pom.xml 파일에 위의 maven dependency를 추가해서 다운로드한다. 

 

 

📝 단위 테스트 클래스 생성

• 스프링 프로젝트에 test 폴더가 있는데, test 폴더 구조는 메인 패키지 구조와 동일하다.
• 프로젝트 패키지 하위에 test 클래스 파일을 생성한다. 파일명은 테스트 코드임을 명시하기 위해 Test로 끝나는 것으로 통일했다.

 

 

 

📝 UserRepository 테스트코드 작성

@Repository
public interface UserRepository extends MongoRepository<User, String>, CrudRepository<User, String>{
	
	Optional<User> findByNickname(String nickname);
	Optional<User> findByIdAndPassword(String id, String password);
}

• 메인 패키지에 User entity에 대한 MongoDB 쿼리 작업을 진행하는데 필요한 인터페이스인 UserRepository를 만들었다.
• UserRepository를 이용해서 User collection 대상으로 MongoRepository, CrudRepository를 상속받아 해당 레포지토리 내 쿼리를 사용할 수 있다. (findById, insert, save, count ... 등)
• UserRepository에서 별도의 메소드를 만든 이유는 다른 필드들을 활용해서 MongoDB에 쿼리를 실행해서 원하는 User 객체를 얻고 싶기 때문이다.
• 따라서 이 사용자 정의 메소드들이 개발자가 원하는 대로 동작하는지 확인하기 위해 UserRepository 메소드 대상으로 테스트 코드를 작성해보았다.

 

package org.smu.blood;

import static org.junit.Assert.assertEquals;

import java.util.Optional;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.smu.blood.database.User;
import org.smu.blood.database.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;
import org.springframework.test.annotation.Rollback;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@EnableMongoRepositories
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations= {"file:src/main/webapp/WEB-INF/spring/appServlet/servlet-context.xml"})
@Rollback(value = true)
public class UserRepositoryTest {
	@Autowired
	private UserRepository repository;
	
	@Test
	public void existsByNicknameTest() {
		User createUser = repository.insert(new User("asdf@naver.com", "qwe123", "asdf", 1, false));
		Optional<User> result = repository.findByNickname(createUser.getNickname());
		assertEquals(result.equals(Optional.empty()), false);
	}
	
}

• @EnableMongoRepositories
  • MongoRepository를 상속받는 UserRepository를 사용하기 위한 annotation
• @RunWith(SpringJUnit4ClassRunner.class)
  • 테스트 코드를 JUnit4에서 실행함을 명시하기 위한 annotation
• @ContextConfiguration
  • 테스트 코드 실행 위해 필요한 정보를 얻을 수 있는 servlet xml configuration 파일 경로 명시하기 위한 annotation.
  • test와 다른 패키지에 있는 파일을 사용하므로 xml configuration 파일 명시가 필요하다.
  • 기타 필요한 옵션들도 명시 가능하다. 
• @Rollback
  • 테스트 코드 실행 시 MongoDB에 영향을 줄텐데, 결과를 유지할지 되돌릴지 명시하는 annotation.
    • true인 경우 내부 MongoDB에서 테스트 진행하고 롤백한다. (운영용 DB에는 생성 X)
• @Test
  • 테스트 메소드임을 표시하기 위한 annotation
• User 객체를 생성해서 User collection에 document를 생성하고, UserRepository의 findByNickname 메소드로 유저를 찾는 쿼리를 실행한다. 
• assertEquals(a, b)
  • a와 b가 동일한지 확인

 

 

 

📝  회원가입 테스트코드 작성

package org.smu.blood;

import static org.junit.Assert.*;
import java.util.Optional;
import org.junit.Test;
import org.junit.jupiter.api.DisplayName;
import org.junit.runner.RunWith;
import org.smu.blood.database.User;
import org.smu.blood.database.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;
import org.springframework.test.annotation.Rollback;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@EnableMongoRepositories
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations= {"file:src/main/webapp/WEB-INF/spring/appServlet/servlet-context.xml"})
@Rollback(value = true)
public class SignUpTest{
	@Autowired
	private UserRepository repository;
	
	//private static final Logger logger = LoggerFactory.getLogger(SignUpTest.class);
	
	@Test
	@DisplayName("Same id user test")
	public void CheckSameId() {
		repository.insert(new User("koharin@naver.com", "qwe123", "koharin", 1, false));
		
		User newUser = new User("koharin@naver.com", "qwerty", "asdf", 2, true);
		Optional<User> userById = repository.findById(newUser.getId());
		assertEquals(userById.equals(Optional.empty()), false);
		
	}
	@Test
	@DisplayName("Same nickname user test")
	public void CheckSameNickname() {
		repository.insert(new User("qwe@naver.com", "qwe123", "qwe", 1, false));
		
		User newUser = new User("asdf@naver.com", "qwerty", "qwe", 2, true);
		Optional<User> userByNickname = repository.findByNickname(newUser.getNickname());
		assertEquals(userByNickname.equals(Optional.empty()), false);
	}
	
}

• 해당 메소드에서도 UserRepository 메소드를 사용한다. 
• CheckSameId는 이미 있는 아이디인지 체크하는 메소드이고, CheckSameNickname은 이미 있는 닉네임인지 확인하는 메소드이다.
• 두 메소드 둘다 User document 하나를 만들어놓고, 새로 계정을 만드려는 사용자의 User 객체의 아이디 및 닉네임을 통해 findById 및 findByNickname 메소드로 쿼리를 실행해서 Optional<User> 객체를 얻는다.
• 만약 중복이 없다면 Optional.empty와 동일할 것이므로 assertEquals로 얻은 객체가 Optional.Empty()와 일치하는지 확인한다.
• 이 코드에서도 UserRepository를 사용하기 위해 @EnabledMongoRepositories annotation을 추가했다.

 

 

 

📝 테스트 코드 실행

• Junit을 통해 실행할 수 있다.
• eclipse IDE를 사용하였고, 오류 없이 정상 실행 시 모두 초록색 체크 표시가 되며, 오류가 있는 경우 오류 메시지를 보여준다.