Skip to content

Improve logs on ProcessRunner #4703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DaanHoogland merged 2 commits into from
Jun 10, 2021
Merged

Improve logs on ProcessRunner #4703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
870c0a6
Improve logs on ProcessRunner
Feb 18, 2021
4992308
Adjust ProcessTest
Feb 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions utils/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,10 @@
<groupId>org.apache.commons</groupId>
<artifactId>commons-compress</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
Expand Down
28 changes: 15 additions & 13 deletions utils/src/main/java/org/apache/cloudstack/utils/process/ProcessRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import org.apache.commons.lang3.StringUtils;

@DaanHoogland DaanHoogland Feb 18, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please refer com.cloud.utils.StringUtils, and add a proxy method there if you need one.

@GutoVeronezi GutoVeronezi Feb 22, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DaanHoogland as discussed in the review #4702 (review), it will not be done.

@DaanHoogland DaanHoogland Feb 23, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thois is bad


public final class ProcessRunner {
public static final Logger LOG = Logger.getLogger(ProcessRunner.class);
Expand Down Expand Up @@ -73,43 +74,44 @@ public ProcessResult executeCommands(final List<String> commands, final Duration
String stdOutput = null;
String stdError = null;

String oneLineCommand = StringUtils.join(commands, " ");

try {
LOG.debug(String.format("Preparing command [%s] to execute.", oneLineCommand));
final Process process = new ProcessBuilder().command(commands).start();

LOG.debug(String.format("Submitting command [%s].", oneLineCommand));
final Future<Integer> processFuture = executor.submit(new Callable<Integer>() {
@Override
public Integer call() throws Exception {
return process.waitFor();
}
});
try {
LOG.debug(String.format("Waiting for a response from command [%s]. Defined timeout: [%s].", oneLineCommand, timeOut.getStandardSeconds()));
retVal = processFuture.get(timeOut.getStandardSeconds(), TimeUnit.SECONDS);
} catch (ExecutionException e) {
LOG.warn(String.format("Failed to complete the requested command [%s] due to execution error.", oneLineCommand), e);
retVal = -2;
stdError = e.getMessage();
if (LOG.isTraceEnabled()) {
LOG.trace("Failed to complete the requested command due to execution error: " + e.getMessage());
}
} catch (TimeoutException e) {
LOG.warn(String.format("Failed to complete the requested command [%s] within timeout. Defined timeout: [%s].", oneLineCommand, timeOut.getStandardSeconds()), e);
retVal = -1;
stdError = "Operation timed out, aborted";
if (LOG.isTraceEnabled()) {
LOG.trace("Failed to complete the requested command within timeout: " + e.getMessage());
}
stdError = "Operation timed out, aborted.";
} finally {
if (Strings.isNullOrEmpty(stdError)) {
stdOutput = CharStreams.toString(new InputStreamReader(process.getInputStream()));
stdError = CharStreams.toString(new InputStreamReader(process.getErrorStream()));
}
process.destroy();
}
if (LOG.isTraceEnabled()) {
LOG.trace("Process standard output: " + stdOutput);
LOG.trace("Process standard error output: " + stdError);
}

LOG.debug(String.format("Process standard output for command [%s]: [%s].", oneLineCommand, stdOutput));
LOG.debug(String.format("Process standard error output command [%s]: [%s].", oneLineCommand, stdError));
} catch (IOException | InterruptedException e) {
LOG.error(String.format("Exception caught error running command [%s].", oneLineCommand), e);
stdError = e.getMessage();
LOG.error("Exception caught error running commands: " + e.getMessage());
}
return new ProcessResult(stdOutput, stdError, retVal);
}
}
}
4 changes: 2 additions & 2 deletions utils/src/test/java/org/apache/cloudstack/utils/process/ProcessTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,15 @@ public void testProcessRunnerWithTimeout() {
ProcessResult result = RUNNER.executeCommands(Arrays.asList("sleep", "5"), Duration.standardSeconds(1));
Assert.assertNotEquals(result.getReturnCode(), 0);
Assert.assertTrue(result.getStdError().length() > 0);
Assert.assertEquals(result.getStdError(), "Operation timed out, aborted");
Assert.assertEquals(result.getStdError(), "Operation timed out, aborted.");
}

@Test
public void testProcessRunnerWithTimeoutAndException() {
ProcessResult result = RUNNER.executeCommands(Arrays.asList("ls", "/some/dir/that/should/not/exist"), Duration.standardSeconds(2));
Assert.assertNotEquals(result.getReturnCode(), 0);
Assert.assertTrue(result.getStdError().length() > 0);
Assert.assertNotEquals(result.getStdError(), "Operation timed out, aborted");
Assert.assertNotEquals(result.getStdError(), "Operation timed out, aborted.");
}

@Test(expected = IllegalArgumentException.class)
Expand Down