Merge lp:~nskaggs/ubuntu-clock-app/switch-emulators-to-proxy-object into lp:ubuntu-clock-app/saucy

[Nicholas Skaggs]

Switch to custom proxy object emulator, instead of calling via old emulators module.

Switch to custom proxy object emulator, instead of calling via old emulators module.

Also cleanup write method for textfield as https://bugs.launchpad.net/ubuntu-ui-toolkit/+bug/1289616 is fixed

[Nicholas Skaggs (nskaggs)]

Left a note about the exception removal.

Also, I renamed emulators.py to custom_proxy_objects.py. I also used helpers sometimes. Do we like this naming?

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

FAILED: Continuous integration, rev:462
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/387/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1042
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1042/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/34

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/387/rebuild

review: Needs Fixing (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

Nice I like the simplicity of just calling ubuntuuitoolkit.Base, seems more formal. Considering that the bug regarding the textfield has been fixed in the SDK emulators, I think it is fine to remove it here. However let's keep this in mind in case we have some failures popping up in QA (obviously there shouldn't be any, but just in case).

>I renamed emulators.py to custom_proxy_objects.py.

Considering that this file mainly houses classes and functions that help tests, wouldn't something along the lines of clock_helper.py be more suitable? custom_proxy_objects is a bit difficult to comprehend :D

But otherwise looks good.

[Nekhelesh Ramananthan (nik90)]

I will test this MP on the phone tomorrow before approving. I just did the code review for now.

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

FAILED: Continuous integration, rev:463
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/388/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1043
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1043/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/35

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/388/rebuild

review: Needs Fixing (continuous-integration)

[Nicholas Skaggs (nskaggs)]

