GooglePlayBooks: Ported workload from WA2

wa/workloads/googleplaybooks/__init__.py

@@ -0,0 +1,100 @@
+#    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.
+#
+
+from wa import ApkUiautoWorkload, Parameter
+
+
+class Googleplaybooks(ApkUiautoWorkload):
+
+    name = 'googleplaybooks'
+    package_names = ['com.google.android.apps.books']
+
+    description = '''
+    A workload to perform standard productivity tasks with googleplaybooks.
+    This workload performs various tasks, such as searching for a book title
+    online, browsing through a book, adding and removing notes, word searching,
+    and querying information about the book.
+
+    Test description:
+    1. Open Google Play Books application
+    2. Dismisses sync operation (if applicable)
+    3. Searches for a book title
+    4. Adds books to library if not already present
+    5. Opens 'My Library' contents
+    6. Opens selected book
+    7. Gestures are performed to swipe between pages and pinch zoom in and out of a page
+    8. Selects a specified chapter based on page number from the navigation view
+    9. Selects a word in the centre of screen and adds a test note to the page
+    10. Removes the test note from the page (clean up)
+    11. Searches for the number of occurrences of a common word throughout the book
+    12. Switches page styles from 'Day' to 'Night' to 'Sepia' and back to 'Day'
+    13. Uses the 'About this book' facility on the currently selected book
+
+    NOTE: This workload requires a network connection (ideally, wifi) to run,
+          a Google account to be setup on the device, and payment details for the account.
+          Free books require payment details to have been setup otherwise it fails.
+          Tip: Install the 'Google Opinion Rewards' app to bypass the need to enter valid
+          card/bank detail.
+
+    Known working APK version: 3.13.17
+    '''
+
+    parameters = [
+        Parameter('search_book_title', kind=str, default='Nikola Tesla: Imagination and the Man That Invented the 20th Century',
+                  description="""
+                  The book title to search for within Google Play Books archive.
+                  The book must either be already in the account's library, or free to purchase.
+                  """),
+        Parameter('library_book_title', kind=str, default='Nikola Tesla',
+                  description="""
+                  The book title to search for within My Library.
+                  The Library name can differ (usually shorter) to the Store name.
+                  If left blank, the ``search_book_title`` will be used.
+                  """),
+        Parameter('select_chapter_page_number', kind=int, default=4,
+                  description="""
+                  The Page Number to search for within a selected book's Chapter list.
+                  Note: Accepts integers only.
+                  """),
+        Parameter('search_word', kind=str, default='the',
+                  description="""
+                  The word to search for within a selected book.
+                  Note: Accepts single words only.
+                  """),
+        Parameter('account', kind=str, mandatory=False,
+                  description="""
+                  If you are running this workload on a device which has more than one
+                  Google account setup, then this parameter is used to select which account
+                  to select when prompted.
+                  The account requires the book to have already been purchased or payment details
+                  already associated with the account.
+                  If omitted, the first account in the list will be selected if prompted.
+                  """),
+    ]
+
+    # This workload relies on the internet so check that there is a working
+    # internet connection
+    requires_network = True
+
+    def init_resources(self, context):
+        super(Googleplaybooks, self).init_resources(context)
+        self.gui.uiauto_params['search_book_title'] = self.search_book_title
+        # If library_book_title is blank, set it to the same as search_book_title
+        if not self.library_book_title:  # pylint: disable=access-member-before-definition
+            self.library_book_title = self.search_book_title  # pylint: disable=attribute-defined-outside-init
+        self.gui.uiauto_params['library_book_title'] = self.library_book_title
+        self.gui.uiauto_params['chapter_page_number'] = self.select_chapter_page_number
+        self.gui.uiauto_params['search_word'] = self.search_word
+        self.gui.uiauto_params['account'] = self.account

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

