任意のブラウザ上でJestで書いたテストを実行する
フロントエンドエンジニアの今村です。任意のブラウザ上でJestで書いたテストを実行する方法を紹介します。
TL;DR
- Jestのテストランナーを任意のブラウザを対象に実行するのは難しい
- Jestのモックやアサーションの機能はブラウザ環境で実行可能
-> 「ブラウザ向けのテストランナー（たとえばKarma） + Jestのテストコード」の組み合わせならブラウザ上で実行できる
Jestとは
JavaScriptの世界で現在もっとも人気がありそうなテスティングフレームワークです。次のような特徴があります。
- 早い
- ブラウザ向けのコードのテストでもブラウザを起動せず、JSDOMというNode.js上に仮想的に用意したブラウザ環境を使う
- テストを並列に実行できる
- watchモードではコード変更時に関連するテストだけを実行する
- オールインワン
- テストランナー
- アサーション
- モック
- カバレッジ
- スナップショットテスト
- HTMLのレンダリング結果をスナップショットとして保存し、UIの予期せぬ変更がないか確認するためのテスト
- StorybookのアドオンのStoryShotsも、Jestを利用してスナップショットテストの機能を提供している
Jestのデメリット
Jestの最大のデメリットの一つは、ブラウザ向けのコードのテストを任意のブラウザ上で実行できないことでしょう。
関連するissue: https://github.com/facebook/jest/issues/848
先に述べたとおり、テストは通常JSDOM環境で実行されます。
公式ドキュメントにpuppeteerで動かす方法が載っていたり、Electronで動かすためのカスタムランナーが開発されていたりしますが、「任意のブラウザ」とまではいきません。コードの中に（たとえば）IEでのみ発生するバグが潜んでいないか、Jestによるユニットテストで検出することはできないのでしょうか。
ソリューション
- この頃流行りのJestを使いたい
- 任意のブラウザ上でテストを実行できなければ精神の安寧が得られない
相反する思いにさいなまれながら上記のissueを眺めていた私の目に、次のコメントが飛び込んできました。
https://github.com/facebook/jest/issues/848#issuecomment-324921548
Jestの機能のうちアサーションを担うexpectと、モックを担うjest-mockは、すでにブラウザ上で動くようになっているというのです。つまり、Jestで書いたテストコードそのものはブラウザ上で問題なく動くはず、ということです。現時点で任意のブラウザで動かすのが難しいのはテストランナーですが、これはKarmaでも使ってみましょう。
というわけで、試してみたのが以下です。
https://github.com/kimamula/jest-karma-angular-demo
仕事で普段Angularを使っているので、Angularプロジェクトで試しています。このリポジトリからコードをcloneすると、Jestで書いた同一のテストコードをJestのテストランナーでもKarmaでも動かせるのを確認できます。
yarn test-> Jestのテストランナーによるテストyarn karma-> Karmaによるテスト
キモは、Karmaからテストを実行する際のエントリーポイントとなるファイルで、次の処理を追記することです。
// https://github.com/kimamula/jest-karma-angular-demo/blob/master/src/test.ts
window['jest'] = require('jest-mock');
window['expect'] = require('expect');
Karmaの設定はJasmineを動かす時と同様にしてしまえばよいです（JestのテストランナーがデフォルトでJamineベースのものなため、Jasmineと同じ設定で実行できるようです）。
いくつか細かい話はありますが（※）、基本的にはこれだけです。
何が嬉しいの？
以下のようなDXが実現できます。
- 普段の開発の中ではJestのテストランナーを使い、Jestのメリットを存分に享受
- CIなど特別なタイミングでいつでも任意の実ブラウザ上でテストを実行できる
※いくつか細かい話
Jestのテストコードの中にスナップショットテストが含まれる場合、これは実ブラウザ上で実行できるようになっていないため、そのままではエラーになります。Karmaのエントリーポイントとなるファイルで次の処理を書くことで回避できます。
window['expect'].extend({
// Karmaからの実行時はスナップショットテストは無条件にパス
toMatchSnapshot: () => ({ pass: true })
});
また、JestのconfigでrestoreMocksやresetMocksなど（テストのたびにモックをリセットする設定）を指定している場合、Jestのテストランナー以外からテストを実行する際はこれが読み込まれないため、指定している内容に応じてグローバルなbeforeEachを実行して設定を反映する必要があります。これもKarmaのエントリーポイントとなるファイルで実行します。
// `restoreMocks: true`の場合
beforeEach(() => jest.restoreAllMocks());
最後に、これはあまり細かくない話かもしれませんが、実はこの方法ではJestのマニュアルモックという機能が使えなくなります。元々のissueに、「こんなんできました！」と意気揚々と書き込んだら、親切な方が教えてくれました。
私のチームではJasmineからJestに移行し、そもそもJasmineにはマニュアルモックのような機能がなかったため特に問題なかったのですが、すでにJestでマニュアルモックをバリバリ使っているチームがこの方法を取り入れるのは少し難しいかもしれません。
終わりに
この頃流行りのJestを精神の安寧を保ちながら導入できました。
株式会社カブクでは、テスト環境のさらなる改善に共に取り組んでくれるエンジニアを募集しています。
その他の記事
Other Articles
2022/06/03
拡張子に Web アプリを関連付ける File Handling API の使い方
2022/03/22<selectmenu> タグできる子; <select> に代わるカスタマイズ可能なドロップダウンリスト
2022/03/02
Java 15 のテキストブロックを横目に C# 11 の生文字列リテラルを眺めて ECMAScript String dedent プロポーザルを想う
2021/10/13
Angularによる開発をできるだけ型安全にするためのKabukuでの取り組み
2021/09/30
さようなら、Node.js
2021/09/30
Union 型を含むオブジェクト型を代入するときに遭遇しうるTypeScript型チェックの制限について
2021/09/16
[ECMAScript] Pipe operator 論争まとめ – F# か Hack か両方か
2021/07/05
TypeScript v4.3 の機能を使って immutable ライブラリの型付けを頑張る
2021/06/25
Denoでwasmを動かすだけの話
2021/05/18
DOMMatrix: 2D / 3D 変形（アフィン変換）の行列を扱う DOM API
2021/03/29
GoのWASMがライブラリではなくアプリケーションであること
2021/03/26
Pythonプロジェクトの共通のひな形を作る
2021/03/25
インラインスタイルと Tailwind CSS と Tailwind CSS 入力補助ライブラリと Tailwind CSS in JS
2021/03/23
Serverless NEGを使ってApp Engineにカスタムドメインをワイルドカードマッピング
2021/01/07
esbuild の機能が足りないならプラグインを自作すればいいじゃない
2020/08/26
TypeScriptで関数の部分型を理解しよう
2020/06/16
[Web フロントエンド] esbuild が爆速すぎて webpack / Rollup にはもう戻れない
2020/03/19
[Web フロントエンド] Elm に心折れ Mint に癒しを求める
2020/02/28
さようなら、TypeScript enum
2020/02/14
受付のLooking Glassに加えたひと工夫
2020/01/28
カブクエンジニア開発合宿に行ってきました 2020冬
2020/01/30
Renovateで依存ライブラリをリノベーションしよう 〜 Bitbucket編 〜
2019/12/27
Cloud Tasks でも deferred ライブラリが使いたい
2019/12/25
*, ::before, ::after { flex: none; }
2019/12/21
Top-level awaitとDual Package Hazard
2019/12/20
Three.jsからWebGLまで行きて帰りし物語
2019/12/18
Three.jsに入門＋手を検出してAR.jsと組み合わせてみた
2019/12/04
WebXR AR Paint その２
2019/11/06
GraphQLの入門書を翻訳しました
2019/09/20
Kabuku Connect 即時見積機能のバックエンド開発
2019/08/14
Maker Faire Tokyo 2019でARゲームを出展しました
2019/07/25
夏休みだョ！WebAssembly Proposal全員集合！！
2019/07/08
鵜呑みにしないで！ —— 書籍『クリーンアーキテクチャ』所感 ≪null 篇≫
2019/07/03
W3C Workshop on Web Games参加レポート
2019/06/28
TypeScriptでObject.assign()に正しい型をつける
2019/06/25
カブクエンジニア開発合宿に行ってきました 2019夏
2019/06/21
Hola! KubeCon Europe 2019の参加レポート
2019/06/19
Clean Resume きれいな環境できれいな履歴書を作成する
2019/05/20
[Web フロントエンド] 状態更新ロジックをフレームワークから独立させる
2019/04/16
C++のenable_shared_from_thisを使う
2019/04/12
OpenAPI 3 ファーストな Web アプリケーション開発（Python で API 編）
2019/04/08
WebGLでレイマーチングを使ったCSGを実現する
2019/03/29
その1 Jetson TX2でk3s(枯山水)を動かしてみた
2019/04/02
『エンジニア採用最前線』に感化されて2週間でエンジニア主導の求人票更新フローを構築した話
2019/02/08
TypeScript で “radian” と “degree” を間違えないようにする
2019/02/05
Python3でGoogle Cloud ML Engineをローカルで動作する方法
2019/01/18
SIGGRAPH Asia 2018 参加レポート
2019/01/08
お正月だョ！ECMAScript Proposal全員集合！！
2019/01/08
カブクエンジニア開発合宿に行ってきました 2018秋
2018/12/25
OpenAPI 3 ファーストな Web アプリケーション開発（環境編）
2018/12/23
いまMLKitカスタムモデル（TF Lite）は使えるのか
2018/12/21
[IoT] Docker on JetsonでMQTTを使ってCloud IoT Coreと通信する
2018/12/11
TypeScriptで実現する型安全な多言語対応（Angularを例に）
2018/12/05
GASでCompute Engineの時間に応じた自動停止/起動ツールを作成する 〜GASで簡単に好きなGoogle APIを叩く方法〜
2018/12/02
single quotes な Black を vendoring して packaging
2018/11/14
3次元データに2次元データの深層学習の技術(Inception V3, ResNet)を適用
2018/11/04
Node Knockout 2018 に参戦しました
2018/10/24
SIGGRAPH 2018参加レポート-後編（VR/AR）
2018/10/11
Angular 4アプリケーションをAngular 6に移行する
2018/10/05
SIGGRAPH 2018参加レポート-特別編（VR@50）
2018/10/03
Three.jsでVRしたい
2018/10/02
SIGGRAPH 2018参加レポート-前編
2018/09/27
ズーム可能なSVGを実装する方法の解説
2018/09/25
Kerasを用いた複数入力モデル精度向上のためのTips
2018/09/21
競技プログラミングの勉強会を開催している話
2018/09/19
Ladder Netwoksによる半教師あり学習
2018/08/10
「Maker Faire Tokyo 2018」に出展しました
2018/08/02
Kerasを用いた複数時系列データを1つの深層学習モデルで学習させる方法
2018/07/26
Apollo GraphQLでWebサービスを開発してわかったこと
2018/07/19
【深層学習】時系列データに対する１次元畳み込み層の出力を可視化
2018/07/11
きたない requirements.txt から Pipenv への移行
2018/06/26
CSS Houdiniを味見する
2018/06/25
不確実性を考慮した時系列データ予測
2018/06/20
Google Colaboratory を自分のマシンで走らせる
2018/06/18
Go言語でWebAssembly
2018/06/15
カブクエンジニア開発合宿に行ってきました 2018春
2018/06/08
2018 年の tree shaking
2018/06/07
隠れマルコフモデル 入門
2018/05/30
DASKによる探索的データ分析(EDA)
2018/05/10
TensorFlowをソースからビルドする方法とその効果
2018/04/23
EGLとOpenGLを使用するコードのビルド方法〜libGLからlibOpenGLへ
2018/04/23
技術書典4にサークル参加してきました
2018/04/13
Python で Cura をバッチ実行するためには
2018/04/04
ARCoreで3Dプリント風エフェクトを実現する〜呪文による積層造形映像制作の舞台裏〜
2018/04/02
深層学習を用いた時系列データにおける異常検知
2018/04/01
音声ユーザーインターフェースを用いた新方式積層造形装置の提案
2018/03/31
Container builderでコンテナイメージをBuildしてSlackで結果を受け取る開発スタイルが捗る
2018/03/23
ngUpgrade を使って AngularJS から Angular に移行
2018/03/14
Three.jsのパフォーマンスTips
2018/02/14
C++17の新機能を試す〜その1「3次元版hypot」
2018/01/17
時系列データにおける異常検知
2018/01/11
異常検知の基礎
2018/01/09
three.ar.jsを使ったスマホAR入門
2017/12/17
Python OpenAPIライブラリ bravado-core の発展的な使い方
2017/12/15
WebAssembly（wat）を手書きする
2017/12/14
AngularJS を Angular に移行: ng-annotate 相当の機能を TypeScrpt ファイルに適用
2017/12/08
Android Thingsで4足ロボットを作る ~ Android ThingsとPCA9685でサーボ制御)
2017/12/06
Raspberry PIとDialogflow & Google Cloud Platformを利用した、3Dプリンターボット(仮)の開発 (概要編)
2017/11/20
カブクエンジニア開発合宿に行ってきました 2017秋
2017/10/19
Android Thingsを使って3Dプリント戦車を作ろう ① ハードウェア準備編
2017/10/13
第2回 魁！！ GPUクラスタ on GKE ~PodからGPUを使う編~
2017/10/05
第1回 魁！！ GPUクラスタ on GKE ~GPUクラスタ構築編~
2017/09/13
「Maker Faire Tokyo 2017」に出展しました。
2017/09/11
PyConJP2017に参加しました
2017/09/08
bravado-coreによるOpenAPIを利用したPythonアプリケーション開発
2017/08/23
OpenAPIのご紹介
2017/08/18
EuroPython2017で2名登壇しました。
2017/07/26
3DプリンターでLチカ
2017/07/03
Three.js r86で何が変わったのか
2017/06/21
3次元データへの深層学習の適用
2017/06/01
カブクエンジニア開発合宿に行ってきました 2017春
2017/05/08
Three.js r85で何が変わったのか
2017/04/10
GCPのGPUインスタンスでレンダリングを高速化
2017/02/07
Three.js r84で何が変わったのか
2017/01/27
Google App EngineのFlexible EnvironmentにTmpfsを導入する
2016/12/21
Three.js r83で何が変わったのか
2016/12/02
Three.jsでのクリッピング平面の利用
2016/11/08
Three.js r82で何が変わったのか
2016/12/17
SIGGRAPH 2016 レポート
2016/11/02
カブクエンジニア開発合宿に行ってきました 2016秋
2016/10/28
PyConJP2016 行きました
2016/10/17
EuroPython2016で登壇しました
2016/10/13
Angular 2.0.0ファイナルへのアップグレード
2016/10/04
Three.js r81で何が変わったのか
2016/09/14
カブクのエンジニアインターンシッププログラムについての詩
2016/09/05
カブクのエンジニアインターンとして3ヶ月でやった事 〜高橋知成の場合〜
2016/08/30
Three.js r80で何が変わったのか
2016/07/15
Three.js r79で何が変わったのか
2016/06/02
Vulkanを試してみた
2016/05/20
MakerGoの作り方
2016/05/08
TensorFlow on DockerでGPUを使えるようにする方法
2016/04/27
Blenderの3DデータをMinecraftに送りこむ
2016/04/20
Tensorflowを使ったDeep LearningにおけるGPU性能調査
関連職種
Recruit