Merge lp:~nskaggs/sudoku-app/add-emulator-autopilot into lp:sudoku-app

[Nicholas Skaggs]

Add the ubuntu sdk emulator for use with autopilot

Add the ubuntu sdk emulator for use with autopilot

[lp:~nskaggs/sudoku-app/add-emulator-autopilot]

71. By Nicholas Skaggs on 2013-07-11

fix import issue

72. By Nicholas Skaggs on 2013-07-11

fix mainwindow function call deprecation

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

review: Approve (continuous-integration)

=== modified file 'tests/autopilot/sudoku_app/__init__.py'
--- tests/autopilot/sudoku_app/__init__.py	2013-07-08 18:15:44 +0000
+++ tests/autopilot/sudoku_app/__init__.py	2013-07-11 17:01:25 +0000
@@ -4,52 +4,3 @@
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
 # by the Free Software Foundation.
-
-"""Sudoku app autopilot tests."""
-
-import os.path
-
-from autopilot.input import Mouse, Touch, Pointer
-from autopilot.platform import model
-from autopilot.testcase import AutopilotTestCase
-
-from sudoku_app.emulators.main_window import MainWindow
-
-
-class SudokuTestCase(AutopilotTestCase):
-
-    """A common test case class that provides several useful methods for
-    sudoku-app tests.
-
-    """
-    if model() == 'Desktop':
-        scenarios = [('with mouse', dict(input_device_class=Mouse))]
-    else:
-        scenarios = [('with touch', dict(input_device_class=Touch))]
-
-    local_location = "../../sudoku-app.qml"
-
-    def setUp(self):
-        self.pointing_device = Pointer(self.input_device_class.create())
-        super(SudokuTestCase, self).setUp()
-        if os.path.exists(self.local_location):
-            self.launch_test_local()
-        else:
-            self.launch_test_installed()
-
-    def launch_test_local(self):
-        self.app = self.launch_test_application(
-            "qmlscene",
-            self.local_location,
-            app_type='qt')
-
-    def launch_test_installed(self):
-        self.app = self.launch_test_application(
-            "qmlscene",
-            "/usr/share/sudoku-app/sudoku-app.qml",
-            "--desktop_file_hint=/usr/share/applications/sudoku-app.desktop",
-            app_type='qt')
-
-    @property
-    def main_window(self):
-        return MainWindow(self.app)
 
