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(SWTBotShell
::isVisible
)
288 .peek(shell
-> log
.debug(MessageFormat
.format("Closing lingering shell with title {0}", shell
.getText())))
289 .forEach(SWTBotShell
::close
);
293 * Close a view with a title
296 * the title, like "welcome"
300 public static void closeView(String title
, SWTWorkbenchBot bot
) {
301 final List
<SWTBotView
> openViews
= bot
.views();
302 for (SWTBotView view
: openViews
) {
303 if (view
.getTitle().equalsIgnoreCase(title
)) {
305 bot
.waitUntil(ConditionHelpers
.ViewIsClosed(view
));
311 * Close a view with an id
314 * the view id, like "org.eclipse.linuxtools.tmf.ui.views.histogram"
318 public static void closeViewById(String viewId
, SWTWorkbenchBot bot
) {
319 final SWTBotView view
= bot
.viewById(viewId
);
321 bot
.waitUntil(ConditionHelpers
.ViewIsClosed(view
));
325 * Switch to the tracing perspective
327 public static void switchToTracingPerspective() {
328 switchToPerspective(TRACING_PERSPECTIVE_ID
);
332 * Switch to a given perspective
335 * the perspective id (like
336 * "org.eclipse.linuxtools.tmf.ui.perspective"
338 public static void switchToPerspective(final String id
) {
339 UIThreadRunnable
.syncExec(new VoidResult() {
343 PlatformUI
.getWorkbench().showPerspective(id
, PlatformUI
.getWorkbench().getActiveWorkbenchWindow());
344 } catch (WorkbenchException e
) {
345 fail(e
.getMessage());
352 * Initialize the environment for SWTBot
354 public static void initialize() {
357 SWTWorkbenchBot bot
= new SWTWorkbenchBot();
358 UIThreadRunnable
.syncExec(() -> {
361 // There seems to be problems on some system where the main shell is
362 // not in focus initially. This was seen using Xvfb and Xephyr on some occasions.
363 focusMainWindow(bot
.shells());
365 Shell shell
= bot
.activeShell().widget
;
367 // Only adjust shell if it appears to be the top-most
368 if (shell
.getParent() == null) {
369 makeShellFullyVisible(shell
);
374 private static void printEnvironment() {
375 if (fPrintedEnvironment
) {
379 // Print some information about the environment that could affect test outcome
380 Rectangle bounds
= Display
.getDefault().getBounds();
381 System
.out
.println("Display size: " + bounds
.width
+ "x" + bounds
.height
);
383 String osVersion
= System
.getProperty("os.version");
384 if (osVersion
!= null) {
385 System
.out
.println("OS version=" + osVersion
);
387 String gtkVersion
= System
.getProperty("org.eclipse.swt.internal.gtk.version");
388 if (gtkVersion
!= null) {
389 System
.out
.println("GTK version=" + gtkVersion
);
390 // Try to print the GTK theme information as behavior can change depending on the theme
391 String gtkTheme
= System
.getProperty("org.eclipse.swt.internal.gtk.theme");
392 System
.out
.println("GTK theme=" + (gtkTheme
== null ?
"unknown" : gtkTheme
));
394 String overlayScrollbar
= System
.getenv("LIBOVERLAY_SCROLLBAR");
395 if (overlayScrollbar
!= null) {
396 System
.out
.println("LIBOVERLAY_SCROLLBAR=" + overlayScrollbar
);
398 String ubuntuMenuProxy
= System
.getenv("UBUNTU_MENUPROXY");
399 if (ubuntuMenuProxy
!= null) {
400 System
.out
.println("UBUNTU_MENUPROXY=" + ubuntuMenuProxy
);
404 System
.out
.println("Time zone: " + TimeZone
.getDefault().getDisplayName());
406 fPrintedEnvironment
= true;
410 * If the test is running in the UI thread then fail
412 private static void failIfUIThread() {
413 if (Display
.getCurrent() != null && Display
.getCurrent().getThread() == Thread
.currentThread()) {
414 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"
415 + " that useUIThread is set to false in the pom.xml");
420 * Try to make the shell fully visible in the display. If the shell cannot
421 * fit the display, it will be positioned so that top-left corner is at
422 * <code>(0, 0)</code> in display-relative coordinates.
425 * the shell to make fully visible
427 private static void makeShellFullyVisible(Shell shell
) {
428 Rectangle displayBounds
= shell
.getDisplay().getBounds();
429 Point absCoord
= shell
.toDisplay(0, 0);
430 Point shellSize
= shell
.getSize();
432 Point newLocation
= new Point(absCoord
.x
, absCoord
.y
);
433 newLocation
.x
= Math
.max(0, Math
.min(absCoord
.x
, displayBounds
.width
- shellSize
.x
));
434 newLocation
.y
= Math
.max(0, Math
.min(absCoord
.y
, displayBounds
.height
- shellSize
.y
));
435 if (!newLocation
.equals(absCoord
)) {
436 shell
.setLocation(newLocation
);
441 * Open a trace, this does not perform any validation though
446 * the path of the trace file (absolute or relative)
448 * the trace type id (eg: org.eclipse.linuxtools.btf.trace)
450 public static void openTrace(final String projectName
, final String tracePath
, final String traceType
) {
451 openTrace(projectName
, tracePath
, traceType
, true);
455 * Open a trace, this does not perform any validation though
460 * the path of the trace file (absolute or relative)
462 * the trace type id (eg: org.eclipse.linuxtools.btf.trace)
464 * delay and wait for jobs
466 public static void openTrace(final String projectName
, final String tracePath
, final String traceType
, boolean delay
) {
467 final Exception exception
[] = new Exception
[1];
469 UIThreadRunnable
.syncExec(new VoidResult() {
473 IProject project
= ResourcesPlugin
.getWorkspace().getRoot().getProject(projectName
);
474 TmfTraceFolder destinationFolder
= TmfProjectRegistry
.getProject(project
, true).getTracesFolder();
475 TmfOpenTraceHelper
.openTraceFromPath(destinationFolder
, tracePath
, PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell(), traceType
);
476 } catch (CoreException e
) {
481 if (exception
[0] != null) {
482 fail(exception
[0].getMessage());
487 WaitUtils
.waitForJobs();
492 * Finds an editor and sets focus to the editor
498 * @return the corresponding SWTBotEditor
500 public static SWTBotEditor
activateEditor(SWTWorkbenchBot bot
, String editorName
) {
501 Matcher
<IEditorReference
> matcher
= WidgetMatcherFactory
.withPartName(editorName
);
502 final SWTBotEditor editorBot
= bot
.editor(matcher
);
503 IEditorPart iep
= editorBot
.getReference().getEditor(true);
504 final TmfEventsEditor tmfEd
= (TmfEventsEditor
) iep
;
506 UIThreadRunnable
.syncExec(new VoidResult() {
513 WaitUtils
.waitForJobs();
514 SWTBotUtils
.delay(1000);
515 assertNotNull(tmfEd
);
520 * Opens a trace in an editor and get the TmfEventsEditor
525 * the name of the project that contains the trace
527 * the trace element path (relative to Traces folder)
528 * @return TmfEventsEditor the opened editor
530 public static TmfEventsEditor
openEditor(SWTWorkbenchBot bot
, String projectName
, IPath elementPath
) {
531 final SWTBotView projectExplorerView
= bot
.viewById(IPageLayout
.ID_PROJECT_EXPLORER
);
532 projectExplorerView
.setFocus();
533 SWTBot projectExplorerBot
= projectExplorerView
.bot();
535 final SWTBotTree tree
= projectExplorerBot
.tree();
536 projectExplorerBot
.waitUntil(ConditionHelpers
.IsTreeNodeAvailable(projectName
, tree
));
537 final SWTBotTreeItem treeItem
= tree
.getTreeItem(projectName
);
540 SWTBotTreeItem tracesNode
= getTraceProjectItem(projectExplorerBot
, treeItem
, TmfTracesFolder
.TRACES_FOLDER_NAME
);
543 SWTBotTreeItem currentItem
= tracesNode
;
544 for (String segment
: elementPath
.segments()) {
545 currentItem
= getTraceProjectItem(projectExplorerBot
, currentItem
, segment
);
546 currentItem
.doubleClick();
549 SWTBotEditor editor
= bot
.editorByTitle(elementPath
.toString());
550 IEditorPart editorPart
= editor
.getReference().getEditor(false);
551 assertTrue(editorPart
instanceof TmfEventsEditor
);
552 return (TmfEventsEditor
) editorPart
;
556 * Returns the child tree item of the specified item with the given name.
557 * The project element label may have a count suffix in the format ' [n]'.
560 * a given workbench bot
562 * the parent tree item
564 * the desired child element name (without suffix)
565 * @return the a {@link SWTBotTreeItem} with the specified name
567 public static SWTBotTreeItem
getTraceProjectItem(SWTBot bot
, final SWTBotTreeItem parentItem
, final String name
) {
568 ProjectElementHasChild condition
= new ProjectElementHasChild(parentItem
, name
);
569 bot
.waitUntil(condition
);
570 return condition
.getItem();
574 * Select the traces folder
577 * a given workbench bot
579 * the name of the project (it needs to exist or else it would
581 * @return a {@link SWTBotTreeItem} of the "Traces" folder
583 public static SWTBotTreeItem
selectTracesFolder(SWTWorkbenchBot bot
, String projectName
) {
584 SWTBotTreeItem projectTreeItem
= selectProject(bot
, projectName
);
585 projectTreeItem
.select();
586 SWTBotTreeItem tracesFolderItem
= getTraceProjectItem(bot
, projectTreeItem
, TmfTracesFolder
.TRACES_FOLDER_NAME
);
587 tracesFolderItem
.select();
588 return tracesFolderItem
;
592 * Clear the traces folder
595 * a given workbench bot
597 * the name of the project (needs to exist)
599 public static void clearTracesFolder(SWTWorkbenchBot bot
, String projectName
) {
600 IProject project
= ResourcesPlugin
.getWorkspace().getRoot().getProject(projectName
);
601 TmfProjectElement tmfProject
= TmfProjectRegistry
.getProject(project
, false);
602 TmfTraceFolder tracesFolder
= tmfProject
.getTracesFolder();
604 for (TmfTraceElement traceElement
: tracesFolder
.getTraces()) {
605 traceElement
.delete(null);
608 final IFolder resource
= tracesFolder
.getResource();
609 resource
.accept(new IResourceVisitor() {
611 public boolean visit(IResource visitedResource
) throws CoreException
{
612 if (visitedResource
!= resource
) {
613 visitedResource
.delete(true, null);
617 }, IResource
.DEPTH_ONE
, 0);
618 } catch (CoreException e
) {
619 fail(e
.getMessage());
622 bot
.waitUntil(new DefaultCondition() {
623 private int fTraceNb
= 0;
626 public boolean test() throws Exception
{
627 List
<TmfTraceElement
> traces
= tracesFolder
.getTraces();
628 fTraceNb
= traces
.size();
629 return fTraceNb
== 0;
633 public String
getFailureMessage() {
634 return "Traces Folder not empty (" + fTraceNb
+ ")";
640 * Clear the trace folder (using the UI)
643 * a given workbench bot
645 * the name of the project (needs to exist)
647 public static void clearTracesFolderUI(SWTWorkbenchBot bot
, String projectName
) {
648 SWTBotTreeItem tracesFolder
= selectTracesFolder(bot
, projectName
);
649 tracesFolder
.contextMenu().menu("Clear").click();
650 String CONFIRM_CLEAR_DIALOG_TITLE
= "Confirm Clear";
651 bot
.waitUntil(Conditions
.shellIsActive(CONFIRM_CLEAR_DIALOG_TITLE
));
653 SWTBotShell shell
= bot
.shell(CONFIRM_CLEAR_DIALOG_TITLE
);
654 shell
.bot().button("Yes").click();
655 bot
.waitUntil(Conditions
.shellCloses(shell
));
656 bot
.waitWhile(ConditionHelpers
.treeItemHasChildren(tracesFolder
));
660 * Clear the experiment folder
663 * a given workbench bot
665 * the name of the project (needs to exist)
667 public static void clearExperimentFolder(SWTWorkbenchBot bot
, String projectName
) {
668 IProject project
= ResourcesPlugin
.getWorkspace().getRoot().getProject(projectName
);
669 TmfProjectElement tmfProject
= TmfProjectRegistry
.getProject(project
, false);
670 TmfExperimentFolder expFolder
= tmfProject
.getExperimentsFolder();
671 expFolder
.getExperiments().forEach(experiment
-> {
672 IResource resource
= experiment
.getResource();
674 // Close the experiment if open
675 experiment
.closeEditors();
677 IPath path
= resource
.getLocation();
679 // Delete supplementary files
680 experiment
.deleteSupplementaryFolder();
682 // Finally, delete the experiment
683 resource
.delete(true, null);
684 } catch (CoreException e
) {
685 fail(e
.getMessage());
689 bot
.waitUntil(new DefaultCondition() {
690 private int fExperimentNb
= 0;
693 public boolean test() throws Exception
{
694 List
<TmfExperimentElement
> experiments
= expFolder
.getExperiments();
695 fExperimentNb
= experiments
.size();
696 return fExperimentNb
== 0;
700 public String
getFailureMessage() {
701 return "Experiment Folder not empty (" + fExperimentNb
+ ")";
707 * Select the project in Project Explorer
710 * a given workbench bot
712 * the name of the project (it needs to exist or else it would time out)
713 * @return a {@link SWTBotTreeItem} of the project
715 public static SWTBotTreeItem
selectProject(SWTWorkbenchBot bot
, String projectName
) {
716 SWTBotView projectExplorerBot
= bot
.viewByTitle("Project Explorer");
717 projectExplorerBot
.show();
718 // FIXME: Bug 496519. Sometimes, the tree becomes disabled for a certain
719 // amount of time. This can happen during a long running operation
720 // (BusyIndicator.showWhile) which brings up the modal dialog "operation
721 // in progress" and this disables all shells
722 projectExplorerBot
.bot().waitUntil(Conditions
.widgetIsEnabled(projectExplorerBot
.bot().tree()));
723 SWTBotTreeItem treeItem
= projectExplorerBot
.bot().tree().getTreeItem(projectName
);
734 public static void openView(final String id
) {
735 final PartInitException res
[] = new PartInitException
[1];
736 UIThreadRunnable
.syncExec(new VoidResult() {
740 PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage().showView(id
);
741 } catch (PartInitException e
) {
746 if (res
[0] != null) {
747 fail(res
[0].getMessage());
749 WaitUtils
.waitForJobs();
756 * the {@link SWTBotTable} table
758 public static void maximizeTable(SWTBotTable tableBot
) {
759 final AtomicBoolean controlResized
= new AtomicBoolean();
760 UIThreadRunnable
.syncExec(new VoidResult() {
763 tableBot
.widget
.addControlListener(new ControlAdapter() {
765 public void controlResized(ControlEvent e
) {
766 tableBot
.widget
.removeControlListener(this);
767 controlResized
.set(true);
773 tableBot
.pressShortcut(KeyStroke
.getInstance(IKeyLookup
.CTRL_NAME
+ "+"), KeyStroke
.getInstance("M"));
774 } catch (ParseException e
) {
777 new SWTBot().waitUntil(new DefaultCondition() {
779 public boolean test() throws Exception
{
780 return controlResized
.get();
784 public String
getFailureMessage() {
785 return "Control was not resized";
791 * Get the bounds of a cell (SWT.Rectangle) for the specified row and column
797 * the row of the table to look up
799 * the column of the table to look up
800 * @return the bounds in display relative coordinates
802 public static Rectangle
getCellBounds(final Table table
, final int row
, final int col
) {
803 return UIThreadRunnable
.syncExec(new Result
<Rectangle
>() {
805 public Rectangle
run() {
806 TableItem item
= table
.getItem(row
);
807 Rectangle bounds
= item
.getBounds(col
);
808 Point p
= table
.toDisplay(bounds
.x
, bounds
.y
);
809 Rectangle rect
= new Rectangle(p
.x
, p
.y
, bounds
.width
, bounds
.height
);
816 * Get the tree item from a tree at the specified location
821 * the tree to find the tree item in
823 * the path to the tree item, in the form of node names (from
825 * @return the tree item
827 public static SWTBotTreeItem
getTreeItem(SWTBot bot
, SWTBotTree tree
, String
... nodeNames
) {
828 if (nodeNames
.length
== 0) {
832 bot
.waitUntil(ConditionHelpers
.IsTreeNodeAvailable(nodeNames
[0], tree
));
833 SWTBotTreeItem currentNode
= tree
.getTreeItem(nodeNames
[0]);
834 return getTreeItem(bot
, currentNode
, Arrays
.copyOfRange(nodeNames
, 1, nodeNames
.length
));
838 * Get the tree item from a parent tree item at the specified location
843 * the treeItem to find the tree item under
845 * the path to the tree item, in the form of node names (from
847 * @return the tree item
849 public static SWTBotTreeItem
getTreeItem(SWTBot bot
, SWTBotTreeItem treeItem
, String
... nodeNames
) {
850 if (nodeNames
.length
== 0) {
854 SWTBotTreeItem currentNode
= treeItem
;
855 for (int i
= 0; i
< nodeNames
.length
; i
++) {
856 bot
.waitUntil(ConditionHelpers
.treeItemHasChildren(treeItem
));
857 currentNode
.expand();
859 String nodeName
= nodeNames
[i
];
861 bot
.waitUntil(ConditionHelpers
.IsTreeChildNodeAvailable(nodeName
, currentNode
));
862 } catch (TimeoutException e
) {
863 //FIXME: Sometimes in a JFace TreeViewer, it expands to nothing. Need to find out why.
864 currentNode
.collapse();
865 currentNode
.expand();
866 bot
.waitUntil(ConditionHelpers
.IsTreeChildNodeAvailable(nodeName
, currentNode
));
869 SWTBotTreeItem newNode
= currentNode
.getNode(nodeName
);
870 currentNode
= newNode
;
877 * Press the keyboard shortcut that goes to the top of a tree widget. The
878 * key combination can differ on different platforms.
881 * the keyboard to use
883 public static void pressShortcutGoToTreeTop(Keyboard keyboard
) {
884 if (SWTUtils
.isMac()) {
885 keyboard
.pressShortcut(Keystrokes
.ALT
, Keystrokes
.UP
);
887 keyboard
.pressShortcut(Keystrokes
.HOME
);
892 * Get the active events editor. Note that this will wait until such editor
895 * @param workbenchBot
896 * a given workbench bot
897 * @return the active events editor
899 public static SWTBotEditor
activeEventsEditor(final SWTWorkbenchBot workbenchBot
) {
900 ConditionHelpers
.ActiveEventsEditor condition
= new ConditionHelpers
.ActiveEventsEditor(workbenchBot
, null);
901 workbenchBot
.waitUntil(condition
);
902 return condition
.getActiveEditor();
906 * Get the active events editor. Note that this will wait until such editor
909 * @param workbenchBot
910 * a given workbench bot
912 * the desired editor title. If null, any active events editor
913 * will be considered valid.
914 * @return the active events editor
916 public static SWTBotEditor
activeEventsEditor(final SWTWorkbenchBot workbenchBot
, String editorTitle
) {
917 ConditionHelpers
.ActiveEventsEditor condition
= new ConditionHelpers
.ActiveEventsEditor(workbenchBot
, editorTitle
);
918 workbenchBot
.waitUntil(condition
);
919 return condition
.getActiveEditor();
923 * Open the preferences dialog and return the corresponding shell.
926 * a given workbench bot
927 * @return the preferences shell
929 public static SWTBotShell
openPreferences(SWTBot bot
) {
930 if (SWTUtils
.isMac()) {
931 // On Mac, the Preferences menu item is under the application name.
932 // For some reason, we can't access the application menu anymore so
933 // we use the keyboard shortcut.
935 bot
.activeShell().pressShortcut(KeyStroke
.getInstance(IKeyLookup
.COMMAND_NAME
+ "+"), KeyStroke
.getInstance(","));
936 } catch (ParseException e
) {
940 bot
.menu(WINDOW_MENU
).menu(PREFERENCES_MENU_ITEM
).click();
943 bot
.waitUntil(Conditions
.shellIsActive(PREFERENCES_MENU_ITEM
));
944 return bot
.activeShell();