sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-11-04 09:02:12 +00:00
Code Issues Releases Wiki Activity

Reader productivity workload

Browse Source 
A new workload to perform standard productivity tasks within Reader. Each user event/step is timed and reported back as a metric.  Dumpsys also captures SurfaceFlinger logs for each event for post analysis.
This commit is contained in:
James Hartley
2016-04-28 13:13:36 +01:00
parent cc2280a317
commit b0d0a19bf0
6 changed files with 610 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
wlauto/workloads/reader/__init__.py Executable file
View File

@@ -0,0 +1,93 @@
import os
import logging
import re
import time
from wlauto import AndroidUiAutoBenchmark, Parameter
class Reader(AndroidUiAutoBenchmark):
activity = 'com.adobe.reader.AdobeReader'
name = 'reader'
package = 'com.adobe.reader'
view = [package+'/com.adobe.reader.help.AROnboardingHelpActivity',
package+'/com.adobe.reader.viewer.ARSplitPaneActivity',
package+'/com.adobe.reader.viewer.ARViewerActivity']
description = """
A workload to perform standard productivity tasks within Adobe Reader.
The workload carries out various tasks, such as opening PDF documents,
scrolling and searching through them, whilst also producing metrics for
action completion times.
"""
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.
"""),
Parameter('email', kind=str, default="email@gmail.com",
description="""
Email account used to register with Adobe online services.
"""),
Parameter('password', kind=str, default="password",
description="""
Password for Adobe online services.
"""),
]
instrumentation_log = ''.join([name, '_instrumentation.log'])
def validate(self):
super(Reader, 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['email'] = self.email
self.uiauto_params['password'] = self.password
self.uiauto_params['dumpsys_enabled'] = self.dumpsys_enabled
def setup(self, context):
super(Reader, self).setup(context)
self.reader_local_dir = self.device.path.join(self.device.external_storage_directory,
'Android/data/com.adobe.reader/files/')
for file in os.listdir(self.dependencies_directory):
if file.endswith(".pdf"):
self.device.push_file(os.path.join(self.dependencies_directory, file),
os.path.join(self.reader_local_dir, file), timeout=300)
def update_result(self, context):
super(Reader, 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(Reader, self).teardown(context)
for file in self.device.listdir(self.reader_local_dir):
if file.endswith(".pdf"):
self.device.delete_file(os.path.join(self.reader_local_dir, file))
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))

BIN
wlauto/workloads/reader/com.arm.wlauto.uiauto.reader.jar Normal file
View File

Binary file not shown.

12
wlauto/workloads/reader/uiauto/build.sh Executable file
View File

@@ -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.reader.jar ]]; then
cp bin/com.arm.wlauto.uiauto.reader.jar ..
fi

92
wlauto/workloads/reader/uiauto/build.xml Normal file
View File

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

14
wlauto/workloads/reader/uiauto/project.properties Normal file
View File

@@ -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-21

399
wlauto/workloads/reader/uiauto/src/com/arm/wlauto/uiauto/UiAutomation.java Executable file
View File

@@ -0,0 +1,399 @@
package com.arm.wlauto.uiauto.reader;
import android.graphics.Rect;
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.core.UiCollection;
import com.android.uiautomator.testrunner.UiAutomatorTestCase;
import com.arm.wlauto.uiauto.UxPerfUiAutomation;
import java.io.File;
import java.io.FileWriter;
import java.io.BufferedWriter;
import java.util.concurrent.TimeUnit;
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_reader";
private Bundle parameters;
private long networkTimeout = TimeUnit.SECONDS.toMillis(20);
private long searchTimeout = TimeUnit.SECONDS.toMillis(20);
private LinkedHashMap<String, Timer> timingResults = new LinkedHashMap<String, Timer>();
public void runUiAutomation() throws Exception {
Timer result = new Timer();
result.start();
parameters = getParams();
dismissWelcomeView();
signInOnline(parameters);
confirmLocalFileAccess();
gesturesTest("Getting Started.pdf");
String [] searchStrings = {"Glossary", "cortex"};
searchPdfTest("cortex_m4", searchStrings);
result.end();
timingResults.put("Total", result);
writeResultsToFile(timingResults, parameters.getString("output_file"));
}
private void dismissWelcomeView() throws Exception {
UiObject welcomeView = getUiObjectByDescription("Acrobat - First Time Experience",
"android.webkit.WebView");
// Click through the first two pages and wait for pages to transition.
// These pages are webkit views so clickAndWaitForNewWindow or waitForExists cannot be used
tapDisplayCentre();
sleep(1);
tapDisplayCentre();
sleep(1);
// Get the box coords for the webView window
Rect webViewCoords = welcomeView.getBounds();
// Iterate up from the bottom middle of the webView until we hit these
// Continue button and change view
int i = 0;
do {
i += 10;
tapDisplay(webViewCoords.centerX(), webViewCoords.bottom - i);
} while ( welcomeView.exists() || i < webViewCoords.top );
}
private void signInOnline(Bundle parameters) throws Exception {
String email = parameters.getString("email");
String password = parameters.getString("password");
UiObject homeButton = getUiObjectByResourceId("android:id/home", "android.widget.ImageView");
homeButton.clickAndWaitForNewWindow();
UiObject firstSignInButton = getUiObjectByResourceId("com.adobe.reader:id/user_info_title",
"android.widget.TextView");
firstSignInButton.clickAndWaitForNewWindow();
// resourceId cannot be trusted across different devices in this view so use description
// and indexes instead
UiObject secondSignInButton = getUiObjectByDescription("Sign In", "android.view.View");
secondSignInButton.clickAndWaitForNewWindow();
UiObject emailBox = new UiObject(new UiSelector().className("android.webkit.WebView")
.description("Sign in - Adobe ID")
.childSelector(new UiSelector()
.index(0).className("android.view.View")
.childSelector(new UiSelector()
.index(1).className("android.view.View")
.childSelector(new UiSelector()
.index(0).className("android.view.View")
.childSelector(new UiSelector()
.index(0).className("android.widget.EditText"))))));
emailBox.setText(email);
UiObject passwordBox = new UiObject(new UiSelector().className("android.webkit.WebView")
.description("Sign in - Adobe ID")
.childSelector(new UiSelector()
.index(0).className("android.view.View")
.childSelector(new UiSelector()
.index(1).className("android.view.View")
.childSelector(new UiSelector()
.index(1).className("android.view.View")
.childSelector(new UiSelector()
.index(0).className("android.widget.EditText"))))));
passwordBox.setText(password);
UiObject lastSignInButton = new UiObject(new UiSelector().className("android.webkit.WebView")
.description("Sign in - Adobe ID")
.childSelector(new UiSelector()
.index(0).className("android.view.View")
.childSelector(new UiSelector()
.index(1).className("android.view.View")
.childSelector(new UiSelector()
.index(3).className("android.view.View")
.childSelector(new UiSelector()
.index(0).className("android.widget.Button"))))));
lastSignInButton.clickAndWaitForNewWindow();
UiObject upButton = new UiObject(new UiSelector().resourceId("android:id/up")
.className("android.widget.ImageView"));
if (upButton.waitForExists(TimeUnit.SECONDS.toMillis(networkTimeout))) {
upButton.clickAndWaitForNewWindow();
}
}
private void confirmLocalFileAccess() throws Exception {
// First time run requires confirmation to allow access to local files
UiObject allowButton = new UiObject(new UiSelector().textContains("Allow")
.className("android.widget.Button"));
if (allowButton.waitForExists(timeout)) {
allowButton.clickAndWaitForNewWindow(timeout);
};
}
private void openFile(String filename) throws Exception {
// Replace whitespace and full stops within the filename
String file = filename.replaceAll("\\.", "_").replaceAll("\\s+", "_");
timingResults.put(String.format("selectLocalFilesList" + "_" + file), selectLocalFilesList());
timingResults.put(String.format("selectSearchDuration" + "_" + file), selectSearchFileButton());
timingResults.put(String.format("searchFileList" + "_" + file), searchFileList(filename));
timingResults.put(String.format("openFileFromList" + "_" + file), openFileFromList(filename));
// Cludge to get rid of the first time run help dialogue boxes
tapDisplayCentre();
sleep(1);
tapDisplayCentre();
sleep(1);
}
private Timer selectLocalFilesList() throws Exception {
// Select the local files list from the My Documents view
UiObject localButton = getUiObjectByText("LOCAL", "android.widget.TextView");
Timer result = new Timer();
result.start();
localButton.clickAndWaitForNewWindow(timeout);
long finish = SystemClock.elapsedRealtime();
result.end();
return result;
}
private Timer selectSearchFileButton() throws Exception {
// Click the button to search from the present file list view
UiObject searchButton = getUiObjectByResourceId("com.adobe.reader:id/split_pane_search",
"android.widget.TextView");
Timer result = new Timer();
result.start();
searchButton.click();
long finish = SystemClock.elapsedRealtime();
result.end();
return result;
}
private Timer searchFileList(String searchText) throws Exception {
// Enter search text into the file searchBox. This will automatically filter the list.
UiObject searchBox = getUiObjectByResourceId("android:id/search_src_text",
"android.widget.EditText");
Timer result = new Timer();
result.start();
searchBox.setText(searchText);
long finish = SystemClock.elapsedRealtime();
result.end();
return result;
}
private Timer openFileFromList(String file) throws Exception {
// Open a file from a file list view by searching for UiObjects containing the doc title.
UiObject fileObject = getUiObjectByText(file, "android.widget.TextView");
Timer result = new Timer();
result.start();
fileObject.clickAndWaitForNewWindow(timeout);
result.end();
// Wait for the doc to open by waiting for the viewPager UiObject to exist
UiObject viewPager = new UiObject(new UiSelector().resourceId("com.adobe.reader:id/viewPager"));
if (!viewPager.waitForExists(timeout)) {
throw new UiObjectNotFoundException("Could not find \"viewPager\".");
};
return result;
}
private class GestureTestParams {
GestureType gestureType;
Direction gestureDirection;
PinchType pinchType;
int percent;
int steps;
GestureTestParams(GestureType gesture, Direction direction, int steps) {
this.gestureType = gesture;
this.gestureDirection = direction;
this.pinchType = PinchType.NULL;
this.steps = steps;
this.percent = 0;
}
GestureTestParams(GestureType gesture, PinchType pinchType, int steps, int percent) {
this.gestureType = gesture;
this.gestureDirection = Direction.NULL;
this.pinchType = pinchType;
this.steps = steps;
this.percent = percent;
}
}
private void gesturesTest (String filename) throws Exception {
String TestTag = "gestures";
// Perform a range of swipe tests at different speeds and on different views
LinkedHashMap<String, GestureTestParams> testParams = new LinkedHashMap<String, GestureTestParams>();
testParams.put("1", new GestureTestParams(GestureType.UIDEVICE_SWIPE, Direction.DOWN, 100));
testParams.put("2", new GestureTestParams(GestureType.UIDEVICE_SWIPE, Direction.UP, 100));
testParams.put("3", new GestureTestParams(GestureType.UIOBJECT_SWIPE, Direction.RIGHT, 50));
testParams.put("4", new GestureTestParams(GestureType.UIOBJECT_SWIPE, Direction.LEFT, 50));
testParams.put("5", new GestureTestParams(GestureType.PINCH, PinchType.OUT, 100, 200));
testParams.put("6", new GestureTestParams(GestureType.PINCH, PinchType.IN, 100, 50));
Iterator<Entry<String, GestureTestParams>> it = testParams.entrySet().iterator();
openFile(filename);
while (it.hasNext()) {
Map.Entry<String, GestureTestParams> pair = it.next();
GestureType type = pair.getValue().gestureType;
Direction dir = pair.getValue().gestureDirection;
PinchType pinch = pair.getValue().pinchType;
int steps = pair.getValue().steps;
int percent = pair.getValue().percent;
String runName = String.format(TestTag + "_" + pair.getKey());
String gfxInfologName = String.format(TAG + "_" + runName + "_gfxInfo.log");
String surfFlingerlogName = String.format(runName + "_surfFlinger.log");
String viewName = new String("com.adobe.reader.viewer.ARViewerActivity");
UiObject view = new UiObject(new UiSelector().resourceId("com.adobe.reader:id/viewPager"));
startDumpsysGfxInfo();
startDumpsysSurfaceFlinger(viewName);
Timer results = new Timer();
switch (type) {
case UIDEVICE_SWIPE:
results = uiDeviceSwipeTest(dir, steps);
break;
case UIOBJECT_SWIPE:
results = uiObjectSwipeTest(view, dir, steps);
break;
case PINCH:
results = uiObjectPinchTest(view, pinch, steps, percent);
break;
default:
break;
}
stopDumpsysSurfaceFlinger(viewName, surfFlingerlogName);
stopDumpsysGfxInfo(gfxInfologName);
timingResults.put(runName, results);
}
exitDocument();
}
private void searchPdfTest (String filename, String [] searchStrings) throws Exception {
String TestTag = "search";
openFile(filename);
// Get the page view for the opened document which we can use for pinch actions
UiObject pageView = getUiObjectByResourceId("com.adobe.reader:id/pageView",
"android.widget.RelativeLayout");
for ( int i=0; i < searchStrings.length; i++) {
timingResults.put(String.format(TestTag + "_" + i),
searchTest(searchStrings[i]));
}
exitDocument();
}
private Timer searchTest(String searchText) throws Exception {
// Click on the search button icon and enter text in the box. This closes the keyboad
// so click the box again and press Enter to start the search.
UiObject searchButton = getUiObjectByResourceId("com.adobe.reader:id/document_view_search_icon",
"android.widget.TextView");
searchButton.clickAndWaitForNewWindow();
UiObject searchBox = getUiObjectByResourceId("android:id/search_src_text",
"android.widget.EditText");
searchBox.setText(searchText);
searchBox.click();
Timer result = new Timer();
result.start();
getUiDevice().getInstance().pressEnter();
// Check the progress bar icon. When this disappears the search is complete.
UiObject progressBar = new UiObject(new UiSelector().resourceId("com.adobe.reader:id/searchProgress")
.className("android.widget.ProgressBar"));
progressBar.waitForExists(timeout);
progressBar.waitUntilGone(searchTimeout);
result.end();
// Get back to the main document view by clicking twice on the close button
UiObject searchCloseButton = getUiObjectByResourceId("android:id/search_close_btn",
"android.widget.ImageView");
searchCloseButton.clickAndWaitForNewWindow();
searchCloseButton.clickAndWaitForNewWindow();
return result;
}
private void exitDocument() throws Exception {
// Return from the document view to the file list view by pressing home and my documents.
UiObject homeButton = new UiObject(new UiSelector().resourceId("android:id/home")
.className("android.widget.ImageView"));
if (!homeButton.waitForExists(timeout)) {
tapDisplayCentre();
}
homeButton.clickAndWaitForNewWindow();
UiObject myDocsButton = getUiObjectByDescription("My Documents", "android.widget.LinearLayout" );
myDocsButton.clickAndWaitForNewWindow();
UiObject upButton = getUiObjectByResourceId("android:id/up", "android.widget.ImageView" );
upButton.clickAndWaitForNewWindow();
}
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();
}
private void startDumpsysSurfaceFlinger(String view) {
if (Boolean.parseBoolean(parameters.getString("dumpsys_enabled"))) {
initDumpsysSurfaceFlinger(parameters.getString("package"), view);
}
}
private void stopDumpsysSurfaceFlinger(String view, String filename) throws Exception {
if (Boolean.parseBoolean(parameters.getString("dumpsys_enabled"))) {
File out_file = new File(parameters.getString("output_dir"), filename);
exitDumpsysSurfaceFlinger(parameters.getString("package"), view, out_file);
}
}
private void startDumpsysGfxInfo() {
if (Boolean.parseBoolean(parameters.getString("dumpsys_enabled"))) {
initDumpsysGfxInfo(parameters.getString("package"));
}
}
private void stopDumpsysGfxInfo(String filename) throws Exception {
if (Boolean.parseBoolean(parameters.getString("dumpsys_enabled"))) {
File out_file = new File(parameters.getString("output_dir"), filename);
exitDumpsysGfxInfo(parameters.getString("package"), out_file);
}
}
}