ホーム 全セッション S03

Sensitive の値の性質のテスト

発展 3 / 4 目安 時間外

ページ一覧

あとで読む: Sensitive によるマスクを、値の性質のテストと型のテストで守る方法を確認します。

飼い主の連絡先(個人情報)の例で、値の性質のテストと型のテストが誤った変更を検出する様子を確認します。「値の性質のテストによる検証」のページと同じ形です。

  1. 守りたい性質は、どんなメールアドレスで OwnerContact を作っても、JSON にした文字列にそのメールアドレスが含まれないことです。fast-check は、ランダムな入力を多数生成するライブラリです。

    守りたい性質

    1. 入力

      メールアドレス。fast-check が多数生成します。

    2. 検証する処理

      OwnerContact.parse で連絡先を作り、JSON.stringify で JSON にします。

    3. 守りたい性質

      JSON の文字列に、メールアドレスが含まれません。

      {"ownerName":"[REDACTED]","ownerEmail":"[REDACTED]","ownerPhone":"[REDACTED]"}

  2. テストは、fast-check が作ったメールアドレスごとに JSON を作り、その文字列にメールアドレスが含まれていなければ true を返します。false を返す入力が1つでもあるか、例外が投げられると、テストは失敗します。clinicFixture は、このハンズオンのテスト用の固定データです。fc.stringMatching は、正規表現に合う文字列を作ります。

    テストのコード

    説明用(教材のコードにはありません)
    import fc from "fast-check";
    import { it } from "vitest";
    import { OwnerContact } from "../src/adaptor/primary/web/ownerContact.js";
    import { clinicFixture } from "../../fixtures/clinic.js";
    const emailAddress = fc.stringMatching(/^[a-z]{1,8}@example\.test$/);
    it("どんなメールアドレスでも、JSON にしても出ない", () => {
      fc.assert(
        fc.property(emailAddress, (ownerEmail) => {
          const contact = OwnerContact.parse({
            ...clinicFixture.ownerContact,
            ownerEmail,
          })._unsafeUnwrap();
          return !JSON.stringify(contact).includes(ownerEmail);
        }),
      );
    });

    fast-check が作る入力

    fc.stringMatching が正規表現に合わせて作る文字列の例

    • eod@example.test
    • ruc@example.test
    • i@example.test
    • wc@example.test
  3. 正しいコードでは、ownerEmail の値が Sensitive(値を包み、ログと JSON では [REDACTED] に置き換える型)で包まれるので、JSON では [REDACTED] になり、テストは通ります。

    変更前(正しいコード)

    examples/session-03-solution/src/adaptor/primary/web/ownerContact.ts:6-12
    const OwnerContactSchema = z
      .object({
        ownerName: z.string().min(1).brand<"OwnerName">().transform(Sensitive.of),
        ownerEmail: z.string().email().brand<"OwnerEmail">().transform(Sensitive.of),
        ownerPhone: z.string().min(1).brand<"OwnerPhone">().transform(Sensitive.of),
      })
      .readonly();

    テストの結果(説明用)

    JSON.stringify(contact) の結果
    {"ownerName":"[REDACTED]","ownerEmail":"[REDACTED]","ownerPhone":"[REDACTED]"}
    vitest の出力(説明用)
    ✓ test/contact.test.ts (1 test)
     Test Files  1 passed (1)
          Tests  1 passed (1)
  4. 誤った変更の例として、ownerEmail の行から .transform(Sensitive.of) を外します。メールアドレスは包まれなくなります。

    変更前(正しいコード)

    examples/session-03-solution/src/adaptor/primary/web/ownerContact.ts:6-12
    const OwnerContactSchema = z
      .object({
        ownerName: z.string().min(1).brand<"OwnerName">().transform(Sensitive.of),
        ownerEmail: z.string().email().brand<"OwnerEmail">().transform(Sensitive.of),
        ownerPhone: z.string().min(1).brand<"OwnerPhone">().transform(Sensitive.of),
      })
      .readonly();

    変更後(誤った変更)

    説明用(教材のコードにはありません) 実物: examples/session-03-solution/src/adaptor/primary/web/ownerContact.ts:6-12
    const OwnerContactSchema = z
      .object({
        ownerName: z.string().min(1).brand<"OwnerName">().transform(Sensitive.of),
        ownerEmail: z.string().email().brand<"OwnerEmail">(),
        ownerPhone: z.string().min(1).brand<"OwnerPhone">().transform(Sensitive.of),
      })
      .readonly();
  5. 誤った変更を加えると、fast-check が失敗する入力を検出して、反例として表示します。fast-check は、失敗した入力を、失敗を保ったまま単純な入力に縮めて表示します。

    変更前(正しいコード)

    JSON.stringify(contact) の結果
    {"ownerName":"[REDACTED]","ownerEmail":"[REDACTED]","ownerPhone":"[REDACTED]"}
    vitest の出力(説明用)
    ✓ test/contact.test.ts (1 test)
     Test Files  1 passed (1)
          Tests  1 passed (1)

    変更後(誤った変更)

    JSON.stringify(contact) の結果
    {"ownerName":"[REDACTED]","ownerEmail":"a@example.test","ownerPhone":"[REDACTED]"}
    vitest の出力(説明用)
    × どんなメールアドレスでも、JSON にしても出ない
      → Property failed after 1 tests
    Counterexample: ["a@example.test"]
    Shrunk 2 time(s)
     Test Files  1 failed (1)
          Tests  1 failed (1)
  6. 型のテストでは、@ts-expect-error の次の行が型エラーであれば tsc は成功し、型エラーがなければ tsc は失敗します。declare const contact は、値を作らずに、型だけを宣言します。変更前は、次の行が型エラーになるので、tsc は成功します。

    変更前(正しいコード)

    examples/session-03-solution/src/adaptor/primary/web/ownerContact.ts:6-12
    const OwnerContactSchema = z
      .object({
        ownerName: z.string().min(1).brand<"OwnerName">().transform(Sensitive.of),
        ownerEmail: z.string().email().brand<"OwnerEmail">().transform(Sensitive.of),
        ownerPhone: z.string().min(1).brand<"OwnerPhone">().transform(Sensitive.of),
      })
      .readonly();
    説明用(教材のコードにはありません)
    import type { OwnerContact } from "../src/adaptor/primary/web/ownerContact.js";
    declare const contact: OwnerContact;
    // @ts-expect-error
    const plain: string = contact.ownerEmail;
    export { plain };
    tsc の出力(説明用)
    (出力なし。終了コード 0)
  7. 誤った変更で ownerEmail の行から .transform(Sensitive.of) を外すと、ownerEmail が string に代入できる型になり、@ts-expect-error の次の行の型エラーが消えます。tsc は「未使用の @ts-expect-error」を報告し、失敗します。演習では exercises/guard/mine/ に *.type-test.ts という名前で置きます。

    変更後(誤った変更)

    説明用(教材のコードにはありません) 実物: examples/session-03-solution/src/adaptor/primary/web/ownerContact.ts:6-12
    const OwnerContactSchema = z
      .object({
        ownerName: z.string().min(1).brand<"OwnerName">().transform(Sensitive.of),
        ownerEmail: z.string().email().brand<"OwnerEmail">(),
        ownerPhone: z.string().min(1).brand<"OwnerPhone">().transform(Sensitive.of),
      })
      .readonly();
    説明用(教材のコードにはありません)
    import type { OwnerContact } from "../src/adaptor/primary/web/ownerContact.js";
    declare const contact: OwnerContact;
    // @ts-expect-error
    const plain: string = contact.ownerEmail;
    export { plain };
    tsc の出力(説明用)
    test/contact.type-test.ts(5,1): error TS2578: Unused '@ts-expect-error' directive.