Wrapper for spok assertion
npm install cy-spok> Playing with spok inside Cypress test
CI | status
--- | ---
lint | !Lint status
badges | !Badges status
cy-spok | !GH Action status
cy-spok-example | !cy-spok-example status
- 📺 Watch Introduction To cy-spok Plugin For Writing Powerful Assertions For Objects
- 📺 Watch Confirm Text In Multiple Page Elements Using cy-spok
- 📺 Watch Verify Cypress Component Prop Calls Using Stubs, cypress-map, and cy-spok
- 📺 Watch Refactor Cypress API Tests Part 1: Use cy-spok Plugin
- 📝 Read Asserting Network Calls from Cypress Tests
- 📝 Read Change E2E Tests From UI To API To App Actions
- 📝 Read Two Simple Tricks To Make Your Cypress Tests Better
- 📝 Read Crawl Weather Using Cypress
- 📝 Read Testing React Number Format Component Example
- 📝 Read Cypress Flakiness Examples
- 📝 Read Use Cypress For API Testing
- 📝 Read Check Fees And Totals Using Cypress
- 📝 Read Retry Network Requests
- 📝 Read Check Data Using Page Objects And Higher Order Functions
- 🎓 Covered in my course Cypress Plugins
- Lesson e1: Validate network requests using cy-spok
- Lesson e2: Use your own predicates to validate object properties
- Lesson e3: Validate URL search parameters
- Lesson e4: Check and control the Redux store using cy-spok plugin
- 🎓 Covered in my course Cypress Network Testing Exercises
- Bonus 28: Use cy-spok plugin to write complex assertions
- Bonus 101: Confirm the server supports caching using the ETag header
- 🎓 Covered in my course Cypress vs Playwright
- Lesson d8: Assert complex objects
``
$ npm i -D cy-spok
See spok docs
`js
// in your Cypress spec file
import spok from 'cy-spok'
const object = {
one: 1,
two: 2,
three: 3,
four: 4,
helloWorld: 'hello world',
anyNum: 999,
anotherNum: 888,
anArray: [1, 2],
anotherArray: [1, 2, 3],
anObject: {},
id: 'abc123',
list: ['one', 'two', 'three'],
}
// using Spok
// https://github.com/thlorenz/spok#readme
cy.wrap(object, { timeout: 2000 }).should(
spok({
$topic: 'spok-example', // optional
one: spok.ge(1),
two: 2,
three: spok.range(2, 6),
four: spok.lt(5),
helloWorld: spok.startsWith('hello'),
anyNum: spok.type('number'),
anotherNum: spok.number,
anArray: spok.array,
anObject: spok.ne(undefined),
// test a string using regular expression
id: spok.test(/^abc\d{3}$/),
// array with 3 elements
list: spok.arrayElements(3),
}),
)
`
See cypress/integration/spec.js here and in the cy-spok-example repo.
Spok prints a lot more information when using it compared to deep.equal. Note that Spok is a subset, not strict value equality.
!deep.equal vs spok for complex objects
`js`
// verify each item in an array as an object
cy.wrap(['one', 42, 'three']).should(
spok({
0: spok.string,
1: spok.number,
2: spok.string,
}),
)
Lodash has many predicate functions is..., see Lodash docs
`js`
cy.wrap({
name: 'Joe',
age: 20,
}).should(
spok({
name: Cypress._.isString,
age: Cypress._.isNumber,
}),
)
Any synchronous function that returns a boolean could be a predicate
`js
// it is a list of strings
const areGreetings = (list) =>
Array.isArray(list) && list.every(Cypress._.isString)
cy.wrap({
greetings: ['hello', 'hi'],
}).should(
spok({
greetings: areGreetings,
}),
)
`
If there are multiple failing predicates, only the first one is shown. All passing predicates are shown
`js``
cy.wrap({
name: 'Joe',
age: 42,
job: 'chimney sweeper',
location: 'Boston',
present: true,
}).should(
spok({
name: 'Mary', // fails
age: 42, // passes
job: 'secret agent', // fails
location: 'Boston', // passes
present: spok.type('boolean'), // passes
}),
)
!Only the first failed predicate is shown
Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2021
- @bahmutov
- glebbahmutov.com
- blog
- videos
- presentations
- cypress.tips
- Cypress Advent 2021
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) 2021 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.
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/