Merge "Events logcat parser"

3 files changed, 393 insertions, 0 deletions

diff --git a/src/com/android/loganalysis/item/TransitionDelayItem.java b/src/com/android/loganalysis/item/TransitionDelayItem.java
new file mode 100644
index 0000000..33a1b93
--- /dev/null
+++ b/src/com/android/loganalysis/item/TransitionDelayItem.java
@@ -0,0 +1,68 @@
+/*
+ * Copyright (C) 2016 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.android.loganalysis.item;
+
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * An {@link IItem} used to TransitionDelayInfo.
+ */
+public class TransitionDelayItem extends GenericItem {
+
+    /** Constant for JSON output */
+    public static final String COMPONENT_NAME = "COMPONENT_NAME";
+    /** Constant for JSON output */
+    public static final String START_WINDOW_DELAY = "START_WINDOW_DELAY";
+    /** Constant for JSON output */
+    public static final String TRANSITION_DELAY = "TRANSITION_DELAY";
+
+    private static final Set<String> ATTRIBUTES = new HashSet<String>(Arrays.asList(
+            COMPONENT_NAME, START_WINDOW_DELAY, TRANSITION_DELAY));
+
+    /**
+     * The constructor for {@link TransitionDelayItem}.
+     */
+    public TransitionDelayItem() {
+        super(ATTRIBUTES);
+    }
+
+    public String getComponentName() {
+        return (String) getAttribute(COMPONENT_NAME);
+    }
+
+    public void setComponentName(String componentName) {
+        setAttribute(COMPONENT_NAME, componentName);
+    }
+
+    public long getStartingWindowDelay() {
+        return (long) getAttribute(START_WINDOW_DELAY);
+    }
+
+    public void setStartingWindowDelay(long startingWindowDelay) {
+        setAttribute(START_WINDOW_DELAY, startingWindowDelay);
+    }
+
+    public long getTransitionDelay() {
+        return (long) getAttribute(TRANSITION_DELAY);
+    }
+
+    public void setTransitionDelay(long transitionDelay) {
+        setAttribute(TRANSITION_DELAY, transitionDelay);
+    }
+
+}
diff --git a/src/com/android/loganalysis/parser/EventsLogParser.java b/src/com/android/loganalysis/parser/EventsLogParser.java
new file mode 100644
index 0000000..068feeb
--- /dev/null
+++ b/src/com/android/loganalysis/parser/EventsLogParser.java
@@ -0,0 +1,111 @@
+/*
+ * Copyright (C) 2016 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.loganalysis.parser;
+
+import com.android.loganalysis.item.IItem;
+import com.android.loganalysis.item.TransitionDelayItem;
+
+import java.io.IOException;
+import java.io.BufferedReader;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * Parse the events logs. </p>
+ */
+public class EventsLogParser implements IParser {
+
+    // 08-21 17:53:53.876 1053 2135 I am_restart_activity:
+    // [0,188098346,127,com.google.android.gm/.ConversationListActivityGmail]
+    private static final Pattern ACTIVITY_RESTART = Pattern.compile("^\\d{2}-\\d{2} \\d{2}:\\d{2}"
+            + ":\\d{2}.\\d{3}\\s+\\d+\\s+\\d+ I am_restart_activity: "
+            + "\\[\\d+\\,\\d+\\,\\d+\\,(?<componentname>.*)\\]$");
+    // 08-21 17:57:15.363 1053 2095 I am_resume_activity:
+    // [0,228277756,132,com.google.android.gm/.ConversationListActivityGmail]
+    private static final Pattern ACTIVITY_RESUME = Pattern.compile("^\\d{2}-\\d{2} \\d{2}:\\d{2}"
+            + ":\\d{2}.\\d{3}\\s+\\d+\\s+\\d+ I am_resume_activity: "
+            + "\\[\\d+\\,\\d+\\,\\d+\\,(?<componentname>.*)\\]$");
+    // 08-21 17:53:53.893 1053 1115 I sysui_action: [321,74]
+    private static final Pattern STARTING_WINDOW_DELAY = Pattern.compile("^\\d{2}-\\d{2} \\d{2}:"
+            + "\\d{2}:\\d{2}.\\d{3}\\s+\\d+\\s+\\d+ I sysui_action: \\[321,(?<startdelay>.*)\\]$");
+    // 08-21 17:54:16.672 1053 1115 I sysui_action: [319,99]
+    private static final Pattern TRANSITION_DELAY = Pattern
+            .compile("^\\d{2}-\\d{2} \\d{2}:"
+                    + "\\d{2}:\\d{2}.\\d{3}\\s+\\d+\\s+\\d+ I sysui_action: \\[319,"
+                    + "(?<transitdelay>.*)\\]$");
+
+    @Override
+    public IItem parse(List<String> lines) {
+        throw new UnsupportedOperationException("Method has not been implemented in lieu"
+                + " of others");
+    }
+
+    /**
+     * Method to parse the transition delay information from the events log
+     *
+     * @param input
+     * @return
+     * @throws IOException
+     */
+    public List<TransitionDelayItem> parseTransitionDelayInfo(BufferedReader input)
+            throws IOException {
+        List<TransitionDelayItem> transitionDelayItems = new ArrayList<TransitionDelayItem>();
+        String line;
+        List<String> componentNameStack = new ArrayList<String>();
+        boolean isRecentStartWindowDelay = false;
+        while ((line = input.readLine()) != null) {
+            Matcher match = null;
+            if (((match = matches(ACTIVITY_RESTART, line))) != null ||
+                    ((match = matches(ACTIVITY_RESUME, line)) != null)) {
+                componentNameStack.add(match.group("componentname"));
+                isRecentStartWindowDelay = false;
+            } else if (((match = matches(STARTING_WINDOW_DELAY, line)) != null)
+                    && (componentNameStack.size() > 0)) {
+                TransitionDelayItem delayItem = new TransitionDelayItem();
+                delayItem.setComponentName(
+                        componentNameStack.remove(componentNameStack.size() - 1));
+                delayItem.setStartingWindowDelay(Long.parseLong(match.group("startdelay")));
+                delayItem.setTransitionDelay(-1);
+                transitionDelayItems.add(delayItem);
+                isRecentStartWindowDelay = true;
+            } else if (((match = matches(TRANSITION_DELAY, line)) != null)
+                    && (componentNameStack.size() > 0) && !isRecentStartWindowDelay) {
+                TransitionDelayItem delayItem = new TransitionDelayItem();
+                delayItem.setComponentName(
+                        componentNameStack.remove(componentNameStack.size() - 1));
+                delayItem.setTransitionDelay(Long.parseLong(match.group("transitdelay")));
+                delayItem.setStartingWindowDelay(-1);
+                transitionDelayItems.add(delayItem);
+            }
+        }
+        return transitionDelayItems;
+    }
+
+    /**
+     * Checks whether {@code line} matches the given {@link Pattern}.
+     *
+     * @return The resulting {@link Matcher} obtained by matching the {@code line} against
+     *         {@code pattern}, or null if the {@code line} does not match.
+     */
+    private static Matcher matches(Pattern pattern, String line) {
+        Matcher ret = pattern.matcher(line);
+        return ret.matches() ? ret : null;
+    }
+
+}
diff --git a/tests/src/com/android/loganalysis/parser/EventsLogParserTest.java b/tests/src/com/android/loganalysis/parser/EventsLogParserTest.java
new file mode 100644
index 0000000..092473e
--- /dev/null
+++ b/tests/src/com/android/loganalysis/parser/EventsLogParserTest.java
@@ -0,0 +1,214 @@
+/*
+ * Copyright (C) 2016 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.loganalysis.parser;
+
+import com.android.loganalysis.item.TransitionDelayItem;
+import com.android.loganalysis.parser.EventsLogParser;
+
+import java.io.BufferedWriter;
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.FileInputStream;
+import java.io.InputStreamReader;
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.List;
+
+import junit.framework.TestCase;
+
+/**
+ * Unit tests for {@link EventsLogParser}.
+ */
+public class EventsLogParserTest extends TestCase {
+
+    private File mTempFile = null;
+
+    /**
+     * Test for empty events logs passed to the transition delay parser
+     */
+    public void testEmptyEventsLog() throws IOException {
+        List<String> lines = Arrays.asList("");
+        List<TransitionDelayItem> transitionItems = (new EventsLogParser()).
+                parseTransitionDelayInfo(readInputBuffer(getTempFile(lines)));
+        assertTrue("Transition Delay items list should be empty", transitionItems.size() == 0);
+    }
+
+    /**
+     * Test for no transition delay info in the events log
+     */
+    public void testNoTransitionDelayInfo() throws IOException {
+        List<String> lines = Arrays
+                .asList(
+                        "08-25 12:56:15.850  1152  8968 I am_focused_stack: [0,0,1,appDied setFocusedActivity]",
+                        "08-25 12:56:15.850  1152  8968 I wm_task_moved: [6,1,1]",
+                        "08-25 12:56:15.852  1152  8968 I am_focused_activity: [0,com.google.android.apps.nexuslauncher/.NexusLauncherActivity,appDied]",
+                        "08-25 12:56:15.852  1152  8968 I wm_task_removed: [27,removeTask]",
+                        "08-25 12:56:15.852  1152  8968 I wm_stack_removed: 1");
+        List<TransitionDelayItem> transitionItems = (new EventsLogParser()).
+                parseTransitionDelayInfo(readInputBuffer(getTempFile(lines)));
+        assertTrue("Transition Delay items list should be empty", transitionItems.size() == 0);
+    }
+
+    /**
+     * Test for Cold launch transition delay info
+     */
+    public void testColdLaunchTransitionDelay() throws IOException {
+        List<String> lines = Arrays.asList("08-25 13:01:19.412  1152  9031 I am_restart_activity: [0,85290699,38,com.google.android.gm/.ConversationListActivityGmail]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [321,85]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [320,1]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [319,85]");
+        List<TransitionDelayItem> transitionItems = (new EventsLogParser()).
+                parseTransitionDelayInfo(readInputBuffer(getTempFile(lines)));
+        assertTrue("Transition Delay items list should have one item",
+                transitionItems.size() == 1);
+        assertTrue("Component name not parsed correctly",
+                transitionItems.get(0).getComponentName().equals(
+                        "com.google.android.gm/.ConversationListActivityGmail"));
+        assertTrue("Cold launch info is not set correctly",
+                transitionItems.get(0).getStartingWindowDelay() == 85);
+        assertTrue("Hot launch info is set which is not expected",
+                transitionItems.get(0).getTransitionDelay() == -1);
+    }
+
+    /**
+     * Test for Hot launch transition delay
+     */
+    public void testHotLaunchTransitionDelay() throws IOException {
+        List<String> lines = Arrays
+                .asList("08-25 13:02:04.740  1152  2715 I am_resume_activity: [0,85290699,38,com.google.android.gm/.ConversationListActivityGmail]",
+                        "08-25 13:02:04.754  1152  1180 I sysui_count: [window_time_0,23]",
+                        "08-25 13:02:04.755  1152  1226 I sysui_action: [320,0]",
+                        "08-25 13:02:04.755  1152  1226 I sysui_action: [319,37]");
+        List<TransitionDelayItem> transitionItems = (new EventsLogParser()).
+                parseTransitionDelayInfo(readInputBuffer(getTempFile(lines)));
+        assertTrue("Transition Delay items list shopuld have one item",
+                transitionItems.size() == 1);
+        assertTrue("Component name not parsed correctly",
+                transitionItems.get(0).getComponentName().equals(
+                        "com.google.android.gm/.ConversationListActivityGmail"));
+        assertTrue("Cold launch info is set which is not expected",
+                transitionItems.get(0).getStartingWindowDelay() == -1);
+        assertTrue("Hot launch info is not set correctly",
+                transitionItems.get(0).getTransitionDelay() == 37);
+    }
+
+    /**
+     * Test for same app transition delay items order after parsing from the events log
+     */
+    public void testTransitionDelayOrder() throws IOException {
+        List<String> lines = Arrays
+                .asList("08-25 13:01:19.412  1152  9031 I am_restart_activity: [0,85290699,38,com.google.android.gm/.ConversationListActivityGmail]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [321,85]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [320,1]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [319,85]",
+                        "08-25 12:56:15.850  1152  8968 I am_focused_stack: [0,0,1,appDied setFocusedActivity]",
+                        "08-25 12:56:15.850  1152  8968 I wm_task_moved: [6,1,1]",
+                        "08-25 12:56:15.852  1152  8968 I am_focused_activity: [0,com.google.android.apps.nexuslauncher/.NexusLauncherActivity,appDied]",
+                        "08-25 12:56:15.852  1152  8968 I wm_task_removed: [27,removeTask]",
+                        "08-25 12:56:15.852  1152  8968 I wm_stack_removed: 1",
+                        "08-25 13:02:04.740  1152  2715 I am_resume_activity: [0,85290699,38,com.google.android.gm/.ConversationListActivityGmail]",
+                        "08-25 13:02:04.754  1152  1180 I sysui_count: [window_time_0,23]",
+                        "08-25 13:02:04.755  1152  1226 I sysui_action: [320,0]",
+                        "08-25 13:02:04.755  1152  1226 I sysui_action: [319,37]");
+        List<TransitionDelayItem> transitionItems = (new EventsLogParser()).
+                parseTransitionDelayInfo(readInputBuffer(getTempFile(lines)));
+        assertTrue("Transition Delay items list should have two items",
+                transitionItems.size() == 2);
+        assertTrue("Cold launch transition delay is not the first item",
+                (transitionItems.get(0).getStartingWindowDelay() == 85));
+        assertTrue("Hot launch transition delay is not the second item",
+                (transitionItems.get(1).getTransitionDelay() == 37));
+    }
+
+    /**
+     * Test for two different different apps transition delay items
+     */
+    public void testDifferentAppTransitionDelay() throws IOException {
+        List<String> lines = Arrays
+                .asList("08-25 13:01:19.412  1152  9031 I am_restart_activity: [0,85290699,38,com.google.android.gm/.ConversationListActivityGmail]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [321,85]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [320,1]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [319,85]",
+                        "08-25 12:56:15.850  1152  8968 I am_focused_stack: [0,0,1,appDied setFocusedActivity]",
+                        "08-25 12:56:15.850  1152  8968 I wm_task_moved: [6,1,1]",
+                        "08-25 12:56:15.852  1152  8968 I am_focused_activity: [0,com.google.android.apps.nexuslauncher/.NexusLauncherActivity,appDied]",
+                        "08-25 12:56:15.852  1152  8968 I wm_task_removed: [27,removeTask]",
+                        "08-25 12:56:15.852  1152  8968 I wm_stack_removed: 1",
+                        "08-25 13:03:35.528  1152  2715 I am_restart_activity: [0,32358360,39,com.google.android.apps.maps/com.google.android.maps.MapsActivity]",
+                        "08-25 13:03:35.540  1152  1179 I am_pss  : [7727,10032,com.google.android.apps.nexuslauncher,50991104,45486080,0]",
+                        "08-25 13:03:35.566  1152  1179 I am_pss  : [9207,10045,com.google.android.googlequicksearchbox:search,111955968,102227968,0]",
+                        "08-25 13:03:35.569  1152  1226 I sysui_action: [321,92]",
+                        "08-25 13:03:35.569  1152  1226 I sysui_action: [320,1]",
+                        "08-25 13:03:35.569  1152  1226 I sysui_action: [319,92]");
+        List<TransitionDelayItem> transitionItems = (new EventsLogParser()).
+                parseTransitionDelayInfo(readInputBuffer(getTempFile(lines)));
+        assertTrue("Transition Delay items list should have two items",
+                transitionItems.size() == 2);
+        assertTrue("Gmail is not the first transition delay item",
+                transitionItems.get(0).getComponentName().equals(
+                        "com.google.android.gm/.ConversationListActivityGmail"));
+        assertTrue("Maps is not the second transition delay item",
+                transitionItems.get(1).getComponentName().equals(
+                        "com.google.android.apps.maps/com.google.android.maps.MapsActivity"));
+    }
+
+    /**
+     * Test for invalid transition delay items pattern
+     */
+    public void testInvalidTransitionPattern() throws IOException {
+        List<String> lines = Arrays
+                .asList("08-25 13:01:19.412  1152  9031 I am_restart_activity: [com.google.android.gm/.ConversationListActivityGmail,0,85290699,38]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [321,85]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [320,1]",
+                        "08-25 13:01:19.437  1152  1226 I sysui_action: [319,85]",
+                        "08-25 12:56:15.850  1152  8968 I am_focused_stack: [0,0,1,appDied setFocusedActivity]",
+                        "08-25 12:56:15.850  1152  8968 I wm_task_moved: [6,1,1]",
+                        "08-25 12:56:15.852  1152  8968 I am_focused_activity: [0,com.google.android.apps.nexuslauncher/.NexusLauncherActivity,appDied]",
+                        "08-25 12:56:15.852  1152  8968 I wm_task_removed: [27,removeTask]",
+                        "08-25 12:56:15.852  1152  8968 I wm_stack_removed: 1",
+                        "08-25 13:02:04.740  1152  2715 I am_res_activity: [0,85290699,38,com.google.android.gm/.ConversationListActivityGmail]",
+                        "08-25 13:02:04.754  1152  1180 I sysui_count: [window_time_0,23]",
+                        "08-25 13:02:04.755  1152  1226 I sysui_action: [320,0]",
+                        "08-25 13:02:04.755  1152  1226 I sysui_action: [319,37]");
+        List<TransitionDelayItem> transitionItems = (new EventsLogParser()).
+                parseTransitionDelayInfo(readInputBuffer(getTempFile(lines)));
+        assertTrue("Transition Delay items list should be empty", transitionItems.size() == 0);
+    }
+
+    /**
+     * Write list of strings to file and use it for testing.
+     */
+    public File getTempFile(List<String> sampleEventsLogs) throws IOException {
+        mTempFile = File.createTempFile("events_logcat", ".txt");
+        BufferedWriter out = new BufferedWriter(new FileWriter(mTempFile));
+        for (String line : sampleEventsLogs) {
+            out.write(line);
+            out.newLine();
+        }
+        out.close();
+        return mTempFile;
+    }
+
+    /**
+     * Reader to read the input from the given temp file
+     */
+    public BufferedReader readInputBuffer(File tempFile) throws IOException {
+        return (new BufferedReader(new InputStreamReader(new FileInputStream(tempFile))));
+    }
+
+}
\ No newline at end of file