git-node: add GitHub status as a CI option

Some project in the org don't use Jenkins, which means PRChecker will never succeed for pull requests on those projects. These projects usually have Travis, AppVeyor or other CI systems in place, and those systems will publish the status to GitHub, which can be retrieved via API. This commit adds GitHub status as an optional way to validate if a PR satisfies the CI requirement. We need to check for the CI status in two fields returned by our GraphQL query: commit.status for services using the old GitHub integration, and commits.checkSuites for services using the new GitHub integration via GitHub Apps.
nodejs · Nov 1, 2019 · fe21810 · fe21810
1 parent b928703
commit fe21810
Show file tree

Hide file tree

Showing 19 changed files with 623 additions and 3 deletions.
diff --git a/lib/pr_checker.js b/lib/pr_checker.js
@@ -187,9 +187,20 @@ class PRChecker {
     return cis.find(ci => isFullCI(ci) || isLiteCI(ci));
   }
 
+  checkCI() {
+    const ciType = this.argv.ciType || 'jenkins';
+    if (ciType === 'jenkins') {
+      return this.checkJenkinsCI();
+    } else if (ciType === 'github-check') {
+      return this.checkGitHubCI();
+    }
+    this.cli.error(`Invalid ciType: ${ciType}`);
+    return false;
+  }
+
   // TODO: we might want to check CI status when it's less flaky...
   // TODO: not all PR requires CI...labels?
