| 1 | /******************************************************************************* |
| 2 | * Copyright (c) 2009, 2014 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 | * Contributors: |
| 10 | * Francois Chouinard - Initial API and implementation |
| 11 | * Alexandre Montplaisir - Port to JUnit4 |
| 12 | *******************************************************************************/ |
| 13 | |
| 14 | package org.eclipse.tracecompass.tmf.core.tests.component; |
| 15 | |
| 16 | import static org.junit.Assert.assertEquals; |
| 17 | import static org.junit.Assert.assertFalse; |
| 18 | import static org.junit.Assert.assertTrue; |
| 19 | import static org.junit.Assert.fail; |
| 20 | |
| 21 | import java.io.IOException; |
| 22 | import java.util.Vector; |
| 23 | |
| 24 | import org.eclipse.tracecompass.internal.tmf.core.component.TmfProviderManager; |
| 25 | import org.eclipse.tracecompass.tmf.core.component.ITmfEventProvider; |
| 26 | import org.eclipse.tracecompass.tmf.core.event.ITmfEvent; |
| 27 | import org.eclipse.tracecompass.tmf.core.request.TmfEventRequest; |
| 28 | import org.eclipse.tracecompass.tmf.core.request.ITmfEventRequest.ExecutionType; |
| 29 | import org.eclipse.tracecompass.tmf.core.signal.TmfEndSynchSignal; |
| 30 | import org.eclipse.tracecompass.tmf.core.signal.TmfStartSynchSignal; |
| 31 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimeRange; |
| 32 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp; |
| 33 | import org.eclipse.tracecompass.tmf.tests.stubs.component.TmfEventProviderStub; |
| 34 | import org.eclipse.tracecompass.tmf.tests.stubs.component.TmfSyntheticEventProviderStub; |
| 35 | import org.eclipse.tracecompass.tmf.tests.stubs.event.TmfSyntheticEventStub; |
| 36 | import org.eclipse.tracecompass.tmf.tests.stubs.trace.TmfTraceStub; |
| 37 | import org.junit.After; |
| 38 | import org.junit.Before; |
| 39 | import org.junit.Test; |
| 40 | |
| 41 | /** |
| 42 | * Test suite for the TmfEventProvider class. |
| 43 | */ |
| 44 | public class TmfEventProviderTest { |
| 45 | |
| 46 | private TmfEventProviderStub fEventProvider; |
| 47 | private TmfSyntheticEventProviderStub fSyntheticEventProvider; |
| 48 | |
| 49 | /** |
| 50 | * Initialization |
| 51 | * |
| 52 | * @throws IOException |
| 53 | * If we can't find the test trace (they are committed in the |
| 54 | * tree, so it shouldn't happen). |
| 55 | */ |
| 56 | @Before |
| 57 | public void setUp() throws IOException { |
| 58 | fEventProvider = new TmfEventProviderStub(); |
| 59 | fSyntheticEventProvider = new TmfSyntheticEventProviderStub(); |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * Clean-up |
| 64 | */ |
| 65 | @After |
| 66 | public void tearDown() { |
| 67 | fEventProvider.dispose(); |
| 68 | fSyntheticEventProvider.dispose(); |
| 69 | } |
| 70 | |
| 71 | // ------------------------------------------------------------------------ |
| 72 | // getProviders (more a sanity check than a test) |
| 73 | // ------------------------------------------------------------------------ |
| 74 | |
| 75 | /** |
| 76 | * Test getProviders |
| 77 | */ |
| 78 | @Test |
| 79 | public void testGetProviders() { |
| 80 | // There should be 2 TmfEvent providers: a TmfTraceStub and a |
| 81 | // TmfEventProviderStub |
| 82 | ITmfEventProvider[] eventProviders = TmfProviderManager.getProviders(ITmfEvent.class); |
| 83 | assertEquals("getProviders", 2, eventProviders.length); |
| 84 | |
| 85 | eventProviders = TmfProviderManager.getProviders(ITmfEvent.class, TmfTraceStub.class); |
| 86 | assertEquals("getProviders", 1, eventProviders.length); |
| 87 | |
| 88 | eventProviders = TmfProviderManager.getProviders(ITmfEvent.class, TmfEventProviderStub.class); |
| 89 | assertEquals("getProviders", 1, eventProviders.length); |
| 90 | |
| 91 | // There should be 1 TmfSyntheticEventStub provider |
| 92 | eventProviders = TmfProviderManager.getProviders(TmfSyntheticEventStub.class); |
| 93 | assertEquals("getProviders", 1, eventProviders.length); |
| 94 | } |
| 95 | |
| 96 | // ------------------------------------------------------------------------ |
| 97 | // getSyntheticEvent |
| 98 | // ------------------------------------------------------------------------ |
| 99 | |
| 100 | /** |
| 101 | * Test getPlainEvents |
| 102 | */ |
| 103 | @Test |
| 104 | public void testGetPlainEvents() { |
| 105 | final int NB_EVENTS = 1000; |
| 106 | final Vector<ITmfEvent> requestedEvents = new Vector<>(); |
| 107 | |
| 108 | // Get the TmfSyntheticEventStub provider |
| 109 | ITmfEventProvider[] eventProviders = TmfProviderManager.getProviders(ITmfEvent.class, |
| 110 | TmfEventProviderStub.class); |
| 111 | ITmfEventProvider provider = eventProviders[0]; |
| 112 | |
| 113 | TmfTimeRange range = new TmfTimeRange(TmfTimestamp.BIG_BANG, TmfTimestamp.BIG_CRUNCH); |
| 114 | final TmfEventRequest request = new TmfEventRequest(ITmfEvent.class, |
| 115 | range, 0, NB_EVENTS, ExecutionType.FOREGROUND) { |
| 116 | @Override |
| 117 | public void handleData(ITmfEvent event) { |
| 118 | super.handleData(event); |
| 119 | requestedEvents.add(event); |
| 120 | } |
| 121 | }; |
| 122 | |
| 123 | provider.sendRequest(request); |
| 124 | try { |
| 125 | request.waitForCompletion(); |
| 126 | assertEquals("nbEvents", NB_EVENTS, requestedEvents.size()); |
| 127 | assertTrue("isCompleted", request.isCompleted()); |
| 128 | assertFalse("isCancelled", request.isCancelled()); |
| 129 | |
| 130 | // Make that we have distinct events. |
| 131 | // Don't go overboard: we are not validating the stub! |
| 132 | for (int i = 0; i < NB_EVENTS; i++) { |
| 133 | assertEquals("Distinct events", i + 1, requestedEvents.get(i).getTimestamp().getValue()); |
| 134 | } |
| 135 | } catch (InterruptedException e) { |
| 136 | fail(); |
| 137 | } |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Test canceling requests. |
| 142 | */ |
| 143 | @Test |
| 144 | public void testCancelRequests() { |
| 145 | final int NB_EVENTS = 1000; |
| 146 | final int NUMBER_EVENTS_BEFORE_CANCEL_REQ1 = 10; |
| 147 | final int NUMBER_EVENTS_BEFORE_CANCEL_REQ2 = 800; |
| 148 | |
| 149 | final Vector<ITmfEvent> requestedEventsReq1 = new Vector<>(); |
| 150 | final Vector<ITmfEvent> requestedEventsReq2 = new Vector<>(); |
| 151 | |
| 152 | // Get the TmfSyntheticEventStub provider |
| 153 | ITmfEventProvider[] eventProviders = TmfProviderManager.getProviders(ITmfEvent.class, |
| 154 | TmfEventProviderStub.class); |
| 155 | ITmfEventProvider provider = eventProviders[0]; |
| 156 | |
| 157 | TmfTimeRange range = new TmfTimeRange(TmfTimestamp.BIG_BANG, TmfTimestamp.BIG_CRUNCH); |
| 158 | |
| 159 | // Create first request |
| 160 | final TmfEventRequest request1 = new TmfEventRequest(ITmfEvent.class, |
| 161 | range, 0, NB_EVENTS, ExecutionType.FOREGROUND) { |
| 162 | @Override |
| 163 | public void handleData(ITmfEvent event) { |
| 164 | super.handleData(event); |
| 165 | requestedEventsReq1.add(event); |
| 166 | |
| 167 | // cancel sub request |
| 168 | if (getNbRead() == NUMBER_EVENTS_BEFORE_CANCEL_REQ1) { |
| 169 | cancel(); |
| 170 | } |
| 171 | } |
| 172 | }; |
| 173 | |
| 174 | // Synchronize requests |
| 175 | ((TmfEventProviderStub) provider).startSynch(new TmfStartSynchSignal(0)); |
| 176 | |
| 177 | // Additionally, notify provider for up-coming requests |
| 178 | provider.notifyPendingRequest(true); |
| 179 | |
| 180 | // Call sendRequest, which will create a coalescing request, but it |
| 181 | // doesn't send request1 yet |
| 182 | provider.sendRequest(request1); |
| 183 | |
| 184 | // Check if request1 is not running yet. |
| 185 | assertFalse("isRunning", request1.isRunning()); |
| 186 | |
| 187 | // Create second request |
| 188 | final TmfEventRequest request2 = new TmfEventRequest(ITmfEvent.class, |
| 189 | range, 0, NB_EVENTS, ExecutionType.FOREGROUND) { |
| 190 | @Override |
| 191 | public void handleData(ITmfEvent event) { |
| 192 | super.handleData(event); |
| 193 | requestedEventsReq2.add(event); |
| 194 | |
| 195 | // cancel sub request which will cancel also main request |
| 196 | if (getNbRead() == NUMBER_EVENTS_BEFORE_CANCEL_REQ2) { |
| 197 | cancel(); |
| 198 | } |
| 199 | } |
| 200 | }; |
| 201 | |
| 202 | // Call sendRequest, which will create a coalescing request, but it |
| 203 | // doesn't send request2 yet |
| 204 | provider.sendRequest(request2); |
| 205 | |
| 206 | // Check if request1/2 is not running yet. |
| 207 | assertFalse("isRunning", request1.isRunning()); |
| 208 | assertFalse("isRunning", request2.isRunning()); |
| 209 | |
| 210 | // Send end synch signal, however requests won't be sent |
| 211 | ((TmfEventProviderStub) provider).endSynch(new TmfEndSynchSignal(0)); |
| 212 | |
| 213 | // Check if request1/2 is not running yet. |
| 214 | assertFalse("isRunning", request1.isRunning()); |
| 215 | assertFalse("isRunning", request2.isRunning()); |
| 216 | |
| 217 | // Finally, trigger sending of requests |
| 218 | provider.notifyPendingRequest(false); |
| 219 | |
| 220 | try { |
| 221 | |
| 222 | // Wait until requests start |
| 223 | request1.waitForStart(); |
| 224 | request2.waitForStart(); |
| 225 | |
| 226 | // // Verify that the requests are running |
| 227 | // assertTrue("isRunning", request1.isRunning()); |
| 228 | // assertTrue("isRunning", request2.isRunning()); |
| 229 | |
| 230 | request1.waitForCompletion(); |
| 231 | |
| 232 | // // Check if request2 is still running |
| 233 | // assertTrue("isRunning", request2.isRunning()); |
| 234 | |
| 235 | // Verify result (request1) |
| 236 | assertEquals("nbEvents", NUMBER_EVENTS_BEFORE_CANCEL_REQ1, requestedEventsReq1.size()); |
| 237 | assertTrue("isCompleted", request1.isCompleted()); |
| 238 | assertTrue("isCancelled", request1.isCancelled()); |
| 239 | |
| 240 | request2.waitForCompletion(); |
| 241 | |
| 242 | // Verify result (request2) |
| 243 | assertEquals("nbEvents", NUMBER_EVENTS_BEFORE_CANCEL_REQ2, requestedEventsReq2.size()); |
| 244 | assertTrue("isCompleted", request2.isCompleted()); |
| 245 | assertTrue("isCancelled", request2.isCancelled()); |
| 246 | |
| 247 | } catch (InterruptedException e) { |
| 248 | fail(); |
| 249 | } |
| 250 | } |
| 251 | |
| 252 | private static void getSyntheticData(final TmfTimeRange range, |
| 253 | final int nbEvents) throws InterruptedException { |
| 254 | |
| 255 | final Vector<ITmfEvent> requestedEvents = new Vector<>(); |
| 256 | |
| 257 | // Get the event provider |
| 258 | ITmfEventProvider[] eventProviders = TmfProviderManager |
| 259 | .getProviders(TmfSyntheticEventStub.class); |
| 260 | ITmfEventProvider provider = eventProviders[0]; |
| 261 | |
| 262 | final TmfEventRequest request = new TmfEventRequest(TmfSyntheticEventStub.class, range, |
| 263 | 0, nbEvents, ExecutionType.FOREGROUND) { |
| 264 | @Override |
| 265 | public void handleData(ITmfEvent event) { |
| 266 | super.handleData(event); |
| 267 | requestedEvents.add(event); |
| 268 | } |
| 269 | }; |
| 270 | provider.sendRequest(request); |
| 271 | |
| 272 | request.waitForCompletion(); |
| 273 | if (nbEvents != -1) { |
| 274 | assertEquals("nbEvents", nbEvents, requestedEvents.size()); |
| 275 | } |
| 276 | assertTrue("isCompleted", request.isCompleted()); |
| 277 | assertFalse("isCancelled", request.isCancelled()); |
| 278 | |
| 279 | // For each base event, the stub will queue 2 identical synthetic events |
| 280 | // Ensure that the events are queued properly. |
| 281 | // Don't go overboard: we are not validating the stub! |
| 282 | for (int i = 0; i < (nbEvents / 2); i++) { |
| 283 | assertEquals("Distinct events", i + 1, requestedEvents.get(2 * i + 0).getTimestamp().getValue()); |
| 284 | assertEquals("Distinct events", i + 1, requestedEvents.get(2 * i + 1).getTimestamp().getValue()); |
| 285 | } |
| 286 | } |
| 287 | |
| 288 | /** |
| 289 | * Test getSyntheticEvents for equal block sizes. |
| 290 | */ |
| 291 | @Test |
| 292 | public void testGetSyntheticEvents_EqualBlockSizes() { |
| 293 | TmfTimeRange range = new TmfTimeRange(TmfTimestamp.BIG_BANG, TmfTimestamp.BIG_CRUNCH); |
| 294 | try { |
| 295 | getSyntheticData(range, 1000); |
| 296 | } catch (InterruptedException e) { |
| 297 | fail(); |
| 298 | } |
| 299 | } |
| 300 | |
| 301 | /** |
| 302 | * Test getSyntheticEvents |
| 303 | */ |
| 304 | @Test |
| 305 | public void testGetSyntheticEvents_TimeRange() { |
| 306 | TmfTimestamp start = new TmfTimestamp(1, (byte) -3); |
| 307 | TmfTimestamp end = new TmfTimestamp(1000, (byte) -3); |
| 308 | TmfTimeRange range = new TmfTimeRange(start, end); |
| 309 | try { |
| 310 | getSyntheticData(range, -1); |
| 311 | } catch (InterruptedException e) { |
| 312 | fail(); |
| 313 | } |
| 314 | } |
| 315 | |
| 316 | // public void testGetSyntheticEvents_WeirdTimeRange1() { |
| 317 | // TmfTimestamp start = TmfTimestamp.BigBang; |
| 318 | // TmfTimestamp end = TmfTimestamp.Zero; // new TmfTimestamp(0, (byte) -3, |
| 319 | // // 0); |
| 320 | // TmfTimeRange range = new TmfTimeRange(start, end); |
| 321 | // try { |
| 322 | // getSyntheticData(range, -1, TmfSyntheticEventProviderStub.BLOCK_SIZE); |
| 323 | // } catch (InterruptedException e) { |
| 324 | // fail(); |
| 325 | // } |
| 326 | // } |
| 327 | |
| 328 | // public void testGetSyntheticEvents_WeirdTimeRange2() { |
| 329 | // TmfTimestamp start = TmfTimestamp.Zero; // new TmfTimestamp(0, (byte) |
| 330 | // // -3, 0); |
| 331 | // TmfTimestamp end = TmfTimestamp.BigCrunch; |
| 332 | // TmfTimeRange range = new TmfTimeRange(start, end); |
| 333 | // try { |
| 334 | // getSyntheticData(range, -1, TmfSyntheticEventProviderStub.BLOCK_SIZE); |
| 335 | // } catch (InterruptedException e) { |
| 336 | // fail(); |
| 337 | // } |
| 338 | // } |
| 339 | |
| 340 | /** |
| 341 | * Test getProviders (more a sanity check than a test) |
| 342 | */ |
| 343 | @Test |
| 344 | public void testGetProviders2() { |
| 345 | |
| 346 | // There should be 2 TmfEvent providers: a TmfTraceStub and a |
| 347 | // TmfEventProviderStub |
| 348 | ITmfEventProvider[] eventProviders = TmfProviderManager.getProviders(ITmfEvent.class); |
| 349 | assertEquals("getProviders", 2, eventProviders.length); |
| 350 | |
| 351 | eventProviders = TmfProviderManager.getProviders(ITmfEvent.class, TmfTraceStub.class); |
| 352 | assertEquals("getProviders", 1, eventProviders.length); |
| 353 | |
| 354 | eventProviders = TmfProviderManager.getProviders(ITmfEvent.class, TmfEventProviderStub.class); |
| 355 | assertEquals("getProviders", 1, eventProviders.length); |
| 356 | |
| 357 | // There should be 1 TmfSyntheticEventStub provider |
| 358 | eventProviders = TmfProviderManager.getProviders(TmfSyntheticEventStub.class); |
| 359 | assertEquals("getProviders", 1, eventProviders.length); |
| 360 | } |
| 361 | |
| 362 | } |