@nik, yes custom_proxy_objects.py is a mouthful, but is more or less consistent. I'd like to get some consensus on what we'd like to call this (I suppose Leo's new arrangement doesn't include this file, some it's ambigious).

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

FAILED: Continuous integration, rev:464
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/389/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1055
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1055/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/36

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/389/rebuild

review: Needs Fixing (continuous-integration)

[Leo Arias (elopio)]

11 === renamed file 'tests/autopilot/ubuntu_clock_app/emulators.py' => 'tests/autopilot/ubuntu_clock_app/custom_proxy_objects.py'
12 --- tests/autopilot/ubuntu_clock_app/emulators.py 2014-07-05 07:58:53 +0000

What we are doing actually is to put most of the things that were on ubuntu_clock_app/emulators.py into ubutu_clock_app/__init__.py.
If it grows to big, I started moving some of the objects into ubuntu_clock_app/pages/name_of_the_page.py

173 - # TODO: This wait to ensure that the textfield is visible before
174 - # entering text should be part of the SDK emulator. Until then, it has
175 - # been added here. http://pad.lv/1289616 --nik90 2014-03-06
176 - name_alarm.visible.wait_for(True)

On the text field helper, we are waiting for it to be focused, not to be visible. I left a comment on that bug saying that now I think it's the caller who should wait for the UI to be ready to receive input.
But anyway, I have done nothing yet to remove this wait. If it's no longer needed, then it's because the clock UI changed, not because the bug is fixed.

[Nicholas Skaggs (nskaggs)]

> What we are doing actually is to put most of the things that were on
> ubuntu_clock_app/emulators.py into ubutu_clock_app/__init__.py.
> If it grows to big, I started moving some of the objects into
> ubuntu_clock_app/pages/name_of_the_page.py
>
Thanks for writing that out. I was fumbling over words trying to explain that the emulators.py file more or less is legacy, so a name isn't really worth worrying about. Though we need one until we move things ;)
> 173 - # TODO: This wait to ensure that the textfield is visible before
> 174 - # entering text should be part of the SDK emulator. Until then, it
> has
> 175 - # been added here. http://pad.lv/1289616 --nik90 2014-03-06
> 176 - name_alarm.visible.wait_for(True)
>
> On the text field helper, we are waiting for it to be focused, not to be
> visible. I left a comment on that bug saying that now I think it's the caller
> who should wait for the UI to be ready to receive input.
> But anyway, I have done nothing yet to remove this wait. If it's no longer
> needed, then it's because the clock UI changed, not because the bug is fixed.
When I check the helper, it indeed showed you are waiting for the object to be focused; but inherently if it's focused it's writeable. I guess we can argue semantics about being visible. The point is, if it's focused it's ready to receive input which is what we need. Visible lies anyway, so if you are wanting to know if the item is onscreen and visible, that's really for the test writer I agree.

[Nicholas Skaggs (nskaggs)]

Leo, I just re-read your comment. So you are saying the isFocused property can be true, while at the same time the object can be not ready to receive input? That seems a bit.. weird.

[Leo Arias (elopio)]

> Leo, I just re-read your comment. So you are saying the isFocused property can
> be true, while at the same time the object can be not ready to receive input?
> That seems a bit.. weird.

No, the original issue iirc was that we were clicking the textfield before it was visible. So it never got the focus. I might be wrong though, Nik has a younger brain so he might remember more.

[Leo Arias (elopio)]

Anyway, for better traceability it would be better if you remove the #TODO in a different branch. That way we can revert them independently in case we break something.

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

FAILED: Continuous integration, rev:466
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/390/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1078/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/37/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/390/rebuild

review: Needs Fixing (continuous-integration)

[lp:~nskaggs/ubuntu-clock-app/switch-emulators-to-proxy-object]

467. By Nicholas Skaggs on 2014-07-21

flake8 happiness

[Nicholas Skaggs (nskaggs)]

> Anyway, for better traceability it would be better if you remove the #TODO in
> a different branch. That way we can revert them independently in case we break
> something.

True, I've done this.

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

FAILED: Continuous integration, rev:467
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/391/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1079
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1079/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/38

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/391/rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:467
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/394/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1133
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1133/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/41

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/394/rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:467
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/395/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1273
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1273/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/42

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/395/rebuild

review: Needs Fixing (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

> > Anyway, for better traceability it would be better if you remove the #TODO
> in
> > a different branch. That way we can revert them independently in case we
> break
> > something.
>
> True, I've done this.

Lets not remove any current workarounds present in the old clock app since it might not be worth the effort considering that the new clock app will replace the old clock app in another week or two. I am concentrating on getting the new clock app AP tests ready to make the replacement happen.

[Nicholas Skaggs (nskaggs)]

I've set this as WIP and will abandon it likely once the transition happens unless something unforeseen occurs.

Unmerged revisions

467. By Nicholas Skaggs on 2014-07-21

flake8 happiness

466. By Nicholas Skaggs on 2014-07-21

undo extraneous TODO removal to keep MP focused

465. By Nicholas Skaggs on 2014-07-17

rename custom_proxy_objects to helpers

464. By Nicholas Skaggs on 2014-07-17

fix Base to be base

463. By Nicholas Skaggs on 2014-07-16

fix multivalue call

462. By Nicholas Skaggs on 2014-07-16

fix flake8

461. By Nicholas Skaggs on 2014-07-16

change emulators to custom proxy objects

=== modified file 'tests/autopilot/ubuntu_clock_app/__init__.py'
--- tests/autopilot/ubuntu_clock_app/__init__.py	2013-04-10 03:05:19 +0000
+++ tests/autopilot/ubuntu_clock_app/__init__.py	2014-07-21 15:31:00 +0000
@@ -16,4 +16,4 @@
 #
 # Authored by: Renato Araujo Oliveira Filho <[e-mail]>
 
-"""clock-app autopilot tests and emulators - top level package."""
+"""clock-app autopilot tests and helpers - top level package."""

=== renamed file 'tests/autopilot/ubuntu_clock_app/emulators.py' => 'tests/autopilot/ubuntu_clock_app/helpers.py'
--- tests/autopilot/ubuntu_clock_app/emulators.py	2014-07-05 07:58:53 +0000
+++ tests/autopilot/ubuntu_clock_app/helpers.py	2014-07-21 15:31:00 +0000
@@ -24,17 +24,17 @@
 from autopilot.introspection import dbus
 from autopilot import logging as autopilot_logging
 
-from ubuntuuitoolkit import emulators as toolkit_emulators
+import ubuntuuitoolkit
 
 logger = logging.getLogger(__name__)
 
 
-class ClockEmulatorException(toolkit_emulators.ToolkitEmulatorException):
-
-    """Exception raised when there is an error with the emulator."""
-
-
-class MainView(toolkit_emulators.MainView):
+class ClockHelperException(ubuntuuitoolkit.ToolkitException):
+
+    """Exception raised when there is an error with the toolkit helpers."""
+
+
+class MainView(ubuntuuitoolkit.MainView):
 
     @autopilot_logging.log_action(logger.info)
     def open_timer(self):
@@ -76,12 +76,12 @@
         return self.wait_select_single(ClockPage)
 
 
-class LabelDots(toolkit_emulators.TextField):
+class LabelDots(ubuntuuitoolkit.TextField):
 
     """Autopilot helper for the LabelDots component."""
 
 
-class Page(toolkit_emulators.UbuntuUIToolkitEmulatorBase):
+class Page(ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase):
 
     """Autopilot helper for Pages."""
 
@@ -141,7 +141,7 @@
     def _get_saved_world_city_list(self):
         """Return the saved world city listview object"""
         return self.wait_select_single(
-            toolkit_emulators.QQuickListView, objectName='listWorldClocks')
+            ubuntuuitoolkit.QQuickListView, objectName='listWorldClocks')
 
     @autopilot_logging.log_action(logger.info)
     def add_world_city(self, index):
@@ -155,7 +155,7 @@
         try:
             self._confirm_world_city_addition(index)
         except AssertionError:
-            raise ClockEmulatorException('Error adding world city.')
+            raise ClockHelperException('Error adding world city.')
 
     def _click_add_city_button(self):
         """Click the add city header button"""
@@ -188,7 +188,7 @@
         try:
             self._confirm_world_city_deletion(old_count=old_world_city_count)
         except AssertionError:
-            raise ClockEmulatorException('Error deleting world city.')
+            raise ClockHelperException('Error deleting world city.')
 
     def _get_saved_world_city(self, index):
         """Return saved world city object"""
@@ -245,7 +245,7 @@
         self._click_back_button()
 
 
-class WorldClock(toolkit_emulators.UbuntuUIToolkitEmulatorBase):
+class WorldClock(ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase):
 
     """Autopilot helper for the World Clock Page"""
 
@@ -256,7 +256,7 @@
 
         """
         city = self.wait_select_single(
-            toolkit_emulators.Base, objectName='worldcity{}'.format(index))
+            ubuntuuitoolkit.base, objectName='worldcity{}'.format(index))
         self.pointing_device.click_object(city)
 
 
@@ -279,7 +279,7 @@
     def enable_show_seconds_option(self):
         """Enable the show seconds option"""
         show_seconds_checkbox = self.proxy_object.wait_select_single(
-            toolkit_emulators.CheckBox, objectName='showSecondsCheckbox')
+            ubuntuuitoolkit.CheckBox, objectName='showSecondsCheckbox')
         show_seconds_checkbox.check()
 
     @autopilot_logging.log_action(logger.info)
@@ -290,7 +290,7 @@
 
         """
         time_format_selector = self.proxy_object.wait_select_single(
-            toolkit_emulators.OptionSelector, objectName='timeFormatSelector')
+            ubuntuuitoolkit.OptionSelector, objectName='timeFormatSelector')
 
         time_format_selector.select_option('Label', text=format)
 
