Merge lp:~nskaggs/ubuntu-calendar-app/refactor-tests into lp:ubuntu-calendar-app

[Nicholas Skaggs]

Refactor tests to use page object model

Refactor tests to use page object model

[lp:~nskaggs/ubuntu-calendar-app/refactor-tests]

214. By Nicholas Skaggs on 2014-03-19

wip monthview

215. By Nicholas Skaggs on 2014-03-20

incorporate fixes from stable

[Leo Arias (elopio)]

Balloons, this is already too old and the code has changed a lot. I'm rejecting it.

review: Disapprove

Unmerged revisions

215. By Nicholas Skaggs on 2014-03-20

incorporate fixes from stable

214. By Nicholas Skaggs on 2014-03-19

wip monthview

=== modified file 'tests/autopilot/calendar_app/emulators.py'
--- tests/autopilot/calendar_app/emulators.py	2013-12-16 21:32:43 +0000
+++ tests/autopilot/calendar_app/emulators.py	2014-03-20 03:45:39 +0000
@@ -7,22 +7,44 @@
 
 """Calendar app autopilot emulators."""
 
+import logging
 from autopilot.introspection import dbus
+from autopilot import logging as autopilot_logging
+
 from ubuntuuitoolkit import emulators as toolkit_emulators
 
+logger = logging.getLogger(__name__)
+
+
+class CalendarEmulatorException(toolkit_emulators.ToolkitEmulatorException):
+    """Exception raised when there is an error with the emulator."""
 
 class MainView(toolkit_emulators.MainView):
 
-    """
-    An emulator class that makes it easy to interact with the calendar-app.
-    """
+    @autopilot_logging.log_action(logger.info)
+    def open_dayview(self):
+        """Open the Dayview tab.
+
+        :return: the Dayview page.
+
+        """
+        self.switch_to_tab('dayTab')
+        return self.wait_select_single(DayviewPage)
+
+    @autopilot_logging.log_action(logger.info)
+    def open_monthview(self):
+        """Open the Monthview Tab.
+
+        :return: the Monthview page.
+
+        """
+        self.switch_to_tab('monthTab')
+        return self.wait_select_single(MonthviewPage)
+
 
     def get_event_view(self):
         return self.wait_select_single("EventView")
 
-    def get_month_view(self):
-        return self.wait_select_single("MonthView")
-
     def get_year_view(self):
         return self.wait_select_single("YearView")
 
@@ -78,6 +100,30 @@
         except dbus.StateNotFoundError:
             return None
 