-  checkCI() {
+  checkJenkinsCI() {
     const { cli, commits, argv } = this;
     const { maxCommits } = argv;
     const thread = this.data.getThread();
@@ -251,6 +262,57 @@ class PRChecker {
     return status;
   }
 
+  checkGitHubCI() {
+    const { cli, commits } = this;
+
+    if (!commits) {
+      cli.error('No commits detected');
+      return false;
+    }
+
+    // NOTE(mmarchini): we only care about the last commit. Maybe in the future
+    // we'll want to check all commits for a successful CI.
+    const { commit } = commits[commits.length - 1];
+
+    this.CIStatus = false;
+    const checkSuites = commit.checkSuites || { nodes: [] };
+    if (!commit.status && checkSuites.nodes.length === 0) {
+      cli.error('No CI runs detected');
+      return false;
+    }
+
+    // GitHub new Check API
+    for (const { status, conclusion } of checkSuites.nodes) {
+      if (status !== 'COMPLETED') {
+        cli.error('CI is still running');
+        return false;
+      }
+
+      if (!['SUCCESS', 'NEUTRAL'].includes(conclusion)) {
+        cli.error('Last CI failed');
+        return false;
+      }
+    }
+
+    // GitHub old commit status API
+    if (commit.status) {
+      const { state } = commit.status;
+      if (state === 'PENDING') {
+        cli.error('CI is still running');
+        return false;
+      }
+
+      if (!['SUCCESS', 'EXPECTED'].includes(state)) {
+        cli.error('Last CI failed');
+        return false;
+      }
+    }
+
+    cli.info('Last CI run was successful');
+    this.CIStatus = true;
+    return true;
+  }
+
   checkAuthor() {
     const { cli, commits, pr } = this;
 

diff --git a/lib/queries/PRCommits.gql b/lib/queries/PRCommits.gql
@@ -25,6 +25,15 @@ query Commits($prid: Int!, $owner: String!, $repo: String!, $after: String) {
             message
             messageHeadline
             authoredByCommitter
+            checkSuites(first: 10) {
+              nodes {
+                conclusion,
+                status
+              }
+            }
+            status {
+              state
+            }
           }
         }
       }

diff --git a/lib/request.js b/lib/request.js
@@ -68,7 +68,8 @@ class Request {
       method: 'POST',
       headers: {
         Authorization: `Basic ${githubCredentials}`,
-        'User-Agent': 'node-core-utils'
+        'User-Agent': 'node-core-utils',
+        Accept: 'application/vnd.github.antiope-preview+json'
       },
       body: JSON.stringify({
         query: query,

diff --git a/lib/session.js b/lib/session.js
@@ -53,6 +53,7 @@ class Session {
       upstream: this.upstream,
       branch: this.branch,
       readme: this.readme,
+      ciType: this.ciType,
       prid: this.prid
     };
   }
@@ -81,6 +82,10 @@ class Session {
     return this.config.readme;
   }
 
+  get ciType() {
+    return this.config.ciType || 'jenkins';
+  }
+
   get pullName() {
     return `${this.owner}/${this.repo}/pulls/${this.prid}`;
   }

diff --git a/test/fixtures/data.js b/test/fixtures/data.js
@@ -1,6 +1,9 @@
 'use strict';
 
-const { readJSON, patchPrototype, readFile } = require('./index');
+const { basename } = require('path');
+const { readdirSync } = require('fs');
+
+const { readJSON, patchPrototype, readFile, path } = require('./index');
 const { Collaborator } = require('../../lib/collaborators');
 const { Review } = require('../../lib/reviews');
 
@@ -82,6 +85,15 @@ const readmeNoCollaborators = readFile('./README/README_no_collaborators.md');
 const readmeNoCollaboratorE = readFile('./README/README_no_collaboratorE.md');
 const readmeUnordered = readFile('./README/README_unordered.md');
 
+const githubCI = {};
+
+for (const item of readdirSync(path('./github-ci'))) {
+  if (!item.endsWith('.json')) {
+    continue;
+  }
+  githubCI[basename(item, '.json')] = readJSON(`./github-ci/${item}`);
+};
+
 module.exports = {
   approved,
   requestedChanges,
@@ -94,6 +106,7 @@ module.exports = {
   commentsWithLiteCI,
   commentsWithLGTM,
   oddCommits,
+  githubCI,
   incorrectGitConfigCommits,
   simpleCommits,
   singleCommitAfterReview,

diff --git a/test/fixtures/github-ci/both-apis-failure.json b/test/fixtures/github-ci/both-apis-failure.json
@@ -0,0 +1,24 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "status": {
+        "state": "FAILURE"
+      },
+      "checkSuites": {
+        "nodes": [
+          {
+            "status": "COMPLETED",
+            "conclusion": "FAILURE"
+          }
+        ]
+      }
+    }
+  }
+]
+
diff --git a/test/fixtures/github-ci/both-apis-success.json b/test/fixtures/github-ci/both-apis-success.json
@@ -0,0 +1,24 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "status": {
+        "state": "SUCCESS"
+      },
+      "checkSuites": {
+        "nodes": [
+          {
+            "status": "COMPLETED",
+            "conclusion": "SUCCESS"
+          }
+        ]
+      }
+    }
+  }
+]
+
diff --git a/test/fixtures/github-ci/check-suite-failure.json b/test/fixtures/github-ci/check-suite-failure.json
@@ -0,0 +1,20 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "checkSuites": {
+        "nodes": [
+          {
+            "status": "COMPLETED",
+            "conclusion": "FAILURE"
+          }
+        ]
+      }
+    }
+  }
+]
diff --git a/test/fixtures/github-ci/check-suite-pending.json b/test/fixtures/github-ci/check-suite-pending.json
@@ -0,0 +1,20 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "checkSuites": {
+        "nodes": [
+          {
+            "status": "IN_PROGRESS"
+          }
+        ]
+      }
+    }
+  }
+]
+
diff --git a/test/fixtures/github-ci/check-suite-success.json b/test/fixtures/github-ci/check-suite-success.json
@@ -0,0 +1,20 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "checkSuites": {
+        "nodes": [
+          {
+            "status": "COMPLETED",
+            "conclusion": "SUCCESS"
+          }
+        ]
+      }
+    }
+  }
+]
diff --git a/test/fixtures/github-ci/commit-status-only-failure.json b/test/fixtures/github-ci/commit-status-only-failure.json
@@ -0,0 +1,16 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "status": {
+        "state": "FAILURE"
+      }
+    }
+  }
+]
+
diff --git a/test/fixtures/github-ci/commit-status-only-pending.json b/test/fixtures/github-ci/commit-status-only-pending.json
@@ -0,0 +1,16 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "status": {
+        "state": "PENDING"
+      }
+    }
+  }
+]
+
diff --git a/test/fixtures/github-ci/commit-status-only-success.json b/test/fixtures/github-ci/commit-status-only-success.json
@@ -0,0 +1,16 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "status": {
+        "state": "SUCCESS"
+      }
+    }
+  }
+]
+
diff --git a/test/fixtures/github-ci/no-status.json b/test/fixtures/github-ci/no-status.json
@@ -0,0 +1,13 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      }
+    }
+  }
+]
+
diff --git a/test/fixtures/github-ci/status-failure-check-suite-succeed.json b/test/fixtures/github-ci/status-failure-check-suite-succeed.json
@@ -0,0 +1,24 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "status": {
+        "state": "FAILURE"
+      },
+      "checkSuites": {
+        "nodes": [
+          {
+            "status": "COMPLETED",
+            "conclusion": "SUCCESS"
+          }
+        ]
+      }
+    }
+  }
+]
+
diff --git a/test/fixtures/github-ci/status-succeed-check-suite-failure.json b/test/fixtures/github-ci/status-succeed-check-suite-failure.json
@@ -0,0 +1,24 @@
+[
+  {
+    "commit": {
+      "committedDate": "2017-10-26T12:10:20Z",
+      "oid": "9d098ssiskj8dhd39js0sjd0cn2ng4is9n40sj12d",
+      "messageHeadline": "doc: add api description README",
+      "author": {
+        "login": "foo"
+      },
+      "status": {
+        "state": "SUCCESS"
+      },
+      "checkSuites": {
+        "nodes": [
+          {
+            "status": "COMPLETED",
+            "conclusion": "FAILURE"
+          }
+        ]
+      }
+    }
+  }
+]
+