screwdriver-api 4.1.178 → 4.1.182

package/lib/registerPlugins.js

@@ -60,7 +60,8 @@ async function registerResourcePlugins(server, config) {
         'isAdmin',
         'shutdown',
         'release',
-        'validator'
+        'validator',
+        'processHooks'
     ];
 
     if (hoek.reach(config, 'coverage.coveragePlugin')) {

package/package.json

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

package/plugins/builds/artifacts/unzip.js

@@ -0,0 +1,49 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const idSchema = schema.models.build.base.extract('id');
+
+module.exports = config => ({
+    method: 'POST',
+    path: '/builds/{id}/artifacts/unzip',
+    options: {
+        description: 'Extract a ZIP for build artifacts',
+        notes: 'Extract a specific ZIP for build artifacts',
+        tags: ['api', 'builds', 'artifacts'],
+        auth: {
+            strategies: ['token'],
+            scope: ['build']
+        },
+
+        handler: async (req, h) => {
+            const buildId = req.params.id;
+            const { username, scope } = req.auth.credentials;
+            const isBuild = scope.includes('build');
+            const { buildFactory } = req.server.app;
+
+            if (isBuild && username !== buildId) {
+                return boom.forbidden(`Credential only valid for ${username}`);
+            }
+
+            return buildFactory
+                .get(buildId)
+                .then(async buildModel => {
+                    if (!buildModel) {
+                        throw boom.notFound('Build does not exist');
+                    }
+                    await buildModel.unzipArtifacts();
+                    return h.response().code(202);
+                })
+                .catch(err => {
+                    throw err;
+                });
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema
+            })
+        }
+    }
+});

package/plugins/builds/index.js

@@ -11,6 +11,7 @@ const createRoute = require('./create');
 const stepGetRoute = require('./steps/get');
 const listStepsRoute = require('./steps/list');
 const artifactGetRoute = require('./artifacts/get');
+const artifactUnzipRoute = require('./artifacts/unzip');
 const stepUpdateRoute = require('./steps/update');
 const stepLogsRoute = require('./steps/logs');
 const listSecretsRoute = require('./listSecrets');
@@ -270,7 +271,6 @@ async function createInternalBuild(config) {
     } else {
         job = await jobFactory.get(jobId);
     }
-
     const internalBuildConfig = {
         jobId: job.id,
         sha: event.sha,
@@ -410,6 +410,11 @@ function parseJobInfo({ joinObj = {}, current, nextJobName, nextPipelineId }) {
  * @return {Promise}                            All finished builds
  */
 async function getFinishedBuilds(event, buildFactory) {
+    if (!event.parentEventId) {
+        // FIXME: remove this flow to always use buildFactory.getLatestBuilds
+        return event.getBuilds();
+    }
+
     // FIXME: buildFactory.getLatestBuilds doesn't return build model
     const builds = await buildFactory.getLatestBuilds({ groupEventId: event.groupEventId });
 
@@ -1106,7 +1111,8 @@ const buildsPlugin = {
             listSecretsRoute(),
             tokenRoute(),
             metricsRoute(),
-            artifactGetRoute(options)
+            artifactGetRoute(options),
+            artifactUnzipRoute(),
         ]);
     }
 };

package/plugins/events/create.js

@@ -149,7 +149,7 @@ module.exports = () => ({
 
                 const [files, prInfo] = await Promise.all([
                     scm.getChangedFiles({
-                        payload: null,
+                        webhookConfig: null,
                         type: 'pr',
                         ...scmConfig
                     }),

package/plugins/processHooks/README.md

@@ -0,0 +1,33 @@
+# Process Hooks Plugin
+> Hapi processHooks plugin for the Screwdriver API
+
+## Usage
+
+### Register plugin
+
+```javascript
+const Hapi = require('@hapi/hapi');
+const server = new Hapi.Server();
+const processHooksPlugin = require('./');
+
+server.connection({ port: 3000 });
+
+server.register({
+    register: processHooksPlugin,
+    options: {}
+}, () => {
+    server.start((err) => {
+        if (err) {
+            throw err;
+        }
+        console.log('Server running at:', server.info.uri);
+    });
+});
+```
+
+### Routes
+
+#### Start pipeline events from scm webhook config
+
+`POST /processHooks`
+

package/plugins/processHooks/index.js

@@ -0,0 +1,47 @@
+'use strict';
+
+const logger = require('screwdriver-logger');
+const { startHookEvent } = require('../webhooks/helper');
+
+/**
+ * Process Hooks API Plugin
+ * - Start pipeline events with scm webhook config via queue-service
+ * @method register
+ * @param  {Hapi}       server  Hapi Server
+ * @param  {Object}     options Configuration
+ * @param  {Function}   next    Function to call when done
+ */
+const processHooksPlugin = {
+    name: 'processHooks',
+    async register(server, options) {
+        server.route({
+            method: 'POST',
+            path: '/processHooks',
+            options: {
+                description: 'Handle process hook events',
+                notes: 'Acts on pull request, pushes, comments, etc.',
+                tags: ['api', 'processHook'],
+                auth: {
+                    strategies: ['token'],
+                    scope: ['webhook_worker']
+                },
+                plugins: {
+                    'hapi-rate-limit': {
+                        enabled: false
+                    }
+                },
+                handler: async (request, h) => {
+                    try {
+                        return await startHookEvent(request, h, request.payload);
+                    } catch (err) {
+                        logger.error(`Error starting hook events for ${request.payload.hookId}:${err}`);
+
+                        throw err;
+                    }
+                }
+            }
+        });
+    }
+};
+
+module.exports = processHooksPlugin;