Refactoring of current function to adjust to change.
Modifications to test scenarios to support new error output
Change-Id: I457aeed7ae6aba1ce880339c5a9b7f55c6a0e232
Signed-off-by: Jonathan Rajotte Julien <jonathan.rajotte-julien@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/31228
Tested-by: Hudson CI
Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
private final static String RESULT_KEY = "<COMMAND_RESULT>";
private final static String OUTPUT_KEY = "<COMMAND_OUTPUT>";
private final static String OUTPUT_END_KEY = "</COMMAND_OUTPUT>";
+ private final static String ERROR_OUTPUT_KEY = "<COMMAND_ERROR_OUTPUT>";
+ private final static String ERROR_OUTPUT_END_KEY = "</COMMAND_ERROR_OUTPUT>";
private final static String COMMENT_KEY = "#.*";
private final static Pattern LTTNG_LIST_SESSION_PATTERN = Pattern.compile("lttng\\s+list\\s+(.+)");
/**
* Parse a scenario file with the format:
- * <SCENARIO>
+ * <pre>
+ * <SCENARIO>
* ScenarioName
*
- * <COMMAND_INPUT>
+ * <COMMAND_INPUT>
* Command
- * </COMAND_INPUT>
+ * </COMAND_INPUT>
*
- * <COMMAND_RESULT>
+ * <COMMAND_RESULT>
* CommandResult
- * </COMMAND_RESULT>
+ * </COMMAND_RESULT>
*
- * <COMMAND_OUTPUT>
+ * <COMMAND_OUTPUT>
* CommandOutput
- * </COMMAND_OUTPUT>
+ * <COMMAND_ERROR_OUTPUT>
+ * CommandErrorOutput
+ * </COMMAND_ERROR_OUTPUT>
+ * </COMMAND_OUTPUT>
*
- * </SCENARIO>
+ * </SCENARIO>
*
* Where: ScenarioName - is the scenario name
* Command - the command line string
* CommandResult - the result integer of the command (0 for success, 1 for failure)
* ComandOutput - the command output string (multi-line possible)
+ * ComandErrorOutput - the command error output string (multi-line possible)
*
* Note: 1) There can be many scenarios per file
* 2) There can be many (Command-CommandResult-CommandOutput) triples per scenario
* 3) Lines starting with # will be ignored (comments)
- *
+ * <pre>
* @param scenariofile - path to scenario file
* @throws Exception
*/
Map<String, ICommandResult> commandMap = new HashMap<>();
fScenarioMap.put(scenario, commandMap);
List<String> output = null;
+ List<String> errorOutput = null;
String input = null;
boolean inOutput = false;
+ boolean inErrorOutput = false;
int result = 0;
tmpSessionNameMap.clear();
while ((strLine = br.readLine()) != null) {
} else if (INPUT_END_KEY.equals(strLine)) {
// Initialize output array
output = new ArrayList<>();
+ errorOutput = new ArrayList<>();
} else if (RESULT_KEY.equals(strLine)) {
strLine = br.readLine();
// Ignore comments
result = Integer.parseInt(strLine);
} else if (OUTPUT_END_KEY.equals(strLine)) {
// Save output/result in command map
- if (output != null) {
- commandMap.put(input, new CommandResult(result, output.toArray(new String[output.size()])));
+ if (output != null && errorOutput != null) {
+ commandMap.put(input, new CommandResult(result, output.toArray(new String[output.size()]), errorOutput.toArray(new String[errorOutput.size()])));
}
inOutput = false;
} else if (OUTPUT_KEY.equals(strLine)) {
// first line of output
inOutput = true;
- strLine = br.readLine();
-
- // Ignore comments
+ } else if (ERROR_OUTPUT_KEY.equals(strLine)) {
+ // first line of output
+ inErrorOutput = true;
+ } else if (ERROR_OUTPUT_END_KEY.equals(strLine)) {
+ inErrorOutput = false;
+ } else if (inOutput) {
while (isComment(strLine)) {
strLine = br.readLine();
}
- if (output != null) {
- output.add(strLine);
- }
- } else if (inOutput) {
- // subsequent lines of output
- if (output != null) {
+ // lines of output/error output
+ if (errorOutput != null && inErrorOutput) {
+ errorOutput.add(strLine);
+ } else if (output != null) {
output.add(strLine);
}
}
String[] output = new String[1];
output[0] = String.valueOf("Command not found");
- CommandResult result = new CommandResult(0, null);
+ CommandResult result = new CommandResult(0, null, null);
// For verification of setters of class CommandResult
result.setOutput(output);
+ result.setErrorOutput(output);
result.setResult(1);
return result;
}
if (fIsConnected) {
}
- return new CommandResult(0, new String[0]);
+ return new CommandResult(0, new String[0], new String[0]);
}
}
0
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Warning: Tracefile size rounded up from (1024) to subbuffer size (8388608)
+</COMMAND_ERROR_OUTPUT>
UST channel mychannel enabled for session mysession
</COMMAND_OUTPUT>
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Command not found
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
</SCENARIO>
</COMMAND_RESULT>
<COMMAND_OUTPUT>
Session test not found
+<COMMAND_ERROR_OUTPUT>
Error: Session name not found
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
</SCENARIO>
<COMMAND_OUTPUT>
DEBUG2: Session name: test [in cmd_list() at commands/list.c:618]
DEBUG1: Session count 1 [in list_sessions() at commands/list.c:485]
+<COMMAND_ERROR_OUTPUT>
Error: Session 'test' not found
Error: Command error
+</COMMAND_ERROR_OUTPUT>
DEBUG1: Clean exit [in clean_exit() at lttng.c:165]
</COMMAND_OUTPUT>
</SCENARIO>
</COMMAND_RESULT>
<COMMAND_OUTPUT>
Spawning session daemon
+<COMMAND_ERROR_OUTPUT>
Error: Unable to list kernel events
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
</SCENARIO>
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: Unable to list kernel events
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
</SCENARIO>
<COMMAND_OUTPUT>
DEBUG2: Session name: (null) [in cmd_list() at commands/list.c:618]
DEBUG1: Getting kernel tracing events [in list_kernel_events() at commands/list.c:309]
+<COMMAND_ERROR_OUTPUT>
Error: Unable to list kernel events
+</COMMAND_ERROR_OUTPUT>
DEBUG1: Clean exit [in clean_exit() at lttng.c:165]
</COMMAND_OUTPUT>
</SCENARIO>
</COMMAND_RESULT>
<COMMAND_OUTPUT>
Spawning a session daemon
+<COMMAND_ERROR_OUTPUT>
Error: Unable to list UST events: Listing UST events failed
Error: Command Error
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
</SCENARIO>
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: Unable to list UST events: Listing UST events failed
Error: Command Error
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
</SCENARIO>
DEBUG2: Session name: (null) [in cmd_list() at commands/list.c:618]
DEBUG1: Getting kernel tracing events [in list_kernel_events() at commands/list.c:309]
Spawning a session daemon
+<COMMAND_ERROR_OUTPUT>
Error: Unable to list UST events: Listing UST events failed
Error: Command Error
+</COMMAND_ERROR_OUTPUT>
DEBUG1: Clean exit [in clean_exit() at lttng.c:165]
</COMMAND_OUTPUT>
</SCENARIO>
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: Session name already exist
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
<COMMAND_INPUT>
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: Session name not found
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
#------------------------------------------------------------------------------
#next is not an error case but good to be tested
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: Session name not found
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
#------------------------------------------------------------------------------
<COMMAND_INPUT>
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: Session needs to be started once
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
</SCENARIO>
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: Snapshot and live modes are mutually exclusive.
Error: Command error
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
#------------------------------------------------------------------------------
<COMMAND_INPUT>
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: URI parse unknown protocol blah
Error: Unable to parse the URL blah
Error: Invalid parameter
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
#------------------------------------------------------------------------------
<COMMAND_INPUT>
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: You need both control and data URL.
Error: Command error
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
</SCENARIO>
\ No newline at end of file
1
</COMMAND_RESULT>
<COMMAND_OUTPUT>
+<COMMAND_ERROR_OUTPUT>
Error: Unable to list kernel events
+</COMMAND_ERROR_OUTPUT>
</COMMAND_OUTPUT>
<COMMAND_INPUT>
* The output as String array.
*/
private String[] fOutput = new String[0];
+ private String[] fErrorOutput = new String[0];
// ------------------------------------------------------------------------
// Constructor
* The result of the command
* @param output
* The output, as an array of strings
+ * @param errorOutput
+ * THe error output as an array of strings
*/
- public CommandResult(int result, String[] output) {
+ public CommandResult(int result, String[] output, String[] errorOutput) {
fResult = result;
if (output != null) {
fOutput = Arrays.copyOf(output, output.length);
}
+ if (errorOutput != null) {
+ fErrorOutput = Arrays.copyOf(errorOutput, errorOutput.length);
+ }
}
// ------------------------------------------------------------------------
fOutput = Arrays.copyOf(output, output.length);
}
}
+
+ @Override
+ public String[] getErrorOutput() {
+ return Arrays.copyOf(fErrorOutput, fErrorOutput.length);
+ }
+
+ @Override
+ public void setErrorOutput(String[] output) {
+ fErrorOutput = new String[0];
+ if (output != null) {
+ fErrorOutput = Arrays.copyOf(output, output.length);
+ }
+ }
}
\ No newline at end of file
@Override
public CommandResult call() throws IOException, CancellationException {
final ArrayList<String> result = new ArrayList<>();
+ final ArrayList<String> errorResult = new ArrayList<>();
synchronized (fHostShell) {
// Initialize return value which will be updated in isAliasEchoResult()
if (fReturnValue != 0) {
while(fErrorBufferReader.ready()) {
if ((nextLine = fErrorBufferReader.readLine()) != null) {
- result.add(nextLine);
+ errorResult.add(nextLine);
}
}
}
}
- return new CommandResult(fReturnValue, result.toArray(new String[result.size()]));
+ return new CommandResult(fReturnValue, result.toArray(new String[result.size()]), errorResult.toArray(new String[errorResult.size()]));
}
});
* The output (as an array of Strings) to assign
*/
void setOutput(String[] output);
+
+ /**
+ * The error output of the command.
+ *
+ * @return returns the command error output.
+ */
+ String[] getErrorOutput();
+
+ /**
+ * Sets the command output.
+ *
+ * @param output
+ * The output (as an array of Strings) to assign
+ */
+ void setErrorOutput(String[] output);
}
\ No newline at end of file
List<IBaseEventInfo> events = new ArrayList<>();
- if (result.getOutput() != null) {
+ if (result.getErrorOutput() != null) {
// Ignore the following 2 cases:
// Spawning a session daemon
// Error: Unable to list kernel events
// Error: Unable to list kernel events
//
int index = 0;
- while (index < result.getOutput().length) {
- String line = result.getOutput()[index];
+ while (index < result.getErrorOutput().length) {
+ String line = result.getErrorOutput()[index];
Matcher matcher = LTTngControlServiceConstants.LIST_KERNEL_NO_KERNEL_PROVIDER_PATTERN.matcher(line);
if (matcher.matches()) {
return events;
return allProviders;
}
- if (result.getOutput() != null) {
+ if (result.getErrorOutput() != null) {
// Ignore the following 2 cases:
// Spawning a session daemon
// Error: Unable to list UST events: Listing UST events failed
// Error: Unable to list UST events: Listing UST events failed
//
int index = 0;
- while (index < result.getOutput().length) {
- String line = result.getOutput()[index];
+ while (index < result.getErrorOutput().length) {
+ String line = result.getErrorOutput()[index];
Matcher matcher = LTTngControlServiceConstants.LIST_UST_NO_UST_PROVIDER_PATTERN.matcher(line);
if (matcher.matches()) {
return allProviders;
StringBuffer command = createCommand(LTTngControlServiceConstants.COMMAND_DESTROY_SESSION, newName);
ICommandResult result = executeCommand(command.toString(), monitor, false);
- String[] output = result.getOutput();
+ String[] errorOutput = result.getErrorOutput();
boolean isError = isError(result);
- if (isError && (output != null)) {
+ if (isError && (errorOutput != null)) {
int index = 0;
- while (index < output.length) {
- String line = output[index];
+ while (index < errorOutput.length) {
+ String line = errorOutput[index];
Matcher matcher = LTTngControlServiceConstants.SESSION_NOT_FOUND_ERROR_PATTERN.matcher(line);
if (matcher.matches()) {
// Don't treat this as an error
*/
protected boolean isError(ICommandResult result) {
// Check return code and length of returned strings
- if ((result.getResult()) != 0 || (result.getOutput().length < 1)) {
+
+ if ((result.getResult()) != 0) {
return true;
}
// Look for error pattern
int index = 0;
- while (index < result.getOutput().length) {
- String line = result.getOutput()[index];
+ while (index < result.getErrorOutput().length) {
+ String line = result.getErrorOutput()[index];
Matcher matcher = LTTngControlServiceConstants.ERROR_PATTERN.matcher(line);
if (matcher.matches()) {
return true;
* @return - the formatted output
*/
public static String formatOutput(ICommandResult result) {
- if ((result == null) || result.getOutput() == null || result.getOutput().length == 0) {
+ if ((result == null) || ((result.getOutput() == null || result.getOutput().length == 0) && (result.getErrorOutput() == null || result.getErrorOutput().length == 0))) {
return ""; //$NON-NLS-1$
}
String[] output = result.getOutput();
+ String[] errorOutput = result.getErrorOutput();
StringBuffer ret = new StringBuffer();
ret.append("Return Value: "); //$NON-NLS-1$
ret.append(result.getResult());
for (int i = 0; i < output.length; i++) {
ret.append(output[i]).append("\n"); //$NON-NLS-1$
}
+ ret.append("Error stream:\n"); //$NON-NLS-1$
+ for (int i = 0; i < errorOutput.length; i++) {
+ ret.append(errorOutput[i]).append("\n"); //$NON-NLS-1$
+ }
return ret.toString();
}
projects / deliverable / tracecompass.git / commitdiff
