Gmail productivity workload

A new workload to perform standard productivity tasks within Gmail.  Each user event/step is timed and reported back as a metric.

wlauto/workloads/gmail/__init__.py

@@ -0,0 +1,78 @@
+import os
+import logging
+import re
+import time
+
+from wlauto import AndroidUiAutoBenchmark, Parameter
+
+
+class Gmail(AndroidUiAutoBenchmark):
+
+    name = 'gmail'
+    package = 'com.google.android.gm'
+    activity = ''
+    view = [package+'/com.google.android.gm.ConversationListActivityGmail',
+            package+'/com.google.android.gm.ComposeActivityGmail']
+    description = """
+    A workload to perform standard productivity tasks within Gmail.
+
+    The workload carries out various tasks, such as creatign new emails and
+    sending them, whilst also producing metrics for action completion times.
+    """
+
+    regex = re.compile(r'uxperf_gmail.*: (?P<key>\w+) (?P<value>\d+)')
+
+    parameters = [
+        Parameter('recipient', default='armuxperf@gmail.com', mandatory=False,
+                  description=""""
+                  The email address of the recipient.  Setting a void address
+                  will stop any mesage failures clogging up your device inbox
+                  """),
+        Parameter('dumpsys_enabled', kind=bool, default=True,
+                  description="""
+                  If ``True``, dumpsys captures will be carried out during the
+                  test run.  The output is piped to log files which are then
+                  pulled from the phone.
+                  """),
+    ]
+
+    instrumentation_log = ''.join([name, '_instrumentation.log'])
+
+    def __init__(self, device, **kwargs):
+        super(Gmail, self).__init__(device, **kwargs)
+        self.uiauto_params['recipient'] = self.recipient
+
+    def validate(self):
+        super(Gmail, self).validate()
+        self.output_file = os.path.join(self.device.working_directory, self.instrumentation_log)
+        self.uiauto_params['package'] = self.package
+        self.uiauto_params['output_dir'] = self.device.working_directory
+        self.uiauto_params['output_file'] = self.output_file
+        self.uiauto_params['dumpsys_enabled'] = self.dumpsys_enabled
+
+    def update_result(self, context):
+        super(Gmail, self).update_result(context)
+
+        if self.dumpsys_enabled:
+            self.device.pull_file(self.output_file, context.output_directory)
+            result_file = os.path.join(context.output_directory, self.instrumentation_log)
+
+            with open(result_file, 'r') as wfh:
+                regex = re.compile(r'(?P<key>\w+)\s+(?P<value1>\d+)\s+(?P<value2>\d+)\s+(?P<value3>\d+)')
+                for line in wfh:
+                    match = regex.search(line)
+                    if match:
+                        context.result.add_metric((match.group('key') + "_start"),
+                                                  match.group('value1'))
+                        context.result.add_metric((match.group('key') + "_finish"),
+                                                  match.group('value2'))
+                        context.result.add_metric((match.group('key') + "_duration"),
+                                                  match.group('value3'))
+
+    def teardown(self, context):
+        super(Gmail, self).teardown(context)
+
+        for file in self.device.listdir(self.device.working_directory):
+            if file.startswith (self.name) and file.endswith(".log"):
+                self.device.pull_file(os.path.join(self.device.working_directory, file), context.output_directory)
+                self.device.delete_file(os.path.join(self.device.working_directory, file))

wlauto/workloads/gmail/uiauto/build.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+class_dir=bin/classes/com/arm/wlauto/uiauto
+base_classes=`python -c "import os, wlauto; print os.path.join(os.path.dirname(wlauto.__file__), 'common', 'android', '*.class')"`
+mkdir -p $class_dir
+cp $base_classes $class_dir
+
+ant build
+
+if [[ -f bin/com.arm.wlauto.uiauto.gmail.jar ]]; then
+    cp bin/com.arm.wlauto.uiauto.gmail.jar ..
+fi

