ホーム 全セッション S03

値の性質のテストによる検証

13 / 18 目安 0.5分

ページ一覧

解決策: 修正したコードも、次の変更で元の状態に戻る場合があります。守る仕組みのうち、値の性質のテスト(プロパティベーステスト)と型のテストの実装方法を学びます。

3つ目の課題は、修正後の状態の維持です。このページでは、UUID の検査の例で、値の性質のテスト(プロパティベーステスト)と型のテストが誤った変更を検出する様子を確認します。

  1. 守りたい性質は、UUID でない文字列を予約ID として渡したとき、StartExaminationInput.parse が Err を返すことです。値の性質のテスト(プロパティベーステスト)は、ランダムな入力を多数生成して、この性質が常に成り立つかを検証します。fast-check は、その入力を生成するライブラリです。

    守りたい性質

    1. 入力

      UUID でない文字列。fast-check が多数生成します。

    2. 検証する処理

      予約IDとして StartExaminationInput.parse に渡します。

    3. 守りたい性質

      結果は Err です。

      Err()

  2. テストは、fast-check が作った UUID でない文字列を予約IDとして parse に渡し、結果が Err であれば true を返します。false を返す入力が1つでもあるか、例外が投げられると、テストは失敗します。fc.string() は任意の文字列を作り、filter は UUID の形の文字列を除きます。

    テストのコード

    説明用(教材のコードにはありません)
    import fc from "fast-check";
    import { it } from "vitest";
    
    import { StartExaminationInput } from "../subjects/input.js";
    
    const veterinarianId = "44444444-4444-4444-8444-444444444444";
    const uuidLike = /^[0-9a-f-]{36}$/i;
    const notUuid = fc.string().filter((s) => !uuidLike.test(s));
    
    it("UUID でない予約 ID は Err になる", () => {
      fc.assert(
        fc.property(notUuid, (appointmentId) => {
          const input = { appointmentId, veterinarianId };
          return StartExaminationInput.parse(input).isErr();
        }),
      );
    });

    fast-check が作る入力

    notUuid が作る文字列の例

    • ""
    • " "
    • "a"
    • "gm0"
  3. 正しいコードでは、予約IDの schema が UUID の形を検査するので、UUID でない文字列は Err になり、テストは通ります。

    変更前(正しいコード)

    examples/session-03-solution/src/adaptor/primary/web/startExaminationInput.ts:7-10
    const schema = z.object({
      appointmentId: AppointmentId.schema,
      veterinarianId: VeterinarianId.schema,
    }).readonly();

    テストの結果(説明用)

    StartExaminationInput.parse の結果
    Err()
    vitest の出力(説明用)
    ✓ mine/input.test.ts (1 test)
     Test Files  1 passed (1)
          Tests  1 passed (1)
  4. 誤った変更の例として、2つの ID の schema から UUID の検査を外します。UUID でない文字列も受け付けるようになります。

    変更前(正しいコード)

    examples/session-03-solution/src/adaptor/primary/web/startExaminationInput.ts:7-10
    const schema = z.object({
      appointmentId: AppointmentId.schema,
      veterinarianId: VeterinarianId.schema,
    }).readonly();

    変更後(誤った変更)

    説明用(教材のコードにはありません) 実物: examples/session-03-solution/src/adaptor/primary/web/startExaminationInput.ts:7-10
    const schema = z.object({
      appointmentId: z.string().brand<"AppointmentId">(),
      veterinarianId: z.string().brand<"VeterinarianId">(),
    }).readonly();
  5. 誤った変更を加えると、fast-check が失敗する入力を検出して、反例として表示します。fast-check は、失敗した入力を、失敗を保ったまま単純な入力に縮めて表示します。

    変更前(正しいコード)

    StartExaminationInput.parse の結果
    Err()
    vitest の出力(説明用)
    ✓ mine/input.test.ts (1 test)
     Test Files  1 passed (1)
          Tests  1 passed (1)

    変更後(誤った変更)

    StartExaminationInput.parse の結果
    Ok({ appointmentId: "", veterinarianId: "44444444-4444-4444-8444-444444444444" })
    vitest の出力(説明用)
    × UUID でない予約 ID は Err になる
      → Property failed after 1 tests
    Counterexample: [""]
    Shrunk 1 time(s)
     Test Files  1 failed (1)
          Tests  1 failed (1)
  6. 型のテストでは、@ts-expect-error の次の行が型エラーであれば tsc は成功し、型エラーがなければ tsc は失敗します。declare const input は、値を作らずに、型だけを宣言します。変更前は、獣医師IDを予約IDの変数へ代入する次の行が型エラーになるので、tsc は成功します。

    変更前(正しいコード)

    examples/session-03-solution/src/adaptor/primary/web/startExaminationInput.ts:7-10
    const schema = z.object({
      appointmentId: AppointmentId.schema,
      veterinarianId: VeterinarianId.schema,
    }).readonly();
    説明用(教材のコードにはありません)
    import type { AppointmentId }
      from "../../../src/domain/appointment/index.js";
    import { StartExaminationInput } from "../subjects/input.js";
    
    declare const input: StartExaminationInput;
    
    // @ts-expect-error
    const appointmentId: AppointmentId = input.veterinarianId;
    tsc の出力(説明用)
    (出力なし。終了コード 0)
  7. 別の誤った変更として、veterinarianId の schema を AppointmentId.schema に変えます。2つの ID が同じ型になり、@ts-expect-error の次の行の型エラーが消えます。tsc は「未使用の @ts-expect-error」を報告し、失敗します。演習では exercises/guard/mine/ に *.type-test.ts という名前で置きます。

    変更後(誤った変更)

    説明用(教材のコードにはありません) 実物: examples/session-03-solution/src/adaptor/primary/web/startExaminationInput.ts:7-10
    const schema = z.object({
      appointmentId: AppointmentId.schema,
      veterinarianId: AppointmentId.schema,
    }).readonly();
    説明用(教材のコードにはありません)
    import type { AppointmentId }
      from "../../../src/domain/appointment/index.js";
    import { StartExaminationInput } from "../subjects/input.js";
    
    declare const input: StartExaminationInput;
    
    // @ts-expect-error
    const appointmentId: AppointmentId = input.veterinarianId;
    tsc の出力(説明用)
    mine/ids.type-test.ts(7,1): error TS2578: Unused '@ts-expect-error' directive.