workloads/chrome: Add chrome workload

wa/workloads/chrome/__init__.py

@@ -0,0 +1,74 @@
+from wa import Parameter, ApkUiautoWorkload
+
+
+class Chrome(ApkUiautoWorkload):
+
+    name = 'chrome'
+    description = '''
+    A workload to perform standard Web browsing tasks with Google Chrome. The workload carries
+    out a number of typical Web-based tasks, navigating through a handful of Wikipedia pages
+    in multiple browser tabs.
+
+    To run the workload in offline mode, a 'pages.tar' archive and an 'OfflinePages.db' file
+    are required. For users wishing to generate these files themselves, Chrome should first be
+    operated from an Internet-connected environment and the following Wikipedia pages should be
+    downloaded for offline use within Chrome:
+
+    - https://en.m.wikipedia.org/wiki/Main_Page
+    - https://en.m.wikipedia.org/wiki/United_States
+    - https://en.m.wikipedia.org/wiki/California
+
+    Following this, the files of interest for viewing these pages offline can be found in the
+    '/data/data/com.android.chrome/app_chrome/Default/Offline Pages' directory. The 'OfflinePages.db'
+    file can be copied from the 'metadata' subdirectory, while the ``*.mhtml`` files that should make
+    up the 'pages.tar' file can be found in the 'archives' subdirectory. These page files can then be
+    archived to produce a tarball using a command such as ``tar -cvf pages.tar -C /path/to/archives .``.
+    Both this and 'OfflinePages.db' should then be placed in the '~/.workload_automation/dependencies/chrome/'
+    directory on your local machine, creating this if it does not already exist.
+
+    Known working APK version: 65.0.3325.109
+    '''
+    package_names = ['com.android.chrome']
+
+    parameters = [
+        Parameter('offline_mode', kind=bool, default=False, description='''
+                  If set to ``True``, the workload will execute in offline mode.
+                  This mode requires root and makes use of a tarball of *.mhtml
+                  files 'pages.tar' and an metadata database 'OfflinePages.db'.
+                  The tarball is extracted directly to the application's offline
+                  pages 'archives' directory, while the database is copied to the
+                  offline pages 'metadata' directory.
+                  '''),
+    ]
+
+    @property
+    def requires_network(self):
+        return not self.offline_mode
+
+    @property
+    def requires_rerun(self):
+        # In offline mode we need to restart the application after modifying its data directory
+        return self.offline_mode
+
+    def __init__(self, target, **kwargs):
+        super(Chrome, self).__init__(target, **kwargs)
+        if self.offline_mode:
+            self.deployable_assets = ['pages.tar', 'OfflinePages.db']
+            self.clean_assets = True
+
+    def initialize(self, context):
+        super(Chrome, self).initialize(context)
+        if self.offline_mode and not self.target.is_rooted:
+            raise WorkloadError('This workload requires root to set up Chrome for offline usage.')
+
+    def setup_rerun(self):
+        super(Chrome, self).setup_rerun()
+        offline_pages = self.target.path.join(self.target.package_data_directory, self.package, 'app_chrome', 'Default', 'Offline\ Pages')
+        metadata_src = self.target.path.join(self.target.working_directory, 'OfflinePages.db')
+        metadata_dst = self.target.path.join(offline_pages, 'metadata')
+        archives_src = self.target.path.join(self.target.working_directory, 'pages.tar')
+        archives_dst = self.target.path.join(offline_pages, 'archives')
+        owner = self.target.execute("{} stat -c '%u' {}".format(self.target.busybox, offline_pages), as_root=True).strip()
+        self.target.execute('{} tar -xvf {} -C {}'.format(self.target.busybox, archives_src, archives_dst), as_root=True)
+        self.target.execute('{} cp {} {}'.format(self.target.busybox, metadata_src, metadata_dst), as_root=True)
+        self.target.execute('{} chown -R {}:{} {}'.format(self.target.busybox, owner, owner, offline_pages), as_root=True)

wa/workloads/chrome/uiauto/app/build.gradle

@@ -0,0 +1,33 @@
+apply plugin: 'com.android.application'
+
+android {
+    compileSdkVersion 18
+    buildToolsVersion '25.0.0'
+    defaultConfig {
+        applicationId "com.arm.wa.uiauto.chrome"
+        minSdkVersion 18
+        targetSdkVersion 25
+        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        applicationVariants.all { variant ->
+            variant.outputs.each { output ->
+                output.outputFile = file("$project.buildDir/apk/com.arm.wa.uiauto.chrome.apk")
+            }
+        }
+    }
+}
+
+dependencies {
+    compile fileTree(include: ['*.jar'], dir: 'libs')
+    compile 'com.android.support.test:runner:0.5'
+    compile 'com.android.support.test:rules:0.5'
+    compile 'com.android.support.test.uiautomator:uiautomator-v18:2.1.2'
+    compile(name: 'uiauto', ext: 'aar')
+}
+
+repositories {
+    flatDir {
+        dirs 'libs'
+    }
+}

