git.efficios.com Git - deliverable/tracecompass.git/blob

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2014 École Polytechnique de Montréal
   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  *   Geneviève Bastien - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.core.tests.analysis;
  14
  15 import static org.junit.Assert.assertEquals;
  16 import static org.junit.Assert.assertFalse;
  17 import static org.junit.Assert.assertNotNull;
  18 import static org.junit.Assert.assertTrue;
  19
  20 import java.util.Collection;
  21 import java.util.Map;
  22
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModuleHelper;
  25 import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModuleSource;
  26 import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisManager;
  27 import org.eclipse.tracecompass.tmf.core.tests.shared.TmfTestTrace;
  28 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  29 import org.eclipse.tracecompass.tmf.tests.stubs.analysis.AnalysisModuleSourceStub;
  30 import org.eclipse.tracecompass.tmf.tests.stubs.analysis.AnalysisModuleTestHelper;
  31 import org.junit.After;
  32 import org.junit.Before;
  33 import org.junit.Test;
  34
  35 import com.google.common.collect.Multimap;
  36
  37 /**
  38  * Test suite for the TmfAnalysisModule class
  39  */
  40 public class AnalysisManagerTest {
  41
  42     /** Id of analysis module with parameter */
  43     public static final @NonNull String MODULE_PARAM = "org.eclipse.linuxtools.tmf.core.tests.analysis.test";
  44     /** ID of analysis module with parameter and default value */
  45     public static final @NonNull String MODULE_PARAM_DEFAULT = "org.eclipse.linuxtools.tmf.core.tests.analysis.test2";
  46     /** ID of analysis module for trace 2 classes only */
  47     public static final @NonNull String MODULE_SECOND = "org.eclipse.linuxtools.tmf.core.tests.analysis.testother";
  48     /** Id of analysis module with requirements */
  49     public static final @NonNull String MODULE_REQ = "org.eclipse.linuxtools.tmf.core.tests.analysis.reqtest";
  50
  51     private ITmfTrace fTrace;
  52
  53     /**
  54      * Set up some trace code
  55      */
  56     @Before
  57     public void setupTraces() {
  58         fTrace = TmfTestTrace.A_TEST_10K2.getTraceAsStub2();
  59     }
  60
  61     /**
  62      * Some tests use traces, let's clean them here
  63      */
  64     @After
  65     public void cleanupTraces() {
  66         TmfTestTrace.A_TEST_10K.dispose();
  67         fTrace.dispose();
  68     }
  69
  70     /**
  71      * Test suite for the {@link TmfAnalysisManager#getAnalysisModules()} method
  72      */
  73     @Test
  74     public void testGetAnalysisModules() {
  75         Multimap<String, IAnalysisModuleHelper> modules = TmfAnalysisManager.getAnalysisModules();
  76         /* At least 3 modules should be found */
  77         assertTrue(modules.size() >= 3);
  78
  79         Collection<IAnalysisModuleHelper> moduleList = modules.get(MODULE_PARAM_DEFAULT);
  80         assertEquals(1, moduleList.size());
  81         IAnalysisModuleHelper module = moduleList.iterator().next();
  82         assertTrue(module.isAutomatic());
  83
  84         moduleList = modules.get(MODULE_PARAM);
  85         assertEquals(1, moduleList.size());
  86         module = moduleList.iterator().next();
  87         assertFalse(module.isAutomatic());
  88     }
  89
  90     /**
  91      * Test suite for {@link TmfAnalysisManager#getAnalysisModules(Class)} Use
  92      * the test TMF trace and test trace2 stubs as sample traces
  93      */
  94     @Test
  95     public void testListForTraces() {
  96         /* Generic TmfTrace */
  97         ITmfTrace trace = TmfTestTrace.A_TEST_10K.getTrace();
  98         Class<? extends ITmfTrace> traceClass = trace.getClass();
  99         assertNotNull(traceClass);
 100         Map<String, IAnalysisModuleHelper> map = TmfAnalysisManager.getAnalysisModules(traceClass);
 101
 102         assertTrue(map.containsKey(MODULE_PARAM));
 103         assertTrue(map.containsKey(MODULE_PARAM_DEFAULT));
 104         assertFalse(map.containsKey(MODULE_SECOND));
 105
 106         /* TmfTraceStub2 class */
 107         traceClass = fTrace.getClass();
 108         assertNotNull(traceClass);
 109         map = TmfAnalysisManager.getAnalysisModules(traceClass);
 110
 111         assertTrue(map.containsKey(MODULE_PARAM));
 112         assertTrue(map.containsKey(MODULE_PARAM_DEFAULT));
 113         assertTrue(map.containsKey(MODULE_SECOND));
 114     }
 115
 116     /**
 117      * Test suite to test refresh of analysis module when adding a {@link IAnalysisModuleSource}
 118      */
 119     @Test
 120     public void testSources() {
 121         /* Make sure that modules in the new source are not in the list already */
 122         /* Generic TmfTrace */
 123         ITmfTrace trace = TmfTestTrace.A_TEST_10K.getTrace();
 124         Class<? extends ITmfTrace> traceClass = trace.getClass();
 125         assertNotNull(traceClass);
 126         Map<String, IAnalysisModuleHelper> map = TmfAnalysisManager.getAnalysisModules(traceClass);
 127
 128         assertFalse(map.containsKey(AnalysisModuleTestHelper.moduleStubEnum.TEST.name()));
 129
 130         /* TmfTraceStub2 class */
 131         Class<? extends ITmfTrace> ftraceClass = fTrace.getClass();
 132         assertNotNull(ftraceClass);
 133         map = TmfAnalysisManager.getAnalysisModules(ftraceClass);
 134
 135         assertFalse(map.containsKey(AnalysisModuleTestHelper.moduleStubEnum.TEST2.name()));
 136
 137         /* Add new source */
 138         TmfAnalysisManager.registerModuleSource(new AnalysisModuleSourceStub());
 139
 140         /* Now make sure the modules are present */
 141         map = TmfAnalysisManager.getAnalysisModules(traceClass);
 142         assertTrue(map.containsKey(AnalysisModuleTestHelper.moduleStubEnum.TEST.name()));
 143
 144         map = TmfAnalysisManager.getAnalysisModules(ftraceClass);
 145         assertTrue(map.containsKey(AnalysisModuleTestHelper.moduleStubEnum.TEST2.name()));
 146     }
 147
 148 }