org.sonar.dev.UploadMojo.java Source code

Introduction

Here is the source code for org.sonar.dev.UploadMojo.java

Source

/*
 * SonarQube Development Maven Plugin
 * Copyright (C) 2010 SonarSource
 * dev@sonar.codehaus.org
 *
 * 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  02
 */
package org.sonar.dev;

import com.github.kevinsawicki.http.HttpRequest;
import org.apache.commons.io.FileUtils;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;

import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.List;

/**
 * Uploads the plugin artifact to server. Requires SonarQube 4.3 or greater.
 * <p/>
 * <ol>
 * <li>Enable the development mode on server : add sonar.dev=true to conf/sonar.properties</li>
 * <li>Restart server</li>
 * <li>Build and upload the plugin : <code>mvn package org.codehaus.sonar:sonar-dev-maven-plugin::upload</code>.
 * It requires the properties sonarHome (path to local server installation) and sonarUrl (default value
 * is http://localhost:9000)
 * </li>
 * </ol>
 *
 * @goal upload
 * @aggregator
 * @requiresDependencyResolution compile
 */
public class UploadMojo extends AbstractMojo {

    /**
     * @parameter property="session"
     * @required
     * @readonly
     */
    private MavenSession session;

    /**
     * Home directory of SonarQube local installation.
     *
     * @parameter property="sonarHome"
     * @required
     */
    private File sonarHome;

    /**
     * Server URL
     *
     * @parameter property="sonarUrl" default-value="http://localhost:9000"
     * @required
     */
    private URL sonarUrl;

    @Override
    public void execute() throws MojoExecutionException {
        checkSonarHome();
        boolean deployed = false;
        for (MavenProject module : (List<MavenProject>) session.getSortedProjects()) {
            if ("sonar-plugin".equals(module.getPackaging())) {
                copyJar(module);
                deployed = true;
            }
        }
        if (deployed) {
            restartServer();
        } else {
            getLog().info("No plugins to be uploaded");
        }
    }

    private void checkSonarHome() throws MojoExecutionException {
        if (!sonarHome.isDirectory() && !sonarHome.exists()) {
            throw new MojoExecutionException(
                    "Server home directory does not exist: " + sonarHome.getAbsolutePath());
        }
        File confFile = new File(sonarHome, "conf/sonar.properties");
        if (!confFile.isFile() && !confFile.exists()) {
            throw new MojoExecutionException("Not a valid server home directory: " + sonarHome.getAbsolutePath());
        }
    }

    private void copyJar(MavenProject module) throws MojoExecutionException {
        File buildDir = new File(module.getBuild().getDirectory());
        File jar = new File(buildDir, module.getBuild().getFinalName() + ".jar");
        if (!jar.exists()) {
            throw new MojoExecutionException("Plugin artifact does not exist for module " + module.getArtifactId()
                    + ": " + jar.getAbsolutePath());
        }
        getLog().info("Copying " + jar.getAbsolutePath());
        File downloadsDir = new File(sonarHome, "extensions/downloads");
        downloadsDir.mkdir();
        try {
            FileUtils.copyFileToDirectory(jar, downloadsDir);
        } catch (IOException e) {
            throw new MojoExecutionException(
                    String.format("Fail to copy %s to %s", jar.getAbsolutePath(), downloadsDir), e);
        }
    }

    private void restartServer() throws MojoExecutionException {
        getLog().info("Restarting server");
        try {
            HttpRequest request = HttpRequest.post(new URL(sonarUrl, "/api/system/restart"));
            if (!request.noContent()) {
                throw new MojoExecutionException("Fail to restart server " + sonarUrl + ": " + request.message());
            }
        } catch (MalformedURLException e) {
            throw new MojoExecutionException("Invalid URL", e);
        }
        getLog().info("Server restarted");
    }
}