chore(prlint): fail prlinter on codecov failures, with exemption label (#32674)

Our current process for codecov statuses is that they block the merge of a PR if the are failing. This PR attempts to move this failure further forward in the PR process, so that the PRlinter fails and alerts the author. It also means that we can include an exemption label to merge a PR that we allow to be in breach of the codecov report. Currently, to do so we must change the branch protection rules.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: kaizencc

tools/@aws-cdk/prlint/lint.ts

@@ -10,7 +10,16 @@ export type GitHubPr =
   Endpoints['GET /repos/{owner}/{repo}/pulls/{pull_number}']['response']['data'];
 
 export const CODE_BUILD_CONTEXT = 'AWS CodeBuild us-east-1 (AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv)';
-
+export const CODECOV_PREFIX = 'codecov/';
+
+export const CODECOV_CHECKS = [
+  'patch',
+  'patch/packages/aws-cdk',
+  'patch/packages/aws-cdk-lib/core',
+  'project',
+  'project/packages/aws-cdk',
+  'project/packages/aws-cdk-lib/core'
+];
 const PR_FROM_MAIN_ERROR = 'Pull requests from `main` branch of a fork cannot be accepted. Please reopen this contribution from another branch on your fork. For more information, see https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md#step-4-pull-request.';
 
 /**
@@ -24,6 +33,7 @@ enum Exemption {
   CLI_INTEG_TESTED = 'pr-linter/cli-integ-tested',
   REQUEST_CLARIFICATION = 'pr/reviewer-clarification-requested',
   REQUEST_EXEMPTION = 'pr-linter/exemption-requested',
+  CODECOV = "pr-linter/exempt-codecov",
 }
 
 export interface GithubStatusEvent {
@@ -336,14 +346,23 @@ export class PullRequestLinter {
    * @param sha the commit sha to evaluate
    */
   private async codeBuildJobSucceeded(sha: string): Promise<boolean> {
-    const statuses = await this.client.repos.listCommitStatusesForRef({
+    return this.checkStatusSucceeded(sha, CODE_BUILD_CONTEXT);
+  }
+
+  /**
+   * Check a specific status check to see if it is successful for the given commit
+   *
+   * @param sha the commit sha to evaluate
+   */
+  private async checkStatusSucceeded(sha: string, context: string): Promise<boolean> {
+    const statuses = await this.client.paginate(this.client.repos.listCommitStatusesForRef, {
       owner: this.prParams.owner,
       repo: this.prParams.repo,
       ref: sha,
     });
-    let status = statuses.data.filter(status => status.context === CODE_BUILD_CONTEXT).map(status => status.state);
-    console.log("CodeBuild Commit Statuses: ", status);
-    return statuses.data.some(status => status.context === CODE_BUILD_CONTEXT && status.state === 'success');
+    let status = statuses.filter(status => status.context === context).map(status => status.state);
+    console.log(`${context} statuses: ${status}`);
+    return statuses.some(status => status.context === context && status.state === 'success');
   }
 
   public async validateStatusEvent(pr: GitHubPr, status: StatusEvent): Promise<void> {
@@ -575,6 +594,24 @@ export class PullRequestLinter {
       ],
     });
 
+    const codecovTests: Test[] = [];
+    for (const c of CODECOV_CHECKS) {
+      const checkName = `${CODECOV_PREFIX}${c}`;
+      const succeeded = await this.checkStatusSucceeded(sha, checkName);
+      codecovTests.push({
+        test: () => {
+          const result = new TestResult();
+          result.assessFailure(!succeeded, `${checkName} job is not succeeding`);
+          return result;
+        }
+      })
+    }
+
+    validationCollector.validateRuleSet({
+      exemption: shouldExemptCodecov,
+      testRuleSet: codecovTests,
+    });
+
     console.log("Deleting PR Linter Comment now");
     await this.deletePRLinterComment();
     try {
@@ -656,6 +693,10 @@ function fixContainsIntegTest(pr: GitHubPr, files: GitHubFile[]): TestResult {
   return result;
 }
 
+function shouldExemptCodecov(pr: GitHubPr): boolean {
+  return hasLabel(pr, Exemption.CODECOV);
+}
+
 function shouldExemptReadme(pr: GitHubPr): boolean {
   return hasLabel(pr, Exemption.README);
 }

tools/@aws-cdk/prlint/test/lint.test.ts

@@ -1182,10 +1182,13 @@ function configureMock(pr: Subset<linter.GitHubPr>, prFiles?: linter.GitHubFile[
   const reposClient = {
     listCommitStatusesForRef() {
       return {
-        data: [{
-          context: linter.CODE_BUILD_CONTEXT,
-          state: 'success',
-        }],
+        data: [
+          {
+            context: linter.CODE_BUILD_CONTEXT,
+            state: 'success',
+          },
+          ...(linter.CODECOV_CHECKS.map(c => ({ context: `${linter.CODECOV_PREFIX}${c}`, state: 'success'})))
+        ],
       };
     },
   };