wa/workloads/chrome/uiauto/app/src/main/AndroidManifest.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.arm.wa.uiauto.chrome"
+    android:versionCode="1"
+    android:versionName="1.0">
+
+
+    <instrumentation
+        android:name="android.support.test.runner.AndroidJUnitRunner"
+        android:targetPackage="com.arm.wa.uiauto.chrome"/>
+
+</manifest>

wa/workloads/chrome/uiauto/app/src/main/java/com/arm/wa/uiauto/UiAutomation.java

@@ -0,0 +1,162 @@
+package com.arm.wa.uiauto.chrome;
+
+import android.app.Activity;
+import android.os.Bundle;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import android.support.test.runner.AndroidJUnit4;
+
+import android.util.Log;
+import android.view.KeyEvent;
+
+import android.support.test.uiautomator.UiObject;
+import android.support.test.uiautomator.UiObjectNotFoundException;
+import android.support.test.uiautomator.UiScrollable;
+import android.support.test.uiautomator.UiSelector;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import com.arm.wa.uiauto.ApplaunchInterface;
+import com.arm.wa.uiauto.BaseUiAutomation;
+import com.arm.wa.uiauto.UiAutoUtils;
+
+@RunWith(AndroidJUnit4.class)
+public class UiAutomation extends BaseUiAutomation implements ApplaunchInterface {
+
+    protected Bundle parameters;
+    protected String packageID;
+
+    public static String TAG = "chrome";
+
+    @Before
+    public void initialize() throws Exception {
+        parameters = getParams();
+        packageID = getPackageID(parameters);
+    }
+
+    @Test
+    public void setup() throws Exception {
+        setScreenOrientation(ScreenOrientation.NATURAL);
+        runApplicationSetup();
+    }
+
+    public void navigateToPage(String url, boolean from_new_tab) throws Exception {
+        UiObject searchBar, urlBar;
+
+        if (from_new_tab) {
+                // On the new tab page, click on the search box to turn it into a url bar
+                searchBar = mDevice.findObject(new UiSelector().resourceId(packageID + "search_box_text")
+                                                               .className("android.widget.EditText"));
+                searchBar.click();
+        }
+
+        // Navigate to the specified URL
+        urlBar = mDevice.findObject(new UiSelector().resourceId(packageID + "url_bar")
+                                                    .className("android.widget.EditText"));
+        urlBar.click();
+        urlBar.setText(url);
+        pressEnter();
+    }
+
+    public void newTab() throws Exception {
+        UiObject tabSwitcher, newTab;
+
+        // Activate the tab switcher
+        tabSwitcher = mDevice.findObject(new UiSelector().resourceId(packageID + "tab_switcher_button")
+                                                         .className("android.widget.ImageButton"));
+        tabSwitcher.clickAndWaitForNewWindow(uiAutoTimeout);
+
+        // Click the New Tab button
+        newTab = mDevice.findObject(new UiSelector().resourceId(packageID + "new_tab_button")
+                                                    .className("android.widget.Button"));
+        newTab.clickAndWaitForNewWindow(uiAutoTimeout);
+    }
+
+    public void followTextLink(String text) throws Exception {
+        UiObject link = mDevice.findObject(new UiSelector().text(text).clickable(true));
+        link.waitForExists(uiAutoTimeout);
+        link.clickAndWaitForNewWindow();
+    }
+
+    @Test
+    public void runWorkload() throws Exception {
+        // Initial browsing within a single tab
+        navigateToPage("https://en.m.wikipedia.org/wiki/Main_Page", true);
+        uiDeviceSwipeUp(100);
+        sleep(1);
+        uiDeviceSwipeUp(100);
+        sleep(1);
+        uiDeviceSwipeUp(250);
+        sleep(1);
+        uiDeviceSwipeDown(100);
+        navigateToPage("https://en.m.wikipedia.org/wiki/United_States", false);
+        uiDeviceSwipeUp(100);
+        sleep(1);
+        uiDeviceSwipeUp(250);
+        sleep(1);
+        uiDeviceSwipeDown(100);
+
+        // URL entry and link navigation within a new tab
+        newTab();
+        navigateToPage("https://en.m.wikipedia.org/wiki/California", true);
+        sleep(2);
+        followTextLink("United States");
+        uiDeviceSwipeDown(50);
+        sleep(1);
+        uiDeviceSwipeUp(10);
+        sleep(3);
+
+        // Pinch to zoom, scroll around
+        UiObject webView = mDevice.findObject(new UiSelector().className("android.webkit.WebView"));
+        uiObjectVertPinchOut(webView, 100, 50);
+        uiDeviceSwipeUp(300);
+        sleep(1);
+        uiObjectVertPinchIn(webView, 100, 50);
+        uiDeviceSwipeUp(100);
+        sleep(1);
+        uiDeviceSwipeUp(100);
+        sleep(3);
+
+        // Go back a page
+        pressBack();
+    }
+
+    @Test
+    public void teardown() throws Exception {
+        unsetScreenOrientation();
+    }
+
+    public void runApplicationSetup() throws Exception {
+        UiObject sendReportBox;
+        UiObject acceptButton, noThanksButton;
+
+        sendReportBox = mDevice.findObject(new UiSelector().resourceId(packageID + "send_report_checkbox")
+                                                           .className("android.widget.CheckBox"));
+        sendReportBox.click();
+
+        acceptButton = mDevice.findObject(new UiSelector().resourceId(packageID + "terms_accept")
+                                                          .className("android.widget.Button"));
+        acceptButton.clickAndWaitForNewWindow(uiAutoTimeout);
+
+        noThanksButton = mDevice.findObject(new UiSelector().resourceId(packageID + "negative_button")
+                                                            .className("android.widget.Button"));
+        noThanksButton.clickAndWaitForNewWindow(uiAutoTimeout);
+    }
+
+    public UiObject getLaunchEndObject() {
+        UiObject launchEndObject = mDevice.findObject(new UiSelector().className("android.widget.EditText"));
+        return launchEndObject;
+    }
+
+    public String getLaunchCommand() {
+        String launch_command = UiAutoUtils.createLaunchCommand(parameters);
+        return launch_command;
+    }
+
+    public void setWorkloadParameters(Bundle workload_parameters) {
+        parameters = workload_parameters;
+        packageID = getPackageID(parameters);
+    }
+}

