iT邦幫忙

2021 iThome 鐵人賽

DAY 6
0
Modern Web

Angular 深入淺出三十天:表單與測試系列 第 6

Angular 深入淺出三十天:表單與測試 Day06 - 單元測試實作 - 登入系統 by Template Driven Forms

Day6

今天我們要來為我們用 Template Driven Forms 所撰寫的登入系統寫單元測試,如果還沒有相關程式碼的朋友,趕快前往閱讀第二天的文章: Template Driven Forms 實作 - 以登入為例

此外,由於使用 Stackblitz 來寫測試比較麻煩一點,所以我建議大家都使用 ng new 建立新的專案,因為 Angular 都幫開發者處理好了,使用 Angular 的開發者就是這麼幸福。

所以在開始之前,如果當初是用 Stackblitz 練習的話,要先將程式碼複製到專案裡,詳細步驟我就不再贅述囉!

小提醒,將程式碼複製到專案裡之後,記得先使用 ng serve 的指令將其啟動起來看看是不是可以正常運作噢!

此外,如果是用 Angular v12 以上的同學,預設的 typescript 會是 strict mode 的狀態,也就是說型別檢查會比較嚴格一點,所以如果看到很多紅色毛毛蟲不用太擔心。

如果有任何問題,我預言會有 80% 的朋友是忘記在 module 裡 import FormsModule ,哈哈!

實作開始

上述前置作業做完之後,我們就可以先打開 app.component.spec.ts,你應該會看到 Angular CLI 幫我們產生的程式碼:

Testing Sample

我們先把除了 should create the app 之外的測試案例刪掉,刪完應該要長這樣:

import { TestBed } from '@angular/core/testing';
import { AppComponent } from './app.component';

describe('AppComponent', () => {
  beforeEach(async () => {
    await TestBed.configureTestingModule({
      declarations: [
        AppComponent
      ],
    }).compileComponents();
  });

  it('should create the app', () => {
    const fixture = TestBed.createComponent(AppComponent);
    const app = fixture.componentInstance;
    expect(app).toBeTruthy();
  });
});

至此我稍微說明一下,在 beforeEach 裡我們可以看到有段滿特別的程式碼:

TestBed.configureTestingModule({
  declarations: [
    AppComponent
  ],
}).compileComponents();

這段程式碼是在配置我們測試集合的環境,就像我們在寫 Angular 的時候一樣, Component 會需要一個模組,而 TestBed 是 Angular 幫我們預先寫好給測試用的一個類型,透過 configureTestingModule 來模擬真實使用情境,最後用 compileComponents 將其實際執行。

這段配置在 Angular 基本上會是必備的,並且我們還會需要依據 Component 其實際情況來調整該配置,例如我們現在就因為我們的表單需要的關係,要在這裡引入 FormsModule

import { TestBed } from '@angular/core/testing';
import { FormsModule } from '@angular/forms';

import { AppComponent } from './app.component';

describe('AppComponent', () => {
  beforeEach(async () => {
    await TestBed.configureTestingModule({
      declarations: [AppComponent],
      imports: [FormsModule]
    }).compileComponents();
  });

  it('should create the app', () => {
    // ...
  });
});

接著使用 ng test 的指令將測試程式啟動起來,應該會可以通過我們的第一個測試案例 should create the app

pass first case

通過這個測試基本上意謂著我們要測試的 Component 的配置沒有什麼太大的問題,因為他要可以被正常建立實體才能通過,至此我們就可以開始來撰寫單元測試了。

欲測試的單元選擇

在第一天時我有提到,單元測試主要是要用來驗證單個類別函式其實際執行結果是否符合我們預期的執行結果。

所以我們先打開 app.component.ts 來看一下目前的程式碼:

export class AppComponent {
  
  // 綁定在帳號欄位上
  account = '';

  // 綁定在密碼欄位上
  password = '';
  
  // 帳號欄位的錯誤訊息
  accountErrorMessage = '';
  
  // 密碼欄位的錯誤訊息
  passwordErrorMessage = '';

  /**
   * 綁定在帳號欄位上,當使用者改變帳號時會觸發此函式
   * 
   * @param {string} account 
   * @param {ValidationErrors} errors 
   */
  accountValueChange(account: string, errors: ValidationErrors | null): void {
    this.account = account;
    this.validationCheck(errors, 'account');
  }

  /**
   * 綁定在密碼欄位上,當使用者改變密碼時會觸發此函式
   * 
   * @param {string} password 
   * @param {ValidationErrors} errors 
   */
  passwordValueChange(password: string, errors: ValidationErrors | null): void {
    this.password = password;
    this.validationCheck(errors, 'password');
  }

  // 綁定在表單上,當使用者按下登入按鈕時會觸發此函式
  login(): void {
    // do login...
  }

