Skip to content

Unescape serialized snapshots for diffing #2852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cpojer merged 3 commits into from
Feb 10, 2017
Merged

Unescape serialized snapshots for diffing #2852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca4f34e
Unescape serialized snapshots for diffing
thymikee Feb 9, 2017
e69d5ae
Normalize \r same way as \r\n by @rubenmoya
thymikee Feb 9, 2017
49fd771
Don't unescape regex for now
thymikee Feb 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/jest-snapshot/src/State.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const {
keyToTestName,
serialize,
testNameToKey,
unescape,
} = require('./utils');
const fileExists = require('jest-file-exists');
const fs = require('fs');
Expand Down Expand Up @@ -158,9 +159,9 @@ class SnapshotState {
if (!pass) {
this.unmatched++;
return {
actual: receivedSerialized,
actual: unescape(receivedSerialized),
count,
expected,
expected: unescape(expected),
pass: false,
};
} else {
Expand Down
13 changes: 12 additions & 1 deletion packages/jest-snapshot/src/__tests__/utils-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ test('getSnapshotPath()', () => {
);
});

test('saveSnapshotFile()', () => {
test('saveSnapshotFile() works with \r\n', () => {
const filename = path.join(__dirname, 'remove-newlines.snap');
const data = {
myKey: '<div>\r\n</div>',
Expand All @@ -52,6 +52,17 @@ test('saveSnapshotFile()', () => {
.toBeCalledWith(filename, 'exports[`myKey`] = `<div>\n</div>`;\n');
});

test('saveSnapshotFile() works with \r', () => {
const filename = path.join(__dirname, 'remove-newlines.snap');
const data = {
myKey: '<div>\r</div>',
};

saveSnapshotFile(data, filename);
expect(fs.writeFileSync)
.toBeCalledWith(filename, 'exports[`myKey`] = `<div>\n</div>`;\n');
});

test('escaping', () => {
const filename = path.join(__dirname, 'escaping.snap');
const data = '"\'\\';
Expand Down
6 changes: 5 additions & 1 deletion packages/jest-snapshot/src/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ const serialize = (data: any): string => {
}));
};

const unescape = (data: any): string =>
data.replace(/\\(")/g, '$1'); // unescape double quotes

const printBacktickString = (str: string) => {
return '`' + str.replace(/`|\\|\${/g, '\\$&') + '`';
};
Expand All @@ -77,7 +80,7 @@ const ensureDirectoryExists = (filePath: Path) => {
};

const normalizeNewlines =
string => string.replace(/\r\n/g, '\n');
string => string.replace(/\r\n|\r/g, '\n');

const saveSnapshotFile = (
snapshotData: {[key: string]: string},
Expand All @@ -102,4 +105,5 @@ module.exports = {
saveSnapshotFile,
serialize,
testNameToKey,
unescape,
};