com.qualinsight.plugins.sonarqube.status.extension.StatusWebService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qualinsight-plugins-sonarqube-status Show documentation
This plugin adds a webservice to SonarQube in order to allow the retrieval of projects' and views' quality gate status as a SVG image.
There is a newer version: 1.1.1
Show newest version
/*
 * qualinsight-plugins-sonarqube-status
 * Copyright (c) 2015, QualInsight
 * http://www.qualinsight.com/
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, you can retrieve a copy
 * from .
 */
package com.qualinsight.plugins.sonarqube.status.extension;

import java.io.InputStream;
import java.io.OutputStream;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.RequestHandler;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import com.qualinsight.plugins.sonarqube.status.internal.QualityGateStatus;
import com.qualinsight.plugins.sonarqube.status.internal.QualityGateStatusRetriever;
import com.qualinsight.plugins.sonarqube.status.internal.SVGImageGenerator;

/**
 * WebService extension that provides the plugins' webservice controller and action for generating SVG quality gate status images.
 *
 * @author Michel Pawlak
 */
public final class StatusWebService implements WebService {

    private static final Logger LOGGER = LoggerFactory.getLogger(StatusWebService.class);

    private QualityGateStatusRetriever qualityGateStatusRetriever;

    private SVGImageGenerator svgImageGenerator;

    /**
     * {@link StatusWebService} IoC constructor
     *
     * @param qualityGateStatusRetriever helper extension to retrieve quality gate status
     * @param svgImageGenerator helper extension to generate SVG images
     */
    public StatusWebService(final QualityGateStatusRetriever qualityGateStatusRetriever, final SVGImageGenerator svgImageGenerator) {
        this.qualityGateStatusRetriever = qualityGateStatusRetriever;
        this.svgImageGenerator = svgImageGenerator;
    }

    @Override
    public void define(final Context context) {
        final NewController controller = context.createController("api/status");
        controller.setDescription("Status SVG image web service");
        controller.createAction("image")
            .setDescription("Retrieve the quality gate status of a project as a SVG image.")
            .setHandler(new RequestHandler() {

                @Override
                public void handle(final Request request, final Response response) throws Exception {
                    final String key = request.mandatoryParam("key");
                    LOGGER.debug("Retrieving quality gate status for key '{}'.", key);
                    final QualityGateStatus status = StatusWebService.this.qualityGateStatusRetriever.retrieveFor(key);
                    // we prepare the response OutputStream
                    final OutputStream responseOutputStream = response.stream()
                        .setMediaType("image/svg+xml")
                        .output();
                    LOGGER.debug("Retrieving SVG image for for quality gate status '{}'.", status);
                    final InputStream svgImageInputStream = StatusWebService.this.svgImageGenerator.svgImageInputStreamFor(status);
                    LOGGER.debug("Writing SVG image to response OutputStream.");
                    IOUtils.copy(svgImageInputStream, responseOutputStream);
                    responseOutputStream.close();
                    // don't close svgImageInputStream, we want it to be reusable
                }
            })
            .createParam("key")
            .setDescription("Key of the project")
            .setExampleValue("org.codehaus.sonar:sonar")
            .setRequired(true);
        controller.done();
    }

}