  /**
   * 透過欄位裡的 ValidationErrors 來設定該欄位的錯誤訊息
   * 
   * @param {ValidationErrors | null} errors 欲驗證的欄位的錯誤 (by Angular)
   * @param {'account' | 'password'} fieldName 欄位名稱
   */
  private validationCheck(
    errors: ValidationErrors | null,
    fieldName: 'account' | 'password'
  ): void {
    let errorMessage: string;
    if (!errors) {
      errorMessage = '';
    } else if (errors.required) {
      errorMessage = '此欄位必填';
    } else if (errors.pattern) {
      errorMessage = '格式有誤,請重新輸入';
    } else if (errors.minlength) {
      errorMessage = '密碼長度最短不得低於8碼';
    }
    this.setErrorMessage(fieldName, errorMessage);
  }

  /**
   * 設定指定欄位的錯誤訊息
   * 
   * @param {'account' | 'password'} fieldName 欲設定錯誤訊息的欄位名稱
   * @param {string} errorMessage 欲設定的錯誤訊息
   */
  private setErrorMessage(
    fieldName: 'account' | 'password',
    errorMessage: string
  ): void {
    if (fieldName === 'account') {
      this.accountErrorMessage = errorMessage;
    } else {
      this.passwordErrorMessage = errorMessage;
    }
  }
}

以目前的程式碼來看,這個 Component 的函式有以下這些:

  1. accountValueChange
  2. passwordValueChange
  3. login
  4. validationCheck
  5. setErrorMessage

這五個函式裡,其中 login 沒寫什麼先不測, validationChecksetErrorMessageprivate 的也不用測,所以我們主要要測試 accountValueChangepasswordValueChange 這兩個函式。

測試單元 - accountValueChange

既然如此,我們先加一個 describe ,表明在這裡面的測試案例都是在測 accountValueChange 這個函式:

describe('AppComponent', () => {
  // ...

  describe('accountValueChange', () => {
    // 這裡面的測試案例都是要測這個函式
  });
});

然後我們來統整一下這個 accountValueChange 的函式裡會遇到的情況:

  1. 會將傳入的 account 的值賦值給 AppComponent 的屬性 account
  2. 如果傳入的 errorsrequired 欄位,則會將錯誤訊息 此欄位必填 賦值給 AppComponent 的屬性 accountErrorMessage
  3. 如果傳入的 errorspattern 欄位,則會將錯誤訊息 格式有誤,請重新輸入 賦值給 AppComponent 的屬性 accountErrorMessage
  4. 如果傳入的 errorsnull ,則會將 AppComponent 的屬性 accountErrorMessage 設為空字串。

統整完之後,就可以將上述情況寫成測試案例:

describe('accountValueChange', () => {
  it('should set value into property "account"', () => {
    // Arrange
    const account = 'abc123@mail.com';
    const errors = null;
    // Act
    component.accountValueChange(account, errors);
    // Assert
    expect(component.account).toBe(account);
  });

  it('should set the required error message into property "accountErrorMessage" when the value is empty string', () => {
    // Arrange
    const account = '';
    const errors = { required: true };
    const accountErrorMessage = '此欄位必填';
    // Act
    component.accountValueChange(account, errors);
    // Assert
    expect(component.accountErrorMessage).toBe(accountErrorMessage);
  });

  it('should set the pattern error message into property "accountErrorMessage" when the value is not the correct pattern', () => {
    // Arrange
    const account = 'abc123';
    const errors = {
      pattern: {
        actualValue: 'abc123',
        requiredPattern: '^\\b[\\w\\.-]+@[\\w\\.-]+\\.\\w{2,4}\\b$'
      }
    };
    const accountErrorMessage = '格式有誤,請重新輸入';
    // Act
    component.accountValueChange(account, errors);
    // Assert
    expect(component.accountErrorMessage).toBe(accountErrorMessage);
  });

  it('should set empty string into property "accountErrorMessage" when the value is the correct pattern', () => {
    // Arrange
    const account = 'abc123@mail.com';
    const errors = null;
    const accountErrorMessage = '';
    // Act
    component.accountValueChange(account, errors);
    // Assert
    expect(component.accountErrorMessage).toBe(accountErrorMessage);
  });
});

測試結果:

testing result

測試單元 - passwordValueChange

接下來,我們繼續來撰寫測試案例來測試 passwordValueChange 函式,一樣先加一個 describe ,表明在這裡面的測試案例都是在測 passwordValueChange 函式:

describe('AppComponent', () => {
  // ...

  describe('passwordValueChange', () => {
    // 這裡面的測試案例都是要測這個函式
  });
});

然後我們來統整一下這個 passwordValueChange 的函式裡會遇到的情況:

  1. 會將傳入的 password 的值賦值給 AppComponent 的屬性 password
  2. 如果傳入的 errorsrequired 欄位,則會將錯誤訊息 此欄位必填 賦值給 AppComponent 的屬性 passwordErrorMessage
  3. 如果傳入的 errorsminlength 欄位,則會將錯誤訊息 密碼長度最短不得低於8碼 賦值給 AppComponent 的屬性 passwordErrorMessage
  4. 如果傳入的 errorsnull ,則會將 AppComponent 的屬性 passwordErrorMessage 設為空字串。

