Skip to content
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

tests(smokehouse): assert on expected array length #9292

Merged
merged 5 commits into from
Jul 9, 2019
Merged

tests(smokehouse): assert on expected array length #9292

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3b8076e
tests(smokehouse): assert on expected array length
connorjclark Jun 27, 2019
c304111
lint
connorjclark Jun 27, 2019
886a109
pr
connorjclark Jul 8, 2019
4132e07
Update lighthouse-cli/test/smokehouse/smokehouse-report.js
connorjclark Jul 8, 2019
2546943
drop the 'is'. it's cleaner.
connorjclark Jul 8, 2019
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
3 changes: 3 additions & 0 deletions lighthouse-cli/test/smokehouse/byte-efficiency/expectations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,9 @@ module.exports = [
transferSize: 53181,
resourceSize: 52997,
},
{
url: 'http://localhost:10200/favicon.ico',
},
],
},
},
Expand Down
14 changes: 10 additions & 4 deletions lighthouse-cli/test/smokehouse/error-expectations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
*/
'use strict';

// Just using `[]` actually asserts for an empty array.
// Use this expectation object to assert an array with at least one element.
const IS_NONEMPTY_ARRAY = {
Copy link
Member

Choose a reason for hiding this comment

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

the "is" prefix is usually for tests. NONEMPTY_ARRAY seems better

Copy link
Member

Choose a reason for hiding this comment

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

(we also use this convention all over the expectations (e.g. dbw and byte-efficiency), so I'm not sure it's really worth calling out here in particular vs just inlining, but it's also fine if you want to keep)

length: '>0',
};

/**
* Expected Lighthouse audit values for sites with various errors.
*/
Expand All @@ -24,10 +30,10 @@ module.exports = [
artifacts: {
PageLoadError: {code: 'PAGE_HUNG'},
devtoolsLogs: {
'pageLoadError-defaultPass': [/* ... */],
'pageLoadError-defaultPass': IS_NONEMPTY_ARRAY,
},
traces: {
'pageLoadError-defaultPass': {traceEvents: [/* ... */]},
'pageLoadError-defaultPass': {traceEvents: IS_NONEMPTY_ARRAY},
},
},
},
Expand All @@ -46,10 +52,10 @@ module.exports = [
artifacts: {
PageLoadError: {code: 'INSECURE_DOCUMENT_REQUEST'},
devtoolsLogs: {
'pageLoadError-defaultPass': [/* ... */],
'pageLoadError-defaultPass': IS_NONEMPTY_ARRAY,
},
traces: {
'pageLoadError-defaultPass': {traceEvents: [/* ... */]},
'pageLoadError-defaultPass': {traceEvents: IS_NONEMPTY_ARRAY},
},
},
},
Expand Down
12 changes: 12 additions & 0 deletions lighthouse-cli/test/smokehouse/smokehouse-report.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,18 @@ function findDifference(path, actual, expected) {
}
}

// If the expected value is an array, assert on the length.
// This still allows for asserting that the first n elements of an array are specified elements,
// but requires using an object literal (ex: {0: x, 1: y, 2: z} matches [x, y, z, q, w, e] and
// {0: x, 1: y, 2: z, length: 5} does not match [x, y, z].
if (Array.isArray(expected) && actual.length !== expected.length) {
return {
path: `${path}.length`,
actual,
expected,
};
}

return null;
}

Expand Down