해당 포스트는 도서 이펙티브 소프트웨어 테스팅(Effective Software Testing)을 Typescript와 Jest 테스팅 프레임워크를 기준으로 해석한 내용입니다. 코드 변환간 불일치가 존재할 수 있습니다.

1. 클래스가 유효하지 않은 입력으로 다른 클래스를 호출할 수 없도록 한다.
2. 유효적이지 않은 입력일시 에러를 발생시키도록 방어적으로 작성한다.
3. 클래스에 대해 명확한 계약을 정의한다.

사전 조건과 사후 조건

1export class TaxCalculator {
2  public calculateTax(value: number): number {
3    // 사전 조건
4    if (value < 0) {
5      throw new Error('Value has to be positive');
6    }
7
8    const taxValue: number = 0;
9
10    // 사후 조건
11    if (taxValue < 0) {
12      throw new Error('Calculated tax cannot be negative');
13    }
14
15    return taxValue;
16  }
17}
18

1/**
2 * 세금 계산기
3 * @description 세금 계산을 위한 클래스
4 */
5export class TaxCalculator {
6  /**
7   * 세금 계산
8   * @param value 세금 계산 대상 금액, 값은 양수여야 한다.
9   * @returns 세금 계산 결과, 값은 양수여야 한다.
10   */
11  public calculateTax(value: number): number {
12    // 사전 조건
13    if (value < 0) {
14      throw new Error('Value has to be positive');
15    }
16
17    const taxValue: number = 0;
18
19    // 사후 조건
20    if (taxValue < 0) {
21      throw new Error('Calculated tax cannot be negative');
22    }
23
24    return taxValue;
25  }
26}
27

강한 조건과 약한 조건

1if (taxValue < 0) {
2  return 0;
3}
4

불변식

1class Product {
2  // ...
3}
4
5class Basket {
6  public add(product: Product, qtyToAdd: number) {
7    // ...
8  }
9
10  public remove(product: Product) {
11    // ...
12  }
13}
14

• product는 null일 수 없다.
• qtyToAdd는 0보다 커야한다.

• 장바구니에 제품이 있어야한다.

1public add(product: Product, qtyToAdd: number) {
2  if (product == null) {
3    throw new Error('Product is required')
4  }
5  if (qtyToAdd <= 0) {
6    throw new Error('Quantity must be greater than 0')
7  }
8  const oldTotalValue = this.totalValue
9  // ...
10  if (oldTotalValue === this.totalValue) {
11    throw new Error('Product does not exist in basket')
12  }
13}
14

• product는 null일 수 없다.
• product는 기존에 존재해야 한다.

• 장바구니에 제품이 더이상 존재해서는 안된다.

1public remove(product: Product) {
2  if (product == null) {
3    throw new Error('Product is required')
4  }
5  if (!this.products.find((p) => p.id === product.id) == null) {
6    throw new Error('Product does not exist in basket')
7  }
8
9  // ...
10
11  if (this.products.find((p) => p.id === product.id)) {
12    throw new Error('Product does exist in basket')
13  }
14}
15

• 장바구니에 있는 제품의 합계는 절대 음수가 될 수 없다.

1class Basket {
2  public products: Product[] = [];
3
4  public totalValue = 0;
5
6  private invariants() {
7    if (this.totalValue < 0) {
8      throw new Error('Total value must be greater than or equal to 0');
9    }
10  }
11
12  public add(product: Product, qtyToAdd: number) {
13    if (product == null) {
14      throw new Error('Product is required');
15    }
16    if (qtyToAdd <= 0) {
17      throw new Error('Quantity must be greater than 0');
18    }
19    const oldTotalValue = this.totalValue;
20
21    // 제품 추가 & 합계 갱신
22
23    if (oldTotalValue === this.totalValue) {
24      throw new Error('Product does not exist in basket');
25    }
26    this.invariants();
27  }
28
29  public remove(product: Product) {
30    if (product == null) {
31      throw new Error('Product is required');
32    }
33    if (!this.products.find((p) => p.id === product.id) == null) {
34      throw new Error('Product does not exist in basket');
35    }
36    // ...
37
38    if (this.products.find((p) => p.id === product.id)) {
39      throw new Error('Product does exist in basket');
40    }
41    if (this.totalValue <= 0) {
42      throw new Error('Total value must be greater than 0');
43    }
44    this.invariants();
45  }
46}
47

계약 변경과 리스코프 치환 법칙

1const dependency1 = () => {
2  taxCalculator.calculateTax(50);
3};
4
5const dependency2 = () => {
6  taxCalculator.calculateTax(150);
7};
8
9const dependency3 = () => {
10  const t = getFromDB();
11
12  if (t < 0) {
13    taxCalculator.calculateTax(250);
14  }
15};
16

상속과 계약

1class TaxCalculatorBrazil extends TaxCalculator {
2  public calculateTax(value: number): number {
3    // 사전 조건
4    if (value < 0) {
5      throw new Error('Value has to be positive');
6    }
7
8    // ...
9
10    return taxValue;
11  }
12}
13
14class TaxCalculatorUS extends TaxCalculator {
15  public calculateTax(value: number): number {
16    // 사전 조건
17    if (value >= 100) {
18      throw new Error('Value has to be positive');
19    }
20
21    // ...
22
23    // 사후 조건
24    if (taxValue < 0) {
25      throw new Error('Calculated tax cannot be negative');
26    }
27  }
28}
29
30class TaxCalculatorNL extends TaxCalculator {
31  public calculateTax(value: number): number {
32    // ...
33
34    // 사후 조건
35    if (taxValue < 0) {
36      throw new Error('Calculated tax cannot be negative');
37    }
38  }
39}
40

• TaxCalculatorBrazil

• TaxCalculatorUS

• TaxCalculatorNL

1. 자식 클래스의 사전 조건은 부모 클래스의 사전 조건보다 같거나 약해야한다. (더 많은 값을 받아야한다.)
2. 자식 클래스의 사후 조건은 부모 클래스의 사전 조건보다 같거나 강해야한다. (더 적은 값을 반환해야한다.)

계약에 의한 설계와 테스트의 연관성

1. 단언문을 통해 코드의 버그를 일찍 발견 가능하다.

2. 사전 조건, 사후 조건, 불변식은 개발자에게 테스트 대상을 제공한다.

3. 명시적인 계약은 클라이언트의 안정성을 가져온다.

현업에서의 계약 설계

강한 사전 조건 vs 약한 사전 조건

계약과 입력 유효성 검사는 다르다

예외 vs 부드러운 반환값

1ex)
2// 부드러운 반환값
3if (value === null) {
4  return '';
5}
6

관련 repositories

• original code (java)
• typescript ver.