1 /*******************************************************************************
2 * Copyright (c) 2014, 2015 Ericsson
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
10 * Matthew Khouzam - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.tracecompass
.tmf
.ui
.swtbot
.tests
.shared
;
15 import static org
.junit
.Assert
.assertNotNull
;
16 import static org
.junit
.Assert
.assertTrue
;
17 import static org
.junit
.Assert
.fail
;
19 import java
.util
.Arrays
;
20 import java
.util
.List
;
21 import java
.util
.TimeZone
;
22 import java
.util
.concurrent
.atomic
.AtomicBoolean
;
24 import org
.apache
.log4j
.Logger
;
25 import org
.eclipse
.core
.resources
.IFolder
;
26 import org
.eclipse
.core
.resources
.IProject
;
27 import org
.eclipse
.core
.resources
.IResource
;
28 import org
.eclipse
.core
.resources
.IResourceVisitor
;
29 import org
.eclipse
.core
.resources
.ResourcesPlugin
;
30 import org
.eclipse
.core
.runtime
.CoreException
;
31 import org
.eclipse
.core
.runtime
.IPath
;
32 import org
.eclipse
.core
.runtime
.NullProgressMonitor
;
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
.MessageFormat
;
56 import org
.eclipse
.swtbot
.swt
.finder
.utils
.SWTUtils
;
57 import org
.eclipse
.swtbot
.swt
.finder
.waits
.Conditions
;
58 import org
.eclipse
.swtbot
.swt
.finder
.waits
.DefaultCondition
;
59 import org
.eclipse
.swtbot
.swt
.finder
.widgets
.SWTBotButton
;
60 import org
.eclipse
.swtbot
.swt
.finder
.widgets
.SWTBotCheckBox
;
61 import org
.eclipse
.swtbot
.swt
.finder
.widgets
.SWTBotMenu
;
62 import org
.eclipse
.swtbot
.swt
.finder
.widgets
.SWTBotShell
;
63 import org
.eclipse
.swtbot
.swt
.finder
.widgets
.SWTBotTable
;
64 import org
.eclipse
.swtbot
.swt
.finder
.widgets
.SWTBotTree
;
65 import org
.eclipse
.swtbot
.swt
.finder
.widgets
.SWTBotTreeItem
;
66 import org
.eclipse
.swtbot
.swt
.finder
.widgets
.TimeoutException
;
67 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.project
.operations
.NewExperimentOperation
;
68 import org
.eclipse
.tracecompass
.tmf
.ui
.editors
.TmfEventsEditor
;
69 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfExperimentElement
;
70 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfExperimentFolder
;
71 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfOpenTraceHelper
;
72 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfProjectElement
;
73 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfProjectRegistry
;
74 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfTraceElement
;
75 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfTraceFolder
;
76 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfTracesFolder
;
77 import org
.eclipse
.tracecompass
.tmf
.ui
.swtbot
.tests
.shared
.ConditionHelpers
.ProjectElementHasChild
;
78 import org
.eclipse
.tracecompass
.tmf
.ui
.tests
.shared
.WaitUtils
;
79 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.TracingPerspectiveFactory
;
80 import org
.eclipse
.ui
.IEditorPart
;
81 import org
.eclipse
.ui
.IEditorReference
;
82 import org
.eclipse
.ui
.IPageLayout
;
83 import org
.eclipse
.ui
.PartInitException
;
84 import org
.eclipse
.ui
.PlatformUI
;
85 import org
.eclipse
.ui
.WorkbenchException
;
86 import org
.hamcrest
.Matcher
;
89 * SWTBot Helper functions
91 * @author Matthew Khouzam
93 @SuppressWarnings("restriction")
94 public final class SWTBotUtils
{
96 private static final String WINDOW_MENU
= "Window";
97 private static final String PREFERENCES_MENU_ITEM
= "Preferences";
98 private static boolean fPrintedEnvironment
= false;
99 private static Logger log
= Logger
.getLogger(SWTBotUtils
.class);
101 private SWTBotUtils() {
105 private static final String TRACING_PERSPECTIVE_ID
= TracingPerspectiveFactory
.ID
;
108 * Waits for all Eclipse jobs to finish. Times out after
109 * WaitUtils#MAX_JOBS_WAIT_TIME by default.
111 * @throws RuntimeException
112 * once the waiting time passes the default maximum value
114 * @deprecated Use {@link WaitUtils#waitForJobs()} instead
117 public static void waitForJobs() {
118 WaitUtils
.waitForJobs();
122 * Sleeps current thread for a given time.
124 * @param waitTimeMillis
125 * time in milliseconds to wait
127 public static void delay(final long waitTimeMillis
) {
129 Thread
.sleep(waitTimeMillis
);
130 } catch (final InterruptedException e
) {
136 * Create a tracing project
139 * the name of the tracing project
141 public static void createProject(final String projectName
) {
145 UIThreadRunnable
.syncExec(new VoidResult() {
148 IProject project
= TmfProjectRegistry
.createProject(projectName
, null, new NullProgressMonitor());
149 assertNotNull(project
);
153 WaitUtils
.waitForJobs();
160 * the name of the tracing project
161 * @param deleteResources
162 * whether or not to deleted resources under the project
166 public static void deleteProject(final String projectName
, boolean deleteResources
, SWTWorkbenchBot bot
) {
167 // Wait for any analysis to complete because it might create
168 // supplementary files
169 WaitUtils
.waitForJobs();
171 ResourcesPlugin
.getWorkspace().getRoot().getProject(projectName
).refreshLocal(IResource
.DEPTH_INFINITE
, null);
172 } catch (CoreException e
) {
175 WaitUtils
.waitForJobs();
177 closeSecondaryShells(bot
);
178 WaitUtils
.waitForJobs();
180 final SWTBotView projectViewBot
= bot
.viewById(IPageLayout
.ID_PROJECT_EXPLORER
);
181 projectViewBot
.setFocus();
183 SWTBotTree treeBot
= projectViewBot
.bot().tree();
184 SWTBotTreeItem treeItem
= treeBot
.getTreeItem(projectName
);
185 SWTBotMenu contextMenu
= treeItem
.contextMenu("Delete");
188 if (deleteResources
) {
189 bot
.shell("Delete Resources").setFocus();
190 final SWTBotCheckBox checkBox
= bot
.checkBox();
191 bot
.waitUntil(Conditions
.widgetIsEnabled(checkBox
));
195 final SWTBotButton okButton
= bot
.button("OK");
196 bot
.waitUntil(Conditions
.widgetIsEnabled(okButton
));
199 WaitUtils
.waitForJobs();
203 * Deletes a project and its resources
206 * the name of the tracing project
210 public static void deleteProject(String projectName
, SWTWorkbenchBot bot
) {
211 deleteProject(projectName
, true, bot
);
215 * Creates an experiment
218 * a given workbench bot
220 * the name of the project, creates the project if needed
222 * the experiment name
224 public static void createExperiment(SWTWorkbenchBot bot
, String projectName
, final @NonNull String expName
) {
225 IProject project
= ResourcesPlugin
.getWorkspace().getRoot().getProject(projectName
);
226 TmfProjectElement tmfProject
= TmfProjectRegistry
.getProject(project
, true);
227 TmfExperimentFolder expFolder
= tmfProject
.getExperimentsFolder();
228 assertNotNull(expFolder
);
229 NewExperimentOperation operation
= new NewExperimentOperation(expFolder
, expName
);
230 operation
.run(new NullProgressMonitor());
232 bot
.waitUntil(new DefaultCondition() {
234 public boolean test() throws Exception
{
235 TmfExperimentElement experiment
= expFolder
.getExperiment(expName
);
236 return experiment
!= null;
240 public String
getFailureMessage() {
241 return "Experiment (" + expName
+ ") couldn't be created";
248 * Focus on the main window
251 * swtbotshells for all the shells
253 public static void focusMainWindow(SWTBotShell
[] shellBots
) {
254 SWTBotShell mainShell
= getMainShell(shellBots
);
255 if (mainShell
!= null) {
256 mainShell
.activate();
260 private static SWTBotShell
getMainShell(SWTBotShell
[] shellBots
) {
261 SWTBotShell mainShell
= null;
262 for (SWTBotShell shellBot
: shellBots
) {
263 if (shellBot
.getText().toLowerCase().contains("eclipse")) {
264 mainShell
= shellBot
;
271 * Close all non-main shells that are visible.
276 public static void closeSecondaryShells(SWTWorkbenchBot bot
) {
277 SWTBotShell
[] shells
= bot
.shells();
278 SWTBotShell mainShell
= getMainShell(shells
);
279 if (mainShell
== null) {
283 // Close all non-main shell but make sure we don't close an invisible
284 // shell such the special "limbo shell" that Eclipse needs to work
285 Arrays
.stream(shells
)
286 .filter(shell
-> shell
!= mainShell
)
287 .filter(s
-> !s
.widget
.isDisposed())
288 .filter(SWTBotShell
::isVisible
)
289 .peek(shell
-> log
.debug(MessageFormat
.format("Closing lingering shell with title {0}", shell
.getText())))
290 .forEach(SWTBotShell
::close
);
294 * Close a view with a title
297 * the title, like "welcome"
301 public static void closeView(String title
, SWTWorkbenchBot bot
) {
302 final List
<SWTBotView
> openViews
= bot
.views();
303 for (SWTBotView view
: openViews
) {
304 if (view
.getTitle().equalsIgnoreCase(title
)) {
306 bot
.waitUntil(ConditionHelpers
.ViewIsClosed(view
));
312 * Close a view with an id
315 * the view id, like "org.eclipse.linuxtools.tmf.ui.views.histogram"
319 public static void closeViewById(String viewId
, SWTWorkbenchBot bot
) {
320 final SWTBotView view
= bot
.viewById(viewId
);
322 bot
.waitUntil(ConditionHelpers
.ViewIsClosed(view
));
326 * Switch to the tracing perspective
328 public static void switchToTracingPerspective() {
329 switchToPerspective(TRACING_PERSPECTIVE_ID
);
333 * Switch to a given perspective
336 * the perspective id (like
337 * "org.eclipse.linuxtools.tmf.ui.perspective"
339 public static void switchToPerspective(final String id
) {
340 UIThreadRunnable
.syncExec(new VoidResult() {
344 PlatformUI
.getWorkbench().showPerspective(id
, PlatformUI
.getWorkbench().getActiveWorkbenchWindow());
345 } catch (WorkbenchException e
) {
346 fail(e
.getMessage());
353 * Initialize the environment for SWTBot
355 public static void initialize() {
358 SWTWorkbenchBot bot
= new SWTWorkbenchBot();
359 UIThreadRunnable
.syncExec(() -> {
362 // There seems to be problems on some system where the main shell is
363 // not in focus initially. This was seen using Xvfb and Xephyr on some occasions.
364 focusMainWindow(bot
.shells());
366 Shell shell
= bot
.activeShell().widget
;
368 // Only adjust shell if it appears to be the top-most
369 if (shell
.getParent() == null) {
370 makeShellFullyVisible(shell
);
375 private static void printEnvironment() {
376 if (fPrintedEnvironment
) {
380 // Print some information about the environment that could affect test outcome
381 Rectangle bounds
= Display
.getDefault().getBounds();
382 System
.out
.println("Display size: " + bounds
.width
+ "x" + bounds
.height
);
384 String osVersion
= System
.getProperty("os.version");
385 if (osVersion
!= null) {
386 System
.out
.println("OS version=" + osVersion
);
388 String gtkVersion
= System
.getProperty("org.eclipse.swt.internal.gtk.version");
389 if (gtkVersion
!= null) {
390 System
.out
.println("GTK version=" + gtkVersion
);
391 // Try to print the GTK theme information as behavior can change depending on the theme
392 String gtkTheme
= System
.getProperty("org.eclipse.swt.internal.gtk.theme");
393 System
.out
.println("GTK theme=" + (gtkTheme
== null ?
"unknown" : gtkTheme
));
395 String overlayScrollbar
= System
.getenv("LIBOVERLAY_SCROLLBAR");
396 if (overlayScrollbar
!= null) {
397 System
.out
.println("LIBOVERLAY_SCROLLBAR=" + overlayScrollbar
);
399 String ubuntuMenuProxy
= System
.getenv("UBUNTU_MENUPROXY");
400 if (ubuntuMenuProxy
!= null) {
401 System
.out
.println("UBUNTU_MENUPROXY=" + ubuntuMenuProxy
);
405 System
.out
.println("Time zone: " + TimeZone
.getDefault().getDisplayName());
407 fPrintedEnvironment
= true;
411 * If the test is running in the UI thread then fail
413 private static void failIfUIThread() {
414 if (Display
.getCurrent() != null && Display
.getCurrent().getThread() == Thread
.currentThread()) {
415 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"
416 + " that useUIThread is set to false in the pom.xml");
421 * Try to make the shell fully visible in the display. If the shell cannot
422 * fit the display, it will be positioned so that top-left corner is at
423 * <code>(0, 0)</code> in display-relative coordinates.
426 * the shell to make fully visible
428 private static void makeShellFullyVisible(Shell shell
) {
429 Rectangle displayBounds
= shell
.getDisplay().getBounds();
430 Point absCoord
= shell
.toDisplay(0, 0);
431 Point shellSize
= shell
.getSize();
433 Point newLocation
= new Point(absCoord
.x
, absCoord
.y
);
434 newLocation
.x
= Math
.max(0, Math
.min(absCoord
.x
, displayBounds
.width
- shellSize
.x
));
435 newLocation
.y
= Math
.max(0, Math
.min(absCoord
.y
, displayBounds
.height
- shellSize
.y
));
436 if (!newLocation
.equals(absCoord
)) {
437 shell
.setLocation(newLocation
);
442 * Open a trace, this does not perform any validation though
447 * the path of the trace file (absolute or relative)
449 * the trace type id (eg: org.eclipse.linuxtools.btf.trace)
451 public static void openTrace(final String projectName
, final String tracePath
, final String traceType
) {
452 openTrace(projectName
, tracePath
, traceType
, true);
456 * Open a trace, this does not perform any validation though
461 * the path of the trace file (absolute or relative)
463 * the trace type id (eg: org.eclipse.linuxtools.btf.trace)
465 * delay and wait for jobs
467 public static void openTrace(final String projectName
, final String tracePath
, final String traceType
, boolean delay
) {
468 final Exception exception
[] = new Exception
[1];
470 UIThreadRunnable
.syncExec(new VoidResult() {
474 IProject project
= ResourcesPlugin
.getWorkspace().getRoot().getProject(projectName
);
475 TmfTraceFolder destinationFolder
= TmfProjectRegistry
.getProject(project
, true).getTracesFolder();
476 TmfOpenTraceHelper
.openTraceFromPath(destinationFolder
, tracePath
, PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell(), traceType
);
477 } catch (CoreException e
) {
482 if (exception
[0] != null) {
483 fail(exception
[0].getMessage());
488 WaitUtils
.waitForJobs();
493 * Finds an editor and sets focus to the editor
499 * @return the corresponding SWTBotEditor
501 public static SWTBotEditor
activateEditor(SWTWorkbenchBot bot
, String editorName
) {
502 Matcher
<IEditorReference
> matcher
= WidgetMatcherFactory
.withPartName(editorName
);
503 final SWTBotEditor editorBot
= bot
.editor(matcher
);
504 IEditorPart iep
= editorBot
.getReference().getEditor(true);
505 final TmfEventsEditor tmfEd
= (TmfEventsEditor
) iep
;
507 UIThreadRunnable
.syncExec(new VoidResult() {
514 WaitUtils
.waitForJobs();
515 SWTBotUtils
.delay(1000);
516 assertNotNull(tmfEd
);
521 * Opens a trace in an editor and get the TmfEventsEditor
526 * the name of the project that contains the trace
528 * the trace element path (relative to Traces folder)
529 * @return TmfEventsEditor the opened editor
531 public static TmfEventsEditor
openEditor(SWTWorkbenchBot bot
, String projectName
, IPath elementPath
) {
532 final SWTBotView projectExplorerView
= bot
.viewById(IPageLayout
.ID_PROJECT_EXPLORER
);
533 projectExplorerView
.setFocus();
534 SWTBot projectExplorerBot
= projectExplorerView
.bot();
536 final SWTBotTree tree
= projectExplorerBot
.tree();
537 projectExplorerBot
.waitUntil(ConditionHelpers
.IsTreeNodeAvailable(projectName
, tree
));
538 final SWTBotTreeItem treeItem
= tree
.getTreeItem(projectName
);
541 SWTBotTreeItem tracesNode
= getTraceProjectItem(projectExplorerBot
, treeItem
, TmfTracesFolder
.TRACES_FOLDER_NAME
);
544 SWTBotTreeItem currentItem
= tracesNode
;
545 for (String segment
: elementPath
.segments()) {
546 currentItem
= getTraceProjectItem(projectExplorerBot
, currentItem
, segment
);
547 currentItem
.doubleClick();
550 SWTBotEditor editor
= bot
.editorByTitle(elementPath
.toString());
551 IEditorPart editorPart
= editor
.getReference().getEditor(false);
552 assertTrue(editorPart
instanceof TmfEventsEditor
);
553 return (TmfEventsEditor
) editorPart
;
557 * Returns the child tree item of the specified item at the given sub-path.
558 * The project element labels may have a count suffix in the format ' [n]'.
561 * a given workbench bot
563 * the parent tree item
565 * the desired child element sub-path (without suffix)
566 * @return the a {@link SWTBotTreeItem} with the specified name
568 public static SWTBotTreeItem
getTraceProjectItem(SWTBot bot
, final SWTBotTreeItem parentItem
, final String
... path
) {
569 SWTBotTreeItem item
= parentItem
;
570 for (String name
: path
) {
571 item
= getTraceProjectItem(bot
, item
, name
);
577 * Returns the child tree item of the specified item with the given name.
578 * The project element label may have a count suffix in the format ' [n]'.
581 * a given workbench bot
583 * the parent tree item
585 * the desired child element name (without suffix)
586 * @return the a {@link SWTBotTreeItem} with the specified name
588 public static SWTBotTreeItem
getTraceProjectItem(SWTBot bot
, final SWTBotTreeItem parentItem
, final String name
) {
589 ProjectElementHasChild condition
= new ProjectElementHasChild(parentItem
, name
);
590 bot
.waitUntil(condition
);
591 return condition
.getItem();
595 * Select the traces folder
598 * a given workbench bot
600 * the name of the project (it needs to exist or else it would
602 * @return a {@link SWTBotTreeItem} of the "Traces" folder
604 public static SWTBotTreeItem
selectTracesFolder(SWTWorkbenchBot bot
, String projectName
) {
605 SWTBotTreeItem projectTreeItem
= selectProject(bot
, projectName
);
606 projectTreeItem
.select();
607 SWTBotTreeItem tracesFolderItem
= getTraceProjectItem(bot
, projectTreeItem
, TmfTracesFolder
.TRACES_FOLDER_NAME
);
608 tracesFolderItem
.select();
609 return tracesFolderItem
;
613 * Clear the traces folder
616 * a given workbench bot
618 * the name of the project (needs to exist)
620 public static void clearTracesFolder(SWTWorkbenchBot bot
, String projectName
) {
621 IProject project
= ResourcesPlugin
.getWorkspace().getRoot().getProject(projectName
);
622 TmfProjectElement tmfProject
= TmfProjectRegistry
.getProject(project
, false);
623 TmfTraceFolder tracesFolder
= tmfProject
.getTracesFolder();
625 for (TmfTraceElement traceElement
: tracesFolder
.getTraces()) {
626 traceElement
.delete(null);
629 final IFolder resource
= tracesFolder
.getResource();
630 resource
.accept(new IResourceVisitor() {
632 public boolean visit(IResource visitedResource
) throws CoreException
{
633 if (visitedResource
!= resource
) {
634 visitedResource
.delete(true, null);
638 }, IResource
.DEPTH_ONE
, 0);
639 } catch (CoreException e
) {
640 fail(e
.getMessage());
643 bot
.waitUntil(new DefaultCondition() {
644 private int fTraceNb
= 0;
647 public boolean test() throws Exception
{
648 List
<TmfTraceElement
> traces
= tracesFolder
.getTraces();
649 fTraceNb
= traces
.size();
650 return fTraceNb
== 0;
654 public String
getFailureMessage() {
655 return "Traces Folder not empty (" + fTraceNb
+ ")";
661 * Clear the trace folder (using the UI)
664 * a given workbench bot
666 * the name of the project (needs to exist)
668 public static void clearTracesFolderUI(SWTWorkbenchBot bot
, String projectName
) {
669 SWTBotTreeItem tracesFolder
= selectTracesFolder(bot
, projectName
);
670 tracesFolder
.contextMenu().menu("Clear").click();
671 String CONFIRM_CLEAR_DIALOG_TITLE
= "Confirm Clear";
672 bot
.waitUntil(Conditions
.shellIsActive(CONFIRM_CLEAR_DIALOG_TITLE
));
674 SWTBotShell shell
= bot
.shell(CONFIRM_CLEAR_DIALOG_TITLE
);
675 shell
.bot().button("Yes").click();
676 bot
.waitUntil(Conditions
.shellCloses(shell
));
677 bot
.waitWhile(ConditionHelpers
.treeItemHasChildren(tracesFolder
));
681 * Clear the experiment folder
684 * a given workbench bot
686 * the name of the project (needs to exist)
688 public static void clearExperimentFolder(SWTWorkbenchBot bot
, String projectName
) {
689 IProject project
= ResourcesPlugin
.getWorkspace().getRoot().getProject(projectName
);
690 TmfProjectElement tmfProject
= TmfProjectRegistry
.getProject(project
, false);
691 TmfExperimentFolder expFolder
= tmfProject
.getExperimentsFolder();
692 expFolder
.getExperiments().forEach(experiment
-> {
693 IResource resource
= experiment
.getResource();
695 // Close the experiment if open
696 experiment
.closeEditors();
698 IPath path
= resource
.getLocation();
700 // Delete supplementary files
701 experiment
.deleteSupplementaryFolder();
703 // Finally, delete the experiment
704 resource
.delete(true, null);
705 } catch (CoreException e
) {
706 fail(e
.getMessage());
710 bot
.waitUntil(new DefaultCondition() {
711 private int fExperimentNb
= 0;
714 public boolean test() throws Exception
{
715 List
<TmfExperimentElement
> experiments
= expFolder
.getExperiments();
716 fExperimentNb
= experiments
.size();
717 return fExperimentNb
== 0;
721 public String
getFailureMessage() {
722 return "Experiment Folder not empty (" + fExperimentNb
+ ")";
728 * Select the project in Project Explorer
731 * a given workbench bot
733 * the name of the project (it needs to exist or else it would time out)
734 * @return a {@link SWTBotTreeItem} of the project
736 public static SWTBotTreeItem
selectProject(SWTWorkbenchBot bot
, String projectName
) {
737 SWTBotView projectExplorerBot
= bot
.viewByTitle("Project Explorer");
738 projectExplorerBot
.show();
739 // FIXME: Bug 496519. Sometimes, the tree becomes disabled for a certain
740 // amount of time. This can happen during a long running operation
741 // (BusyIndicator.showWhile) which brings up the modal dialog "operation
742 // in progress" and this disables all shells
743 projectExplorerBot
.bot().waitUntil(Conditions
.widgetIsEnabled(projectExplorerBot
.bot().tree()));
744 SWTBotTreeItem treeItem
= projectExplorerBot
.bot().tree().getTreeItem(projectName
);
755 public static void openView(final String id
) {
756 final PartInitException res
[] = new PartInitException
[1];
757 UIThreadRunnable
.syncExec(new VoidResult() {
761 PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage().showView(id
);
762 } catch (PartInitException e
) {
767 if (res
[0] != null) {
768 fail(res
[0].getMessage());
770 WaitUtils
.waitForJobs();
777 * the {@link SWTBotTable} table
779 public static void maximizeTable(SWTBotTable tableBot
) {
780 final AtomicBoolean controlResized
= new AtomicBoolean();
781 UIThreadRunnable
.syncExec(new VoidResult() {
784 tableBot
.widget
.addControlListener(new ControlAdapter() {
786 public void controlResized(ControlEvent e
) {
787 tableBot
.widget
.removeControlListener(this);
788 controlResized
.set(true);
794 tableBot
.pressShortcut(KeyStroke
.getInstance(IKeyLookup
.CTRL_NAME
+ "+"), KeyStroke
.getInstance("M"));
795 } catch (ParseException e
) {
798 new SWTBot().waitUntil(new DefaultCondition() {
800 public boolean test() throws Exception
{
801 return controlResized
.get();
805 public String
getFailureMessage() {
806 return "Control was not resized";
812 * Get the bounds of a cell (SWT.Rectangle) for the specified row and column
818 * the row of the table to look up
820 * the column of the table to look up
821 * @return the bounds in display relative coordinates
823 public static Rectangle
getCellBounds(final Table table
, final int row
, final int col
) {
824 return UIThreadRunnable
.syncExec(new Result
<Rectangle
>() {
826 public Rectangle
run() {
827 TableItem item
= table
.getItem(row
);
828 Rectangle bounds
= item
.getBounds(col
);
829 Point p
= table
.toDisplay(bounds
.x
, bounds
.y
);
830 Rectangle rect
= new Rectangle(p
.x
, p
.y
, bounds
.width
, bounds
.height
);
837 * Get the tree item from a tree at the specified location
842 * the tree to find the tree item in
844 * the path to the tree item, in the form of node names (from
846 * @return the tree item
848 public static SWTBotTreeItem
getTreeItem(SWTBot bot
, SWTBotTree tree
, String
... nodeNames
) {
849 if (nodeNames
.length
== 0) {
853 bot
.waitUntil(ConditionHelpers
.IsTreeNodeAvailable(nodeNames
[0], tree
));
854 SWTBotTreeItem currentNode
= tree
.getTreeItem(nodeNames
[0]);
855 return getTreeItem(bot
, currentNode
, Arrays
.copyOfRange(nodeNames
, 1, nodeNames
.length
));
859 * Get the tree item from a parent tree item at the specified location
864 * the treeItem to find the tree item under
866 * the path to the tree item, in the form of node names (from
868 * @return the tree item
870 public static SWTBotTreeItem
getTreeItem(SWTBot bot
, SWTBotTreeItem treeItem
, String
... nodeNames
) {
871 if (nodeNames
.length
== 0) {
875 SWTBotTreeItem currentNode
= treeItem
;
876 for (int i
= 0; i
< nodeNames
.length
; i
++) {
877 bot
.waitUntil(ConditionHelpers
.treeItemHasChildren(treeItem
));
878 currentNode
.expand();
880 String nodeName
= nodeNames
[i
];
882 bot
.waitUntil(ConditionHelpers
.IsTreeChildNodeAvailable(nodeName
, currentNode
));
883 } catch (TimeoutException e
) {
884 //FIXME: Sometimes in a JFace TreeViewer, it expands to nothing. Need to find out why.
885 currentNode
.collapse();
886 currentNode
.expand();
887 bot
.waitUntil(ConditionHelpers
.IsTreeChildNodeAvailable(nodeName
, currentNode
));
890 SWTBotTreeItem newNode
= currentNode
.getNode(nodeName
);
891 currentNode
= newNode
;
898 * Press the keyboard shortcut that goes to the top of a tree widget. The
899 * key combination can differ on different platforms.
902 * the keyboard to use
904 public static void pressShortcutGoToTreeTop(Keyboard keyboard
) {
905 if (SWTUtils
.isMac()) {
906 keyboard
.pressShortcut(Keystrokes
.ALT
, Keystrokes
.UP
);
908 keyboard
.pressShortcut(Keystrokes
.HOME
);
913 * Get the active events editor. Note that this will wait until such editor
916 * @param workbenchBot
917 * a given workbench bot
918 * @return the active events editor
920 public static SWTBotEditor
activeEventsEditor(final SWTWorkbenchBot workbenchBot
) {
921 ConditionHelpers
.ActiveEventsEditor condition
= new ConditionHelpers
.ActiveEventsEditor(workbenchBot
, null);
922 workbenchBot
.waitUntil(condition
);
923 return condition
.getActiveEditor();
927 * Get the active events editor. Note that this will wait until such editor
930 * @param workbenchBot
931 * a given workbench bot
933 * the desired editor title. If null, any active events editor
934 * will be considered valid.
935 * @return the active events editor
937 public static SWTBotEditor
activeEventsEditor(final SWTWorkbenchBot workbenchBot
, String editorTitle
) {
938 ConditionHelpers
.ActiveEventsEditor condition
= new ConditionHelpers
.ActiveEventsEditor(workbenchBot
, editorTitle
);
939 workbenchBot
.waitUntil(condition
);
940 return condition
.getActiveEditor();
944 * Open the preferences dialog and return the corresponding shell.
947 * a given workbench bot
948 * @return the preferences shell
950 public static SWTBotShell
openPreferences(SWTBot bot
) {
951 if (SWTUtils
.isMac()) {
952 // On Mac, the Preferences menu item is under the application name.
953 // For some reason, we can't access the application menu anymore so
954 // we use the keyboard shortcut.
956 bot
.activeShell().pressShortcut(KeyStroke
.getInstance(IKeyLookup
.COMMAND_NAME
+ "+"), KeyStroke
.getInstance(","));
957 } catch (ParseException e
) {
961 bot
.menu(WINDOW_MENU
).menu(PREFERENCES_MENU_ITEM
).click();
964 bot
.waitUntil(Conditions
.shellIsActive(PREFERENCES_MENU_ITEM
));
965 return bot
.activeShell();