分而治之

好的單元測(cè)試應(yīng)該僅出于一個(gè)原因而失敗。 這意味著適當(dāng)?shù)膯卧獪y(cè)試僅測(cè)試一個(gè)邏輯概念。

如果我們要編寫干凈的測(cè)試，則必須識(shí)別那些邏輯概念，并且每個(gè)邏輯概念只編寫一個(gè)測(cè)試用例。

這篇博客文章描述了我們?nèi)绾巫R(shí)別從測(cè)試中發(fā)現(xiàn)的邏輯概念，以及如何將現(xiàn)有的單元測(cè)試分成多個(gè)單元測(cè)試。

干凈還不夠好

讓我們先看一下單元測(cè)試的源代碼，該源代碼確保當(dāng)使用唯一的電子郵件地址和社交登錄提供者創(chuàng)建新用戶帳戶時(shí)， RepositoryUserService類的registerNewUserAccount（RegistrationForm userAccountData）方法能夠按預(yù)期工作。

該單元測(cè)試的源代碼如下所示：

import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.Mock; import org.mockito.invocation.InvocationOnMock; import org.mockito.runners.MockitoJUnitRunner; import org.mockito.stubbing.Answer; import org.springframework.security.crypto.password.PasswordEncoder;import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNull; import static org.mockito.Matchers.isA; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verifyNoMoreInteractions; import static org.mockito.Mockito.verifyZeroInteractions; import static org.mockito.Mockito.when;@RunWith(MockitoJUnitRunner.class) public class RepositoryUserServiceTest {private static final String REGISTRATION_EMAIL_ADDRESS = "john.smith@gmail.com";private static final String REGISTRATION_FIRST_NAME = "John";private static final String REGISTRATION_LAST_NAME = "Smith";private static final SocialMediaService SOCIAL_SIGN_IN_PROVIDER = SocialMediaService.TWITTER;private RepositoryUserService registrationService;@Mockprivate PasswordEncoder passwordEncoder;@Mockprivate UserRepository repository;@Beforepublic void setUp() {registrationService = new RepositoryUserService(passwordEncoder, repository);}@Testpublic void registerNewUserAccount_SocialSignInAndUniqueEmail_ShouldCreateNewUserAccountAndSetSignInProvider() throws DuplicateEmailException {RegistrationForm registration = new RegistrationFormBuilder().email(REGISTRATION_EMAIL_ADDRESS).firstName(REGISTRATION_FIRST_NAME).lastName(REGISTRATION_LAST_NAME).isSocialSignInViaSignInProvider(SOCIAL_SIGN_IN_PROVIDER).build();when(repository.findByEmail(REGISTRATION_EMAIL_ADDRESS)).thenReturn(null);when(repository.save(isA(User.class))).thenAnswer(new Answer<User>() {@Overridepublic User answer(InvocationOnMock invocation) throws Throwable {Object[] arguments = invocation.getArguments();return (User) arguments[0];}});User createdUserAccount = registrationService.registerNewUserAccount(registration);assertThat(createdUserAccount).hasEmail(REGISTRATION_EMAIL_ADDRESS).hasFirstName(REGISTRATION_FIRST_NAME).hasLastName(REGISTRATION_LAST_NAME).isRegisteredUser().isRegisteredByUsingSignInProvider(SOCIAL_SIGN_IN_PROVIDER);verify(repository, times(1)).findByEmail(REGISTRATION_EMAIL_ADDRESS);verify(repository, times(1)).save(createdUserAccount);verifyNoMoreInteractions(repository);verifyZeroInteractions(passwordEncoder);} }

這個(gè)單元測(cè)試非常干凈。 畢竟，我們的測(cè)試類，測(cè)試方法以及在測(cè)試方法內(nèi)部創(chuàng)建的局部變量具有描述性名稱。 我們還用常數(shù)替換了幻數(shù)，并創(chuàng)建了特定領(lǐng)域的語(yǔ)言來創(chuàng)建新對(duì)象和編寫斷言。

但是， 我們可以使這項(xiàng)測(cè)試更好 。

此單元測(cè)試的問題在于它可能出于多種原因而失敗。 如果發(fā)生以下情況，它將失敗：

