web-dev-qa-db-fra.com

Comment écrire un test qui se moque de l'objet $ route dans les composants vue

J'ai un composant qui contient une instruction comme this.$route.fullPath, comment dois-je simuler la valeur de fullPathof $route object si je veux tester ce composant?

unit-testingsinonvue-componentvuejs2vue-loader
18
Jerry Zhang

Ne modifiez pas vue-router, mais utilisez-le plutôt pour restituer le composant. Ainsi, vous obtiendrez un bon routeur. Exemple:

import Vue from 'vue'
import VueRouter from 'vue-router'
import totest from 'src/components/totest'

describe('totest.vue', () => {
  it('should totest renders stuff', done => {
    Vue.use(VueRouter)
    const router = new VueRouter({routes: [
        {path: '/totest/:id', name: 'totest', component: totest},
        {path: '/wherever', name: 'another_component', component: {render: h => '-'}},
    ]})
    const vm = new Vue({
      el: document.createElement('div'),
      router: router,
      render: h => h('router-view')
    })
    router.Push({name: 'totest', params: {id: 123}})
    Vue.nextTick(() => {
      console.log('html:', vm.$el)
      expect(vm.$el.querySelector('h2').textContent).to.equal('Fred Bloggs')
      done()
    })
  })
})

Choses à noter:

  1. J'utilise la version de vue, uniquement à l'exécution, d'où render: h => h('router-view').
  2. Je teste uniquement le composant totest, mais d'autres peuvent être requis s'ils sont référencés par totest, par exemple. another_component dans cet exemple.
  3. Vous devez avoir nextTick pour que le code HTML ait été rendu avant de pouvoir le consulter/le tester.

Un des problèmes est que la plupart des exemples que j'ai trouvés se référaient à l'ancienne version de vue-router, voir les documents de migration , par exemple. Quelques exemples utilisent router.go() qui ne fonctionne pas maintenant.

29
SColvin

Je ne suis pas d’accord avec la réponse principale: vous pouvez vous moquer de $route sans problème.

D'autre part, l'installation de vue-router plusieurs fois sur le constructeur de base will vous causera des problèmes. Il ajoute $route et $router en tant que propriétés en lecture seule. Ce qui rend impossible de les écraser lors de futurs tests.

Pour ce faire, il existe deux manières de procéder avec vue-test-utils .

Mocking vue-router avec l'option mocks

const $route = {
    fullPath: 'full/path'
}
const wrapper = mount(ComponentWithRouter, { 
  mocks: {
    $route
  } 
})

wrapper.vm.$route.fullPath // 'full/path'

Vous pouvez également installer Vue Router en toute sécurité en utilisant createLocalVue:

Installation de vue-router en toute sécurité lors des tests avec createLocalVue

const localVue = createLocalVue()
localVue.use(VueRouter)
const routes = [
 {
   path: '/',
   component: Component
 }
]
const router = new VueRouter({
 routes
})
const wrapper = mount(ComponentWithRouter, { localVue, router })
expect(wrapper.vm.$route).to.be.an('object')
17
Edd

Aucune réponse ne m'aidait, alors j'ai creusé dans la documentation vue-test-utils et je me suis trouvé une réponse efficace, vous devez donc importer.

import { shallowMount,createLocalVue } from '@vue/test-utils';
import router from '@/router.ts';
const localVue = createLocalVue();

Nous avons créé un exemple d'instance vue. Pendant le test, vous devez utiliser shallowMount pour pouvoir fournir une instance et un routeur vue.

describe('Components', () => {
  it('renders a comment form', () => {
    const COMMENTFORM = shallowMount(CommentForm,{
      localVue,
      router
    });
  })
})

Vous pouvez facilement passer le routeur et monter peu profond et il ne vous donne pas l'erreur. Si vous voulez passer en magasin, vous utilisez:

import { shallowMount,createLocalVue } from '@vue/test-utils';
import router from '@/router.ts';
import store from '@/store.ts';
const localVue = createLocalVue();

Et puis passer magasin:

describe('Components', () => {
  it('renders a comment form', () => {
    const COMMENTFORM = shallowMount(CommentForm,{
      localVue,
      router,
      store
    });
  })
})

Cette solution a résolu les erreurs suivantes:

  • Impossible de lire la propriété 'params' de non définie en utilisant this.$route.params.id
  • Elément personnalisé inconnu router-link

✔

3
Ilyas karim

Toutes nos félicitations à @SColvin pour sa réponse; aidé à trouver une réponse dans mon scénario où j’avais un composant avec un lien de routeur qui lançait un 

ERROR: '[Vue warn]: Error in render function: (found in <RouterLink>)'

pendant le test unitaire car Vue n’avait pas été fourni avec un routeur. Utiliser @SColvin answer pour réécrire le test fourni à l’origine par vue-cli de 

