sonar-scanner-cli/sonar-runner-impl/src/main/java/org/sonar/runner/internal/batch/Launcher.java

/*
 * Sonar Runner - Implementation
 * Copyright (C) 2011 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.runner.internal.batch;

import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.joran.JoranConfigurator;
import ch.qos.logback.core.joran.spi.JoranException;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.Maps;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.bootstrap.ProjectDefinition;
import org.sonar.api.batch.bootstrap.ProjectReactor;
import org.sonar.api.utils.SonarException;
import org.sonar.batch.bootstrapper.Batch;
import org.sonar.batch.bootstrapper.EnvironmentInformation;
import org.sonar.runner.Runner;

import java.io.InputStream;
import java.util.List;
import java.util.Map;
import java.util.Properties;

/**
 * Contrary to {@link org.sonar.runner.Runner}, this class is executed within the classloader
 * provided by the server. It contains the installed plugins and the same version of sonar-batch as the server.
 */
public class Launcher {

  private String command;
  private Properties globalProperties;
  private Properties projectProperties;
  private List<Object> containerExtensions;

  /**
   * @deprecated Use {@link Launcher#Launcher(String, Properties, Properties, List)} instead
   */
  @Deprecated
  public Launcher(Properties properties, List<Object> containerExtensions) {
    this("project-analysis", new Properties(), properties, containerExtensions);
  }

  public Launcher(String command, Properties globalProperties, Properties projectProperties, List<Object> containerExtensions) {
    this.command = command;
    this.globalProperties = globalProperties;
    this.projectProperties = projectProperties;
    this.containerExtensions = containerExtensions;
  }

  /**
   * Main entry point.
   */
  public void execute() {
    Properties globalConfiguration = getInitialConfiguration();
    globalConfiguration.putAll(globalProperties);
    initLogging(globalConfiguration);

    Properties projectConfiguration = new Properties();
    projectConfiguration.putAll(globalConfiguration);
    projectConfiguration.putAll(projectProperties);
    ProjectDefinition project = SonarProjectBuilder.create(command, projectConfiguration).generateProjectDefinition();

    executeBatch(globalConfiguration, project);
  }

  private void executeBatch(Properties globalConfiguration, ProjectDefinition project) {
    String envKey = globalProperties.getProperty(Runner.PROPERTY_ENVIRONMENT_INFORMATION_KEY);
    String envVersion = globalProperties.getProperty(Runner.PROPERTY_ENVIRONMENT_INFORMATION_VERSION);
    Batch.Builder builder = Batch.builder()
        .setEnvironment(new EnvironmentInformation(envKey, envVersion));
    for (Object extension : containerExtensions) {
      builder.addComponent(extension);
    }
    if (project != null) {
      builder.setProjectReactor(new ProjectReactor(project));
    }
    if (StringUtils.isNotBlank(command)) {
      // This code can only works on Sonar 3.5+
      builder
          .setGlobalProperties(toMap(globalConfiguration))
          .setTaskCommand(command);
    }
    Batch batch = builder.build();
    batch.execute();
  }

  private Map<String, String> toMap(Properties props) {
    Map<String, String> result = Maps.newHashMap();
    for (Map.Entry<Object, Object> entry : props.entrySet()) {
      result.put(entry.getKey().toString(), entry.getValue().toString());
    }
    return result;
  }

  private void initLogging(Properties props) {
    LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
    JoranConfigurator jc = new JoranConfigurator();
    jc.setContext(context);
    context.reset();
    InputStream input = Batch.class.getResourceAsStream("/org/sonar/batch/logback.xml");
    System.setProperty("ROOT_LOGGER_LEVEL", isDebug() ? "DEBUG" : "INFO");
    context.putProperty("SQL_LOGGER_LEVEL", getSqlLevel(props));
    context.putProperty("SQL_RESULTS_LOGGER_LEVEL", getSqlResultsLevel(props));
    try {
      jc.doConfigure(input);

    } catch (JoranException e) {
      throw new SonarException("can not initialize logging", e);

    } finally {
      IOUtils.closeQuietly(input);
    }
  }

  @VisibleForTesting
  protected boolean isDebug() {
    return Boolean.parseBoolean(projectProperties.getProperty(Runner.PROPERTY_VERBOSE,
        projectProperties.getProperty(Runner.PROPERTY_OLD_DEBUG_MODE, "false")));
  }

  @VisibleForTesting
  protected static String getSqlLevel(Properties props) {
    boolean showSql = "true".equals(props.get("sonar.showSql"));
    return showSql ? "DEBUG" : "WARN";
  }

  @VisibleForTesting
  protected static String getSqlResultsLevel(Properties props) {
    boolean showSql = "true".equals(props.get("sonar.showSqlResults"));
    return showSql ? "DEBUG" : "WARN";
  }

  private Properties getInitialConfiguration() {
    Properties props = new Properties();
    props.putAll(System.getProperties());
    props.putAll(System.getenv());
    return props;
  }

}