🐷
【Vue3】defineExpose()内で定義している無名関数のテスト実施方法【vitest/Vue Test Util】
前置き
業務で詰まった個所を備忘で残します。
サンプルコードは生成AIでサクッと生成しているため、一部動かない部分があるかもしれないです。
- Vue3
- Vitest
- Vue Test Util
結論
wrapper.vm.$.exposed.hoge()を使うことで、defineExpose()で公開されたメソッドやプロパティに直接アクセスできます。
テスト対象コンポーネント
<script setup lang="ts">
defineExpose({
hoge: () => console.log('fuga')
})
</script>
テストコード
it('defineExposeの確認', () => {
const wrapper = shallowMount(MyComponent)
const spy = vi.spyOn(console, 'log')
wrapper.vm.$.exposed.hoge()
expect(spy).toHaveBeenCalledWith('fuga')
})
デメリット
- Vueの内部実装を利用しているため、テストがVueのバージョンに依存します
所感
- テスト内で疑似的に親コンポーネントを作成して呼び出す手法もあるみたいですが、それよりは幾分か簡略化できていそう
- 無名関数で渡さずにコンポーネント内で関数定義しておけば
wrapper.vm.hoge()で簡単にアクセス可能 - そもそも「defineExpose()で親コンポーネントにメソッドを渡せていること」をテストする必要がないのではないか
- 内部実装までテストしたい場合、
composables/に渡してしまったほうがComposition APIの設計思想にあっていそう
Discussion