puppeteer/test/coverage.spec.ts

316 lines
13 KiB
TypeScript
Raw Normal View History

/**
* Copyright 2018 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.
*/
import expect from 'expect';
import {
2020-05-07 10:54:55 +00:00
getTestState,
setupTestPageAndContextHooks,
setupTestBrowserHooks,
describeChromeOnly,
} from './mocha-utils'; // eslint-disable-line import/extensions
2020-05-07 10:54:55 +00:00
describe('Coverage specs', function () {
describeChromeOnly('JSCoverage', function () {
setupTestBrowserHooks();
setupTestPageAndContextHooks();
2020-05-07 10:54:55 +00:00
it('should work', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
2020-05-07 10:54:55 +00:00
await page.goto(server.PREFIX + '/jscoverage/simple.html', {
waitUntil: 'networkidle0',
});
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(1);
expect(coverage[0].url).toContain('/jscoverage/simple.html');
expect(coverage[0].ranges).toEqual([
2020-05-07 10:54:55 +00:00
{ start: 0, end: 17 },
{ start: 35, end: 61 },
]);
});
2020-05-07 10:54:55 +00:00
it('should report sourceURLs', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
await page.goto(server.PREFIX + '/jscoverage/sourceurl.html');
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(1);
expect(coverage[0].url).toBe('nicename.js');
});
2020-05-07 10:54:55 +00:00
it('should ignore eval() scripts by default', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
await page.goto(server.PREFIX + '/jscoverage/eval.html');
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(1);
});
2020-05-07 10:54:55 +00:00
it("shouldn't ignore eval() scripts if reportAnonymousScripts is true", async () => {
const { page, server } = getTestState();
2020-05-07 10:54:55 +00:00
await page.coverage.startJSCoverage({ reportAnonymousScripts: true });
await page.goto(server.PREFIX + '/jscoverage/eval.html');
const coverage = await page.coverage.stopJSCoverage();
2020-05-07 10:54:55 +00:00
expect(
coverage.find((entry) => entry.url.startsWith('debugger://'))
).not.toBe(null);
expect(coverage.length).toBe(2);
});
2020-05-07 10:54:55 +00:00
it('should ignore pptr internal scripts if reportAnonymousScripts is true', async () => {
const { page, server } = getTestState();
2020-05-07 10:54:55 +00:00
await page.coverage.startJSCoverage({ reportAnonymousScripts: true });
await page.goto(server.EMPTY_PAGE);
await page.evaluate('console.log("foo")');
await page.evaluate(() => console.log('bar'));
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(0);
});
2020-05-07 10:54:55 +00:00
it('should report multiple scripts', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
await page.goto(server.PREFIX + '/jscoverage/multiple.html');
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(2);
coverage.sort((a, b) => a.url.localeCompare(b.url));
expect(coverage[0].url).toContain('/jscoverage/script1.js');
expect(coverage[1].url).toContain('/jscoverage/script2.js');
});
2020-05-07 10:54:55 +00:00
it('should report right ranges', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
await page.goto(server.PREFIX + '/jscoverage/ranges.html');
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(1);
const entry = coverage[0];
expect(entry.ranges.length).toBe(1);
const range = entry.ranges[0];
2020-05-07 10:54:55 +00:00
expect(entry.text.substring(range.start, range.end)).toBe(
`console.log('used!');`
);
});
2020-05-07 10:54:55 +00:00
it('should report scripts that have no coverage', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
await page.goto(server.PREFIX + '/jscoverage/unused.html');
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(1);
const entry = coverage[0];
expect(entry.url).toContain('unused.html');
expect(entry.ranges.length).toBe(0);
});
2020-05-07 10:54:55 +00:00
it('should work with conditionals', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
await page.goto(server.PREFIX + '/jscoverage/involved.html');
const coverage = await page.coverage.stopJSCoverage();
2020-05-07 10:54:55 +00:00
expect(
JSON.stringify(coverage, null, 2).replace(/:\d{4}\//g, ':<PORT>/')
).toBeGolden('jscoverage-involved.txt');
});
// @see https://crbug.com/990945
xit('should not hang when there is a debugger statement', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
await page.goto(server.EMPTY_PAGE);
await page.evaluate(() => {
debugger; // eslint-disable-line no-debugger
});
await page.coverage.stopJSCoverage();
});
2020-05-07 10:54:55 +00:00
describe('resetOnNavigation', function () {
it('should report scripts across navigations when disabled', async () => {
const { page, server } = getTestState();
2020-05-07 10:54:55 +00:00
await page.coverage.startJSCoverage({ resetOnNavigation: false });
await page.goto(server.PREFIX + '/jscoverage/multiple.html');
await page.goto(server.EMPTY_PAGE);
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(2);
});
2020-05-07 10:54:55 +00:00
it('should NOT report scripts across navigations when enabled', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage(); // Enabled by default.
await page.goto(server.PREFIX + '/jscoverage/multiple.html');
await page.goto(server.EMPTY_PAGE);
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(0);
});
});
describe('includeRawScriptCoverage', function () {
it('should not include rawScriptCoverage field when disabled', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
await page.goto(server.PREFIX + '/jscoverage/simple.html', {
waitUntil: 'networkidle0',
});
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(1);
expect(coverage[0].rawScriptCoverage).toBeUndefined();
});
it('should include rawScriptCoverage field when enabled', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage({
includeRawScriptCoverage: true,
});
await page.goto(server.PREFIX + '/jscoverage/simple.html', {
waitUntil: 'networkidle0',
});
const coverage = await page.coverage.stopJSCoverage();
expect(coverage.length).toBe(1);
expect(coverage[0].rawScriptCoverage).toBeTruthy();
});
});
// @see https://crbug.com/990945
xit('should not hang when there is a debugger statement', async () => {
const { page, server } = getTestState();
await page.coverage.startJSCoverage();
await page.goto(server.EMPTY_PAGE);
await page.evaluate(() => {
debugger; // eslint-disable-line no-debugger
});
await page.coverage.stopJSCoverage();
});
});
2020-05-07 10:54:55 +00:00
describeChromeOnly('CSSCoverage', function () {
setupTestBrowserHooks();
setupTestPageAndContextHooks();
2020-05-07 10:54:55 +00:00
it('should work', async () => {
const { page, server } = getTestState();
await page.coverage.startCSSCoverage();
await page.goto(server.PREFIX + '/csscoverage/simple.html');
const coverage = await page.coverage.stopCSSCoverage();
expect(coverage.length).toBe(1);
expect(coverage[0].url).toContain('/csscoverage/simple.html');
2020-05-07 10:54:55 +00:00
expect(coverage[0].ranges).toEqual([{ start: 1, end: 22 }]);
const range = coverage[0].ranges[0];
2020-05-07 10:54:55 +00:00
expect(coverage[0].text.substring(range.start, range.end)).toBe(
'div { color: green; }'
);
});
2020-05-07 10:54:55 +00:00
it('should report sourceURLs', async () => {
const { page, server } = getTestState();
await page.coverage.startCSSCoverage();
await page.goto(server.PREFIX + '/csscoverage/sourceurl.html');
const coverage = await page.coverage.stopCSSCoverage();
expect(coverage.length).toBe(1);
expect(coverage[0].url).toBe('nicename.css');
});
2020-05-07 10:54:55 +00:00
it('should report multiple stylesheets', async () => {
const { page, server } = getTestState();
await page.coverage.startCSSCoverage();
await page.goto(server.PREFIX + '/csscoverage/multiple.html');
const coverage = await page.coverage.stopCSSCoverage();
expect(coverage.length).toBe(2);
coverage.sort((a, b) => a.url.localeCompare(b.url));
expect(coverage[0].url).toContain('/csscoverage/stylesheet1.css');
expect(coverage[1].url).toContain('/csscoverage/stylesheet2.css');
});
2020-05-07 10:54:55 +00:00
it('should report stylesheets that have no coverage', async () => {
const { page, server } = getTestState();
await page.coverage.startCSSCoverage();
await page.goto(server.PREFIX + '/csscoverage/unused.html');
const coverage = await page.coverage.stopCSSCoverage();
expect(coverage.length).toBe(1);
expect(coverage[0].url).toBe('unused.css');
expect(coverage[0].ranges.length).toBe(0);
});
2020-05-07 10:54:55 +00:00
it('should work with media queries', async () => {
const { page, server } = getTestState();
await page.coverage.startCSSCoverage();
await page.goto(server.PREFIX + '/csscoverage/media.html');
const coverage = await page.coverage.stopCSSCoverage();
expect(coverage.length).toBe(1);
expect(coverage[0].url).toContain('/csscoverage/media.html');
2020-05-07 10:54:55 +00:00
expect(coverage[0].ranges).toEqual([{ start: 17, end: 38 }]);
});
2020-05-07 10:54:55 +00:00
it('should work with complicated usecases', async () => {
const { page, server } = getTestState();
await page.coverage.startCSSCoverage();
await page.goto(server.PREFIX + '/csscoverage/involved.html');
const coverage = await page.coverage.stopCSSCoverage();
2020-05-07 10:54:55 +00:00
expect(
JSON.stringify(coverage, null, 2).replace(/:\d{4}\//g, ':<PORT>/')
).toBeGolden('csscoverage-involved.txt');
});
2020-05-07 10:54:55 +00:00
it('should ignore injected stylesheets', async () => {
const { page } = getTestState();
await page.coverage.startCSSCoverage();
2020-05-07 10:54:55 +00:00
await page.addStyleTag({ content: 'body { margin: 10px;}' });
// trigger style recalc
2020-05-07 10:54:55 +00:00
const margin = await page.evaluate(
() => window.getComputedStyle(document.body).margin
);
expect(margin).toBe('10px');
const coverage = await page.coverage.stopCSSCoverage();
expect(coverage.length).toBe(0);
});
it('should work with a recently loaded stylesheet', async () => {
const { page, server } = getTestState();
await page.coverage.startCSSCoverage();
await page.evaluate<(url: string) => Promise<void>>(async (url) => {
document.body.textContent = 'hello, world';
const link = document.createElement('link');
link.rel = 'stylesheet';
link.href = url;
document.head.appendChild(link);
await new Promise((x) => (link.onload = x));
}, server.PREFIX + '/csscoverage/stylesheet1.css');
const coverage = await page.coverage.stopCSSCoverage();
expect(coverage.length).toBe(1);
});
2020-05-07 10:54:55 +00:00
describe('resetOnNavigation', function () {
it('should report stylesheets across navigations', async () => {
const { page, server } = getTestState();
2020-05-07 10:54:55 +00:00
await page.coverage.startCSSCoverage({ resetOnNavigation: false });
await page.goto(server.PREFIX + '/csscoverage/multiple.html');
await page.goto(server.EMPTY_PAGE);
const coverage = await page.coverage.stopCSSCoverage();
expect(coverage.length).toBe(2);
});
2020-05-07 10:54:55 +00:00
it('should NOT report scripts across navigations', async () => {
const { page, server } = getTestState();
await page.coverage.startCSSCoverage(); // Enabled by default.
await page.goto(server.PREFIX + '/csscoverage/multiple.html');
await page.goto(server.EMPTY_PAGE);
const coverage = await page.coverage.stopCSSCoverage();
expect(coverage.length).toBe(0);
});
});
});
});