tmf/org.eclipse.tracecompass.tmf.ui.swtbot.tests/shared/org/eclipse/tracecompass/tmf/ui/swtbot/tests/shared/SWTBotUtils.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014, 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  *   Matthew Khouzam - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.ui.swtbot.tests.shared;
  14
  15 import static org.junit.Assert.assertNotNull;
  16 import static org.junit.Assert.assertTrue;
  17 import static org.junit.Assert.fail;
  18
  19 import java.util.Arrays;
  20 import java.util.List;
  21 import java.util.TimeZone;
  22 import java.util.concurrent.atomic.AtomicBoolean;
  23
  24 import org.eclipse.core.resources.IFolder;
  25 import org.eclipse.core.resources.IProject;
  26 import org.eclipse.core.resources.IResource;
  27 import org.eclipse.core.resources.IResourceVisitor;
  28 import org.eclipse.core.resources.ResourcesPlugin;
  29 import org.eclipse.core.runtime.CoreException;
  30 import org.eclipse.core.runtime.IPath;
  31 import org.eclipse.core.runtime.NullProgressMonitor;
  32 import org.eclipse.core.runtime.jobs.Job;
  33 import org.eclipse.jdt.annotation.NonNull;
  34 import org.eclipse.jface.bindings.keys.IKeyLookup;
  35 import org.eclipse.jface.bindings.keys.KeyStroke;
  36 import org.eclipse.jface.bindings.keys.ParseException;
  37 import org.eclipse.swt.events.ControlAdapter;
  38 import org.eclipse.swt.events.ControlEvent;
  39 import org.eclipse.swt.graphics.Point;
  40 import org.eclipse.swt.graphics.Rectangle;
  41 import org.eclipse.swt.widgets.Display;
  42 import org.eclipse.swt.widgets.Shell;
  43 import org.eclipse.swt.widgets.Table;
  44 import org.eclipse.swt.widgets.TableItem;
  45 import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;
  46 import org.eclipse.swtbot.eclipse.finder.matchers.WidgetMatcherFactory;
  47 import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotEditor;
  48 import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotView;
  49 import org.eclipse.swtbot.swt.finder.SWTBot;
  50 import org.eclipse.swtbot.swt.finder.finders.UIThreadRunnable;
  51 import org.eclipse.swtbot.swt.finder.keyboard.Keyboard;
  52 import org.eclipse.swtbot.swt.finder.keyboard.Keystrokes;
  53 import org.eclipse.swtbot.swt.finder.results.Result;
  54 import org.eclipse.swtbot.swt.finder.results.VoidResult;
  55 import org.eclipse.swtbot.swt.finder.utils.SWTUtils;
  56 import org.eclipse.swtbot.swt.finder.waits.Conditions;
  57 import org.eclipse.swtbot.swt.finder.waits.DefaultCondition;
  58 import org.eclipse.swtbot.swt.finder.widgets.SWTBotButton;
  59 import org.eclipse.swtbot.swt.finder.widgets.SWTBotCheckBox;
  60 import org.eclipse.swtbot.swt.finder.widgets.SWTBotMenu;
  61 import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell;
  62 import org.eclipse.swtbot.swt.finder.widgets.SWTBotTable;
  63 import org.eclipse.swtbot.swt.finder.widgets.SWTBotTree;
  64 import org.eclipse.swtbot.swt.finder.widgets.SWTBotTreeItem;
  65 import org.eclipse.swtbot.swt.finder.widgets.TimeoutException;
  66 import org.eclipse.tracecompass.internal.tmf.ui.project.operations.NewExperimentOperation;
  67 import org.eclipse.tracecompass.tmf.ui.editors.TmfEventsEditor;
  68 import org.eclipse.tracecompass.tmf.ui.project.model.TmfExperimentElement;
  69 import org.eclipse.tracecompass.tmf.ui.project.model.TmfExperimentFolder;
  70 import org.eclipse.tracecompass.tmf.ui.project.model.TmfOpenTraceHelper;
  71 import org.eclipse.tracecompass.tmf.ui.project.model.TmfProjectElement;
  72 import org.eclipse.tracecompass.tmf.ui.project.model.TmfProjectRegistry;
  73 import org.eclipse.tracecompass.tmf.ui.project.model.TmfTraceElement;
  74 import org.eclipse.tracecompass.tmf.ui.project.model.TmfTraceFolder;
  75 import org.eclipse.tracecompass.tmf.ui.project.model.TmfTracesFolder;
  76 import org.eclipse.tracecompass.tmf.ui.swtbot.tests.shared.ConditionHelpers.ProjectElementHasChild;
  77 import org.eclipse.tracecompass.tmf.ui.views.TracingPerspectiveFactory;
  78 import org.eclipse.ui.IEditorPart;
  79 import org.eclipse.ui.IEditorReference;
  80 import org.eclipse.ui.IPageLayout;
  81 import org.eclipse.ui.PartInitException;
  82 import org.eclipse.ui.PlatformUI;
  83 import org.eclipse.ui.WorkbenchException;
  84 import org.hamcrest.Matcher;
  85
  86 /**
  87  * SWTBot Helper functions
  88  *
  89  * @author Matthew Khouzam
  90  */
  91 @SuppressWarnings("restriction")
  92 public final class SWTBotUtils {
  93
  94     private static final long MAX_JOBS_WAIT_TIME = 300000;
  95     private static final String WINDOW_MENU = "Window";
  96     private static final String PREFERENCES_MENU_ITEM = "Preferences";
  97     private static boolean fPrintedEnvironment = false;
  98
  99     private SWTBotUtils() {
 100     }
 101
 102     private static final String TRACING_PERSPECTIVE_ID = TracingPerspectiveFactory.ID;
 103
 104     /**
 105      * Waits for all Eclipse jobs to finish. Times out after
 106      * SWTBotUtils#MAX_JOBS_WAIT_TIME by default.
 107      *
 108      * @throws TimeoutException
 109      *             once the waiting time passes the default maximum value
 110      */
 111     public static void waitForJobs() {
 112         waitForJobs(MAX_JOBS_WAIT_TIME);
 113     }
 114
 115     /**
 116      * Waits for all Eclipse jobs to finish
 117      *
 118      * @param maxWait
 119      *            the maximum time to wait, in milliseconds. Once the waiting
 120      *            time passes the maximum value, a TimeoutException is thrown
 121      * @throws TimeoutException
 122      *             once the waiting time passes the maximum value
 123      */
 124     public static void waitForJobs(long maxWait) {
 125         long waitStart = System.currentTimeMillis();
 126         while (!Job.getJobManager().isIdle()) {
 127             if (System.currentTimeMillis() - waitStart > maxWait) {
 128                 printJobs();
 129                 throw new TimeoutException("Timed out waiting for jobs to finish.");
 130             }
 131
 132             delay(100);
 133         }
 134     }
 135
 136     private static void printJobs() {
 137         Job[] jobs = Job.getJobManager().find(null);
 138         for (Job job : jobs) {
 139             System.err.println(job.toString() + " state: " + jobStateToString(job.getState()));
 140             Thread thread = job.getThread();
 141             if (thread != null) {
 142                 for (StackTraceElement stractTraceElement : thread.getStackTrace()) {
 143                     System.err.println("  " + stractTraceElement);
 144                 }
 145             }
 146             System.err.println();
 147         }
 148     }
 149
 150     private static String jobStateToString(int jobState) {
 151         switch (jobState) {
 152         case Job.RUNNING:
 153             return "RUNNING";
 154         case Job.WAITING:
 155             return "WAITING";
 156         case Job.SLEEPING:
 157             return "SLEEPING";
 158         case Job.NONE:
 159             return "NONE";
 160         default:
 161             return "UNKNOWN";
 162         }
 163     }
 164
 165     /**
 166      * Sleeps current thread for a given time.
 167      *
 168      * @param waitTimeMillis
 169      *            time in milliseconds to wait
 170      */
 171     public static void delay(final long waitTimeMillis) {
 172         try {
 173             Thread.sleep(waitTimeMillis);
 174         } catch (final InterruptedException e) {
 175             // Ignored
 176         }
 177     }
 178
 179     /**
 180      * Create a tracing project
 181      *
 182      * @param projectName
 183      *            the name of the tracing project
 184      */
 185     public static void createProject(final String projectName) {
 186         /*
 187          * Make a new test
 188          */
 189         UIThreadRunnable.syncExec(new VoidResult() {
 190             @Override
 191             public void run() {
 192                 IProject project = TmfProjectRegistry.createProject(projectName, null, new NullProgressMonitor());
 193                 assertNotNull(project);
 194             }
 195         });
 196
 197         SWTBotUtils.waitForJobs();
 198     }
 199
 200     /**
 201      * Deletes a project
 202      *
 203      * @param projectName
 204      *            the name of the tracing project
 205      * @param deleteResources
 206      *            whether or not to deleted resources under the project
 207      * @param bot
 208      *            the workbench bot
 209      */
 210     public static void deleteProject(final String projectName, boolean deleteResources, SWTWorkbenchBot bot) {
 211         // Wait for any analysis to complete because it might create
 212         // supplementary files
 213         SWTBotUtils.waitForJobs();
 214         try {
 215             ResourcesPlugin.getWorkspace().getRoot().getProject(projectName).refreshLocal(IResource.DEPTH_INFINITE, null);
 216         } catch (CoreException e) {
 217         }
 218
 219         SWTBotUtils.waitForJobs();
 220
 221         final SWTBotView projectViewBot = bot.viewById(IPageLayout.ID_PROJECT_EXPLORER);
 222         projectViewBot.setFocus();
 223
 224         SWTBotTree treeBot = projectViewBot.bot().tree();
 225         SWTBotTreeItem treeItem = treeBot.getTreeItem(projectName);
 226         SWTBotMenu contextMenu = treeItem.contextMenu("Delete");
 227         contextMenu.click();
 228
 229         if (deleteResources) {
 230             bot.shell("Delete Resources").setFocus();
 231             final SWTBotCheckBox checkBox = bot.checkBox();
 232             bot.waitUntil(Conditions.widgetIsEnabled(checkBox));
 233             checkBox.click();
 234         }
 235
 236         final SWTBotButton okButton = bot.button("OK");
 237         bot.waitUntil(Conditions.widgetIsEnabled(okButton));
 238         okButton.click();
 239
 240         SWTBotUtils.waitForJobs();
 241     }
 242
 243     /**
 244      * Deletes a project and its resources
 245      *
 246      * @param projectName
 247      *            the name of the tracing project
 248      * @param bot
 249      *            the workbench bot
 250      */
 251     public static void deleteProject(String projectName, SWTWorkbenchBot bot) {
 252         deleteProject(projectName, true, bot);
 253     }
 254
 255     /**
 256      * Creates an experiment
 257      *
 258      * @param bot
 259      *            a given workbench bot
 260      * @param projectName
 261      *            the name of the project, creates the project if needed
 262      * @param expName
 263      *            the experiment name
 264      */
 265     public static void createExperiment(SWTWorkbenchBot bot, String projectName, final @NonNull String expName) {
 266         IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(projectName);
 267         TmfProjectElement tmfProject = TmfProjectRegistry.getProject(project, true);
 268         TmfExperimentFolder expFolder = tmfProject.getExperimentsFolder();
 269         assertNotNull(expFolder);
 270         NewExperimentOperation operation = new NewExperimentOperation(expFolder, expName);
 271         operation.run(new NullProgressMonitor());
 272
 273         bot.waitUntil(new DefaultCondition() {
 274             @Override
 275             public boolean test() throws Exception {
 276                 TmfExperimentElement experiment = expFolder.getExperiment(expName);
 277                 return experiment != null;
 278             }
 279
 280             @Override
 281             public String getFailureMessage() {
 282                 return "Experiment (" + expName + ") couldn't be created";
 283             }
 284         });
 285     }
 286
 287
 288     /**
 289      * Focus on the main window
 290      *
 291      * @param shellBots
 292      *            swtbotshells for all the shells
 293      */
 294     public static void focusMainWindow(SWTBotShell[] shellBots) {
 295         for (SWTBotShell shellBot : shellBots) {
 296             if (shellBot.getText().toLowerCase().contains("eclipse")) {
 297                 shellBot.activate();
 298             }
 299         }
 300     }
 301
 302     /**
 303      * Close a view with a title
 304      *
 305      * @param title
 306      *            the title, like "welcome"
 307      * @param bot
 308      *            the workbench bot
 309      */
 310     public static void closeView(String title, SWTWorkbenchBot bot) {
 311         final List<SWTBotView> openViews = bot.views();
 312         for (SWTBotView view : openViews) {
 313             if (view.getTitle().equalsIgnoreCase(title)) {
 314                 view.close();
 315                 bot.waitUntil(ConditionHelpers.ViewIsClosed(view));
 316             }
 317         }
 318     }
 319
 320     /**
 321      * Close a view with an id
 322      *
 323      * @param viewId
 324      *            the view id, like "org.eclipse.linuxtools.tmf.ui.views.histogram"
 325      * @param bot
 326      *            the workbench bot
 327      */
 328     public static void closeViewById(String viewId, SWTWorkbenchBot bot) {
 329         final SWTBotView view = bot.viewById(viewId);
 330         view.close();
 331         bot.waitUntil(ConditionHelpers.ViewIsClosed(view));
 332     }
 333
 334     /**
 335      * Switch to the tracing perspective
 336      */
 337     public static void switchToTracingPerspective() {
 338         switchToPerspective(TRACING_PERSPECTIVE_ID);
 339     }
 340
 341     /**
 342      * Switch to a given perspective
 343      *
 344      * @param id
 345      *            the perspective id (like
 346      *            "org.eclipse.linuxtools.tmf.ui.perspective"
 347      */
 348     public static void switchToPerspective(final String id) {
 349         UIThreadRunnable.syncExec(new VoidResult() {
 350             @Override
 351             public void run() {
 352                 try {
 353                     PlatformUI.getWorkbench().showPerspective(id, PlatformUI.getWorkbench().getActiveWorkbenchWindow());
 354                 } catch (WorkbenchException e) {
 355                     fail(e.getMessage());
 356                 }
 357             }
 358         });
 359     }
 360
 361     /**
 362      * Initialize the environment for SWTBot
 363      */
 364     public static void initialize() {
 365         failIfUIThread();
 366
 367         SWTWorkbenchBot bot = new SWTWorkbenchBot();
 368         UIThreadRunnable.syncExec(() -> {
 369             printEnvironment();
 370
 371             // There seems to be problems on some system where the main shell is
 372             // not in focus initially. This was seen using Xvfb and Xephyr on some occasions.
 373             focusMainWindow(bot.shells());
 374
 375             Shell shell = bot.activeShell().widget;
 376
 377             // Only adjust shell if it appears to be the top-most
 378             if (shell.getParent() == null) {
 379                 makeShellFullyVisible(shell);
 380             }
 381         });
 382     }
 383
 384     private static void printEnvironment() {
 385         if (fPrintedEnvironment) {
 386             return;
 387         }
 388
 389         // Print some information about the environment that could affect test outcome
 390         Rectangle bounds = Display.getDefault().getBounds();
 391         System.out.println("Display size: " + bounds.width + "x" + bounds.height);
 392
 393         String osVersion = System.getProperty("os.version");
 394         if (osVersion != null) {
 395             System.out.println("OS version=" + osVersion);
 396         }
 397         String gtkVersion = System.getProperty("org.eclipse.swt.internal.gtk.version");
 398         if (gtkVersion != null) {
 399             System.out.println("GTK version=" + gtkVersion);
 400             String overlayScrollbar = System.getenv("LIBOVERLAY_SCROLLBAR");
 401             if (overlayScrollbar != null) {
 402                 System.out.println("LIBOVERLAY_SCROLLBAR=" + overlayScrollbar);
 403             }
 404             String ubuntuMenuProxy = System.getenv("UBUNTU_MENUPROXY");
 405             if (ubuntuMenuProxy != null) {
 406                 System.out.println("UBUNTU_MENUPROXY=" + ubuntuMenuProxy);
 407             }
 408         }
 409
 410         System.out.println("Time zone: " + TimeZone.getDefault().getDisplayName());
 411
 412         fPrintedEnvironment = true;
 413     }
 414
 415     /**
 416      * If the test is running in the UI thread then fail
 417      */
 418     private static void failIfUIThread() {
 419         if (Display.getCurrent() != null && Display.getCurrent().getThread() == Thread.currentThread()) {
 420             fail("SWTBot test needs to run in a non-UI thread. Make sure that \"Run in UI thread\" is unchecked in your launch configuration or"
 421                     + " that useUIThread is set to false in the pom.xml");
 422         }
 423     }
 424
 425     /**
 426      * Try to make the shell fully visible in the display. If the shell cannot
 427      * fit the display, it will be positioned so that top-left corner is at
 428      * <code>(0, 0)</code> in display-relative coordinates.
 429      *
 430      * @param shell
 431      *            the shell to make fully visible
 432      */
 433     private static void makeShellFullyVisible(Shell shell) {
 434         Rectangle displayBounds = shell.getDisplay().getBounds();
 435         Point absCoord = shell.toDisplay(0, 0);
 436         Point shellSize = shell.getSize();
 437
 438         Point newLocation = new Point(absCoord.x, absCoord.y);
 439         newLocation.x = Math.max(0, Math.min(absCoord.x, displayBounds.width - shellSize.x));
 440         newLocation.y = Math.max(0, Math.min(absCoord.y, displayBounds.height - shellSize.y));
 441         if (!newLocation.equals(absCoord)) {
 442             shell.setLocation(newLocation);
 443         }
 444     }
 445
 446     /**
 447      * Open a trace, this does not perform any validation though
 448      *
 449      * @param projectName
 450      *            The project name
 451      * @param tracePath
 452      *            the path of the trace file (absolute or relative)
 453      * @param traceType
 454      *            the trace type id (eg: org.eclipse.linuxtools.btf.trace)
 455      */
 456     public static void openTrace(final String projectName, final String tracePath, final String traceType) {
 457         openTrace(projectName, tracePath, traceType, true);
 458     }
 459
 460     /**
 461      * Open a trace, this does not perform any validation though
 462      *
 463      * @param projectName
 464      *            The project name
 465      * @param tracePath
 466      *            the path of the trace file (absolute or relative)
 467      * @param traceType
 468      *            the trace type id (eg: org.eclipse.linuxtools.btf.trace)
 469      * @param delay
 470      *            delay and wait for jobs
 471      */
 472     public static void openTrace(final String projectName, final String tracePath, final String traceType, boolean delay) {
 473         final Exception exception[] = new Exception[1];
 474         exception[0] = null;
 475         UIThreadRunnable.syncExec(new VoidResult() {
 476             @Override
 477             public void run() {
 478                 try {
 479                     IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(projectName);
 480                     TmfTraceFolder destinationFolder = TmfProjectRegistry.getProject(project, true).getTracesFolder();
 481                     TmfOpenTraceHelper.openTraceFromPath(destinationFolder, tracePath, PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell(), traceType);
 482                 } catch (CoreException e) {
 483                     exception[0] = e;
 484                 }
 485             }
 486         });
 487         if (exception[0] != null) {
 488             fail(exception[0].getMessage());
 489         }
 490
 491         if (delay) {
 492             delay(1000);
 493             waitForJobs();
 494         }
 495     }
 496
 497     /**
 498      * Finds an editor and sets focus to the editor
 499      *
 500      * @param bot
 501      *            the workbench bot
 502      * @param editorName
 503      *            the editor name
 504      * @return the corresponding SWTBotEditor
 505      */
 506     public static SWTBotEditor activateEditor(SWTWorkbenchBot bot, String editorName) {
 507         Matcher<IEditorReference> matcher = WidgetMatcherFactory.withPartName(editorName);
 508         final SWTBotEditor editorBot = bot.editor(matcher);
 509         IEditorPart iep = editorBot.getReference().getEditor(true);
 510         final TmfEventsEditor tmfEd = (TmfEventsEditor) iep;
 511         editorBot.show();
 512         UIThreadRunnable.syncExec(new VoidResult() {
 513             @Override
 514             public void run() {
 515                 tmfEd.setFocus();
 516             }
 517         });
 518
 519         SWTBotUtils.waitForJobs();
 520         SWTBotUtils.delay(1000);
 521         assertNotNull(tmfEd);
 522         return editorBot;
 523     }
 524
 525     /**
 526      * Opens a trace in an editor and get the TmfEventsEditor
 527      *
 528      * @param bot
 529      *            the workbench bot
 530      * @param projectName
 531      *            the name of the project that contains the trace
 532      * @param elementPath
 533      *            the trace element path (relative to Traces folder)
 534      * @return TmfEventsEditor the opened editor
 535      */
 536     public static TmfEventsEditor openEditor(SWTWorkbenchBot bot, String projectName, IPath elementPath) {
 537         final SWTBotView projectExplorerView = bot.viewById(IPageLayout.ID_PROJECT_EXPLORER);
 538         projectExplorerView.setFocus();
 539         SWTBot projectExplorerBot = projectExplorerView.bot();
 540
 541         final SWTBotTree tree = projectExplorerBot.tree();
 542         projectExplorerBot.waitUntil(ConditionHelpers.IsTreeNodeAvailable(projectName, tree));
 543         final SWTBotTreeItem treeItem = tree.getTreeItem(projectName);
 544         treeItem.expand();
 545
 546         SWTBotTreeItem tracesNode = getTraceProjectItem(projectExplorerBot, treeItem, TmfTracesFolder.TRACES_FOLDER_NAME);
 547         tracesNode.expand();
 548
 549         SWTBotTreeItem currentItem = tracesNode;
 550         for (String segment : elementPath.segments()) {
 551             currentItem = getTraceProjectItem(projectExplorerBot, currentItem, segment);
 552             currentItem.doubleClick();
 553         }
 554
 555         SWTBotEditor editor = bot.editorByTitle(elementPath.toString());
 556         IEditorPart editorPart = editor.getReference().getEditor(false);
 557         assertTrue(editorPart instanceof TmfEventsEditor);
 558         return (TmfEventsEditor) editorPart;
 559     }
 560
 561     /**
 562      * Returns the child tree item of the specified item with the given name.
 563      * The project element label may have a count suffix in the format ' [n]'.
 564      *
 565      * @param bot
 566      *            a given workbench bot
 567      * @param parentItem
 568      *            the parent tree item
 569      * @param name
 570      *            the desired child element name (without suffix)
 571      * @return the a {@link SWTBotTreeItem} with the specified name
 572      */
 573     public static SWTBotTreeItem getTraceProjectItem(SWTBot bot, final SWTBotTreeItem parentItem, final String name) {
 574         ProjectElementHasChild condition = new ProjectElementHasChild(parentItem, name);
 575         bot.waitUntil(condition);
 576         return condition.getItem();
 577     }
 578
 579     /**
 580      * Select the traces folder
 581      *
 582      * @param bot
 583      *            a given workbench bot
 584      * @param projectName
 585      *            the name of the project (it needs to exist or else it would
 586      *            time out)
 587      * @return a {@link SWTBotTreeItem} of the "Traces" folder
 588      */
 589     public static SWTBotTreeItem selectTracesFolder(SWTWorkbenchBot bot, String projectName) {
 590         SWTBotTreeItem projectTreeItem = selectProject(bot, projectName);
 591         projectTreeItem.select();
 592         SWTBotTreeItem tracesFolderItem = getTraceProjectItem(bot, projectTreeItem, TmfTracesFolder.TRACES_FOLDER_NAME);
 593         tracesFolderItem.select();
 594         return tracesFolderItem;
 595     }
 596
 597     /**
 598      * Clear the traces folder
 599      *
 600      * @param bot
 601      *            a given workbench bot
 602      * @param projectName
 603      *            the name of the project (needs to exist)
 604      */
 605     public static void clearTracesFolder(SWTWorkbenchBot bot, String projectName) {
 606         IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(projectName);
 607         TmfProjectElement tmfProject = TmfProjectRegistry.getProject(project, false);
 608         TmfTraceFolder tracesFolder = tmfProject.getTracesFolder();
 609         try {
 610             for (TmfTraceElement traceElement : tracesFolder.getTraces()) {
 611                 traceElement.delete(null);
 612             }
 613
 614             final IFolder resource = tracesFolder.getResource();
 615             resource.accept(new IResourceVisitor() {
 616                 @Override
 617                 public boolean visit(IResource visitedResource) throws CoreException {
 618                     if (visitedResource != resource) {
 619                         visitedResource.delete(true, null);
 620                     }
 621                     return true;
 622                 }
 623             }, IResource.DEPTH_ONE, 0);
 624         } catch (CoreException e) {
 625             fail(e.getMessage());
 626         }
 627
 628         bot.waitUntil(new DefaultCondition() {
 629             private int fTraceNb = 0;
 630
 631             @Override
 632             public boolean test() throws Exception {
 633                 List<TmfTraceElement> traces = tracesFolder.getTraces();
 634                 fTraceNb = traces.size();
 635                 return fTraceNb == 0;
 636             }
 637
 638             @Override
 639             public String getFailureMessage() {
 640                 return "Traces Folder not empty (" + fTraceNb + ")";
 641             }
 642         });
 643     }
 644
 645     /**
 646      * Clear the trace folder (using the UI)
 647      *
 648      * @param bot
 649      *            a given workbench bot
 650      * @param projectName
 651      *            the name of the project (needs to exist)
 652      */
 653     public static void clearTracesFolderUI(SWTWorkbenchBot bot, String projectName) {
 654         SWTBotTreeItem tracesFolder = selectTracesFolder(bot, projectName);
 655         tracesFolder.contextMenu().menu("Clear").click();
 656         String CONFIRM_CLEAR_DIALOG_TITLE = "Confirm Clear";
 657         bot.waitUntil(Conditions.shellIsActive(CONFIRM_CLEAR_DIALOG_TITLE));
 658
 659         SWTBotShell shell = bot.shell(CONFIRM_CLEAR_DIALOG_TITLE);
 660         shell.bot().button("Yes").click();
 661         bot.waitUntil(Conditions.shellCloses(shell));
 662         bot.waitWhile(ConditionHelpers.treeItemHasChildren(tracesFolder));
 663     }
 664
 665     /**
 666      * Clear the experiment folder
 667      *
 668      * @param bot
 669      *            a given workbench bot
 670      * @param projectName
 671      *            the name of the project (needs to exist)
 672      */
 673     public static void clearExperimentFolder(SWTWorkbenchBot bot, String projectName) {
 674         IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(projectName);
 675         TmfProjectElement tmfProject = TmfProjectRegistry.getProject(project, false);
 676         TmfExperimentFolder expFolder = tmfProject.getExperimentsFolder();
 677         expFolder.getExperiments().forEach(experiment -> {
 678             IResource resource = experiment.getResource();
 679             try {
 680                 // Close the experiment if open
 681                 experiment.closeEditors();
 682
 683                 IPath path = resource.getLocation();
 684                 if (path != null) {
 685                     // Delete supplementary files
 686                     experiment.deleteSupplementaryFolder();
 687                 }
 688                 // Finally, delete the experiment
 689                 resource.delete(true, null);
 690             } catch (CoreException e) {
 691                 fail(e.getMessage());
 692             }
 693         });
 694
 695         bot.waitUntil(new DefaultCondition() {
 696             private int fExperimentNb = 0;
 697
 698             @Override
 699             public boolean test() throws Exception {
 700                 List<TmfExperimentElement> experiments = expFolder.getExperiments();
 701                 fExperimentNb = experiments.size();
 702                 return fExperimentNb == 0;
 703             }
 704
 705             @Override
 706             public String getFailureMessage() {
 707                 return "Experiment Folder not empty (" + fExperimentNb + ")";
 708             }
 709         });
 710     }
 711
 712     /**
 713      * Select the project in Project Explorer
 714      *
 715      * @param bot
 716      *            a given workbench bot
 717      * @param projectName
 718      *            the name of the project (it needs to exist or else it would time out)
 719      * @return a {@link SWTBotTreeItem} of the project
 720      */
 721     public static SWTBotTreeItem selectProject(SWTWorkbenchBot bot, String projectName) {
 722         SWTBotView projectExplorerBot = bot.viewByTitle("Project Explorer");
 723         projectExplorerBot.show();
 724         // FIXME: Bug 496519. Sometimes, the tree becomes disabled for a certain
 725         // amount of time. This can happen during a long running operation
 726         // (BusyIndicator.showWhile) which brings up the modal dialog "operation
 727         // in progress" and this disables all shells
 728         projectExplorerBot.bot().waitUntil(Conditions.widgetIsEnabled(projectExplorerBot.bot().tree()));
 729         SWTBotTreeItem treeItem = projectExplorerBot.bot().tree().getTreeItem(projectName);
 730         treeItem.select();
 731         return treeItem;
 732     }
 733
 734     /**
 735      * Open a view by id.
 736      *
 737      * @param id
 738      *            view id.
 739      */
 740     public static void openView(final String id) {
 741         final PartInitException res[] = new PartInitException[1];
 742         UIThreadRunnable.syncExec(new VoidResult() {
 743             @Override
 744             public void run() {
 745                 try {
 746                     PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().showView(id);
 747                 } catch (PartInitException e) {
 748                     res[0] = e;
 749                 }
 750             }
 751         });
 752         if (res[0] != null) {
 753             fail(res[0].getMessage());
 754         }
 755         waitForJobs();
 756     }
 757
 758     /**
 759      * Maximize a table
 760      *
 761      * @param tableBot
 762      *            the {@link SWTBotTable} table
 763      */
 764     public static void maximizeTable(SWTBotTable tableBot) {
 765         final AtomicBoolean controlResized = new AtomicBoolean();
 766         UIThreadRunnable.syncExec(new VoidResult() {
 767             @Override
 768             public void run() {
 769                 tableBot.widget.addControlListener(new ControlAdapter() {
 770                     @Override
 771                     public void controlResized(ControlEvent e) {
 772                         tableBot.widget.removeControlListener(this);
 773                         controlResized.set(true);
 774                     }
 775                 });
 776             }
 777         });
 778         try {
 779             tableBot.pressShortcut(KeyStroke.getInstance(IKeyLookup.CTRL_NAME + "+"), KeyStroke.getInstance("M"));
 780         } catch (ParseException e) {
 781             fail();
 782         }
 783         new SWTBot().waitUntil(new DefaultCondition() {
 784             @Override
 785             public boolean test() throws Exception {
 786                 return controlResized.get();
 787             }
 788
 789             @Override
 790             public String getFailureMessage() {
 791                 return "Control was not resized";
 792             }
 793         });
 794     }
 795
 796     /**
 797      * Get the bounds of a cell (SWT.Rectangle) for the specified row and column
 798      * index in a table
 799      *
 800      * @param table
 801      *            the table
 802      * @param row
 803      *            the row of the table to look up
 804      * @param col
 805      *            the column of the table to look up
 806      * @return the bounds in display relative coordinates
 807      */
 808     public static Rectangle getCellBounds(final Table table, final int row, final int col) {
 809         return UIThreadRunnable.syncExec(new Result<Rectangle>() {
 810             @Override
 811             public Rectangle run() {
 812                 TableItem item = table.getItem(row);
 813                 Rectangle bounds = item.getBounds(col);
 814                 Point p = table.toDisplay(bounds.x, bounds.y);
 815                 Rectangle rect = new Rectangle(p.x, p.y, bounds.width, bounds.height);
 816                 return rect;
 817             }
 818         });
 819     }
 820
 821     /**
 822      * Get the tree item from a tree at the specified location
 823      *
 824      * @param bot
 825      *            the SWTBot
 826      * @param tree
 827      *            the tree to find the tree item in
 828      * @param nodeNames
 829      *            the path to the tree item, in the form of node names (from
 830      *            parent to child).
 831      * @return the tree item
 832      */
 833     public static SWTBotTreeItem getTreeItem(SWTBot bot, SWTBotTree tree, String... nodeNames) {
 834         if (nodeNames.length == 0) {
 835             return null;
 836         }
 837
 838         bot.waitUntil(ConditionHelpers.IsTreeNodeAvailable(nodeNames[0], tree));
 839         SWTBotTreeItem currentNode = tree.getTreeItem(nodeNames[0]);
 840         return getTreeItem(bot, currentNode, Arrays.copyOfRange(nodeNames, 1, nodeNames.length));
 841     }
 842
 843     /**
 844      * Get the tree item from a parent tree item at the specified location
 845      *
 846      * @param bot
 847      *            the SWTBot
 848      * @param treeItem
 849      *            the treeItem to find the tree item under
 850      * @param nodeNames
 851      *            the path to the tree item, in the form of node names (from
 852      *            parent to child).
 853      * @return the tree item
 854      */
 855     public static SWTBotTreeItem getTreeItem(SWTBot bot, SWTBotTreeItem treeItem, String... nodeNames) {
 856         if (nodeNames.length == 0) {
 857             return treeItem;
 858         }
 859
 860         SWTBotTreeItem currentNode = treeItem;
 861         for (int i = 0; i < nodeNames.length; i++) {
 862             bot.waitUntil(ConditionHelpers.treeItemHasChildren(treeItem));
 863             currentNode.expand();
 864
 865             String nodeName = nodeNames[i];
 866             try {
 867                 bot.waitUntil(ConditionHelpers.IsTreeChildNodeAvailable(nodeName, currentNode));
 868             } catch (TimeoutException e) {
 869                 //FIXME: Sometimes in a JFace TreeViewer, it expands to nothing. Need to find out why.
 870                 currentNode.collapse();
 871                 currentNode.expand();
 872                 bot.waitUntil(ConditionHelpers.IsTreeChildNodeAvailable(nodeName, currentNode));
 873             }
 874
 875             SWTBotTreeItem newNode = currentNode.getNode(nodeName);
 876             currentNode = newNode;
 877         }
 878
 879         return currentNode;
 880     }
 881
 882     /**
 883      * Press the keyboard shortcut that goes to the top of a tree widget. The
 884      * key combination can differ on different platforms.
 885      *
 886      * @param keyboard
 887      *            the keyboard to use
 888      */
 889     public static void pressShortcutGoToTreeTop(Keyboard keyboard) {
 890         if (SWTUtils.isMac()) {
 891             keyboard.pressShortcut(Keystrokes.ALT, Keystrokes.UP);
 892         } else {
 893             keyboard.pressShortcut(Keystrokes.HOME);
 894         }
 895     }
 896
 897     /**
 898      * Get the active events editor. Note that this will wait until such editor
 899      * is available.
 900      *
 901      * @param workbenchBot
 902      *            a given workbench bot
 903      * @return the active events editor
 904      */
 905     public static SWTBotEditor activeEventsEditor(final SWTWorkbenchBot workbenchBot) {
 906         ConditionHelpers.ActiveEventsEditor condition = new ConditionHelpers.ActiveEventsEditor(workbenchBot, null);
 907         workbenchBot.waitUntil(condition);
 908         return condition.getActiveEditor();
 909     }
 910
 911     /**
 912      * Get the active events editor. Note that this will wait until such editor
 913      * is available.
 914      *
 915      * @param workbenchBot
 916      *            a given workbench bot
 917      * @param editorTitle
 918      *            the desired editor title. If null, any active events editor
 919      *            will be considered valid.
 920      * @return the active events editor
 921      */
 922     public static SWTBotEditor activeEventsEditor(final SWTWorkbenchBot workbenchBot, String editorTitle) {
 923         ConditionHelpers.ActiveEventsEditor condition = new ConditionHelpers.ActiveEventsEditor(workbenchBot, editorTitle);
 924         workbenchBot.waitUntil(condition);
 925         return condition.getActiveEditor();
 926     }
 927
 928     /**
 929      * Open the preferences dialog and return the corresponding shell.
 930      *
 931      * @param bot
 932      *            a given workbench bot
 933      * @return the preferences shell
 934      */
 935     public static SWTBotShell openPreferences(SWTBot bot) {
 936         if (SWTUtils.isMac()) {
 937             // On Mac, the Preferences menu item is under the application name.
 938             // For some reason, we can't access the application menu anymore so
 939             // we use the keyboard shortcut.
 940             try {
 941                 bot.activeShell().pressShortcut(KeyStroke.getInstance(IKeyLookup.COMMAND_NAME + "+"), KeyStroke.getInstance(","));
 942             } catch (ParseException e) {
 943                 fail();
 944             }
 945         } else {
 946             bot.menu(WINDOW_MENU).menu(PREFERENCES_MENU_ITEM).click();
 947         }
 948
 949         bot.waitUntil(Conditions.shellIsActive(PREFERENCES_MENU_ITEM));
 950         return bot.activeShell();
 951     }
 952 }