@@ -0,0 +1,35 @@
+apply plugin: 'com.android.application'
+
+def packageName = "com.arm.wa.uiauto.googleplaybooks"
+
+android {
+    compileSdkVersion 25
+    buildToolsVersion "25.0.3"
+    defaultConfig {
+        applicationId "${packageName}"
+        minSdkVersion 18
+        targetSdkVersion 25
+        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        applicationVariants.all { variant ->
+            variant.outputs.each { output ->
+                output.outputFile = file("$project.buildDir/apk/${packageName}.apk")
+            }
+        }
+    }
+}
+
+dependencies {
+    compile fileTree(dir: 'libs', include: ['*.jar'])
+    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/googleplaybooks/uiauto/app/src/main/AndroidManifest.xml

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

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

@@ -0,0 +1,672 @@
+/*    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.
+ */
+
+package com.arm.wa.uiauto.googleplaybooks;
+
+import android.os.Bundle;
+import android.support.test.runner.AndroidJUnit4;
+import android.support.test.uiautomator.UiObject;
+import android.support.test.uiautomator.UiObject2;
+import android.support.test.uiautomator.UiObjectNotFoundException;
+import android.support.test.uiautomator.UiSelector;
+import android.support.test.uiautomator.UiWatcher;
+import android.support.test.uiautomator.By;
+import android.util.Log;
+
+import com.arm.wa.uiauto.UxPerfUiAutomation.GestureTestParams;
+import com.arm.wa.uiauto.UxPerfUiAutomation.GestureType;
+import com.arm.wa.uiauto.BaseUiAutomation;
+import com.arm.wa.uiauto.ActionLogger;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.util.Iterator;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.concurrent.TimeUnit;
+
+import static com.arm.wa.uiauto.BaseUiAutomation.FindByCriteria.BY_DESC;
+import static com.arm.wa.uiauto.BaseUiAutomation.FindByCriteria.BY_ID;
+import static com.arm.wa.uiauto.BaseUiAutomation.FindByCriteria.BY_TEXT;
+
+
+@RunWith(AndroidJUnit4.class)
+public class UiAutomation extends BaseUiAutomation {
+
+    private int viewTimeoutSecs = 10;
+    private long viewTimeout =  TimeUnit.SECONDS.toMillis(viewTimeoutSecs);
+
+    protected Bundle parameters;
+    protected String packageID;
+
+    protected String searchBookTitle;
+    protected String libraryBookTitle;
+    protected int chapterPageNumber;
+    protected String searchWord;
+    protected String noteText;
+
+    @Before
+    public void initialize() {
+        this.uiAutoTimeout = TimeUnit.SECONDS.toMillis(8);
+
+        parameters = getParams();
+        packageID = getPackageID(parameters);
+
+        searchBookTitle = parameters.getString("search_book_title");
+        libraryBookTitle = parameters.getString("library_book_title");
+        chapterPageNumber = parameters.getInt("chapter_page_number");
+        searchWord = parameters.getString("search_word");
+        noteText = "This is a test note";
+    }
+
+    @Test
+    public void setup() throws Exception {
+        setScreenOrientation(ScreenOrientation.NATURAL);
+        runApplicationInitialization();
+
+        searchForBook(searchBookTitle);
+        addToLibrary();
+        openMyLibrary();
+
+        UiWatcher pageSyncPopUpWatcher = createPopUpWatcher();
+        registerWatcher("pageSyncPopUp", pageSyncPopUpWatcher);
+        runWatchers();
+    }
+    @Test
+    public void runWorkload() throws Exception {
+        openBook(libraryBookTitle);
+        selectChapter(chapterPageNumber);
+        gesturesTest();
+        addNote(noteText);
+        removeNote();
+        searchForWord(searchWord);
+        switchPageStyles();
+        aboutBook();
+        pressBack();
+    }
+
+    @Test
+    public void teardown() throws Exception {
+        removeWatcher("pageSyncPopUp");
+        unsetScreenOrientation();
+    }
+
+    // Get application parameters and clear the initial run dialogues of the application launch.
+    public void runApplicationInitialization() throws Exception {
+        String account = parameters.getString("account");
+        chooseAccount(account);
+        clearFirstRunDialogues();
+        dismissSendBooksAsGiftsDialog();
+        dismissSync();
+    }
+
+    // If the device has more than one account setup, a prompt appears
+    // In this case, select the first account in the list, unless `account`
+    // has been specified as a parameter, otherwise select `account`.
+    private void chooseAccount(String account) throws Exception {
+        UiObject accountPopup =
+            mDevice.findObject(new UiSelector().textContains("Choose an account")
+                                               .className("android.widget.TextView"));
+        if (accountPopup.exists()) {
+            if ("None".equals(account)) {
+                // If no account has been specified, pick the first entry in the list
+                UiObject list =
+                    mDevice.findObject(new UiSelector().className("android.widget.ListView"));
+                UiObject first = list.getChild(new UiSelector().index(0));
+                if (!first.exists()) {
+                    // Some devices are not zero indexed. If 0 doesnt exist, pick 1
+                    first = list.getChild(new UiSelector().index(1));
+                }
+                first.click();
+            } else {
+                // Account specified, select that
+                clickUiObject(BY_TEXT, account, "android.widget.CheckedTextView");
+            }
+            // Click OK to proceed
+            UiObject ok =
+                mDevice.findObject(new UiSelector().textContains("OK")
+                                                   .className("android.widget.Button")
+                                                   .enabled(true));
+            ok.clickAndWaitForNewWindow();
+        }
+    }
+
+    // If there is no sample book in My library we are prompted to choose a
+    // book the first time application is run. Try to skip the screen or
+    // pick a random sample book.
+    private void clearFirstRunDialogues() throws Exception {
+        UiObject startButton =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "start_button"));
+        // First try and skip the sample book selection
+        if (startButton.exists()) {
+            startButton.click();
+        }
+
+        UiObject endButton =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "end_button"));
+        // Click next button if it exists
+        if (endButton.exists()) {
+            endButton.click();
+
+            // Select a random sample book to add to My library
+            sleep(1);
+            tapDisplayCentre();
+            sleep(1);
+
+            // Click done button (uses same resource-id)
+            endButton.click();
+        }
+    }
+
+    private void dismissSendBooksAsGiftsDialog() throws Exception {
+        UiObject gotIt =
+            mDevice.findObject(new UiSelector().textContains("GOT IT"));
+        if (gotIt.exists()) {
+            gotIt.click();
+        }
+    }
+
+    private void dismissSync() throws Exception {
+        UiObject keepSyncOff =
+            mDevice.findObject(new UiSelector().textContains("Keep sync off")
+                                               .className("android.widget.Button"));
+        if (keepSyncOff.exists()) {
+            keepSyncOff.click();
+        }
+    }
+
+    // Searches for a "free" or "purchased" book title in Google play
+    private void searchForBook(final String bookTitle) throws Exception {
+        UiObject search =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "menu_search"));
+        if (!search.exists()) {
+            search =
+                mDevice.findObject(new UiSelector().resourceId(packageID + "search_box_idle_text"));
+        }
+        search.click();
+
+        UiObject searchText =
+            mDevice.findObject(new UiSelector().textContains("Search")
+                                               .className("android.widget.EditText"));
+        searchText.setText(bookTitle);
+        pressEnter();
+
+        UiObject resultList =
+            mDevice.findObject(new UiSelector().resourceId("com.android.vending:id/search_results_list"));
+        if (!resultList.waitForExists(viewTimeout)) {
+            throw new UiObjectNotFoundException("Could not find \"search results list view\".");
+        }
+
+        // Create a selector so that we can search for siblings of the desired
+        // book that contains a "free" or "purchased" book identifier
+        UiObject label =
+            mDevice.findObject(new UiSelector().fromParent(new UiSelector()
+                                               .description(String.format("Book: " + bookTitle))
+                                               .className("android.widget.TextView"))
+                                               .resourceId("com.android.vending:id/li_label")
+                                               .descriptionMatches("^(Purchased|Free)$"));
+
+        final int maxSearchTime = 30;
+        int searchTime = maxSearchTime;
+
+        while (!label.exists()) {
+            if (searchTime > 0) {
+                uiDeviceSwipeDown(100);
+                sleep(1);
+                searchTime--;
+            } else {
+                throw new UiObjectNotFoundException(
+                        "Exceeded maximum search time (" + maxSearchTime  +
+                        " seconds) to find book \"" + bookTitle + "\"");
+            }
+        }
+
+        // Click on either the first "free" or "purchased" book found that
+        // matches the book title
+        label.click();
+    }
+
+    private void addToLibrary() throws Exception {
+        UiObject add =
+            mDevice.findObject(new UiSelector().textContains("ADD TO LIBRARY")
+                                               .className("android.widget.Button"));
+        if (add.exists()) {
+            // add to My Library and opens book by default
+            add.click();
+            clickUiObject(BY_TEXT, "BUY", "android.widget.Button", true);
+        } else {
+            // opens book
+            clickUiObject(BY_TEXT, "READ", "android.widget.Button");
+        }
+
+        waitForPage();
+
+        UiObject navigationButton =
+            mDevice.findObject(new UiSelector().description("Navigate up"));
+
+        // Return to main app window
+        pressBack();
+
+        // On some devices screen ordering is not preserved so check for
+        // navigation button to determine current screen
+        if (navigationButton.exists()) {
+            pressBack();
+            pressBack();
+        }
+    }
+
+    private void openMyLibrary() throws Exception {
+        String testTag = "open_library";
+        ActionLogger logger = new ActionLogger(testTag, parameters);
+
+        logger.start();
+        //clickUiObject(BY_DESC, "Show navigation drawer");
+        // To correctly find the UiObject we need to specify the index also here
+        UiObject myLibrary =
+            mDevice.findObject(new UiSelector().className("android.widget.TextView")
+                                               .textMatches(".*[lL]ibrary")
+                                               .index(3));
+        if (!myLibrary.exists()) {
+            myLibrary =
+                mDevice.findObject(new UiSelector().resourceId(packageID + "jump_text"));
+        }
+        if (!myLibrary.exists()) {
+            myLibrary =
+                mDevice.findObject(new UiSelector().resourceId(packageID + "bottom_my_library"));
+        }
+		myLibrary.clickAndWaitForNewWindow(uiAutoTimeout);
+
+        // Switch to books tab on newer versions
+        UiObject books_tab =
+            mDevice.findObject(new UiSelector().className("android.widget.TextView")
+                                               .textMatches("BOOKS"));
+        if (books_tab.exists()){
+            books_tab.click();
+        }
+		logger.stop();
+	}
+
+    private void openBook(final String bookTitle) throws Exception {
+        String testTag = "open_book";
+        ActionLogger logger = new ActionLogger(testTag, parameters);
+
+        long maxWaitTimeSeconds = 120;
+        long maxWaitTime = TimeUnit.SECONDS.toMillis(maxWaitTimeSeconds);
+
+        UiSelector bookSelector =
+            new UiSelector().text(bookTitle)
+                            .className("android.widget.TextView");
+        UiObject book = mDevice.findObject(bookSelector);
+        // Check that books are sorted by time added to library. This way we
+        // can assume any newly downloaded books will be visible on the first
+        // screen.
+        mDevice.findObject(By.res(packageID + "menu_sort")).click();
+        clickUiObject(BY_TEXT, "Recent", "android.widget.TextView");
+        // When the book is first added to library it may not appear in
+        // cardsGrid until it has been fully downloaded. Wait for fully
+        // downloaded books
+        UiObject downloadComplete =
+            mDevice.findObject(new UiSelector().fromParent(bookSelector)
+                                               .description("100% downloaded"));
+        if (!downloadComplete.waitForExists(maxWaitTime)) {
+                throw new UiObjectNotFoundException(
+                        "Exceeded maximum wait time (" + maxWaitTimeSeconds  +
+                        " seconds) to download book \"" + bookTitle + "\"");
+        }
+
+        logger.start();
+        book.click();
+        waitForPage();
+        logger.stop();
+    }
+
+    // Creates a watcher for when a pop up warning appears when pages are out
+    // of sync across multiple devices.
+    private UiWatcher createPopUpWatcher() throws Exception {
+        UiWatcher pageSyncPopUpWatcher = new UiWatcher() {
+            @Override
+            public boolean checkForCondition() {
+                UiObject popUpDialogue =
+                    mDevice.findObject(new UiSelector().textStartsWith("You're on page")
+                                                       .resourceId("android:id/message"));
+                // Don't sync and stay on the current page
+                if (popUpDialogue.exists()) {
+                    try {
+                        UiObject stayOnPage =
+                            mDevice.findObject(new UiSelector().text("Yes")
+                                                               .className("android.widget.Button"));
+                        stayOnPage.click();
+                    } catch (UiObjectNotFoundException e) {
+                        e.printStackTrace();
+                    }
+                    return popUpDialogue.waitUntilGone(viewTimeout);
+                }
+                return false;
+            }
+        };
+        return pageSyncPopUpWatcher;
+    }
+
+    private void selectChapter(final int chapterPageNumber) throws Exception {
+        getDropdownMenu();
+
+        UiObject contents = getUiObjectByResourceId(packageID + "menu_reader_toc");
+        contents.clickAndWaitForNewWindow(uiAutoTimeout);
+        UiObject toChapterView = getUiObjectByResourceId(packageID + "toc_list_view",
+                                                         "android.widget.ExpandableListView");
+        // Navigate to top of chapter view
+        searchPage(toChapterView, 1, Direction.UP, 10);
+        // Search for chapter page number
+        UiObject page = searchPage(toChapterView, chapterPageNumber, Direction.DOWN, 10);
+        // Go to the page
+        page.clickAndWaitForNewWindow(viewTimeout);
+
+        waitForPage();
+    }
+
+    private void gesturesTest() throws Exception {
+        String testTag = "gesture";
+
+        // Perform a range of swipe tests while browsing home photoplaybooks gallery
+        LinkedHashMap<String, GestureTestParams> testParams = new LinkedHashMap<String, GestureTestParams>();
+        testParams.put("swipe_left", new GestureTestParams(GestureType.UIDEVICE_SWIPE, Direction.LEFT, 20));
+        testParams.put("swipe_right", new GestureTestParams(GestureType.UIDEVICE_SWIPE, Direction.RIGHT, 20));
+        testParams.put("pinch_out", new GestureTestParams(GestureType.PINCH, PinchType.OUT, 100, 50));
+        testParams.put("pinch_in", new GestureTestParams(GestureType.PINCH, PinchType.IN, 100, 50));
+
+        Iterator<Entry<String, GestureTestParams>> it = testParams.entrySet().iterator();
+
+        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());
+            ActionLogger logger = new ActionLogger(runName, parameters);
+
+            UiObject pageView = waitForPage();
+
+            logger.start();
+
+            switch (type) {
+                case UIDEVICE_SWIPE:
+                    uiDeviceSwipe(dir, steps);
+                    break;
+                case PINCH:
+                    uiObjectVertPinch(pageView, pinch, steps, percent);
+                    break;
+                default:
+                    break;
+            }
+
+            logger.stop();
+        }
+
+        waitForPage();
+    }
+
+    private void addNote(final String text) throws Exception {
+        String testTag = "note_add";
+        ActionLogger logger = new ActionLogger(testTag, parameters);
+
+        hideDropDownMenu();
+
+        UiObject clickable = mDevice.findObject(new UiSelector().longClickable(true));
+        if (!clickable.exists()){
+            clickable = mDevice.findObject(new UiSelector().resourceIdMatches(".*/main_page"));
+        }
+        if (!clickable.exists()){
+            clickable = mDevice.findObject(new UiSelector().resourceIdMatches(".*/reader"));
+        }
+
+        logger.start();
+
+        uiObjectPerformLongClick(clickable, 100);
+
+        UiObject addNoteButton =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "add_note_button"));
+        addNoteButton.click();
+
+        UiObject noteEditText = getUiObjectByResourceId(packageID + "note_edit_text",
+                                                        "android.widget.EditText");
+        noteEditText.setText(text);
+
+        clickUiObject(BY_ID, packageID + "note_menu_button", "android.widget.ImageButton");
+        clickUiObject(BY_TEXT, "Save", "android.widget.TextView");
+
+        logger.stop();
+
+        waitForPage();
+    }
+
+    private void removeNote() throws Exception {
+        String testTag = "note_remove";
+        ActionLogger logger = new ActionLogger(testTag, parameters);
+
+        UiObject clickable = mDevice.findObject(new UiSelector().longClickable(true));
+        if (!clickable.exists()){
+            clickable = mDevice.findObject(new UiSelector().resourceIdMatches(".*/main_page"));
+        }
+        if (!clickable.exists()){
+            clickable = mDevice.findObject(new UiSelector().resourceIdMatches(".*/reader"));
+        }
+
+        logger.start();
+
+        uiObjectPerformLongClick(clickable, 100);
+
+        UiObject removeButton =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "remove_highlight_button"));
+        removeButton.click();
+
+        clickUiObject(BY_TEXT, "Remove", "android.widget.Button");
+
+        logger.stop();
+
+        waitForPage();
+    }
+
+    private void searchForWord(final String text) throws Exception {
+        String testTag = "search_word";
+        ActionLogger logger = new ActionLogger(testTag, parameters);
+
+        // Allow extra time for search queries involing high freqency words
+        final long searchTimeout =  TimeUnit.SECONDS.toMillis(20);
+
+        getDropdownMenu();
+
+        UiObject search =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "menu_search"));
+        search.click();
+
+        UiObject searchText =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "search_src_text"));
+
+        logger.start();
+
+        searchText.setText(text);
+        pressEnter();
+
+        UiObject resultList =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "search_results_list"));
+        if (!resultList.waitForExists(searchTimeout)) {
+            throw new UiObjectNotFoundException("Could not find \"search results list view\".");
+        }
+
+        UiObject searchWeb =
+            mDevice.findObject(new UiSelector().textMatches("Search web|SEARCH WEB")
+                                         .className("android.widget.TextView"));
+        if (!searchWeb.waitForExists(searchTimeout)) {
+            throw new UiObjectNotFoundException("Could not find \"Search web view\".");
+        }
+
+        logger.stop();
+
+        pressBack();
+    }
+
+    private void switchPageStyles() throws Exception {
+        String testTag = "style";
+
+        getDropdownMenu();
+
+        clickUiObject(BY_ID, packageID + "menu_reader_settings", "android.widget.TextView");
+
+        // Check for lighting option button on newer versions
+        UiObject lightingOptionsButton =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "lighting_options_button"));
+        if (lightingOptionsButton.exists()) {
+            lightingOptionsButton.click();
+        }
+
+        String[] styles = {"Night", "Sepia", "Day"};
+        for (String style : styles) {
+            try {
+                ActionLogger logger = new ActionLogger(testTag + "_" + style, parameters);
+                UiObject pageStyle =
+                    mDevice.findObject(new UiSelector().description(style));
+
+                logger.start();
+                pageStyle.clickAndWaitForNewWindow(viewTimeout);
+                logger.stop();
+
+            } catch (UiObjectNotFoundException e) {
+                // On some devices the lighting options menu disappears
+                // between clicks. Searching for the menu again would affect
+                // the logger timings so log a message and continue
+                Log.e("GooglePlayBooks", "Could not find pageStyle \"" + style + "\"");
+            }
+        }
+
+        sleep(2);
+        tapDisplayCentre(); // exit reader settings dialog
+        waitForPage();
+    }
+
+    private void aboutBook() throws Exception {
+        String testTag = "open_about";
+        ActionLogger logger = new ActionLogger(testTag, parameters);
+
+        getDropdownMenu();
+
+        clickUiObject(BY_DESC, "More options", "android.widget.ImageView");
+
+        UiObject bookInfo = getUiObjectByText("About this book", "android.widget.TextView");
+
+        logger.start();
+
+        bookInfo.clickAndWaitForNewWindow(uiAutoTimeout);
+
+        UiObject detailsPanel =
+            mDevice.findObject(new UiSelector().resourceId("com.android.vending:id/item_details_panel"));
+        waitObject(detailsPanel, viewTimeoutSecs);
+
+        logger.stop();
+
+        pressBack();
+    }
+
+    // Helper for waiting on a page between actions
+    private UiObject waitForPage() throws Exception {
+        UiObject activityReader =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "activity_reader")
+                                               .childSelector(new UiSelector()
+                                               .focusable(true)));
+        // On some devices the object in the view hierarchy is found before it
+        // becomes visible on the screen. Therefore add pause instead.
+        sleep(3);
+
+        if (!activityReader.waitForExists(viewTimeout)) {
+            throw new UiObjectNotFoundException("Could not find \"activity reader view\".");
+        }
+
+        return activityReader;
+    }
+
+    // Helper for accessing the drop down menu
+    private void getDropdownMenu() throws Exception {
+        UiObject actionBar =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "action_bar"));
+        if (!actionBar.exists()) {
+            tapDisplayCentre();
+            sleep(1); // Allow previous views to settle
+        }
+
+        UiObject card =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "cards")
+                                               .className("android.view.ViewGroup"));
+        if (card.exists()) {
+            // On rare occasions tapping a certain word that appears in the centre
+            // of the display will bring up a card to describe the word.
+            // (Such as a place will bring a map of its location)
+            // In this situation, tap centre to go back, and try again
+            // at a different set of coordinates
+            int x = (int)(getDisplayCentreWidth() * 0.8);
+            int y = (int)(getDisplayCentreHeight() * 0.8);
+            while (card.exists()) {
+                tapDisplay(x, y);
+                sleep(1);
+            }
+
+            tapDisplay(x, y);
+            sleep(1); // Allow previous views to settle
+        }
+
+        if (!actionBar.exists()) {
+            throw new UiObjectNotFoundException("Could not find \"action bar\".");
+        }
+    }
+
+    private void hideDropDownMenu() throws Exception {
+        UiObject actionBar =
+            mDevice.findObject(new UiSelector().resourceId(packageID + "action_bar"));
+        if (actionBar.exists()) {
+            tapDisplayCentre();
+            sleep(1); // Allow previous views to settle
+        }
+
+        if (actionBar.exists()) {
+            throw new UiObjectNotFoundException("Could not close \"action bar\".");
+        }
+    }
+
+    private UiObject searchPage(final UiObject view, final int pagenum, final Direction updown,
+                                final int attempts) throws Exception {
+        if (attempts <= 0) {
+            throw new UiObjectNotFoundException("Could not find \"page number\" after several attempts.");
+        }
+
+        UiObject page =
+            mDevice.findObject(new UiSelector().description(String.format("page " + Integer.toString(pagenum)))
+                                         .className("android.widget.TextView"));
+        if (!page.exists()) {
+            // Scroll up by swiping down
+            if (updown == Direction.UP) {
+                view.swipeDown(200);
+            // Default case is to scroll down (swipe up)
+            } else {
+                view.swipeUp(200);
+            }
+            page = searchPage(view, pagenum, updown, attempts - 1);
+        }
+        return page;
+    }
+}

wa/workloads/googleplaybooks/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.2'
+
+        // 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/googleplaybooks/uiauto/build.sh

@@ -0,0 +1,40 @@
+#!/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 wa dist
+libs_dir=app/libs
+mkdir -p $libs_dir
+base_class=`python -c "import os, wa; print os.path.join(os.path.dirname(wa.__file__), 'framework', 'uiauto', 'uiauto.aar')"`
+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)
+package=com.arm.wa.uiauto.googleplaybooks
+rm -f ../$package
+if [[ -f app/build/apk/$package.apk ]]; then
+    cp app/build/apk/$package.apk ../$package.apk
+else
+    echo 'ERROR: UiAutomator apk could not be found!'
+    exit 9
+fi

wa/workloads/googleplaybooks/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/googleplaybooks/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/googleplaybooks/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/googleplaybooks/uiauto/settings.gradle

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