tmf: bug 494698 Add per-event fields to custom parsers
[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.core.tests / src / org / eclipse / tracecompass / tmf / core / tests / parsers / custom / CustomXmlTraceDataTest.java
index 48b811cb81cb5c4ad423290a77618c04ceacea58..f40db45ce1302e160946e003e200057e749592fd 100644 (file)
 package org.eclipse.tracecompass.tmf.core.tests.parsers.custom;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
 
 import java.io.BufferedWriter;
 import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.text.SimpleDateFormat;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Date;
 
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
+import org.eclipse.tracecompass.tmf.core.event.aspect.ITmfEventAspect;
+import org.eclipse.tracecompass.tmf.core.event.aspect.TmfBaseAspects;
 import org.eclipse.tracecompass.tmf.core.exceptions.TmfTraceException;
+import org.eclipse.tracecompass.tmf.core.parsers.custom.CustomTraceDefinition;
 import org.eclipse.tracecompass.tmf.core.parsers.custom.CustomXmlEvent;
 import org.eclipse.tracecompass.tmf.core.parsers.custom.CustomXmlTrace;
 import org.eclipse.tracecompass.tmf.core.parsers.custom.CustomXmlTraceDefinition;
+import org.eclipse.tracecompass.tmf.core.parsers.custom.CustomTraceDefinition.Tag;
 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
 import org.junit.runner.RunWith;
 import org.junit.runners.Parameterized;
 import org.junit.runners.Parameterized.Parameters;
 
+import com.google.common.collect.Lists;
+
 /**
  * Test the events parsed by a custom XML trace
  *
@@ -63,6 +73,7 @@ public class CustomXmlTraceDataTest extends AbstractCustomTraceDataTest {
 
         private static final int NB_EVENTS = 10;
         private CustomXmlTraceDefinition fDefinition;
+        private ITmfEventAspect<?> fTimestampAspect;
 
         @Override
         public ITmfTrace getTrace() throws IOException, TmfTraceException {
@@ -77,7 +88,10 @@ public class CustomXmlTraceDataTest extends AbstractCustomTraceDataTest {
                 }
                 writer.write("</trace>");
             }
-            return new CustomXmlTrace(null, fDefinition, file.getPath(), BLOCK_SIZE);
+            ITmfTrace trace = new CustomXmlTrace(null, fDefinition, file.getPath(), BLOCK_SIZE);
+            ArrayList<@NonNull ITmfEventAspect<?>> aspects = Lists.newArrayList(trace.getEventAspects());
+            fTimestampAspect = aspects.stream().filter(aspect -> aspect.getName().equals("Timestamp")).findFirst().get();
+            return trace;
         }
 
         @Override
@@ -86,6 +100,7 @@ public class CustomXmlTraceDataTest extends AbstractCustomTraceDataTest {
             String name = fDefinition.definitionName;
             assertEquals("Event name", name, event.getName());
             assertEquals("Event name and type", event.getType().getName(), event.getName());
+            assertEquals("Timestamp", Long.toString(event.getTimestamp().toNanos()), fTimestampAspect.resolve(event));
         }
 
         @Override
@@ -102,6 +117,7 @@ public class CustomXmlTraceDataTest extends AbstractCustomTraceDataTest {
         private static final String ATTRIBUTE_EVENT = "AttributeName";
         private static final String ELEMENT_EVENT = "ElementName";
         private CustomXmlTraceDefinition fDefinition;
+        private ITmfEventAspect<?> fTimestampAspect;
 
         @Override
         public ITmfTrace getTrace() throws IOException, TmfTraceException {
@@ -117,7 +133,10 @@ public class CustomXmlTraceDataTest extends AbstractCustomTraceDataTest {
                 }
                 writer.write("</trace>");
             }
-            return new CustomXmlTrace(null, fDefinition, file.getPath(), BLOCK_SIZE);
+            ITmfTrace trace = new CustomXmlTrace(null, fDefinition, file.getPath(), BLOCK_SIZE);
+            ArrayList<@NonNull ITmfEventAspect<?>> aspects = Lists.newArrayList(trace.getEventAspects());
+            fTimestampAspect = aspects.stream().filter(aspect -> aspect.getName().equals("Timestamp")).findFirst().get();
+            return trace;
         }
 
         @Override
@@ -132,6 +151,100 @@ public class CustomXmlTraceDataTest extends AbstractCustomTraceDataTest {
                 assertEquals("Event name", ELEMENT_EVENT, event.getName());
             }
             assertEquals("Event name and type", event.getType().getName(), event.getName());
+            assertEquals("Timestamp", TmfBaseAspects.getTimestampAspect().resolve(event), fTimestampAspect.resolve(event));
+        }
+
+        @Override
+        public void validateEventCount(int eventCount) {
+            assertEquals("Event count", NB_EVENTS, eventCount);
+        }
+
+    };
+
+    private static final ICustomTestData CUSTOM_XML_EXTRA_FIELDS = new ICustomTestData() {
+
+        private static final int NB_EVENTS = 5;
+        private static final String FOO = "foo";
+        private static final String BAR = "bar";
+        private static final String BAZ = "baz";
+        private static final String MESSAGE = "message";
+        private CustomXmlTraceDefinition fDefinition;
+
+        @Override
+        public ITmfTrace getTrace() throws IOException, TmfTraceException {
+            fDefinition = getDefinition(2);
+            final File file = new File(TRACE_PATH);
+            try (BufferedWriter writer = new BufferedWriter(new FileWriter(file));) {
+                writer.write("<trace>");
+                // Event with one field to set
+                String eventStr = String.format("<event timestamp=\"%s\" name=\"%s\">\n", "1", MESSAGE);
+                eventStr += String.format("<field name=\"%s\" value=\"%s\"/>\n", FOO, BAR);
+                eventStr += "</event>\n";
+                writer.write(eventStr);
+                // Event with 2 different fields and different values
+                eventStr = String.format("<event timestamp=\"%s\" name=\"%s\">\n", "2", MESSAGE);
+                eventStr += String.format("<field name=\"%s\" value=\"%s\"/>\n", FOO, BAR);
+                eventStr += String.format("<field name=\"%s\" value=\"%s\"/>\n", BAR, FOO);
+                eventStr += "</event>\n";
+                writer.write(eventStr);
+                // Event with an extra field that conflicts with a built-in field
+                eventStr = String.format("<event timestamp=\"%s\" name=\"%s\">\n", "3", MESSAGE);
+                eventStr += String.format("<field name=\"Message\" value=\"%s\"/>\n", FOO);
+                eventStr += "</event>\n";
+                writer.write(eventStr);
+                // Event with 2 extra fields with same name where the values
+                // should be appended
+                eventStr = String.format("<event timestamp=\"%s\" name=\"%s\">\n", "4", MESSAGE);
+                eventStr += String.format("<field name=\"%s\" value=\"%s\"/>\n", FOO, BAR);
+                eventStr += String.format("<field name=\"%s\" value=\"%s\"/>\n", FOO, BAZ);
+                eventStr += "</event>\n";
+                writer.write(eventStr);
+                // Event with 2 non matching number extra field names/values
+                eventStr = String.format("<event timestamp=\"%s\" name=\"%s\">\n", "5", MESSAGE);
+                eventStr += String.format("<fieldName value=\"%s\"/>\n", FOO);
+                eventStr += String.format("<fieldValue value=\"%s\"/>\n", BAR);
+                eventStr += String.format("<fieldValue value=\"%s\"/>\n", BAZ);
+                eventStr += "</event>\n";
+                writer.write(eventStr);
+                writer.write("</trace>");
+            }
+            return new CustomXmlTrace(null, fDefinition, file.getPath(), BLOCK_SIZE);
+        }
+
+        @Override
+        public void validateEvent(ITmfEvent event) {
+            assertTrue(event instanceof CustomXmlEvent);
+            long ts = event.getTimestamp().getValue();
+            switch ((int) ts) {
+            case 1:
+                assertNotNull(event.getContent().getField(FOO));
+                assertEquals(BAR, event.getContent().getField(FOO).getValue());
+                assertNull(event.getContent().getField(BAR));
+                break;
+            case 2:
+                assertNotNull(event.getContent().getField(FOO));
+                assertEquals(BAR, event.getContent().getField(FOO).getValue());
+                assertNotNull(event.getContent().getField(BAR));
+                assertEquals(FOO, event.getContent().getField(BAR).getValue());
+                break;
+            case 3:
+                assertNotNull(event.getContent().getField(Tag.MESSAGE.toString()));
+                assertEquals(MESSAGE, event.getContent().getField(Tag.MESSAGE.toString()).getValue());
+                break;
+            case 4:
+                assertNotNull(event.getContent().getField(FOO));
+                assertEquals(BAR + CustomTraceDefinition.SEPARATOR + BAZ, event.getContent().getField(FOO).getValue());
+                assertNull(event.getContent().getField(BAR));
+                break;
+            case 5:
+                assertNotNull(event.getContent().getField(FOO));
+                assertEquals(BAZ, event.getContent().getField(FOO).getValue());
+                assertNull(event.getContent().getField(BAR));
+                break;
+            default:
+                fail("unknown timestamp " + ts);
+            }
+            assertEquals("Event name and type", event.getType().getName(), event.getName());
         }
 
         @Override
@@ -148,7 +261,8 @@ public class CustomXmlTraceDataTest extends AbstractCustomTraceDataTest {
     public static Iterable<Object[]> getParameters() {
         return Arrays.asList(new Object[][] {
                 { "Base parser", CUSTOM_XML },
-                { "Parse with event name", CUSTOM_XML_EVENT_NAME }
+                { "Parse with event name", CUSTOM_XML_EVENT_NAME },
+                { "Parse with extra fields", CUSTOM_XML_EXTRA_FIELDS }
         });
     }
 
This page took 0.027002 seconds and 5 git commands to generate.