Merge lp:~om26er/ubuntu-calendar-app/autopilot_tests_bootstrap into lp:ubuntu-calendar-app

[Omer Akram]

Initial autopilot structure

Initial autopilot structure

[Olivier Tilloy (osomon)]

32 +# Copyright 2012 Canonical

All the copyright notices say 2012, they should be updated to 2013.

review: Needs Fixing

[Olivier Tilloy (osomon)]

163 +class CalendarTestCase(CalendarTestCase):

It looks unwise to give a class the exact same name as its parent.

As a suggestion, in the webbrowser-app, the names of all the actual test cases begin with "Test", e.g.:

    class TestWindowTitle(BrowserTestCaseBase):

Feel free to choose a different naming scheme, but in any case do not use the same name as the base class.

review: Needs Fixing

[Olivier Tilloy (osomon)]

173 + def test_this(self):
174 + print "Now start writing your tests"

How about writing a very simple test case that actually tests something, to give a starting point to other developers? It could be something as simple as asserting that when the app starts, the default view is visible (the calendar app has several types of views).

review: Needs Fixing

[Olivier Tilloy (osomon)]

Warnings raised by pyflakes:

  tests/autopilot/ubuntu_calendar_app/tests/__init__.py:13: 'Eventually' imported but unused
  tests/autopilot/ubuntu_calendar_app/tests/__init__.py:16: 'Equals' imported but unused
  tests/autopilot/ubuntu_calendar_app/tests/test_calendar.py:13: 'model' imported but unused

Warnings raised by pep8:

  tests/autopilot/ubuntu_calendar_app/tests/__init__.py:52:80: E501 line too long (86 > 79 characters)

review: Needs Fixing

[lp:~om26er/ubuntu-calendar-app/autopilot_tests_bootstrap]

37. By Omer Akram on 2013-05-29

year is 2013 now

38. By Omer Akram on 2013-05-29

rename test class

39. By Omer Akram on 2013-05-29

fix pyflakes warnings

40. By Omer Akram on 2013-05-29

add autopilot test for NewEvent dialog

41. By Omer Akram on 2013-05-29

fix more

[Omer Akram (om26er)]

> Warnings raised by pyflakes:
>
> tests/autopilot/ubuntu_calendar_app/tests/__init__.py:13: 'Eventually'
> imported but unused
> tests/autopilot/ubuntu_calendar_app/tests/__init__.py:16: 'Equals' imported
> but unused
> tests/autopilot/ubuntu_calendar_app/tests/test_calendar.py:13: 'model'
> imported but unused
>
>
>
> Warnings raised by pep8:
>
> tests/autopilot/ubuntu_calendar_app/tests/__init__.py:52:80: E501 line too
> long (86 > 79 characters)

Thanks for the review, I have now made the changes as you suggested.

[Olivier Tilloy (osomon)]

133 + def get_new_event_button(self):
134 + return self.app.select_many("Button", visible=True)[1]
135 +
136 + def get_timeline_button(self):
137 + return self.app.select_many("Button", visible=True)[2]

That’s not robust, instead you should give an objectName to those buttons and get a reference to them using self.app.select_single("Button", objectName="…").

review: Needs Fixing

[Olivier Tilloy (osomon)]

224 + x, y, h, w = toolbar.globalRect
225 + tx = x + (h / 2)
226 + ty = y + (w - 2)

If I’m not mistaken the globalRect tuple contains, in this order: x, y, width, height. Using 'h' for width and 'w' for height is very confusing.

review: Needs Fixing

[Olivier Tilloy (osomon)]

ensure_toolbar_visible() works if the toolbar is initially hidden, but will it work if it’s already shown? If not, either the method should be renamed ('ensure' implies that the toolbar will be shown after executing it, regardless of the initial state), or it should account for all possible initial states.

[Omer Akram (om26er)]

> 133 + def get_new_event_button(self):
> 134 + return self.app.select_many("Button", visible=True)[1]
> 135 +
> 136 + def get_timeline_button(self):
> 137 + return self.app.select_many("Button", visible=True)[2]
>
> That’s not robust, instead you should give an objectName to those buttons and
> get a reference to them using self.app.select_single("Button",
> objectName="…").

That's the problem, I have not been able to assign objectNames to those buttons, it seems that doesn't work there.

