👩🏻‍🔧 Using Matchers

• Jest는 "매처"를 사용하여 다양한 방식으로 값을 테스트할 수 있다.
• 여기서는 일반적으로 사용되는 몇가지 매처를 소개한다.
• 전체 목록은 expect API doc를 참고하자

💡 TIP

npm install --save-dev @types/jest

타입스크립트를 사용하지 않더라도 @types/jest를 설치하면 vscode 코드 자동 완성 기능을 사용할 수 있습니다😉

😀 공통 매처(Matchers)

---

.toBe

값을 테스트하는 가장 간단한 방법은 정확한 일치를 사용하는 것이다.

test('two plus two is four', () => {
  expect(2 + 2).toBe(4);
});

위 코드에서 expect(2+2)는 "expectation" 객체를 반환한다. 일반적으로 매처를 호출하는 것을 제외하고는 이러한 "expectation" 객체로 많은 작업을 수행하지 않는다.

이 코드에서 .toBe(4)는 매처이다.
Jest가 실행되면 실패한 매처들을 모두 추적하여 멋진 오류 메시지를 출력해줄 수 있다.

.toBe는 Object.is를 사용하여 정확한 일치를 테스트한다.
객체의 값을 확인할 때는 .toEqual를 사용하자.

.toEqual, .toStrictEqual

test('object assignment', () => {
  const data = {one: 1};
  data['two'] = 2;
  expect(data).toEqual({one: 1, two: 2});
});

.toEqual은 객체 또는 배열의 모든 필드를 재귀적으로 검사한다.

💡 TIP
.toEqual은 undefined 속성을 가진 객체의 키, undefined인 배열 항목, 희소 배열(sparse array), 객체 타입 불일치인 경우는 무시한다. 이를 고려하려면 .toStrictEqual를 사용하자.

not을 사용하여 매처의 반대를 테스트할 수도 있다.

test('adding positive numbers is not zero', () => {
  for (let a = 1; a < 10; a++) {
    for (let b = 1; b < 10; b++) {
      expect(a + b).not.toBe(0);
    }
  }
});

여기서 not은 "Modifier" 중 하나인데 "Modifier"은 다음 글에서 알아보자

🤥 Truthiness

---

테스트에서 undefined, null 그리고 false를 구별해야하는 경우도 있지만 이를 다르게 취급하고 싶지 않은 경우도 있다.

• .toBeNull은 null만 일치
• .toBeUndefined는 undefined만 일치
• .toBeDefined는 toBeUndefined와 반대
• .toBeTruthy는 if문이 true로 취급하는 모든 항목과 일치
• .toBeFalsy는 if문이 false로 취급하는 모든 항목과 일치

예시는 다음과 같다

test("null", () => {
  const n = null;
  expect(n).toBeNull();
  expect(n).toBeDefined();
  expect(n).not.toBeUndefined();
  expect(n).not.toBeTruthy();
  expect(n).toBeFalsy();
});

test("zero", () => {
  const z = 0;
  expect(z).not.toBeNull();
  expect(z).toBeDefined();
  expect(z).not.toBeUndefined();
  expect(z).not.toBeTruthy();
  expect(z).toBeFalsy();
});

test("undefined", () => {
  const u = undefined;
  expect(u).not.toBeNull();
  expect(u).not.toBeDefined();
  expect(u).toBeUndefined();
  expect(u).not.toBeTruthy();
  expect(u).toBeFalsy();
});

🔢 숫자(Numbers)

---

숫자를 비교하는 대부분의 방법에는 상응하는 매처가 있다.

test("two plus two", () => {
  const value = 2 + 2;
  expect(value).toBeGreaterThan(3);
  expect(value).toBeGreaterThan(3.5);
  expect(value).toBeGreaterThanOrEqual(4);
  expect(value).toBeLessThan(5);
  expect(value).toBeLessThan(4.5);
  expect(value).toBeLessThanOrEqual(4);

  // toBe and toEqual are equivalent for numbers
  expect(value).toBe(4);
  expect(value).toEqual(4);
});

