Commit | Line | Data |
---|---|---|
723a1d49 BH |
1 | /******************************************************************************* |
2 | * Copyright (c) 2016 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 | ||
10 | package org.eclipse.tracecompass.lttng2.kernel.ui.swtbot.tests; | |
11 | ||
12 | import static org.junit.Assert.assertEquals; | |
13 | import static org.junit.Assert.fail; | |
14 | ||
15 | import java.io.IOException; | |
16 | ||
17 | import org.eclipse.core.runtime.FileLocator; | |
18 | import org.eclipse.core.runtime.preferences.IEclipsePreferences; | |
19 | import org.eclipse.core.runtime.preferences.InstanceScope; | |
f149d124 | 20 | import org.eclipse.jdt.annotation.NonNull; |
723a1d49 BH |
21 | import org.eclipse.osgi.util.NLS; |
22 | import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotView; | |
23 | import org.eclipse.swtbot.swt.finder.SWTBot; | |
24 | import org.eclipse.swtbot.swt.finder.finders.UIThreadRunnable; | |
25 | import org.eclipse.swtbot.swt.finder.junit.SWTBotJunit4ClassRunner; | |
26 | import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell; | |
27 | import org.eclipse.swtbot.swt.finder.widgets.SWTBotToolbarButton; | |
28 | import org.eclipse.swtbot.swt.finder.widgets.SWTBotTree; | |
29 | import org.eclipse.swtbot.swt.finder.widgets.SWTBotTreeColumn; | |
30 | import org.eclipse.swtbot.swt.finder.widgets.SWTBotTreeItem; | |
31 | import org.eclipse.tracecompass.internal.tmf.core.Activator; | |
32 | import org.eclipse.tracecompass.testtraces.ctf.CtfTestTrace; | |
33 | import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimePreferencesConstants; | |
f149d124 | 34 | import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp; |
9bb4b61e | 35 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimePreferences; |
f149d124 MAL |
36 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimeRange; |
37 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp; | |
723a1d49 | 38 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampFormat; |
f149d124 | 39 | import org.eclipse.tracecompass.tmf.ui.swtbot.tests.shared.ConditionHelpers; |
723a1d49 BH |
40 | import org.eclipse.tracecompass.tmf.ui.swtbot.tests.shared.ConditionHelpers.SWTBotTestCondition; |
41 | import org.eclipse.tracecompass.tmf.ui.swtbot.tests.shared.SWTBotUtils; | |
f149d124 | 42 | import org.eclipse.tracecompass.tmf.ui.views.timegraph.AbstractTimeGraphView; |
723a1d49 BH |
43 | import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.widgets.Utils; |
44 | import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.widgets.Utils.Resolution; | |
45 | import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.widgets.Utils.TimeFormat; | |
46 | import org.junit.Before; | |
47 | import org.junit.Test; | |
48 | import org.junit.runner.RunWith; | |
49 | ||
50 | /** | |
51 | * SWTBot tests for column sorting in the Control Flow view. | |
52 | * | |
53 | * @author Bernd Hufmann | |
54 | */ | |
55 | @SuppressWarnings("restriction") | |
56 | @RunWith(SWTBotJunit4ClassRunner.class) | |
57 | public class ControlFlowViewSortingTest extends KernelTestBase { | |
58 | ||
59 | // ------------------------------------------------------------------------ | |
60 | // Constants | |
61 | // ------------------------------------------------------------------------ | |
62 | private static final String FILTER_ACTION = "Show View Filters"; | |
63 | private static final String FILTER_DIALOG_TITLE = "Filter"; | |
64 | private static final String UNCHECK_ALL = "Uncheck all"; | |
65 | private static final String CHECK_SUBTREE = "Check subtree"; | |
66 | private static final String OK_BUTTON = "OK"; | |
67 | ||
68 | private static final String PROCESS_COLUMN = "Process"; | |
69 | private static final int PROCESS_COLUMN_ID = 0; | |
70 | private static final String TID_COLUMN = "TID"; | |
71 | private static final int TID_COLUMN_ID = 1; | |
72 | private static final String PTID_COLUMN = "PTID"; | |
73 | private static final String BIRTH_COLUMN = "Birth time"; | |
74 | private static final int BIRTH_COLUMN_ID = 3; | |
75 | private static final String TRACE_COLUMN = "Trace"; | |
76 | ||
77 | private static final String SYSTEMD_PROCESS_NAME = "systemd"; | |
78 | private static final long SYSTEMD_BIRTHTIME = 1361214078967531336L; | |
79 | private static final String SYSTEMD_TID = "1"; | |
80 | ||
81 | private static final String KTHREAD_PROCESS_NAME = "kthreadd"; | |
82 | private static final long KTHREAD_BIRTHTIME = 1361214078967533536L; | |
83 | private static final String KTHREAD_TID = "2"; | |
84 | ||
85 | private static final String LTTNG_CONSUMER_PROCESS_NAME = "lttng-consumerd"; | |
86 | private static final long LTTNG_CONSUMER_BIRTHTIME = 1361214078963717040L; | |
87 | private static final String LTTNG_CONSUMER_TID = "4034"; | |
88 | ||
f149d124 MAL |
89 | private static final @NonNull TmfTimestamp TRACE_START_TIME = new TmfTimestamp(1361214078963711320L, ITmfTimestamp.NANOSECOND_SCALE); |
90 | ||
723a1d49 BH |
91 | // ------------------------------------------------------------------------ |
92 | // Attributes | |
93 | // ------------------------------------------------------------------------ | |
94 | ||
95 | private SWTBotView fViewBot; | |
96 | ||
97 | // ------------------------------------------------------------------------ | |
98 | // Housekeeping | |
99 | // ------------------------------------------------------------------------ | |
100 | /** | |
101 | * Before Test | |
102 | */ | |
103 | @Override | |
104 | @Before | |
105 | public void before() { | |
106 | ||
107 | try { | |
108 | IEclipsePreferences defaultPreferences = InstanceScope.INSTANCE.getNode(Activator.PLUGIN_ID); | |
109 | defaultPreferences.put(ITmfTimePreferencesConstants.TIME_ZONE, "GMT-05:00"); | |
110 | TmfTimestampFormat.updateDefaultFormats(); | |
111 | ||
112 | String tracePath = FileLocator.toFileURL(CtfTestTrace.SYNC_DEST.getTraceURL()).getPath(); | |
113 | SWTBotUtils.openTrace(TRACE_PROJECT_NAME, tracePath, KERNEL_TRACE_TYPE); | |
114 | fViewBot = fBot.viewByTitle("Control Flow"); | |
115 | fViewBot.show(); | |
116 | fViewBot.setFocus(); | |
117 | } catch (IOException e) { | |
118 | fail(); | |
119 | } | |
120 | } | |
121 | ||
122 | @Override | |
123 | public void after() { | |
124 | IEclipsePreferences defaultPreferences = InstanceScope.INSTANCE.getNode(Activator.PLUGIN_ID); | |
9bb4b61e | 125 | defaultPreferences.put(ITmfTimePreferencesConstants.TIME_ZONE, TmfTimePreferences.getDefaultPreferenceMap().get(ITmfTimePreferencesConstants.TIME_ZONE)); |
723a1d49 BH |
126 | TmfTimestampFormat.updateDefaultFormats(); |
127 | super.after(); | |
128 | } | |
129 | ||
130 | // ------------------------------------------------------------------------ | |
131 | // Test case(s) | |
132 | // ------------------------------------------------------------------------ | |
133 | /** | |
134 | * UI test of sorting of processes in CFV based on column selection. To verify that the sorting | |
135 | * was executed correctly, the test will use bot.waitUntil() the column content has the right | |
136 | * order. | |
137 | */ | |
138 | @Test | |
139 | public void testColumnSorting() { | |
f149d124 MAL |
140 | fBot.waitUntil(ConditionHelpers.timeGraphIsReadyCondition((AbstractTimeGraphView) fViewBot.getViewReference().getPart(false), new TmfTimeRange(TRACE_START_TIME, TRACE_START_TIME), TRACE_START_TIME)); |
141 | ||
723a1d49 BH |
142 | // Create a known state |
143 | applyFilter(); | |
144 | final SWTBotTree tree = fViewBot.bot().tree(); | |
145 | SWTBotTreeItem item = SWTBotUtils.getTreeItem(fBot, tree, SYSTEMD_PROCESS_NAME); | |
146 | item.select(); | |
147 | ||
148 | testProcessSorting(tree); | |
149 | testTidSorting(tree); | |
150 | testPidSorting(tree); | |
151 | testBirthtimeSorting(tree); | |
152 | testTraceSorting(tree); | |
153 | } | |
154 | ||
155 | // ------------------------------------------------------------------------ | |
156 | // Helpers | |
157 | // ------------------------------------------------------------------------ | |
158 | private void applyFilter() { | |
159 | // Select only certain root nodes and their children but filter out rest | |
160 | SWTBotToolbarButton filterButton = fViewBot.toolbarButton(FILTER_ACTION); | |
161 | filterButton.click(); | |
162 | SWTBotShell shell = fBot.shell(FILTER_DIALOG_TITLE).activate(); | |
163 | ||
164 | SWTBot bot = shell.bot(); | |
165 | SWTBotTree treeBot = bot.tree(); | |
166 | bot.button(UNCHECK_ALL).click(); | |
167 | ||
168 | TreeCheckedCounter treeCheckCounter = new TreeCheckedCounter(treeBot); | |
169 | Integer checked = UIThreadRunnable.syncExec(treeCheckCounter); | |
170 | assertEquals("default", 0, checked.intValue()); | |
171 | ||
172 | // select root nodes and their children | |
d1a3f3fb BH |
173 | checkFilterTreeItems(bot, treeBot, SYSTEMD_PROCESS_NAME); |
174 | checkFilterTreeItems(bot, treeBot, KTHREAD_PROCESS_NAME); | |
175 | checkFilterTreeItems(bot, treeBot, LTTNG_CONSUMER_PROCESS_NAME); | |
723a1d49 BH |
176 | |
177 | bot.button(OK_BUTTON).click(); | |
178 | } | |
179 | ||
d1a3f3fb | 180 | private static void checkFilterTreeItems(SWTBot bot, SWTBotTree treeBot, String process) { |
723a1d49 BH |
181 | SWTBotTreeItem item = SWTBotUtils.getTreeItem(bot, treeBot, process); |
182 | item.select(); | |
183 | bot.button(CHECK_SUBTREE).click(); | |
184 | TreeCheckedCounter treeCheckCounter = new TreeCheckedCounter(treeBot); | |
d1a3f3fb | 185 | UIThreadRunnable.syncExec(treeCheckCounter); |
723a1d49 BH |
186 | } |
187 | ||
188 | private static void testProcessSorting(final SWTBotTree tree) { | |
189 | SWTBotTreeColumn column = tree.header(PROCESS_COLUMN); | |
190 | String[] expected = { KTHREAD_PROCESS_NAME, LTTNG_CONSUMER_PROCESS_NAME, SYSTEMD_PROCESS_NAME }; | |
191 | ||
192 | /* Sort direction Up */ | |
193 | SWTBotTestCondition condition = getSortCondition(PROCESS_COLUMN, PROCESS_COLUMN_ID, expected, tree, false); | |
194 | clickColumn(tree, column, condition); | |
195 | ||
196 | /* Sort direction Down */ | |
197 | condition = getSortCondition(PROCESS_COLUMN, 0, expected, tree, true); | |
198 | clickColumn(tree, column, condition); | |
199 | } | |
200 | ||
201 | private static void testTidSorting(final SWTBotTree tree) { | |
202 | String[] expected = { SYSTEMD_TID, KTHREAD_TID, LTTNG_CONSUMER_TID }; | |
203 | SWTBotTreeColumn column = tree.header(TID_COLUMN); | |
204 | /* Sort direction Up */ | |
205 | SWTBotTestCondition condition = getSortCondition(TID_COLUMN, TID_COLUMN_ID, expected, tree, false); | |
206 | clickColumn(tree, column, condition); | |
207 | ||
208 | /* Sort direction Down */ | |
209 | condition = getSortCondition(TID_COLUMN, TID_COLUMN_ID, expected, tree, true); | |
210 | clickColumn(tree, column, condition); | |
211 | } | |
212 | ||
213 | /* | |
214 | * Note: In this test systemd and kthreadd have PTID 0 where | |
215 | * lttng-consumerd has PTID -1 that is unknown. Currently | |
216 | * in CFV PTID is only shown when it's greater than 0. | |
217 | */ | |
218 | private static void testPidSorting(final SWTBotTree tree) { | |
219 | SWTBotTreeColumn column = tree.header(PTID_COLUMN); | |
220 | String[] expected = { LTTNG_CONSUMER_PROCESS_NAME, SYSTEMD_PROCESS_NAME, KTHREAD_PROCESS_NAME }; | |
221 | /* Sort direction Up */ | |
222 | SWTBotTestCondition condition = getSortCondition(PTID_COLUMN, PROCESS_COLUMN_ID, expected, tree, false); | |
223 | clickColumn(tree, column, condition); | |
224 | ||
225 | /* Sort direction Down */ | |
226 | String[] expected2 = { SYSTEMD_PROCESS_NAME, KTHREAD_PROCESS_NAME, LTTNG_CONSUMER_PROCESS_NAME }; | |
227 | condition = getSortCondition(PTID_COLUMN, PROCESS_COLUMN_ID, expected2, tree, false); | |
228 | clickColumn(tree, column, condition); | |
229 | } | |
230 | ||
231 | private static void testBirthtimeSorting(final SWTBotTree tree) { | |
232 | SWTBotTreeColumn column = tree.header(BIRTH_COLUMN); | |
233 | String[] expected = { | |
234 | Utils.formatTime(LTTNG_CONSUMER_BIRTHTIME, TimeFormat.CALENDAR, Resolution.NANOSEC), | |
235 | Utils.formatTime(SYSTEMD_BIRTHTIME, TimeFormat.CALENDAR, Resolution.NANOSEC), | |
236 | Utils.formatTime(KTHREAD_BIRTHTIME, TimeFormat.CALENDAR, Resolution.NANOSEC) }; | |
237 | ||
238 | /* Sort direction Up */ | |
239 | SWTBotTestCondition condition = getSortCondition(BIRTH_COLUMN, BIRTH_COLUMN_ID, expected, tree, false); | |
240 | clickColumn(tree, column, condition); | |
241 | ||
242 | /* Sort direction Down */ | |
243 | condition = getSortCondition(BIRTH_COLUMN, BIRTH_COLUMN_ID, expected, tree, true); | |
244 | clickColumn(tree, column, condition); | |
245 | } | |
246 | ||
247 | /* | |
248 | * Note: In this test only one trace is visualized in CFV. | |
249 | * Sorting is done based on birth time (up direction). | |
250 | * The implementation in CFV won't change the order when changing | |
251 | * the direction. | |
252 | */ | |
253 | private static void testTraceSorting(final SWTBotTree tree) { | |
254 | SWTBotTreeColumn column = tree.header(TRACE_COLUMN); | |
255 | String[] expected = { LTTNG_CONSUMER_PROCESS_NAME, SYSTEMD_PROCESS_NAME, KTHREAD_PROCESS_NAME }; | |
256 | ||
257 | /* Sort direction Up */ | |
258 | SWTBotTestCondition condition = getSortCondition(TRACE_COLUMN, PROCESS_COLUMN_ID, expected, tree, false); | |
259 | clickColumn(tree, column, condition); | |
260 | ||
261 | /* Sort direction Down */ | |
262 | condition = getSortCondition(TRACE_COLUMN, PROCESS_COLUMN_ID, expected, tree, false); | |
263 | clickColumn(tree, column, condition); | |
264 | } | |
265 | ||
266 | private static void clickColumn(final SWTBotTree tree, SWTBotTreeColumn processColumn, SWTBotTestCondition condition) { | |
267 | processColumn.click(); | |
268 | fBot.waitUntil(condition); | |
269 | } | |
270 | ||
271 | private static SWTBotTestCondition getSortCondition(final String testCase, final int cell, final String[] expected, final SWTBotTree tree, final boolean reverse) { | |
272 | return new SWTBotTestCondition() { | |
273 | @Override | |
274 | public boolean test() throws Exception { | |
275 | SWTBotTreeItem[] items = tree.getAllItems(); | |
276 | if (reverse) { | |
277 | for (int i = expected.length - 1; i > 0; i--) { | |
278 | if (!expected[i].equals(items[expected.length - (i + 1)].cell(cell))) { | |
279 | return false; | |
280 | } | |
281 | } | |
282 | } else { | |
283 | for (int i = 0; i < expected.length; i++) { | |
284 | if (!expected[i].equals(items[i].cell(cell))) { | |
285 | return false; | |
286 | } | |
287 | } | |
288 | } | |
289 | return true; | |
290 | } | |
291 | @Override | |
292 | public String getFailureMessage() { | |
293 | return NLS.bind("Test Case: \'{0}\' failed!", testCase); | |
294 | } | |
295 | }; | |
296 | } | |
297 | ||
298 | } |