Home | History | Annotate | Download | only in cts
      1 /*
      2  * Copyright (C) 2009 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package android.util.cts;
     18 
     19 import static org.junit.Assert.assertEquals;
     20 import static org.junit.Assert.assertNull;
     21 import static org.junit.Assert.assertTrue;
     22 import static org.junit.Assert.fail;
     23 
     24 import android.os.Process;
     25 import android.support.test.filters.SmallTest;
     26 import android.support.test.runner.AndroidJUnit4;
     27 import android.util.EventLog;
     28 import android.util.EventLog.Event;
     29 
     30 import org.junit.Test;
     31 import org.junit.runner.RunWith;
     32 
     33 import java.io.IOException;
     34 import java.util.ArrayList;
     35 import java.util.Iterator;
     36 import java.util.List;
     37 
     38 @SmallTest
     39 @RunWith(AndroidJUnit4.class)
     40 public class EventLogTest {
     41     private static final int ANSWER_TAG = 42;
     42     private static final int PI_TAG = 314;
     43     private static final int E_TAG = 2718;
     44 
     45     @Test
     46     public void testWriteEvent() throws Exception {
     47         long markerData = System.currentTimeMillis();
     48         EventLog.writeEvent(ANSWER_TAG, markerData);
     49         EventLog.writeEvent(ANSWER_TAG, 12345);
     50         EventLog.writeEvent(ANSWER_TAG, 23456L);
     51         EventLog.writeEvent(ANSWER_TAG, 42.4242f);
     52         EventLog.writeEvent(ANSWER_TAG, "Test");
     53         EventLog.writeEvent(ANSWER_TAG, 12345, 23456L, 42.4242f, "Test");
     54 
     55         List<EventLog.Event> events = getEventsAfterMarker(markerData, ANSWER_TAG);
     56         assertEquals(5, events.size());
     57         assertEquals(ANSWER_TAG, events.get(0).getTag());
     58         assertEquals(12345, events.get(0).getData());
     59         assertEquals(23456L, events.get(1).getData());
     60         assertEquals(42.4242f, events.get(2).getData());
     61         assertEquals("Test", events.get(3).getData());
     62 
     63         Object[] arr = (Object[]) events.get(4).getData();
     64         assertEquals(4, arr.length);
     65         assertEquals(12345, arr[0]);
     66         assertEquals(23456L, arr[1]);
     67         assertEquals(42.4242f, arr[2]);
     68         assertEquals("Test", arr[3]);
     69     }
     70 
     71     @Test
     72     public void testWriteEventWithOversizeValueLimitElision() throws Exception {
     73         // make sure big events are postsed and only elided to no less than about 4K.
     74         StringBuilder longString = new StringBuilder();
     75         for (int i = 0; i < 1000; i++) longString.append("xyzzy");
     76 
     77         Object[] longArray = new Object[1000];
     78         for (int i = 0; i < 1000; i++) longArray[i] = 12345;
     79 
     80         Long markerData = System.currentTimeMillis();
     81         EventLog.writeEvent(ANSWER_TAG, markerData);
     82         EventLog.writeEvent(ANSWER_TAG, longString.toString());
     83         EventLog.writeEvent(ANSWER_TAG, "hi", longString.toString());
     84         EventLog.writeEvent(ANSWER_TAG, 12345, longString.toString());
     85         EventLog.writeEvent(ANSWER_TAG, 12345L, longString.toString());
     86         EventLog.writeEvent(ANSWER_TAG, 42.4242f, longString.toString());
     87         EventLog.writeEvent(ANSWER_TAG, longString.toString(), longString.toString());
     88         EventLog.writeEvent(ANSWER_TAG, longArray);
     89         List<Event> events = getEventsAfterMarker(markerData, ANSWER_TAG);
     90         assertEquals(7, events.size());
     91 
     92         final int big = 4000; // expect at least this many bytes to get through.
     93 
     94         // subtract: string header (type + length)
     95         String val0 = (String) events.get(0).getData();
     96         assertNull("getData on object 0 raised a WTF", events.get(0).getLastError());
     97         assertTrue("big string 0 seems short", big < val0.length());
     98 
     99         // subtract: array header, "hi" header, "hi", string header
    100         Object[] arr1 = (Object[]) events.get(1).getData();
    101         assertNull("getData on object 1 raised a WTF", events.get(1).getLastError());
    102         assertEquals(2, arr1.length);
    103         assertEquals("hi", arr1[0]);
    104         assertTrue("big string 1 seems short", big < ((String) arr1[1]).length());
    105 
    106         // subtract: array header, int (type + value), string header
    107         Object[] arr2 = (Object[]) events.get(2).getData();
    108         assertNull("getData on object 2 raised a WTF", events.get(2).getLastError());
    109         assertEquals(2, arr2.length);
    110         assertEquals(12345, arr2[0]);
    111         assertTrue("big string 2 seems short", big < ((String) arr2[1]).length());
    112 
    113         // subtract: array header, long, string header
    114         Object[] arr3 = (Object[]) events.get(3).getData();
    115         assertNull("getData on object 3 raised a WTF", events.get(3).getLastError());
    116         assertEquals(2, arr3.length);
    117         assertEquals(12345L, arr3[0]);
    118         assertTrue("big string 3 seems short", big < ((String) arr3[1]).length());
    119 
    120         // subtract: array header, float, string header
    121         Object[] arr4 = (Object[]) events.get(4).getData();
    122         assertNull("getData on object 4 raised a WTF", events.get(4).getLastError());
    123         assertEquals(2, arr4.length);
    124         assertEquals(42.4242f, arr4[0]);
    125         assertTrue("big string 4 seems short", big < ((String) arr4[1]).length());
    126 
    127         // subtract: array header, string header (second string is dropped entirely)
    128         String string5 = (String) events.get(5).getData();
    129         assertNull("getData on object 5 raised a WTF", events.get(5).getLastError());
    130         assertTrue("big string 5 seems short", big < string5.length());
    131 
    132         Object[] arr6 = (Object[]) events.get(6).getData();
    133         assertNull("getData on object 6 raised a WTF", events.get(6).getLastError());
    134         assertEquals(255, arr6.length);
    135         assertEquals(12345, arr6[0]);
    136         assertEquals(12345, arr6[arr6.length - 1]);
    137     }
    138 
    139     @Test
    140     public void testOversizeStringMayBeTruncated() throws Exception {
    141         // make sure big events elide from the end, not the  from the front or middle.
    142         StringBuilder longBuilder = new StringBuilder();
    143 
    144         // build a long string where the prefix is never repeated
    145         for (int step = 1; step < 256; step += 2) { // all odds are relatively prime to 256
    146             for (int i = 0; i < 255; i++) {
    147                 longBuilder.append(String.valueOf((char) (((step * i) % 256) + 1))); // never emit 0
    148             }
    149         }
    150         String longString = longBuilder.toString(); // 32K
    151 
    152         Long markerData = System.currentTimeMillis();
    153         EventLog.writeEvent(ANSWER_TAG, markerData);
    154         EventLog.writeEvent(ANSWER_TAG, longString);
    155 
    156         List<Event> events = getEventsAfterMarker(markerData, ANSWER_TAG);
    157         assertEquals(1, events.size());
    158 
    159         // subtract: string header (type + length)
    160         String out = (String) events.get(0).getData();
    161         assertNull("getData on big string raised a WTF", events.get(0).getLastError());
    162         assertEquals("output is not a prefix of the input", 0, longString.indexOf(out), 0);
    163     }
    164 
    165     @Test
    166     public void testWriteNullEvent() throws Exception {
    167         Long markerData = System.currentTimeMillis();
    168         EventLog.writeEvent(ANSWER_TAG, markerData);
    169         EventLog.writeEvent(ANSWER_TAG, (String) null);
    170         EventLog.writeEvent(ANSWER_TAG, 12345, null);
    171 
    172         List<EventLog.Event> events = getEventsAfterMarker(markerData, ANSWER_TAG);
    173         assertEquals(2, events.size());
    174         assertEquals("NULL", events.get(0).getData());
    175 
    176         Object[] arr = (Object[]) events.get(1).getData();
    177         assertEquals(2, arr.length);
    178         assertEquals(12345, arr[0]);
    179         assertEquals("NULL", arr[1]);
    180     }
    181 
    182     @Test
    183     public void testReadDataWhenNone() throws Exception {
    184         Long markerData = System.currentTimeMillis();
    185         EventLog.writeEvent(ANSWER_TAG, markerData);
    186         EventLog.writeEvent(ANSWER_TAG);
    187 
    188         List<EventLog.Event> events = getEventsAfterMarker(markerData, ANSWER_TAG);
    189         assertEquals(1, events.size());
    190         assertEquals("getData on empty data did not return null", null, events.get(0).getData());
    191         assertNull("getData on object 0 raised a WTF", events.get(0).getLastError());
    192     }
    193 
    194     @Test
    195     public void testReadEvents() throws Exception {
    196         Long markerData = System.currentTimeMillis();
    197         EventLog.writeEvent(ANSWER_TAG, markerData);
    198 
    199         Long data0 = markerData + 1;
    200         EventLog.writeEvent(ANSWER_TAG, data0);
    201 
    202         Long data1 = data0 + 1;
    203         EventLog.writeEvent(PI_TAG, data1);
    204 
    205         Long data2 = data1 + 1;
    206         EventLog.writeEvent(E_TAG, data2);
    207 
    208         List<Event> events = getEventsAfterMarker(markerData, ANSWER_TAG, PI_TAG, E_TAG);
    209         assertEquals(3, events.size());
    210         verifyEvent(events.get(0), ANSWER_TAG, data0);
    211         verifyEvent(events.get(1), PI_TAG, data1);
    212         verifyEvent(events.get(2), E_TAG, data2);
    213 
    214         events = getEventsAfterMarker(markerData, ANSWER_TAG, E_TAG);
    215         assertEquals(2, events.size());
    216         verifyEvent(events.get(0), ANSWER_TAG, data0);
    217         verifyEvent(events.get(1), E_TAG, data2);
    218 
    219         events = getEventsAfterMarker(markerData, ANSWER_TAG);
    220         assertEquals(1, events.size());
    221         verifyEvent(events.get(0), ANSWER_TAG, data0);
    222     }
    223 
    224     /** Return elements after and the event that has the marker data and matching tag. */
    225     private List<Event> getEventsAfterMarker(Object marker, int... tags)
    226             throws IOException, InterruptedException {
    227         List<Event> events = new ArrayList<>();
    228         // Give the message some time to show up in the log
    229         Thread.sleep(20);
    230         EventLog.readEvents(tags, events);
    231 
    232         for (Iterator<Event> itr = events.iterator(); itr.hasNext(); ) {
    233             Event event = itr.next();
    234             itr.remove();
    235             if (marker.equals(event.getData())) {
    236                 break;
    237             }
    238         }
    239 
    240         verifyEventTimes(events);
    241 
    242         return events;
    243     }
    244 
    245     private void verifyEvent(Event event, int expectedTag, Object expectedData) {
    246         assertEquals(Process.myPid(), event.getProcessId());
    247         assertEquals(Process.myTid(), event.getThreadId());
    248         assertEquals(expectedTag, event.getTag());
    249         assertEquals(expectedData, event.getData());
    250     }
    251 
    252     private void verifyEventTimes(List<Event> events) {
    253         for (int i = 0; i + 1 < events.size(); i++) {
    254             long time = events.get(i).getTimeNanos();
    255             long nextTime = events.get(i).getTimeNanos();
    256             assertTrue(time <= nextTime);
    257         }
    258     }
    259 
    260     @Test
    261     public void testGetTagName() throws Exception {
    262         assertEquals("answer", EventLog.getTagName(ANSWER_TAG));
    263         assertEquals("pi", EventLog.getTagName(PI_TAG));
    264         assertEquals("e", EventLog.getTagName(E_TAG));
    265         assertEquals(null, EventLog.getTagName(999999999));
    266     }
    267 
    268     @Test
    269     public void testGetTagCode() throws Exception {
    270         assertEquals(ANSWER_TAG, EventLog.getTagCode("answer"));
    271         assertEquals(PI_TAG, EventLog.getTagCode("pi"));
    272         assertEquals(E_TAG, EventLog.getTagCode("e"));
    273         assertEquals(-1, EventLog.getTagCode("does_not_exist"));
    274     }
    275 }
    276