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

docs: show browser test stats in the readme #24

Merged
merged 1 commit into from
Nov 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Browser Test Stats
<!-- GEN:test-stats -->
|Firefox|Chromium|WebKit|all|
|---|---|---|---|
|511/650|698/705|325/653|309/650|
<!-- GEN:stop -->

# Contributing

Expand Down
69 changes: 69 additions & 0 deletions test/stats.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
const path = require('path');
const {TestRunner} = require('../utils/testrunner/');
const utils = require('./utils');
const {addTests} = require('./playwright.spec.js');
const firefoxTests = testsForProduct('Firefox');
const chromiumTests = testsForProduct('Chromium');
const webkitTests = testsForProduct('WebKit');
const goalSuite = intersectSets(firefoxTests.all, chromiumTests.all, webkitTests.all);
const skippedSuite = intersectSets(goalSuite, joinSets(firefoxTests.skipped, chromiumTests.skipped, webkitTests.skipped));

module.exports = {
firefox: {
total: firefoxTests.all.size,
skipped: firefoxTests.skipped.size,
},
chromium: {
total: chromiumTests.all.size,
skipped: chromiumTests.skipped.size,
},
webkit: {
total: webkitTests.all.size,
skipped: webkitTests.skipped.size,
},
all: {
total: goalSuite.size,
skipped: skippedSuite.size,
}
};

/**
* @param {string} product
*/
function testsForProduct(product) {
const testRunner = new TestRunner();
addTests({
product,
playwrightPath: path.join(utils.projectRoot(), `${product.toLowerCase()}.js`),
testRunner
});
return {
all: new Set(testRunner.tests().map(test => test.fullName)),
skipped: new Set(testRunner.tests().filter(test => test.declaredMode === 'skip').map(test => test.fullName))
}
}

/**
* @param {...Set} sets
*/
function intersectSets(...sets) {
if (!sets.length)
return new Set();
const intersect = new Set();
const [first, ...rest] = sets;
outer: for (const item of first) {
for (const set of rest)
if (!set.has(item))
continue outer;
intersect.add(item);
}
return intersect;
}

function joinSets(...sets) {
const joined = new Set();
for (const set of sets)
for (const item of set)
joined.add(item);
return joined;
}
15 changes: 15 additions & 0 deletions utils/doclint/preprocessor/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ module.exports.runCommands = function(sources, version) {
newText = isReleaseVersion ? '' : command.originalText;
else if (command.name === 'toc')
newText = generateTableOfContents(command.source.text().substring(command.to));
else if (command.name === 'test-stats')
newText = generateTestStats();
if (newText === null)
messages.push(Message.error(`Unknown command 'gen:${command.name}'`));
else if (applyCommand(command, newText))
Expand All @@ -91,6 +93,19 @@ function applyCommand(command, editText) {
return command.source.setText(newText);
}

function generateTestStats() {
const stats = require('../../../test/stats');
return `
|Firefox|Chromium|WebKit|all|
|---|---|---|---|
|${s('firefox')}|${s('chromium')}|${s('webkit')}|${s('all')}|
`;
function s(product) {
const {total, skipped} = stats[product];
return `${total-skipped}/${total}`;
}
}

function generateTableOfContents(mdText) {
const ids = new Set();
const titles = [];
Expand Down