nuxtの環境でvuexのテストをするときに$axiosをスタブ化したい

Question

nuxtで作成しているアプリケーションでstoreのテストを書いています。テストライブラリはjestを使用しています。
actionのコード例は以下のとおりです

export const actions = {
  async login({ commit }, { id }) {
    const user = await this.$axios.$get(`/users/${id}`)
    if (!user) { throw new Error('invalid user') }
    commit('setUser', { user })
  }
}

ここでactionに対するテストを書くと以下のようになると思います。

let store
beforeEach(() => {
  store = new Vuex.Store(cloneDeep(index))
})
test('login', () => {
  store.dispatch('login', { id: 'foo_bar' })
  expect(store.getters['user'].id).toEqual('foo_bar')
})

このときにthis.$axiosは当然存在しないのでstubを作りたいのですがどのように作ればよいかわかりません。

いくつか調べた中でaxios + MockAdapterを使用する方法は試したのですが、上手く動作しませんでした。

// beforeEachに追加
store.$axios = axios.create()

// test内に追加
const mock = new MockAdapter(store.$axios)
mock.onGet('/users/foo_bar').reply(200, { id: 'foo_bar' })

Comments

[退会済みユーザー]

何のテストツールを使用しているか追記したほうが良いと思います。

[mosmos_21]

ご指摘ありがとうございます。追加しました。

[退会済みユーザー]

this.$axiosというのはそもそもどのように注入されているのでしょうか。

[mosmos_21]

触り始めで正確に理解していないのですが、nuxtのmoduleなのでnuxt側がstoreを作る際に自動的に注入されるものという認識です。

Answer 1

私はVue/Nuxtの専門家ではありませんが、私見を述べます。

まず this.$axios がいつどのように注入されたのかを理解していないと代わりのオブジェクトを差し込むことができないと思います。
そのため既存のコードを変えたくないのであればこの仕組みに精通しダミーの注入方法を発見する必要があると思います。
それができないのであれば this.$axios は剥がすことができない密結合なオブジェクトということとなりスタブ/モック化しての単体テストは難しいでしょう。
私なら this.$axios の利用自体を慎重に検討します。

少しググって発見した下記の記事ではaxiosをラップする自作の関数を作り、それをテスト時に差し替えているようです。
こちらの方が this.$nuxt よりテスト時の交換が容易そうです。

https://techblog.istyle.co.jp/archives/1397

actionの単体テストを諦めるという方針もあり得るでしょう。
そもそもmutationとactionが別れているのは非同期処理というテストが難しい部分をactionに追い出すという目的があると思います。
mutationを単体テストし、actionについてはサーバを含めたE2Eテストで担保するという方針も十分考えられます。

まとめると採れる選択肢は以下でしょう。

① this.$axios がいつ注入されているのかを調査する
② this.$axios を使うのを辞め、自分で疎結合な仕組みを導入する
③ mutationのテストのみで妥協し、actionsはE2Eテストで担保する