Тестирование

Основные части Vuex, которые мы хотим протестировать по отдельности, это мутации и действия.

Тестирование мутаций

Мутации очень легко тестировать, потому что они представляют собой просто функции, полностью зависящие от своих аргументов. Один из трюков заключается в том, что если вы используете модули ES2015 и помещаете свои мутации в свой store.js файл, помимо стандартного экспорта, вы также должны экспортировать мутации как именованный экспорт:

const state = { ... }

// export `mutations` as a named export
export const mutations = { ... }

export default new Vuex.Store({
  state,
  mutations
})

Пример тестирования мутации с использованием Mocha + Chai (можно использовать любые фреймворки/библиотеки утверждений):

// mutations.js
export const mutations = {
  increment: state => state.count++
}

// mutations.spec.js
import { expect } from 'chai'
import { mutations } from './store'

// destructure assign `mutations`
const { increment } = mutations

describe('mutations', () => {
  it('INCREMENT', () => {
    // mock state
    const state = { count: 0 }
    // apply mutation
    increment(state)
    // assert result
    expect(state.count).to.equal(1)
  })
})

Тестирование действий

Действия могут быть немного сложнее, поскольку они могут обращаться к внешним API. При тестировании действий, как правило, необходимо выполнить некоторое моделирование — например, мы можем абстрагировать вызовы API в сервис и смоделировать этот сервис в наших тестах. Для удобного моделирования зависимостей мы можем использовать webpack и inject-loader (opens new window) для сборки наших тестовых файлов.

Пример тестирования асинхронного действия:

// actions.js
import shop from '../api/shop'

export const getAllProducts = ({ commit }) => {
  commit('REQUEST_PRODUCTS')
  shop.getProducts(products => {
    commit('RECEIVE_PRODUCTS', products)
  })
}

// actions.spec.js

// use require syntax for inline loaders.
// with inject-loader, this returns a module factory
// that allows us to inject mocked dependencies.
import { expect } from 'chai'
const actionsInjector = require('inject-loader!./actions')

// create the module with our mocks
const actions = actionsInjector({
  '../api/shop': {
    getProducts (cb) {
      setTimeout(() => {
        cb([ /* mocked response */ ])
      }, 100)
    }
  }
})

// helper for testing action with expected mutations
const testAction = (action, payload, state, expectedMutations, done) => {
  let count = 0

  // mock commit
  const commit = (type, payload) => {
    const mutation = expectedMutations[count]

    try {
      expect(type).to.equal(mutation.type)
      expect(payload).to.deep.equal(mutation.payload)
    } catch (error) {
      done(error)
    }

    count++
    if (count >= expectedMutations.length) {
      done()
    }
  }

  // call the action with mocked store and arguments
  action({ commit, state }, payload)

  // check if no mutations should have been dispatched
  if (expectedMutations.length === 0) {
    expect(count).to.equal(0)
    done()
  }
}

describe('actions', () => {
  it('getAllProducts', done => {
    testAction(actions.getAllProducts, null, {}, [
      { type: 'REQUEST_PRODUCTS' },
      { type: 'RECEIVE_PRODUCTS', payload: { /* mocked response */ } }
    ], done)
  })
})

Если в вашей тестовой среде доступны шпионы (например, через Sinon.JS (opens new window)), вы можете использовать их вместо помощника testAction:

describe('actions', () => {
  it('getAllProducts', () => {
    const commit = sinon.spy()
    const state = {}
    
    actions.getAllProducts({ commit, state })
    
    expect(commit.args).to.deep.equal([
      ['REQUEST_PRODUCTS'],
      ['RECEIVE_PRODUCTS', { /* mocked response */ }]
    ])
  })
})

Тестирование геттеров

Если ваши геттеры имеют сложное вычисление, стоит их протестировать. Геттеры также очень просто тестировать по той же причине, что и мутации.

Пример тестирования геттера:

// getters.js
export const getters = {
  filteredProducts (state, { filterCategory }) {
    return state.products.filter(product => {
      return product.category === filterCategory
    })
  }
}

// getters.spec.js
import { expect } from 'chai'
import { getters } from './getters'

describe('getters', () => {
  it('filteredProducts', () => {
    // mock state
    const state = {
      products: [
        { id: 1, title: 'Apple', category: 'fruit' },
        { id: 2, title: 'Orange', category: 'fruit' },
        { id: 3, title: 'Carrot', category: 'vegetable' }
      ]
    }
    // mock getter
    const filterCategory = 'fruit'

    // get the result from the getter
    const result = getters.filteredProducts(state, { filterCategory })

    // assert the result
    expect(result).to.deep.equal([
      { id: 1, title: 'Apple', category: 'fruit' },
      { id: 2, title: 'Orange', category: 'fruit' }
    ])
  })
})

Запуск тестов

Если ваши мутации и действия написаны правильно, тесты не должны иметь прямой зависимости от API браузера после надлежащего моделирования. Таким образом, вы можете просто собрать тесты с помощью webpack и запустить их напрямую в Node.js. В качестве альтернативы, вы можете использовать mocha-loader или Karma + karma-webpack для запуска тестов в реальных браузерах.

Запуск в Node.js

Создайте следующий конфигурационный файл webpack (вместе с соответствующими .babelrc (opens new window)):

// webpack.config.js
module.exports = {
  entry: './test.js',
  output: {
    path: __dirname,
    filename: 'test-bundle.js'
  },
  module: {
    loaders: [
      {
        test: /\.js$/,
        loader: 'babel-loader',
        exclude: /node_modules/
      }
    ]
  }
}

Затем:

webpack
mocha test-bundle.js

Запуск в браузере

Установите mocha-loader.
Измените entry в конфигурации webpack на 'mocha-loader!babel-loader!./test.js'.
Запустите webpack-dev-server с помощью конфигурации.
Перейдите к localhost:8080/webpack-dev-server/test-bundle.

Запуск в браузере с помощью Karma + karma-webpack

Обратитесь к настройке в документации vue-loader (opens new window).

← Обработка форм Горячая перезагрузка →