org.sonar.server.ce.ws.SubmitAction.java Source code

Introduction

Here is the source code for org.sonar.server.ce.ws.SubmitAction.java

Source

/*
 * SonarQube
 * Copyright (C) 2009-2017 SonarSource SA
 * mailto:info AT sonarsource DOT 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, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.ce.ws;

import java.io.BufferedInputStream;
import java.io.InputStream;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import org.sonar.ce.queue.CeTask;
import org.sonar.server.computation.queue.ReportSubmitter;
import org.sonar.server.organization.DefaultOrganizationProvider;
import org.sonar.server.ws.WsUtils;
import org.sonarqube.ws.WsCe;

public class SubmitAction implements CeWsAction {

    private static final String PARAM_ORGANIZATION_KEY = "organization";
    private static final String PARAM_PROJECT_KEY = "projectKey";
    private static final String PARAM_PROJECT_BRANCH = "projectBranch";
    private static final String PARAM_PROJECT_NAME = "projectName";
    private static final String PARAM_REPORT_DATA = "report";

    private final ReportSubmitter reportSubmitter;
    private final DefaultOrganizationProvider defaultOrganizationProvider;

    public SubmitAction(ReportSubmitter reportSubmitter, DefaultOrganizationProvider defaultOrganizationProvider) {
        this.reportSubmitter = reportSubmitter;
        this.defaultOrganizationProvider = defaultOrganizationProvider;
    }

    @Override
    public void define(WebService.NewController controller) {
        WebService.NewAction action = controller.createAction("submit").setDescription(
                "Submits a scanner report to the queue. Report is processed asynchronously. Requires analysis permission. "
                        + "If the project does not exist, then the provisioning permission is also required.")
                .setPost(true).setInternal(true).setSince("5.2").setHandler(this)
                .setResponseExample(getClass().getResource("submit-example.json"));

        action.createParam(PARAM_ORGANIZATION_KEY).setDescription("Key of the organization the project belongs to")
                .setExampleValue("my-org").setSince("6.3").setInternal(true);

        action.createParam(PARAM_PROJECT_KEY).setRequired(true).setDescription("Key of project")
                .setExampleValue("my_project");

        action.createParam(PARAM_PROJECT_BRANCH).setDescription("Optional branch of project")
                .setExampleValue("branch-1.x");

        action.createParam(PARAM_PROJECT_NAME).setRequired(false)
                .setDescription("Optional name of the project, used only if the project does not exist yet.")
                .setExampleValue("My Project");

        action.createParam(PARAM_REPORT_DATA).setRequired(true)
                .setDescription("Report file. Format is not an API, it changes among SonarQube versions.");
    }

    @Override
    public void handle(Request wsRequest, Response wsResponse) throws Exception {
        String organizationKey = wsRequest.getParam(PARAM_ORGANIZATION_KEY).emptyAsNull()
                .or(defaultOrganizationProvider.get()::getKey);
        String projectKey = wsRequest.mandatoryParam(PARAM_PROJECT_KEY);
        String projectBranch = wsRequest.param(PARAM_PROJECT_BRANCH);
        String projectName = StringUtils.defaultIfBlank(wsRequest.param(PARAM_PROJECT_NAME), projectKey);

        CeTask task;
        try (InputStream report = new BufferedInputStream(wsRequest.paramAsInputStream(PARAM_REPORT_DATA))) {
            task = reportSubmitter.submit(organizationKey, projectKey, projectBranch, projectName, report);
        }

        WsCe.SubmitResponse submitResponse = WsCe.SubmitResponse.newBuilder().setTaskId(task.getUuid())
                .setProjectId(task.getComponentUuid()).build();
        WsUtils.writeProtobuf(submitResponse, wsRequest, wsResponse);
    }
}