Function verify

ng-dev/pullapprove/verify.ts:16–110

()

import {getGroupsFromYaml} from './parse-yaml.js';

export async function verify() {
  const git = await 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 allGroupConditionsValid =
    resultsByGroup.every((r) => !r.unmatchedCount) && !unmatchedFiles.length;
  /** Whether all groups have at least one reviewer user or team defined.  */
  const groupsWithoutReviewers = groups.filter(
    (group) => Object.keys(group.reviewers).length === 0,
  );
  /** The overall result of the verifcation. */
  const overallResult = allGroupConditionsValid && groupsWithoutReviewers.length === 0;

  /**
   * Overall result
   */
  logHeader('Overall Result');
  if (overallResult) {
    Log.info('PullApprove verification succeeded!');
  } else {
    Log.info(`PullApprove verification failed.`);
    Log.info();
    Log.info(`Please update '.pullapprove.yml' to ensure that all necessary`);
    Log.info(`files/directories have owners and all patterns that appear in`);
    Log.info(`the file correspond to actual files/directories in the repo.`);
  }