Initial commit for Google Slides

Includes functionality to create a document from template or plain PPT or Slides
Also helper functions for edge swipe and adb commands (not quite working)

wlauto/workloads/googleslides/__init__.py

@@ -0,0 +1,94 @@
+#    Copyright 2014-2016 ARM Limited
+#
+# 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.
+#
+
+import os.path as op
+import re
+import time
+
+from wlauto import AndroidUiAutoBenchmark, Parameter
+
+
+def not_implemented(workload, text):
+    workload.logger.info('## ++ NOT IMPLEMENTED ++ ##\n## {}\n## -- NOT IMPLEMENTED -- ##'.format(text))
+
+
+class GoogleSlides(AndroidUiAutoBenchmark):
+
+    name = 'googleslides'
+    package = 'com.google.android.apps.docs.editors.slides'
+    description = 'Creates a Google Slides presentation with some commonly used features'
+    activity = ''
+    # com.google.android.apps.docs.editors.slides/com.google.android.apps.docs.app.DocListActivity
+    # com.google.android.apps.docs.editors.slides/com.google.android.apps.docs.welcome.warmwelcome.TrackingWelcomeActivity
+
+    instrumentation_log = '{}_instrumentation.log'.format(name)
+
+    parameters = [
+        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.
+                  '''),
+    ]
+
+    def __init__(self, device, **kwargs):
+        super(GoogleSlides, self).__init__(device, **kwargs)
+        self.output_file = op.join(self.device.working_directory, self.instrumentation_log)
+        self.run_timeout = 60
+
+    def validate(self):
+        self.logger.info('===== validate() ======')
+        super(GoogleSlides, self).validate()
+        self.uiauto_params['dumpsys_enabled'] = self.dumpsys_enabled
+        self.uiauto_params['output_dir'] = self.device.working_directory
+        self.uiauto_params['results_file'] = self.output_file
+
+    def setup(self, context):
+        self.logger.info('===== setup() ======')
+        super(GoogleSlides, self).setup(context)
+
+    def run(self, context):
+        self.logger.info('===== run() ======')
+        super(GoogleSlides, self).run(context)
+
+    def update_result(self, context):
+        self.logger.info('===== update_result() ======')
+        super(GoogleSlides, self).update_result(context)
+        if self.dumpsys_enabled:
+            not_implemented(self, 'get_metrics(context)')
+
+    def teardown(self, context):
+        self.logger.info('===== teardown() ======')
+        super(GoogleSlides, self).teardown(context)
+        not_implemented(self, 'pull_logs(context)')
+
+    def get_metrics(self, context):
+        self.device.pull_file(self.output_file, context.output_directory)
+        metrics_file = op.join(context.output_directory, self.instrumentation_log)
+        with open(metrics_file, 'r') as wfh:
+            regex = re.compile(r'(\w+)\s+(\d+)\s+(\d+)\s+(\d+)')
+            for line in wfh:
+                match = regex.search(line)
+                if match:
+                    context.result.add_metric((match.group(1) + '_start'), match.group(2))
+                    context.result.add_metric((match.group(1) + '_finish'), match.group(3))
+                    context.result.add_metric((match.group(1) + '_duration'), match.group(4))
+
+    def pull_logs(self, context):
+        wd = self.device.working_directory
+        for entry in self.device.listdir(wd):
+            if entry.startswith(self.name) and entry.endswith('.log'):
+                self.device.pull_file(op.join(wd, entry), context.output_directory)
+                self.device.delete_file(op.join(wd, entry))

wlauto/workloads/googleslides/uiauto/build.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# CD into build dir if possible - allows building from any directory
+script_path='.'
+if `readlink -f $0 &>/dev/null`; then
+    script_path=`readlink -f $0 2>/dev/null`
+fi
+script_dir=`dirname $script_path`
+cd $script_dir
+
+# Ensure build.xml exists before starting
+if [[ ! -f build.xml ]]; then
+    echo 'Ant build.xml file not found! Check that you are in the right directory.'
+    exit 9
+fi
+
+# Copy base classes from wlauto dist
+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
+
+# Build and return appropriate exit code if failed
+ant build
+exit_code=$?
+if [[ $exit_code -ne 0 ]]; then
+    echo "ERROR: 'ant build' exited with code $exit_code"
+    exit $exit_code
+fi
+
+# If successful move JAR file to workload folder (remove previous)
+package=com.arm.wlauto.uiauto.googleslides.jar
+rm -f ../$package
+if [[ -f bin/$package ]]; then
+    cp bin/$package ..
+else
+    echo 'ERROR: UiAutomator JAR could not be found!'
+    exit 9
+fi

wlauto/workloads/googleslides/uiauto/build.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="com.arm.wlauto.uiauto.googleslides" 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/googleslides/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/googleslides/uiauto/src/com/arm/wlauto/uiauto/UiAutomation.java

@@ -0,0 +1,155 @@
+package com.arm.wlauto.uiauto.googleslides;
+
+import java.io.File;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+import android.app.Activity;
+import android.content.Context;
+import android.net.wifi.WifiManager;
+import android.os.Bundle;
+import android.util.Log;
+import android.view.KeyEvent;
+
+// 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;
+
+public class UiAutomation extends UxPerfUiAutomation {
+
+    public static String TAG = "googleslides";
+    public static final String PACKAGE = "com.google.android.apps.docs.editors.slides";
+    public static final String PACKAGE_ID = PACKAGE + ":id/";
+
+    public static final String CLASS_TEXT_VIEW = "android.widget.TextView";
+    public static final String CLASS_IMAGE_VIEW = "android.widget.ImageView";
+    public static final String CLASS_BUTTON = "android.widget.Button";
+    public static final String CLASS_IMAGE_BUTTON = "android.widget.ImageButton";
+    public static final String CLASS_TABLE_ROW = "android.widget.TableRow";
+
+    public Bundle parameters;
+    private Map<String, Timer> results = new LinkedHashMap<String, Timer>();
+    private boolean dumpsysEnabled;
+    private String outputDir;
+
+    public static final int DOCTYPE_TEMPLATE = 1;
+    public static final int DOCTYPE_PPT = 2;
+    public static final int DOCTYPE_SLIDES = 3;
+
+    public void runUiAutomation() throws Exception {
+        parameters = getParams();
+        parseParams(parameters);
+        skipWelcomeScreen();
+        enablePowerpointCompat();
+        if (false) { // TODO currently unused
+            openFromStorage();
+        }
+        createNewDoc(DOCTYPE_TEMPLATE);
+        setWifiStatus(false);
+        tapDisplayNormalised(0.99, 0.99);
+        sleep(5);
+        if (false) { // TODO currently unused
+            writeResultsToFile(results, parameters.getString("results_file"));
+        }
+    }
+
+    public void parseParams(Bundle parameters) throws Exception {
+        dumpsysEnabled = Boolean.parseBoolean(parameters.getString("dumpsys_enabled"));
+        outputDir = parameters.getString("output_dir", "/sdcard/wa-working");
+    }
+
+    private void skipWelcomeScreen() throws Exception {
+        UiObject skipButton = getUiObjectByText("Skip", CLASS_BUTTON);
+        skipButton.clickAndWaitForNewWindow();
+        sleep(1);
+    }
+
+    private void enablePowerpointCompat() throws Exception {
+        uiDeviceEdgeSwipeFromLeft(10);
+        UiObject settings = getUiObjectByText("Settings", CLASS_TEXT_VIEW);
+        settings.clickAndWaitForNewWindow();
+        UiObject checkboxRow = getUiObjectByText("Create PowerPoint", CLASS_TEXT_VIEW);
+        checkboxRow.click();
+        getUiDevice().pressBack();
+        sleep(1);
+    }
+
+    private void openFromStorage() throws Exception {
+        // UiObject newButton = getUiObjectByResourceId(PACKAGE_ID + "menu_open_with_picker", CLASS_TEXT_VIEW);
+        UiObject openButton = getUiObjectByDescription("Open presentation", CLASS_TEXT_VIEW);
+        openButton.click();
+        openButton = getUiObjectByText("Device storage", CLASS_TEXT_VIEW);
+        openButton.clickAndWaitForNewWindow();
+        getUiDevice().pressBack();
+        sleep(1);
+    }
+
+    private void createNewDoc(int docType) throws Exception {
+        // UiObject newButton = getUiObjectByResourceId(PACKAGE_ID + "fab_base_button", CLASS_IMAGE_BUTTON);
+        UiObject newButton = getUiObjectByDescription("New presentation", CLASS_IMAGE_BUTTON);
+        newButton.click();
+
+        UiObject newPowerpoint = getUiObjectByDescription("New PowerPoint", CLASS_IMAGE_BUTTON);
+        UiObject newSlidesFile = getUiObjectByDescription("New Slides", CLASS_IMAGE_BUTTON);
+        UiObject fromTemplate = getUiObjectByDescription("Choose template", CLASS_IMAGE_BUTTON);
+        // UiObject newPowerpoint = getUiObjectByText("New PowerPoint", CLASS_TEXT_VIEW);
+        // UiObject newSlidesFile = getUiObjectByText("New Slides", CLASS_TEXT_VIEW);
+        // UiObject fromTemplate = getUiObjectByText("Choose template", CLASS_TEXT_VIEW);
+
+        switch (docType) {
+            case DOCTYPE_TEMPLATE:
+                fromTemplate.clickAndWaitForNewWindow();
+                break;
+            case DOCTYPE_PPT:
+                newPowerpoint.clickAndWaitForNewWindow();
+                break;
+            case DOCTYPE_SLIDES:
+            default:
+                newSlidesFile.clickAndWaitForNewWindow();
+                break;
+        }
+        sleep(1);
+        getUiDevice().pressBack();
+    }
+
+    public void uiDeviceEdgeSwipeFromLeft(int steps) {
+        int height = getDisplayHeight();
+        int width = getDisplayWidth();
+        getUiDevice().swipe(0, height/2, width/2, height/2, steps);
+    }
+
+    public void tapDisplayNormalised(double percentX, double percentY) {
+        double x = Math.max(0, Math.min(1, percentX));
+        double y = Math.max(0, Math.min(1, percentY));
+        int tapX = (int) Math.floor(x * getDisplayWidth());
+        int tapY = (int) Math.floor(y * getDisplayHeight());
+        getUiDevice().click(tapX, tapY);
+    }
+
+    public void setWifiStatus(boolean flag) throws Exception {
+        // To enable, check for "UninitializedState"
+        String checkFor = flag ? "UninitializedState" : "ConnectedState";
+        String adbCommand =
+              "dumpsys wifi | grep curState=" + checkFor + ";"
+            + "exit_code=$?;"
+            + "if [ $exit_code = 0 ]; then"
+            + "    am start -a android.intent.action.MAIN -n com.android.settings/.wifi.WifiSettings;"
+            + "    input keyevent 20;"
+            + "    input keyevent 23;"
+            + "    sleep 1;"
+            + "    input keyevent 4;"
+            + "fi";
+        // runShellCommand(adbCommand);
+        runShellCommand("dumpsys wifi | grep curState=ConnectedState");
+        sleep(1);
+    }
+
+    public void runShellCommand(String command) throws Exception {
+        Process proc = Runtime.getRuntime().exec(command);
+    }
+}