org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/analysis/AnalysisParameterProviderTest.java

   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.assertNotNull;
  17 import static org.junit.Assert.fail;
  18
  19 import java.util.List;
  20
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModule;
  23 import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModuleHelper;
  24 import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisParameterProvider;
  25 import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisManager;
  26 import org.eclipse.tracecompass.tmf.core.exceptions.TmfAnalysisException;
  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.TestAnalysis;
  30 import org.eclipse.tracecompass.tmf.tests.stubs.analysis.TestAnalysisParameterProvider;
  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 the TmfAbstractParameterProvider class
  39  *
  40  * @author Geneviève Bastien
  41  */
  42 public class AnalysisParameterProviderTest {
  43
  44     private static IAnalysisModuleHelper getModuleHelper(@NonNull String moduleId) {
  45         Multimap<String, IAnalysisModuleHelper> helpers = TmfAnalysisManager.getAnalysisModules();
  46         assertEquals(1, helpers.get(moduleId).size());
  47         return helpers.get(moduleId).iterator().next();
  48     }
  49
  50     /**
  51      * Registers the parameter provider
  52      */
  53     @Before
  54     public void setup() {
  55         TmfAnalysisManager.registerParameterProvider(AnalysisManagerTest.MODULE_PARAM, TestAnalysisParameterProvider.class);
  56     }
  57
  58     /**
  59      * Cleanup the trace after testing
  60      */
  61     @After
  62     public void cleanupTrace() {
  63         TmfTestTrace.A_TEST_10K.dispose();
  64     }
  65
  66     /**
  67      * Test that the provider's value is used
  68      */
  69     @Test
  70     public void testProviderTmfTrace() {
  71         ITmfTrace trace = TmfTestTrace.A_TEST_10K.getTrace();
  72         /* Make sure the value is set to null */
  73         IAnalysisModuleHelper helper = getModuleHelper(AnalysisManagerTest.MODULE_PARAM);
  74         assertNotNull(helper);
  75         IAnalysisModule module = null;
  76         try {
  77             module = helper.newModule(trace);
  78
  79             assertEquals(10, module.getParameter(TestAnalysis.PARAM_TEST));
  80
  81             /* Change the value of the parameter in the provider */
  82             List<IAnalysisParameterProvider> providers = TmfAnalysisManager.getParameterProviders(module, trace);
  83             assertEquals(1, providers.size());
  84             TestAnalysisParameterProvider provider = (TestAnalysisParameterProvider) providers.get(0);
  85             provider.setValue(5);
  86             assertEquals(5, module.getParameter(TestAnalysis.PARAM_TEST));
  87
  88         } catch (TmfAnalysisException e) {
  89             fail(e.getMessage());
  90         } finally {
  91             if (module != null) {
  92                 module.dispose();
  93             }
  94         }
  95     }
  96
  97 }