[Olivier Tilloy (osomon)]

> > 133 + def get_new_event_button(self):
> > 134 + return self.app.select_many("Button", visible=True)[1]
> > 135 +
> > 136 + def get_timeline_button(self):
> > 137 + return self.app.select_many("Button", visible=True)[2]
> >
> > That’s not robust, instead you should give an objectName to those buttons
> and
> > get a reference to them using self.app.select_single("Button",
> > objectName="…").
>
> That's the problem, I have not been able to assign objectNames to those
> buttons, it seems that doesn't work there.

What’s the error you’re getting? If it’s an issue in autopilot itself, we should make sure it’s reported and fixed, not just worked around silently.

[Olivier Tilloy (osomon)]

266 + def test_new_event_page(self):

In its current state, it’s not a very useful test, it doesn’t verify that the event gets actually created, could you please update it to do that?

[Omer Akram (om26er)]

> > > 133 + def get_new_event_button(self):
> > > 134 + return self.app.select_many("Button", visible=True)[1]
> > > 135 +
> > > 136 + def get_timeline_button(self):
> > > 137 + return self.app.select_many("Button", visible=True)[2]
> > >
> > > That’s not robust, instead you should give an objectName to those buttons
> > and
> > > get a reference to them using self.app.select_single("Button",
> > > objectName="…").
> >
> > That's the problem, I have not been able to assign objectNames to those
> > buttons, it seems that doesn't work there.
>
> What’s the error you’re getting? If it’s an issue in autopilot itself, we
> should make sure it’s reported and fixed, not just worked around silently.

I don't think the issue is with autopilot, I am trying this patch http://paste.ubuntu.com/5713531/ to set objectName but it seems I cannot find any thing in autopilot vis with that objectName.

[lp:~om26er/ubuntu-calendar-app/autopilot_tests_bootstrap]

42. By Omer Akram on 2013-05-29

write a simple autopilot test instead of a complex one

[Omer Akram (om26er)]

Now I am using a more "reliable" approach to select object, I have written a much simpler test as you suggested on IRC and also renamed ensure_toolbar_visible()

[Olivier Tilloy (osomon)]

133 + def get_toolbar_button(self, button_idx):
134 + toolbar = self.app.select_single("Toolbar")
135 + item = toolbar.get_children_by_type("QQuickItem")[0]
136 + row = item.get_children_by_type("QQuickRow")[0]
137 + button_loaders = row.get_children_by_type("QQuickLoader")
138 + button_loader = button_loaders[button_idx]
139 + return button_loader

This can be greatly simplified:

    def get_toolbar_button(self, button_idx):
        toolbar = self.app.select_single("Toolbar")
        row = toolbar.select_single("QQuickRow")
        buttons = row.select_many("Button")
        return buttons[button_idx]

review: Needs Fixing

[Olivier Tilloy (osomon)]

277 + def test_timline_view_shows(self):

typo: timline

review: Needs Fixing

[lp:~om26er/ubuntu-calendar-app/autopilot_tests_bootstrap]

43. By Omer Akram on 2013-05-29

fix per suggestions

[Omer Akram (om26er)]

> 133 + def get_toolbar_button(self, button_idx):
> 134 + toolbar = self.app.select_single("Toolbar")
> 135 + item = toolbar.get_children_by_type("QQuickItem")[0]
> 136 + row = item.get_children_by_type("QQuickRow")[0]
> 137 + button_loaders = row.get_children_by_type("QQuickLoader")
> 138 + button_loader = button_loaders[button_idx]
> 139 + return button_loader
>
> This can be greatly simplified:
>
> def get_toolbar_button(self, button_idx):
> toolbar = self.app.select_single("Toolbar")
> row = toolbar.select_single("QQuickRow")
> buttons = row.select_many("Button")
> return buttons[button_idx]

Done. Tested the change as well.

[Olivier Tilloy (osomon)]

Looks good now.

review: Approve

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

review: Approve (continuous-integration)

