lttng/org.eclipse.tracecompass.lttng2.control.ui.tests/stubs/org/eclipse/tracecompass/internal/lttng2/control/stubs/shells/LTTngToolsFileShell.java

   1 /**********************************************************************
   2  * Copyright (c) 2012, 2015 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Bernd Hufmann - Initial API and implementation
  11  *   Markus Schorn - Bug 448058: Use org.eclipse.remote in favor of RSE
  12  **********************************************************************/
  13 package org.eclipse.tracecompass.internal.lttng2.control.stubs.shells;
  14
  15 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  16
  17 import java.io.BufferedReader;
  18 import java.io.DataInputStream;
  19 import java.io.FileInputStream;
  20 import java.io.IOException;
  21 import java.io.InputStreamReader;
  22 import java.util.ArrayList;
  23 import java.util.Collection;
  24 import java.util.HashMap;
  25 import java.util.Iterator;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.regex.Matcher;
  29 import java.util.regex.Pattern;
  30
  31 import org.eclipse.core.commands.ExecutionException;
  32 import org.eclipse.core.runtime.IProgressMonitor;
  33 import org.eclipse.jdt.annotation.NonNull;
  34 import org.eclipse.tracecompass.internal.tmf.remote.core.stubs.shells.TestCommandShell;
  35 import org.eclipse.tracecompass.tmf.remote.core.shell.ICommandInput;
  36 import org.eclipse.tracecompass.tmf.remote.core.shell.ICommandOutputListener;
  37 import org.eclipse.tracecompass.tmf.remote.core.shell.ICommandResult;
  38
  39 @SuppressWarnings("javadoc")
  40 public class LTTngToolsFileShell extends TestCommandShell {
  41
  42     // ------------------------------------------------------------------------
  43     // CONSTANTS
  44     // ------------------------------------------------------------------------
  45     private final static String SCENARIO_KEY = "<SCENARIO>";
  46     private final static String SCENARIO_END_KEY = "</SCENARIO>";
  47     private final static String INPUT_KEY = "<COMMAND_INPUT>";
  48     private final static String INPUT_END_KEY = "</COMMAND_INPUT>";
  49     private final static String RESULT_KEY = "<COMMAND_RESULT>";
  50     private final static String OUTPUT_KEY = "<COMMAND_OUTPUT>";
  51     private final static String OUTPUT_END_KEY = "</COMMAND_OUTPUT>";
  52     private final static String ERROR_OUTPUT_KEY = "<COMMAND_ERROR_OUTPUT>";
  53     private final static String ERROR_OUTPUT_END_KEY = "</COMMAND_ERROR_OUTPUT>";
  54     private final static String COMMENT_KEY = "#.*";
  55
  56     private final static Pattern LTTNG_LIST_SESSION_PATTERN = Pattern.compile("lttng\\s+list\\s+(.+)");
  57     private final static String LTTNG_LIST_PROVIDER_PATTERN = "lttng\\s+list\\s+(-u|-k)";
  58
  59     // ------------------------------------------------------------------------
  60     // Attributes
  61     // ------------------------------------------------------------------------
  62     private String fScenariofile;
  63     private String fScenario;
  64
  65     private final Map<String, Map<String, ICommandResult>> fScenarioMap = new HashMap<>();
  66     private final Map<String, Integer> fSessionNameMap = new HashMap<>();
  67
  68     /**
  69      * Parse a scenario file with the format:
  70      *
  71      * <pre>
  72      * &lt;SCENARIO&gt;
  73      * ScenarioName
  74      *
  75      * &lt;COMMAND_INPUT&gt;
  76      * Command
  77      * &lt;/COMMAND_INPUT&gt;
  78      *
  79      * &lt;COMMAND_RESULT&gt;
  80      * CommandResult
  81      * &lt;/COMMAND_RESULT&gt;
  82      *
  83      * &lt;COMMAND_OUTPUT&gt;
  84      * CommandOutput
  85      * &lt;COMMAND_ERROR_OUTPUT&gt;
  86      * CommandErrorOutput
  87      * &lt;/COMMAND_ERROR_OUTPUT&gt;
  88      * &lt;/COMMAND_OUTPUT&gt;
  89      *
  90      * &lt;/SCENARIO&gt;
  91      *
  92      * Where: ScenarioName - is the scenario name
  93      *        Command - the command line string
  94      *        CommandResult - the result integer of the command (0 for success, 1 for failure)
  95      *        CommandOutput - the command output string (multi-line possible)
  96      *        CommandErrorOutput - the command error output string (multi-line possible)
  97      *
  98      * Note: 1) There can be many scenarios per file
  99      *       2) There can be many (Command-CommandResult-CommandOutput) triples per scenario
 100      * 3) Lines starting with # will be ignored (comments)
 101      *
 102      * <pre>
 103      * @param scenariofile - path to scenario file
 104      */
 105     public synchronized void loadScenarioFile(String scenariofile) {
 106         fScenariofile = scenariofile;
 107
 108         // clean up map
 109         Collection<Map<String, ICommandResult>> values = fScenarioMap.values();
 110         for (Iterator<Map<String, ICommandResult>> iterator = values.iterator(); iterator.hasNext();) {
 111             Map<String, ICommandResult> map = iterator.next();
 112             map.clear();
 113         }
 114         fScenarioMap.clear();
 115
 116         // load from file
 117
 118         // Open the file
 119         try (FileInputStream fstream = new FileInputStream(fScenariofile);
 120                 DataInputStream in = new DataInputStream(fstream);
 121                 BufferedReader br = new BufferedReader(new InputStreamReader(in));) {
 122             String strLine;
 123
 124             // Read File Line by Line
 125
 126             // Temporary map for generating instance numbers for lttng list
 127             // <session> commands.
 128             // The numbers are per scenario.
 129             Map<String, Integer> tmpSessionNameMap = new HashMap<>();
 130             while ((strLine = br.readLine()) != null) {
 131
 132                 // Ignore comments
 133                 if (isComment(strLine)) {
 134                     continue;
 135                 }
 136
 137                 if (SCENARIO_KEY.equals(strLine)) {
 138                     // scenario start
 139
 140                     // Ignore comments
 141                     strLine = br.readLine();
 142                     while (isComment(strLine)) {
 143                         strLine = br.readLine();
 144                     }
 145
 146                     String scenario = strLine;
 147                     Map<String, ICommandResult> commandMap = new HashMap<>();
 148                     fScenarioMap.put(scenario, commandMap);
 149                     List<String> output = null;
 150                     List<String> errorOutput = null;
 151                     String input = null;
 152                     boolean inOutput = false;
 153                     boolean inErrorOutput = false;
 154                     int result = 0;
 155                     tmpSessionNameMap.clear();
 156                     while ((strLine = br.readLine()) != null) {
 157                         // Ignore comments
 158                         if (isComment(strLine)) {
 159                             continue;
 160                         }
 161
 162                         if (SCENARIO_END_KEY.equals(strLine)) {
 163                             // Scenario is finished
 164                             break;
 165                         }
 166                         if (INPUT_KEY.equals(strLine)) {
 167                             strLine = br.readLine();
 168                             // Ignore comments
 169                             while (isComment(strLine)) {
 170                                 strLine = br.readLine();
 171                             }
 172                             // Read command
 173                             input = strLine;
 174
 175                             // Handle instances of 'lttng list
 176                             // <session"-command
 177                             Matcher matcher = LTTNG_LIST_SESSION_PATTERN.matcher(strLine);
 178                             if (matcher.matches() && !input.matches(LTTNG_LIST_PROVIDER_PATTERN)) {
 179                                 String sessionName = matcher.group(1).trim();
 180                                 Integer i = tmpSessionNameMap.get(sessionName);
 181                                 if (i != null) {
 182                                     i++;
 183                                 } else {
 184                                     i = 0;
 185                                 }
 186                                 tmpSessionNameMap.put(sessionName, i);
 187                                 input += String.valueOf(i);
 188                             }
 189                         } else if (INPUT_END_KEY.equals(strLine)) {
 190                             // Initialize output array
 191                             output = new ArrayList<>();
 192                             errorOutput = new ArrayList<>();
 193                         } else if (RESULT_KEY.equals(strLine)) {
 194                             strLine = br.readLine();
 195                             // Ignore comments
 196                             while (isComment(strLine)) {
 197                                 strLine = br.readLine();
 198                             }
 199                             // Save result value
 200                             result = Integer.parseInt(strLine);
 201                         } else if (OUTPUT_END_KEY.equals(strLine)) {
 202                             // Save output/result in command map
 203                             if (output != null && errorOutput != null) {
 204                                 commandMap.put(input, createCommandResult(result,
 205                                         checkNotNull(output.toArray(new @NonNull String[output.size()])),
 206                                         checkNotNull(errorOutput.toArray(new @NonNull String[errorOutput.size()]))));
 207                             }
 208                             inOutput = false;
 209                         } else if (OUTPUT_KEY.equals(strLine)) {
 210                             // first line of output
 211                             inOutput = true;
 212                         } else if (ERROR_OUTPUT_KEY.equals(strLine)) {
 213                             // first line of output
 214                             inErrorOutput = true;
 215                         } else if (ERROR_OUTPUT_END_KEY.equals(strLine)) {
 216                             inErrorOutput = false;
 217                         } else if (inOutput) {
 218                             while (isComment(strLine)) {
 219                                 strLine = br.readLine();
 220                             }
 221                             // lines of output/error output
 222                             if (errorOutput != null && inErrorOutput) {
 223                                 errorOutput.add(strLine);
 224                             } else if (output != null) {
 225                                 output.add(strLine);
 226                             }
 227                         }
 228                         // else {
 229                         // if (RESULT_END_KEY.equals(strLine)) {
 230                         // nothing to do
 231                         // }
 232                     }
 233                 }
 234             }
 235         } catch (IOException e) {
 236             e.printStackTrace();
 237         }
 238     }
 239
 240     // Set the scenario to consider in executeCommand()
 241     public synchronized void setScenario(String scenario) {
 242         fScenario = scenario;
 243         fSessionNameMap.clear();
 244         if (!fScenarioMap.containsKey(fScenario)) {
 245             throw new IllegalArgumentException();
 246         }
 247     }
 248
 249     @Override
 250     public synchronized ICommandResult executeCommand(ICommandInput command, IProgressMonitor monitor) throws ExecutionException {
 251         return executeCommand(command, monitor, null);
 252     }
 253
 254     @Override
 255     public synchronized ICommandResult executeCommand(ICommandInput command, IProgressMonitor monitor, ICommandOutputListener listener) throws ExecutionException {
 256         Map<String, ICommandResult> commands = checkNotNull(fScenarioMap.get(fScenario));
 257         String commandLine = command.toString();
 258         String fullCommand = commandLine;
 259
 260         Matcher matcher = LTTNG_LIST_SESSION_PATTERN.matcher(commandLine);
 261         if (matcher.matches() && !commandLine.matches(LTTNG_LIST_PROVIDER_PATTERN)) {
 262             String sessionName = matcher.group(1).trim();
 263             Integer i = fSessionNameMap.get(sessionName);
 264             if (i != null) {
 265                 i++;
 266             } else {
 267                 i = 0;
 268             }
 269             fSessionNameMap.put(sessionName, i);
 270             fullCommand += String.valueOf(i);
 271         }
 272
 273         if (commands.containsKey(fullCommand)) {
 274             return checkNotNull(commands.get(fullCommand));
 275         }
 276
 277         @NonNull String[] output = new @NonNull String[1];
 278         output[0] = String.valueOf("Command not found");
 279         ICommandResult result = createCommandResult(1, output, output);
 280         return result;
 281     }
 282
 283     // ------------------------------------------------------------------------
 284     // Helper methods
 285     // ------------------------------------------------------------------------
 286
 287     private static boolean isComment(String line) {
 288         if (line == null) {
 289             throw new RuntimeException("line is null");
 290         }
 291         return line.matches(COMMENT_KEY);
 292     }
 293 }