f0c570bd41
Currently, when verifying our pullapprove configuration, we don't respect modifications to the set of files in a condition. e.g. It's not possible to do the following: ``` contains_any_globs(files.exclude(...), [ ``` This prevents us from having codeowner groups which match a directory, but want to filter out specific sub directories. For example, `fw-core` matches all files in the core package. We want to exclude the schematics from that glob. Usually we do this by another exclude condition. This has a *significant* downside though. It means that fw-core will not be requested if a PR changes schematic code, _and_ actual fw-core code. To support these conditions, the pullapprove verification tool is refactored, so that it no longer uses Regular expressions for parsing, but rather evaluates the code through a dynamic function. This is possible since the conditions are written in simple Python that can be run in NodeJS too (with small modifications/transformations). PR Close #36661
106 lines
3.5 KiB
TypeScript
106 lines
3.5 KiB
TypeScript
/**
|
|
* @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
|
|
*/
|
|
import {convertConditionToFunction} from './condition_evaluator';
|
|
import {PullApproveGroupConfig} from './parse-yaml';
|
|
|
|
/** A condition for a group. */
|
|
interface GroupCondition {
|
|
expression: string;
|
|
checkFn: (files: string[]) => boolean;
|
|
matchedFiles: Set<string>;
|
|
}
|
|
|
|
/** Result of testing files against the group. */
|
|
export interface PullApproveGroupResult {
|
|
groupName: string;
|
|
matchedConditions: GroupCondition[];
|
|
matchedCount: number;
|
|
unmatchedConditions: GroupCondition[];
|
|
unmatchedCount: number;
|
|
}
|
|
|
|
// Regular expression that matches conditions for the global approval.
|
|
const GLOBAL_APPROVAL_CONDITION_REGEX = /^"global-(docs-)?approvers" not in groups.approved$/;
|
|
|
|
// Name of the PullApprove group that serves as fallback. This group should never capture
|
|
// any conditions as it would always match specified files. This is not desired as we want
|
|
// to figure out as part of this tool, whether there actually are unmatched files.
|
|
const FALLBACK_GROUP_NAME = 'fallback';
|
|
|
|
/** A PullApprove group to be able to test files against. */
|
|
export class PullApproveGroup {
|
|
/** List of conditions for the group. */
|
|
conditions: GroupCondition[] = [];
|
|
|
|
constructor(public groupName: string, config: PullApproveGroupConfig) {
|
|
this._captureConditions(config);
|
|
}
|
|
|
|
private _captureConditions(config: PullApproveGroupConfig) {
|
|
if (config.conditions && this.groupName !== FALLBACK_GROUP_NAME) {
|
|
return config.conditions.forEach(condition => {
|
|
const expression = condition.trim();
|
|
|
|
if (expression.match(GLOBAL_APPROVAL_CONDITION_REGEX)) {
|
|
// Currently a noop as we don't take any action for global approval conditions.
|
|
return;
|
|
}
|
|
|
|
try {
|
|
this.conditions.push({
|
|
expression,
|
|
checkFn: convertConditionToFunction(expression),
|
|
matchedFiles: new Set(),
|
|
});
|
|
} catch (e) {
|
|
console.error(`Could not parse condition in group: ${this.groupName}`);
|
|
console.error(` - ${expression}`);
|
|
console.error(`Error:`, e.message, e.stack);
|
|
process.exit(1);
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tests a provided file path to determine if it would be considered matched by
|
|
* the pull approve group's conditions.
|
|
*/
|
|
testFile(filePath: string): boolean {
|
|
return this.conditions.every(({matchedFiles, checkFn, expression}) => {
|
|
try {
|
|
const matchesFile = checkFn([filePath]);
|
|
if (matchesFile) {
|
|
matchedFiles.add(filePath);
|
|
}
|
|
return matchesFile;
|
|
} catch (e) {
|
|
const errMessage = `Condition could not be evaluated: \n\n` +
|
|
`From the [${this.groupName}] group:\n` +
|
|
` - ${expression}` +
|
|
`\n\n${e.message} ${e.stack}\n\n`;
|
|
console.error(errMessage);
|
|
process.exit(1);
|
|
}
|
|
});
|
|
}
|
|
|
|
/** Retrieve the results for the Group, all matched and unmatched conditions. */
|
|
getResults(): PullApproveGroupResult {
|
|
const matchedConditions = this.conditions.filter(c => !!c.matchedFiles.size);
|
|
const unmatchedConditions = this.conditions.filter(c => !c.matchedFiles.size);
|
|
return {
|
|
matchedConditions,
|
|
matchedCount: matchedConditions.length,
|
|
unmatchedConditions,
|
|
unmatchedCount: unmatchedConditions.length,
|
|
groupName: this.groupName,
|
|
};
|
|
}
|
|
}
|