=== modified file 'NewEvent.qml'
--- NewEvent.qml	2013-03-29 23:12:40 +0000
+++ NewEvent.qml	2013-05-29 16:41:23 +0000
@@ -21,6 +21,7 @@
         ListItem.Empty {
             highlightWhenPressed: false
             TextField {
+                objectName: "newEventName"
                 id: titleEdit
                 placeholderText: i18n.tr("Add event name")
                 anchors {
@@ -69,6 +70,7 @@
                         anchors.left: timeContainer.left
                         width: units.gu(12)
                         TextField {
+                            objectName: "startTimeInput"
                             id: startTimeEdit
                             text: Qt.formatDateTime(defaultDate,"hh")
                             anchors {
@@ -84,6 +86,7 @@
                         anchors.right: timeContainer.right
                         width: units.gu(12)
                         TextField {
+                            objectName: "endTimeInput"
                             id: endTimeEdit
                             text: Qt.formatDateTime(defaultDate,"hh")
                             anchors {
@@ -100,6 +103,7 @@
         ListItem.Empty {
             highlightWhenPressed: false
             TextField {
+                objectName: "eventLocationInput"
                 id: locationEdit
                 placeholderText: i18n.tr("Add Location")
                 anchors {
@@ -113,6 +117,7 @@
         ListItem.Empty {
             highlightWhenPressed: false
             TextField {
+                objectName: "eventPeopleInput"
                 id: personEdit
                 placeholderText: i18n.tr("Invite People")
                 anchors {
@@ -125,6 +130,7 @@
         ListItem.SingleControl {
             highlightWhenPressed: false
             control: Button {
+                objectName: "eventSaveButton"
                 text: i18n.tr("Save")
                 anchors {
                     fill: parent

=== modified file 'debian/control'
--- debian/control	2013-04-11 19:47:11 +0000
+++ debian/control	2013-05-29 16:41:23 +0000
@@ -22,3 +22,12 @@
  It’s about the task and the context; use the calendar app as a todo list,
  a diary, a planner, a journal, a life log; and the calendar will behave how
  you need it to.
+
+Package: ubuntu-calendar-app-autopilot
+Architecture: all
+Depends: libautopilot-qt,
+         libqt5test5,
+         ubuntu-calendar-app (= ${source:Version}),
+Description: Autopilot tests for Ubuntu Calendar Application
+ This package contains autopilot tests for the Ubuntu Calendar application.
+

=== added file 'debian/ubuntu-calendar-app-autopilot.install'
--- debian/ubuntu-calendar-app-autopilot.install	1970-01-01 00:00:00 +0000
+++ debian/ubuntu-calendar-app-autopilot.install	2013-05-29 16:41:23 +0000
@@ -0,0 +1,1 @@
+tests/autopilot/ubuntu_calendar_app/* usr/lib/python2.7/dist-packages/ubuntu_calendar_app/

=== added directory 'tests'
=== added directory 'tests/autopilot'
=== added directory 'tests/autopilot/ubuntu_calendar_app'
=== added file 'tests/autopilot/ubuntu_calendar_app/__init__.py'
--- tests/autopilot/ubuntu_calendar_app/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntu_calendar_app/__init__.py	2013-05-29 16:41:23 +0000
@@ -0,0 +1,8 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2013 Canonical
+#
+# 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.
+
+"""calendar-app tests and emulators - top level package."""

=== added directory 'tests/autopilot/ubuntu_calendar_app/emulators'
=== added file 'tests/autopilot/ubuntu_calendar_app/emulators/__init__.py'
--- tests/autopilot/ubuntu_calendar_app/emulators/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntu_calendar_app/emulators/__init__.py	2013-05-29 16:41:23 +0000
@@ -0,0 +1,6 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2013 Canonical
+#
+# 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.

=== added file 'tests/autopilot/ubuntu_calendar_app/emulators/main_window.py'
--- tests/autopilot/ubuntu_calendar_app/emulators/main_window.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntu_calendar_app/emulators/main_window.py	2013-05-29 16:41:23 +0000
@@ -0,0 +1,62 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2013 Canonical
+#
+# 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.
+
+"""Calendar app autopilot emulators."""
+
+
+class MainWindow(object):
+    """An emulator class that makes it easy to interact with the
+    calendar-app.
+
+    """
+    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_panel(self):
+        return self.app.select_single("Toolbar")
+
+    def get_toolbar_button(self, button_idx):
+        toolbar = self.app.select_single("Toolbar")
+        row = toolbar.select_single("QQuickRow")
+        buttons = row.select_many("Button")
+        return buttons[button_idx]
+
+    def get_toolbar_new_event_button(self):
+        return self.get_toolbar_button(1)
+
+    def get_toolbar_timeline_button(self):
+        return self.get_toolbar_button(2)
+
+    def get_create_event_page(self):
+        return self.app.select_single("NewEvent")
+
+    def get_new_event_name_input_box(self):
+        return self.app.select_single("TextField", objectName="newEventName")
+
+    def get_event_start_time_field(self):
+        return self.app.select_single("TextField", objectName="startTimeInput")
+
+    def get_event_end_time_field(self):
+        return self.app.select_single("TextField", objectName="endTimeInput")
+
+    def get_event_location_field(self):
+        return self.app.select_single(
+            "TextField", objectName="eventLocationInput")
+
+    def get_event_people_field(self):
+        return self.app.select_single(
+            "TextField", objectName="eventPeopleInput")
+
+    def get_event_save_button(self):
+        return self.app.select_single("Button", objectName="eventSaveButton")
+
+    def get_event_view(self):
+        return self.app.select_single("EventView")

=== added directory 'tests/autopilot/ubuntu_calendar_app/tests'
=== added file 'tests/autopilot/ubuntu_calendar_app/tests/__init__.py'
--- tests/autopilot/ubuntu_calendar_app/tests/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntu_calendar_app/tests/__init__.py	2013-05-29 16:41:23 +0000
@@ -0,0 +1,67 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2013 Canonical
+#
+# 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.
+
+"""Calendar app autopilot tests."""
+
+import os.path
+
+from autopilot.input import Mouse, Touch, Pointer
+from autopilot.matchers import Eventually
+from autopilot.platform import model
+from autopilot.testcase import AutopilotTestCase
+from testtools.matchers import Equals
+
+from ubuntu_calendar_app.emulators.main_window import MainWindow
+
+
+class CalendarTestCase(AutopilotTestCase):
+
+    """A common test case class that provides several useful methods for
+    calendar-app tests.
+
+    """
+    if model() == 'Desktop':
+        scenarios = [('with mouse', dict(input_device_class=Mouse))]
+    else:
+        scenarios = [('with touch', dict(input_device_class=Touch))]
+
+    local_location = "../../calendar.qml"
+
+    def setUp(self):
+        self.pointing_device = Pointer(self.input_device_class.create())
+        super(CalendarTestCase, 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/ubuntu-calendar-app/calendar.qml",
+            "--desktop_file_hint=/usr/share/applications/ubuntu-calendar-app.desktop",
+            app_type='qt')
+
+    def reveal_toolbar(self):
+        toolbar = self.main_window.get_panel()
+
+        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")))
+
+    @property
+    def main_window(self):
+        return MainWindow(self.app)

=== added file 'tests/autopilot/ubuntu_calendar_app/tests/test_calendar.py'
--- tests/autopilot/ubuntu_calendar_app/tests/test_calendar.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntu_calendar_app/tests/test_calendar.py	2013-05-29 16:41:23 +0000
@@ -0,0 +1,37 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2013 Canonical
+#
+# 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.
+
+"""Calendar app autopilot tests."""
+
+from __future__ import absolute_import
+
+from autopilot.matchers import Eventually
+from testtools.matchers import Equals
+
+from ubuntu_calendar_app.tests import CalendarTestCase
+
+
+class TestMainWindow(CalendarTestCase):
+
+    def setUp(self):
+        super(TestMainWindow, self).setUp()
+        self.assertThat(
+            self.main_window.get_qml_view().visible, Eventually(Equals(True)))
+
+    def tearDown(self):
+        super(TestMainWindow, self).tearDown()
+
+    def test_timeline_view_shows(self):
+        timeline_button = self.main_window.get_toolbar_timeline_button()
+        event_view = self.main_window.get_event_view()
+        self.reveal_toolbar()
+
+        self.assertThat(event_view.eventViewType, Eventually(Equals("DiaryView.qml")))
+        self.pointing_device.click_object(timeline_button)
+        self.assertThat(event_view.eventViewType, Eventually(Equals("TimeLineView.qml")))
+        self.pointing_device.click_object(timeline_button)
+        self.assertThat(event_view.eventViewType, Eventually(Equals("DiaryView.qml")))