67f65a9d25
Currently the `GitClient` accepts a generic parameter for determining
whether the `githubToken` should be set or not. This worked fine so far
in terms of distinguishing between an authenticated and
non-authenticated git client instance, but if we intend to conditionally
show methods only for authenticated instances, the generic parameter
is not suitable.
This commit splits up the `GitClient` into two classes. One for
the base logic without any authorization, and a second class that
extends the base logic with authentication logic. i.e. the
`AuthenticatedGitClient`. This allows us to have specific methods only
for the authenticated instance. e.g.
* `hasOauthScopes` has been moved to only exist for authenticated
instances.
* the GraphQL functionality within `gitClient.github` is not
accessible for non-authenticated instances. GraphQL API requires
authentication as per Github.
The initial motiviation for this was that we want to throw if
`hasOAuthScopes` is called without the Octokit instance having
a token configured. This should help avoiding issues as within
3b434ed94d
that prevented the caretaker process momentarily.
Additionally, the Git client has moved from `index.ts` to
`git-client.ts` for better discoverability in the codebase.
PR Close #42468
102 lines
4.0 KiB
TypeScript
102 lines
4.0 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC 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 {readFileSync} from 'fs';
|
|
import {resolve} from 'path';
|
|
|
|
import {debug, info} from '../utils/console';
|
|
import {GitClient} from '../utils/git/git-client';
|
|
import {logGroup, logHeader} from './logging';
|
|
import {getGroupsFromYaml} from './parse-yaml';
|
|
|
|
export function verify() {
|
|
const git = GitClient.get();
|
|
/** Full path to PullApprove config file */
|
|
const PULL_APPROVE_YAML_PATH = resolve(git.baseDir, '.pullapprove.yml');
|
|
/** All tracked files in the repository. */
|
|
const REPO_FILES = git.allFiles();
|
|
/** The pull approve config file. */
|
|
const pullApproveYamlRaw = readFileSync(PULL_APPROVE_YAML_PATH, 'utf8');
|
|
/** All of the groups defined in the pullapprove yaml. */
|
|
const groups = getGroupsFromYaml(pullApproveYamlRaw);
|
|
/**
|
|
* PullApprove groups without conditions. These are skipped in the verification
|
|
* as those would always be active and cause zero unmatched files.
|
|
*/
|
|
const groupsSkipped = groups.filter(group => !group.conditions.length);
|
|
/** PullApprove groups with conditions. */
|
|
const groupsWithConditions = groups.filter(group => !!group.conditions.length);
|
|
/** Files which are matched by at least one group. */
|
|
const matchedFiles: string[] = [];
|
|
/** Files which are not matched by at least one group. */
|
|
const unmatchedFiles: string[] = [];
|
|
|
|
// Test each file in the repo against each group for being matched.
|
|
REPO_FILES.forEach((file: string) => {
|
|
if (groupsWithConditions.filter(group => group.testFile(file)).length) {
|
|
matchedFiles.push(file);
|
|
} else {
|
|
unmatchedFiles.push(file);
|
|
}
|
|
});
|
|
/** Results for each group */
|
|
const resultsByGroup = groupsWithConditions.map(group => group.getResults());
|
|
/**
|
|
* Whether all group condition lines match at least one file and all files
|
|
* are matched by at least one group.
|
|
*/
|
|
const verificationSucceeded =
|
|
resultsByGroup.every(r => !r.unmatchedCount) && !unmatchedFiles.length;
|
|
|
|
/**
|
|
* Overall result
|
|
*/
|
|
logHeader('Overall Result');
|
|
if (verificationSucceeded) {
|
|
info('PullApprove verification succeeded!');
|
|
} else {
|
|
info(`PullApprove verification failed.`);
|
|
info();
|
|
info(`Please update '.pullapprove.yml' to ensure that all necessary`);
|
|
info(`files/directories have owners and all patterns that appear in`);
|
|
info(`the file correspond to actual files/directories in the repo.`);
|
|
}
|
|
/**
|
|
* File by file Summary
|
|
*/
|
|
logHeader('PullApprove results by file');
|
|
info.group(`Matched Files (${matchedFiles.length} files)`);
|
|
matchedFiles.forEach(file => debug(file));
|
|
info.groupEnd();
|
|
info.group(`Unmatched Files (${unmatchedFiles.length} files)`);
|
|
unmatchedFiles.forEach(file => info(file));
|
|
info.groupEnd();
|
|
/**
|
|
* Group by group Summary
|
|
*/
|
|
logHeader('PullApprove results by group');
|
|
info.group(`Groups skipped (${groupsSkipped.length} groups)`);
|
|
groupsSkipped.forEach(group => debug(`${group.groupName}`));
|
|
info.groupEnd();
|
|
const matchedGroups = resultsByGroup.filter(group => !group.unmatchedCount);
|
|
info.group(`Matched conditions by Group (${matchedGroups.length} groups)`);
|
|
matchedGroups.forEach(group => logGroup(group, 'matchedConditions', debug));
|
|
info.groupEnd();
|
|
const unmatchedGroups = resultsByGroup.filter(group => group.unmatchedCount);
|
|
info.group(`Unmatched conditions by Group (${unmatchedGroups.length} groups)`);
|
|
unmatchedGroups.forEach(group => logGroup(group, 'unmatchedConditions'));
|
|
info.groupEnd();
|
|
const unverifiableConditionsInGroups =
|
|
resultsByGroup.filter(group => group.unverifiableConditions.length > 0);
|
|
info.group(`Unverifiable conditions by Group (${unverifiableConditionsInGroups.length} groups)`);
|
|
unverifiableConditionsInGroups.forEach(group => logGroup(group, 'unverifiableConditions'));
|
|
info.groupEnd();
|
|
|
|
// Provide correct exit code based on verification success.
|
|
process.exit(verificationSucceeded ? 0 : 1);
|
|
}
|