Merge lp:~elopio/ubuntu-rssreader-app/refactor_tests into lp:~ubuntu-shorts-dev/ubuntu-rssreader-app/trunk

[Leo Arias]

Cleaned a test to add a feed to a new topic.

I started refactoring the first test, but it includes an add and delete test. This branch only includes the add part. So, for now I'm not removing any old code or tests. I find it nicer to go slowly.
Please let me know what you think, and if we should continue writing the tests this way.

[lp:~elopio/ubuntu-rssreader-app/refactor_tests]

184. By Leo Arias on 2014-02-27

Fixed the copyright statements.

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

FAILED: Continuous integration, rev:184
http://91.189.93.70:8080/job/ubuntu-rssreader-app-ci/184/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-trusty/1524
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-rssreader-app-raring-amd64-ci/184
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-rssreader-app-saucy-amd64-ci/184
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-rssreader-app-trusty-amd64-ci/71

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

review: Needs Fixing (continuous-integration)

[Chris Gagnon (chris.gagnon)]

I'd really like to see a local http started to serve rss files from 127.0.0.1 instead of an external website.

there is an example here you can re-use to serve an rss xml file.
https://bazaar.launchpad.net/~phablet-team/webbrowser-app/trunk/view/head:/tests/autopilot/webbrowser_app/tests/http_server.py

review: Needs Fixing

[Carla Sella (carla-sella)]

I think that writing tests this way is fine.

[Carla Sella (carla-sella)]

review: Approve

[lp:~elopio/ubuntu-rssreader-app/refactor_tests]

185. By Leo Arias on 2014-03-04

Removed the old add helper. Updated the remove tests with the new one.

186. By Leo Arias on 2014-03-04

Updated the other tests.

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

PASSED: Continuous integration, rev:185
http://91.189.93.70:8080/job/ubuntu-rssreader-app-ci/185/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-trusty/1572
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-rssreader-app-raring-amd64-ci/185
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-rssreader-app-saucy-amd64-ci/185
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-rssreader-app-trusty-amd64-ci/72

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:186
http://91.189.93.70:8080/job/ubuntu-rssreader-app-ci/186/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-trusty/1579
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-rssreader-app-raring-amd64-ci/186
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-rssreader-app-saucy-amd64-ci/186
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-rssreader-app-trusty-amd64-ci/73

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

review: Approve (continuous-integration)

[Chris Gagnon (chris.gagnon)]

We should really mock the network calls, without looking too closely it looks like google provides a library to do this. https://developers.google.com/api-client-library/python/guide/mocks

I won't hold up this MP for not mocking the network, but it should be on the roadmap for autopilot tests in this project.

review: Approve