wa/workloads/chrome/uiauto/build.gradle

@@ -0,0 +1,23 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+
+buildscript {
+    repositories {
+        jcenter()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:2.3.1'
+
+        // NOTE: Do not place your application dependencies here; they belong
+        // in the individual module build.gradle files
+    }
+}
+
+allprojects {
+    repositories {
+        jcenter()
+    }
+}
+
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}

wa/workloads/chrome/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 gradelw exists before starting
+if [[ ! -f gradlew ]]; then
+    echo 'gradlew file not found! Check that you are in the right directory.'
+    exit 9
+fi
+
+# Copy base class library from wlauto dist
+libs_dir=app/libs
+base_class=`python -c "import os, wa; print os.path.join(os.path.dirname(wa.__file__), 'framework', 'uiauto', 'uiauto.aar')"`
+mkdir -p $libs_dir
+cp $base_class $libs_dir
+
+# Build and return appropriate exit code if failed
+# gradle build
+./gradlew clean :app:assembleDebug
+exit_code=$?
+if [[ $exit_code -ne 0 ]]; then
+    echo "ERROR: 'gradle build' exited with code $exit_code"
+    exit $exit_code
+fi
+
+# If successful move APK file to workload folder (overwrite previous)
+rm -f ../com.arm.wa.uiauto.chrome
+if [[ -f app/build/apk/com.arm.wa.uiauto.chrome.apk ]]; then
+    cp app/build/apk/com.arm.wa.uiauto.chrome.apk ../com.arm.wa.uiauto.chrome.apk
+else
+    echo 'ERROR: UiAutomator apk could not be found!'
+    exit 9
+fi

wa/workloads/chrome/uiauto/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Wed May 03 15:42:44 BST 2017
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip

wa/workloads/chrome/uiauto/gradlew

@@ -0,0 +1,160 @@
+#!/usr/bin/env bash
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn ( ) {
+    echo "$*"
+}
+
+die ( ) {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+esac
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
+function splitJvmOpts() {
+    JVM_OPTS=("$@")
+}
+eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
+JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
+
+exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"

wa/workloads/chrome/uiauto/gradlew.bat

@@ -0,0 +1,90 @@
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS=
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto init
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto init
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:init
+@rem Get command-line arguments, handling Windowz variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+if "%@eval[2+2]" == "4" goto 4NT_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+goto execute
+
+:4NT_args
+@rem Get arguments from the 4NT Shell from JP Software
+set CMD_LINE_ARGS=%$
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

wa/workloads/chrome/uiauto/settings.gradle

@@ -0,0 +1 @@
+include ':app'