VitestでLitコンポーネントをテストするためのチュートリアル

記事作成日時: 2022/08/02 03:45

最終更新日時: 2022/08/02 03:45


VitestでLitのコンポーネントをテストするまでのチュートリアルです。

プロジェクトを用意する

lit-test-sampleという名前のNodeプロジェクトを作成します。

mkdir lit-test-sample
cd lit-test-sample
npm init -y

Litをインストールする

npm install lit

Vitestとjsdomをインストールする

npm install --save-dev vitest

テストコードの実行環境としてjsdomを使うので、一緒にインストールします。

npm install --save-dev jsdom

vitest.config.tsを用意する

実行環境にjsdomを指定するため、vitest.config.tsを設定します。

import { defineConfig } from "vitest/config";

export default defineConfig({
  test: {
    environment: "jsdom",
  },
});

package.jsonのscriptsにテストスクリプトを設定する

Vitestを実行できるようにpackage.jsonのscriptsにtestを定義します。

{
  "name": "lit-test-sample",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "vitest"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "lit": "^2.2.8"
  },
  "devDependencies": {
    "jsdom": "^20.0.0",
    "vitest": "^0.20.2"
  }
}

tsconfig.jsonを用意する

以下のtsconfig.jsonを用意します。

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "useDefineForClassFields": false,
    "importsNotUsedAsValues": "preserve"
  }
}

テストをするLitコンポーネントを作成する

テストするLitコンポーネント、hello-world.tsを作成します。
nameで指定された値を使って"Hello, {name}!"と表示するだけのシンプルなコンポーネントです。

import { html, LitElement } from "lit";
import { customElement, property } from "lit/decorators.js";

@customElement("hello-world")
export class HelloWorld extends LitElement {
  @property()
  name = "World";

  render() {
    return html`<p>Hello, ${this.name}!</p>`;
  }
}

テストを作成する

hello-world.tsをテストする、hello-world.test.tsを作成します。

import { describe, expect, it } from "vitest";
import "./hello-world";

describe("HelloWorld", () => {
  it("should show name props", async () => {
    // Setup
    document.body.innerHTML = "<hello-world name='Test'></hello-world>";
    await customElements.whenDefined("hello-world");

    // Action
    const helloWorldElement = document.body.querySelector("hello-world");
    const actual = helloWorldElement.shadowRoot.querySelector("p").textContent;

    // Assert
    expect(actual).toBe("Hello, Test!");
  });
});

テストを実行する

npm test

正しくテストが通ると以下のように結果が出力されます。

 ✓ hello-world.test.ts (1)

Test Files  1 passed (1)
     Tests  1 passed (1)
      Time  1.44s (in thread 22ms, 6536.64%)

 PASS  Waiting for file changes...
       press h to show help, press q to quit

参考情報