JESTでよく使うVueのMockの方法まとめ[Nuxt]

概要

テストを楽に行うためにMockの仕方を調べることが多かった
以下は個人的によく利用したMockの方法をまとめたものとなる

目次

1. methodsはWrapperの上書きをする
2. $routerはconfig.mock
3. VuexのSotreはshallowMountに設定
4. 外部ツールはjest.spyOn

環境

"nuxt": "^2.0.0",
"vue": "^2.6.11",
"vuetify": "^2.2.27",
"jest": "^26.6.3",
"playwright": "^1.10.0",

Mock方法

methodsはWrapperの上書きをする

• mountまたはshallowMountでWrapperを生成し、Wrapperのmethodを上書きする
• 全てのテストでmock状態にしたい場合はbeforeEachを使う
• mock関数色々 https://jestjs.io/ja/docs/mock-function-api

テストしたいページ： ~/pages/index.vue

<script>
export default {
  methods: {
    getString() {
        return 'test1';
    },
  },
};
</script>

テストコード

import page from '~/pages/index.vue';
beforeEach(() => {
  const store = new Vuex.Store({getters});
  wrapper = shallowMount(page, {store});
  // Methodの上書き
  wrapper.vm.getString = jest.fn().mockReturnValue('test2');
});
afterEach(() => {
  wrapper = null; // test毎リセットしておくと安全
});
describe('Methods', () => {
  test('login： validationエラーの場合', async () => {
    const result = wrapper.vm.getString();
    await flushPromises();
    expect(result).toBe('test2');
  });
});

$routerはconfig.mock

• this.$router などthis.$で取得できる情報はconfig.mocksで定義できる
• 参考：Vue Test Utils Config について

import {config} from '@vue/test-utils';
beforeEach(() => {
  config.mocks['$router'] = {
    push: jest.fn(),
    go: jest.fn(),
    currentRoute: {
      path: 'dummy_path',
    },
  };
});

VuexのStoreはshallowMountに設定

• 参考：VueTestUtils Vuex と一緒に使用する
• より効率的にMockする方法
  • mock用のファイルを用意して各testファイルでまとめて実装

getters.js (とか actions.js)

const getters = {
  'test/getter': jest.fn().mockReturnValue(''),
};
export default getters;

store.test.js

import Vuex from 'vuex';
import getters from 'getters.js';
import actions from 'actions.js';
let wrapper;

beforeEach(() => {
  const store = new Vuex.Store({getters, actions});
  wrapper = shallowMount(page, {store});
});

外部ツールはjest.spyOnを使う

• 例：Auth
• 参考：jest.spyOn(object, methodName)

import Auth from '@aws-amplify/auth';
beforeEach(() => {
  // currentAuthenticatedUser はMockしたい関数名
  jest.spyOn(Auth, 'currentAuthenticatedUser').mockResolvedValue({data: ''});
});