smRunner/src/com/intellij/execution/testframework/sm/runner/TestSuiteStack.java

   1 package com.intellij.execution.testframework.sm.runner;
   2
   3 import com.intellij.openapi.diagnostic.Logger;
   4 import org.jetbrains.annotations.NonNls;
   5 import org.jetbrains.annotations.NotNull;
   6 import org.jetbrains.annotations.Nullable;
   7
   8 import java.util.EmptyStackException;
   9 import java.util.Stack;
  10
  11 /**
  12  * @author Roman Chernyatchik
  13  */
  14 public class TestSuiteStack {
  15   private static final Logger LOG = Logger.getInstance(TestSuiteStack.class.getName());
  16
  17   @NonNls private static final String EMPTY = "empty";
  18
  19   private final Stack<SMTestProxy> myStack = new Stack<SMTestProxy>();
  20
  21   public void pushSuite(@NotNull final SMTestProxy suite) {
  22     myStack.push(suite);
  23   }
  24
  25   /**
  26    * @return Top element of non stack or null for empty stack
  27    */
  28   @Nullable
  29   public SMTestProxy getCurrentSuite() {
  30     if (getStackSize() != 0) {
  31       return myStack.peek();
  32     }
  33     return null;
  34   }
  35
  36   /**
  37    * Pop element form stack and checks consistency
  38    * @param suiteName Predictable name of top suite in stack
  39    */
  40   @NotNull
  41   public SMTestProxy popSuite(final String suiteName) throws EmptyStackException {
  42     if (myStack.isEmpty()) {
  43       LOG.assertTrue(false, "Pop error: Test runner try to close test suite which has been already closed or wasn't started at all. Unexpected suite name [" + suiteName + "]");
  44       return null;
  45     }
  46     final SMTestProxy currentSuite = myStack.pop();
  47
  48     if (!suiteName.equals(currentSuite.getName())) {
  49       LOG.assertTrue(false, "Pop error: Unexpected closing suite. Expected [" + suiteName + "] but [" + currentSuite.getName() + "] was found. Rest of stack: " + getSuitePathPresentation());
  50       return null;
  51     }
  52
  53     return currentSuite;
  54   }
  55
  56   public final boolean isEmpty() {
  57     return getStackSize() == 0;
  58   }
  59
  60   protected int getStackSize() {
  61     return myStack.size();
  62   }
  63
  64   protected String[] getSuitePath() {
  65     final int stackSize = getStackSize();
  66     final String[] names = new String[stackSize];
  67     for (int i = 0; i < stackSize; i++) {
  68       names[i] = myStack.get(i).getName();
  69     }
  70     return names;
  71   }
  72
  73   protected String getSuitePathPresentation() {
  74     final String[] names = getSuitePath();
  75     if (names.length == 0) {
  76       return EMPTY;
  77     }
  78
  79     final StringBuilder builder = new StringBuilder();
  80     final String lastName = names[names.length - 1];
  81     for (String name : names) {
  82       builder.append('[').append(name).append(']');
  83       //Here we can use != instead of !equals()
  84       //noinspection StringEquality
  85       if (name != lastName) {
  86         builder.append("->");
  87       }
  88     }
  89     return builder.toString();
  90   }
  91
  92   public void clear() {
  93     myStack.clear();
  94   }
  95 }