screwdriver-api 8.0.38 → 8.0.40

package/package.json

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

package/plugins/builds/helper/updateBuild.js

@@ -3,8 +3,8 @@
 const boom = require('@hapi/boom');
 const hoek = require('@hapi/hoek');
 const merge = require('lodash.mergewith');
+const { PR_JOB_NAME, PR_STAGE_NAME, STAGE_TEARDOWN_PATTERN } = require('screwdriver-data-schema').config.regex;
 const { getFullStageJobName } = require('../../helper');
-const STAGE_TEARDOWN_PATTERN = /^stage@([\w-]+)(?::teardown)$/;
 const TERMINAL_STATUSES = ['FAILURE', 'ABORTED', 'UNSTABLE', 'COLLAPSED'];
 const FINISHED_STATUSES = ['FAILURE', 'SUCCESS', 'ABORTED', 'UNSTABLE', 'COLLAPSED'];
 
@@ -121,13 +121,18 @@ function updateBuildStatus(build, desiredStatus, statusMessage, statusMessageTyp
  * @return {Stage}                          Stage for node
  */
 async function getStage({ stageFactory, workflowGraph, jobName, pipelineId }) {
-    const currentNode = workflowGraph.nodes.find(node => node.name === jobName);
+    const prJobName = jobName.match(PR_JOB_NAME);
+    const nodeName = prJobName ? prJobName[2] : jobName;
+
+    const currentNode = workflowGraph.nodes.find(node => node.name === nodeName);
     let stage = null;
 
     if (currentNode && currentNode.stageName) {
+        const stageName = prJobName ? `${prJobName[1]}:${currentNode.stageName}` : currentNode.stageName;
+
         stage = await stageFactory.get({
             pipelineId,
-            name: currentNode.stageName
+            name: stageName
         });
     }
 
@@ -143,19 +148,24 @@ async function getStage({ stageFactory, workflowGraph, jobName, pipelineId }) {
  * @return {Promise<Build[]>}              Builds in stage
  */
 async function getStageJobBuilds({ stage, event, jobFactory }) {
+    const prStageName = stage.name.match(PR_STAGE_NAME);
+    const stageName = prStageName ? prStageName[2] : stage.name;
+
     // Get all jobIds for jobs in the stage
     const stageNodes = event.workflowGraph.nodes.filter(n => {
         const jobName = n.name.split(':')[1];
 
-        return n.stageName === stage.name && jobName !== 'teardown';
+        return n.stageName === stageName && jobName !== 'teardown';
     });
+
     const stageJobIds = await Promise.all(
         stageNodes.map(async n => {
             if (n.id) {
                 return n.id;
             }
 
-            const job = await jobFactory.get({ pipelineId: event.pipelineId, name: n.name });
+            const jobName = prStageName ? `${prStageName[1]}:${n.name}` : n.name;
+            const job = await jobFactory.get({ pipelineId: event.pipelineId, name: jobName });
 
             return job.id;
         })
@@ -333,6 +343,14 @@ async function updateBuildAndTriggerDownstreamJobs(config, build, server, userna
         }
 
         stageBuildHasFailure = TERMINAL_STATUSES.includes(stageBuild.status);
+
+        // Create a stage teardown build
+        if (!isStageTeardown) {
+            await createOrUpdateStageTeardownBuild(
+                { pipeline, job, build, username, scmContext, event, stage },
+                server.app
+            );
+        }
     }
 
     // Guard against triggering non-successful or unstable builds
@@ -341,13 +359,6 @@ async function updateBuildAndTriggerDownstreamJobs(config, build, server, userna
         // Check for failed jobs and remove any child jobs in created state
         if (newBuild.status === 'FAILURE') {
             await removeJoinBuilds({ pipeline, job, build: newBuild, event: newEvent, stage }, server.app);
-
-            if (stage && !isStageTeardown) {
-                await createOrUpdateStageTeardownBuild(
-                    { pipeline, job, build, username, scmContext, event, stage },
-                    server.app
-                );
-            }
         }
         // Do not continue downstream is current job is stage teardown and statusBuild has failure
     } else if (newBuild.status === 'SUCCESS' && isStageTeardown && stageBuildHasFailure) {
@@ -373,6 +384,7 @@ async function updateBuildAndTriggerDownstreamJobs(config, build, server, userna
                 stageTeardownBuild.status = 'QUEUED';
                 stageTeardownBuild.parentBuildId = stageJobBuilds.map(b => b.id);
 
+                // TODO: Handle if a teardown job is virtual
                 await stageTeardownBuild.update();
                 await stageTeardownBuild.start();
             }

package/plugins/builds/index.js

@@ -2,6 +2,7 @@
 
 const logger = require('screwdriver-logger');
 const workflowParser = require('screwdriver-workflow-parser');
+const { STAGE_TEARDOWN_PATTERN } = require('screwdriver-data-schema').config.regex;
 const hoek = require('@hapi/hoek');
 const getRoute = require('./get');
 const getBuildStatusesRoute = require('./getBuildStatuses');
@@ -39,7 +40,8 @@ const {
     getParallelBuilds,
     isStartFromMiddleOfCurrentStage,
     Status,
-    getSameParentEvents
+    getSameParentEvents,
+    getNextJobStageName
 } = require('./triggers/helpers');
 const { getFullStageJobName } = require('../helper');
 
@@ -99,7 +101,7 @@ async function triggerNextJobs(config, app) {
         const nextJob = await getJob(nextJobName, currentPipeline.id, jobFactory);
         const node = currentEvent.workflowGraph.nodes.find(n => n.name === trimJobName(nextJobName));
         const isNextJobVirtual = node.virtual || false;
-        const nextJobStageName = node.stageName || null;
+        const nextJobStageName = getNextJobStageName({ stageName: node.stageName, nextJobName });
         const resource = `pipeline:${currentPipeline.id}:groupEvent:${currentEvent.groupEventId}`;
         let lock;
         let nextBuild;
@@ -289,7 +291,7 @@ async function triggerNextJobs(config, app) {
                 const nextJob = await getJob(nextJobName, joinedPipelineId, jobFactory);
                 const node = externalEvent.workflowGraph.nodes.find(n => n.name === trimJobName(nextJobName));
                 const isNextJobVirtual = node.virtual || false;
-                const nextJobStageName = node.stageName || null;
+                const nextJobStageName = getNextJobStageName({ stageName: node.stageName, nextJobName });
 
                 const { parentBuilds } = parseJobInfo({
                     joinObj: joinedPipeline.jobs,
@@ -469,29 +471,33 @@ const buildsPlugin = {
 
                 for (const nextJobName of Object.keys(pipelineJoinData[pid].jobs)) {
                     try {
-                        const nextJob = pipelineJoinData[pid].jobs[nextJobName];
+                        const isNextJobStageTeardown = STAGE_TEARDOWN_PATTERN.test(nextJobName);
 
-                        buildConfig.jobId = nextJob.id;
-                        if (!isExternal) {
-                            buildConfig.eventId = event.id;
-                        } else {
-                            buildConfig.eventId = hoek.reach(pipelineJoinData[pid], 'event.id');
-                        }
+                        if (!isNextJobStageTeardown) {
+                            const nextJob = pipelineJoinData[pid].jobs[nextJobName];
 
-                        if (buildConfig.eventId) {
-                            if (current.stage) {
-                                const stageTeardownName = getFullStageJobName({
-                                    stageName: current.stage.name,
-                                    jobName: 'teardown'
-                                });
+                            buildConfig.jobId = nextJob.id;
+                            if (!isExternal) {
+                                buildConfig.eventId = event.id;
+                            } else {
+                                buildConfig.eventId = hoek.reach(pipelineJoinData[pid], 'event.id');
+                            }
 
-                                // Do not remove stage teardown builds as they need to be executed on stage failure as well.
-                                if (nextJobName !== stageTeardownName) {
-                                    deletePromises.push(deleteBuild(buildConfig, buildFactory));
+                            if (buildConfig.eventId) {
+                                if (current.stage) {
+                                    const stageTeardownName = getFullStageJobName({
+                                        stageName: current.stage.name,
+                                        jobName: 'teardown'
+                                    });
+
+                                    // Do not remove stage teardown builds as they need to be executed on stage failure as well.
+                                    if (nextJobName !== stageTeardownName) {
+                                        deletePromises.push(deleteBuild(buildConfig, buildFactory));
+                                    }
                                 }
-                            }
 
-                            deletePromises.push(deleteBuild(buildConfig, buildFactory));
+                                deletePromises.push(deleteBuild(buildConfig, buildFactory));
+                            }
                         }
                     } catch (err) {
                         logger.error(

package/plugins/builds/triggers/helpers.js

@@ -4,7 +4,7 @@ const logger = require('screwdriver-logger');
 const workflowParser = require('screwdriver-workflow-parser');
 const merge = require('lodash.mergewith');
 const schema = require('screwdriver-data-schema');
-const { EXTERNAL_TRIGGER_ALL, STAGE_SETUP_PATTERN } = schema.config.regex;
+const { EXTERNAL_TRIGGER_ALL, STAGE_SETUP_PATTERN, PR_JOB_NAME } = schema.config.regex;
 const { getFullStageJobName } = require('../../helper');
 const BUILD_STATUS_MESSAGES = {
     SKIP_VIRTUAL_JOB: {
@@ -373,27 +373,15 @@ async function createInternalBuild(config) {
     return null;
 }
 
-/**
- * Return PR job or not
- * PR job name certainly has ":". e.g. "PR-1:jobName"
- * @param {String} jobName
- * @returns {Boolean}
- */
-function isPR(jobName) {
-    return jobName.startsWith('PR-');
-}
-
 /**
  * Trim Job name to follow data-schema
  * @param {String} jobName
  * @returns {String} trimmed jobName
  */
 function trimJobName(jobName) {
-    if (isPR(jobName)) {
-        return jobName.split(':')[1];
-    }
+    const matched = jobName.match(PR_JOB_NAME);
 
-    return jobName;
+    return matched ? matched[2] : jobName;
 }
 
 /**
@@ -1175,6 +1163,22 @@ function getStageName(workflowGraph, jobName) {
     return jobNode ? jobNode.stageName : null;
 }
 
+/**
+ * get the stage name of a next job (foo or PR-123:foo)
+ * @param  {String} nextJobName             Next jobob name
+ * @param  {String} stageName               Stage name (Not have PR-xxx)
+ * @return {String}                         Stage name
+ */
+function getNextJobStageName({ stageName, nextJobName }) {
+    if (!stageName) {
+        return null;
+    }
+
+    const matched = nextJobName.match(PR_JOB_NAME);
+
+    return matched ? `${matched[1]}:${stageName}` : stageName;
+}
+
 /**
  * Check if the current job is a stage setup and the next job is a non-setup job in the same stage
  * @param {String} currentJobName            Current job
@@ -1215,5 +1219,6 @@ module.exports = {
     trimJobName,
     isStartFromMiddleOfCurrentStage,
     hasFreezeWindows,
+    getNextJobStageName,
     BUILD_STATUS_MESSAGES
 };

package/plugins/helper.js

@@ -2,8 +2,10 @@
 
 const boom = require('@hapi/boom');
 const dayjs = require('dayjs');
+const schema = require('screwdriver-data-schema');
 const STAGE_PREFIX = 'stage@';
 const STAGE_TEARDOWN_PATTERN = /^stage@([\w-]+):teardown$/;
+const { PR_STAGE_NAME } = schema.config.regex;
 
 /**
  * Set default start time and end time
@@ -111,7 +113,11 @@ async function getScmUri({ pipeline, pipelineFactory }) {
  * @return {String}                         Full stage name
  */
 function getFullStageJobName({ stageName, jobName }) {
-    return `${STAGE_PREFIX}${stageName}:${jobName}`;
+    const prStage = stageName.match(PR_STAGE_NAME);
+
+    return prStage
+        ? `${prStage[1]}:${STAGE_PREFIX}${prStage[2]}:${jobName}` // PR-123:stage@staging:deploy
+        : `${STAGE_PREFIX}${stageName}:${jobName}`; // stage@staging:deploy
 }
 
 /**