screwdriver-api/plugins/builds/artifacts/unzip.js

API server for the Screwdriver.cd service

'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: ['user', 'build']
        },

        handler: async (req, h) => {
            if (!req.server.app.unzipArtifacts) {
                const data = {
                    statusCode: 200,
                    message: "This function is not enabled and will do nothing."
                }
                return h.response(data).code(200);
            }
            const buildId = req.params.id;
            const { username, scope, scmContext, scmUserId } = req.auth.credentials;
            const isBuild = scope.includes('build');
            const { buildFactory } = req.server.app;
            const scmDisplayName = buildFactory.scm.getDisplayName({ scmContext })
            const adminDetails = req.server.plugins.banners.screwdriverAdminDetails(username, scmDisplayName, scmUserId);

            if (scope.includes('user') && !adminDetails.isAdmin) {
                return boom.forbidden(`User ${adminDetails.userDisplayName} does not have Screwdriver administrative privileges.`)
            }

            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
            })
        }
    }
});