describe('Hello.vue', () =>
{
  it('should render correct contents', () =>
  {
    const Constructor = Vue.extend(Hello);
    const vm = new Constructor().$mount();
    expect(vm.$el.querySelector('.hello h1').textContent)
      .to.equal('Welcome to Your Vue.js App');
  });

à

describe('Hello.vue', () =>
{
  it('should render correct contents', () =>
  {
    Vue.use(VueRouter);
    const router = new VueRouter({
      routes: [
        { path: '/', name: 'Hello', component: Hello },
      ],
    });
    const vm = new Vue({
      el: document.createElement('div'),
      /* eslint-disable object-shorthand */
      router: router,
      render: h => h('router-view'),
    });
    expect(vm.$el.querySelector('.hello h1').textContent)
      .to.equal('Welcome to Your Vue.js App');
  });
});

N'ayant pas besoin de passer de paramètres à la vue, je pouvais simplifier le composant en tant que rendu par défaut, pas besoin de Push ni d'attendre nextTick. HTH quelqu'un d'autre!

1
9swampy

C’est ce que je faisais selon cet article :

it('renders $router.name', () => {
    const scopedVue = Vue.extend();

    const mockRoute = {
        name: 'abc'
    };

    scopedVue.prototype.$route = mockRoute;

    const Constructor = scopedVue.extend(Component);
    const vm = new Constructor().$mount();
    expect(vm.$el.textContent).to.equal('abc');
});
0
d512

Regardez cet exemple avec vue-test-utils, où je me moque du routeur et du magasin.

import ArticleDetails from '@/components/ArticleDetails'
import { mount } from 'vue-test-utils'
import router from '@/router'

describe('ArticleDetails.vue', () => {
  it('should display post details', () => {
    const POST_MESSAGE = 'Header of our content!'

    const EXAMPLE_POST = {
      title: 'Title',
      date: '6 May 2016',
      content: `# ${POST_MESSAGE}`
    }

    const wrapper = mount(ArticleDetails, {
      router,

      mocks: {
        $store: {
          getters: {
            getPostById () {
              return EXAMPLE_POST
            }
          }
        }
      }
    })

    expect(wrapper.vm.$el.querySelector('h1.post-title').textContent.trim()).to.equal(EXAMPLE_POST.title)
    expect(wrapper.vm.$el.querySelector('time').textContent.trim()).to.equal(EXAMPLE_POST.date)
    expect(wrapper.vm.$el.querySelector('.post-content').innerHTML.trim()).to.equal(
      `<h1>${POST_MESSAGE}</h1>`
    )
  })
})
0
Daniel Kmak

Pour ajouter à l'excellente réponse de @SColvin, voici un exemple de ce travail avec Avoriaz :

import { mount } from 'avoriaz'
import Vue from 'vue'
import VueRouter from 'vue-router'
import router from '@/router'
import HappyComponent from '@/components/HappyComponent'

Vue.use(VueRouter)

describe('HappyComponent.vue', () => {
  it('renders router links', () => {
    wrapper = mount(HappyComponent, {router})
    // Write your test
  })
})

Je crois que cela devrait fonctionner avec vue-test-utils aussi.

0
Franey

Vous pouvez vous moquer de vm. $ Router en définissant vm._routerRoot._router 

Par exemple

var Constructor      = Vue.extend(Your_Component)
var vm               = new Constructor().$mount()
var your_mock_router = {hello:'there'}

vm.$router             = your_mock_router //An error 'setting a property that has only a getter'
vm._routerRoot._router = your_mock_router //Wow, it works!

Vous pouvez vérifier leur code source ici: https://github.com/vuejs/vue-router/blob/dev/dist/vue-router.js#L558

0
nhanbach

Le moyen le plus simple que j'ai trouvé est de se moquer de la route $.

it('renders $router.name', () => {
  const $route = {
    name: 'test name - avoriaz'
  }


 const wrapper = shallow(Component, {
    mocks: {
      $route
    }
  })
  expect(wrapper.text()).to.equal($route.name)
})
0
Evan Burbidge

La méthode la plus simple que j'ai trouvée consiste à utiliser localVue 

import { createLocalVue, mount } from '@vue/test-utils'
import ComponentName from 'componentPath'
import Vuex from 'vuex'
import store from '@/store/store' //Add store file if any getters is accessed
import VueRouter from 'vue-router'

describe('File name', () => { 
const localVue = createLocalVue()
localVue.use(VueRouter)
const routes = [  //Can also be rreplaced with route(router.js) file
    {
        path: '/path',
        component: ComponentName,
        name: 'Route name'
    }
]
const router = new VueRouter({
    routes
})
router.Push({ 
              name: 'Route name',
              params: {} 
            }) //if needed
const wrapper = mount(ComponentName, {localVue, router, store })
beforeEach(function() {      
});

    it('Method()', () => {
        wrapper.vm.methodName()
        expect(wrapper.vm.$route.path).toBe(routes[0].path)
    });
});

J'espère que ça aide!!!

0
Bharathkumar kamal