Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
/**
* Copyright (c) Microsoft Corporation.
*
* 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.
*/
// The istanbul coverage format, mirrors the shapes from istanbul-lib-coverage.
export type IstanbulLocation = {
line: number;
column: number;
};
export type IstanbulRange = {
start: IstanbulLocation;
end: IstanbulLocation;
};
export type IstanbulFunctionMapping = {
name: string;
decl: IstanbulRange;
loc: IstanbulRange;
line?: number;
};
export type IstanbulBranchMapping = {
type: string;
loc: IstanbulRange;
locations: IstanbulRange[];
line?: number;
};
export type IstanbulFileCoverage = {
path: string;
statementMap: { [key: string]: IstanbulRange };
fnMap: { [key: string]: IstanbulFunctionMapping };
branchMap: { [key: string]: IstanbulBranchMapping };
s: { [key: string]: number };
f: { [key: string]: number };
b: { [key: string]: number[] };
};
export type IstanbulCoverage = { [file: string]: IstanbulFileCoverage };
// The maps are only sent with the first report of each file.
export type IstanbulFileCoverageDelta = Partial<IstanbulFileCoverage> & Pick<IstanbulFileCoverage, 'path' | 's' | 'f' | 'b'>;
export type IstanbulCoverageDelta = { [file: string]: IstanbulFileCoverageDelta };
export const kCoverageStashPrefix = '__pwCoverage.';
export const kCoverageStashError = 'Failed to stash the coverage';
export type IstanbulCoverageChunk = {
data: IstanbulCoverageDelta;
id?: string;
};
export function sortedIstanbulCoverage(coverage: Map<string, IstanbulFileCoverage>): IstanbulCoverage {
return Object.fromEntries([...coverage.entries()].sort(([a], [b]) => a.localeCompare(b)));
}
export function mergeIstanbulCoverage(into: Map<string, IstanbulFileCoverage>, data: IstanbulCoverageDelta) {
for (const [file, fileCov] of Object.entries(data)) {
let existing = into.get(file);
if (!existing) {
existing = { path: fileCov.path, statementMap: {}, fnMap: {}, branchMap: {}, s: {}, f: {}, b: {} };
into.set(file, existing);
}
// The maps can arrive late if the report that carried them was lost.
if (fileCov.statementMap && !Object.keys(existing.statementMap).length) {
existing.statementMap = fileCov.statementMap;
existing.fnMap = fileCov.fnMap || {};
existing.branchMap = fileCov.branchMap || {};
// Reports only carry the counters that were hit, zero fill the rest.
for (const key of Object.keys(existing.statementMap))
existing.s[key] = existing.s[key] || 0;
for (const key of Object.keys(existing.fnMap))
existing.f[key] = existing.f[key] || 0;
for (const [key, branch] of Object.entries(existing.branchMap))
existing.b[key] = existing.b[key] || branch.locations.map(() => 0);
}
for (const key of Object.keys(fileCov.s))
existing.s[key] = (existing.s[key] || 0) + fileCov.s[key];
for (const key of Object.keys(fileCov.f))
existing.f[key] = (existing.f[key] || 0) + fileCov.f[key];
for (const key of Object.keys(fileCov.b)) {
const branches = existing.b[key] || (existing.b[key] = []);
fileCov.b[key].forEach((count, i) => branches[i] = (branches[i] || 0) + count);
}
}
}
export function takeCounters(counters: { [key: string]: number }): { [key: string]: number } | undefined {
let result: { [key: string]: number } | undefined;
for (const key of Object.keys(counters)) {
const count = counters[key];
if (!count)
continue;
if (!result)
result = {};
result[key] = count;
counters[key] = 0;
}
return result;
}
// Branch counters are positional, so a hit branch is reported with the whole array.
export function takeBranchCounters(counters: { [key: string]: number[] }): { [key: string]: number[] } | undefined {
let result: { [key: string]: number[] } | undefined;
for (const key of Object.keys(counters)) {
const counts = counters[key];
if (!counts.some(Boolean))
continue;
if (!result)
result = {};
result[key] = counts.slice();
counts.fill(0);
}
return result;
}