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.

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): refactor to enable Smokerider #7284

Merged
merged 10 commits into from
Mar 6, 2019
9 changes: 6 additions & 3 deletions clients/lightrider-entry.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,19 @@ const LR_PRESETS = {
* @param {Connection} connection
* @param {string} url
* @param {LH.Flags} flags Lighthouse flags, including `output`
* @param {{lrDevice?: 'desktop'|'mobile', categoryIDs?: Array<string>, logAssets: boolean}} lrOpts Options coming from Lightrider
* @param {{lrDevice?: 'desktop'|'mobile', categoryIDs?: Array<string>, logAssets: boolean, keepRawValues: boolean}} lrOpts Options coming from Lightrider
* @return {Promise<string|Array<string>|void>}
*/
async function runLighthouseInLR(connection, url, flags, {lrDevice, categoryIDs, logAssets}) {
async function runLighthouseInLR(connection, url, flags, lrOpts) {
const {lrDevice, categoryIDs, logAssets, keepRawValues} = lrOpts;

// Certain fixes need to kick in under LR, see https://github.com/GoogleChrome/lighthouse/issues/5839
global.isLightRider = true;

// disableStorageReset because it causes render server hang
flags.disableStorageReset = true;
flags.logLevel = flags.logLevel || 'info';

const config = lrDevice === 'desktop' ? LR_PRESETS.desktop : LR_PRESETS.mobile;
if (categoryIDs) {
config.settings = config.settings || {};
Expand All @@ -50,7 +53,7 @@ async function runLighthouseInLR(connection, url, flags, {lrDevice, categoryIDs,

// pre process the LHR for proto
if (flags.output === 'json' && typeof results.report === 'string') {
return preprocessor.processForProto(results.report);
return preprocessor.processForProto(results.report, {keepRawValues});
}

return results.report;
Expand Down
87 changes: 3 additions & 84 deletions lighthouse-cli/test/smokehouse/run-smoke.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,88 +14,7 @@ const log = require('lighthouse-logger');

/** @param {string} str */
const purpleify = str => `${log.purple}${str}${log.reset}`;
const smokehouseDir = 'lighthouse-cli/test/smokehouse/';

/**
* @typedef {object} SmoketestDfn
* @property {string} id
* @property {string} expectations
* @property {string} config
* @property {string | undefined} batch
*/

/** @type {Array<SmoketestDfn>} */
const SMOKETESTS = [{
id: 'a11y',
config: smokehouseDir + 'a11y/a11y-config.js',
expectations: 'a11y/expectations.js',
batch: 'parallel-first',
}, {
id: 'errors',
expectations: smokehouseDir + 'error-expectations.js',
config: smokehouseDir + 'error-config.js',
batch: 'errors',
}, {
id: 'oopif',
expectations: smokehouseDir + 'oopif-expectations.js',
config: smokehouseDir + 'oopif-config.js',
batch: 'parallel-first',
}, {
id: 'pwa',
expectations: smokehouseDir + 'pwa-expectations.js',
config: smokehouseDir + 'pwa-config.js',
batch: 'parallel-second',
}, {
id: 'pwa2',
expectations: smokehouseDir + 'pwa2-expectations.js',
config: smokehouseDir + 'pwa-config.js',
batch: 'parallel-second',
}, {
id: 'pwa3',
expectations: smokehouseDir + 'pwa3-expectations.js',
config: smokehouseDir + 'pwa-config.js',
batch: 'parallel-first',
}, {
id: 'dbw',
expectations: 'dobetterweb/dbw-expectations.js',
config: smokehouseDir + 'dbw-config.js',
batch: 'parallel-second',
}, {
id: 'redirects',
expectations: 'redirects/expectations.js',
config: smokehouseDir + 'redirects-config.js',
batch: 'parallel-first',
}, {
id: 'seo',
expectations: 'seo/expectations.js',
config: smokehouseDir + 'seo-config.js',
batch: 'parallel-first',
}, {
id: 'offline',
expectations: 'offline-local/offline-expectations.js',
config: smokehouseDir + 'offline-config.js',
batch: 'offline',
}, {
id: 'byte',
expectations: 'byte-efficiency/expectations.js',
config: smokehouseDir + 'byte-config.js',
batch: 'perf-opportunity',
}, {
id: 'perf',
expectations: 'perf/expectations.js',
config: 'lighthouse-core/config/perf-config.js',
batch: 'perf-metric',
}, {
id: 'lantern',
expectations: 'perf/lantern-expectations.js',
config: smokehouseDir + 'lantern-config.js',
batch: 'parallel-first',
}, {
id: 'metrics',
expectations: 'tricky-metrics/expectations.js',
config: 'lighthouse-core/config/perf-config.js',
batch: 'parallel-second',
}];
const SMOKETESTS = require('./smoke-test-dfns').SMOKE_TEST_DFNS;

/**
* Display smokehouse output from child process
Expand All @@ -116,7 +35,7 @@ function displaySmokehouseOutput(result) {
/**
* Run smokehouse in child processes for selected smoketests
* Display output from each as soon as they finish, but resolve function when ALL are complete
* @param {Array<SmoketestDfn>} smokes
* @param {Array<Smokehouse.TestDfn>} smokes
* @return {Promise<Array<{id: string, error?: Error}>>}
*/
async function runSmokehouse(smokes) {
Expand Down Expand Up @@ -149,7 +68,7 @@ async function runSmokehouse(smokes) {
/**
* Determine batches of smoketests to run, based on argv
* @param {string[]} argv
* @return {Map<string|undefined, Array<SmoketestDfn>>}
* @return {Map<string|undefined, Array<Smokehouse.TestDfn>>}
*/
function getSmoketestBatches(argv) {
let smokes = [];
Expand Down
133 changes: 133 additions & 0 deletions lighthouse-cli/test/smokehouse/smoke-test-dfns.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
/**
* @license Copyright 2019 Google Inc. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
*/
'use strict';
Copy link
Member

Choose a reason for hiding this comment

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

/**
 * @license Copyright 2019 Google Inc. All Rights Reserved.
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */


const path = require('path');
const smokehouseDir = 'lighthouse-cli/test/smokehouse/';

/** @type {Array<Smokehouse.TestDfn>} */
const SMOKE_TEST_DFNS = [{
id: 'a11y',
config: smokehouseDir + 'a11y/a11y-config.js',
expectations: 'a11y/expectations.js',
batch: 'parallel-first',
}, {
id: 'errors',
expectations: smokehouseDir + 'error-expectations.js',
config: smokehouseDir + 'error-config.js',
batch: 'errors',
}, {
id: 'oopif',
expectations: smokehouseDir + 'oopif-expectations.js',
config: smokehouseDir + 'oopif-config.js',
batch: 'parallel-first',
}, {
id: 'pwa',
expectations: smokehouseDir + 'pwa-expectations.js',
config: smokehouseDir + 'pwa-config.js',
batch: 'parallel-second',
}, {
id: 'pwa2',
expectations: smokehouseDir + 'pwa2-expectations.js',
config: smokehouseDir + 'pwa-config.js',
batch: 'parallel-second',
}, {
id: 'pwa3',
expectations: smokehouseDir + 'pwa3-expectations.js',
config: smokehouseDir + 'pwa-config.js',
batch: 'parallel-first',
}, {
id: 'dbw',
expectations: 'dobetterweb/dbw-expectations.js',
config: smokehouseDir + 'dbw-config.js',
batch: 'parallel-second',
}, {
id: 'redirects',
expectations: 'redirects/expectations.js',
config: smokehouseDir + 'redirects-config.js',
batch: 'parallel-first',
}, {
id: 'seo',
expectations: 'seo/expectations.js',
config: smokehouseDir + 'seo-config.js',
batch: 'parallel-first',
}, {
id: 'offline',
expectations: 'offline-local/offline-expectations.js',
config: smokehouseDir + 'offline-config.js',
batch: 'offline',
}, {
id: 'byte',
expectations: 'byte-efficiency/expectations.js',
config: smokehouseDir + 'byte-config.js',
batch: 'perf-opportunity',
}, {
id: 'perf',
expectations: 'perf/expectations.js',
config: 'lighthouse-core/config/perf-config.js',
batch: 'perf-metric',
}, {
id: 'lantern',
expectations: 'perf/lantern-expectations.js',
config: smokehouseDir + 'lantern-config.js',
batch: 'parallel-first',
}, {
id: 'metrics',
expectations: 'tricky-metrics/expectations.js',
config: 'lighthouse-core/config/perf-config.js',
batch: 'parallel-second',
}];

/**
* Attempt to resolve a path relative to the smokehouse folder.
* If this fails, attempts to locate the path
* relative to the project root.
* @param {string} payloadPath
* @return {string}
*/
function resolveLocalOrProjectRoot(payloadPath) {
let resolved;
try {
resolved = require.resolve(__dirname + '/' + payloadPath);
} catch (e) {
const cwdPath = path.resolve(__dirname + '/../../../', payloadPath);
resolved = require.resolve(cwdPath);
}

return resolved;
}

/**
* @param {string} configPath
* @return {LH.Config.Json}
*/
function loadConfig(configPath) {
return require(configPath);
}

/**
* @param {string} expectationsPath
* @return {Smokehouse.ExpectedLHR[]}
*/
function loadExpectations(expectationsPath) {
return require(expectationsPath);
}

function getSmokeTests() {
return SMOKE_TEST_DFNS.map(smokeTestDfn => {
return {
id: smokeTestDfn.id,
config: loadConfig(resolveLocalOrProjectRoot(smokeTestDfn.config)),
expectations: loadExpectations(resolveLocalOrProjectRoot(smokeTestDfn.expectations)),
batch: smokeTestDfn.batch,
};
});
}

module.exports = {
SMOKE_TEST_DFNS,
getSmokeTests,
};
Loading