tmf/org.eclipse.tracecompass.tmf.ui.tests/src/org/eclipse/tracecompass/tmf/ui/tests/statistics/TmfTreeContentProviderTest.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 design and implementation
  11  *   Bernd Hufmann - Fixed 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.assertFalse;
  19 import static org.junit.Assert.assertNotNull;
  20 import static org.junit.Assert.assertTrue;
  21 import static org.junit.Assert.fail;
  22
  23 import java.util.Arrays;
  24
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.eclipse.tracecompass.internal.tmf.ui.viewers.statistics.model.Messages;
  27 import org.eclipse.tracecompass.internal.tmf.ui.viewers.statistics.model.TmfStatisticsTree;
  28 import org.eclipse.tracecompass.internal.tmf.ui.viewers.statistics.model.TmfStatisticsTreeNode;
  29 import org.eclipse.tracecompass.internal.tmf.ui.viewers.statistics.model.TmfTreeContentProvider;
  30 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
  31 import org.eclipse.tracecompass.tmf.core.event.ITmfEventField;
  32 import org.eclipse.tracecompass.tmf.core.event.TmfEvent;
  33 import org.eclipse.tracecompass.tmf.core.event.TmfEventField;
  34 import org.eclipse.tracecompass.tmf.core.event.TmfEventType;
  35 import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
  36 import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp;
  37 import org.eclipse.tracecompass.tmf.core.trace.ITmfContext;
  38 import org.junit.Test;
  39
  40 /**
  41  * TmfTreeContentProvider Test Cases.
  42  */
  43 public class TmfTreeContentProviderTest {
  44
  45     // ------------------------------------------------------------------------
  46     // Fields
  47     // ------------------------------------------------------------------------
  48
  49     private static final String fTestName = "TreeContentProviderTest";
  50
  51     private final @NonNull String fTypeId1 = "Some type1";
  52     private final @NonNull String fTypeId2 = "Some type2";
  53
  54     private final String fLabel0 = "label1";
  55     private final String fLabel1 = "label2";
  56     private final String[] fLabels = new String[] { fLabel0, fLabel1 };
  57
  58     private final ITmfTimestamp fTimestamp1 = TmfTimestamp.create(12345, (byte) 2);
  59     private final ITmfTimestamp fTimestamp2 = TmfTimestamp.create(12350, (byte) 2);
  60
  61     private final TmfEventType fType1 = new TmfEventType(fTypeId1, TmfEventField.makeRoot(fLabels));
  62     private final TmfEventType fType2 = new TmfEventType(fTypeId2, TmfEventField.makeRoot(fLabels));
  63
  64     private final ITmfEvent fEvent1;
  65     private final ITmfEvent fEvent2;
  66
  67     private final TmfEventField fContent1;
  68     private final TmfEventField fContent2;
  69
  70     private final TmfStatisticsTree fStatsData;
  71
  72     private final TmfTreeContentProvider treeProvider;
  73
  74     // ------------------------------------------------------------------------
  75     // Housekeeping
  76     // ------------------------------------------------------------------------
  77
  78     /**
  79      * Constructor
  80      */
  81     public TmfTreeContentProviderTest() {
  82         fContent1 = new TmfEventField(ITmfEventField.ROOT_FIELD_ID, "Some content", null);
  83         fEvent1 = new TmfEvent(null, ITmfContext.UNKNOWN_RANK, fTimestamp1, fType1, fContent1);
  84
  85         fContent2 = new TmfEventField(ITmfEventField.ROOT_FIELD_ID, "Some other content", null);
  86         fEvent2 = new TmfEvent(null, ITmfContext.UNKNOWN_RANK, fTimestamp2, fType2, fContent2);
  87
  88         fStatsData = new TmfStatisticsTree();
  89
  90         fStatsData.setTotal(fTestName, true, 2);
  91         fStatsData.setTypeCount(fTestName, fEvent1.getName(), true, 1);
  92         fStatsData.setTypeCount(fTestName, fEvent2.getName(), true, 1);
  93
  94         treeProvider = new TmfTreeContentProvider();
  95     }
  96
  97     // ------------------------------------------------------------------------
  98     // Test methods
  99     // ------------------------------------------------------------------------
 100
 101     /**
 102      * Test getting of children.
 103      * FIXME this test was quickly adapted when we removed the TmfFixedArray,
 104      * but it could be rewritten to be much more simple...
 105      */
 106     @Test
 107     public void testGetChildren() {
 108         Object[] objectArray = treeProvider.getChildren(fStatsData.getOrCreateNode(fTestName, Messages.TmfStatisticsData_EventTypes));
 109         TmfStatisticsTreeNode[] childrenNode = Arrays.asList(objectArray).toArray(new TmfStatisticsTreeNode[0]);
 110
 111         String[][] childrenExpected = new String[][] {
 112                 new String[] { fTestName, Messages.TmfStatisticsData_EventTypes, fEvent1.getName() },
 113                 new String[] { fTestName, Messages.TmfStatisticsData_EventTypes, fEvent2.getName() }
 114         };
 115
 116         assertEquals("getChildren", childrenExpected.length, childrenNode.length);
 117         // assertTrue("getChildren", childrenPath.equals(childrenExpected));
 118         for (TmfStatisticsTreeNode childNode : childrenNode) {
 119             if (!arrayOfArraysContains(childrenExpected, childNode.getPath())) {
 120                 fail();
 121             }
 122         }
 123     }
 124
 125     private static boolean arrayOfArraysContains(String[][] arrayOfArrays, String[] array) {
 126         for (String[] curArray : arrayOfArrays) {
 127             if (arraysEqual(curArray, array)) {
 128                 return true;
 129             }
 130         }
 131         return false;
 132     }
 133
 134     private static boolean arraysEqual(String[] array1, String[] array2) {
 135         if (array1.length != array2.length) {
 136             return false;
 137         }
 138         for (int i = 0; i < array1.length; i++) {
 139             if (!array1[i].equals(array2[i])) {
 140                 return false;
 141             }
 142         }
 143         return true;
 144     }
 145
 146     /**
 147      * Test getting of parent.
 148      */
 149     @Test
 150     public void testGetParent() {
 151         TmfStatisticsTreeNode parent = (TmfStatisticsTreeNode) treeProvider.getParent(fStatsData.getNode(fTestName));
 152
 153         assertNotNull("getParent", parent);
 154         assertTrue("getParent", parent.getPath().equals(fStatsData.getRootNode().getPath()));
 155     }
 156
 157     /**
 158      * Test checking for children.
 159      */
 160     @Test
 161     public void testHasChildren() {
 162         boolean hasChildren = treeProvider.hasChildren(fStatsData.getRootNode());
 163         assertTrue("hasChildren", hasChildren);
 164
 165         hasChildren = treeProvider.hasChildren(fStatsData.getOrCreateNode(fTestName));
 166         assertTrue("hasChildren", hasChildren);
 167
 168         hasChildren = treeProvider.hasChildren(fStatsData.getOrCreateNode(fTestName, Messages.TmfStatisticsData_EventTypes));
 169         assertTrue("hasChildren", hasChildren);
 170
 171         hasChildren = treeProvider.hasChildren(fStatsData.getOrCreateNode(fTestName, Messages.TmfStatisticsData_EventTypes, fEvent1.getName()));
 172         assertFalse("hasChildren", hasChildren);
 173     }
 174
 175     /**
 176      * Test getting of elements.
 177      */
 178     @Test
 179     public void testGetElements() {
 180         Object[] objectElements = treeProvider.getElements(fStatsData.getRootNode());
 181         TmfStatisticsTreeNode[] nodeElements = Arrays.asList(objectElements).toArray(new TmfStatisticsTreeNode[0]);
 182         assertEquals("getElements", 1, nodeElements.length);
 183         assertTrue("getElements", nodeElements[0].getPath()[0].equals(fTestName));
 184     }
 185 }