Snapshot testing where new value can be a superset of the saved snapshot
JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
__snapshots__
src
test
.gitignore
.npmrc
.travis.yml
README.md
package.json

README.md

subset-shot

Snapshot testing where new value can be a superset of the saved snapshot

NPM

Build status semantic-release js-standard-style

Related

This is a sister project to snap-shot and schema-shot

Why

Imagine you have an API returning list of Oscar-winning movies. At some point it returns N movie titles, including "Braveheart", "Titanic" and "The Artist" (see example page here). You write an end to end test and would like to use snapshot testing, but you cannot because at some point in February of the next year a new movie will be added and your snapshot will have to be updated.

This module solves this problem by allowing future values to be a superset of the saved snapshot. If API returns more movies - it is fine, as long as it returns all the ones already saved in the snapshot.

Install

Requires Node version 6 or above.

npm install --save-dev subset-shot

Use

This module works using same stack-walking, AST parsing magic as snap-shot and schema-shot. This means, just use it in any testing framework (like Ava, Jest, etc)

// movies-spec.js
const subsetShot = require('subset-shot')
it('Oscar movies', () => {
  const list = ['Braveheart', 'Titanic']
  subsetShot(list)
})

The snapshot file will have contents

// movies-spec.js.subset-shot
exports['Oscar movies'] = [
  'Braveheart', 
  'Titanic'
]

Later the API might return more movies, yet the same test still passes because the snapshot has subset of the new data.

// movies-spec.js
const subsetShot = require('subset-shot')
it('Oscar movies', () => {
  const list = ['Braveheart', 'Titanic', 'The Artist']
  subsetShot(list)
})

The test still passes. But a test that all of the sudden returns empty list or nothing, or a totally different set of movies (by confusing "Best Picture" with "Best Director" for example) fails.

Updating snapshots

You can show the snapshots but skip saving them (dry run) by running tests with environment variable DRY=1 npm test.

You can show and save snapshots by running tests with environment variable SHOW=1 npm test.

You can update saved snapshots by running tests with environment variable UPDATE=1 npm test.

Comparing objects

A snapshot could be an object subset, compared using obj-subset.

// saved snapshot is {foo: 42}
const subsetShot = require('subset-shot')
it('allows new properties', () => {
  subsetShot({foo: 42, bar: 10}) // ok
})
it('requires value', () => {
  subsetShot({foo: 20}) // exception, value should 42
})
it('requires matching key', () => {
  subsetShot({foo2: 42}) // exception, wrong key name
})

Small print

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

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) 2017 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.