Merge pull request #39 from screwdriver-cd/description

fix: includes pipelineId in description

Author: minzcmu

index.js

@@ -572,11 +572,16 @@ class BitbucketScm extends Scm {
      * @param  {String}   config.buildStatus  The screwdriver build status to translate into scm commit status
      * @param  {String}   config.token        The token used to authenticate to the SCM
      * @param  {String}   config.url          Target Url of this commit status
-     * @param  {String}   [config.jobName]    Optional name of the job that finished
+     * @param  {String}   config.jobName      Optional name of the job that finished
+     * @param  {Number}   config.pipelineId   Pipeline ID
      * @return {Promise}
      */
     _updateCommitStatus(config) {
         const scm = getScmUriParts(config.scmUri);
+        let context = `Screwdriver/${config.pipelineId}/`;
+
+        context += /^PR/.test(config.jobName) ? 'PR' : config.jobName;
+
         const options = {
             url: `${REPO_URL}/${scm.repoId}/commit/${config.sha}/statuses/build`,
             method: 'POST',
@@ -585,7 +590,7 @@ class BitbucketScm extends Scm {
                 url: config.url,
                 state: STATE_MAP[config.buildStatus],
                 key: config.sha,
-                description: config.jobName ? `Screwdriver/${config.jobName}` : 'Screwdriver'
+                description: context
             },
             auth: {
                 bearer: decodeURIComponent(config.token)

package.json

@@ -49,7 +49,7 @@
     "hoek": "^4.1.0",
     "joi": "^10.0.5",
     "request": "^2.75.0",
-    "screwdriver-data-schema": "^16.0.0",
+    "screwdriver-data-schema": "^16.9.2",
     "screwdriver-scm-base": "^2.5.1"
   }
 }

test/index.test.js

@@ -1034,7 +1034,8 @@ describe('index', function () {
                 buildStatus: 'SUCCESS',
                 token: 'bearerToken',
                 url: 'http://valid.url',
-                jobName: 'main'
+                jobName: 'main',
+                pipelineId: 123
             };
             apiUrl = `${API_URL_V2}/repositories/repoId/commit/${config.sha}/statuses/build`;
             fakeResponse = {
@@ -1048,7 +1049,7 @@ describe('index', function () {
                     url: config.url,
                     state: 'SUCCESSFUL',
                     key: config.sha,
-                    description: 'Screwdriver/main'
+                    description: 'Screwdriver/123/main'
                 },
                 auth: {
                     bearer: 'bearerToken'     // Decoded access token
@@ -1057,24 +1058,21 @@ describe('index', function () {
             requestMock.yieldsAsync(null, fakeResponse);
         });
 
-        it('successfully update status', () =>
-            scm.updateCommitStatus(config).then(() => {
-                assert.calledWith(requestMock, expectedOptions);
-            })
-        );
-
-        it('successfully update status with correct values', () => {
-            config.buildStatus = 'ABORTED';
-            delete config.jobName;
-
-            expectedOptions.body.state = 'STOPPED';
-            expectedOptions.body.description = 'Screwdriver';
+        it('successfully update status for PR', () => {
+            config.jobName = 'PR-1';
+            expectedOptions.body.description = 'Screwdriver/123/PR';
 
             return scm.updateCommitStatus(config).then(() => {
                 assert.calledWith(requestMock, expectedOptions);
             });
         });
 
+        it('successfully update status', () =>
+            scm.updateCommitStatus(config).then(() => {
+                assert.calledWith(requestMock, expectedOptions);
+            })
+        );
+
         it('rejects if status code is not 201 or 200', () => {
             fakeResponse = {
                 statusCode: 401,