+    def get_year(self, component):
+        return int(component.wait_select_single(
+            "Label", objectName="yearLabel").text)
+
+    def get_num_events(self):
+        return len(self.select_many("EventBubble"))
+
+class Page(toolkit_emulators.UbuntuUIToolkitEmulatorBase):
+    """Autopilot helper for Pages."""
+
+    def __init__(self, *args):
+        super(Page, self).__init__(*args)
+        # XXX we need a better way to keep reference to the main view.
+        # --elopio - 2014-01-31
+        self.main_view = self.get_root_instance().select_single(MainView)
+
+    def drag_page_up(self):
+        """Drag the given page up."""
+        self._drag_page(direction='up')
+
+    def drag_page_down(self):
+        """Drag the given page down."""
+        self._drag_page(direction='down')
+
     def swipe_view(self, direction, view, x_pad=0.15):
         """Swipe the given view to left or right.
 
@@ -96,10 +142,55 @@
 
         self.pointing_device.drag(x_start, y_line, x_stop, y_line)
 
-    def get_year(self, component):
-        return int(component.wait_select_single(
-            "Label", objectName="yearLabel").text)
-
-    def get_month_name(self, component):
-        return component.wait_select_single(
-            "Label", objectName="monthLabel").text
+    def _drag_page(self, direction):
+        """Function to drag the page up/down."""
+        self._wait_to_stop_moving()
+
+        x, y, w, h = self.globalRect
+        start_x = stop_x = x + (w / 2)
+        start_y = y + (h / 2)
+
+        if direction == "down":
+            stop_y = start_y + h / 3
+            self.pointing_device.drag(start_x, start_y, stop_x, stop_y)
+        else:
+            stop_y = start_y - h / 3
+            self.pointing_device.drag(start_x, start_y, stop_x, stop_y)
+
+        self._wait_to_stop_moving()
+
+    def _wait_to_stop_moving(self):
+        self.select_single(
+            'QQuickFlickable',
+            objectName='animationContainer').moving.wait_for(False)
+
+class DayviewPage(Page):
+    """Autopilot helper for the Dayview page."""
+
+
+class MonthviewPage(Page):
+    """Autopilot helper for the Monthview page."""
+
+    def __init__(self):
+        self.view = self.wait_select_single("MonthView")
+
+    def change_month(self, delta):
+        sign = int(math.copysign(1, delta))
+
+        for _ in range(abs(delta)):
+            before = month_view.currentMonth.datetime
+
+            #prevent timing issues with swiping
+            old_month = self.currentMonth.datetime
+            self.swipe_view(sign, month_view)
+            #self.assertThat(lambda: self.currentMonth.datetime,
+            #                Eventually(NotEquals(old_month)))
+
+            after = before + relativedelta(months=sign)
+
+            #self.assertThat(lambda:
+            #                self.currentMonth.datetime.month,
+            #                Eventually(Equals(after.month)))
+            #self.assertThat(lambda:
+            #                self.currentMonth.datetime.year,
+            #                Eventually(Equals(after.year)))

=== modified file 'tests/autopilot/calendar_app/tests/__init__.py'
--- tests/autopilot/calendar_app/tests/__init__.py	2014-01-31 21:15:52 +0000
+++ tests/autopilot/calendar_app/tests/__init__.py	2014-03-20 03:45:39 +0000
@@ -22,6 +22,12 @@
 import shutil
 import logging
 
+try:
+    from unittest import mock
+except ImportError:
+    import mock
+import tempfile
+
 from autopilot.input import Mouse, Touch, Pointer
 from autopilot.platform import model
 from autopilot.testcase import AutopilotTestCase
@@ -45,20 +51,16 @@
 
     local_location = "../../calendar.qml"
     installed_location = "/usr/share/calendar-app/calendar.qml"
-    sqlite_dir = os.path.expanduser(
-        "~/.local/share/com.ubuntu.calendar/Databases")
-    backup_dir = sqlite_dir + ".backup"
 
     def setUp(self):
         self.pointing_device = Pointer(self.input_device_class.create())
+        self.home_dir = self._patch_home()
         super(CalendarTestCase, self).setUp()
-        self.temp_move_sqlite_db()
-        self.addCleanup(self.restore_sqlite_db)
 
         #turn off the OSK so it doesn't block screen elements
-        if model() != 'Desktop':
-            os.system("stop maliit-server")
-            self.addCleanup(os.system, "start maliit-server")
+        #if model() != 'Desktop':
+        #    os.system("stop maliit-server")
+        #    self.addCleanup(os.system, "start maliit-server")
 
         # Unset the current locale to ensure locale-specific data
         # (day and month names, first day of the week, …) doesn’t get
@@ -73,6 +75,7 @@
             self.launch_test_click()
 
     def launch_test_local(self):
+        logger.debug("Running via local installation")
         self.app = self.launch_test_application(
             "qmlscene",
             self.local_location,
@@ -80,6 +83,7 @@
             emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
 
     def launch_test_installed(self):
+        logger.debug("Running via installed debian package")
         self.app = self.launch_test_application(
             "qmlscene",
             self.installed_location,
@@ -87,39 +91,30 @@
             emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
 
     def launch_test_click(self):
+        logger.debug("Running via click package")
         self.app = self.launch_click_package(
             "com.ubuntu.calendar",
             emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
 
-    def temp_move_sqlite_db(self):
-        try:
-            shutil.rmtree(self.backup_dir)
-        except:
-            pass
-        else:
-            logger.warning("Prexisting backup database found and removed")
-
-        try:
-            shutil.move(self.sqlite_dir, self.backup_dir)
-        except:
-            logger.warning("No current database found")
-        else:
-            logger.debug("Backed up database")
-
-    def restore_sqlite_db(self):
-        if os.path.exists(self.backup_dir):
-            if os.path.exists(self.sqlite_dir):
-                try:
-                    shutil.rmtree(self.sqlite_dir)
-                except:
-                    logger.error("Failed to remove test database and restore" /
-                                 "database")
-                    return
-            try:
-                shutil.move(self.backup_dir, self.sqlite_dir)
-            except:
-                logger.error("Failed to restore database")
+    def _patch_home(self):
+        #make a temp dir
+        temp_dir = tempfile.mkdtemp()
+        logger.debug("Created fake home directory " + temp_dir)
+        self.addCleanup(shutil.rmtree, temp_dir)
+        #if the Xauthority file is in home directory
+        #make sure we copy it to temp home, otherwise do nothing
+        xauth = os.path.expanduser(os.path.join('~', '.Xauthority'))
+        if os.path.isfile(xauth):
+            logger.debug("Copying .Xauthority to fake home " + temp_dir)
+            shutil.copyfile(
+                os.path.expanduser(os.path.join('~', '.Xauthority')),
+                os.path.join(temp_dir, '.Xauthority'))
+        patcher = mock.patch.dict('os.environ', {'HOME': temp_dir})
+        patcher.start()
+        logger.debug("Patched home to fake home directory " + temp_dir)
+        self.addCleanup(patcher.stop)
+        return temp_dir
 
     @property
     def main_view(self):
-        return self.app.select_single(emulators.MainView)
+        return self.app.wait_select_single(emulators.MainView)

=== modified file 'tests/autopilot/calendar_app/tests/test_calendar.py'
--- tests/autopilot/calendar_app/tests/test_calendar.py	2014-01-11 06:05:42 +0000
+++ tests/autopilot/calendar_app/tests/test_calendar.py	2014-03-20 03:45:39 +0000
@@ -11,7 +11,7 @@
 
 from autopilot.matchers import Eventually
 
-from testtools.matchers import Equals, Not, Is
+from testtools.matchers import Equals, Not, Is, NotEquals
 
 import time
 
@@ -46,6 +46,10 @@
 
     def test_new_event(self):
         """test add new event """
+        #go to today
+        self.main_view.switch_to_tab("dayTab")
+        self.main_view.open_toolbar().click_button("todaybutton")
+        num_events = self.main_view.get_num_events()
 
         #click on new event button
         self.main_view.open_toolbar().click_button("neweventbutton")
@@ -68,7 +72,7 @@
         ok = picker.select_single("Button", objectName="TimePickerOKButton")
         self.pointing_device.click_object(ok)
 
-        # Set the end time
+        ## Set the end time
         end_time_field = self.main_view.get_event_end_time_field()
         self.pointing_device.click_object(end_time_field)
         picker = self.main_view.get_time_picker()
@@ -83,18 +87,10 @@
         self.keyboard.type("My location")
         self.assertThat(location_field.text, Eventually(Equals("My location")))
 
-        #input people
-        people_field = self.main_view.get_event_people_field()
-        self.pointing_device.click_object(people_field)
-        self.assertThat(people_field.activeFocus, Eventually(Equals(True)))
-        self.keyboard.type("Me")
-        self.assertThat(people_field.text, Eventually(Equals("Me")))
-
         #click save button
         self.main_view.open_toolbar().click_button("eventSaveButton")
 
         #verify that the event has been created in timeline
-        self.main_view.switch_to_tab("dayTab")
-        self.assertThat(lambda: self.main_view.get_label_with_text(
-                        eventTitle, root=self.main_view.get_day_view()),
-                        Eventually(Not(Is(None))))
+        self.main_view.open_toolbar().click_button("todaybutton")
+        self.assertThat(self.main_view.get_num_events,
+                        Eventually(NotEquals(num_events)))

=== modified file 'tests/autopilot/calendar_app/tests/test_monthview.py'
--- tests/autopilot/calendar_app/tests/test_monthview.py	2014-01-09 23:30:55 +0000
+++ tests/autopilot/calendar_app/tests/test_monthview.py	2014-03-20 03:45:39 +0000
@@ -24,59 +24,25 @@
 
     def setUp(self):
         super(TestMonthView, self).setUp()
-        self.assertThat(self.main_view.visible, Eventually(Equals(True)))
-        self.main_view.switch_to_tab("monthTab")
-
         self.assertThat(
-            self.main_view.get_month_view, Eventually(NotEquals(None)))
-
-        self.month_view = self.main_view.get_month_view()
-
-    def change_month(self, delta):
-        month_view = self.main_view.get_month_view()
-        sign = int(math.copysign(1, delta))
-
-        for _ in range(abs(delta)):
-            before = month_view.currentMonth.datetime
-
-            #prevent timing issues with swiping
-            old_month = month_view.currentMonth.datetime
-            self.main_view.swipe_view(sign, month_view)
-            self.assertThat(lambda: month_view.currentMonth.datetime,
-                            Eventually(NotEquals(old_month)))
-
-            after = before + relativedelta(months=sign)
-
-            self.assertThat(lambda:
-                            self.month_view.currentMonth.datetime.month,
-                            Eventually(Equals(after.month)))
-            self.assertThat(lambda:
-                            self.month_view.currentMonth.datetime.year,
-                            Eventually(Equals(after.year)))
-
-    def _assert_today(self):
-        today = datetime.today()
-        self.assertThat(lambda: self.month_view.currentMonth.datetime.day,
+            self.main_view.visible, Eventually(Equals(True)))
+        self.page = self.main_view.open_monthview()
+
+    def test_monthview_go_to_today_next_month(self):
+        self.page.change_month(1)
+        self.main_view.open_toolbar().click_button("todaybutton")
+        self.assertThat(lambda: self.page.currentMonth.datetime.day,
                         Eventually(Equals(today.day)))
-        self.assertThat(lambda: self.month_view.currentMonth.datetime.month,
+        self.assertThat(lambda: self.page.currentMonth.datetime.month,
                         Eventually(Equals(today.month)))
-        self.assertThat(lambda: self.month_view.currentMonth.datetime.year,
+        self.assertThat(lambda: self.page.currentMonth.datetime.year,
                         Eventually(Equals(today.year)))
 
-    def _test_go_to_today(self, delta):
-        self._assert_today()
-        self.change_month(delta)
-        self.main_view.open_toolbar().click_button("todaybutton")
-        self._assert_today()
-
-    def test_monthview_go_to_today_next_month(self):
-        self._test_go_to_today(1)
-
     def test_monthview_go_to_today_prev_month(self):
-        self._test_go_to_today(-1)
+        self.page.change_month(-1)
 
     def test_monthview_go_to_today_next_year(self):
-        self._test_go_to_today(12)
+        self.page.change_month(12)
 
     def test_monthview_go_to_today_prev_year(self):
-        self._test_go_to_today(-12)
+        self.page.change_month(-12)