Merge lp:~tpeeters/ubuntu-ui-toolkit/ensureVisible into lp:ubuntu-ui-toolkit/staging

[Tim Peeters]

Add ensure_visible() function to header AP helper.

[lp:~tpeeters/ubuntu-ui-toolkit/ensureVisible]

1342. By Tim Peeters on 2014-11-24

add comment

1343. By Tim Peeters on 2014-11-24

flake8

1344. By Tim Peeters on 2014-11-24

remove _show_if_not_visible()

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1341
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1261/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/6613/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/1094/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/1093/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/1093/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/7865/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1261/rebuild

review: Needs Fixing (continuous-integration)

[Leo Arias (elopio)]

136 + def test_show_header(self):

It would be clearer if you rename this test to test_ensure_header_visible_must_show_it_when_not_visible

137 + """Test that header.ensure_visible() shows the header.
138 + """

It will look a little better if you put the closing quotes in the same line. Also, that's a rule from pep 257 for one-line docstrings. We are not currently enforcing pep257, but it makes the code look nicer.

Other than that, it looks good. Thanks!
You have a pep8 error that's making the tests fail. Please fix it and make sure that the tests pass before merging. I will leave you my approval here.

review: Approve (code review)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1344
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1262/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/6615/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/1095
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/1094
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/1094/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/1094
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/6178/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/7867
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/7867/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/16181

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1262/rebuild

review: Needs Fixing (continuous-integration)

[lp:~tpeeters/ubuntu-ui-toolkit/ensureVisible]

1345. By Tim Peeters on 2014-11-25

Leo's review comments

[Zsombor Egri (zsombi)]

Looks good. Thx!

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1345
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1266/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/6621/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/1099
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/1098
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/1098/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/1098
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/6184/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/7873
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/7873/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/16218

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1266/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py	2014-09-18 15:04:43 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py	2014-11-25 10:38:20 +0000
@@ -34,7 +34,7 @@
 class AppHeader(_common.UbuntuUIToolkitCustomProxyObjectBase):
     """AppHeader Autopilot custom proxy object."""
 
-    def _show_if_not_visible(self):
+    def ensure_visible(self):
         if not self._is_visible():
             self._show()
 
@@ -67,7 +67,7 @@
                 range or useDeprecatedToolbar is set.
 
         """
-        self._show_if_not_visible()
+        self.ensure_visible()
 
         if self.useDeprecatedToolbar:
             raise _common.ToolkitException('Old header has no sections')
@@ -92,7 +92,7 @@
         return sectionsProperties.selectedIndex
 
     def click_back_button(self):
-        self._show_if_not_visible()
+        self.ensure_visible()
 
         if self.useDeprecatedToolbar:
             raise _common.ToolkitException('Old header has no back button')
@@ -107,7 +107,7 @@
         self.wait_for_animation()
 
     def click_custom_back_button(self):
-        self._show_if_not_visible()
+        self.ensure_visible()
 
         if self.useDeprecatedToolbar:
             raise _common.ToolkitException(
@@ -139,7 +139,7 @@
         :raise ToolkitException: If the main view has no tabs.
 
         """
-        self._show_if_not_visible()
+        self.ensure_visible()
 
         if self.useDeprecatedToolbar:
             self._switch_to_next_tab_in_deprecated_tabbar()
@@ -171,7 +171,7 @@
                 of range or useDeprecatedToolbar is set.
 
         """
-        self._show_if_not_visible()
+        self.ensure_visible()
 
         if self.useDeprecatedToolbar:
             raise _common.ToolkitException(
@@ -211,7 +211,7 @@
             name.
 
         """
-        self._show_if_not_visible()
+        self.ensure_visible()
 
         button = self._get_action_button(action_object_name)
         self.pointing_device.click_object(button)

=== added file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HideShowTestCase.qml'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HideShowTestCase.qml	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HideShowTestCase.qml	2014-11-25 10:38:20 +0000
@@ -0,0 +1,44 @@
+/*
+ * 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 {
+    width: units.gu(48)
+    height: units.gu(60)
+
+    useDeprecatedToolbar: false
+
+    Page {
+        id: page
+        title: "Test title"
+
+        ListView {
+            id: testListView
+            objectName: "testListView"
+            anchors.fill: parent
+            model: 20
+
+            delegate: ListItem.Standard {
+                objectName: "testListElement%1".arg(index)
+                text: "test list element %1".arg(index)
+                height: units.gu(5)
+            }
+        }
+    }
+}

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py	2014-07-30 12:45:31 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py	2014-11-25 10:38:20 +0000
@@ -24,6 +24,34 @@
 from ubuntuuitoolkit import tests
 
 
+class HideShowTestCase(tests.QMLFileAppTestCase):
+
+    path = os.path.abspath(__file__)
+    dir_path = os.path.dirname(path)
+    test_qml_file_path = os.path.join(
+        dir_path,
+        'test_header.HideShowTestCase.qml')
+
+    def setUp(self):
+        super(HideShowTestCase, self).setUp()
+        self.header = self.main_view.get_header()
+
+    def test_ensure_header_visible_must_show_it_when_not_visible(self):
+        """Test that header.ensure_visible() shows the header."""
+
+        # NOTE: Using the internal _is_visible() function here.
+        # It is not made public because besides testing the
+        # ensure_visible() function, there is no use for it.
+        self.assertEquals(self.header._is_visible(), True)
+        # Scroll down to hide the header
+        self.list_view = self.main_view.select_single(
+            ubuntuuitoolkit.QQuickListView, objectName='testListView')
+        self.list_view.click_element('testListElement19')
+        self.assertEquals(self.header._is_visible(), False)
+        self.header.ensure_visible()
+        self.assertEquals(self.header._is_visible(), True)
+
+
 class ActionsTestCase(tests.QMLFileAppTestCase):
 
     path = os.path.abspath(__file__)