update status messages

Author: podviaznikov

lib/models/apis/pullrequest.js

@@ -7,127 +7,139 @@ function PullRequest (githubToken) {
   this.github = new Github({token: githubToken});
 }
 
-PullRequest.prototype.buildStarted = function (repo, commit, targetUrl, cb) {
+PullRequest.prototype.buildStarted = function (pullRequestInfo, targetUrl, cb) {
   debug('buildStarted', formatArgs(arguments));
   if (process.env.ENABLE_GITHUB_PR_STATUSES !== 'true') {
     return cb(null);
   }
   var payload = {
     state: 'pending',
-    description: 'A build has been started.',
+    description: 'PR-' + pullRequestInfo.number + ' is building on Runnable.',
     // we use url to differentiate between several runnable builds
     context: targetUrl,
     target_url: targetUrl,
-    sha: commit
+    sha: pullRequestInfo.commit
   };
-  this.github.createBuildStatus(repo, payload, cb);
+  this.github.createBuildStatus(pullRequestInfo.repo, payload, cb);
 };
 
-PullRequest.prototype.buildSucceeded = function (repo, commit, targetUrl, cb) {
+PullRequest.prototype.buildSucceeded = function (pullRequestInfo, targetUrl, cb) {
   debug('buildSucceeded', formatArgs(arguments));
   if (process.env.ENABLE_GITHUB_PR_STATUSES !== 'true') {
     return cb(null);
   }
   var payload = {
     state: 'success',
-    description: 'A build has been completed.',
+    description: 'PR-' + pullRequestInfo.number + ' is ready to run on Runnable.',
     // we use url to differentiate between several runnable builds
     context: targetUrl,
     target_url: targetUrl,
-    sha: commit
+    sha: pullRequestInfo.commit
   };
-  this.github.createBuildStatus(repo, payload, cb);
+  this.github.createBuildStatus(pullRequestInfo.repo, payload, cb);
 };
 
-PullRequest.prototype.buildErrored = function (repo, commit, targetUrl, cb) {
+PullRequest.prototype.buildErrored = function (pullRequestInfo, targetUrl, cb) {
   debug('buildErrored', formatArgs(arguments));
   if (process.env.ENABLE_GITHUB_PR_STATUSES !== 'true') {
     return cb(null);
   }
   var payload = {
     state: 'error',
-    description: 'A build has been completed with an error.',
+    description: 'Select a server to build PR-' + pullRequestInfo.number,
     // we use url to differentiate between several runnable builds
     context: targetUrl,
-    target_url: targetUrl
+    target_url: targetUrl,
+    sha: pullRequestInfo.commit
   };
-  this.github.createBuildStatus(repo, commit, payload, cb);
+  this.github.createBuildStatus(pullRequestInfo.repo, payload, cb);
 };
 
-PullRequest.prototype.serverSelectionStatus = function (repo, commit, targetUrl, cb) {
+PullRequest.prototype.serverSelectionStatus = function (pullRequestInfo, targetUrl, cb) {
   debug('buildStarted', formatArgs(arguments));
   if (process.env.ENABLE_GITHUB_PR_STATUSES !== 'true') {
     return cb(null);
   }
   var payload = {
     state: 'pending',
-    description: 'Select a server to run this Pull Request',
+    description: 'PR-' + pullRequestInfo.number + ' is ready to run on Runnable.',
     // we use url to differentiate between several runnable builds
     context: targetUrl,
     target_url: targetUrl,
-    sha: commit
+    sha: pullRequestInfo.commit
   };
-  this.github.createBuildStatus(repo, payload, cb);
+  this.github.createBuildStatus(pullRequestInfo.repo, payload, cb);
 };
 
 
-PullRequest.prototype.createDeployment = function (repo, commit, payload, cb) {
+PullRequest.prototype.createDeployment = function (pullRequestInfo, serverName, payload, cb) {
   debug('createDeployment', formatArgs(arguments));
   if (process.env.ENABLE_GITHUB_PR_STATUSES !== 'true') {
     return cb(null);
   }
+  var description = 'Deploying PR-' + pullRequestInfo.number + ' to ' +
+    serverName + ' on Runnable.';
   var query = {
     auto_merge: false,
     environment: 'runnable',
-    description: 'Deploying code to the runnable sandbox.',
-    ref: commit,
+    description: description,
+    ref: pullRequestInfo.commit,
     payload: JSON.stringify(payload || {}),
     required_contexts: [] // we skip check on all `contexts` since we still can deploy
   };
-  this.github.createDeployment(repo, query, cb);
+  this.github.createDeployment(pullRequestInfo.repo, query, cb);
 };
 
 
-PullRequest.prototype.deploymentStarted = function (repo, deploymentId, targetUrl, cb) {
+PullRequest.prototype.deploymentStarted =
+function (pullRequestInfo, deploymentId, serverName, targetUrl, cb) {
   debug('deploymentStarted', formatArgs(arguments));
   if (process.env.ENABLE_GITHUB_PR_STATUSES !== 'true') {
     return cb(null);
   }
+  var description = 'Deploying PR-' + pullRequestInfo.number + ' to ' +
+    serverName + ' on Runnable.';
   var payload = {
     id: deploymentId,
     state: 'pending',
     target_url: targetUrl,
-    description: 'Deployment has been started.'
+    description: description
   };
-  this.github.createDeploymentStatus(repo, payload, cb);
+  this.github.createDeploymentStatus(pullRequestInfo.repo, payload, cb);
 };
 
-PullRequest.prototype.deploymentSucceeded = function (repo, deploymentId, targetUrl, cb) {
+PullRequest.prototype.deploymentSucceeded =
+function (pullRequestInfo, deploymentId, serverName, targetUrl, cb) {
   debug('deploymentSucceeded', formatArgs(arguments));
   if (process.env.ENABLE_GITHUB_PR_STATUSES !== 'true') {
     return cb(null);
   }
+  var description = 'Deployed PR-' + pullRequestInfo.number +
+    ' to ' + serverName + ' on Runnable.';
   var payload = {
     id: deploymentId,
     state: 'success',
     target_url: targetUrl,
-    description: 'Deployment has been completed.'
+    description: description
   };
-  this.github.createDeploymentStatus(repo, payload, cb);
+  this.github.createDeploymentStatus(pullRequestInfo.repo, payload, cb);
 };
 
-PullRequest.prototype.deploymentErrored = function (repo, deploymentId, targetUrl, cb) {
+PullRequest.prototype.deploymentErrored =
+function (pullRequestInfo, deploymentId, serverName, targetUrl, cb) {
   debug('deploymentErrored', formatArgs(arguments));
   if (process.env.ENABLE_GITHUB_PR_STATUSES !== 'true') {
     return cb(null);
   }
+  var description = 'Failed to deploy PR-' + pullRequestInfo.number +
+    ' to ' + serverName + ' on Runnable.';
   var payload = {
     id: deploymentId,
     state: 'error',
     target_url: targetUrl,
-    description: 'Deployment has been completed with an error.'
+    description: description
   };
-  this.github.createDeploymentStatus(repo, payload, cb);
+  this.github.createDeploymentStatus(pullRequestInfo.repo, payload, cb);
 };
 
 module.exports = PullRequest;

lib/routes/actions/github.js

@@ -143,8 +143,7 @@ function notServersForPullRequest () {
       next();
     },
     pullRequest.create('versionCreator.accounts.github.accessToken'),
-    pullRequest.model.serverSelectionStatus('githubPullRequest.repo',
-      'githubPullRequest.commit', 'serverSelectionUrl'),
+    pullRequest.model.serverSelectionStatus('githubPullRequest', 'serverSelectionUrl'),
     mw.res.status(201),
     mw.res.json('contextVersionIds')
   );
@@ -195,8 +194,7 @@ function followBranch (instancesKey) {
       mw.req('creatorGithubId').validate(validations.equalsKeypath('githubPullRequest.creator.id'))
         .then(
           pullRequest.create('instanceCreator.accounts.github.accessToken'),
-          pullRequest.model.buildStarted('githubPullRequest.repo',
-            'githubPullRequest.commit', 'targetUrl')
+          pullRequest.model.buildStarted('githubPullRequest', 'targetUrl')
         ),
       newContextVersion('contextVersion'), // replaces context version!
       flow.try(
@@ -255,8 +253,7 @@ function followBranch (instancesKey) {
           validations.equalsKeypath('githubPullRequest.creator.id'))
           .then(
             pullRequest.create('instanceCreator.accounts.github.accessToken'),
-            pullRequest.model.buildErrored('githubPullRequest.repo',
-              'githubPullRequest.commit', 'targetUrl')
+            pullRequest.model.buildErrored('githubPullRequest', 'targetUrl')
           )
       )
     ),
@@ -281,8 +278,7 @@ function followBranch (instancesKey) {
             var instanceCreator = infoObject.instanceCreator;
             var prData = req.githubPullRequest;
             pullRequest.create(instanceCreator.accounts.github.accessToken);
-            pullRequest.model.buildErrored(prData.repo, prData.commit,
-              infoObject.targetUrl)(req, res, next);
+            pullRequest.model.buildErrored(prData, infoObject.targetUrl)(req, res, next);
           });
         }
       }),
@@ -302,18 +298,17 @@ function followBranch (instancesKey) {
         mw.req('creatorGithubId').validate(
           validations.equalsKeypath('githubPullRequest.creator.id'))
             .then(
-              pullRequest.model.buildSucceeded('githubPullRequest.repo',
-                'githubPullRequest.commit', 'targetUrl')
+              pullRequest.model.buildSucceeded('githubPullRequest', 'targetUrl')
         ),
         timers.create(),
         timers.model.startTimer('timerId'),
-        pullRequest.model.createDeployment('githubPullRequest.repo', 'githubPullRequest.commit', {
+        pullRequest.model.createDeployment('githubPullRequest', 'instance.name', {
           instanceId: 'instance._id.toString()',
         }),
         mw.req().set('deploymentId', 'pullrequestResult.id'),
         flow.try(
-          pullRequest.model.deploymentStarted('githubPullRequest.repo',
-            'deploymentId', 'targetUrl'),
+          pullRequest.model.deploymentStarted('githubPullRequest',
+            'deploymentId', 'instance.name', 'targetUrl'),
           // we cannot use pushSessionUser, bc patch requires token
           // we must reinstantiate runnable model for each call bc of a bug
           runnable.create({}, 'instanceCreator'),
@@ -323,12 +318,12 @@ function followBranch (instancesKey) {
           // we must reinstantiate runnable model for each call bc of a bug
           runnable.create({}, 'instanceCreator'),
           runnable.model.waitForInstanceDeployed('instance.shortHash'),
-          pullRequest.model.deploymentSucceeded('githubPullRequest.repo',
-            'deploymentId', 'targetUrl')
+          pullRequest.model.deploymentSucceeded('githubPullRequest',
+            'deploymentId', 'instance.name', 'targetUrl')
         ).catch(
           error.logIfErrMw,
-          pullRequest.model.deploymentErrored('githubPullRequest.repo',
-            'deploymentId', 'targetUrl')
+          pullRequest.model.deploymentErrored('githubPullRequest',
+            'deploymentId', 'instance.name', 'targetUrl')
         ),
         instanceAutoDeployDone()
       )

templates/github_pull_request_choose_server.hbs

@@ -184,7 +184,7 @@ describe('Github - /actions/github', function () {
       it('should set deployment status to error if error happened during instance update', {timeout: 6000},
         function (done) {
           var baseDeploymentId = 100000;
-          PullRequest.createDeployment = function (repo, commit, payload, cb) {
+          PullRequest.createDeployment = function (pullRequest, serverName, payload, cb) {
             cb(null, {id: baseDeploymentId});
           };
 
@@ -193,8 +193,9 @@ describe('Github - /actions/github', function () {
             cb(Boom.notFound('Instance update failed'));
           };
 
-          PullRequest.prototype.deploymentErrored = function (repo, deploymentId, targetUrl) {
-            expect(repo).to.exist();
+          PullRequest.prototype.deploymentErrored = function (pullRequest, deploymentId, serverName, targetUrl) {
+            expect(pullRequest).to.exist();
+            expect(serverName).to.exist();
             expect(targetUrl).to.include('https://runnable.io/');
             done();
           };
@@ -221,7 +222,7 @@ describe('Github - /actions/github', function () {
       it('should set deployment status to error if error happened during instance deployment', {timeout: 6000},
         function (done) {
           var baseDeploymentId = 100000;
-          PullRequest.createDeployment = function (repo, commit, payload, cb) {
+          PullRequest.createDeployment = function (pullRequest, serverName, payload, cb) {
             cb(null, {id: baseDeploymentId});
           };
 
@@ -230,8 +231,9 @@ describe('Github - /actions/github', function () {
             cb(Boom.notFound('Instance deploy failed'));
           };
 
-          PullRequest.prototype.deploymentErrored = function (repo, deploymentId, targetUrl) {
-            expect(repo).to.exist();
+          PullRequest.prototype.deploymentErrored = function (pullRequest, deploymentId, serverName, targetUrl) {
+            expect(pullRequest).to.exist();
+            expect(serverName).to.exist();
             expect(targetUrl).to.include('https://runnable.io/');
             done();
           };
@@ -276,7 +278,7 @@ describe('Github - /actions/github', function () {
           var spyOnClassMethod = require('function-proxy').spyOnClassMethod;
           var baseDeploymentId = 1234567;
           spyOnClassMethod(require('models/apis/pullrequest'), 'createDeployment',
-            function (repo, commit, payload, cb) {
+            function (pullRequest, serverName, payload, cb) {
               baseDeploymentId++;
               cb(null, {id: baseDeploymentId});
             });
@@ -301,8 +303,9 @@ describe('Github - /actions/github', function () {
             }));
           });
           spyOnClassMethod(require('models/apis/pullrequest'), 'deploymentSucceeded',
-            function (repo, deploymentId, targetUrl) {
-              expect(repo).to.exist();
+            function (pullRequest, deploymentId, serverName, targetUrl) {
+              expect(pullRequest).to.exist();
+              expect(serverName).to.exist();
               expect([1234568, 1234569]).to.contain(deploymentId);
               expect(targetUrl).to.include('https://runnable.io/');
               count.next();