如何編寫好單元測試？

一、單元測試的概念

單元測試是軟件開發中測試的其中一種類型，它是程序員編寫的一系列自動化測試用例，主要用來測試程序的某個最小的、可測試的單元。單元可以是一個函數、方法、類、模塊等。單元測試的目的是驗證這個單元是否符合預期的行為，以便及時發現和修復潛在的問題。

相對於手工測試，單元測試具有測試速度快、反饋及時、重複測試方便、測試精度高等優點。同時，也能夠幫助開發人員更好地理解需求、代碼實現和使用場景，提高代碼質量。

二、編寫單元測試的要點

1. 測試應該考慮到各種情況

在編寫單元測試時，應該儘可能地考慮到程序可能面臨的各種情況，例如邊界情況、錯誤情況和特殊情況等。特別是在處理輸入數據和處理邊界條件等方面，需要仔細思考可能存在的問題，並編寫相應的測試用例。

/**
 * 測試求和函數
 */
 
const sum = require('./sum');
 
test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});
 
test('adds -1 + -2 to equal -3', () => {
  expect(sum(-1, -2)).toBe(-3);
});
 
test('adds 0.1 + 0.2 to equal 0.3', () => {
  expect(sum(0.1, 0.2)).toBeCloseTo(0.3);
});

2. 測試應該覆蓋所有代碼分支

單元測試的目標之一是儘可能地發現潛在問題，因此測試用例應該盡量覆蓋代碼的所有分支和邊緣情況。要做到這一點，需要了解代碼中的所有分支並進行適當的測試。測試用例的數量應該足夠多，以發現和解決潛在的問題。

/**
 * 測試模擬登錄函數
 */
 
const login = require('./login');
 
test('login with correct username and password', () => {
  expect(login('admin', '123456')).toBe(true);
});
 
test('login with wrong username', () => {
  expect(login('test', '123456')).toBe(false);
});
 
test('login with wrong password', () => {
  expect(login('admin', '654321')).toBe(false);
});

3. 測試應該是自動化的

自動化測試是單元測試的一個重要特點。自動化測試用例可以被連續運行，可以在開發過程中反覆測試，並且可以隨時運行以檢查代碼更改的影響。當測試用例自動執行時，可以更快地發現和解決問題，提高代碼質量和開發效率。

/**
 * 測試取得當前時間函數
 */
 
const { getCurrentTime } = require('./utils');
 
test('getCurrentTime function returns current timestamp', () => {
  expect(typeof getCurrentTime()).toBe('number');
});

4. 測試應該使用斷言

斷言是單元測試框架中的關鍵組件，用於檢查測試結果和預期結果之間的差異。在編寫單元測試時，應該根據實際情況選擇正確的斷言方式，例如深度比較、類型比較、錯誤拋出、函數調用等。

/**
 * 測試排序函數
 */
 
const { sort } = require('./sort');
 
test('sort function sorts input array in ascending order', () => {
  const input = [3, 1, 2];
  const expectedOutput = [1, 2, 3];
  expect(sort(input)).toEqual(expectedOutput);
});
 
test('sort function throws error when input is not an array', () => {
  const input = 'not an array';
  expect(() => sort(input)).toThrow('input is not an array');
});

5. 測試應該易於維護

單元測試的另一個目標是易於維護。為了實現這一目標，應該使用良好的測試組織結構、良好的注釋和易於理解的變量名等。同時，測試用例應該儘可能獨立，以便在出現問題時能夠更容易地識別和解決問題。

/**
 * 測試計算圓的面積函數
 */
 
const { calculateCircleArea } = require('./geometry');
 
describe('calculateCircleArea function', () => {
  test('with positive radius', () => {
    expect(calculateCircleArea(2)).toBeCloseTo(Math.PI * 4);
  });
  
  test('with zero radius', () => {
    expect(calculateCircleArea(0)).toBeCloseTo(0);
  });
  
  test('with negative radius', () => {
    expect(() => calculateCircleArea(-1)).toThrow('radius must be positive');
  });
});

三、總結

單元測試是軟件開發中不可或缺的一部分。編寫好單元測試，可以幫助開發人員及時發現和解決潛在問題，提高代碼質量和開發效率。在編寫單元測試時，需要考慮各種情況、覆蓋所有代碼分支、自動化測試、使用斷言和易於維護。希望這篇文章能夠幫助你更好地理解和編寫單元測試。