Merge lp:~elopio/ubuntu-ui-toolkit/98-DeprecateHeader-autopilot into lp:~tpeeters/ubuntu-ui-toolkit/98-DeprecateHeader

[Leo Arias]

Added an autoiplot helper for the deprecated header.

[Leo Arias (elopio)]

Tim, with this we will support people that are still using the deprecated Header, but we will log an additional warning on the autopilot side.

This is pretty ugly:
11 + property string _for_autopilot

but is the only way I know for QML to assign Header to this component. Otherwise it will consider it to be an AppHeader, and autopilot won't be able to distinguish between them.

And related to the existing app tests, they will be safe and won't require a modification if they are using main_view.get_header(). If they are doing something like select_single(Header) they will have to be updated. I don't think a lot of applications are doing that, maybe not a single one is doing it, but we have to search the code.

[Tim Peeters (tpeeters)]

thanks

review: Approve

=== modified file 'modules/Ubuntu/Components/Header.qml'
--- modules/Ubuntu/Components/Header.qml	2014-05-28 19:13:40 +0000
+++ modules/Ubuntu/Components/Header.qml	2014-06-03 20:49:38 +0000
@@ -22,6 +22,11 @@
     \deprecated
 */
 AppHeader {
+
+    // We need this property so QML exposes this class as Header instead of
+    // AppHeader. This way autopilot can select the deprecated header.
+    property string _for_autopilot
+
     Component.onCompleted: {
         print("WARNING: Header is an internal component of Ubuntu.Components and" +
               "its API may change or be removed at any moment." +

=== modified file 'tests/autopilot/ubuntuuitoolkit/__init__.py'
--- tests/autopilot/ubuntuuitoolkit/__init__.py	2014-06-02 20:15:56 +0000
+++ tests/autopilot/ubuntuuitoolkit/__init__.py	2014-06-03 20:49:38 +0000
@@ -18,6 +18,7 @@
 
 
 __all__ = [
+    'AppHeader',
     'base',
     'check_autopilot_version',
     'CheckBox',
@@ -26,7 +27,7 @@
     'fixture_setup',
     'get_keyboard',
     'get_pointing_device',
-    'AppHeader',
+    'Header',
     'listitems',
     'MainView',
     'OptionSelector',
@@ -52,11 +53,12 @@
     tests,
 )
 from ubuntuuitoolkit._custom_proxy_objects import (
+    AppHeader,
     check_autopilot_version,
     CheckBox,
     get_keyboard,
     get_pointing_device,
-    AppHeader,
+    Header,
     listitems,
     MainView,
     OptionSelector,

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/__init__.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/__init__.py	2014-06-02 20:15:56 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/__init__.py	2014-06-03 20:49:38 +0000
@@ -18,11 +18,12 @@
 
 
 __all__ = [
+    'AppHeader',
     'check_autopilot_version',
     'CheckBox',
     'get_keyboard',
     'get_pointing_device',
-    'AppHeader',
+    'Header',
     'listitems',
     'MainView',
     'OptionSelector',
@@ -47,7 +48,10 @@
     UbuntuUIToolkitCustomProxyObjectBase,
 )
 from ubuntuuitoolkit._custom_proxy_objects._flickable import QQuickFlickable
-from ubuntuuitoolkit._custom_proxy_objects._header import AppHeader
+from ubuntuuitoolkit._custom_proxy_objects._header import (
+    AppHeader,
+    Header,
+)
 from ubuntuuitoolkit._custom_proxy_objects import listitems
 from ubuntuuitoolkit._custom_proxy_objects._mainview import MainView
 from ubuntuuitoolkit._custom_proxy_objects._optionselector import (

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py	2014-06-02 20:15:56 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py	2014-06-03 20:49:38 +0000
@@ -204,3 +204,14 @@
         # to find the requested button
         return self.get_root_instance().select_single(
             'Standard', objectName=object_name)
+
+
+class Header(AppHeader):
+    """Autopilot helper for the deprecated Header."""
+
+    def __init__(self, *args):
+        logger.warning(
+            'Header is an internal QML component of Ubuntu.Components and '
+            'its API may change or be removed at any moment. Please use '
+            'MainView and Page instead.')
+        super(Header, self).__init__(*args)

=== modified file 'tests/autopilot/ubuntuuitoolkit/emulators.py'
--- tests/autopilot/ubuntuuitoolkit/emulators.py	2014-06-02 20:15:56 +0000
+++ tests/autopilot/ubuntuuitoolkit/emulators.py	2014-06-03 20:49:38 +0000
@@ -36,7 +36,7 @@
     'CheckBox',
     'ComposerSheet',
     'Empty',
-    'AppHeader',
+    'Header',
     'ItemSelector',
     'MainView',
     'MultiValue',
@@ -61,7 +61,7 @@
     get_keyboard,
     get_pointing_device,
     CheckBox,
-    AppHeader,
+    Header,
     MainView,
     OptionSelector,
     QQuickFlickable,

=== added file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.DeprecatedHeaderTestCase.qml'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.DeprecatedHeaderTestCase.qml	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.DeprecatedHeaderTestCase.qml	2014-06-03 20:49:38 +0000
@@ -0,0 +1,27 @@
+/*
+ * 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
+
+Item {
+
+    objectName: 'main'
+
+    Header {
+        title: 'test'
+    }
+}

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py	2014-06-02 20:15:56 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py	2014-06-03 20:49:38 +0000
@@ -14,8 +14,12 @@
 # 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 logging
 import os
 
+import fixtures
+from testtools.matchers import Contains
+
 import ubuntuuitoolkit
 from ubuntuuitoolkit import tests
 
@@ -184,3 +188,26 @@
         """
         header = self.main_view.get_header()
         self.assertIsInstance(header, ubuntuuitoolkit.AppHeader)
+
+
+class DeprecatedHeaderTestCase(tests.QMLFileAppTestCase):
+
+    path = os.path.abspath(__file__)
+    dir_path = os.path.dirname(path)
+    test_qml_file_path = os.path.join(
+        dir_path, 'test_header.DeprecatedHeaderTestCase.qml')
+
+    @property
+    def main_view(self):
+        return self.app.select_single('QQuickItem', objectName='main')
+
+    def test_get_deprecated_header_must_log_deprecation_warning(self):
+        fake_logger = fixtures.FakeLogger(level=logging.WARNING)
+        self.useFixture(fake_logger)
+        self.main_view.select_single(ubuntuuitoolkit.Header)
+        self.assertThat(
+            fake_logger.output,
+            Contains(
+                'Header is an internal QML component of Ubuntu.Components and '
+                'its API may change or be removed at any moment. Please use '
+                'MainView and Page instead.'))