我們的服務(wù)方法不會(huì)檢查是否從我們的數(shù)據(jù)庫(kù)中找不到輸入到注冊(cè)表中的電子郵件地址。

持久化的User對(duì)象的信息與在注冊(cè)表中輸入的信息不匹配。

返回的User對(duì)象的信息不正確。

我們的服務(wù)方法通過使用PasswordEncoder對(duì)象為用戶創(chuàng)建密碼。

換句話說，此單元測(cè)試測(cè)試了四個(gè)不同的邏輯概念，這導(dǎo)致以下問題：

• 如果此測(cè)試失敗，我們不一定知道為什么失敗。 這意味著我們必須閱讀單元測(cè)試的源代碼。
• 單元測(cè)試有點(diǎn)長(zhǎng)，這使得閱讀起來有些困難。
• 很難描述預(yù)期的行為。 這意味著很難為我們的測(cè)試方法找到好名字。

通過確定單元測(cè)試將失敗的情況，我們可以確定單個(gè)單元測(cè)試所涵蓋的邏輯概念。

這就是為什么我們需要將此測(cè)試分為四個(gè)單元測(cè)試。

一測(cè)試，一故障

下一步是將單元測(cè)試分成四個(gè)新的單元測(cè)試，并確保每個(gè)單元測(cè)試都測(cè)試一個(gè)邏輯概念。 我們可以通過編寫以下單元測(cè)試來做到這一點(diǎn)：

我們需要確保我們的服務(wù)方法檢查用戶提供的電子郵件地址是否唯一。

我們需要驗(yàn)證持久性User對(duì)象的信息是否正確。

我們需要確保返回的User對(duì)象的信息正確。

我們需要驗(yàn)證我們的服務(wù)方法沒有為使用社交登錄提供商的用戶創(chuàng)建編碼密碼。

編寫完這些單元測(cè)試后，測(cè)試類的源代碼如下所示：

