screwdriver-api 5.0.5 → 5.0.6

package/package.json

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

package/plugins/collections/README.md

@@ -74,6 +74,25 @@ Example payload:
 }
 ```
 
+#### Add one or more pipelines to a collection
+
+`PUT /collections/{id}/pipelines?ids[]={pipelineId}`
+
+Examples:
+
+`PUT /collections/123/pipelines?ids[]=11&ids[]=23` adds pipelines with `id` equal to `11` and `23` to the collection with `id` equal to `123`
+
+
+#### Remove one or more pipelines from a collection
+
+`DELETE /collections/{id}/pipelines?ids[]={pipelineId}`
+
+Examples:
+
+`DELETE /collections/123/pipelines?ids[]=11&ids[]=23` removes pipelines with `id` equal to `11` and `23` from the collection with `id` equal to `123`
+
+`DELETE /collections/123/pipelines` removes all the pipelines from the collection with `id` equal to `123`
+
 #### Delete a collection
 
 `DELETE /collections/{id}`

package/plugins/collections/addPipelines.js

@@ -0,0 +1,82 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const schema = require('screwdriver-data-schema');
+const joi = require('joi');
+const idSchema = schema.models.collection.base.extract('id');
+const pipelineIdSchema = schema.models.pipeline.base.extract('id');
+const pipelineIdsSchema = joi
+    .alternatives()
+    .try(joi.array().items(pipelineIdSchema), pipelineIdSchema)
+    .required();
+const IDS_KEY = 'ids[]';
+
+module.exports = () => ({
+    method: 'PUT',
+    path: '/collections/{id}/pipelines',
+    options: {
+        description: 'Add one or more pipelines to the collection',
+        notes: 'Returns null if successful',
+        tags: ['api', 'collections'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', '!guest']
+        },
+
+        handler: async (request, h) => {
+            const { collectionFactory, pipelineFactory, userFactory } = request.server.app;
+            const { username, scmContext } = request.auth.credentials;
+            const { id } = request.params;
+
+            // Fetch the collection and user models
+            return Promise.all([collectionFactory.get(id), userFactory.get({ username, scmContext })])
+                .then(([collection, user]) => {
+                    if (!collection) {
+                        throw boom.notFound(`Collection ${id} does not exist`);
+                    }
+                    if (!user) {
+                        throw boom.notFound(`User ${username} does not exist`);
+                    }
+                    if (collection.userId !== user.id) {
+                        throw boom.forbidden(`User ${username} does not own collection`);
+                    }
+
+                    const pipelineIdsQueryParam = request.query[IDS_KEY];
+
+                    if (!pipelineIdsQueryParam) {
+                        throw boom.notFound(`Pipelines are not provided to add to the collection`);
+                    }
+
+                    const pipelineIdsToAdd = Array.isArray(pipelineIdsQueryParam)
+                        ? pipelineIdsQueryParam.map(pipelineId => parseInt(pipelineId, 10))
+                        : [parseInt(pipelineIdsQueryParam, 10)];
+
+                    return pipelineFactory
+                        .list({
+                            params: {
+                                scmContext,
+                                id: pipelineIdsToAdd
+                            }
+                        })
+                        .then(pipelinesToAdd => {
+                            const newPipelineIdsToAdd = pipelinesToAdd
+                                .filter(p => !collection.pipelineIds.includes(p.id))
+                                .map(p => p.id);
+
+                            collection.pipelineIds = [...collection.pipelineIds, ...newPipelineIdsToAdd];
+
+                            return collection.update().then(() => h.response().code(204));
+                        });
+                })
+                .catch(err => {
+                    throw err;
+                });
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema,
+                'ids[]': pipelineIdsSchema.optional()
+            })
+        }
+    }
+});

package/plugins/collections/index.js

@@ -5,6 +5,8 @@ const getRoute = require('./get');
 const listRoute = require('./list');
 const updateRoute = require('./update');
 const removeRoute = require('./remove');
+const removePipelinesRoute = require('./removePipelines');
+const addPipelinesRoute = require('./addPipelines');
 
 /**
  * Collections API Plugin
@@ -16,7 +18,15 @@ const removeRoute = require('./remove');
 const collectionsPlugin = {
     name: 'collections',
     async register(server) {
-        server.route([createRoute(), getRoute(), listRoute(), updateRoute(), removeRoute()]);
+        server.route([
+            createRoute(),
+            getRoute(),
+            listRoute(),
+            updateRoute(),
+            removeRoute(),
+            removePipelinesRoute(),
+            addPipelinesRoute()
+        ]);
     }
 };
 

package/plugins/collections/removePipelines.js

@@ -0,0 +1,70 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const schema = require('screwdriver-data-schema');
+const joi = require('joi');
+const idSchema = schema.models.collection.base.extract('id');
+const pipelineIdSchema = schema.models.pipeline.base.extract('id');
+const pipelineIdsSchema = joi
+    .alternatives()
+    .try(joi.array().items(pipelineIdSchema), pipelineIdSchema)
+    .required();
+const IDS_KEY = 'ids[]';
+
+module.exports = () => ({
+    method: 'DELETE',
+    path: '/collections/{id}/pipelines',
+    options: {
+        description: 'Delete one or more pipelines from a collection',
+        notes: 'Returns null if successful',
+        tags: ['api', 'collections'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', '!guest']
+        },
+
+        handler: async (request, h) => {
+            const { collectionFactory, userFactory } = request.server.app;
+            const { username, scmContext } = request.auth.credentials;
+            const { id } = request.params;
+
+            // Fetch the collection and user models
+            return Promise.all([collectionFactory.get(request.params.id), userFactory.get({ username, scmContext })])
+                .then(([collection, user]) => {
+                    if (!collection) {
+                        throw boom.notFound(`Collection ${id} does not exist`);
+                    }
+                    if (!user) {
+                        throw boom.notFound(`User ${username} does not exist`);
+                    }
+                    if (collection.userId !== user.id) {
+                        throw boom.forbidden(`User ${username} does not own collection`);
+                    }
+
+                    // Only return specific pipelines
+                    const pipelineIdsQueryParam = request.query[IDS_KEY];
+
+                    if (pipelineIdsQueryParam) {
+                        const pipelineIdsToRemove = Array.isArray(pipelineIdsQueryParam)
+                            ? pipelineIdsQueryParam.map(pipelineId => parseInt(pipelineId, 10))
+                            : [parseInt(pipelineIdsQueryParam, 10)];
+
+                        collection.pipelineIds = collection.pipelineIds.filter(i => !pipelineIdsToRemove.includes(i));
+                    } else {
+                        collection.pipelineIds = [];
+                    }
+
+                    return collection.update().then(() => h.response().code(204));
+                })
+                .catch(err => {
+                    throw err;
+                });
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema,
+                'ids[]': pipelineIdsSchema.optional()
+            })
+        }
+    }
+});