screwdriver-api 7.0.217 → 7.0.219

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "7.0.217",
+  "version": "7.0.219",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {
@@ -109,7 +109,7 @@
     "screwdriver-config-parser": "^11.0.0",
     "screwdriver-coverage-bookend": "^2.0.0",
     "screwdriver-coverage-sonar": "^4.1.1",
-    "screwdriver-data-schema": "^24.0.0",
+    "screwdriver-data-schema": "^24.1.0",
     "screwdriver-datastore-sequelize": "^9.0.0",
     "screwdriver-executor-base": "^10.0.0",
     "screwdriver-executor-docker": "^7.0.0",
@@ -118,7 +118,7 @@
     "screwdriver-executor-queue": "^5.0.0",
     "screwdriver-executor-router": "^4.0.0",
     "screwdriver-logger": "^2.0.0",
-    "screwdriver-models": "^30.0.0",
+    "screwdriver-models": "^30.2.0",
     "screwdriver-notifications-email": "^4.0.0",
     "screwdriver-notifications-slack": "^6.0.0",
     "screwdriver-request": "^2.0.1",

package/plugins/builds/README.md

@@ -75,12 +75,11 @@ Example payload:
 Arguments:
 
 * `type` - Return type for build artifact, `download` or `preview`
+* `dir` - If downloading directory or not (`true` or `false`, default `false`). Must be set with `type=download`.
 
 `GET /builds/{id}/artifacts/{name*}?type=preview`
 
-`GET /builds/{id}/artifacts/this/is/a/directory/path/?type=download`
-
-*Note: To download a directory, there must be a trailing slash (`/`) in the name and `type=download`.*
+`GET /builds/{id}/artifacts/this/is/a/directory/path?type=download&dir=true`
 
 #### Get build statuses
 `GET /builds/statuses`

package/plugins/builds/artifacts/get.js

@@ -50,9 +50,9 @@ module.exports = config => ({
                 .then(async () => {
                     // Directory should fetch manifest and
                     // gather all files that belong to that directory
-                    if (artifact.endsWith('/') && req.query.type === 'download') {
+                    if (req.query.dir && req.query.type === 'download') {
                         // Create a zip name from the directory structure
-                        const zipName = artifact.split('/').slice(-2)[0];
+                        const zipName = artifact.split('/').slice(-1)[0];
 
                         try {
                             const token = jwt.sign({
@@ -69,7 +69,7 @@ module.exports = config => ({
                                 method: 'GET'
                             }).text();
                             const manifestArray = manifest.trim().split('\n');
-                            const directoryArray = manifestArray.filter(f => f.startsWith(`./${artifact}`));
+                            const directoryArray = manifestArray.filter(f => f.startsWith(`./${artifact}/`));
 
                             // Create a stream and set up archiver
                             const archive = archiver('zip', { zlib: { level: 9 } });
@@ -100,7 +100,7 @@ module.exports = config => ({
                                         archive.emit('error', err); // Emit error to stop the archive process
                                     });
 
-                                    const relativePath = file.replace(`./${artifact}`, `./${zipName}/`);
+                                    const relativePath = file.replace(`./${artifact}/`, `./${zipName}/`);
 
                                     // Append the file stream to the archive with the correct relative path
                                     archive.append(fileStream, { name: relativePath });
@@ -168,7 +168,8 @@ module.exports = config => ({
                 name: artifactSchema
             }),
             query: joi.object({
-                type: typeSchema
+                type: typeSchema,
+                dir: joi.boolean().truthy('true').falsy('false').default(false)
             }).options({ allowUnknown: true })
         }
     }

package/plugins/builds/triggers/helpers.js

@@ -6,6 +6,12 @@ const merge = require('lodash.mergewith');
 const schema = require('screwdriver-data-schema');
 const { EXTERNAL_TRIGGER_ALL, STAGE_SETUP_PATTERN } = schema.config.regex;
 const { getFullStageJobName } = require('../../helper');
+const BUILD_STATUS_MESSAGES = {
+    SKIP_VIRTUAL_JOB: {
+        statusMessage: 'Skipped execution of the virtual job',
+        statusMessageType: 'INFO'
+    }
+};
 
 /**
  * @typedef {import('screwdriver-models').JobFactory} JobFactory
@@ -630,6 +636,8 @@ async function handleNewBuild({ done, hasFailure, newBuild, job, pipelineId, sta
 
     if (isVirtualJob && !hasFreezeWindows) {
         newBuild.status = Status.SUCCESS;
+        newBuild.statusMessage = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage;
+        newBuild.statusMessageType = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType;
 
         return newBuild.update();
     }
@@ -1158,5 +1166,6 @@ module.exports = {
     extractExternalJoinData,
     buildsToRestartFilter,
     trimJobName,
-    isStartFromMiddleOfCurrentStage
+    isStartFromMiddleOfCurrentStage,
+    BUILD_STATUS_MESSAGES
 };

package/plugins/builds/triggers/orBase.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { createInternalBuild, Status } = require('./helpers');
+const { createInternalBuild, Status, BUILD_STATUS_MESSAGES } = require('./helpers');
 
 /**
  * @typedef {import('screwdriver-models').BuildFactory} BuildFactory
@@ -58,6 +58,8 @@ class OrBase {
             // Bypass execution of the build if the job is virtual
             if (isNextJobVirtual && !hasFreezeWindows) {
                 nextBuild.status = Status.SUCCESS;
+                nextBuild.statusMessage = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage;
+                nextBuild.statusMessageType = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType;
 
                 return nextBuild.update();
             }
@@ -86,6 +88,8 @@ class OrBase {
         // Bypass execution of the build if the job is virtual
         if (isNextJobVirtual && !hasFreezeWindows) {
             nextBuild.status = Status.SUCCESS;
+            nextBuild.statusMessage = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage;
+            nextBuild.statusMessageType = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType;
 
             nextBuild = nextBuild.update();
         }

package/plugins/builds/update.js

@@ -129,12 +129,13 @@ async function validateUserPermission(build, request) {
 
 /**
  * Set build status to desired status, set build statusMessage
- * @param {Object} build         Build Model
- * @param {String} desiredStatus New Status
- * @param {String} statusMessage User passed status message
- * @param {String} username      User initiating status build update
+ * @param {Object} build                Build Model
+ * @param {String} desiredStatus        New Status
+ * @param {String} statusMessage        User passed status message
+ * @param {String} statusMessageType    User passed severity of the status message
+ * @param {String} username             User initiating status build update
  */
-function updateBuildStatus(build, desiredStatus, statusMessage, username) {
+function updateBuildStatus(build, desiredStatus, statusMessage, statusMessageType, username) {
     // UNSTABLE -> SUCCESS needs to update meta and endtime.
     // However, the status itself cannot be updated to SUCCESS
     const currentStatus = build.status;
@@ -152,9 +153,11 @@ function updateBuildStatus(build, desiredStatus, statusMessage, username) {
         } else if (build.status === 'FAILURE' || build.status === 'SUCCESS') {
             if (statusMessage) {
                 build.statusMessage = statusMessage;
+                build.statusMessageType = statusMessageType || null;
             }
         } else {
             build.statusMessage = statusMessage || null;
+            build.statusMessageType = statusMessageType || null;
         }
     }
 }
@@ -219,7 +222,7 @@ module.exports = () => ({
         handler: async (request, h) => {
             const { buildFactory, eventFactory, jobFactory, stageFactory, stageBuildFactory } = request.server.app;
             const { id } = request.params;
-            const { statusMessage, stats, status: desiredStatus } = request.payload;
+            const { statusMessage, statusMessageType, stats, status: desiredStatus } = request.payload;
             const { username, scmContext, scope } = request.auth.credentials;
             const isBuild = scope.includes('build') || scope.includes('temporal');
             const { triggerNextJobs, removeJoinBuilds, createOrUpdateStageTeardownBuild } =
@@ -246,6 +249,7 @@ module.exports = () => ({
             // Short circuit for cases that don't need to update status
             if (!desiredStatus) {
                 build.statusMessage = statusMessage || build.statusMessage;
+                build.statusMessageType = statusMessageType || build.statusMessageType;
             } else if (['SUCCESS', 'FAILURE', 'ABORTED'].includes(desiredStatus)) {
                 build.meta = request.payload.meta || {};
                 event.meta = merge({}, event.meta, build.meta);
@@ -266,7 +270,7 @@ module.exports = () => ({
             let isFixed = Promise.resolve(false);
             let stopFrozen = null;
 
-            updateBuildStatus(build, desiredStatus, statusMessage, username);
+            updateBuildStatus(build, desiredStatus, statusMessage, statusMessageType, username);
 
             // If status got updated to RUNNING or COLLAPSED, update init endTime and code
             if (['RUNNING', 'COLLAPSED', 'FROZEN'].includes(desiredStatus)) {