ci: move public-api goldens to goldens directory (#35768)
Moves the public api .d.ts files from tools/public_api_guard to goldens/public-api. Additionally, provides a README in the goldens directory and a script assist in testing the current state of the repo against the goldens as well as a command for accepting all changes to the goldens in a single command. PR Close #35768
This commit is contained in:

committed by
Matias Niemelä

parent
19cfaf7f4c
commit
15f8afa4bf
54
goldens/public-api/manage.js
Normal file
54
goldens/public-api/manage.js
Normal file
@ -0,0 +1,54 @@
|
||||
const {exec} = require('shelljs');
|
||||
const minimist = require('minimist');
|
||||
|
||||
// Remove all command line flags from the arguments.
|
||||
const argv = minimist(process.argv.slice(2));
|
||||
// The command the user would like to run, either 'accept' or 'test'
|
||||
const USER_COMMAND = argv._[0];
|
||||
// The shell command to query for all Public API guard tests.
|
||||
const BAZEL_PUBLIC_API_TARGET_QUERY_CMD =
|
||||
`yarn -s bazel query --output label 'kind(nodejs_test, ...) intersect attr("tags", "api_guard", ...)'`
|
||||
// Bazel targets for testing Public API goldens
|
||||
process.stdout.write('Gathering all Public API targets');
|
||||
const ALL_PUBLIC_API_TESTS = exec(BAZEL_PUBLIC_API_TARGET_QUERY_CMD, {silent: true})
|
||||
.trim()
|
||||
.split('\n')
|
||||
.map(test => test.trim());
|
||||
process.stdout.clearLine();
|
||||
process.stdout.cursorTo(0);
|
||||
// Bazel targets for generating Public API goldens
|
||||
const ALL_PUBLIC_API_ACCEPTS = ALL_PUBLIC_API_TESTS.map(test => `${test}.accept`);
|
||||
|
||||
/**
|
||||
* Run the provided bazel commands on each provided target individually.
|
||||
*/
|
||||
function runBazelCommandOnTargets(command, targets, present) {
|
||||
for (const target of targets) {
|
||||
process.stdout.write(`${present}: ${target}`);
|
||||
const commandResult = exec(`yarn -s bazel ${command} ${target}`, {silent: true});
|
||||
process.stdout.clearLine();
|
||||
process.stdout.cursorTo(0);
|
||||
if (commandResult.code) {
|
||||
console.error(`Failed ${command}: ${target}`);
|
||||
console.group();
|
||||
console.error(commandResult.stdout || commandResult.stderr);
|
||||
console.groupEnd();
|
||||
} else {
|
||||
console.log(`Successful ${command}: ${target}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
switch (USER_COMMAND) {
|
||||
case 'accept':
|
||||
runBazelCommandOnTargets('run', ALL_PUBLIC_API_ACCEPTS, 'Running');
|
||||
break;
|
||||
case 'test':
|
||||
runBazelCommandOnTargets('test', ALL_PUBLIC_API_TESTS, 'Testing');
|
||||
break;
|
||||
default:
|
||||
console.warn('Invalid command provided.');
|
||||
console.warn();
|
||||
console.warn(`Run this script with either "accept" and "test"`);
|
||||
break;
|
||||
}
|
Reference in New Issue
Block a user