@@ -379,7 +379,7 @@
     def _get_saved_alarms_list(self):
         """Return the saved alarm list"""
         return self.wait_select_single(
-            toolkit_emulators.QQuickListView, objectName='listSavedAlarm')
+            ubuntuuitoolkit.QQuickListView, objectName='listSavedAlarm')
 
     @autopilot_logging.log_action(logger.info)
     def add_single_alarm(self, name, day):
@@ -433,7 +433,7 @@
         try:
             self._get_saved_alarms_list().count.wait_for(count + 1)
         except AssertionError:
-            raise ClockEmulatorException('Error creating alarm.')
+            raise ClockHelperException('Error creating alarm.')
 
     def _click_add_alarm_button(self):
         """Click the add alarm header button."""
@@ -451,7 +451,7 @@
         """Delete an alarm at the specified index."""
         old_alarm_count = self.get_num_of_alarms()
         alarm = self.wait_select_single(
-            toolkit_emulators.Base, objectName='alarm{}'.format(index))
+            ubuntuuitoolkit.base, objectName='alarm{}'.format(index))
         if not self.main_view.wideAspect:
             self.drag_page_up()
         alarm.swipe_to_delete()
@@ -459,13 +459,13 @@
         try:
             self._get_saved_alarms_list().count.wait_for(old_alarm_count - 1)
         except AssertionError:
-            raise ClockEmulatorException('Error deleting alarm.')
+            raise ClockHelperException('Error deleting alarm.')
 
     @autopilot_logging.log_action(logger.info)
     def toggle_alarm(self, index):
         """Toggle an alarm on/off."""
         alarm = self.wait_select_single(
-            toolkit_emulators.CheckBox,
+            ubuntuuitoolkit.CheckBox,
             objectName='listAlarmStatus{}'.format(index))
         if not self.main_view.wideAspect:
             self.drag_page_up()
@@ -492,7 +492,7 @@
             # TODO: Check the alarm enabled status once the bug at
             # http://pad.lv/1272337 is resolved
             # enabled = self.select_single(
-            #    toolkit_emulators.CheckBox,
+            #    ubuntuuitoolkit.CheckBox,
             #    objectName='listAlarmStatus{}'.format(index)).checked
             alarms.append((name, recurrence))
         return alarms
@@ -574,7 +574,7 @@
     def enable_recurring_alarm_type_switch(self):
         """Enable the recurring alarm type switch"""
         alarm_type_checkbox = self.wait_select_single(
-            toolkit_emulators.CheckBox, objectName='RepeatSelector')
+            ubuntuuitoolkit.CheckBox, objectName='RepeatSelector')
         alarm_type_checkbox.check()
 
     @autopilot_logging.log_action(logger.info)
