jenkins: post CI comment in PR for node-test-pull-request builds

These changes posts CI style comments whenever Jenkins reports that
node-test-pull-request builds has started.

Refs #212

Author: phillipj

lib/github-comment.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const githubClient = require('./github-client')
+
+exports.createPrComment = function createPrComment ({ owner, repo, number, logger }, body) {
+  githubClient.issues.createComment({
+    owner,
+    repo,
+    number,
+    body
+  }, (err) => {
+    if (err) {
+      logger.error(err, 'Error while creating comment on GitHub')
+    }
+  })
+}

lib/push-jenkins-update.js

@@ -3,6 +3,7 @@
 const url = require('url')
 
 const githubClient = require('./github-client')
+const { createPrComment } = require('./github-comment')
 
 function pushStarted (options, build, cb) {
   const pr = findPrInRef(build.ref)
@@ -13,6 +14,10 @@ function pushStarted (options, build, cb) {
 
   const optsWithPr = Object.assign({ pr }, options)
 
+  if (build.identifier === 'node-test-pull-request') {
+    createPrComment(Object.assign({ number: pr }, options), `CI: ${build.url}`)
+  }
+
   findLatestCommitInPr(optsWithPr, (err, latestCommit) => {
     if (err) {
       logger.error(err, 'Got error when retrieving GitHub commits for PR')

scripts/trigger-jenkins-build.js

@@ -4,6 +4,7 @@ const request = require('request')
 
 const githubClient = require('../lib/github-client')
 const botUsername = require('../lib/bot-username')
+const { createPrComment } = require('../lib/github-comment')
 
 const jenkinsApiCredentials = process.env.JENKINS_API_CREDENTIALS || ''
 
@@ -85,19 +86,6 @@ function triggerBuild (options, cb) {
   })
 }
 
-function createPrComment ({ owner, repo, number, logger }, body) {
-  githubClient.issues.createComment({
-    owner,
-    repo,
-    number,
-    body
-  }, (err) => {
-    if (err) {
-      logger.error(err, 'Error while creating comment to reply on CI run comment')
-    }
-  })
-}
-
 function triggerBuildIfValid (options) {
   const { owner, repo, author, logger } = options
 

test/_fixtures/jenkins-test-pull-request-success-payload.json

@@ -0,0 +1,8 @@
+{
+  "identifier": "node-test-pull-request",
+  "status": "success",
+  "message": "tests passed",
+  "commit": "8a5fec2a6bade91e544a30314d7cf21f8a200de1",
+  "url": "https://ci.nodejs.org/job/node-test-pull-request/21633/",
+  "ref": "refs/pull/12345/head"
+}

test/integration/push-jenkins-update.test.js

@@ -110,6 +110,32 @@ tap.test('Forwards payload provided in incoming POST to GitHub status API', (t)
     })
 })
 
+tap.test('Posts a CI comment in the related PR when Jenkins build is named node-test-pull-request', (t) => {
+  const fixture = readFixture('jenkins-test-pull-request-success-payload.json')
+  const commentScope = nock('https://api.github.com')
+                        .filteringPath(ignoreQueryParams)
+                        .post('/repos/nodejs/node/issues/12345/comments', { body: 'CI: https://ci.nodejs.org/job/node-test-pull-request/21633/' })
+                        .reply(200)
+
+  // we don't care about asserting the scopes below, just want to stop the requests from actually being sent
+  setupGetCommitsMock('node')
+  nock('https://api.github.com')
+    .filteringPath(ignoreQueryParams)
+    .post('/repos/nodejs/node/statuses/8a5fec2a6bade91e544a30314d7cf21f8a200de1')
+    .reply(201)
+
+  t.plan(1)
+  t.tearDown(() => commentScope.done())
+
+  supertest(app)
+    .post('/node/jenkins/start')
+    .send(fixture)
+    .expect(201)
+    .end((err, res) => {
+      t.equal(err, null)
+    })
+})
+
 tap.test('Responds with 400 / "Bad request" when incoming request has invalid payload', (t) => {
   const fixture = readFixture('invalid-payload.json')