Cypress Component Test Runner を Vue Vite で使ってみる

Last updated at 2021-12-24Posted at 2021-12-23

これは「弁護士ドットコムアドベントカレンダー」の24日目の記事です。
昨日の記事は @shirauix さんでした。（オンラインユーザーリサーチのすすめ）

Cypress Component Test Runner とは？

テスト時必要なコンポーネントのみを直接マウントすることで不要な部分の読み込みやルーティング等発生させずに高速なテストを行うことができるのがこちらのコンポーネントテスト。
まだα版のようですが、百聞は一見にしかずということで実際に動かしてみます。

Vue（Vite）に導入してみる（チュートリアル）

チュートリアルの内容を基に進めてみます。
こちらのチュートリアルだと Vue CLI で進めていますが、 Vite もサポートしているとのことなので今回は Vite で立ち上げます。

Vue のドキュメント通りにここは進めます。今回は yarn で進めていきます。

.bash

$ yarn create vite <project-name> --template vue
$ cd <project-name>
$ yarn
$ yarn dev

こんな感じの画面が出ればOK。

必要なライブラリをインストールします。

.bash

$ yarn add cypress @cypress/vue@next @cypress/webpack-dev-server @cypress/vite-dev-server --dev

チュートリアルには書いていないが Vite の場合は、@cypress/vite-dev-server がないと怒られるので注意。

必要なファイルを用意します。（ドキュメント）

cypress/plugins/index.js

const path = require('path')
const { startDevServer } = require('@cypress/vite-dev-server')

module.exports = (on, config) => {
  on('dev-server:start', (options) => {
    return startDevServer({
      options,
      viteConfig: {
        configFile: path.resolve(__dirname, '..', '..', 'vite.config.js'),
      },
    })
  })
}

テストは .spec.ts　に書いていきます。

cypress.json

{
  "testFiles": "**/*.spec.ts",
  "componentFolder": "src"
}

ここまで準備できたら src/components/HelloWorld.vue をテストするコードを用意してみます。
props されたデータが正しく反映されるかテストします。

src/components/HelloWorld.spec.ts

import { mount } from '@cypress/vue'
import HelloWorld from './HelloWorld.vue'

describe('HelloWorld', () => {
  it('renders a message', () => {
    const msg = 'Hello Cypress Component Testing!'
    mount(HelloWorld, {
      propsData: {
        msg
      }
    })

    cy.get('h1').should('have.text', msg)
  })
})

テストを実行してみます。

$　yarn cypress open-ct

テストの結果とテストコード内で指定したコンポーネントが表示されているはずです。
今回テストが成功しているため緑のチェックマークがついています。
次にわざと失敗してみます。テストの内容を変更します。

src/components/HelloWorld.spec.ts

import { mount } from '@cypress/vue'
import HelloWorld from './HelloWorld.vue'

describe('HelloWorld', () => {
  it('renders a message', () => {
    const msg = 'Hello Cypress Component Testing!'
    mount(HelloWorld, {
      propsData: {
        msg
      }
    })

    cy.get('h1').should('have.text', 'hogehoge')
  })
})

hogeとは表示されないので失敗するはずです。
変更を保存をするとリアルタイムでこの結果を反映してくれます。先ほどのテストの結果が表示されていた画面に戻ると...

ちゃんと失敗してくれてます。すばらC。
勿論、コンポーネント側の実装を変更してもその内容がリアルタイムに反映されます。

簡単なテストを書いてみる

チュートリアルだけだと面白くないので追加で簡単な実装とそのテストコードを書いてみます。
新たにボタンを用意して、そのボタンをクリックでカウントが2倍になるかテストしてみます。

テスト駆動開発的に、まずはテストを書きます。
add_button（既存のボタン）を2回クリックしてtwice_button（新規で実装するボタン）をクリックしたら4になるよねっていうテスト。

src/components/HelloWorld.spec.ts

import { mount } from '@cypress/vue'
import HelloWorld from './HelloWorld.vue'


describe('HelloWorld', () => {

// 省略

  it('2倍ボタンクリックでカウントが2倍になる', () => {
    mount(HelloWorld)
    cy.get('#add_button').click()
    cy.get('#add_button').click()
    cy.get('#twice_button').click()
    cy.get('#add_button').should('have.text', 'count is: 4')
  })
})

この状態で一度テストを実行。

$　yarn cypress open-ct

勿論テストは通らないです。

実装していきましょう。

　src/components/HelloWorld.vue

<template>

// 省略

　　　　// 既存のボタンに id="add_button" を追加
  <button id="add_button" type="button" @click="count++">count is: {{ count }}</button>
  // 2倍ボタンを追加
  <button id="twice_button" type="button" @click="count = count*2">2倍</button>

// 省略

</template>