wlauto/workloads/gmail/uiauto/build.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="com.arm.wlauto.uiauto.gmail" default="help">
+
+    <!-- The local.properties file is created and updated by the 'android' tool.
+         It contains the path to the SDK. It should *NOT* be checked into
+         Version Control Systems. -->
+    <property file="local.properties" />
+
+    <!-- The ant.properties file can be created by you. It is only edited by the
+         'android' tool to add properties to it.
+         This is the place to change some Ant specific build properties.
+         Here are some properties you may want to change/update:
+
+         source.dir
+             The name of the source directory. Default is 'src'.
+         out.dir
+             The name of the output directory. Default is 'bin'.
+
+         For other overridable properties, look at the beginning of the rules
+         files in the SDK, at tools/ant/build.xml
+
+         Properties related to the SDK location or the project target should
+         be updated using the 'android' tool with the 'update' action.
+
+         This file is an integral part of the build system for your
+         application and should be checked into Version Control Systems.
+
+         -->
+    <property file="ant.properties" />
+
+    <!-- if sdk.dir was not set from one of the property file, then
+         get it from the ANDROID_HOME env var.
+         This must be done before we load project.properties since
+         the proguard config can use sdk.dir -->
+    <property environment="env" />
+    <condition property="sdk.dir" value="${env.ANDROID_HOME}">
+        <isset property="env.ANDROID_HOME" />
+    </condition>
+
+    <!-- The project.properties file is created and updated by the 'android'
+         tool, as well as ADT.
+
+         This contains project specific properties such as project target, and library
+         dependencies. Lower level build properties are stored in ant.properties
+         (or in .classpath for Eclipse projects).
+
+         This file is an integral part of the build system for your
+         application and should be checked into Version Control Systems. -->
+    <loadproperties srcFile="project.properties" />
+
+    <!-- quick check on sdk.dir -->
+    <fail
+            message="sdk.dir is missing. Make sure to generate local.properties using 'android update project' or to inject it through the ANDROID_HOME environment variable."
+            unless="sdk.dir"
+    />
+
+    <!--
+        Import per project custom build rules if present at the root of the project.
+        This is the place to put custom intermediary targets such as:
+            -pre-build
+            -pre-compile
+            -post-compile (This is typically used for code obfuscation.
+                           Compiled code location: ${out.classes.absolute.dir}
+                           If this is not done in place, override ${out.dex.input.absolute.dir})
+            -post-package
+            -post-build
+            -pre-clean
+    -->
+    <import file="custom_rules.xml" optional="true" />
+
+    <!-- Import the actual build file.
+
+         To customize existing targets, there are two options:
+         - Customize only one target:
+             - copy/paste the target into this file, *before* the
+               <import> task.
+             - customize it to your needs.
+         - Customize the whole content of build.xml
+             - copy/paste the content of the rules files (minus the top node)
+               into this file, replacing the <import> task.
+             - customize to your needs.
+
+         ***********************
+         ****** IMPORTANT ******
+         ***********************
+         In all cases you must update the value of version-tag below to read 'custom' instead of an integer,
+         in order to avoid having your file be overridden by tools such as "android update project"
+    -->
+    <!-- version-tag: VERSION_TAG -->
+    <import file="${sdk.dir}/tools/ant/uibuild.xml" />
+
+</project>

wlauto/workloads/gmail/uiauto/project.properties

@@ -0,0 +1,14 @@
+# This file is automatically generated by Android Tools.
+# Do not modify this file -- YOUR CHANGES WILL BE ERASED!
+#
+# This file must be checked in Version Control Systems.
+#
+# To customize properties used by the Ant build system edit
+# "ant.properties", and override values to adapt the script to your
+# project structure.
+#
+# To enable ProGuard to shrink and obfuscate your code, uncomment this (available properties: sdk.dir, user.home):
+#proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt
+
+# Project target.
+target=android-18

wlauto/workloads/gmail/uiauto/src/com/arm/wlauto/uiauto/UiAutomation.java