테스트가 작은 반올림 오류(rounding error)에 의존하는 것을 원하지 않을 경우 부동 소수점(Floating point) 동등성을 위해서 .toEqual 대신 .toBeCloseTo를 사용하자.

test("adding floating point numbers", () => {
  const value = 0.1 + 0.2;
  // expect(value).toBe(0.3); // 반올림 오류(rounding error)로 인한 오류
  expect(value).toBeCloseTo(0.3); // this works
});

🔡 문자열(Strings)

---

.toMatch를 사용해서 정규식에 대한 문자열을 확인할 수 있다.

test('there is no I in team', () => {
  expect('team').not.toMatch(/I/);
});

test('but there is a "stop" in Christoph', () => {
  expect('Christoph').toMatch(/stop/);
});

🅰️ 배열(Arrays)과 이터러블(iterables)

---

.toContain(item)

.toContain을 사용하여 배열이나 이터러블에 특정 항목이 포함되어 있는지 확인할 수 있다. 배열의 항목을 테스트하기 위해 엄격한 동등성(equality) 검사인 ===를 사용한다.

const shoppingList = [
  'diapers',
  'kleenex',
  'trash bags',
  'paper towels',
  'milk',
];

test('the shopping list has milk on it', () => {
  expect(shoppingList).toContain('milk');
  expect(new Set(shoppingList)).toContain('milk');
});

.toContain은 문자열은 다른 문자열의 하위 문자열(substring)인지 여부도 확인할 수 있다.

test("'jerry' is a substring of 'my name is jerry'", () => {
  expect("my name is jerry").toContain("jerry");
});

.toContainEqual(item)

특정 구조와 값을 가진 항목이 배열에 포함되어 있는지 확인하려면 .toContain을 사용하자. 배열의 항목을 테스트하기 위해 이 매처는 객체 동일성(identity)를 확인하는 대신 모든 필드의 동등성(equality)을 재귀적으로 확인한다.

function myBeverages() {
  return [
    "cocacola",
    "sprite",
    { spicy: true, sweet: true },
    { delicious: true, sour: false },
  ];
}

describe("my beverage", () => {
  test("is delicious and not sour", () => {
    const myBeverage = { delicious: true, sour: false };
    expect(myBeverages()).toContainEqual(myBeverage, "cocacola");
  });
});

⚠️ 예외(Exeptions)

---

특정 함수가 호출될 때 오류를 발생시키는지 테스트하려면 .toThrow를 사용하자

function compileAndroidCode() {
  throw new Error("you are using the wrong JDK!");
}

test("compiling android goes as expected", () => {
  expect(() => compileAndroidCode()).toThrow();
  expect(() => compileAndroidCode()).toThrow(Error);

  // 오류 메시지에 포함되어야 하는 문자열 또는 정규 표현식을 사용할 수 도 있다.
  expect(() => compileAndroidCode()).toThrow("you are using the wrong");
  expect(() => compileAndroidCode()).toThrow(/JDK/);

  // 아래와 같은 정규 표현식을 사용하면 정확한 오류 메시지를 일치시킬 수 있다.
  expect(() => compileAndroidCode()).toThrow(/^you are using the wrong JDK$/); // Test fails
  expect(() => compileAndroidCode()).toThrow(/^you are using the wrong JDK!$/); // Test pass
});

💡TIP
예외를 발생시키는 함수는 wrapping function 내에서 호출되어야 한다. 그렇지 않으면 .toTrow는 실패한다.

➕ And More

---

아직까지는 맛보기였다. 매처의 전체 목록은 참조 문서를 확인하자.
사용 가능한 매처에 대해 배웠다면 다음 단계는 Jest에서 비동기 코드를 테스트하는 방법을 확인하는 것이다. 다음 글에서 살펴보자!

이 글은 아래 사이트를 참고하여 작성했습니다🙂
https://jestjs.io/docs/using-matchers