[英]How to mock JPA repository's save method in unit tests
例如,我在 UserService 中有这个方法:
@Override
@Transactional
public UserDto create(UserDto userDto) {
User dbUser = userRepository.findOne(userDto.getId());
if (dbUser != null) {
throw new AuthException(AuthException.ErrorCode.DUPLICATE_USER_EXCEPTION);
}
User oneByLogin = userRepository.findOneByLogin(userDto.getLogin());
if (oneByLogin != null) {
throw new AuthExceptionAuthException.ErrorCode.DUPLICATE_LOGIN_EXCEPTION);
}
User newUser = new User();
newUser.setGuid(UUID.randomUUID().toString());
newUser.setInsertDate(new Date());
newUser.setFirstName(userDto.getFirstName());
newUser.setLastName(userDto.getLastName());
newUser.setLogin(userDto.getLogin());
newUser.setPassword(userDto.getPassword());
newUser.setAuthToken(TokenGenerator.nextToken());
newUser.setAuthTokenCreatedDate(new Date());
User savedUser = userRepository.save(newUser);
userDto.setAuthToken(savedUser.getAuthToken());
log.info("User {0} created", savedUser.getLogin());
return userDto;
}
如何为此方法创建单元测试? 我接下来尝试:
@Test
public void createUser() {
UserDto userDtoRequest = new UserDto();
userDtoRequest.setLogin("Alex");
userDtoRequest.setPassword("123");
UserDto found = userService.create(userDtoRequest);
assertThat(found.getAuthToken()).isNotEmpty();
}
我有下一个逻辑:
User dbUser = userRepository.findOne(userDto.getId());
数据库用户 = NULLif (dbUser != null
) 和if (oneByLogin != null)
跳过User savedUser = userRepository.save(newUser);
已保存用户 = NULL 在这一步中,我遇到了一个问题,因为我无法模拟userRepository.save(newUser)
。
newUser create inside the method. and test fail.
SavedUser.getAuthToken() - savedUser == NULL
我可以重写:
userRepository.save(newUser);
userDto.setAuthToken(newUser.getAuthToken());
log.info("User {0} created", newUser.getLogin());
return userDto;
但是如果我想使用返回的对象savedUser
呢?
你需要这样做。
when(userRepository.save(Mockito.any(User.class)))
.thenAnswer(i -> i.getArguments()[0]);
现在您可以获得作为参数传递的用户。
您可以执行以下操作:
@RunWith(MockitoJUnitRunner.class)
public class SimpleTest {
@Mock
private UserRepository mockedUserRepository;
// .. your test setup
@Test
public void testYourMethod() {
User userToReturnFromRepository = new User();
userToReturnFromRepository.setAuthToken(YOUR_TOKEN);
when(mockedUserRepository.save(any(User.class)).thenReturn(userToReturnFromRepository);
UserDto found = userService.create(userDtoRequest);
// ... your asserts
}
}
使用这种方法,您只需要确保您的mockedUserRepository
被注入到您的测试类中(例如在构造函数中)。
您需要编写多个测试用例来测试不同的场景。
场景一:当findOne返回一个非空对象时:
@Test(expected=AuthException.class)
public void testCreateUserWhenAvailable() {
//Create one sample userDto object with test data
when(mockedUserRepository.findOne(userDto.getId())).thenReturn(new User());
userService.create(userDto);
}
场景二:当findOneByLogin返回一个空对象时:
@Test(expected=AuthException.class)
public void testCreateUserWhenLoginAvailable() {
//Create one sample userDto object with test data
when(mockedUserRepository.findOne(userDto.getId())).thenReturn(null);
when(mockedUserRepository.findOneByLogin(userDto.getId())).thenReturn(new User());
userService.create(userDto);
}
场景2:保存完成后:
@测试
public void testCreateUserWhenSaved() {
//Create one sample userDto object with test data
when(mockedUserRepository.findOne(userDto.getId())).thenReturn(null);
when(mockedUserRepository.findOneByLogin(userDto.getId())).thenReturn(null);
//Create sample User object and set all the properties
User newUser=new User();
when(mockedUserRepository.save(Mockito.any(User.class)).thenReturn(newUser);
User returnedUser=userService.create(userDto);
//You have two ways to test, you can either verify that save method was invoked by
//verify method
verify(mockedUserRepository, times(1)).save(Mockito.any(User.class);
//or by assertion statements, match the authToken in the returned object to be equal
//to the one set by you in the mocked object
Assert.assertEquals(returnedUser.getAuthToken(),newUser.getAuthToken());
}
关于如何使用@GeneratedValue
为字段生成随机 ID 来创建 JPA 存储库save
方法只需两美分。
/**
* Mocks {@link JpaRepository#save(Object)} method to return the
* saved entity as it was passed as parameter and add generated ID to it.
* If ID could not be generated, it will be ignored.
* If parameter already has and ID, it will be overridden.
*/
private <T, V> void mockSave(JpaRepository<T, V> repository) {
when(repository.save(any())).thenAnswer(i -> {
Object argument = i.getArgument(0);
Arrays.stream(argument.getClass().getDeclaredFields())
.filter(f -> f.getAnnotation(GeneratedValue.class) != null)
.forEach(f -> enrichGeneratedValueField(argument, f));
return argument;
});
}
因此,在这里您将所需的存储库作为参数传递,并且这些方法为所有用@GeneratedValue
注释注释的字段调用enrichGeneratedValueField
值字段。 下面是这个方法的实现:
private void enrichGeneratedValueField(Object argument, Field field) {
try {
if (field.getType().isAssignableFrom(Integer.class)) {
FieldUtils.writeField(field, argument, Math.abs(random.nextInt()), true);
} else {
FieldUtils.writeField(field, argument, mock(field.getType()), true);
}
} catch (Exception ignored) {
}
}
在这个例子中,我只使用了Integer
类型的 ID,但可以随意添加您想要的 ID 类型。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.