Unit testing Svelte components in Cypress E2E test runner
Clone or download

README.md

cypress-svelte-unit-test

Unit testing Svelte components in Cypress E2E test runner

NPM

Build status semantic-release js-standard-style renovate-app badge

Install

Requires Node version 6 or above.

npm install --save cypress-svelte-unit-test
npm install --save-dev @cypress/webpack-preprocessor

Use

  • Import your component and mount function from this module
  • Mount your component
  • Start testing using Cypress commands
import Counter from '../components/Counter.html'
import mount from 'cypress-svelte-unit-test'
describe('count', () => {
  beforeEach(() => {
    mount(Counter)
  })
  it('shows 0', () => {
    cy.contains('Count: 0')
  })
})

The mount function returns a promise which resolves to the current document. At the same time, the instance of the mounted component is available from Cypress.component for further interaction.

Assuming that your component has a value item in its data:

mount(InputText, {value: ''}).then((doc) =>
  Cypress.component.observe('value', (val) =>
    // ... called for any change to value
  )
)

Assuming that your component has a default slot:

mount(Button, null, {
    default: document.createTextNode('Click me')
}).then((doc) =>
    // Mounted component has default slot
    // Cypress.component.options.slots.default
)

Examples

Details

Related tools

Same feature for unit testing components from other framesworks using Cypress

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2018

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2018 Gleb Bahmutov <gleb.bahmutov@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.