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

더미, 페이크, 스텁, 모의 객체, 스파이

더미 객체

페이크 객체

스텁

모의 객체

스파이

모의 객체 프레임워크에 대한 소개

해당 책의 경우 Java의 Mockito 프레임워크를 기준으로 설명한다. 하지만 해당 포스트의 경우 Jest를 기반으로 작성되기에 Jest와 jest-mock-extended를 기준으로 작성된다.

의존성 스텁화

프로그램은 100보다 작은 값을 가지는 송장을 모두 반환한다. 송장은 데이터베이스테엇 찾을 수 있다. IssuedInvoices 클래스는 모든 송장을 검색하는 메서드를 이미 포함하고 있다.

1export class InvoiceFilter {
2  public lowValueInvoices(): Invoice[] {
3    const dbConnection = new DatabaseConnection(); // 1
4    const issuedInvoices = new IssuedInvoices(databaseConnection); // 2
5
6    try {
7      const all: Invoice[] = this.issuedInvoices.all();
8
9      return all.filter((invoice) => invoice.getValue() < 100); // 3
10    } finally {
11      dbConnection.close(); // 4
12    }
13  }
14}
15

1. 종속성 클래스 IssuedInvoices를 생성한다.
2. 데이터베이스로부터 모든 송장을 얻는다.
3. 값이 100보다 작은 것들을 고른다.
4. 데이터베이스 연결을 닫는다.

1describe('InvoiceFilter', () => {
2  let invoices: IssuedInvoices;
3  let dbConnection: DatabaseConnection;
4
5  beforeEach(() => {
6    // 1
7    dbConnection = new DatabaseConnection();
8    invoices = new IssuedInvoices(dbConnection);
9
10    dbConnection.resetDatabase(); // 2
11  });
12
13  afterEach(() => {
14    dbConnection.close(); // 3
15  });
16
17  it('filterInvoices', () => {
18    const mauricio = new Invoice('Mauricio', 20); // 4
19    const steve = new Invoice('Steve', 99); // 5
20    const frank = new Invoice('Frank', 100); // 5
21    invoices.save(mauricio); // 6
22    invoices.save(steve); // 6
23    invoices.save(frank); // 6
24
25    const invoiceFilter = new InvoiceFilter(); // 7
26    expect(invoiceFilter.lowValueInvoices()).toEqual([mauricio, steve]); // 8
27  });
28});
29

1. 모든 테스트가 실행되기 전 조건들을 설정한다.
2. 데이터베이스를 리셋한다.
3. 모든 테스트가 끝나면 데이터베이스의 연결을 끊는다.
4. 인메모리 송장을 생성한다.
5. 경계 테스트를 수행한다.
6. 데이터베이스에 해당 송장을 영속화한다.
7. InvoiceFilter를 초기화ㅘㄴ다.
8. 메서드가 작은 값을 가진 송장을 반환한다고 단언한다.

1export class InvoiceFilter {
2  private issuedInvoices: IssuedInvoices;
3
4  public constructor(issuedInvoices: IssuedInvoices) {
5    this.issuedInvoices = issuedInvoices;
6  }
7
8  public lowValueInvoices(): Invoice[] {
9    const dbConnection = new DatabaseConnection();
10
11    try {
12      const all = this.issuedInvoices.all();
13      return all.filter((invoice) => invoice.getValue() < 100);
14    } finally {
15      dbConnection.close();
16    }
17  }
18}
19

1import { type MockProxy, mock } from 'jest-mock-extended';
2
3import { DatabaseConnection } from './DatabaseConnection';
4import { Invoice } from './Invoice';
5import { InvoiceFilter } from './InvoiceFilter';
6import { IssuedInvoices } from './IssuedInvoices';
7
8describe('InvoiceFilter', () => {
9  let invoices: MockProxy<IssuedInvoices>;
10  let dbConnection: DatabaseConnection;
11
12  beforeEach(() => {
13    dbConnection = new DatabaseConnection();
14    invoices = mock<IssuedInvoices>(); // 1
15
16    dbConnection.resetDatabase();
17  });
18
19  afterEach(() => {
20    dbConnection.close();
21  });
22
23  it('filterInvoices', () => {
24    const mauricio = new Invoice('Mauricio', 20);
25    const steve = new Invoice('Steve', 99);
26    const frank = new Invoice('Frank', 100); // 2
27    const listOfInvoices = [mauricio, steve, frank];
28
29    invoices.all.mockReturnValue(listOfInvoices); //3
30
31    const invoiceFilter = new InvoiceFilter(invoices); // 4
32    expect(invoiceFilter.lowValueInvoices()).toEqual([mauricio, steve]); // 5
33  });
34});
35