統整完之後其實可以發現,這跟剛剛我們測 accountValueChange 的時候很像,所以我們只要複製一下 accountValueChange 的測試案例再稍微改一下就可以用了:

describe('passwordValueChange', () => {

  it('should set value into property "password"', () => {
    // Arrange
    const password = 'abc123';
    const errors = null;
    // Act
    component.passwordValueChange(password, errors);
    // Assert
    expect(component.password).toBe(password);
  });

  it('should set the required error message into property "passwordErrorMessage" when the value is empty string', () => {
    // Arrange
    const password = '';
    const errors = { required: true };
    const passwordErrorMessage = '此欄位必填';
    // Act
    component.passwordValueChange(password, errors);
    // Assert
    expect(component.passwordErrorMessage).toBe(passwordErrorMessage);
  });

  it('should set the pattern error message into property "passwordErrorMessage" when the value is not the correct pattern', () => {
    // Arrange
    const password = 'abc123';
    const errors = {
      minlength: {
        actualLength: 7,
        requiredLength: 8
      }
    };
    const passwordErrorMessage = '密碼長度最短不得低於8碼';
    // Act
    component.passwordValueChange(password, errors);
    // Assert
    expect(component.passwordErrorMessage).toBe(passwordErrorMessage);
  });

  it('should set empty string into property "passwordErrorMessage" when the value is the correct pattern', () => {
    // Arrange
    const password = 'abcd1234';
    const errors = null;
    const passwordErrorMessage = '';
    // Act
    component.passwordValueChange(password, errors);
    // Assert
    expect(component.passwordErrorMessage).toBe(passwordErrorMessage);
  });
});

測試結果:

testing result

至此,我們就完成了單元測試的部份囉!是不是感覺其實很簡單,並沒有想像中的難呢?!俗話說:「萬事起頭難」,只要我們已經跨出第一步,後面就會越來越簡單噢!

今天的文章就到這邊,大家稍微沉澱、吸收一下,明天我們接著撰寫整合測試的部份。

本日小結

再次提醒大家,單元測試要驗證的是某一函式不同情況下的執行結果是否符合預期,並且記得要盡量做到我在如何寫出優秀的測試?文中所提到的部份。

今天的程式碼比較多,且應該會有很多朋友初次接觸到測試所以可能腦筋會比較轉不過來,這時可以先回頭看看我第四天與第五天的文章,複習一下核心概念與測試語法,相信一定會有所幫助。

我會將今日的實作程式碼放在 Github - Branch: day6 供大家參考,建議大家在看我的實作之前,先按照需求規格自己做一遍,之後再跟我的對照,看看自己的實作跟我的實作不同的地方在哪裡、有什麼好處與壞處,如此反覆咀嚼消化後,我相信你一定可以進步地非常快!

如果有任何的問題或是回饋,也都非常歡迎留言給我讓我知道噢!


上一篇
Angular 深入淺出三十天:表單與測試 Day05 - 如何寫出優秀的測試?
下一篇
Angular 深入淺出三十天:表單與測試 Day07 - 整合測試實作 - 登入系統 by Template Driven Forms
系列文
Angular 深入淺出三十天:表單與測試30

1 則留言

0
TD
iT邦新手 5 級 ‧ 2021-09-21 21:40:42

分享一下我的想法 ... passwordValueChange 被呼叫的時候,會同時變更兩個變數的狀態,所以我會在測試 passwordValueChange 時,同時 assert component.passwordErrorMessagecomponent.password,以確保 function 呼叫完畢之後,最終狀態如預期

所以會是這樣

  it('...', () => {
    // Arrange
    const password = 'abc123';
    const errors = {
      minlength: {
        actualLength: 7,
        requiredLength: 8
      }
    };
    const passwordErrorMessage = '密碼長度最短不得低於8碼';
    // Act
    component.passwordValueChange(password, errors);
    // Assert
    expect(component.passwordErrorMessage).toBe(passwordErrorMessage);
    expect(component.password).toBe(password);
  });

這樣也會讓這裡 arrange 的 password 有意義。

雖然這樣會多寫了一些程式碼,不過自己感覺比較心安 XD

Leo iT邦新手 3 級 ‧ 2021-09-21 21:47:39 檢舉

Hi TD

昨天的文章中有提到,每個案例只會有一個關注點,而且如果你前面的那個 expect 錯了,後面那個 expect 就不會跑了,這樣就驗證不到真正該驗證的事情。

所以我才會建議要將其分開,就算 assign 值的錯了,後面該驗證的事情還是要繼續驗證會比較好噢!

TD iT邦新手 5 級 ‧ 2021-09-21 21:51:09 檢舉

阿我懂意思了!如果是要認真執行 TDD 的話,分開做的確比較好,才能夠確定哪邊真正驗證過了

Leo iT邦新手 3 級 ‧ 2021-09-21 22:10:52 檢舉

/images/emoticon/emoticon12.gif

我要留言

立即登入留言