screwdriver-api 8.0.0 → 8.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "8.0.0",
+  "version": "8.0.2",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {
@@ -111,7 +111,7 @@
     "screwdriver-config-parser": "^12.0.0",
     "screwdriver-coverage-bookend": "^3.0.0",
     "screwdriver-coverage-sonar": "^5.0.0",
-    "screwdriver-data-schema": "^25.0.0",
+    "screwdriver-data-schema": "^25.1.0",
     "screwdriver-datastore-sequelize": "^10.0.0",
     "screwdriver-executor-base": "^11.0.0",
     "screwdriver-executor-docker": "^8.0.1",

package/plugins/jobs/buildCluster/remove.js

@@ -0,0 +1,70 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const logger = require('screwdriver-logger');
+const idSchema = schema.models.job.base.extract('id');
+
+module.exports = () => ({
+    method: 'DELETE',
+    path: '/jobs/{id}/buildCluster',
+    options: {
+        description: 'Delete the buildCluster override of a job',
+        notes: 'Returns null if successful',
+        tags: ['api', 'jobs'],
+        auth: {
+            strategies: ['token'],
+            scope: ['admin', '!guest']
+        },
+
+        handler: async (request, h) => {
+            const { jobFactory, pipelineFactory } = request.server.app;
+            const { username } = request.auth.credentials;
+            const { id } = request.params;
+            const adminAnnotation = 'screwdriver.cd/sdAdminBuildClusterOverride';
+            const job = await jobFactory.get(id);
+
+            if (!job) {
+                throw boom.notFound(`Job ${id} does not exist`);
+            }
+
+            const pipeline = await pipelineFactory.get(job.pipelineId);
+
+            if (!pipeline) {
+                throw boom.notFound('Pipeline does not exist');
+            }
+
+            // remove buildClusterOverride annotation from job
+            const [permutation] = job.permutations;
+            const buildClusterOverride =
+                permutation && permutation.annotations && permutation.annotations[adminAnnotation];
+
+            if (!buildClusterOverride) {
+                logger.info(`[Audit] ${adminAnnotation} does not exists for jobId:${id}.`);
+
+                return h.response().code(204);
+            }
+
+            logger.info(`[Audit] ${adminAnnotation} for jobId:${id} set to ${buildClusterOverride}, deleting.`);
+
+            delete permutation.annotations[adminAnnotation];
+
+            try {
+                const result = await job.updateBuildCluster();
+
+                logger.info(`[Audit] user ${username} deleted ${adminAnnotation} for jobId:${id}.`);
+
+                return h.response(result.toJson()).code(200);
+            } catch (err) {
+                logger.error(`Failed to remove ${adminAnnotation} for job ${id}: ${err.message}`);
+                throw boom.internal(`Failed to remove ${adminAnnotation} for job ${id}`);
+            }
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema
+            })
+        }
+    }
+});

package/plugins/jobs/buildCluster/update.js

@@ -0,0 +1,85 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const logger = require('screwdriver-logger');
+const idSchema = schema.models.job.base.extract('id');
+
+module.exports = () => ({
+    method: 'PUT',
+    path: '/jobs/{id}/buildCluster',
+    options: {
+        description: 'Update the buildCluster of a job',
+        notes: 'Update the buildCluster of a specific job',
+        tags: ['api', 'jobs'],
+        auth: {
+            strategies: ['token'],
+            scope: ['admin', '!guest']
+        },
+        handler: async (request, h) => {
+            const adminAnnotation = 'screwdriver.cd/sdAdminBuildClusterOverride';
+            const { payload } = request;
+            const { id } = request.params;
+
+            if (!payload[adminAnnotation]) {
+                throw boom.badRequest(`Payload must contain ${adminAnnotation}`);
+            }
+
+            const { jobFactory, buildClusterFactory, pipelineFactory } = request.server.app;
+            const { scmContext, username } = request.auth.credentials;
+
+            const job = await jobFactory.get(id);
+
+            if (!job) {
+                throw boom.notFound(`Job ${id} does not exist`);
+            }
+
+            const pipeline = await pipelineFactory.get(job.pipelineId);
+
+            if (!pipeline) {
+                throw boom.notFound('Pipeline does not exist');
+            }
+
+            // ensure that the buildCluster is a valid cluster
+            const buildClusterName = payload[adminAnnotation];
+            const buildCluster = await buildClusterFactory.get({ name: buildClusterName, scmContext });
+
+            if (!buildCluster || !buildCluster.isActive) {
+                throw boom.badRequest(`Build cluster ${buildClusterName} does not exist or is not active`);
+            }
+
+            // update job with buildClusterOverride annotation
+            const [permutation] = job.permutations;
+
+            permutation.annotations = permutation.annotations || {};
+
+            const annotations = permutation.annotations;
+
+            if (annotations[adminAnnotation]) {
+                logger.info(
+                    `[Audit] ${adminAnnotation} for jobId:${id} already set to ${annotations[adminAnnotation]}, updating.`
+                );
+            }
+            permutation.annotations[adminAnnotation] = buildClusterName;
+
+            try {
+                const result = await job.updateBuildCluster();
+
+                logger.info(
+                    `[Audit] user ${username} updates ${adminAnnotation} for jobId:${id} to ${buildClusterName}.`
+                );
+
+                return h.response(result.toJson()).code(200);
+            } catch (err) {
+                logger.error(`Failed to update ${adminAnnotation} for job ${id}: ${err.message}`);
+                throw boom.internal(`Failed to update ${adminAnnotation} for job ${id}`);
+            }
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema
+            })
+        }
+    }
+});

package/plugins/jobs/index.js

@@ -7,6 +7,8 @@ const lastSuccessfulMeta = require('./lastSuccessfulMeta');
 const latestBuild = require('./latestBuild');
 const metrics = require('./metrics');
 const notify = require('./notify');
+const addBuildCluster = require('./buildCluster/update');
+const removeBuildCluster = require('./buildCluster/remove');
 
 /**
  * Job API Plugin
@@ -23,7 +25,9 @@ const jobsPlugin = {
             lastSuccessfulMeta(),
             metrics(),
             latestBuild(),
-            notify()
+            notify(),
+            addBuildCluster(),
+            removeBuildCluster()
         ]);
     }
 };