123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240 |
- /*
- * SonarQube Runner - API
- * 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.api;
-
- import org.sonar.runner.impl.Logs;
- import org.sonar.runner.impl.BatchLauncherMain;
- import org.sonar.runner.impl.JarExtractor;
-
- import javax.annotation.Nullable;
-
- import java.io.File;
- import java.io.FileOutputStream;
- import java.io.OutputStream;
- import java.util.ArrayList;
- import java.util.Arrays;
- import java.util.HashMap;
- import java.util.List;
- import java.util.Map;
- import java.util.Properties;
-
- /**
- * Runner executed in a new JVM.
- *
- * @since 2.2
- */
- public class ForkedRunner extends Runner<ForkedRunner> {
-
- private static final int ONE_DAY_IN_MILLISECONDS = 24 * 60 * 60 * 1000;
-
- private final Map<String, String> jvmEnvVariables = new HashMap<String, String>();
- private final List<String> jvmArguments = new ArrayList<String>();
- private String javaExecutable;
- private StreamConsumer stdOut = null;
- private StreamConsumer stdErr = null;
- private final JarExtractor jarExtractor;
- private final CommandExecutor commandExecutor;
-
- private ProcessMonitor processMonitor;
-
- ForkedRunner(JarExtractor jarExtractor, CommandExecutor commandExecutor, @Nullable ProcessMonitor processMonitor) {
- this.jarExtractor = jarExtractor;
- this.commandExecutor = commandExecutor;
- this.processMonitor = processMonitor;
- }
-
- ForkedRunner(JarExtractor jarExtractor, CommandExecutor commandExecutor) {
- this(jarExtractor, commandExecutor, null);
- }
-
- /**
- * Create new instance. Never return null.
- */
- public static ForkedRunner create() {
- return new ForkedRunner(new JarExtractor(), CommandExecutor.create());
- }
-
- /**
- * Create new instance. Never return null.
- */
- public static ForkedRunner create(ProcessMonitor processMonitor) {
- return new ForkedRunner(new JarExtractor(), CommandExecutor.create(), processMonitor);
- }
-
- /**
- * Path to the java executable. The JVM of the client app is used by default
- * (see the system property java.home)
- */
- public ForkedRunner setJavaExecutable(@Nullable String s) {
- this.javaExecutable = s;
- return this;
- }
-
- public List<String> jvmArguments() {
- return new ArrayList<String>(jvmArguments);
- }
-
- /**
- * See {@link #addJvmArguments(java.util.List)}
- */
- public ForkedRunner addJvmArguments(String... s) {
- return addJvmArguments(Arrays.asList(s));
- }
-
- /**
- * JVM arguments, for example "-Xmx512m"
- */
- public ForkedRunner addJvmArguments(List<String> args) {
- jvmArguments.addAll(args);
- return this;
- }
-
- /**
- * Set a JVM environment variable. By default no variables are set.
- */
- public ForkedRunner setJvmEnvVariable(String key, String value) {
- jvmEnvVariables.put(key, value);
- return this;
- }
-
- /**
- * Add some JVM environment variables. By default no variables are set.
- */
- public ForkedRunner addJvmEnvVariables(Map<String, String> map) {
- jvmEnvVariables.putAll(map);
- return this;
- }
-
- /**
- * @deprecated Since 2.5. Use {@link ForkedRunner#setLogListener} instead.
- * Subscribe to the standard output from the forked process. By default, logs messages are sent with INFO level to the log listener set.
- */
- public ForkedRunner setStdOut(@Nullable StreamConsumer stream) {
- this.stdOut = stream;
- return this;
- }
-
- /**
- * @deprecated Since 2.5. Use {@link ForkedRunner#setLogListener}instead.
- * Subscribe to the error output from the forked process. By default, logs messages are sent with ERROR level to the log listener set.
- */
- public ForkedRunner setStdErr(@Nullable StreamConsumer stream) {
- this.stdErr = stream;
- return this;
- }
-
- @Override
- protected void doExecute(Properties props) {
- // merge both global and analysis-specific properties because it will be used both to start and to execute.
- Properties p = new Properties();
-
- p.putAll(globalProperties());
- p.putAll(props);
-
- ForkCommand forkCommand = createCommand(p);
- try {
- fork(forkCommand);
- } finally {
- deleteTempFiles(forkCommand);
- }
- }
-
- @Override
- protected void doStop() {
- // nothing to do
- }
-
- @Override
- protected void doStart() {
- // nothing to do
- }
-
- ForkCommand createCommand(Properties p) {
- File propertiesFile = writeProperties(p);
- File jarFile = jarExtractor.extractToTemp("sonar-runner-impl");
- if (javaExecutable == null) {
- javaExecutable = new Os().thisJavaExe().getAbsolutePath();
- }
- Command command = Command.builder()
- .setExecutable(javaExecutable)
- .addEnvVariables(jvmEnvVariables)
- .addArguments(jvmArguments)
- .addArguments("-cp", jarFile.getAbsolutePath(), BatchLauncherMain.class.getName(), propertiesFile.getAbsolutePath())
- .build();
- return new ForkCommand(command, jarFile, propertiesFile);
- }
-
- File writeProperties(Properties p) {
- try {
- File file = File.createTempFile("sonar-project", ".properties");
- try (OutputStream output = new FileOutputStream(file)) {
- p.store(output, "Generated by sonar-runner");
- return file;
- }
- } catch (Exception e) {
- throw new IllegalStateException("Fail to export sonar-runner properties", e);
- }
- }
-
- private static void deleteTempFiles(ForkCommand forkCommand) {
- Utils.deleteQuietly(forkCommand.jarFile);
- Utils.deleteQuietly(forkCommand.propertiesFile);
- }
-
- private void fork(ForkCommand forkCommand) {
- if (stdOut == null) {
- stdOut = new StreamConsumer() {
- @Override
- public void consumeLine(String line) {
- Logs.info(line);
- }
- };
- }
- if (stdErr == null) {
- stdErr = new StreamConsumer() {
- @Override
- public void consumeLine(String line) {
- Logs.error(line);
- }
- };
- }
-
- int status = commandExecutor.execute(forkCommand.command, stdOut, stdErr, ONE_DAY_IN_MILLISECONDS, processMonitor);
- if (status != 0) {
- if (processMonitor != null && processMonitor.stop()) {
- stdOut.consumeLine(String.format("SonarQube Runner was stopped [status=%s]", status));
- } else {
- throw new IllegalStateException("Error status [command: " + forkCommand.command + "]: " + status);
- }
- }
- }
-
- static class ForkCommand {
- Command command;
- File jarFile;
- File propertiesFile;
-
- private ForkCommand(Command command, File jarFile, File propertiesFile) {
- this.command = command;
- this.jarFile = jarFile;
- this.propertiesFile = propertiesFile;
- }
- }
- }
|