screwdriver-api 8.0.35 → 8.0.36

package/package.json

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

package/plugins/pipelines/index.js

@@ -44,6 +44,7 @@ const removeTemplateTagRoute = require('./templates/removeTag');
 const removeTemplateVersionRoute = require('./templates/removeVersion');
 const updateTrustedRoute = require('./templates/updateTrusted');
 const updateBuildCluster = require('./updateBuildCluster');
+const updateAdminsRoute = require('./updateAdmins');
 
 /**
  * Pipeline API Plugin
@@ -278,7 +279,8 @@ const pipelinesPlugin = {
             removeTemplateTagRoute(),
             removeTemplateVersionRoute(),
             updateTrustedRoute(),
-            updateBuildCluster()
+            updateBuildCluster(),
+            updateAdminsRoute()
         ]);
     }
 };

package/plugins/pipelines/list.js

@@ -4,6 +4,7 @@ const joi = require('joi');
 const schema = require('screwdriver-data-schema');
 const idSchema = schema.models.pipeline.base.extract('id');
 const scmUriSchema = schema.models.pipeline.base.extract('scmUri');
+const scmContextSchema = schema.models.pipeline.base.extract('scmContext');
 const listSchema = joi.array().items(schema.models.pipeline.get).label('List of Pipelines');
 const pipelineIdsSchema = joi.alternatives().try(joi.array().items(idSchema), idSchema).required();
 const IDS_KEY = 'ids[]';
@@ -23,12 +24,14 @@ module.exports = () => ({
         handler: async (request, h) => {
             const { pipelineFactory } = request.server.app;
             const { sort, configPipelineId, sortBy, search, scmUri, page, count } = request.query;
-            const scmContexts = pipelineFactory.scm.getScmContexts();
+            const scmContexts = request.query.scmContext
+                ? [request.query.scmContext]
+                : pipelineFactory.scm.getScmContexts();
             let pipelineArray = [];
 
-            scmContexts.forEach(scmContext => {
+            scmContexts.forEach(sc => {
                 const config = {
-                    params: { scmContext },
+                    params: { scmContext: sc },
                     sort
                 };
 
@@ -129,7 +132,8 @@ module.exports = () => ({
                 joi.object({
                     configPipelineId: idSchema,
                     'ids[]': pipelineIdsSchema.optional(),
-                    scmUri: scmUriSchema
+                    scmUri: scmUriSchema,
+                    scmContext: scmContextSchema.optional()
                 })
             )
         }

package/plugins/pipelines/updateAdmins.js

@@ -0,0 +1,106 @@
+'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.pipeline.base.extract('id');
+
+module.exports = () => ({
+    method: 'PUT',
+    path: '/pipelines/{id}/updateAdmins',
+    options: {
+        description: 'Update admins of a pipeline',
+        notes: 'Update the admins of a specific pipeline',
+        tags: ['api', 'pipelines'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', '!guest', 'pipeline']
+        },
+        handler: async (request, h) => {
+            const { id } = request.params;
+            const { scmContext, username, scmUserId, scope } = request.auth.credentials;
+            const isPipeline = scope.includes('pipeline');
+
+            const { usernames } = request.payload;
+            const payloadScmContext = request.payload.scmContext;
+
+            if (!Array.isArray(usernames) || usernames.length === 0) {
+                throw boom.badRequest(`Payload must contain admin usernames`);
+            } else if (!payloadScmContext) {
+                throw boom.badRequest(`Payload must contain scmContext`);
+            }
+
+            const { pipelineFactory, bannerFactory, userFactory } = request.server.app;
+
+            // Check token permissions
+            if (isPipeline) {
+                if (username !== id) {
+                    throw boom.forbidden(
+                        `User ${username} is not authorized to update admins for the pipeline (id=${id})`
+                    );
+                }
+            } else {
+                // Only SD cluster admins can update the admins
+                const scmDisplayName = bannerFactory.scm.getDisplayName({ scmContext });
+
+                const adminDetails = request.server.plugins.banners.screwdriverAdminDetails(
+                    username,
+                    scmDisplayName,
+                    scmUserId
+                );
+
+                if (!adminDetails.isAdmin) {
+                    throw boom.forbidden(
+                        `User ${username} does not have Screwdriver administrative privileges to update the admins for the pipeline (id=${id})`
+                    );
+                }
+            }
+
+            const pipeline = await pipelineFactory.get({ id });
+
+            // check if pipeline exists
+            if (!pipeline) {
+                throw boom.notFound(`Pipeline ${id} does not exist`);
+            }
+            if (pipeline.state === 'DELETING') {
+                throw boom.conflict('This pipeline is being deleted.');
+            }
+
+            const users = await userFactory.list({
+                params: {
+                    username: usernames,
+                    scmContext: payloadScmContext
+                }
+            });
+
+            const adminUsernamesForUpdate = [];
+            const newAdmins = new Set(pipeline.adminUserIds);
+
+            users.forEach(user => {
+                newAdmins.add(user.id);
+                adminUsernamesForUpdate.push(user.username);
+            });
+
+            pipeline.adminUserIds = Array.from(newAdmins);
+
+            try {
+                const result = await pipeline.update();
+
+                logger.info(`Updated admins ${adminUsernamesForUpdate} for pipeline(id=${id})`);
+
+                return h.response(result.toJson()).code(200);
+            } catch (err) {
+                logger.error(
+                    `Failed to update admins ${adminUsernamesForUpdate} for pipeline(id=${id}): ${err.message}`
+                );
+                throw boom.internal(`Failed to update admins for pipeline ${id}`);
+            }
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema
+            })
+        }
+    }
+});