@@ -585,7 +585,7 @@
 
         """
         day_option_selector = self.select_single(
-            toolkit_emulators.OptionSelector, objectName='OccursSelector')
+            ubuntuuitoolkit.OptionSelector, objectName='OccursSelector')
 
         # Wait for the option selector to expand
         if not day_option_selector.currentlyExpanded:
@@ -614,7 +614,7 @@
     def _open_recurring_alarm_dialog(self):
         """Open the recurring alarm dialogue."""
         recurring_option = self.wait_select_single(
-            toolkit_emulators.MultiValue, objectName='OccurrenceList')
+            ubuntuuitoolkit.listitems.MultiValue, objectName='OccurrenceList')
         self.pointing_device.click_object(recurring_option)
         alarm_days_dialog = self.main_view.wait_select_single(
             AlarmDays, objectName='alarmDaysDialog')
@@ -622,7 +622,7 @@
         return alarm_days_dialog
 
 
-class AlarmDays(toolkit_emulators.UbuntuUIToolkitEmulatorBase):
+class AlarmDays(ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase):
 
     """Autopilot helper for the Alarm Days dialog."""
 
@@ -647,7 +647,7 @@
             day_element_label = self.wait_select_single(
                 'Label', objectName='repeatDaysLabel{}'.format(index))
             day_element = self.wait_select_single(
-                toolkit_emulators.CheckBox,
+                ubuntuuitoolkit.CheckBox,
                 objectName='repeatDaysSwitch{}'.format(index))
             if day_element_label.text in days_to_select:
                 day_element.check()
@@ -656,7 +656,7 @@
                 day_element.uncheck()
 
         if days_to_select != []:
-            raise ClockEmulatorException(
+            raise ClockHelperException(
                 "Can't enable the alarm for days {}".format(days_to_select))
 
     def _click_confirm_recurring_alarm_days(self):
@@ -712,7 +712,7 @@
         name_label.visible.wait_for(True)
         name_label.write(name)
         if name_label.text != name:
-            raise ClockEmulatorException('Failed to write the timer name.')
+            raise ClockHelperException('Failed to write the timer name.')
 
     def _set_time(self):
         """Set the timer hour and minute"""
@@ -728,7 +728,7 @@
             sleep(1)
             timeout += 1
 
-        # TODO we need a dialer hand emulator, with proper self-tests.
+        # TODO we need a dialer hand helper, with proper self-tests.
         # --elopio -2014-01-31
         minute = self._get_timer_minute_hand()
         # make sure timer is set
@@ -802,7 +802,7 @@
 
         """
         presets_list = self.wait_select_single(
-            toolkit_emulators.QQuickListView, objectName='listTimerPreset')
+            ubuntuuitoolkit.QQuickListView, objectName='listTimerPreset')
         presets_list.click_element('preset{}'.format(index))
 
     def get_current_time(self):
@@ -835,6 +835,6 @@
         if not self.main_view.wideAspect:
             self.drag_page_up()
         preset = self.select_single(
-            toolkit_emulators.Standard, objectName='preset{}'.format(index))
+            ubuntuuitoolkit.Standard, objectName='preset{}'.format(index))
         preset.swipe_to_delete()
         preset.confirm_removal()

=== modified file 'tests/autopilot/ubuntu_clock_app/tests/__init__.py'
--- tests/autopilot/ubuntu_clock_app/tests/__init__.py	2014-06-27 15:22:04 +0000
+++ tests/autopilot/ubuntu_clock_app/tests/__init__.py	2014-07-21 15:31:00 +0000
@@ -26,12 +26,10 @@
 
 from autopilot import input
 from autopilot.platform import model
-from ubuntuuitoolkit import (
-    base,
-    emulators as toolkit_emulators
-)
+from ubuntuuitoolkit import base
+import ubuntuuitoolkit
 
-from ubuntu_clock_app import emulators
+from ubuntu_clock_app import helpers
 
 logger = logging.getLogger(__name__)
 
@@ -73,19 +71,19 @@
             base.get_qmlscene_launch_command(),
             self.local_location,
             app_type='qt',
-            emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
+            emulator_base=ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase)
 
     def launch_test_installed(self):
         self.app = self.launch_test_application(
             base.get_qmlscene_launch_command(),
             self.installed_location,
             app_type='qt',
-            emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
+            emulator_base=ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase)
 
     def launch_test_click(self):
         self.app = self.launch_click_package(
             "com.ubuntu.clock",
-            emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
+            emulator_base=ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase)
 
     def temp_move_sqlite_db(self):
         try:
@@ -118,4 +116,4 @@
 
     @property
     def main_view(self):
-        return self.app.wait_select_single(emulators.MainView)
+        return self.app.wait_select_single(helpers.MainView)