@@ -0,0 +1,123 @@
+package com.arm.wlauto.uiauto.gmail;
+
+import android.os.Bundle;
+import android.os.SystemClock;
+
+// Import the uiautomator libraries
+import com.android.uiautomator.core.UiObject;
+import com.android.uiautomator.core.UiObjectNotFoundException;
+import com.android.uiautomator.core.UiScrollable;
+import com.android.uiautomator.core.UiSelector;
+import com.android.uiautomator.testrunner.UiAutomatorTestCase;
+
+import com.arm.wlauto.uiauto.UxPerfUiAutomation;
+
+import java.io.BufferedWriter;
+import java.io.FileWriter;
+import java.util.LinkedHashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Map.Entry;
+
+public class UiAutomation extends UxPerfUiAutomation {
+
+    public static String TAG = "uxperf_gmail";
+
+    private Bundle parameters;
+    private LinkedHashMap<String, Timer> timingResults = new LinkedHashMap<String, Timer>();
+
+    public void runUiAutomation() throws Exception {
+        parameters = getParams();
+
+        Timer result = new Timer();
+        result.start();
+
+        clearFirstRunDialogues();
+
+        clickNewMail();
+        setToField();
+        setSubjectField();
+        setComposeField();
+        clickSendButton();
+
+        result.end();
+        timingResults.put("Total", result);
+
+        writeResultsToFile(timingResults, parameters.getString("output_file"));
+    }
+
+    public void clearFirstRunDialogues () throws Exception {
+        // Enter search text into the file searchBox.  This will automatically filter the list.
+        UiObject gotItBox = getUiObjectByResourceId("com.google.android.gm:id/welcome_tour_got_it",
+                                                     "android.widget.TextView");
+        gotItBox.clickAndWaitForNewWindow();
+        UiObject takeMeToBox = getUiObjectByText("Take me to Gmail", "android.widget.TextView");
+        takeMeToBox.clickAndWaitForNewWindow();
+    }
+
+    public void clickNewMail() throws Exception {
+        Timer result = new Timer();
+        UiObject newMailButton = getUiObjectByDescription("Compose", "android.widget.ImageButton");
+        result.start();
+        newMailButton.clickAndWaitForNewWindow(timeout);
+        result.end();
+        timingResults.put("newMail", result);
+    }
+
+    public void setToField() throws Exception {
+        Timer result = new Timer();
+        UiObject toField = getUiObjectByDescription("To", "android.widget.TextView");
+        String recipient = parameters.getString("recipient").replace('_', ' ');
+        result.start();
+        toField.setText(recipient);
+        getUiDevice().pressEnter();
+        result.end();
+        timingResults.put("To", result);
+    }
+
+    public void setSubjectField() throws Exception {
+        Timer result = new Timer();
+        UiObject subjectField = getUiObjectByText("Subject", "android.widget.EditText");
+        result.start();
+        subjectField.setText("This is a test message");
+        getUiDevice().pressEnter();
+        result.end();
+        timingResults.put("Subject", result);
+    }
+
+    public void setComposeField() throws Exception {
+        Timer result = new Timer();
+        UiObject composeField = getUiObjectByText("Compose email", "android.widget.EditText");
+        result.start();
+        composeField.setText("This is a test composition");
+        getUiDevice().pressEnter();
+        result.end();
+        timingResults.put("Compose", result);
+    }
+
+    public void clickSendButton() throws Exception {
+        Timer result = new Timer();
+        UiObject sendButton = getUiObjectByDescription("Send", "android.widget.TextView");
+        result.start();
+        sendButton.clickAndWaitForNewWindow(timeout);
+        result.end();
+        timingResults.put("Send", result);
+    }
+
+    private void writeResultsToFile(LinkedHashMap timingResults, String file) throws Exception {
+        // Write out the key/value pairs to the instrumentation log file
+        FileWriter fstream = new FileWriter(file);
+        BufferedWriter out = new BufferedWriter(fstream);
+        Iterator<Entry<String, Timer>> it = timingResults.entrySet().iterator();
+
+        while (it.hasNext()) {
+            Map.Entry<String, Timer> pairs = it.next();
+            Timer results = pairs.getValue();
+            long start = results.getStart();
+            long finish = results.getFinish();
+            long duration = results.getDuration();
+            out.write(String.format(pairs.getKey() + " " + start + " " + finish + " " + duration + "\n"));
+        }
+        out.close();
+    }
+}