Unit test Angularjs code using Cypress.io test runner
npm install cypress-angularjs-unit-test> Unit test Angularjs code using Cypress.io test runner
[![NPM][npm-icon]][npm-url]
[![Build status][ci-image]][ci-url]
[![semantic-release][semantic-image]][semantic-url]
[![standard][standard-image]][standard-url]
[![renovate-app badge][renovate-badge]][renovate-app]
You can use Cypress.io to end-to-end test any application, but what if you want to test your Angular.js values, services, controllers and components individually? This adaptor allows you to do this very quickly. See each test run as a mini app inside a real browser, go back in time using DOM snapshot, etc - all the good things available in E2E tests are working in unit tests.
Requires Node version 6 or above.
``sh`
npm install --save cypress-angularjs-unit-test cypress
Requires angular peer dependency
`js`
import {mount} from 'cypress-angularjs-unit-test'
// or const mount = require('cypress-angularjs-unit-test').mount
import angular from 'angular'
// prepare app
it('works', () => {
const template = '... HTML template ... '
const modules = ['module1', 'module2', '...']
mount(template, modules)
})
See cypress/integration/basic-spec.js
`js
import {mount} from 'cypress-angularjs-unit-test'
import angular from 'angular'
angular.module('demo', [])
.controller('WelcomeController', function($scope) {
$scope.greeting = 'Welcome!';
$scope.version = angular.version.full
});
beforeEach(() => {
// let's mount our "demo" module and its controller
// in a "mini app" before each test
const template =
mount(template, ['demo'])
})it('shows hello', () => {
// "WelcomeController" should have replaced template
// expression {{greeting}} with actual text
cy.contains('div', 'Welcome!').should('be.visible')
})
Examples
* Testing a value in value-spec.js
* filter and filter-spec.js
* component and component-spec.js
* Loading test HTML template from a fixture in fixture-spec.js
Notes
*
opens Cypress end-to-end test runner in GUI mode
* npm test runs Cypress in headless mode
* mount uses angular.bootstrap` to mount code inside the test iframe.Cypress can do everything you can do from DevTools console when dealing with Angular.js application.
Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2018
* @bahmutov
* glebbahmutov.com
* blog
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
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.
[npm-icon]: https://nodei.co/npm/cypress-angularjs-unit-test.svg?downloads=true
[npm-url]: https://npmjs.org/package/cypress-angularjs-unit-test
[ci-image]: https://travis-ci.org/bahmutov/cypress-angularjs-unit-test.svg?branch=master
[ci-url]: https://travis-ci.org/bahmutov/cypress-angularjs-unit-test
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/