1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
/*******************************************************************************
* Copyright (c) 2013, 2014 École Polytechnique de Montréal
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Geneviève Bastien - Initial API and implementation
* Mathieu Rail - Added tests for getting a module's requirements
*******************************************************************************/
package org.eclipse.tracecompass.tmf.core.tests.analysis;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.util.Set;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModule;
import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModuleHelper;
import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisManager;
import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisModuleHelperConfigElement;
import org.eclipse.tracecompass.tmf.core.analysis.requirements.TmfAnalysisRequirement;
import org.eclipse.tracecompass.tmf.core.exceptions.TmfAnalysisException;
import org.eclipse.tracecompass.tmf.core.tests.shared.TmfTestTrace;
import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
import org.eclipse.tracecompass.tmf.core.trace.TmfTrace;
import org.eclipse.tracecompass.tmf.core.trace.experiment.TmfExperiment;
import org.eclipse.tracecompass.tmf.tests.stubs.analysis.AnalysisRequirementFactory;
import org.eclipse.tracecompass.tmf.tests.stubs.analysis.TestAnalysis;
import org.eclipse.tracecompass.tmf.tests.stubs.analysis.TestAnalysis2;
import org.eclipse.tracecompass.tmf.tests.stubs.trace.TmfTraceStub;
import org.eclipse.tracecompass.tmf.tests.stubs.trace.TmfTraceStub2;
import org.eclipse.tracecompass.tmf.tests.stubs.trace.TmfTraceStub3;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.osgi.framework.Bundle;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
/**
* Test suite for the {@link TmfAnalysisModuleHelperConfigElement} class
*
* @author Geneviève Bastien
*/
public class AnalysisModuleHelperTest {
private IAnalysisModuleHelper fModule;
private IAnalysisModuleHelper fModuleOther;
private IAnalysisModuleHelper fReqModule;
private ITmfTrace fTrace;
private static IAnalysisModuleHelper getModuleHelper(@NonNull String moduleId) {
Multimap<String, IAnalysisModuleHelper> helpers = TmfAnalysisManager.getAnalysisModules();
assertEquals(1, helpers.get(moduleId).size());
return helpers.get(moduleId).iterator().next();
}
/**
* Gets the module helpers for 2 test modules
*/
@Before
public void getModules() {
fModule = getModuleHelper(AnalysisManagerTest.MODULE_PARAM);
assertNotNull(fModule);
assertTrue(fModule instanceof TmfAnalysisModuleHelperConfigElement);
fModuleOther = getModuleHelper(AnalysisManagerTest.MODULE_SECOND);
assertNotNull(fModuleOther);
assertTrue(fModuleOther instanceof TmfAnalysisModuleHelperConfigElement);
fReqModule = getModuleHelper(AnalysisManagerTest.MODULE_REQ);
assertNotNull(fReqModule);
assertTrue(fReqModule instanceof TmfAnalysisModuleHelperConfigElement);
fTrace = TmfTestTrace.A_TEST_10K2.getTraceAsStub2();
}
/**
* Some tests use traces, let's clean them here
*/
@After
public void cleanupTraces() {
TmfTestTrace.A_TEST_10K.dispose();
fTrace.dispose();
}
/**
* Test the helper's getters and setters
*/
@Test
public void testHelperGetters() {
/* With first module */
assertEquals(AnalysisManagerTest.MODULE_PARAM, fModule.getId());
assertEquals("Test analysis", fModule.getName());
assertFalse(fModule.isAutomatic());
Bundle helperbundle = fModule.getBundle();
Bundle thisbundle = Platform.getBundle("org.eclipse.tracecompass.tmf.core.tests");
assertNotNull(helperbundle);
assertEquals(thisbundle, helperbundle);
/* With other module */
assertEquals(AnalysisManagerTest.MODULE_SECOND, fModuleOther.getId());
assertEquals("Test other analysis", fModuleOther.getName());
assertTrue(fModuleOther.isAutomatic());
}
/**
* Test the
* {@link TmfAnalysisModuleHelperConfigElement#appliesToTraceType(Class)}
* method for the 2 modules
*/
@Test
public void testAppliesToTrace() {
/* stub module */
assertFalse(fModule.appliesToTraceType(TmfTrace.class));
assertTrue(fModule.appliesToTraceType(TmfTraceStub.class));
assertTrue(fModule.appliesToTraceType(TmfTraceStub2.class));
assertFalse(fModule.appliesToTraceType(TmfTraceStub3.class));
assertFalse(fModule.appliesToTraceType(TmfExperiment.class));
/* stub module 2 */
assertFalse(fModuleOther.appliesToTraceType(TmfTrace.class));
assertFalse(fModuleOther.appliesToTraceType(TmfTraceStub.class));
assertTrue(fModuleOther.appliesToTraceType(TmfTraceStub2.class));
assertTrue(fModuleOther.appliesToTraceType(TmfTraceStub3.class));
assertFalse(fModuleOther.appliesToTraceType(TmfExperiment.class));
}
/**
* Test the
* {@link TmfAnalysisModuleHelperConfigElement#newModule(ITmfTrace)} method
* for the 2 modules
*/
@Test
public void testNewModule() {
/* Test analysis module with traceStub */
IAnalysisModule module = null;
try {
module = fModule.newModule(TmfTestTrace.A_TEST_10K.getTrace());
assertNotNull(module);
assertTrue(module instanceof TestAnalysis);
} catch (TmfAnalysisException e) {
fail();
} finally {
if (module != null) {
module.dispose();
}
}
/* TestAnalysis2 module with trace, should return an exception */
try {
module = fModuleOther.newModule(TmfTestTrace.A_TEST_10K.getTrace());
assertNull(module);
} catch (TmfAnalysisException e) {
fail();
} finally {
if (module != null) {
module.dispose();
}
}
/* TestAnalysis2 module with a TraceStub2 */
ITmfTrace trace = fTrace;
assertNotNull(trace);
try {
module = fModuleOther.newModule(trace);
assertNotNull(module);
assertTrue(module instanceof TestAnalysis2);
} catch (TmfAnalysisException e) {
fail();
} finally {
if (module != null) {
module.dispose();
}
}
}
/**
* Test the analysis modules with a differing result for experiments
*/
@Test
public void testAppliesToExperiment() {
ITmfTrace trace1 = TmfTestTrace.A_TEST_10K.getTrace();
ITmfTrace trace2 = TmfTestTrace.A_TEST_10K2.getTrace();
ITmfTrace trace3 = TmfTestTrace.A_TEST_10K2.getTraceAsStub2();
/* Create an experiment with TmfTraceStub */
ITmfTrace[] tracesExp1 = { trace1, trace2 };
TmfExperiment exp1 = new TmfExperiment(tracesExp1[0].getEventType(), "Experiment 1", tracesExp1, TmfExperiment.DEFAULT_INDEX_PAGE_SIZE, null);
/* Create an experiment containing some TmfTraceStub2 */
ITmfTrace[] tracesExp2 = { trace1, trace3 };
TmfExperiment exp2 = new TmfExperiment(tracesExp2[0].getEventType(), "Experiment 1", tracesExp2, TmfExperiment.DEFAULT_INDEX_PAGE_SIZE, null);
try {
/* fModule should return null for both experiments */
IAnalysisModule module = null;
try {
module = fModule.newModule(exp1);
assertNull(module);
} catch (TmfAnalysisException e) {
fail();
} finally {
if (module != null) {
module.dispose();
}
}
try {
module = fModule.newModule(exp2);
assertNull(module);
} catch (TmfAnalysisException e) {
fail();
} finally {
if (module != null) {
module.dispose();
}
}
/* fModuleOther should throw exception for exp1, but not exp2 */
try {
module = fModuleOther.newModule(exp1);
assertNull(module);
} catch (TmfAnalysisException e) {
fail();
} finally {
if (module != null) {
module.dispose();
}
}
try {
module = fModuleOther.newModule(exp2);
assertNotNull(module);
} catch (TmfAnalysisException e) {
fail();
} finally {
if (module != null) {
module.dispose();
}
}
} finally {
exp2.dispose();
exp1.dispose();
}
}
/**
* Test for the initialization of parameters from the extension points
*/
@Test
public void testParameters() {
ITmfTrace trace = TmfTestTrace.A_TEST_10K.getTrace();
/*
* This analysis has a parameter, but no default value. we should be
* able to set the parameter
*/
IAnalysisModuleHelper helper = getModuleHelper(AnalysisManagerTest.MODULE_PARAM);
assertNotNull(helper);
IAnalysisModule module = null;
try {
module = helper.newModule(trace);
assertNotNull(module);
assertNull(module.getParameter(TestAnalysis.PARAM_TEST));
module.setParameter(TestAnalysis.PARAM_TEST, 1);
assertEquals(1, module.getParameter(TestAnalysis.PARAM_TEST));
} catch (TmfAnalysisException e1) {
fail(e1.getMessage());
return;
} finally {
if (module != null) {
module.dispose();
}
}
/* This module has a parameter with default value */
helper = getModuleHelper(AnalysisManagerTest.MODULE_PARAM_DEFAULT);
assertNotNull(helper);
try {
module = helper.newModule(trace);
assertNotNull(module);
assertEquals(3, module.getParameter(TestAnalysis.PARAM_TEST));
module.setParameter(TestAnalysis.PARAM_TEST, 1);
assertEquals(1, module.getParameter(TestAnalysis.PARAM_TEST));
} catch (TmfAnalysisException e1) {
fail(e1.getMessage());
return;
} finally {
if (module != null) {
module.dispose();
}
}
/*
* This module does not have a parameter so setting it should throw an
* error
*/
helper = getModuleHelper(AnalysisManagerTest.MODULE_SECOND);
assertNotNull(helper);
Exception exception = null;
trace = fTrace;
assertNotNull(trace);
try {
module = helper.newModule(trace);
assertNotNull(module);
assertNull(module.getParameter(TestAnalysis.PARAM_TEST));
try {
module.setParameter(TestAnalysis.PARAM_TEST, 1);
} catch (RuntimeException e) {
exception = e;
}
} catch (TmfAnalysisException e1) {
fail(e1.getMessage());
return;
} finally {
if (module != null) {
module.dispose();
}
}
assertNotNull(exception);
}
/**
* Test for the
* {@link TmfAnalysisModuleHelperConfigElement#getValidTraceTypes} method
*/
@Test
public void testGetValidTraceTypes() {
Set<Class<? extends ITmfTrace>> expected = ImmutableSet.of((Class<? extends ITmfTrace>) TmfTraceStub.class, TmfTraceStub2.class, TmfTraceStub3.class);
Iterable<Class<? extends ITmfTrace>> traceTypes = fReqModule.getValidTraceTypes();
assertEquals(expected, traceTypes);
}
/**
* Test for the
* {@link TmfAnalysisModuleHelperConfigElement#getAnalysisRequirements}
* method
*/
@Test
public void testGetRequirements() {
Iterable<TmfAnalysisRequirement> requirements = fReqModule.getAnalysisRequirements();
Set<TmfAnalysisRequirement> expected = ImmutableSet.of(
AnalysisRequirementFactory.REQUIREMENT_1,
AnalysisRequirementFactory.REQUIREMENT_3);
assertEquals(expected, requirements);
}
}
|