=== modified file 'tests/autopilot/sudoku_app/emulators/main_window.py'
--- tests/autopilot/sudoku_app/emulators/main_window.py	2013-07-08 18:54:35 +0000
+++ tests/autopilot/sudoku_app/emulators/main_window.py	2013-07-11 17:01:25 +0000
@@ -15,10 +15,3 @@
     """
     def __init__(self, app):
         self.app = app
-
-    def get_qml_view(self):
-        """Get the main QML view"""
-        return self.app.select_single("QQuickView")
-
-    def get_toolbar(self):
-        return self.app.select_single("Toolbar") 
 
=== added file 'tests/autopilot/sudoku_app/emulators/ubuntusdk.py'
--- tests/autopilot/sudoku_app/emulators/ubuntusdk.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/sudoku_app/emulators/ubuntusdk.py	2013-07-11 17:01:25 +0000
@@ -0,0 +1,151 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2013 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Authored by: Nicholas Skaggs <[e-mail]>
+
+from testtools.matchers import Equals, NotEquals, Not, Is
+from autopilot.matchers import Eventually
+
+class ubuntusdk(object):
+    """An emulator class that makes it easy to interact with the ubuntu sdk applications."""
+
+    def __init__(self, autopilot, app):
+        self.app = app
+        self.autopilot = autopilot
+
+    def get_qml_view(self):
+        """Get the main QML view"""
+        return self.app.select_single("QQuickView")
+
+    def get_object(self, typeName, name):
+        """Get a specific object"""
+        return self.app.select_single(typeName, objectName=name)
+
+    def get_objects(self, typeName, name):
+        """Get more than one object"""
+        return self.app.select_many(typeName, objectName=name)
+
+    def switch_to_tab(self, tab):
+        """Switch to the specified tab number"""
+        tabs = self.get_tabs()
+        currentTab = tabs.selectedTabIndex
+
+        #perform operations until tab == currentTab
+        while tab != currentTab:
+            if tab > currentTab:
+                self._previous_tab()
+            if tab < currentTab:
+                self._next_tab()
+            currentTab = tabs.selectedTabIndex
+
+    def toggle_toolbar(self):
+        """Toggle the toolbar between revealed and hidden"""
+        #check and see if the toolbar is open or not
+        if self.get_toolbar().opened:
+            self.hide_toolbar()
+        else:
+            self.open_toolbar()
+
+    def get_toolbar(self):
+        """Returns the toolbar in the main events view."""
+        return self.app.select_single("Toolbar")
+
+    def get_toolbar_button(self, buttonObject):
+        """Returns the toolbar button with objectName buttonObject"""
+        toolbar = self.get_toolbar()
+        if not toolbar.opened:
+            self.open_toolbar()
+        buttonList = toolbar.select_many("ActionItem")
+        for button in buttonList:
+            if button.objectName == buttonObject:
+                return button
+
+    def click_toolbar_button(self, buttonObject):
+        """Clicks the toolbar button with objectName buttonObject"""
+        #The toolbar button is assumed to be the following format
+        #Toolbar {
+        #         ...
+        #           ActionItem {
+        #               objectName: "name"
+        button = self.get_toolbar_button(buttonObject)
+        self.autopilot.pointing_device.click_object(button)
+        return button
+
+    def open_toolbar(self):
+        """Open the toolbar"""
+        qmlView = self.get_qml_view()
+
+        lineX = int(qmlView.x + qmlView.width * 0.50)
+        startY = int(qmlView.y + qmlView.height - 1)
+        stopY = int(qmlView.y + qmlView.height * 0.95)
+
+        self.autopilot.pointing_device.drag(lineX, startY, lineX, stopY)
+
+    def hide_toolbar(self):
+        """Hide the toolbar"""
+        qmlView = self.get_qml_view()
+
+        lineX = int(qmlView.x + qmlView.width * 0.50)
+        startY = int(qmlView.y + qmlView.height * 0.95)
+        stopY = int(qmlView.y + qmlView.height - 1)
+
+        self.autopilot.pointing_device.drag(lineX, startY, lineX, stopY)
+
+    def set_popup_value(self, popover, button, value):
+        """Changes the given popover selector to the request value
+        At the moment this only works for values that are currently visible. To
+        access the remaining items, a help method to drag and recheck is needed."""
+        #The popover is assumed to be the following format
+        #Component {
+        #    id: actionSelectionPopover
+        #
+        #ActionSelectionPopover {
+        #                actions: ActionList {
+        #                    Action {
+
+        popList = self.get_object("ActionSelectionPopover", popover)
+        itemList = popList.select_many("Label")
+        for item in itemList:
+            if item.text == value:
+                self.autopilot.pointing_device.click_object(item)
+                return item
+
+    def get_tabs(self):
+        """Return all tabs"""
+        return self.get_object("Tabs", "rootTabs")
+
+    def _previous_tab(self):
+        """Switch to the previous tab"""
+        qmlView = self.get_qml_view()
+
+        startX = int(qmlView.x + qmlView.width * 0.35)
+        stopX = int(qmlView.x + qmlView.width * 0.50)
+        lineY = int(qmlView.y + qmlView.height * 0.05)
+
+        self.autopilot.pointing_device.drag(startX, lineY, stopX, lineY)
+        self.autopilot.pointing_device.click()
+        self.autopilot.pointing_device.click()
+
+    def _next_tab(self):
+        """Switch to the next tab"""
+        qmlView = self.get_qml_view()
+
+        startX = int(qmlView.x + qmlView.width * 0.50)
+        stopX = int(qmlView.x + qmlView.width * 0.35)
+        lineY = int(qmlView.y + qmlView.height * 0.05)
+
+        self.autopilot.pointing_device.drag(startX, lineY, stopX, lineY)
+        self.autopilot.pointing_device.click()
 
=== modified file 'tests/autopilot/sudoku_app/tests/__init__.py'
--- tests/autopilot/sudoku_app/tests/__init__.py	2013-07-08 18:15:44 +0000
+++ tests/autopilot/sudoku_app/tests/__init__.py	2013-07-11 17:01:25 +0000
@@ -3,4 +3,58 @@
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
-# by the Free Software Foundation.
 \ No newline at end of file
+# by the Free Software Foundation.
+
+"""Sudoku app autopilot tests."""
+
+import os.path
+
+from autopilot.input import Mouse, Touch, Pointer
+from autopilot.platform import model
+from autopilot.testcase import AutopilotTestCase
+
+from sudoku_app.emulators.main_window import MainWindow
+from sudoku_app.emulators.ubuntusdk import ubuntusdk
+
+
+class SudokuTestCase(AutopilotTestCase):
+
+    """A common test case class that provides several useful methods for
+    sudoku-app tests.
+
+    """
+    if model() == 'Desktop':
+        scenarios = [('with mouse', dict(input_device_class=Mouse))]
+    else:
+        scenarios = [('with touch', dict(input_device_class=Touch))]
+
+    local_location = "../../sudoku-app.qml"
+
+    def setUp(self):
+        self.pointing_device = Pointer(self.input_device_class.create())
+        super(SudokuTestCase, self).setUp()
+        if os.path.exists(self.local_location):
+            self.launch_test_local()
+        else:
+            self.launch_test_installed()
+
+    def launch_test_local(self):
+        self.app = self.launch_test_application(
+            "qmlscene",
+            self.local_location,
+            app_type='qt')
+
+    def launch_test_installed(self):
+        self.app = self.launch_test_application(
+            "qmlscene",
+            "/usr/share/sudoku-app/sudoku-app.qml",
+            "--desktop_file_hint=/usr/share/applications/sudoku-app.desktop",
+            app_type='qt')
+
+    @property
+    def main_window(self):
+        return MainWindow(self.app)
+
+    @property
+    def ubuntusdk(self):
+        return ubuntusdk(self, self.app)
 
=== modified file 'tests/autopilot/sudoku_app/tests/test_sudoku.py'
--- tests/autopilot/sudoku_app/tests/test_sudoku.py	2013-07-08 18:15:44 +0000
+++ tests/autopilot/sudoku_app/tests/test_sudoku.py	2013-07-11 17:01:25 +0000
@@ -12,7 +12,7 @@
 from autopilot.matchers import Eventually
 from testtools.matchers import Equals
 
-from sudoku_app import SudokuTestCase
+from sudoku_app.tests import SudokuTestCase
 
 
 class TestMainWindow(SudokuTestCase):
@@ -20,19 +20,7 @@
     def setUp(self):
         super(TestMainWindow, self).setUp()
         self.assertThat(
-            self.main_window.get_qml_view().visible, Eventually(Equals(True)))
+            self.ubuntusdk.get_qml_view().visible, Eventually(Equals(True)))
 
     def tearDown(self):
         super(TestMainWindow, self).tearDown()
-
-    def test_toolbar_shows(self):
-        """Make sure that dragging from the bottom reveals the hidden
-        toolbar."""
-        toolbar = self.main_window.get_toolbar()
-
-        x, y, w, h = toolbar.globalRect
-        tx = x + (w / 2)
-        ty = y + (h - 2)
-
-        self.pointing_device.drag(tx, ty, tx, ty - h)
-        self.assertThat(toolbar.state, Eventually(Equals("spread")))