X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;f=runtime%2Forg.argeo.slc.core%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fcore%2Fexecution%2Ftasks%2FSystemCall.java;h=9d8ebdcf8785920a459be223eed70596ea693e5c;hb=e875b40fba70bb76fed1e2f3ff77c9adca1be1a4;hp=f3314ac7f46616b9b84334e1a60e4dec6410d335;hpb=09ab1aca27488e1feef6c8f46b34b7d27284be9a;p=gpl%2Fargeo-slc.git diff --git a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/tasks/SystemCall.java b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/tasks/SystemCall.java index f3314ac7f..9d8ebdcf8 100644 --- a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/tasks/SystemCall.java +++ b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/tasks/SystemCall.java @@ -1,9 +1,14 @@ package org.argeo.slc.core.execution.tasks; import java.io.File; +import java.io.FileOutputStream; import java.io.FileWriter; import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; import java.io.Writer; +import java.util.ArrayList; +import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -12,26 +17,29 @@ import org.apache.commons.exec.CommandLine; import org.apache.commons.exec.DefaultExecutor; import org.apache.commons.exec.ExecuteException; import org.apache.commons.exec.ExecuteResultHandler; +import org.apache.commons.exec.ExecuteStreamHandler; import org.apache.commons.exec.ExecuteWatchdog; import org.apache.commons.exec.Executor; import org.apache.commons.exec.LogOutputStream; import org.apache.commons.exec.PumpStreamHandler; import org.apache.commons.exec.ShutdownHookProcessDestroyer; +import org.apache.commons.io.FileUtils; import org.apache.commons.io.IOUtils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.argeo.slc.SlcException; -import org.argeo.slc.core.structure.tree.TreeSPath; +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.structure.StructureAware; import org.argeo.slc.test.TestResult; import org.argeo.slc.test.TestStatus; import org.springframework.core.io.Resource; -/** Execute and OS system call. */ -public class SystemCall extends TreeSRelatedHelper implements Runnable, - StructureAware { +/** Execute an OS specific system call. */ +public class SystemCall extends TreeSRelatedHelper implements Runnable { + public final static String LOG_STDOUT = "System.out"; + private final Log log = LogFactory.getLog(getClass()); private String execDir; @@ -46,120 +54,139 @@ public class SystemCall extends TreeSRelatedHelper implements Runnable, private Resource stdOutFile = null; private Resource stdErrFile = null; + private Resource stdInFile = null; + private Boolean redirectStdOut = false; + + private List outputListeners = Collections + .synchronizedList(new ArrayList()); private Map> osCommands = new HashMap>(); private Map osCmds = new HashMap(); private Map environmentVariables = new HashMap(); + private Boolean logCommand = false; + private Boolean redirectStreams = true; + private Boolean exceptionOnFailed = true; + private Boolean mergeEnvironmentVariables = true; + + private String osConsole = null; + private String generateScript = null; + private Long watchdogTimeout = 24 * 60 * 60 * 1000l; private TestResult testResult; + private ExecutionResources executionResources; + + /** Empty constructor */ public SystemCall() { } + /** + * Constructor based on the provided command list. + * + * @param command + * the command list + */ public SystemCall(List command) { - super(); this.command = command; } + /** + * Constructor based on the provided command. + * + * @param cmd + * the command. If the provided string contains no space a + * command list is initialized with the argument as first + * component (useful for chained construction) + */ + public SystemCall(String cmd) { + if (cmd.indexOf(' ') < 0) { + command = new ArrayList(); + command.add(cmd); + } else { + this.cmd = cmd; + } + } + + /** Executes the system call. */ public void run() { - // Log writers - final Writer stdOutWriter; - final Writer stdErrWriter; - if (stdOutFile != null) { - stdOutWriter = createWriter(stdOutFile); - } else - stdOutWriter = null; + // Manage streams + Writer stdOutWriter = null; + OutputStream stdOutputStream = null; + Writer stdErrWriter = null; + InputStream stdInStream = null; + if (stdOutFile != null) + if (redirectStdOut) + stdOutputStream = createOutputStream(stdOutFile); + else + stdOutWriter = createWriter(stdOutFile, true); + if (stdErrFile != null) { - stdErrWriter = createWriter(stdErrFile); + stdErrWriter = createWriter(stdErrFile, true); } else { - if (stdOutFile != null) { - stdErrWriter = createWriter(stdOutFile); - } else - stdErrWriter = null; + if (stdOutFile != null && !redirectStdOut) + stdErrWriter = createWriter(stdOutFile, true); } - try { - if (log.isTraceEnabled()) { - log.debug("os.name=" + System.getProperty("os.name")); - log.debug("os.arch=" + System.getProperty("os.arch")); - log.debug("os.version=" + System.getProperty("os.version")); + if (stdInFile != null) + try { + stdInStream = stdInFile.getInputStream(); + } catch (IOException e2) { + throw new SlcException("Cannot open a stream for " + stdInFile, + e2); } - // Execution directory - File dir = null; - if (execDir != null) { - // Replace '/' by local file separator, for portability - execDir.replace('/', File.separatorChar); - dir = new File(execDir).getCanonicalFile(); - } + if (log.isTraceEnabled()) { + log.debug("os.name=" + System.getProperty("os.name")); + log.debug("os.arch=" + System.getProperty("os.arch")); + log.debug("os.version=" + System.getProperty("os.version")); + } - // Prepare executor - if (dir == null) - dir = new File(getUsedDir(dir)); - if (!dir.exists()) - dir.mkdirs(); + // Execution directory + File dir = new File(getExecDirToUse()); + if (!dir.exists()) + dir.mkdirs(); - // Watchdog to check for lost processes - Executor executor = new DefaultExecutor(); - executor.setWatchdog(new ExecuteWatchdog(watchdogTimeout)); + // Watchdog to check for lost processes + Executor executor = new DefaultExecutor(); + executor.setWatchdog(new ExecuteWatchdog(watchdogTimeout)); + if (redirectStreams) { // Redirect standard streams - PumpStreamHandler pumpStreamHandler = new PumpStreamHandler( - new LogOutputStream() { - protected void processLine(String line, int level) { - log(stdOutLogLevel, line); - if (stdOutWriter != null) - appendLineToFile(stdOutWriter, line); - } - }, new LogOutputStream() { - protected void processLine(String line, int level) { - log(stdErrLogLevel, line); - if (stdErrWriter != null) - appendLineToFile(stdErrWriter, line); - } - }, null); - executor.setStreamHandler(pumpStreamHandler); - executor.setProcessDestroyer(new ShutdownHookProcessDestroyer()); - executor.setWorkingDirectory(dir); - - // Command line to use - final CommandLine commandLine = createCommandLine(); - - // Env variables - Map environmentVariablesToUse = environmentVariables - .size() > 0 ? environmentVariables : null; - - // Execute - ExecuteResultHandler executeResultHandler = new ExecuteResultHandler() { - - public void onProcessComplete(int exitValue) { - if (log.isDebugEnabled()) - log.debug("Process " + commandLine - + " properly completed."); - if (testResult != null) { - forwardPath(testResult, null); - testResult.addResultPart(new SimpleResultPart( - TestStatus.PASSED, "Process " + commandLine - + " properly completed.")); - } - } + executor.setStreamHandler(createExecuteStreamHandler(stdOutWriter, + stdOutputStream, stdErrWriter, stdInStream)); + } else { + // Dummy stream handler (otherwise pump is used) + executor.setStreamHandler(new DummyexecuteStreamHandler()); + } - public void onProcessFailed(ExecuteException e) { - if (testResult != null) { - forwardPath(testResult, null); - testResult.addResultPart(new SimpleResultPart( - TestStatus.ERROR, "Process " + commandLine - + " failed.", e)); - } else { - throw new SlcException("Process " + commandLine - + " failed.", e); - } - } - }; + executor.setProcessDestroyer(new ShutdownHookProcessDestroyer()); + executor.setWorkingDirectory(dir); + + // Command line to use + final CommandLine commandLine = createCommandLine(); + if (logCommand) + log.info("Execute command:\n" + commandLine + + "\n in working directory: \n" + dir + "\n"); + + // Env variables + Map environmentVariablesToUse = null; + if (environmentVariables.size() > 0) { + environmentVariablesToUse = new HashMap(); + if (mergeEnvironmentVariables) + environmentVariablesToUse.putAll(System.getenv()); + environmentVariablesToUse.putAll(environmentVariables); + } + + // Execute + ExecuteResultHandler executeResultHandler = createExecuteResultHandler(commandLine); + // + // THE EXECUTION PROPER + // + try { if (synchronous) try { int exitValue = executor.execute(commandLine, @@ -171,16 +198,47 @@ public class SystemCall extends TreeSRelatedHelper implements Runnable, else executor.execute(commandLine, environmentVariablesToUse, executeResultHandler); + } catch (SlcException e) { + throw e; } catch (Exception e) { - throw new SlcException("Could not execute command " + cmd, e); + throw new SlcException("Could not execute command " + commandLine, + e); } finally { IOUtils.closeQuietly(stdOutWriter); IOUtils.closeQuietly(stdErrWriter); + IOUtils.closeQuietly(stdInStream); } } - /** Can be overridden by specific command wrapper*/ + public synchronized String function() { + final StringBuffer buf = new StringBuffer(""); + SystemCallOutputListener tempOutputListener = new SystemCallOutputListener() { + public void newLine(SystemCall systemCall, String line, + Boolean isError) { + if (!isError) + buf.append(line); + } + }; + addOutputListener(tempOutputListener); + run(); + removeOutputListener(tempOutputListener); + return buf.toString(); + } + + public String asCommand() { + return createCommandLine().toString(); + } + + @Override + public String toString() { + return asCommand(); + } + + /** + * Build a command line based on the properties. Can be overridden by + * specific command wrappers. + */ protected CommandLine createCommandLine() { // Check if an OS specific command overrides String osName = System.getProperty("os.name"); @@ -195,7 +253,7 @@ public class SystemCall extends TreeSRelatedHelper implements Runnable, else cmdToUse = cmd; - final CommandLine commandLine; + CommandLine commandLine = null; // Which command definition to use if (commandToUse == null && cmdToUse == null) @@ -210,26 +268,135 @@ public class SystemCall extends TreeSRelatedHelper implements Runnable, throw new SlcException("Command line is empty."); commandLine = new CommandLine(commandToUse.get(0).toString()); - for (int i = 1; i < commandToUse.size(); i++) + + for (int i = 1; i < commandToUse.size(); i++) { + if (log.isTraceEnabled()) + log.debug(commandToUse.get(i)); commandLine.addArgument(commandToUse.get(i).toString()); + } } else { // all cases covered previously - throw new UnsupportedOperationException(); + throw new UnsupportedException(); + } + + if (generateScript != null) { + File scriptFile = new File(getExecDirToUse() + File.separator + + generateScript); + try { + FileUtils.writeStringToFile(scriptFile, + (osConsole != null ? osConsole + " " : "") + + commandLine.toString()); + } catch (IOException e) { + throw new SlcException("Could not generate script " + + scriptFile, e); + } + commandLine = new CommandLine(scriptFile); + } else { + if (osConsole != null) + commandLine = CommandLine.parse(osConsole + " " + + commandLine.toString()); } + return commandLine; } /** - * Shortcut method returning the current exec dir if the specified one is - * null. + * Creates a {@link PumpStreamHandler} which redirects streams to the custom + * logging mechanism. */ - private String getUsedDir(File dir) { - if (dir == null) - return System.getProperty("user.dir"); - else - return dir.getPath(); + protected ExecuteStreamHandler createExecuteStreamHandler( + final Writer stdOutWriter, final OutputStream stdOutputStream, + 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("")) + logStdOut(line); + if (stdOutWriter != null) + appendLineToFile(stdOutWriter, line); + } + }, new LogOutputStream() { + protected void processLine(String line, int level) { + if (line != null && !line.trim().equals("")) + logStdErr(line); + if (stdErrWriter != null) + appendLineToFile(stdErrWriter, line); + } + }, stdInStream); + return pumpStreamHandler; + } + + /** Creates the default {@link ExecuteResultHandler}. */ + protected ExecuteResultHandler createExecuteResultHandler( + final CommandLine commandLine) { + return new ExecuteResultHandler() { + + public void onProcessComplete(int exitValue) { + String msg = "System call '" + commandLine + + "' properly completed."; + if (log.isTraceEnabled()) + log.trace(msg); + if (testResult != null) { + forwardPath(testResult, null); + testResult.addResultPart(new SimpleResultPart( + TestStatus.PASSED, msg)); + } + } + + public void onProcessFailed(ExecuteException e) { + String msg = "System call '" + commandLine + "' failed."; + if (testResult != null) { + forwardPath(testResult, null); + testResult.addResultPart(new SimpleResultPart( + TestStatus.ERROR, msg, e)); + } else { + if (exceptionOnFailed) + throw new SlcException(msg, e); + else + log.error(msg, e); + } + } + }; + } + + /** + * 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(); + } + + if (dir == null) + return System.getProperty("user.dir"); + else + return dir.getPath(); + } 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) { if ("ERROR".equals(logLevel)) log.error(line); @@ -241,10 +408,15 @@ public class SystemCall extends TreeSRelatedHelper implements Runnable, log.debug(line); else if ("TRACE".equals(logLevel)) log.trace(line); + else if (LOG_STDOUT.equals(logLevel)) + System.out.println(line); + else if ("System.err".equals(logLevel)) + System.err.println(line); else throw new SlcException("Unknown log level " + logLevel); } + /** Append line to a log file. */ protected void appendLineToFile(Writer writer, String line) { try { writer.append(line).append('\n'); @@ -253,22 +425,64 @@ public class SystemCall extends TreeSRelatedHelper implements Runnable, } } - protected Writer createWriter(Resource target) { + /** Creates the writer for the output/err files. */ + protected Writer createWriter(Resource target, Boolean append) { FileWriter writer = null; try { - File file = target.getFile(); - writer = new FileWriter(file, true); + + final File file; + if (executionResources != null) + file = new File(executionResources.getAsOsPath(target, true)); + else + file = target.getFile(); + writer = new FileWriter(file, append); } catch (IOException e) { - log.error("Cannot create log file " + target, e); + log.error("Cannot get file for " + target, e); IOUtils.closeQuietly(writer); } return writer; } + /** Creates an outputstream for the output/err files. */ + protected OutputStream createOutputStream(Resource target) { + FileOutputStream out = null; + try { + + final File file; + if (executionResources != null) + file = new File(executionResources.getAsOsPath(target, true)); + else + file = target.getFile(); + out = new FileOutputStream(file, false); + } catch (IOException e) { + log.error("Cannot get file for " + target, e); + IOUtils.closeQuietly(out); + } + return out; + } + + /** Append the argument (for chaining) */ + public SystemCall arg(String arg) { + command.add(arg); + return this; + } + + /** Append the argument (for chaining) */ + public SystemCall arg(String arg, String value) { + command.add(arg); + command.add(value); + return this; + } + + /** */ public void setCmd(String command) { this.cmd = command; } + public void setCommand(List command) { + this.command = command; + } + public void setExecDir(String execdir) { this.execDir = execdir; } @@ -285,10 +499,6 @@ public class SystemCall extends TreeSRelatedHelper implements Runnable, this.synchronous = synchronous; } - public void setCommand(List command) { - this.command = command; - } - public void setOsCommands(Map> osCommands) { this.osCommands = osCommands; } @@ -313,8 +523,76 @@ public class SystemCall extends TreeSRelatedHelper implements Runnable, this.stdErrFile = stdErrFile; } + public void setStdInFile(Resource stdInFile) { + this.stdInFile = stdInFile; + } + public void setTestResult(TestResult testResult) { this.testResult = testResult; } + public void setLogCommand(Boolean logCommand) { + this.logCommand = logCommand; + } + + public void setRedirectStreams(Boolean redirectStreams) { + this.redirectStreams = redirectStreams; + } + + public void setExceptionOnFailed(Boolean exceptionOnFailed) { + this.exceptionOnFailed = exceptionOnFailed; + } + + public void setMergeEnvironmentVariables(Boolean mergeEnvironmentVariables) { + this.mergeEnvironmentVariables = mergeEnvironmentVariables; + } + + public void setOsConsole(String osConsole) { + this.osConsole = osConsole; + } + + public void setGenerateScript(String generateScript) { + this.generateScript = generateScript; + } + + public void setExecutionResources(ExecutionResources executionResources) { + this.executionResources = executionResources; + } + + public void setRedirectStdOut(Boolean redirectStdOut) { + this.redirectStdOut = redirectStdOut; + } + + public void addOutputListener(SystemCallOutputListener outputListener) { + outputListeners.add(outputListener); + } + + public void removeOutputListener(SystemCallOutputListener outputListener) { + outputListeners.remove(outputListener); + } + + public void setOutputListeners( + List outputListeners) { + this.outputListeners = outputListeners; + } + + private class DummyexecuteStreamHandler implements ExecuteStreamHandler { + + public void setProcessErrorStream(InputStream is) throws IOException { + } + + public void setProcessInputStream(OutputStream os) throws IOException { + } + + public void setProcessOutputStream(InputStream is) throws IOException { + } + + public void start() throws IOException { + } + + public void stop() { + } + + } + }