1. jest-mock-extended의 모의 메서드를 사용해 IssuedInvoices의 스텁 인스턴스를 생성한다.
2. 송장을 생성한다.
3. all 메서드가 미리 정의된 송장을 반환하도록 한다.
4. 테스트 대상 클래스의 인스턴스를 생성하고 종속성으로 스텁을 전달한다.
5. 테스트를 진행한다.

모의 객체와 기댓값

작은 값을 가진 송장을 모두 SAP(비즈니스 운영 관리 시스템)으로 전송해야한다. SAP는 송장을 받기 위해 sendInvoice 웹 서비스를 제공한다.

1import { Invoice } from '../stub/Invoice';
2import { InvoiceFilter } from '../stub/InvoiceFilter';
3
4import { SAP } from './SAP';
5
6export class SAPInvoiceSender {
7  private readonly filter: InvoiceFilter;
8
9  private readonly sap: SAP;
10
11  public constructor(filter: InvoiceFilter, sap: SAP) {
12    this.filter = filter;
13    this.sap = sap;
14  }
15
16  public sendLowValuedInvoices(): void {
17    const lowValuedInvoices: Invoice[] = this.filter.lowValueInvoices();
18
19    for (const invoice of lowValuedInvoices) {
20      this.sap.send(invoice);
21    }
22  }
23}
24

1describe('SAPInvoiceSender', () => {
2  const invoiceFilter = mock<InvoiceFilter>(); // 1
3  const sap = mock<SAP>(); // 1
4  const sender = new SAPInvoiceSender(invoiceFilter, sap); // 2
5
6  it('sentToSap', () => {
7    const mauricio = new Invoice('Mauricio', 20);
8    const frank = new Invoice('Frank', 99);
9    const invoices = [mauricio, frank];
10
11    invoiceFilter.lowValueInvoices.mockReturnValue(invoices); // 3
12
13    sender.sendLowValuedInvoices(); // 4
14
15    expect(sap.send).toHaveBeenCalledTimes(2);
16    expect(sap.send).toHaveBeenCalledWith(mauricio);
17    expect(sap.send).toHaveBeenCalledWith(frank); // 5
18  });
19});
20

1. 모의 객체 인스턴스를 생성한다.
2. 테스트 대상 클래스에 전달한다.
3. invoiceFilter 스텁을 설정한다. lowValueInvoices의 반환 값을 지정한다.
4. 테스트 대상 메서드를 호출한다.
5. send 메서드가 두 송장에 대해 호출되었는지 확인한다.

인수 포획

SAP는 이제 Invoice 엔티티를 직접 받지 않고 다른 형식으로 전송된 데이터를 받는다. SAP는 고객명, 송장 가격, 생성 ID가 필요하다.
ID는 다음과 같은 형식을 따른다: <날짜><고객코드>
- 날짜 형식은 'MMddyyyy'이다.
- 고객 코드는 고객 이름의 첫 두글자이다. 고객 이름이 두글자보다 짧으면 X로 한다.