import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.ArgumentCaptor; import org.mockito.Mock; import org.mockito.invocation.InvocationOnMock; import org.mockito.runners.MockitoJUnitRunner; import org.mockito.stubbing.Answer; import org.springframework.security.crypto.password.PasswordEncoder;import static net.petrikainulainen.spring.social.signinmvc.user.model.UserAssert.assertThat; import static org.mockito.Matchers.isA; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verifyZeroInteractions; import static org.mockito.Mockito.when;@RunWith(MockitoJUnitRunner.class) public class RepositoryUserServiceTest {private static final String REGISTRATION_EMAIL_ADDRESS = "john.smith@gmail.com";private static final String REGISTRATION_FIRST_NAME = "John";private static final String REGISTRATION_LAST_NAME = "Smith";private static final SocialMediaService SOCIAL_SIGN_IN_PROVIDER = SocialMediaService.TWITTER;private RepositoryUserService registrationService;@Mockprivate PasswordEncoder passwordEncoder;@Mockprivate UserRepository repository;@Beforepublic void setUp() {registrationService = new RepositoryUserService(passwordEncoder, repository);}@Testpublic void registerNewUserAccount_SocialSignInAndUniqueEmail_ShouldCheckThatEmailIsUnique() throws DuplicateEmailException {RegistrationForm registration = new RegistrationFormBuilder().email(REGISTRATION_EMAIL_ADDRESS).firstName(REGISTRATION_FIRST_NAME).lastName(REGISTRATION_LAST_NAME).isSocialSignInViaSignInProvider(SOCIAL_SIGN_IN_PROVIDER).build();when(repository.findByEmail(REGISTRATION_EMAIL_ADDRESS)).thenReturn(null);registrationService.registerNewUserAccount(registration);verify(repository, times(1)).findByEmail(REGISTRATION_EMAIL_ADDRESS);}@Testpublic void registerNewUserAccount_SocialSignInAndUniqueEmail_ShouldSaveNewUserAccountAndSetSignInProvider() throws DuplicateEmailException {RegistrationForm registration = new RegistrationFormBuilder().email(REGISTRATION_EMAIL_ADDRESS).firstName(REGISTRATION_FIRST_NAME).lastName(REGISTRATION_LAST_NAME).isSocialSignInViaSignInProvider(SOCIAL_SIGN_IN_PROVIDER).build();when(repository.findByEmail(REGISTRATION_EMAIL_ADDRESS)).thenReturn(null);registrationService.registerNewUserAccount(registration);ArgumentCaptor<User> userAccountArgument = ArgumentCaptor.forClass(User.class);verify(repository, times(1)).save(userAccountArgument.capture());User createdUserAccount = userAccountArgument.getValue();assertThat(createdUserAccount).hasEmail(REGISTRATION_EMAIL_ADDRESS).hasFirstName(REGISTRATION_FIRST_NAME).hasLastName(REGISTRATION_LAST_NAME).isRegisteredUser().isRegisteredByUsingSignInProvider(SOCIAL_SIGN_IN_PROVIDER);}@Testpublic void registerNewUserAccount_SocialSignInAndUniqueEmail_ShouldReturnCreatedUserAccount() throws DuplicateEmailException {RegistrationForm registration = new RegistrationFormBuilder().email(REGISTRATION_EMAIL_ADDRESS).firstName(REGISTRATION_FIRST_NAME).lastName(REGISTRATION_LAST_NAME).isSocialSignInViaSignInProvider(SOCIAL_SIGN_IN_PROVIDER).build();when(repository.findByEmail(REGISTRATION_EMAIL_ADDRESS)).thenReturn(null);when(repository.save(isA(User.class))).thenAnswer(new Answer<User>() {@Overridepublic User answer(InvocationOnMock invocation) throws Throwable {Object[] arguments = invocation.getArguments();return (User) arguments[0];}});User createdUserAccount = registrationService.registerNewUserAccount(registration);assertThat(createdUserAccount).hasEmail(REGISTRATION_EMAIL_ADDRESS).hasFirstName(REGISTRATION_FIRST_NAME).hasLastName(REGISTRATION_LAST_NAME).isRegisteredUser().isRegisteredByUsingSignInProvider(SOCIAL_SIGN_IN_PROVIDER);}@Testpublic void registerNewUserAccount_SocialSignInAnUniqueEmail_ShouldNotCreateEncodedPasswordForUser() throws DuplicateEmailException {RegistrationForm registration = new RegistrationFormBuilder().email(REGISTRATION_EMAIL_ADDRESS).firstName(REGISTRATION_FIRST_NAME).lastName(REGISTRATION_LAST_NAME).isSocialSignInViaSignInProvider(SOCIAL_SIGN_IN_PROVIDER).build();when(repository.findByEmail(REGISTRATION_EMAIL_ADDRESS)).thenReturn(null);registrationService.registerNewUserAccount(registration);verifyZeroInteractions(passwordEncoder);} }

編寫只測(cè)試一個(gè)邏輯概念的單元測(cè)試的明顯好處是，很容易知道為什么測(cè)試失敗。 但是，此方法還有其他兩個(gè)好處：

• 指定期望的行為很容易。 這意味著更容易為我們的測(cè)試方法找出好名字。
• 因?yàn)檫@些單元測(cè)試比原始單元測(cè)試要短得多，所以更容易弄清測(cè)試方法/組件的要求。 這有助于我們將測(cè)試轉(zhuǎn)換為可執(zhí)行規(guī)范。

讓我們繼續(xù)并總結(jié)從這篇博客文章中學(xué)到的知識(shí)。

摘要

現(xiàn)在，我們已經(jīng)成功地將單元測(cè)試分為四個(gè)較小的單元測(cè)試，它們測(cè)試了一個(gè)邏輯概念。 這篇博客文章教會(huì)了我們兩件事：

• 我們了解到，通過確定測(cè)試失敗的情況，我們可以確定單個(gè)單元測(cè)試所涵蓋的邏輯概念。
• 我們了解到，編寫僅測(cè)試一個(gè)邏輯概念的單元測(cè)試有助于我們將測(cè)試用例編寫成可執(zhí)行的規(guī)范，從而確定測(cè)試方法/組件的要求。

翻譯自: https://www.javacodegeeks.com/2014/06/writing-clean-tests-divide-and-conquer.html

分而治之

總結(jié)

以上是生活随笔為你收集整理的分而治之_编写干净的测试–分而治之的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。