+/*
+ * Copyright (C) 2007-2012 Argeo GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.argeo.slc.core.execution.tasks;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
import java.io.Writer;
import java.util.ArrayList;
+import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import java.util.UUID;
+
+import javax.security.auth.callback.CallbackHandler;
import org.apache.commons.exec.CommandLine;
import org.apache.commons.exec.DefaultExecutor;
import org.argeo.slc.SlcException;
import org.argeo.slc.UnsupportedException;
import org.argeo.slc.core.execution.ExecutionResources;
-import org.argeo.slc.core.structure.tree.TreeSRelatedHelper;
import org.argeo.slc.core.test.SimpleResultPart;
import org.argeo.slc.test.TestResult;
import org.argeo.slc.test.TestStatus;
import org.springframework.core.io.Resource;
+import org.springframework.security.Authentication;
+import org.springframework.security.context.SecurityContextHolder;
/** Execute an OS specific system call. */
-public class SystemCall extends TreeSRelatedHelper implements Runnable {
+public class SystemCall implements Runnable {
+ public final static String LOG_STDOUT = "System.out";
+
private final Log log = LogFactory.getLog(getClass());
private String execDir;
private String cmd = null;
private List<Object> command = null;
+ private Executor executor = new DefaultExecutor();
private Boolean synchronous = true;
private String stdErrLogLevel = "ERROR";
private Resource stdOutFile = null;
private Resource stdErrFile = null;
+
private Resource stdInFile = null;
+ /**
+ * If no {@link #stdInFile} provided, writing to this stream will write to
+ * the stdin of the process.
+ */
+ private OutputStream stdInSink = null;
+
private Boolean redirectStdOut = false;
+ private List<SystemCallOutputListener> outputListeners = Collections
+ .synchronizedList(new ArrayList<SystemCallOutputListener>());
+
private Map<String, List<Object>> osCommands = new HashMap<String, List<Object>>();
private Map<String, String> osCmds = new HashMap<String, String>();
private Map<String, String> environmentVariables = new HashMap<String, String>();
private Boolean exceptionOnFailed = true;
private Boolean mergeEnvironmentVariables = true;
+ private Authentication authentication;
+
private String osConsole = null;
private String generateScript = null;
+ /** 24 hours */
private Long watchdogTimeout = 24 * 60 * 60 * 1000l;
private TestResult testResult;
private ExecutionResources executionResources;
+ /** Sudo the command, as root if empty or as user if not. */
+ private String sudo = null;
+ // TODO make it more secure and robust, test only once
+ private final String sudoPrompt = UUID.randomUUID().toString();
+ private String askPassProgram = "/usr/libexec/openssh/ssh-askpass";
+ private boolean firstLine = true;
+ private CallbackHandler callbackHandler;
+ /** Chroot to the this path (must not be empty) */
+ private String chroot = null;
+
/** Empty constructor */
public SystemCall() {
/** Executes the system call. */
public void run() {
+ authentication = SecurityContextHolder.getContext().getAuthentication();
+
// Manage streams
Writer stdOutWriter = null;
OutputStream stdOutputStream = null;
stdErrWriter = createWriter(stdOutFile, true);
}
- if (stdInFile != null)
- try {
+ try {
+ if (stdInFile != null)
stdInStream = stdInFile.getInputStream();
- } catch (IOException e2) {
- throw new SlcException("Cannot open a stream for " + stdInFile,
- e2);
+ else {
+ stdInStream = new PipedInputStream();
+ stdInSink = new PipedOutputStream(
+ (PipedInputStream) stdInStream);
}
+ } catch (IOException e2) {
+ throw new SlcException("Cannot open a stream for " + stdInFile, e2);
+ }
if (log.isTraceEnabled()) {
log.debug("os.name=" + System.getProperty("os.name"));
// Execution directory
File dir = new File(getExecDirToUse());
- if (!dir.exists())
- dir.mkdirs();
+ // if (!dir.exists())
+ // dir.mkdirs();
// Watchdog to check for lost processes
- Executor executor = new DefaultExecutor();
- executor.setWatchdog(new ExecuteWatchdog(watchdogTimeout));
+ Executor executorToUse;
+ if (executor != null)
+ executorToUse = executor;
+ else
+ executorToUse = new DefaultExecutor();
+ executorToUse.setWatchdog(new ExecuteWatchdog(watchdogTimeout));
if (redirectStreams) {
// Redirect standard streams
- executor.setStreamHandler(createExecuteStreamHandler(stdOutWriter,
- stdOutputStream, stdErrWriter, stdInStream));
+ executorToUse.setStreamHandler(createExecuteStreamHandler(
+ stdOutWriter, stdOutputStream, stdErrWriter, stdInStream));
} else {
// Dummy stream handler (otherwise pump is used)
- executor.setStreamHandler(new DummyexecuteStreamHandler());
+ executorToUse.setStreamHandler(new DummyexecuteStreamHandler());
}
- executor.setProcessDestroyer(new ShutdownHookProcessDestroyer());
- executor.setWorkingDirectory(dir);
+ executorToUse.setProcessDestroyer(new ShutdownHookProcessDestroyer());
+ executorToUse.setWorkingDirectory(dir);
// Command line to use
final CommandLine commandLine = createCommandLine();
// Env variables
Map<String, String> environmentVariablesToUse = null;
- if (environmentVariables.size() > 0) {
- environmentVariablesToUse = new HashMap<String, String>();
- if (mergeEnvironmentVariables)
- environmentVariablesToUse.putAll(System.getenv());
+ environmentVariablesToUse = new HashMap<String, String>();
+ if (mergeEnvironmentVariables)
+ environmentVariablesToUse.putAll(System.getenv());
+ if (environmentVariables.size() > 0)
environmentVariablesToUse.putAll(environmentVariables);
- }
// Execute
ExecuteResultHandler executeResultHandler = createExecuteResultHandler(commandLine);
+ //
+ // THE EXECUTION PROPER
+ //
try {
if (synchronous)
try {
- int exitValue = executor.execute(commandLine,
+ int exitValue = executorToUse.execute(commandLine,
environmentVariablesToUse);
executeResultHandler.onProcessComplete(exitValue);
} catch (ExecuteException e1) {
+ if (e1.getExitValue() == Executor.INVALID_EXITVALUE) {
+ Thread.currentThread().interrupt();
+ return;
+ }
+ // Sleep 1s in order to make sure error logs are flushed
+ Thread.sleep(1000);
executeResultHandler.onProcessFailed(e1);
}
else
- executor.execute(commandLine, environmentVariablesToUse,
+ executorToUse.execute(commandLine, environmentVariablesToUse,
executeResultHandler);
} catch (SlcException e) {
throw e;
IOUtils.closeQuietly(stdOutWriter);
IOUtils.closeQuietly(stdErrWriter);
IOUtils.closeQuietly(stdInStream);
+ IOUtils.closeQuietly(stdInSink);
}
}
+ public synchronized String function() {
+ final StringBuffer buf = new StringBuffer("");
+ SystemCallOutputListener tempOutputListener = new SystemCallOutputListener() {
+ private Long lineCount = 0l;
+
+ public void newLine(SystemCall systemCall, String line,
+ Boolean isError) {
+ if (!isError) {
+ if (lineCount != 0l)
+ buf.append('\n');
+ buf.append(line);
+ lineCount++;
+ }
+ }
+ };
+ addOutputListener(tempOutputListener);
+ run();
+ removeOutputListener(tempOutputListener);
+ return buf.toString();
+ }
+
public String asCommand() {
return createCommandLine().toString();
}
throw new SlcException(
"Specify the command either as a line or as a list.");
else if (cmdToUse != null) {
+ if (chroot != null && !chroot.trim().equals(""))
+ cmdToUse = "chroot \"" + chroot + "\" " + cmdToUse;
+ if (sudo != null) {
+ environmentVariables.put("SUDO_ASKPASS", askPassProgram);
+ if (!sudo.trim().equals(""))
+ cmdToUse = "sudo -p " + sudoPrompt + " -u " + sudo + " "
+ + cmdToUse;
+ else
+ cmdToUse = "sudo -p " + sudoPrompt + " " + cmdToUse;
+ }
+
+ // GENERATE COMMAND LINE
commandLine = CommandLine.parse(cmdToUse);
} else if (commandToUse != null) {
if (commandToUse.size() == 0)
throw new SlcException("Command line is empty.");
+ if (chroot != null && sudo != null) {
+ commandToUse.add(0, "chroot");
+ commandToUse.add(1, chroot);
+ }
+
+ if (sudo != null) {
+ environmentVariables.put("SUDO_ASKPASS", askPassProgram);
+ commandToUse.add(0, "sudo");
+ commandToUse.add(1, "-p");
+ commandToUse.add(2, sudoPrompt);
+ if (!sudo.trim().equals("")) {
+ commandToUse.add(3, "-u");
+ commandToUse.add(4, sudo);
+ }
+ }
+
+ // GENERATE COMMAND LINE
commandLine = new CommandLine(commandToUse.get(0).toString());
for (int i = 1; i < commandToUse.size(); i++) {
final Writer stdErrWriter, final InputStream stdInStream) {
// Log writers
-
- PumpStreamHandler pumpStreamHandler = new PumpStreamHandler(
- stdOutputStream != null ? stdOutputStream
- : new LogOutputStream() {
- protected void processLine(String line, int level) {
- if (line != null && !line.trim().equals(""))
- log(stdOutLogLevel, line);
- if (stdOutWriter != null)
- appendLineToFile(stdOutWriter, line);
- }
- }, new LogOutputStream() {
+ OutputStream stdout = stdOutputStream != null ? stdOutputStream
+ : new LogOutputStream() {
protected void processLine(String line, int level) {
+ // if (firstLine) {
+ // if (sudo != null && callbackHandler != null
+ // && line.startsWith(sudoPrompt)) {
+ // try {
+ // PasswordCallback pc = new PasswordCallback(
+ // "sudo password", false);
+ // Callback[] cbs = { pc };
+ // callbackHandler.handle(cbs);
+ // char[] pwd = pc.getPassword();
+ // char[] arr = Arrays.copyOf(pwd,
+ // pwd.length + 1);
+ // arr[arr.length - 1] = '\n';
+ // IOUtils.write(arr, stdInSink);
+ // stdInSink.flush();
+ // } catch (Exception e) {
+ // throw new SlcException(
+ // "Cannot retrieve sudo password", e);
+ // }
+ // }
+ // firstLine = false;
+ // }
+
if (line != null && !line.trim().equals(""))
- log(stdErrLogLevel, line);
- if (stdErrWriter != null)
- appendLineToFile(stdErrWriter, line);
+ logStdOut(line);
+
+ if (stdOutWriter != null)
+ appendLineToFile(stdOutWriter, line);
}
- }, stdInStream);
+ };
+
+ OutputStream stderr = new LogOutputStream() {
+ protected void processLine(String line, int level) {
+ if (line != null && !line.trim().equals(""))
+ logStdErr(line);
+ if (stdErrWriter != null)
+ appendLineToFile(stdErrWriter, line);
+ }
+ };
+
+ PumpStreamHandler pumpStreamHandler = new PumpStreamHandler(stdout,
+ stderr, stdInStream) {
+
+ @Override
+ public void stop() {
+ // prevents the method to block when joining stdin
+ if (stdInSink != null)
+ IOUtils.closeQuietly(stdInSink);
+
+ super.stop();
+ }
+ };
return pumpStreamHandler;
}
public void onProcessComplete(int exitValue) {
String msg = "System call '" + commandLine
+ "' properly completed.";
- if (log.isDebugEnabled())
- log.debug(msg);
+ if (log.isTraceEnabled())
+ log.trace(msg);
if (testResult != null) {
- forwardPath(testResult, null);
+ forwardPath(testResult);
testResult.addResultPart(new SimpleResultPart(
TestStatus.PASSED, msg));
}
}
public void onProcessFailed(ExecuteException e) {
+
String msg = "System call '" + commandLine + "' failed.";
if (testResult != null) {
- forwardPath(testResult, null);
+ forwardPath(testResult);
testResult.addResultPart(new SimpleResultPart(
TestStatus.ERROR, msg, e));
} else {
};
}
+ @Deprecated
+ protected void forwardPath(TestResult testResult) {
+ // TODO: allocate a TreeSPath
+ }
+
/**
* Shortcut method getting the execDir to use
*/
protected String getExecDirToUse() {
try {
- File dir = null;
if (execDir != null) {
- // Replace '/' by local file separator, for portability
- execDir.replace('/', File.separatorChar);
- dir = new File(execDir).getCanonicalFile();
+ return execDir;
}
-
- if (dir == null)
- return System.getProperty("user.dir");
- else
- return dir.getPath();
+ return System.getProperty("user.dir");
} catch (Exception e) {
throw new SlcException("Cannot find exec dir", e);
}
}
+ protected void logStdOut(String line) {
+ for (SystemCallOutputListener outputListener : outputListeners)
+ outputListener.newLine(this, line, false);
+ log(stdOutLogLevel, line);
+ }
+
+ protected void logStdErr(String line) {
+ for (SystemCallOutputListener outputListener : outputListeners)
+ outputListener.newLine(this, line, true);
+ log(stdErrLogLevel, line);
+ }
+
/** Log from the underlying streams. */
protected void log(String logLevel, String line) {
+ // TODO optimize
+ if (SecurityContextHolder.getContext().getAuthentication() == null) {
+ SecurityContextHolder.getContext()
+ .setAuthentication(authentication);
+ }
+
if ("ERROR".equals(logLevel))
log.error(line);
else if ("WARN".equals(logLevel))
log.debug(line);
else if ("TRACE".equals(logLevel))
log.trace(line);
- else if ("System.out".equals(logLevel))
+ else if (LOG_STDOUT.equals(logLevel))
System.out.println(line);
else if ("System.err".equals(logLevel))
System.err.println(line);
/** Creates an outputstream for the output/err files. */
protected OutputStream createOutputStream(Resource target) {
- FileOutputStream OutputStream = null;
+ FileOutputStream out = null;
try {
final File file;
file = new File(executionResources.getAsOsPath(target, true));
else
file = target.getFile();
- OutputStream = new FileOutputStream(file, false);
+ out = new FileOutputStream(file, false);
} catch (IOException e) {
log.error("Cannot get file for " + target, e);
- IOUtils.closeQuietly(OutputStream);
+ IOUtils.closeQuietly(out);
}
- return OutputStream;
+ return out;
}
/** Append the argument (for chaining) */
public SystemCall arg(String arg) {
+ if (command == null)
+ command = new ArrayList<Object>();
command.add(arg);
return this;
}
/** Append the argument (for chaining) */
public SystemCall arg(String arg, String value) {
+ if (command == null)
+ command = new ArrayList<Object>();
command.add(arg);
command.add(value);
return this;
this.environmentVariables = environmentVariables;
}
+ public Map<String, String> getEnvironmentVariables() {
+ return environmentVariables;
+ }
+
public void setWatchdogTimeout(Long watchdogTimeout) {
this.watchdogTimeout = watchdogTimeout;
}
this.redirectStdOut = redirectStdOut;
}
+ public void addOutputListener(SystemCallOutputListener outputListener) {
+ outputListeners.add(outputListener);
+ }
+
+ public void removeOutputListener(SystemCallOutputListener outputListener) {
+ outputListeners.remove(outputListener);
+ }
+
+ public void setOutputListeners(
+ List<SystemCallOutputListener> outputListeners) {
+ this.outputListeners = outputListeners;
+ }
+
+ public void setExecutor(Executor executor) {
+ this.executor = executor;
+ }
+
+ public void setSudo(String sudo) {
+ this.sudo = sudo;
+ }
+
+ public void setCallbackHandler(CallbackHandler callbackHandler) {
+ this.callbackHandler = callbackHandler;
+ }
+
+ public void setChroot(String chroot) {
+ this.chroot = chroot;
+ }
+
private class DummyexecuteStreamHandler implements ExecuteStreamHandler {
public void setProcessErrorStream(InputStream is) throws IOException {
}
}
-
}
projects / gpl / argeo-slc.git / blobdiff