Merge lp:~elopio/ubuntu-ui-toolkit/pullToRefresh-test1 into lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/pullToRefresh

[Leo Arias]

Added a test for the pull to refresh with autopilot.

[lp:~elopio/ubuntu-ui-toolkit/pullToRefresh-test1]

944. By Leo Arias on 2014-05-21

Fixed identation.

945. By Leo Arias on 2014-05-21

Added the missing files.

[Julia Palandri (julia-palandri)]

Looks good as far as I can tell; please have someone else to review it as well.

review: Approve

[Zsombor Egri (zsombi)]

All good, thx!!!

review: Approve

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py	2014-04-30 00:46:11 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py	2014-05-21 12:15:40 +0000
@@ -16,6 +16,7 @@
 
 import logging
 
+import autopilot.exceptions
 from autopilot import logging as autopilot_logging
 
 from ubuntuuitoolkit._custom_proxy_objects import _common
@@ -156,8 +157,47 @@
         self.pointing_device.drag(start_x, start_y, stop_x, stop_y, rate=5)
 
     @autopilot_logging.log_action(logger.info)
-    def _scroll_to_top(self):
+    def _swipe_to_top(self):
         if not self.atYBeginning:
             containers = self._get_containers()
             while not self.atYBeginning:
                 self._swipe_to_show_more_above(containers)
+
+    @autopilot_logging.log_action(logger.info)
+    def pull_to_refresh(self):
+        """Pulls the flickable down and triggers a refresh on it.
+
+        :raises ubuntuuitoolkit.ToolkitException: If the flickable has no pull
+            to release functionality.
+
+        """
+        try:
+            pull_to_refresh = self.select_single(PullToRefresh)
+        except autopilot.exceptions.StateNotFoundError:
+            raise _common.ToolkitException(
+                'The flickable has no pull to refresh functionality.')
+        self._swipe_to_top()
+        self._swipe_to_middle()
+        pull_to_refresh.wait_for_refresh()
+
+    @autopilot_logging.log_action(logger.info)
+    def _swipe_to_middle(self):
+        start_x = stop_x = self.globalRect.x + (self.globalRect.width // 2)
+        # Start and stop just a little under the top.
+        containers = self._get_containers()
+        top = _get_visible_container_top(containers) + 5
+        bottom = _get_visible_container_bottom(containers)
+
+        start_y = top
+        stop_y = bottom // 2
+        self._slow_drag(start_x, stop_x, start_y, stop_y)
+        self.dragging.wait_for(False)
+        self.moving.wait_for(False)
+
+
+class PullToRefresh(_common.UbuntuUIToolkitCustomProxyObjectBase):
+    """Autopilot helper for the PullToRefresh component."""
+
+    def wait_for_refresh(self):
+        activity_indicator = self.select_single('ActivityIndicator')
+        activity_indicator.running.wait_for(False)

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_qquicklistview.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_qquicklistview.py	2014-04-30 00:46:11 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_qquicklistview.py	2014-05-21 12:15:40 +0000
@@ -48,7 +48,7 @@
 
     @autopilot_logging.log_action(logger.info)
     def _find_element(self, object_name):
-        self._scroll_to_top()
+        self._swipe_to_top()
         while not self.atYEnd:
             containers = self._get_containers()
             self._swipe_to_show_more_below(containers)

=== added file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_pull_to_refresh.py'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_pull_to_refresh.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_pull_to_refresh.py	2014-05-21 12:15:40 +0000
@@ -0,0 +1,50 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2014 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; version 3.
+#
+# 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import os
+
+import ubuntuuitoolkit
+from ubuntuuitoolkit import tests
+
+
+class PullToRefreshTestCase(tests.QMLFileAppTestCase):
+
+    path = os.path.abspath(__file__)
+    dir_path = os.path.dirname(path)
+    test_qml_file_path = os.path.join(dir_path, 'test_pull_to_refresh.qml')
+
+    def setUp(self):
+        super(PullToRefreshTestCase, self).setUp()
+        self.label = self.main_view.select_single(
+            'Label', objectName='refreshedLabel')
+        self.assertEqual(self.label.text, 'Not refreshed.')
+
+    def test_pull_to_refresh_on_a_flickable_without_it_must_raise_error(self):
+        flickable = self.main_view.select_single(
+            ubuntuuitoolkit.QQuickFlickable,
+            objectName='flickableWithoutPullToRefresh')
+        error = self.assertRaises(
+            ubuntuuitoolkit.ToolkitException, flickable.pull_to_refresh)
+        self.assertEqual(
+            str(error), 'The flickable has no pull to refresh functionality.')
+
+    def test_pull_to_refresh_must_refresh_model(self):
+        flickable = self.main_view.select_single(
+            ubuntuuitoolkit.QQuickFlickable,
+            objectName='flickableWithPullToRefresh')
+        flickable.pull_to_refresh()
+
+        self.assertEqual(self.label.text, 'Refreshed.')

=== added file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_pull_to_refresh.qml'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_pull_to_refresh.qml	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_pull_to_refresh.qml	2014-05-21 12:15:40 +0000
@@ -0,0 +1,102 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import Ubuntu.Components 1.1
+import Ubuntu.Components.ListItems 1.0 as ListItem
+
+MainView {
+    id: root
+    width: units.gu(48)
+    height: units.gu(60)
+
+    ListModel {
+        id: listModel
+        property bool refreshing: refreshComplete.running
+
+        function modelData(index) {
+            return {'name': 'line #' + index}
+        }
+
+        function reload() {
+            refreshComplete.restart();
+            refreshedLabel.text = 'Refreshed.'
+        }
+
+        function fillModel() {
+            clear();
+            for (var i = 0; i < 50; i++) {
+                append(modelData(i));
+            }
+        }
+
+        Component.onCompleted: fillModel()
+    }
+
+    Timer {
+        id: refreshComplete
+        interval: 1000
+        onTriggered: {
+            listModel.fillModel();
+        }
+    }
+
+    Column {
+
+        anchors.fill: parent
+        Label {
+            id: refreshedLabel
+            objectName: 'refreshedLabel'
+            text: 'Not refreshed.'
+        }
+
+        Flickable {
+            id: view
+            objectName: 'flickableWithPullToRefresh'
+            width: parent.width
+            height: parent.height - refreshedLabel.paintedHeight
+            clip: true
+            contentWidth: column.childrenRect.width
+            contentHeight: column.childrenRect.height
+            Column {
+                id: column
+                Repeater {
+                    model: listModel
+                    ListItem.Standard {
+                        width: root.width
+                        height: units.gu(5)
+                        text: index + ' - ' + modelData
+                        onClicked: {
+                            listModel.reload();
+                        }
+                    }
+                }
+            }
+
+            PullToRefresh {
+                id: pullToRefresh
+                objectName: 'InFlickable'
+                parent: view
+                refreshing: listModel.refreshing
+                onRefresh: listModel.reload()
+            }
+        }
+
+        Flickable {
+            objectName: 'flickableWithoutPullToRefresh'
+        }
+    }
+}