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
.pcap
.ui
.swtbot
.tests
;
15 import static org
.junit
.Assert
.assertFalse
;
16 import static org
.junit
.Assert
.assertNotNull
;
17 import static org
.junit
.Assert
.fail
;
18 import static org
.junit
.Assume
.assumeTrue
;
21 import java
.util
.ArrayList
;
22 import java
.util
.Arrays
;
23 import java
.util
.List
;
25 import org
.apache
.log4j
.ConsoleAppender
;
26 import org
.apache
.log4j
.Logger
;
27 import org
.apache
.log4j
.SimpleLayout
;
28 import org
.eclipse
.core
.resources
.IProject
;
29 import org
.eclipse
.core
.resources
.ResourcesPlugin
;
30 import org
.eclipse
.core
.runtime
.CoreException
;
31 import org
.eclipse
.jface
.viewers
.SelectionChangedEvent
;
32 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
33 import org
.eclipse
.swtbot
.eclipse
.finder
.SWTWorkbenchBot
;
34 import org
.eclipse
.swtbot
.eclipse
.finder
.widgets
.SWTBotView
;
35 import org
.eclipse
.swtbot
.swt
.finder
.finders
.UIThreadRunnable
;
36 import org
.eclipse
.swtbot
.swt
.finder
.junit
.SWTBotJunit4ClassRunner
;
37 import org
.eclipse
.swtbot
.swt
.finder
.results
.BoolResult
;
38 import org
.eclipse
.swtbot
.swt
.finder
.results
.VoidResult
;
39 import org
.eclipse
.swtbot
.swt
.finder
.utils
.SWTBotPreferences
;
40 import org
.eclipse
.swtbot
.swt
.finder
.widgets
.SWTBotTree
;
41 import org
.eclipse
.tracecompass
.internal
.tmf
.pcap
.core
.trace
.PcapTrace
;
42 import org
.eclipse
.tracecompass
.internal
.tmf
.pcap
.ui
.NetworkingPerspectiveFactory
;
43 import org
.eclipse
.tracecompass
.internal
.tmf
.pcap
.ui
.stream
.StreamListView
;
44 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
45 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTimeSynchSignal
;
46 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfContext
;
47 import org
.eclipse
.tracecompass
.tmf
.pcap
.core
.tests
.shared
.PcapTmfTestTrace
;
48 import org
.eclipse
.tracecompass
.tmf
.ui
.editors
.TmfEventsEditor
;
49 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfOpenTraceHelper
;
50 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfProjectRegistry
;
51 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfTraceFolder
;
52 import org
.eclipse
.tracecompass
.tmf
.ui
.swtbot
.tests
.shared
.ConditionHelpers
;
53 import org
.eclipse
.tracecompass
.tmf
.ui
.swtbot
.tests
.shared
.SWTBotUtils
;
54 import org
.eclipse
.ui
.IEditorPart
;
55 import org
.eclipse
.ui
.IEditorReference
;
56 import org
.eclipse
.ui
.IViewPart
;
57 import org
.eclipse
.ui
.IViewReference
;
58 import org
.eclipse
.ui
.PlatformUI
;
59 import org
.eclipse
.ui
.WorkbenchException
;
60 import org
.junit
.AfterClass
;
61 import org
.junit
.BeforeClass
;
62 import org
.junit
.Test
;
63 import org
.junit
.runner
.RunWith
;
66 * SWTBot Smoke test for Pcap UI.
68 * @author Matthew Khouzam
70 @RunWith(SWTBotJunit4ClassRunner
.class)
71 public class ImportAndReadPcapTest
{
73 private static final String NETWORK_PERSPECTIVE_ID
= NetworkingPerspectiveFactory
.ID
;
74 private static final String TRACE_PROJECT_NAME
= "test";
76 private static SWTWorkbenchBot fBot
;
77 private ITmfEvent fDesired1
;
78 private static PcapTmfTestTrace pttt
= PcapTmfTestTrace
.BENCHMARK_TRACE
;
80 /** The Log4j logger instance. */
81 private static final Logger fLogger
= Logger
.getRootLogger();
87 public static void init() {
89 SWTBotUtils
.failIfUIThread();
91 /* set up for swtbot */
92 SWTBotPreferences
.TIMEOUT
= 300000; /* 300 second timeout */
93 fLogger
.removeAllAppenders();
94 fLogger
.addAppender(new ConsoleAppender(new SimpleLayout(), ConsoleAppender
.SYSTEM_OUT
));
95 fBot
= new SWTWorkbenchBot();
97 final List
<SWTBotView
> openViews
= fBot
.views();
98 for (SWTBotView view
: openViews
) {
99 if (view
.getTitle().equals("Welcome")) {
101 fBot
.waitUntil(ConditionHelpers
.ViewIsClosed(view
));
104 /* Switch perspectives */
105 switchNetworkPerspective();
106 /* Finish waiting for eclipse to load */
107 SWTBotUtils
.waitForJobs();
111 * Test Class teardown
114 public static void terminate() {
115 fLogger
.removeAllAppenders();
118 private static void switchNetworkPerspective() {
119 final Exception retE
[] = new Exception
[1];
120 if (!UIThreadRunnable
.syncExec(new BoolResult() {
122 public Boolean
run() {
124 PlatformUI
.getWorkbench().showPerspective(NETWORK_PERSPECTIVE_ID
,
125 PlatformUI
.getWorkbench().getActiveWorkbenchWindow());
126 } catch (WorkbenchException e
) {
133 fail(retE
[0].getMessage());
143 assumeTrue(pttt
.exists());
144 SWTBotUtils
.createProject(TRACE_PROJECT_NAME
);
147 testHV(getViewPart("Histogram"));
148 testStreamView(getViewPartRef("Stream List"));
149 fBot
.closeAllEditors();
150 SWTBotUtils
.deleteProject(TRACE_PROJECT_NAME
, fBot
);
153 private void testStreamView(IViewReference viewPart
) {
154 SWTBotView botView
= new SWTBotView(viewPart
, fBot
);
155 StreamListView slv
= (StreamListView
) getViewPart("Stream List");
157 SWTBotTree botTree
= fBot
.tree();
158 assertNotNull(botTree
);
159 final TmfTimeSynchSignal signal
= new TmfTimeSynchSignal(slv
, fDesired1
.getTimestamp());
160 slv
.broadcast(signal
);
161 SWTBotUtils
.waitForJobs();
162 // FIXME This is a race condition:
163 // TmfEventsTable launches an async exec that may be run after the wait
164 // for jobs. This last delay catches it.
165 SWTBotUtils
.delay(1000);
169 private static void openTrace() {
170 final Exception exception
[] = new Exception
[1];
172 UIThreadRunnable
.syncExec(new VoidResult() {
176 IProject project
= ResourcesPlugin
.getWorkspace().getRoot().getProject(TRACE_PROJECT_NAME
);
177 TmfTraceFolder destinationFolder
= TmfProjectRegistry
.getProject(project
, true).getTracesFolder();
178 String absolutePath
= (new File(pttt
.getTrace().getPath())).getAbsolutePath();
179 TmfOpenTraceHelper
.openTraceFromPath(destinationFolder
, absolutePath
, PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell(), "org.eclipse.linuxtools.tmf.pcap.core.pcaptrace");
180 } catch (CoreException e
) {
185 if (exception
[0] != null) {
186 fail(exception
[0].getMessage());
189 SWTBotUtils
.delay(1000);
190 SWTBotUtils
.waitForJobs();
193 private void openEditor() {
194 final List
<IEditorReference
> editorRefs
= new ArrayList
<>();
195 UIThreadRunnable
.syncExec(new VoidResult() {
198 IEditorReference
[] ieds
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage().getEditorReferences();
199 editorRefs
.addAll(Arrays
.asList(ieds
));
203 assertFalse(editorRefs
.isEmpty());
204 IEditorPart iep
= null;
205 for (IEditorReference ied
: editorRefs
) {
206 if (ied
.getTitle().equals(pttt
.getTrace().getName())) {
207 iep
= ied
.getEditor(true);
212 fDesired1
= getEvent(100);
213 final TmfEventsEditor tmfEd
= (TmfEventsEditor
) iep
;
214 UIThreadRunnable
.syncExec(new VoidResult() {
218 tmfEd
.selectionChanged(new SelectionChangedEvent(tmfEd
, new StructuredSelection(fDesired1
)));
222 SWTBotUtils
.waitForJobs();
223 SWTBotUtils
.delay(1000);
224 assertNotNull(tmfEd
);
227 private static void testHV(IViewPart vp
) {
231 private static ITmfEvent
getEvent(int rank
) {
232 try (PcapTrace trace
= pttt
.getTrace()) {
233 ITmfContext ctx
= trace
.seekEvent(0);
234 for (int i
= 0; i
< rank
; i
++) {
237 return trace
.getNext(ctx
);
242 private static IViewPart
getViewPart(final String viewTile
) {
243 final IViewPart
[] vps
= new IViewPart
[1];
244 UIThreadRunnable
.syncExec(new VoidResult() {
247 IViewReference
[] viewRefs
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage().getViewReferences();
248 for (IViewReference viewRef
: viewRefs
) {
249 IViewPart vp
= viewRef
.getView(true);
250 if (vp
.getTitle().equals(viewTile
)) {
261 private static IViewReference
getViewPartRef(final String viewTile
) {
262 final IViewReference
[] vrs
= new IViewReference
[1];
263 UIThreadRunnable
.syncExec(new VoidResult() {
266 IViewReference
[] viewRefs
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage().getViewReferences();
267 for (IViewReference viewRef
: viewRefs
) {
268 IViewPart vp
= viewRef
.getView(true);
269 if (vp
.getTitle().equals(viewTile
)) {