1// SapInvoices.ts
2
3export class SapInvoice {
4  private readonly customer: string;
5  private readonly value: number;
6  private readonly id: string;
7
8  public constructor(customer: string, value: number, id: string) {
9    if (!customer || !id) {
10      throw new Error('Customer and ID must be provided');
11    }
12
13    this.customer = customer;
14    this.value = value;
15    this.id = id;
16  }
17
18  public getCustomer(): string {
19    return this.customer;
20  }
21
22  public getValue(): number {
23    return this.value;
24  }
25
26  public getId(): string {
27    return this.id;
28  }
29}
30
31// SAPInvoiceSender.ts
32
33export class SAPInvoiceSender {
34  private readonly filter: InvoiceFilter;
35  private readonly sap: SAP;
36
37  public constructor(filter: InvoiceFilter, sap: SAP) {
38    this.filter = filter;
39    this.sap = sap;
40  }
41
42  public sendLowValuedInvoices(): void {
43    const lowValuedInvoices: Invoice[] = this.filter.lowValueInvoices();
44
45    for (const invoice of lowValuedInvoices) {
46      const customer = invoice.getCustomer();
47      const value = invoice.getValue();
48      const sapId = this.generateId(invoice);
49
50      const sapInvoice = new SapInvoice(customer, value, sapId);
51
52      this.sap.send(sapInvoice);
53    }
54  }
55
56  private generateId(invoice: Invoice): string {
57    const date = new Date()
58      .toLocaleDateString('en-US', {
59        month: '2-digit',
60        day: '2-digit',
61        year: 'numeric',
62      })
63      .replace(/\//g, '');
64    const customer = invoice.getCustomer();
65
66    return date + (customer.length > 2 ? customer.substring(0, 2) : 'X');
67  }
68}
69

1it('sendToSapWithGeneratedId', () => {
2  const mauricio = new Invoice('Mauricio', 20);
3  const invoices = [mauricio];
4
5  invoiceFilter.lowValueInvoices.mockReturnValue(invoices);
6
7  sender.sendLowValuedInvoices();
8  expect(sap.send).toHaveBeenCalledWith(expect.any(SapInvoice));
9});
10

1it.each([
2  ['Mauricio', 'Ma'],
3  ['M', 'X'],
4])('sendToSapWithTheGeneratedId', (customer, initialId) => {
5  const mauricio = new Invoice(customer, 20);
6  const invoices = [mauricio];
7
8  invoiceFilter.lowValueInvoices.mockReturnValue(invoices);
9
10  sender.sendLowValuedInvoices();
11
12  const date = new Date()
13    .toLocaleDateString('en-US', {
14      month: '2-digit',
15      day: '2-digit',
16      year: 'numeric',
17    })
18    .replace(/\//g, '');
19
20  expect(sap.send).toHaveBeenCalledWith(expect.any(SapInvoice));
21  expect(sap.send).toHaveBeenCalledWith(new SapInvoice(customer, 20, date + initialId));
22});
23

예외 시뮬레이션

시스템은 전송에 실패한 송장 목록을 반환한다. 실패가 일어나더라도 프래고램은 멈추지 않으며, 재시도가 이루어진다.

1public sendLowValuedInvoices() {
2  const lowValuedInvoices: Invoice[] = this.filter.lowValueInvoices()
3  for (const invoice of lowValuedInvoices) {
4    const customer = invoice.getCustomer()
5    const value = invoice.getValue()
6    const sapId = this.generateId(invoice)
7    const sapInvoice = new SapInvoice(customer, value, sapId)
8    try {
9      this.sap.send(sapInvoice)
10    } catch {
11      this.failedInvoices.push(invoice)
12    }
13  }
14  return this.failedInvoices
15}
16

1it('returnFailedInvoices', () => {
2  const mauricio = new Invoice('Mauricio', 20);
3  const frank = new Invoice('Frank', 25);
4  const steve = new Invoice('Steve', 48);
5
6  const invoices = [mauricio, frank, steve];
7  invoiceFilter.lowValueInvoices.mockReturnValue(invoices);
8
9  sap.send.mockImplementation((invoice: SapInvoice) => {
10    if (invoice.getCustomer() === 'Frank') {
11      // 1
12      throw Error();
13    }
14  });
15
16  const date = new Date()
17    .toLocaleDateString('en-US', {
18      month: '2-digit',
19      day: '2-digit',
20      year: 'numeric',
21    })
22    .replace(/\//g, '');
23
24  const failedInvoices = sender.sendLowValuedInvoices(); // 2
25  expect(failedInvoices).toEqual(expect.arrayContaining([frank])); // 3
26
27  const mauricioInvoice = new SapInvoice('Mauricio', 20, date + 'Ma'); // 4
28  expect(sap.send).toHaveBeenNthCalledWith(1, mauricioInvoice);
29  const steveInvoice = new SapInvoice('Steve', 48, date + 'St'); // 4
30  expect(sap.send).toHaveBeenNthCalledWith(3, steveInvoice);
31});
32

1. send의 인자로 frank가 들어올 시 에러를 반환하도록 구성한다.
2. 실패한 송장 목록을 받는다.
3. 실패한 송장 목록 내에 frank가 존재하는지 확인한다.
4. 마우리시오와 스티브의 송장을 전송 시도하였는지 확인한다.

현업에서의 모의 객체

모의 객체의 단점

모의해야하는 대상과 하지 말아야 하는 대상

모의를 사용하는 경우

모의를 사용하지 않는 경우

날짜 및 시간 래퍼

🤔 작성자의 생각
날짜를 가공하기 위해 존재하는 서비스 클래스가 없는 경우 jest에서는 timer mocks가 더 적절할 수도 있을 것 같다.

관련 repositories

• original code (java)
• typescript ver.