=== modified file 'feeds/AppendFeedPage.qml'
--- feeds/AppendFeedPage.qml	2014-01-15 16:27:41 +0000
+++ feeds/AppendFeedPage.qml	2014-03-04 04:12:43 +0000
@@ -1,3 +1,19 @@
+/*
+ * Copyright (C) 2013, 2014
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
 import QtQuick 2.0
 import QtQuick.XmlListModel 2.0
 import Ubuntu.Components 0.1
@@ -249,7 +265,7 @@
 
         delegate: ListItem.Standard {
             text: model.title
-            objectName: "feedpagelistitem"
+            objectName: "feedpagelistitem-" + model.title
 
             control: CheckBox {
                 anchors.verticalCenter: parent.verticalCenter

=== modified file 'tests/autopilot/shorts_app/emulators.py'
--- tests/autopilot/shorts_app/emulators.py	2014-01-15 16:27:41 +0000
+++ tests/autopilot/shorts_app/emulators.py	2014-03-04 04:12:43 +0000
@@ -1,6 +1,6 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
-# Copyright (C) 2013 Canonical Ltd.
+# Copyright (C) 2013, 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
@@ -14,14 +14,41 @@
 # 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
+from time import sleep
+
+from autopilot import logging as autopilot_logging
+from testtools.matchers import NotEquals
 from ubuntuuitoolkit import emulators as toolkit_emulators
-from time import sleep
+
+
+logger = logging.getLogger(__name__)
 
 
 class MainView(toolkit_emulators.MainView):
 
     retry_delay = 0.2
 
+    @autopilot_logging.log_action(logger.info)
+    def go_to_add_feeds(self):
+        popover = self._click_add_reads()
+        popover.click_button_by_text('+ Add feeds')
+        return self.select_single(
+            AppendFeedPage, objectName='appendfeedpage')
+
+    def _click_add_reads(self):
+        toolbar = self.open_toolbar()
+        toolbar.click_button('addreadsbutton')
+        return self.get_action_selection_popover('addreadspopover')
+
+    def get_selected_tab_title(self):
+        tabs = self.get_tabs()
+        selected_tab_index = tabs.selectedTabIndex
+        # TODO there are other tabs that are not of TopicTab type.
+        # --elopio - 2014-02-26
+        tab = tabs.select_single('TopicTab', index=selected_tab_index)
+        return tab.title
+
     #ideally this should be converted to the sdk
     #and use object name not text names
     #see https://bugs.launchpad.net/ubuntu-ui-toolkit/+bug/1205144
@@ -83,10 +110,6 @@
         #grab just the first checkbox
         return self.select_many_retry("CheckBox", objectName="feedCheckbox")[0]
 
-    def get_append_page_list_items(self):
-        return self.select_many_retry("Standard",
-                                      objectName="feedpagelistitem")
-
     def get_next_button(self):
         return self.select_single("Button", objectName="nextButton")
 
@@ -200,3 +223,69 @@
     def get_editfeed_valueselector_value(self, name):
         valueselector = self.get_editfeed_topic_valueselector()
         return valueselector.select_single("LabelVisual", text=name)
+
+
+class Page(toolkit_emulators.MainView):
+    """Autopilot helper for the Page objects."""
+
+    def __init__(self, *args):
+        super(Page, self).__init__(*args)
+        # XXX we need a better way to keep reference to the main view.
+        # --elopio - 2014-02-26
+        self.main_view = self.get_root_instance().select_single(MainView)
+
+    @autopilot_logging.log_action(logger.info)
+    def click_next(self):
+        toolbar = self.main_view.get_toolbar()
+        next_button = toolbar.select_single('Button', objectName='nextButton')
+        self.pointing_device.click_object(next_button)
+
+
+class AppendFeedPage(Page):
+    """Autopilot helper for the Append Feed page."""
+
+    @autopilot_logging.log_action(logger.info)
+    def search_feed(self, keyword_or_url):
+        search_text_field = self.select_single(
+            toolkit_emulators.TextField, objectName='tfFeedUrl')
+        # Write and press enter.
+        search_text_field.write(keyword_or_url + '\n')
+        self._wait_for_results_to_appear()
+
+    def _wait_for_results_to_appear(self):
+        results_list = self._get_results_list()
+        results_list.count.wait_for(NotEquals(0))
+
+    def _get_results_list(self):
+        return self.select_single(
+            toolkit_emulators.QQuickListView, objectName='feedpagelistview')
+
+    @autopilot_logging.log_action(logger.info)
+    def select_results(self, *results):
+        """Select feed items from the list of results.
+
+        :param results: The titles of the items to select from the list.
+
+        """
+        for result in results:
+            self._check_result(result)
+
+    def click_next(self):
+        super(AppendFeedPage, self).click_next()
+        return self.main_view.select_single(
+            ChooseTopicPage, objectName='choosetopicpage')
+
+    def _check_result(self, result):
+        results_list = self._get_results_list()
+        results_list.click_element('feedpagelistitem-{}'.format(result))
+
+
+class ChooseTopicPage(Page):
+    """Autopilot helper for the Choose Topic Page page."""
+
+    @autopilot_logging.log_action(logger.info)
+    def add_topic(self, topic):
+        new_topic_text_field = self.select_single(
+            toolkit_emulators.TextField, objectName='newTopic')
+        # Write and press enter.
+        new_topic_text_field.write(topic + '\n')

=== modified file 'tests/autopilot/shorts_app/tests/test_rssreader.py'
--- tests/autopilot/shorts_app/tests/test_rssreader.py	2014-02-13 03:52:29 +0000
+++ tests/autopilot/shorts_app/tests/test_rssreader.py	2014-03-04 04:12:43 +0000
@@ -1,9 +1,18 @@
 # -*- 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.
+#
+# Copyright (C) 2013, 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/>.
 
 """shorts app autopilot tests."""
 
@@ -42,79 +51,28 @@
                 self.main_view.get_network_activity,
                 Eventually(Equals(None), timeout=60))
 
-    def _add_feed_and_topic(self, feed, topicName):
-        """test add feed and topic"""
-        logger.debug("starting test add feed and topic")
-
-        self.assertThat(self.main_view.get_topics_page,
-                        Eventually(NotEquals(None)))
-        #open toolbar
-        logger.debug("opening toolbar")
-        toolbar = self.main_view.open_toolbar()
-
-        #click on add reads toolbar button
-        logger.debug("clicking addreadsbutton")
-        toolbar.click_button("addreadsbutton")
-
-        #click on add feeds popover action
-        logger.debug("clicking + Add feeds")
-        addReadsPopover = self.main_view.get_action_popover()
-        self.main_view.run_action(addReadsPopover, "+ Add feeds")
-
-        #verify Append Feed  page is open
-        logger.debug("asserting append page")
-        appendpage = lambda: self.main_view.get_append_page().visible
-        self.assertThat(appendpage, Eventually(Equals(True)))
-
-        #type feed in input field
-        logger.debug("inputting feed")
-        self._input_new_feed(feed)
-
-        #click on checkbox to confirm feed
-        logger.debug("asserting checkbox")
-        self.assertThat(self.main_view.get_append_page_feed,
-                        Eventually(Not(Is(None))))
-        logger.debug("grabbing checkbox")
-        checkboxBtn = self.main_view.get_append_page_feed()
-        logger.debug("clicking checkbox")
-        self.pointing_device.click_object(checkboxBtn)
-        logger.debug("asserting checkbox checked")
-        self.assertThat(checkboxBtn.checked, Eventually(Equals(True)))
-
-        #save selected feedname
-        feedName = self.main_view.strip_html_tags(
-            str(self.main_view.get_append_page_list_items()[0].text))
-
-        #click on Next button
-        logger.debug("asserting next")
-        self.assertThat(self.main_view.get_next_button,
-                        Eventually(Not(Is(None))))
-        logger.debug("grabbing next")
-        nextButton = self.main_view.get_next_button()
-        logger.debug("clicking next")
-        self.pointing_device.click_object(nextButton)
-
-        #verify choose topic page has opened
-        logger.debug("asserting choose topic page")
-        chossetopicpage = lambda: self.main_view.get_topics_page().visible
-        self.assertThat(chossetopicpage, Eventually(Equals(True)))
-
-        #get current topics
-        logger.debug("grabbing topics")
-        topics = self.main_view.get_choose_topics_items()
-        numTopics = len(topics)
-        logger.debug("found " + str(numTopics) + " topics")
-        for topic in topics:
-            logger.debug("Topic: " + str(topic.text))
-
-        #add a new topic
-        logger.debug("input topic")
-        self._input_new_topic(topicName)
-
-        #wait for new feed and topic to be added
+    def add_feed_to_new_topic(self, feed_url, feed_title, topic):
+        add_feeds_page = self.main_view.go_to_add_feeds()
+        # XXX here we are using an external server because we are currently
+        # using the Google Feed API, which doesn't let us access local
+        # resources. --elopio - 2014-02-26
+        add_feeds_page.search_feed(feed_url)
+        add_feeds_page.select_results(feed_title)
+        choose_topics_page = add_feeds_page.click_next()
+        choose_topics_page.add_topic(topic)
+        # TODO move this wait to the main view custom proxy object.
+        # --elopio - 2014-02-26
         self._wait_for_refresh()
 
-        return feedName
+    def test_add_feed_to_new_topic(self):
+        """Test that adding a feed to a new topic must show it in a new tab."""
+        test_feed_url = 'http://www.canonical.com/rss.xml'
+        test_feed_title = 'Insights'
+        test_topic = 'Test topic'
+        self.add_feed_to_new_topic(test_feed_url, test_feed_title, test_topic)
+
+        selected_tab_title = self.main_view.get_selected_tab_title()
+        self.assertEqual('Test topic', selected_tab_title)
 
     def _remove_feed(self, feedName, topicName):
         logger.debug("removing feed")
@@ -268,55 +226,32 @@
             poll += 1
         return topic
 
-    def test_add_remove_feed_and_topic(self):
+    def test_remove_feed_and_topic(self):
         """ test add and remove feed and topic"""
-
-        #add topic and feed
-        #TODO, try several different feeds
-        feed = "http://www.canonical.com/rss.xml"
-        feedName = "Insights"
-        topicName = "CanonicalTopic"
-
-        #just for timing issues
-        self.assertThat(self.main_view.get_shorts_tab(),
-                        NotEquals(None))
-        self.assertThat(self.main_view.get_shorts_tab().objectName,
-                        Eventually(Equals("Tab0")))
-        self.assertThat(self.main_view.get_shorts_tab().visible,
-                        Eventually(Equals(True)))
-
-        #add feed and topic
-        feedName = self._add_feed_and_topic(feed, topicName)
+        test_feed_url = 'http://www.canonical.com/rss.xml'
+        test_feed_title = 'Insights'
+        test_topic = 'Test topic'
+        self.add_feed_to_new_topic(test_feed_url, test_feed_title, test_topic)
 
         #remove added feed
         logger.debug("starting remove feed")
 
-        self._remove_feed(feedName, topicName)
+        self._remove_feed(test_feed_title, test_topic)
 
         #remove added topic
-        self._remove_topic(topicName)
+        self._remove_topic(test_topic)
 
     @unittest.skip("Tab switching fails")
     def test_view_mode_and_feed_item(self):
         """test view modes and ensure feed items can be opened"""
-
-        feed = "http://www.canonical.com/rss.xml"
-        #feedName = "Insights"
-        topicName = "CanonicalTopic"
-
-        #just for timing issues
-        self.assertThat(self.main_view.get_shorts_tab(),
-                        NotEquals(None))
-        self.assertThat(self.main_view.get_shorts_tab().objectName,
-                        Eventually(Equals("Tab0")))
-        self.assertThat(self.main_view.get_shorts_tab().visible,
-                        Eventually(Equals(True)))
-
-        #add topic and feed
-        self._add_feed_and_topic(feed, topicName)
+        test_feed_url = 'http://www.canonical.com/rss.xml'
+        test_feed_title = 'Insights'
+        test_topic = 'Test topic'
+
+        self.add_feed_to_new_topic(test_feed_url, test_feed_title, test_topic)
 
         #verify we are on the editTopic Tab
-        editTab = self.main_view.get_topic_tab(topicName)
+        editTab = self.main_view.get_topic_tab(test_topic)
         self.assertThat(lambda: editTab.visible, Eventually(Equals(True)))
 
         #open toolbar
@@ -344,9 +279,9 @@
         #self.assertThat(lambda: feedTab.visible, Eventually(Equals(True)))
 
         #select feed entry
-        self.assertThat(lambda: self.main_view.get_feedlist(topicName),
+        self.assertThat(lambda: self.main_view.get_feedlist(test_topic),
                         Eventually(Not(Is(None))))
-        editFeed = self.main_view.get_feedlist(topicName)
+        editFeed = self.main_view.get_feedlist(test_topic)
 
         for item in editFeed:
             label = item.select_single("Label", objectName="labelFeedname")
@@ -362,16 +297,14 @@
     @unittest.skip("Can't see or get dynamic tabs")
     def test_edit_topic(self):
         """test edit topic"""
-
-        feed = "http://www.canonical.com/rss.xml"
-        feedName = "Insights"
-        topicName = "CanonicalTopic"
-
-        #add topic and feed
-        feedName = self._add_feed_and_topic(feed, topicName)
+        test_feed_url = 'http://www.canonical.com/rss.xml'
+        test_feed_title = 'Insights'
+        test_topic = 'Test topic'
+
+        self.add_feed_to_new_topic(test_feed_url, test_feed_title, test_topic)
 
         #verify we are on the topicName Tab
-        editTab = self.main_view.get_topic_tab(topicName)
+        editTab = self.main_view.get_topic_tab(test_topic)
         self.assertThat(editTab.visible, Eventually(Equals(True)))
 
         #open toolbar
@@ -387,12 +320,12 @@
             Eventually(Equals("topicmanagement")))
 
         #verity Tab is expanded
-        editTopic = self.main_view.get_feedlist_topic(topicName)
+        editTopic = self.main_view.get_feedlist_topic(test_topic)
         if editTopic.state != "expended":
             self.pointing_device.click_object(editTopic)
 
         #select feed
-        editFeed = self.main_view.get_feedlist_feed(feedName)
+        editFeed = self.main_view.get_feedlist_feed(test_topic)
         self.assertThat(editFeed, NotEquals(None))
         self.pointing_device.click_object(editFeed)