puppeteer/test/utils.js

133 lines
3.6 KiB
JavaScript
Raw Normal View History

/**
* Copyright 2017 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 fs = require('fs');
const path = require('path');
const expect = require('expect');
const GoldenUtils = require('./golden-utils');
2020-05-07 10:54:55 +00:00
const PROJECT_ROOT = fs.existsSync(path.join(__dirname, '..', 'package.json'))
? path.join(__dirname, '..')
: path.join(__dirname, '..', '..');
2020-05-07 10:54:55 +00:00
const utils = (module.exports = {
extendExpectWithToBeGolden: function (goldenDir, outputDir) {
expect.extend({
toBeGolden: (testScreenshot, goldenFilePath) => {
2020-05-07 10:54:55 +00:00
const result = GoldenUtils.compare(
goldenDir,
outputDir,
testScreenshot,
goldenFilePath
);
return {
message: () => result.message,
2020-05-07 10:54:55 +00:00
pass: result.pass,
};
2020-05-07 10:54:55 +00:00
},
});
},
/**
* @returns {string}
*/
2020-05-07 10:54:55 +00:00
projectRoot: function () {
return PROJECT_ROOT;
},
2017-06-21 20:51:06 +00:00
/**
2017-06-21 20:58:49 +00:00
* @param {!Page} page
* @param {string} frameId
* @param {string} url
* @returns {!Frame}
2017-06-21 20:58:49 +00:00
*/
2020-05-07 10:54:55 +00:00
attachFrame: async function (page, frameId, url) {
const handle = await page.evaluateHandle(attachFrame, frameId, url);
return await handle.asElement().contentFrame();
async function attachFrame(frameId, url) {
const frame = document.createElement('iframe');
2017-06-21 20:51:06 +00:00
frame.src = url;
frame.id = frameId;
document.body.appendChild(frame);
2020-05-07 10:54:55 +00:00
await new Promise((x) => (frame.onload = x));
return frame;
2017-06-21 20:51:06 +00:00
}
},
2020-05-07 10:54:55 +00:00
isFavicon: function (request) {
return request.url().includes('favicon.ico');
},
2017-06-21 20:51:06 +00:00
/**
2017-06-21 20:58:49 +00:00
* @param {!Page} page
* @param {string} frameId
*/
2020-05-07 10:54:55 +00:00
detachFrame: async function (page, frameId) {
2017-06-21 20:51:06 +00:00
await page.evaluate(detachFrame, frameId);
2017-06-21 20:51:06 +00:00
function detachFrame(frameId) {
const frame = document.getElementById(frameId);
2017-06-21 20:51:06 +00:00
frame.remove();
}
},
2017-06-21 20:51:06 +00:00
/**
2017-06-21 20:58:49 +00:00
* @param {!Page} page
* @param {string} frameId
* @param {string} url
*/
2020-05-07 10:54:55 +00:00
navigateFrame: async function (page, frameId, url) {
2017-06-21 20:51:06 +00:00
await page.evaluate(navigateFrame, frameId, url);
2017-06-21 20:51:06 +00:00
function navigateFrame(frameId, url) {
const frame = document.getElementById(frameId);
2017-06-21 20:51:06 +00:00
frame.src = url;
2020-05-07 10:54:55 +00:00
return new Promise((x) => (frame.onload = x));
2017-06-21 20:51:06 +00:00
}
},
2017-06-21 20:51:06 +00:00
/**
2017-06-21 20:58:49 +00:00
* @param {!Frame} frame
* @param {string=} indentation
* @returns {Array<string>}
2017-06-21 20:58:49 +00:00
*/
2020-05-07 10:54:55 +00:00
dumpFrames: function (frame, indentation) {
2017-06-21 20:51:06 +00:00
indentation = indentation || '';
let description = frame.url().replace(/:\d{4}\//, ':<PORT>/');
2020-05-07 10:54:55 +00:00
if (frame.name()) description += ' (' + frame.name() + ')';
const result = [indentation + description];
for (const child of frame.childFrames())
result.push(...utils.dumpFrames(child, ' ' + indentation));
2017-06-21 20:51:06 +00:00
return result;
},
/**
* @param {!EventEmitter} emitter
* @param {string} eventName
* @returns {!Promise<!Object>}
*/
2020-05-07 10:54:55 +00:00
waitEvent: function (emitter, eventName, predicate = () => true) {
return new Promise((fulfill) => {
emitter.on(eventName, function listener(event) {
2020-05-07 10:54:55 +00:00
if (!predicate(event)) return;
emitter.removeListener(eventName, listener);
fulfill(event);
});
});
},
2020-05-07 10:54:55 +00:00
});