1 /*******************************************************************************
2 * Copyright (c) 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
.viewers
.events
;
15 import static org
.junit
.Assert
.assertEquals
;
16 import static org
.junit
.Assert
.assertNotNull
;
19 import java
.io
.IOException
;
20 import java
.util
.Arrays
;
22 import org
.apache
.log4j
.ConsoleAppender
;
23 import org
.apache
.log4j
.Logger
;
24 import org
.apache
.log4j
.SimpleLayout
;
25 import org
.eclipse
.swt
.SWT
;
26 import org
.eclipse
.swt
.custom
.SashForm
;
27 import org
.eclipse
.swt
.graphics
.Point
;
28 import org
.eclipse
.swt
.widgets
.Sash
;
29 import org
.eclipse
.swtbot
.eclipse
.finder
.SWTWorkbenchBot
;
30 import org
.eclipse
.swtbot
.eclipse
.finder
.widgets
.SWTBotView
;
31 import org
.eclipse
.swtbot
.swt
.finder
.finders
.UIThreadRunnable
;
32 import org
.eclipse
.swtbot
.swt
.finder
.junit
.SWTBotJunit4ClassRunner
;
33 import org
.eclipse
.swtbot
.swt
.finder
.results
.VoidResult
;
34 import org
.eclipse
.swtbot
.swt
.finder
.utils
.SWTBotPreferences
;
35 import org
.eclipse
.tracecompass
.tmf
.core
.io
.BufferedRandomAccessFile
;
36 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.wizards
.NewTmfProjectWizard
;
37 import org
.eclipse
.tracecompass
.tmf
.ui
.swtbot
.tests
.shared
.SWTBotSash
;
38 import org
.eclipse
.tracecompass
.tmf
.ui
.swtbot
.tests
.shared
.SWTBotUtils
;
39 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.callstack
.CallStackView
;
40 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.histogram
.HistogramView
;
41 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.timechart
.TimeChartView
;
42 import org
.eclipse
.ui
.IFolderLayout
;
43 import org
.eclipse
.ui
.IPageLayout
;
44 import org
.eclipse
.ui
.IPerspectiveFactory
;
45 import org
.hamcrest
.BaseMatcher
;
46 import org
.hamcrest
.Description
;
47 import org
.junit
.After
;
48 import org
.junit
.AfterClass
;
49 import org
.junit
.Before
;
50 import org
.junit
.BeforeClass
;
51 import org
.junit
.Test
;
52 import org
.junit
.runner
.RunWith
;
55 * Test common time axis for views
57 * @author Matthew Khouzam
59 @RunWith(SWTBotJunit4ClassRunner
.class)
60 public class TmfAlignTimeAxisTest
{
63 * wait for throttler (2x the throttler time)
65 private static final int SYNC_DELAY
= 1000;
66 private static final String TRACE_START
= "<trace>";
67 private static final String EVENT_BEGIN
= "<event timestamp=\"";
68 private static final String EVENT_MIDDLE
= " \" name=\"event\"><field name=\"field\" value=\"";
69 private static final String EVENT_END
= "\" type=\"int\" />" + "</event>";
70 private static final String TRACE_END
= "</trace>";
72 private static final String PROJET_NAME
= "TestAxisAlignment";
73 private static final int NUM_EVENTS
= 100;
75 * Using a small ratio for the editor so that other views have enough space
76 * to be drawn, even when a low screen resolution is used.
78 private static final float EDITOR_AREA_RATIO
= 0.10f
;
80 /** The Log4j logger instance. */
81 private static final Logger fLogger
= Logger
.getRootLogger();
82 private static SWTWorkbenchBot fBot
;
84 private static String
makeEvent(int ts
, int val
) {
85 return EVENT_BEGIN
+ Integer
.toString(ts
) + EVENT_MIDDLE
+ Integer
.toString(val
) + EVENT_END
+ "\n";
88 private static File fLocation
;
89 private static final BaseMatcher
<Sash
> SASH_MATCHER
= new SashMatcher();
92 * Initialization, creates a temp trace
98 public static void init() throws IOException
{
99 SWTBotUtils
.initialize();
100 Thread
.currentThread().setName("SWTBot Thread"); // for the debugger
101 /* set up for swtbot */
102 SWTBotPreferences
.TIMEOUT
= 20000; /* 20 second timeout */
103 fLogger
.removeAllAppenders();
104 fLogger
.addAppender(new ConsoleAppender(new SimpleLayout()));
105 SWTWorkbenchBot bot
= new SWTWorkbenchBot();
107 SWTBotUtils
.closeView("welcome", bot
);
109 SWTBotUtils
.switchToTracingPerspective();
110 /* finish waiting for eclipse to load */
111 SWTBotUtils
.waitForJobs();
112 fLocation
= File
.createTempFile("sample", ".xml");
113 try (BufferedRandomAccessFile braf
= new BufferedRandomAccessFile(fLocation
, "rw")) {
114 braf
.writeBytes(TRACE_START
);
115 for (int i
= 0; i
< NUM_EVENTS
; i
++) {
116 braf
.writeBytes(makeEvent(i
* 100, i
% 4));
118 braf
.writeBytes(TRACE_END
);
120 SWTBotUtils
.createProject(PROJET_NAME
);
121 SWTBotUtils
.selectTracesFolder(bot
, PROJET_NAME
);
128 public static void cleanup() {
129 SWTBotUtils
.deleteProject(PROJET_NAME
, new SWTWorkbenchBot());
131 fLogger
.removeAllAppenders();
138 public void before() {
139 SWTBotUtils
.openTrace(PROJET_NAME
, fLocation
.getAbsolutePath(), "org.eclipse.linuxtools.tmf.core.tests.xmlstub");
146 public void after() {
147 SWTWorkbenchBot bot
= new SWTWorkbenchBot();
148 SWTBotUtils
.activeEventsEditor(bot
).close();
152 * Test 3 views, none overlap, the histogram, the callstack and the
153 * timechart are aligned, the histogram is moved, callstack and timechart
157 public void testMoveHistogramCallstackFollows() {
158 fBot
= new SWTWorkbenchBot();
159 SWTBotUtils
.switchToPerspective(AlignPerspectiveFactory1
.ID
);
160 testOverlap(HistogramView
.ID
, CallStackView
.ID
);
164 * Test 3 views, none overlap, the histogram, the callstack and the
165 * timechart are aligned, the callstack is moved, histogram and timechart
169 public void testMoveCallstackHistogramFollows() {
170 fBot
= new SWTWorkbenchBot();
171 SWTBotUtils
.switchToPerspective(AlignPerspectiveFactory1
.ID
);
172 testOverlap(CallStackView
.ID
, HistogramView
.ID
);
176 * Test 3 views, overlap on the resizing view. The timechart and callstack
177 * are overlapping. Test that when the histogram moves, the timechart
178 * follows. Hidden views are not tested as their state does not matter until
182 public void testOverlappingHistogramMove() {
183 fBot
= new SWTWorkbenchBot();
184 SWTBotUtils
.switchToPerspective(AlignPerspectiveFactory2
.ID
);
185 testOverlap(HistogramView
.ID
, CallStackView
.ID
);
189 * Test 3 views, overlap on the resizing view. The timechart and callstack
190 * are overlapping. Test that when the timechart moves, the histogram
191 * follows. Hidden views are not tested as their state does not matter until
195 public void testOverlappingTimechartMove() {
196 fBot
= new SWTWorkbenchBot();
197 SWTBotUtils
.switchToPerspective(AlignPerspectiveFactory2
.ID
);
198 testOverlap(CallStackView
.ID
, HistogramView
.ID
);
202 * Test 3 views. No overlap. The callstack is not aligned with the
203 * histogram, the histogram is moved, we check that the callstack does NOT
207 public void testNotOverlappingHistogramMove() {
208 fBot
= new SWTWorkbenchBot();
209 testNonOverlap(HistogramView
.ID
, CallStackView
.ID
);
213 * Test 3 views. No overlap. The callstack is not aligned with the
214 * histogram, the callstack is moved, we check that the histogram does NOT
218 public void testNotOverlappingCallstackMove() {
219 fBot
= new SWTWorkbenchBot();
220 testNonOverlap(CallStackView
.ID
, HistogramView
.ID
);
223 private static void testNonOverlap(String vId1
, String vId2
) {
224 final int offset
= 100;
225 // switch to the proper perspective and wait for views to align
226 SWTBotUtils
.switchToPerspective(AlignPerspectiveFactory3
.ID
);
227 SWTBotUtils
.waitForJobs();
228 SWTBotUtils
.delay(SYNC_DELAY
);
230 SWTBotView masterView
= fBot
.viewById(vId1
);
231 SWTBotView slaveView
= fBot
.viewById(vId2
);
232 final Sash slaveSash
= slaveView
.bot().widget(SASH_MATCHER
, 0);
233 SWTBotSash slaveSashBot
= new SWTBotSash(slaveSash
, null);
234 Point before
= slaveSashBot
.getPoint();
235 // move master and wait for slaves to follow
236 drag(masterView
, offset
);
237 SWTBotUtils
.waitForJobs();
238 SWTBotUtils
.delay(SYNC_DELAY
);
239 // verify that the slave did not follow
240 assertEquals(before
, slaveSashBot
.getPoint());
241 // put everything back the way it was
242 drag(masterView
, -offset
);
243 SWTBotUtils
.delay(SYNC_DELAY
);
246 private static final class SashMatcher
extends BaseMatcher
<Sash
> {
248 public boolean matches(Object item
) {
249 return (item
instanceof Sash
);
253 public void describeTo(Description description
) {
257 private static final class SashFormMatcher
extends BaseMatcher
<SashForm
> {
259 public boolean matches(Object item
) {
260 return (item
instanceof SashForm
);
264 public void describeTo(Description description
) {
269 * Simulate a drag operation using "setWeights"
271 private static void drag(final SWTBotView view
, final int offset
) {
272 // this is the final sash form
273 final SashForm sashForm
= view
.bot().widget(new SashFormMatcher(), 0);
274 assertNotNull(sashForm
);
275 // resize widgets using sashform
276 UIThreadRunnable
.syncExec(new VoidResult() {
279 int[] originalWeights
= sashForm
.getWeights();
280 int[] newWeights
= Arrays
.copyOf(originalWeights
, originalWeights
.length
);
281 newWeights
[0] += offset
;
282 newWeights
[1] -= offset
;
283 sashForm
.setWeights(newWeights
);
284 sashForm
.getParent().layout();
287 // send update signals
288 UIThreadRunnable
.syncExec(new VoidResult() {
291 sashForm
.getChildren()[0].notifyListeners(SWT
.Resize
, null);
292 sashForm
.getChildren()[1].notifyListeners(SWT
.Resize
, null);
294 * This one is the most important, the previous two are added to
295 * be a good citizen, this event (selection) is the one that
296 * triggers an alignment
298 sashForm
.getChildren()[2].notifyListeners(SWT
.Selection
, null);
303 private static void testOverlap(String masterView
, String slaveView
) {
304 final int offset
= 100;
305 final int delta
= offset
/ 2;
306 // wait for the perspective switch to propagate alignments
307 SWTBotUtils
.waitForJobs();
308 SWTBotUtils
.delay(SYNC_DELAY
);
309 // select master and slave parts to observe
310 SWTBotView masterViewBot
= fBot
.viewById(masterView
);
311 final Sash masterSash
= masterViewBot
.bot().widget(SASH_MATCHER
, 0);
312 SWTBotSash masterSashBot
= new SWTBotSash(masterSash
, null);
314 SWTBotView slaveViewBot
= fBot
.viewById(slaveView
);
315 final Sash slaveSash
= slaveViewBot
.bot().widget(SASH_MATCHER
, 0);
316 SWTBotSash slaveSashBot
= new SWTBotSash(slaveSash
, null);
318 double masterOriginalSashX
= masterSashBot
.getPoint().x
;
319 // check that the views are already aligned
320 assertEquals("Approx align", masterOriginalSashX
, slaveSashBot
.getPoint().x
, delta
);
321 // move sash and wait for alignment
322 drag(masterViewBot
, offset
);
323 SWTBotUtils
.waitForJobs();
324 SWTBotUtils
.delay(SYNC_DELAY
);
326 double masterNewSashX
= masterSashBot
.getPoint().x
;
327 assertEquals("Approx align", masterNewSashX
, slaveSashBot
.getPoint().x
, delta
);
328 assertEquals(masterOriginalSashX
, masterNewSashX
- offset
, delta
);
329 // put things back the way they were
330 drag(masterViewBot
, -offset
);
331 SWTBotUtils
.delay(SYNC_DELAY
);
335 * Histogram, Callstack and timechart aligned but in different sites
337 public static class AlignPerspectiveFactory1
implements IPerspectiveFactory
{
339 /** The Perspective ID */
340 public static final String ID
= "org.eclipse.linuxtools.tmf.test.align.1"; //$NON-NLS-1$
343 public void createInitialLayout(IPageLayout layout
) {
344 if (layout
== null) {
349 layout
.setEditorAreaVisible(true);
352 layout
.setEditorAreaVisible(true);
354 // Create the top left folder
355 IFolderLayout topLeftFolder
= layout
.createFolder("topLeftFolder", IPageLayout
.LEFT
, 0.15f
, IPageLayout
.ID_EDITOR_AREA
); //$NON-NLS-1$
356 topLeftFolder
.addView(IPageLayout
.ID_PROJECT_EXPLORER
);
358 // Create the top right folder
359 IFolderLayout topRightFolder
= layout
.createFolder("topRightFolder", IPageLayout
.BOTTOM
, EDITOR_AREA_RATIO
, IPageLayout
.ID_EDITOR_AREA
); //$NON-NLS-1$
360 topRightFolder
.addView(HistogramView
.ID
);
362 // Create the middle right folder
363 IFolderLayout middleRightFolder
= layout
.createFolder("middleRightFolder", IPageLayout
.BOTTOM
, 0.50f
, "topRightFolder"); //$NON-NLS-1$
364 middleRightFolder
.addView(CallStackView
.ID
);
366 // Create the bottom right folder
367 IFolderLayout bottomRightFolder
= layout
.createFolder("bottomRightFolder", IPageLayout
.BOTTOM
, 0.65f
, "middleRightFolder"); //$NON-NLS-1$ //$NON-NLS-2$
368 bottomRightFolder
.addView(TimeChartView
.ID
);
370 // Populate menus, etc
371 layout
.addPerspectiveShortcut(ID
);
372 layout
.addNewWizardShortcut(NewTmfProjectWizard
.ID
);
378 * Timechart and Histogram share a site, all views aligned
380 public static class AlignPerspectiveFactory2
implements IPerspectiveFactory
{
382 /** The Perspective ID */
383 public static final String ID
= "org.eclipse.linuxtools.tmf.test.align.2"; //$NON-NLS-1$
386 public void createInitialLayout(IPageLayout layout
) {
387 if (layout
== null) {
392 layout
.setEditorAreaVisible(true);
395 layout
.setEditorAreaVisible(true);
397 // Create the top left folder
398 IFolderLayout topLeftFolder
= layout
.createFolder("topLeftFolder", IPageLayout
.LEFT
, 0.15f
, IPageLayout
.ID_EDITOR_AREA
); //$NON-NLS-1$
399 topLeftFolder
.addView(IPageLayout
.ID_PROJECT_EXPLORER
);
401 // Create the middle right folder
402 IFolderLayout middleRightFolder
= layout
.createFolder("middleRightFolder", IPageLayout
.BOTTOM
, EDITOR_AREA_RATIO
, IPageLayout
.ID_EDITOR_AREA
); //$NON-NLS-1$
403 middleRightFolder
.addView(HistogramView
.ID
);
404 middleRightFolder
.addView(TimeChartView
.ID
);
406 // Create the bottom right folder
407 IFolderLayout bottomRightFolder
= layout
.createFolder("bottomRightFolder", IPageLayout
.BOTTOM
, 0.65f
, "middleRightFolder"); //$NON-NLS-1$ //$NON-NLS-2$
408 bottomRightFolder
.addView(CallStackView
.ID
);
410 // Populate menus, etc
411 layout
.addPerspectiveShortcut(ID
);
412 layout
.addNewWizardShortcut(NewTmfProjectWizard
.ID
);
418 * Histogram and timechart aligned, callstack not aligned
420 public static class AlignPerspectiveFactory3
implements IPerspectiveFactory
{
422 /** The Perspective ID */
423 public static final String ID
= "org.eclipse.linuxtools.tmf.test.align.3"; //$NON-NLS-1$
426 public void createInitialLayout(IPageLayout layout
) {
427 if (layout
== null) {
432 layout
.setEditorAreaVisible(true);
435 layout
.setEditorAreaVisible(true);
437 // Create the top left folder
438 IFolderLayout topLeftFolder
= layout
.createFolder("topLeftFolder", IPageLayout
.LEFT
, 0.15f
, IPageLayout
.ID_EDITOR_AREA
); //$NON-NLS-1$
439 topLeftFolder
.addView(IPageLayout
.ID_PROJECT_EXPLORER
);
441 IFolderLayout bottomLeftFolder
= layout
.createFolder("bottomLeftFolder", IPageLayout
.BOTTOM
, 0.5f
, "topLeftFolder"); //$NON-NLS-1$
442 bottomLeftFolder
.addView(CallStackView
.ID
);
444 // Create the middle right folder
445 IFolderLayout middleRightFolder
= layout
.createFolder("middleRightFolder", IPageLayout
.BOTTOM
, EDITOR_AREA_RATIO
, IPageLayout
.ID_EDITOR_AREA
); //$NON-NLS-1$
446 middleRightFolder
.addView(HistogramView
.ID
);
448 // Create the bottom right folder
449 IFolderLayout bottomRightFolder
= layout
.createFolder("bottomRightFolder", IPageLayout
.BOTTOM
, 0.65f
, "middleRightFolder"); //$NON-NLS-1$ //$NON-NLS-2$
450 bottomRightFolder
.addView(TimeChartView
.ID
);
452 // Populate menus, etc
453 layout
.addPerspectiveShortcut(ID
);
454 layout
.addNewWizardShortcut(NewTmfProjectWizard
.ID
);