プログラミングマガジン

プログラミングを中心にIT技術をできるだけわかりやすくまとめます。

  • ホーム
  • JavaScript
  • StoryBookのインタラクションテスト
 
 
     
  • サーバー言語  
    • Python
    • Ruby
    • PHP
    • SQL
  •  
  • インフラ  
       
    • AWS
    •  
    • 基本
    • Git
  • Web
       
    • Web開発
    • JavaScript
    • Vue.js
    • React
  •  
  • 設計  
       
    • 実装設計
    • DB設計
  • 問い合わせ
  

StoryBookのインタラクションテスト

09.28

  • miyabisan2
  • コメントを書く

この記事は1分で読めます

testing-libraryなどのパッケージを使ったUIテスト(ユーザーイベントのテスト)と同じようなテストをStoryBookを使って記述することが可能です。

PlayFunctionとは?

StoryBookを使ってユーザーインタラクションテストの実装ができるパッケージです。

インストール

1
npm i -D @storybook/jest

storybook用に拡張されたjestをインストールします。

サンプル

以下はFormからテキストボックスのDOMを読み取って初期値が空になっていることをチェックするテストケースです。react-testing-libraryのuser-eventとほぼ同じようにstorybook上で記述することが可能です。(storybookのインタラクションテストの場合は通常のtesting-libraryの時と異なりsetupは不要です。)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
import Form from "./Form";
import type {Meta,StoryObj} from "@storybook/react"
import {within} from "@storybook/testing-library"
import {expect} from "@storybook/jest"
import { userEvent } from "@storybook/testing-library"
 
const meta = {
    title: "Form",
    component: Form,
} as Meta<typeof Form>;
 
export default meta;
 
type Story = StoryObj<typeof Form>;
 
export const Default: Story = {}
 
export const Test: Story = {
    play: async ({canvasElement})=>{
        const canvas = within(canvasElement);
        const input = canvas.getByRole("textbox");
        await userEvent.type(input,"aaaa");
        await expect(canvas.getByDisplayValue("aaaa")).toBeInTheDocument();
    }
}

play

これがPlayFunctionの宣言になります。

canvas

react-testing-libraryのscreenと非常によく似たオブジェクトになります。

実行結果

以下のようにTestというstoryに対してInteractionsというタブを開くとテストが実行されていることがわかります。(テキストボックスへの文字入力のテストをしています。)

注意点

storybookでインタラクションテストを行えることはわかりましたが、通常のjest+testing-libraryの方でも同じことは行えるので重複したテストコードを書かないように注意しましょう。

判断としては、個人的にはtesting-libraryでまずは同じことができないか考えてみるのがよいです。理由としては、hooksなどのテストではtesting-libraryを使うと思うので同じ場所にまとめてしまった方がテストコードの管理面でよいと思われるためです。また、モックも現状だと使えないです。

ただ、Storybookは視覚的に確認しながらテストができるという利点があるのでその点も考慮して実装を検討するのが良いです。

スポンサーリンク
  • 2023 09.28
  • miyabisan2
  • コメントを書く
  • JavaScript
  • Tweets Twitter
  • このエントリーをはてなブックマークに追加
  • LINEで送る

関連記事

  1. 2018 07.05

    【JavaScript】「Globalオブジェクト」について

  2. 2021 08.15

    【JavaScript】「null」と「undefined」、「空文字」の使い分け

  3. 2020 05.09

    【JavaScript】配列の便利メソッド「map」、「filter」、「find」、「reduce」について

  4. 2020 05.03

    【JavaScript】非同期関数(「async」、「await」)について

  5. 2021 05.01

    【JavaScript】for文、繰り返し文、配列系メソッドの使い分け

  6. 2018 04.12

    【JavaScript】「コールバック関数」や、「コールバック地獄」について

  • コメント ( 0 )
  • トラックバック ( 0 )
  1. この記事へのコメントはありません。

  1. この記事へのトラックバックはありません。

返信をキャンセルする。

StoryBookの基本

StoryBookのビジュアルリグレッションテスト

RETURN TOP

著者プロフィール

エンジニア歴10年で過去に業務系、Webデザイン、インフラ系なども経験あります。現在はWeb系でフロントエンド開発中心です。

詳細なプロフィールはこちら

スポンサーリンク

カテゴリー

  • Android
  • AngularJS
  • API
  • AWS
  • C++
  • CSS
  • cursor
  • C言語
  • DDD
  • DevOps
  • Django
  • Docker
  • Figma
  • Git
  • GitLab
  • GraphQL
  • gRPC
  • Hasura
  • Java
  • JavaScript
  • Kubernetes
  • Laravel
  • linux
  • MySQL
  • Next.js
  • nginx
  • Node.js
  • NoSQL
  • Nuxt.js
  • Oracle
  • PHP
  • Python
  • React
  • Redux
  • Rspec
  • Ruby
  • Ruby on Rails
  • Sass
  • Spring Framework
  • SQL
  • TypeScript
  • Unity
  • Vue.js
  • Webサービス開発
  • Webデザイン
  • Web技術
  • インフラ
  • オブジェクト指向
  • システム開発
  • セキュリティ
  • その他
  • データベース
  • デザインパターン
  • テスト
  • ネットワーク
  • プログラミング全般
  • マイクロサービス
  • マイクロソフト系技術
  • マルチメディア
  • リファクタリング
  • 副業
  • 未分類
  • 業務知識
  • 生成AI
  • 設計
  • 関数型言語
RETURN TOP

Copyright ©  プログラミングマガジン | プライバシーポリシー