Skip to content

chore: add script to generate ivy test blacklist #14877

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

Merged
merged 1 commit into from
Jan 18, 2019
Merged
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
90 changes: 90 additions & 0 deletions scripts/ivy/generate-blacklist.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
#!/usr/bin/env node

const path = require('path');
const fs = require('fs');

const karmaOutput = JSON.parse(fs.readFileSync('/tmp/karma-result.json'));
Copy link
Member

Choose a reason for hiding this comment

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

Could probably make this as a CLI arg as well. I'm sure it doesn't matter too much, so just nit.



let generatedBlacklist = {};
for (const desc of Object.keys(karmaOutput)) {
generatedBlacklist = {...generatedBlacklist, ...getFullFailure(karmaOutput[desc], desc)};
}

// We want to "remember" the notes from the current blacklist on angular/angular unless the
// error message has changed. We need to know where the local angular/angular repo is.
const angularRepoPath = process.argv[2];
if (!angularRepoPath) {
console.error('Please provide the path to your local angular/angular repo as the first argument');
process.exit(1);
}

// Read the contents of the previous blacklist.
const previousBlacklistPath =
path.join(angularRepoPath, 'tools', 'material-ci', 'angular_material_test_blacklist.js');
const previousBlacklistContent = fs.readFileSync(previousBlacklistPath, 'utf-8');

// Because the blacklist is a javascript file meant to be executed, we just actually execute it with
// eval. Create a dummy `window` for it to add to.
const window = {};
eval(previousBlacklistContent);
const previousBlacklist = window.testBlacklist;

// Copy any existing test notes.
for (const testName of Object.keys(generatedBlacklist)) {
if (previousBlacklist[testName] &&
generatedBlacklist[testName].error === previousBlacklist[testName].error) {
generatedBlacklist[testName].notes = previousBlacklist[testName].notes;
}
}

// Format the output as an executable javascript program.
const output =
`/**
* @license
* Copyright Google Inc. All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/

/**
* Blacklist of unit tests from angular/material2 with ivy that are skipped when running on
* angular/angular. As bugs are resolved, items should be removed from this blacklist.
*
* The \`notes\` section should be used to keep track of specific issues associated with the failures.
*/

// clang-format off
// tslint:disable

window.testBlacklist = ${JSON.stringify(generatedBlacklist, null, 2)};
// clang-format on`;

// Write that sucker to dist.
fs.writeFileSync('dist/angular_material_test_blacklist.js', output, 'utf-8');


/**
* Given a karma test result, get a blacklist entry in the form
* {[full test name]: {error: '...', notes: '...'}}
*/
function getFullFailure(result, fullName = '') {
if (result['log']) {
if (result['log'].length) {
return {[fullName]: {
error: result['log'][0].split('\n')[0],
notes: 'Unknown',
}};
}

return {};
}

let failures = {};
for (const key of Object.keys(result)) {
failures = {...failures, ...getFullFailure(result[key], fullName + ' ' + key)};
}

return failures;
}