tmf/org.eclipse.tracecompass.tmf.ui.tests/src/org/eclipse/tracecompass/tmf/ui/tests/statistics/TmfBaseColumnDataProviderTest.java

   1 /*******************************************************************************
   2  * Copyright (c) 2011, 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  *   Mathieu Denis <mathieu.denis@polymtl.ca> - Initial API and Implementation
  11  *   Bernd Hufmann - Fixed header and warnings
  12  *   Alexandre Montplaisir - Port to JUnit4
  13  *******************************************************************************/
  14
  15 package org.eclipse.tracecompass.tmf.ui.tests.statistics;
  16
  17 import static org.junit.Assert.assertEquals;
  18 import static org.junit.Assert.assertNotNull;
  19 import static org.junit.Assert.assertNull;
  20 import static org.junit.Assert.assertTrue;
  21
  22 import java.util.List;
  23
  24 import org.eclipse.jface.viewers.ColumnLabelProvider;
  25 import org.eclipse.jface.viewers.ViewerComparator;
  26 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
  27 import org.eclipse.tracecompass.tmf.core.event.ITmfEventField;
  28 import org.eclipse.tracecompass.tmf.core.event.TmfEvent;
  29 import org.eclipse.tracecompass.tmf.core.event.TmfEventField;
  30 import org.eclipse.tracecompass.tmf.core.event.TmfEventType;
  31 import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp;
  32 import org.eclipse.tracecompass.tmf.core.trace.ITmfContext;
  33 import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.Messages;
  34 import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfBaseColumnData;
  35 import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfBaseColumnDataProvider;
  36 import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfStatisticsTree;
  37 import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfStatisticsTreeNode;
  38 import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfBaseColumnData.ITmfColumnPercentageProvider;
  39 import org.junit.Test;
  40
  41 /**
  42  * TmfBaseColumnDataProvider test cases.
  43  *
  44  */
  45 public class TmfBaseColumnDataProviderTest {
  46
  47     // ------------------------------------------------------------------------
  48     // Fields
  49     // ------------------------------------------------------------------------
  50
  51     private static final double DELTA = 1e-15;
  52
  53     private final static String LEVEL_COLUMN = Messages.TmfStatisticsView_LevelColumn;
  54     private final static String EVENTS_COUNT_COLUMN = Messages.TmfStatisticsView_NbEventsColumn;
  55
  56     private TmfBaseColumnDataProvider provider;
  57
  58     private static final String fTestName = "ColumnDataProviderTest";
  59
  60     private final String fTypeId1 = "Some type1";
  61     private final String fTypeId2 = "Some type2";
  62
  63     private final String fLabel0 = "label1";
  64     private final String fLabel1 = "label2";
  65     private final String fLabel2 = "label3";
  66     private final String[] fLabels = new String[] { fLabel0, fLabel1, fLabel2 };
  67
  68     private final TmfTimestamp fTimestamp1 = new TmfTimestamp(12345, (byte) 2);
  69     private final TmfTimestamp fTimestamp2 = new TmfTimestamp(12350, (byte) 2);
  70     private final TmfTimestamp fTimestamp3 = new TmfTimestamp(12355, (byte) 2);
  71
  72     private final TmfEventType fType1 = new TmfEventType(fTypeId1, TmfEventField.makeRoot(fLabels));
  73     private final TmfEventType fType2 = new TmfEventType(fTypeId1, TmfEventField.makeRoot(fLabels));
  74     private final TmfEventType fType3 = new TmfEventType(fTypeId2, TmfEventField.makeRoot(fLabels));
  75
  76     private final ITmfEvent fEvent1;
  77     private final ITmfEvent fEvent2;
  78     private final ITmfEvent fEvent3;
  79
  80     private final TmfEventField fContent1;
  81     private final TmfEventField fContent2;
  82     private final TmfEventField fContent3;
  83
  84     private final TmfStatisticsTree fStatsData;
  85
  86     // ------------------------------------------------------------------------
  87     // Housekeeping
  88     // ------------------------------------------------------------------------
  89
  90     /**
  91      * Constructor
  92      */
  93     public TmfBaseColumnDataProviderTest() {
  94         fContent1 = new TmfEventField(ITmfEventField.ROOT_FIELD_ID, "Some content", null);
  95         fEvent1 = new TmfEvent(null, ITmfContext.UNKNOWN_RANK, fTimestamp1, fType1, fContent1);
  96
  97         fContent2 = new TmfEventField(ITmfEventField.ROOT_FIELD_ID, "Some other content", null);
  98         fEvent2 = new TmfEvent(null, ITmfContext.UNKNOWN_RANK, fTimestamp2, fType2, fContent2);
  99
 100         fContent3 = new TmfEventField(ITmfEventField.ROOT_FIELD_ID, "Some other different content", null);
 101         fEvent3 = new TmfEvent(null, ITmfContext.UNKNOWN_RANK, fTimestamp3, fType3, fContent3);
 102
 103         fStatsData = new TmfStatisticsTree();
 104
 105         fStatsData.getOrCreateNode(fTestName, Messages.TmfStatisticsData_EventTypes);
 106
 107         fStatsData.setTotal(fTestName, true, 3);
 108         fStatsData.setTypeCount(fTestName, fEvent1.getName(), true, 1);
 109         fStatsData.setTypeCount(fTestName, fEvent2.getName(), true, 1);
 110         fStatsData.setTypeCount(fTestName, fEvent3.getName(), true, 1);
 111
 112         provider = new TmfBaseColumnDataProvider();
 113     }
 114
 115     // ------------------------------------------------------------------------
 116     // Get Column Data
 117     // ------------------------------------------------------------------------
 118
 119     /**
 120      * Method with test cases.
 121      */
 122     @Test
 123     public void testGetColumnData() {
 124         List<TmfBaseColumnData> columnsData = provider.getColumnData();
 125         assertNotNull("getColumnData", columnsData);
 126         assertEquals("getColumnData", 4, columnsData.size());
 127
 128         TmfStatisticsTreeNode parentNode = fStatsData.getNode(fTestName);
 129         TmfStatisticsTreeNode treeNode1 = fStatsData.getNode(fTestName, Messages.TmfStatisticsData_EventTypes, fEvent1.getName());
 130         TmfStatisticsTreeNode treeNode2 = fStatsData.getNode(fTestName, Messages.TmfStatisticsData_EventTypes, fEvent3.getName());
 131         ViewerComparator vComp = null;
 132         for (TmfBaseColumnData columnData : columnsData) {
 133             assertNotNull("getColumnData", columnData);
 134             assertNotNull("getColumnData", columnData.getHeader());
 135             assertNotNull("getColumnData", columnData.getTooltip());
 136
 137             // Testing labelProvider
 138             ColumnLabelProvider labelProvider = columnData.getLabelProvider();
 139             if (columnData.getHeader().compareTo(LEVEL_COLUMN) == 0) {
 140                 assertEquals("getColumnData", 0, labelProvider.getText(treeNode1).compareTo(treeNode1.getName()));
 141             } else if (columnData.getHeader().compareTo(EVENTS_COUNT_COLUMN) == 0) {
 142                 // might not work because of machine local number format
 143                 assertEquals("getColumnData", "1", labelProvider.getText(treeNode1));
 144             }
 145
 146             // Testing comparator
 147             vComp = columnData.getComparator();
 148             if (columnData.getHeader().compareTo(LEVEL_COLUMN) == 0) {
 149                 assertTrue("getColumnData", vComp.compare(null, treeNode1, treeNode2) < 0);
 150                 assertTrue("getColumnData", vComp.compare(null, treeNode2, treeNode1) > 0);
 151                 assertTrue("getColumnData", vComp.compare(null, treeNode1, treeNode1) == 0);
 152             } else if (columnData.getHeader().compareTo(EVENTS_COUNT_COLUMN) == 0) {
 153                 assertTrue("getColumnData", vComp.compare(null, treeNode1, treeNode2) == 0);
 154                 assertTrue("getColumnData", vComp.compare(null, treeNode2, treeNode1) == 0);
 155                 assertTrue("getColumnData", vComp.compare(null, treeNode1, treeNode1) == 0);
 156             }
 157
 158             // Testing percentage provider
 159             ITmfColumnPercentageProvider percentProvider = columnData.getPercentageProvider();
 160             if (columnData.getHeader().compareTo(LEVEL_COLUMN) == 0) {
 161                 assertNull("getColumnData", percentProvider);
 162             } else if (columnData.getHeader().compareTo(EVENTS_COUNT_COLUMN) == 0) {
 163                 double percentage = (double) treeNode1.getValues().getTotal() / parentNode.getValues().getTotal();
 164                 assertEquals("getColumnData", percentage, percentProvider.getPercentage(treeNode1), DELTA);
 165             }
 166         }
 167     }
 168 }