// ES2015 modules and destructuring assignmentimport React from 'react';import renderer from 'react-test-renderer';import {plugins, format as prettyFormat} from 'pretty-format';const {ReactElement, ReactTestComponent} = plugins;
For snapshot tests, Jest uses pretty-format with options that include some of its built-in plugins. For this purpose, plugins are also known as snapshot serializers.
To serialize application-specific data types, you can add modules to devDependencies of a project, and then:
In an individual test file, you can add a module as follows. It precedes any modules from Jest configuration.
import serializer from 'my-serializer-module';expect.addSnapshotSerializer(serializer);// tests which have `expect(value).toMatchSnapshot()` assertions
For all test files, you can specify modules in Jest configuration. They precede built-in plugins for React, HTML, and Immutable.js data types. For example, in a package.json file:
If options has a plugins array: for the first plugin whose test(val) method returns a truthy value, then prettyFormat(val, options) returns the result from either:
serialize(val, …) method of the improved interface (available in version 21 or later)
print(val, …) method of the original interface (if plugin does not have serialize method)
test
Write test so it can receive val argument of any type. To serialize objects which have certain properties, then a guarded expression like val != null && … or more concise val && … prevents the following errors:
TypeError: Cannot read property 'whatever' of null
TypeError: Cannot read property 'whatever' of undefined
For example, test method of built-in ReactElement plugin:
const elementSymbol = Symbol.for('react.element');const test = val => val && val.$$typeof === elementSymbol;
Pay attention to efficiency in test because pretty-format calls it often.
serialize
The improved interface is available in version 21 or later.
Write serialize to return a string, given the arguments:
val which “passed the test”
unchanging config object: derived from options
current indentation string: concatenate to indent from config
current depth number: compare to maxDepth from config
current refs array: find circular references in objects
printer callback function: serialize children
config
key
type
description
callToJSON
boolean
call toJSON method (if it exists) on objects
compareKeys
function|null
compare function used when sorting object keys, null can be used to skip over sorting
colors
Object
escape codes for colors to highlight syntax
escapeRegex
boolean
escape special characters in regular expressions
escapeString
boolean
escape special characters in strings
indent
string
spaces in each level of indentation
Each property of colors in config corresponds to a property of theme in options:
the key is the same (for example, tag)
the value in colors is a object with open and close properties whose values are escape codes from ansi-styles for the color value in theme (for example, 'cyan')
Some properties in config are derived from min in options:
spacingInner and spacingOuter are newline if min is false
spacingInner is space and spacingOuter is empty string if min is true
Example of serialize and test
This plugin is a pattern you can apply to serialize composite data types. Side note: pretty-format does not need a plugin to serialize arrays.
// We reused more code when we factored out a function for child items// that is independent of depth, name, and enclosing punctuation (see below).const SEPARATOR = ',';function serializeItems(items, config, indentation, depth, refs, printer) { if (items.length === 0) { return ''; } const indentationItems = indentation + config.indent; return ( config.spacingOuter + items .map( item => indentationItems + printer(item, config, indentationItems, depth, refs), // callback ) .join(SEPARATOR + config.spacingInner) +
that do not depend on options other than highlight or min
that do not depend on depth or refs in recursive traversal, and
if values either
do not require indentation, or
do not occur as children of JavaScript data structures (for example, array)
Write print to return a string, given the arguments:
val which “passed the test”
current printer(valChild) callback function: serialize children
current indenter(lines) callback function: indent lines at the next level
unchanging config object: derived from options
unchanging colors object: derived from options
The 3 properties of config are min in options and:
spacing and edgeSpacing are newline if min is false
spacing is space and edgeSpacing is empty string if min is true
Each property of colors corresponds to a property of theme in options:
the key is the same (for example, tag)
the value in colors is a object with open and close properties whose values are escape codes from ansi-styles for the color value in theme (for example, 'cyan')
Example of print and test
This plugin prints functions with the number of named arguments excluding rest argument.
This plugin ignores the printFunctionName option. That limitation of the original print interface is a reason to use the improved serialize interface, described above.