Skip to content

Correctly merge property matchers with the rest of the snapshot in toMatchSnapshot. #6528

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
thymikee merged 12 commits into from
Aug 9, 2018
Merged

Correctly merge property matchers with the rest of the snapshot in toMatchSnapshot. #6528

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a88a7c0
deep merge property matchers in snapshot objects
swcisel Jun 23, 2018
994e09e
Update index.js
swcisel Jun 23, 2018
cbf8f6b
Update CHANGELOG.md
swcisel Jun 23, 2018
7ac7f4d
moved deepMerge to jest-snapshot utils.
swcisel Jun 24, 2018
a3b32ed
Merge remote-tracking branch 'origin/master' into full_snapshot_with_…
rickhanlonii Jul 12, 2018
74796b0
Update changelog
rickhanlonii Jul 12, 2018
d17e7f6
Update deepmerge tests
rickhanlonii Jul 12, 2018
1b8dd70
Add errors for invalid property matchers
rickhanlonii Jul 12, 2018
deb016c
Update changelog
rickhanlonii Jul 12, 2018
7032a35
Merge branch 'master' into full_snapshot_with_property_matcher
SimenB Jul 16, 2018
e4fbf98
Merge branch 'master' into full_snapshot_with_property_matcher
thymikee Aug 8, 2018
3902a22
Merge branch 'master' into full_snapshot_with_property_matcher
thymikee Aug 9, 2018
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
Prev Previous commit
Next Next commit
Add errors for invalid property matchers
  • Loading branch information
@rickhanlonii
rickhanlonii committed Jul 12, 2018
commit 1b8dd70c4c5cf3d9c366b6559002e801d9e14567
67 changes: 61 additions & 6 deletions e2e/__tests__/to_match_snapshot.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,49 @@ test('handles property matchers', () => {
}
});

test('handles invalid property matchers', () => {
const filename = 'handle-property-matchers.test.js';
{
writeFiles(TESTS_DIR, {
[filename]: `test('invalid property matchers', () => {
expect({foo: 'bar'}).toMatchSnapshot(null);
});
`,
});
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]);
expect(stderr).toMatch('Property matchers must be an object.');
expect(status).toBe(1);
}
{
writeFiles(TESTS_DIR, {
[filename]: `test('invalid property matchers', () => {
expect({foo: 'bar'}).toMatchSnapshot(null, 'test-name');
});
`,
});
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]);
expect(stderr).toMatch('Property matchers must be an object.');
expect(stderr).toMatch(
'To provide a snapshot test name without property matchers, use: toMatchSnapshot("name")',
);
expect(status).toBe(1);
}
{
writeFiles(TESTS_DIR, {
[filename]: `test('invalid property matchers', () => {
expect({foo: 'bar'}).toMatchSnapshot(undefined, 'test-name');
});
`,
});
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]);
expect(stderr).toMatch('Property matchers must be an object.');
expect(stderr).toMatch(
'To provide a snapshot test name without property matchers, use: toMatchSnapshot("name")',
);
expect(status).toBe(1);
}
});

test('handles property matchers with custom name', () => {
const filename = 'handle-property-matchers-with-name.test.js';
const template = makeTemplate(`test('handles property matchers with name', () => {
Expand All @@ -217,20 +260,21 @@ test('handles property matchers with custom name', () => {
expect(stderr).toMatch(
'Received value does not match snapshot properties for "handles property matchers with name: custom-name 1".',
);
expect(stderr).toMatch('Expected snapshot to match properties:');
expect(stderr).toMatch('Snapshots: 1 failed, 1 total');
expect(status).toBe(1);
}
});

test('handles property matchers with deep expect.objectContaining', () => {
test('handles property matchers with deep properties', () => {
const filename = 'handle-property-matchers-with-name.test.js';
const template = makeTemplate(`test('handles property matchers with deep expect.objectContaining', () => {
expect({ user: { createdAt: $1, name: 'Jest' }}).toMatchSnapshot({ user: expect.objectContaining({ createdAt: expect.any(Date) }) });
const template = makeTemplate(`test('handles property matchers with deep properties', () => {
expect({ user: { createdAt: $1, name: $2 }}).toMatchSnapshot({ user: { createdAt: expect.any(Date), name: $2 }});
});
`);

{
writeFiles(TESTS_DIR, {[filename]: template(['new Date()'])});
writeFiles(TESTS_DIR, {[filename]: template(['new Date()', '"Jest"'])});
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]);
expect(stderr).toMatch('1 snapshot written from 1 test suite.');
expect(status).toBe(0);
Expand All @@ -243,10 +287,21 @@ test('handles property matchers with deep expect.objectContaining', () => {
}

{
writeFiles(TESTS_DIR, {[filename]: template(['"string"'])});
writeFiles(TESTS_DIR, {[filename]: template(['"string"', '"Jest"'])});
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]);
expect(stderr).toMatch(
'Received value does not match snapshot properties for "handles property matchers with deep properties 1".',
);
expect(stderr).toMatch('Expected snapshot to match properties:');
expect(stderr).toMatch('Snapshots: 1 failed, 1 total');
expect(status).toBe(1);
}

{
writeFiles(TESTS_DIR, {[filename]: template(['new Date()', '"CHANGED"'])});
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]);
expect(stderr).toMatch(
'Received value does not match snapshot properties for "handles property matchers with deep expect.objectContaining 1".',
'Received value does not match stored snapshot "handles property matchers with deep properties 1"',
);
expect(stderr).toMatch('Snapshots: 1 failed, 1 total');
expect(status).toBe(1);
Expand Down
9 changes: 9 additions & 0 deletions packages/jest-snapshot/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ const toMatchSnapshot = function(
propertyMatchers?: any,
testName?: string,
) {
if (arguments.length === 3 && !propertyMatchers) {
throw new Error(
'Property matchers must be an object.\n\nTo provide a snapshot test name without property matchers, use: toMatchSnapshot("name")',
);
}
Copy link
Member

@rickhanlonii rickhanlonii Jul 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the checks here to close #6581


return _toMatchSnapshot({
context: this,
propertyMatchers,
Expand Down Expand Up @@ -118,6 +124,9 @@ const _toMatchSnapshot = ({
: currentTestName || '';

if (typeof propertyMatchers === 'object') {
if (propertyMatchers === null) {
throw new Error(`Property matchers must be an object.`);
}
const propertyPass = context.equals(received, propertyMatchers, [
context.utils.iterableEquality,
context.utils.subsetEquality,
Expand Down