package org.argeo.slc.core.execution.tasks; import java.io.File; import java.io.FileWriter; import java.io.IOException; import java.io.Writer; import java.util.HashMap; import java.util.List; import java.util.Map; 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.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.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.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 { private final Log log = LogFactory.getLog(getClass()); private String execDir; private String cmd = null; private List command = null; private Boolean synchronous = true; private String stdErrLogLevel = "ERROR"; private String stdOutLogLevel = "INFO"; private Resource stdOutFile = null; private Resource stdErrFile = null; private Map> osCommands = new HashMap>(); private Map osCmds = new HashMap(); private Map environmentVariables = new HashMap(); private Long watchdogTimeout = 24 * 60 * 60 * 1000l; private TestResult testResult; public SystemCall() { } public SystemCall(List command) { super(); this.command = command; } public void run() { // Log writers final Writer stdOutWriter; final Writer stdErrWriter; if (stdOutFile != null) { stdOutWriter = createWriter(stdOutFile); } else stdOutWriter = null; if (stdErrFile != null) { stdErrWriter = createWriter(stdErrFile); } else { if (stdOutFile != null) { stdErrWriter = createWriter(stdOutFile); } else stdErrWriter = null; } 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")); } // Execution directory File dir = null; if (execDir != null) { // Replace '/' by local file separator, for portability execDir.replace('/', File.separatorChar); dir = new File(execDir).getCanonicalFile(); } // Prepare executor if (dir == null) dir = new File(getUsedDir(dir)); if (!dir.exists()) dir.mkdirs(); // Watchdog to check for lost processes Executor executor = new DefaultExecutor(); executor.setWatchdog(new ExecuteWatchdog(watchdogTimeout)); // 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.")); } } 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); } } }; if (synchronous) try { int exitValue = executor.execute(commandLine, environmentVariablesToUse); executeResultHandler.onProcessComplete(exitValue); } catch (ExecuteException e1) { executeResultHandler.onProcessFailed(e1); } else executor.execute(commandLine, environmentVariablesToUse, executeResultHandler); } catch (Exception e) { throw new SlcException("Could not execute command " + cmd, e); } finally { IOUtils.closeQuietly(stdOutWriter); IOUtils.closeQuietly(stdErrWriter); } } /** Can be overridden by specific command wrapper*/ protected CommandLine createCommandLine() { // Check if an OS specific command overrides String osName = System.getProperty("os.name"); List commandToUse = null; if (osCommands.containsKey(osName)) commandToUse = osCommands.get(osName); else commandToUse = command; String cmdToUse = null; if (osCmds.containsKey(osName)) cmdToUse = osCmds.get(osName); else cmdToUse = cmd; final CommandLine commandLine; // Which command definition to use if (commandToUse == null && cmdToUse == null) throw new SlcException("Please specify a command."); else if (commandToUse != null && cmdToUse != null) throw new SlcException( "Specify the command either as a line or as a list."); else if (cmdToUse != null) { commandLine = CommandLine.parse(cmdToUse); } else if (commandToUse != null) { if (commandToUse.size() == 0) throw new SlcException("Command line is empty."); commandLine = new CommandLine(commandToUse.get(0).toString()); for (int i = 1; i < commandToUse.size(); i++) commandLine.addArgument(commandToUse.get(i).toString()); } else { // all cases covered previously throw new UnsupportedOperationException(); } return commandLine; } /** * Shortcut method returning the current exec dir if the specified one is * null. */ private String getUsedDir(File dir) { if (dir == null) return System.getProperty("user.dir"); else return dir.getPath(); } protected void log(String logLevel, String line) { if ("ERROR".equals(logLevel)) log.error(line); else if ("WARN".equals(logLevel)) log.warn(line); else if ("INFO".equals(logLevel)) log.info(line); else if ("DEBUG".equals(logLevel)) log.debug(line); else if ("TRACE".equals(logLevel)) log.trace(line); else throw new SlcException("Unknown log level " + logLevel); } protected void appendLineToFile(Writer writer, String line) { try { writer.append(line).append('\n'); } catch (IOException e) { log.error("Cannot write to log file", e); } } protected Writer createWriter(Resource target) { FileWriter writer = null; try { File file = target.getFile(); writer = new FileWriter(file, true); } catch (IOException e) { log.error("Cannot create log file " + target, e); IOUtils.closeQuietly(writer); } return writer; } public void setCmd(String command) { this.cmd = command; } public void setExecDir(String execdir) { this.execDir = execdir; } public void setStdErrLogLevel(String stdErrLogLevel) { this.stdErrLogLevel = stdErrLogLevel; } public void setStdOutLogLevel(String stdOutLogLevel) { this.stdOutLogLevel = stdOutLogLevel; } public void setSynchronous(Boolean synchronous) { this.synchronous = synchronous; } public void setCommand(List command) { this.command = command; } public void setOsCommands(Map> osCommands) { this.osCommands = osCommands; } public void setOsCmds(Map osCmds) { this.osCmds = osCmds; } public void setEnvironmentVariables(Map environmentVariables) { this.environmentVariables = environmentVariables; } public void setWatchdogTimeout(Long watchdogTimeout) { this.watchdogTimeout = watchdogTimeout; } public void setStdOutFile(Resource stdOutFile) { this.stdOutFile = stdOutFile; } public void setStdErrFile(Resource stdErrFile) { this.stdErrFile = stdErrFile; } public void setTestResult(TestResult testResult) { this.testResult = testResult; } }