screwdriver-api 4.1.192 → 4.1.196

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "4.1.192",
+  "version": "4.1.196",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {

package/plugins/pipelines/create.js

@@ -5,6 +5,7 @@ const schema = require('screwdriver-data-schema');
 const urlLib = require('url');
 const { formatCheckoutUrl, sanitizeRootDir } = require('./helper');
 const { getUserPermissions } = require('../helper');
+const ANNOTATION_USE_DEPLOY_KEY = 'screwdriver.cd/useDeployKey';
 
 module.exports = () => ({
     method: 'POST',
@@ -89,7 +90,10 @@ module.exports = () => ({
 
                 await defaultCollection.update();
             }
-            if (autoKeysGeneration) {
+            // check if pipeline has deploy key annotation then create secrets
+            const deployKeyAnnotation = pipeline.annotations && pipeline.annotations[ANNOTATION_USE_DEPLOY_KEY]
+      
+            if (autoKeysGeneration || deployKeyAnnotation) {
                 const privateDeployKey = await pipelineFactory.scm.addDeployKey({
                     scmContext,
                     checkoutUrl,

package/plugins/pipelines/update.js

@@ -6,6 +6,7 @@ const schema = require('screwdriver-data-schema');
 const idSchema = schema.models.pipeline.base.extract('id');
 const { formatCheckoutUrl, sanitizeRootDir } = require('./helper');
 const { getUserPermissions } = require('../helper');
+const ANNOTATION_USE_DEPLOY_KEY = 'screwdriver.cd/useDeployKey';
 
 /**
  * Get user permissions on old pipeline
@@ -45,10 +46,11 @@ module.exports = () => ({
         handler: async (request, h) => {
             const { checkoutUrl, rootDir, settings } = request.payload;
             const { id } = request.params;
-            const { pipelineFactory, userFactory } = request.server.app;
+            const { pipelineFactory, userFactory, secretFactory } = request.server.app;
             const { scmContext, username } = request.auth.credentials;
             const scmContexts = pipelineFactory.scm.getScmContexts();
             const { isValidToken } = request.server.plugins.pipelines;
+            const deployKeySecret = 'SD_SCM_DEPLOY_KEY';
 
             if (!isValidToken(id, request.auth.credentials)) {
                 return boom.unauthorized('Token does not have permission to this pipeline');
@@ -83,12 +85,15 @@ module.exports = () => ({
                 throw boom.forbidden(`User ${user.getFullDisplayName()} does not have admin permission for this repo`);
             }
 
+            let token;
+            let formattedCheckoutUrl;
+
             if (checkoutUrl || rootDir) {
-                const formattedCheckoutUrl = formatCheckoutUrl(request.payload.checkoutUrl);
+                formattedCheckoutUrl = formatCheckoutUrl(request.payload.checkoutUrl);
                 const sanitizedRootDir = sanitizeRootDir(request.payload.rootDir);
 
                 // get the user token
-                const token = await user.unsealToken();
+                token = await user.unsealToken();
                 // get the scm URI
                 const scmUri = await pipelineFactory.scm.parseUrl({
                     scmContext,
@@ -136,6 +141,32 @@ module.exports = () => ({
             // update pipeline
             const updatedPipeline = await oldPipeline.update();
 
+            // check if pipeline has deploy key annotation then create secrets
+            const deployKeyAnnotation = oldPipeline.annotations && oldPipeline.annotations[ANNOTATION_USE_DEPLOY_KEY]
+
+            if (deployKeyAnnotation) {
+                const deploySecret = await secretFactory.get({
+                    pipelineId: oldPipeline.id,
+                    name: deployKeySecret,
+                })
+
+                if (!deploySecret) {
+                    const privateDeployKey = await pipelineFactory.scm.addDeployKey({
+                        scmContext: oldPipeline.scmContext,
+                        checkoutUrl: formattedCheckoutUrl,
+                        token
+                    });
+                    const privateDeployKeyB64 = Buffer.from(privateDeployKey).toString('base64');
+
+                    await secretFactory.create({
+                        pipelineId: oldPipeline.id,
+                        name: deployKeySecret,
+                        value: privateDeployKeyB64,
+                        allowInPR: true
+                    });
+                }
+            }
+
             await updatedPipeline.addWebhooks(`${request.server.info.uri}/v4/webhooks`);
 
             const result = await updatedPipeline.sync();

package/plugins/webhooks/helper.js

@@ -347,6 +347,47 @@ async function triggeredPipelines(
     return currentRepoPipelines.concat(pipelinesWithSubscribedRepos);
 }
 
+/**
+ * Start Events
+ * @async  startEvents
+ * @param  {Array}  eventConfigs Array of event config objects
+ * @param  {Object} eventFactory Factory to create events
+ * @return {Promise<Array>}  Array of created events
+ */
+async function startEvents(eventConfigs, eventFactory) {
+    const events = [];
+    let errorCount = 0;
+    let eventsCount = 0;
+
+    const results = await Promise.allSettled(
+        eventConfigs.map(eventConfig => {
+            if (eventConfig && eventConfig.configPipelineSha) {
+                eventsCount += 1;
+
+                return eventFactory.create(eventConfig);
+            }
+
+            return Promise.resolve(null);
+        })
+    );
+
+    results.forEach((result, i) => {
+        if (result.status === 'fulfilled') {
+            if (result.value) events.push(result.value);
+        } else {
+            errorCount += 1;
+            logger.error(`pipeline:${eventConfigs[i].pipelineId} error in starting event`, result.value);
+        }
+    });
+
+    if (errorCount && errorCount === eventsCount) {
+        // preserve current behavior of returning 500 on error
+        throw new Error('Failed to start any events');
+    }
+
+    return events;
+}
+
 /**
  * Create events for each pipeline
  * @async  createPREvents
@@ -388,7 +429,6 @@ async function createPREvents(options, request) {
     const { eventFactory, pipelineFactory, userFactory } = request.server.app;
     const scmDisplayName = scm.getDisplayName({ scmContext: scmConfig.scmContext });
     const userDisplayName = `${scmDisplayName}:${username}`;
-    const events = [];
     let { sha } = options;
 
     scmConfig.prNum = prNum;
@@ -509,13 +549,9 @@ async function createPREvents(options, request) {
         })
     );
 
-    eventConfigs.forEach(eventConfig => {
-        if (eventConfig && eventConfig.configPipelineSha) {
-            events.push(eventFactory.create(eventConfig));
-        }
-    });
+    const events = await startEvents(eventConfigs, eventFactory);
 
-    return Promise.all(events);
+    return events;
 }
 
 /**
@@ -851,7 +887,6 @@ async function createEvents(
     scmConfigFromHook
 ) {
     const { action, branch, sha, username, scmContext, changedFiles, type, releaseName, ref } = parsed;
-    const events = [];
     const meta = createMeta(parsed);
 
     const pipelineTuples = await Promise.all(
@@ -991,13 +1026,9 @@ async function createEvents(
         })
     );
 
-    eventConfigs.forEach(eventConfig => {
-        if (eventConfig && eventConfig.configPipelineSha) {
-            events.push(eventFactory.create(eventConfig));
-        }
-    });
+    const events = await startEvents(eventConfigs, eventFactory);
 
-    return Promise.all(events);
+    return events;
 }
 
 /**