Merge lp:~elopio/u1-test-utils/dash-tests into lp:~canonical-isd-hackers/u1-test-utils/test-in-dash-payments

[Leo Arias]

Added tests for the dash functions we use, cleaned the purchase tests and make sure they will work with the local servers.

[Vincent Ladeuil (vila)]

44 + # TODO We should check if the result is visible, instead of checking if
45 + # there are visible categories. I don't know how to do it, I'll ask
46 + # --elopio - 2013-05-19

I thought the following was doing that:

91 - refresh_results_fn = lambda: len(category.get_results())
92 - test.assertThat(refresh_results_fn, Eventually(GreaterThan(0)))
93 - # Select first result as soon as it appears
94 - return category.get_results()[0]

This also ensures that there is at least one result which the following
doesn't seem to care about:

40 + return category.get_results()[0]

I'm not sure about why you thunk some methods to functions but as long as
daughter classes can still redefine the methods, I don't have strong
objections either.

review: Approve

[lp:~elopio/u1-test-utils/dash-tests]

64. By Leo Arias on 2013-06-19

Assert that there is at least one result displayed.

[Leo Arias (elopio)]

> 44 + # TODO We should check if the result is visible, instead of checking
> if
> 45 + # there are visible categories. I don't know how to do it, I'll ask
> 46 + # --elopio - 2013-05-19
>
> I thought the following was doing that:
>
> 91 - refresh_results_fn = lambda: len(category.get_results())
> 92 - test.assertThat(refresh_results_fn, Eventually(GreaterThan(0)))
> 93 - # Select first result as soon as it appears
> 94 - return category.get_results()[0]
>
> This also ensures that there is at least one result which the following
> doesn't seem to care about:
>
> 40 + return category.get_results()[0]

You are right. I copied that part of the code. Thanks.

> I'm not sure about why you thunk some methods to functions but as long as
> daughter classes can still redefine the methods, I don't have strong
> objections either.

My goal is to put this in a custom autopilot emulator that inherits from the one in unity. We still need a little work from the autopilot team for that.

=== modified file 'tests/dash.py'
--- tests/dash.py	2013-05-17 16:24:59 +0000
+++ tests/dash.py	2013-06-19 20:36:26 +0000
@@ -4,13 +4,69 @@
     GreaterThan,
     NotEquals,
 )
-from unity.emulators import dash as udash
-
-
-def wait_for_category(test, scope, category_name):
-    get_category = lambda: scope.get_category_by_name(category_name)
-    test.assertThat(get_category, Eventually(NotEquals(None)))
-    return get_category()
+
+
+def search_music_scope(test, query):
+    test.addCleanup(test.unity.dash.ensure_hidden)
+    test.unity.dash.reveal_music_scope()
+    test.addCleanup(clear_music_scope_search, test)
+    test.keyboard.type(query)
+    music_scope = test.unity.dash.get_current_scope()
+    # Wait for a category to appear.
+    test.assertThat(
+        music_scope.get_num_visible_categories,
+        Eventually(GreaterThan(0)))
+
+
+def clear_music_scope_search(test):
+    dash = test.unity.dash
+    if (not dash.visible) or (dash.get_current_scope() != 'music.scope'):
+        dash.reveal_music_scope()
+    dash.clear_search()
+
+
+def get_first_result_from_category(test, category_name):
+    current_scope = test.unity.dash.get_current_scope()
+    category = current_scope.get_category_by_name(category_name)
+    test.assertTrue(category.is_visible)
+    get_number_of_results = lambda: len(category.get_results())
+    test.assertThat(get_number_of_results, Eventually(GreaterThan(0)))
+    return category.get_results()[0]
+
+
+def preview_result(test, result):
+    current_scope = test.unity.dash.get_current_scope()
+    test.assertThat(current_scope.get_num_visible_categories(), GreaterThan(0))
+    result.preview()
+    _wait_for_preview_animation(test)
+
+
+def _wait_for_preview_animation(test):
+    test.assertThat(
+        test.unity.dash.view.get_preview_container,
+        Eventually(NotEquals(None)))
+    preview_container = test.unity.dash.view.get_preview_container()
+    test.assertThat(
+        preview_container.animating, Eventually(Equals(False)))
+
+
+def ensure_preview_closed(test):
+    if test.unity.dash.preview_displaying:
+        close_preview(test)
+
+
+def close_preview(test):
+    test.assertTrue(test.unity.dash.preview_displaying)
+    test.keyboard.press_and_release('Escape')
+
+
+def get_current_preview(test):
+    test.assertThat(
+        test.unity.dash.view.get_preview_container,
+        Eventually(NotEquals(None)))
+    container = test.unity.dash.view.get_preview_container()
+    test.assertThat(container.waiting_preview, Eventually(Equals(False)))
+    return container.current_preview    
 
 
 class Window(object):
@@ -23,37 +79,17 @@
     """The first window opened when the dash is activated."""
 
     def get_result(self, test):
-        scope = test.unity.dash.get_current_scope()
-        # Wait for the category we care about to appear (that's the one where
-        # goods can be bought).
-        category = scope.get_category_by_name('More suggestions')
-
-        refresh_results_fn = lambda: len(category.get_results())
-        test.assertThat(refresh_results_fn, Eventually(GreaterThan(0)))
-        # Select first result as soon as it appears
-        return category.get_results()[0]
+        # XXX Currently we can't force the Music Store to return a result,
+        # so for now we will just use the first one. --elopio - 2013-05-19
+        return get_first_result_from_category(test, 'More suggestions')
 
     def get_preview(self, test, good):
-        test.unity.dash.ensure_visible()
-        test.addCleanup(test.unity.dash.ensure_hidden)
-        # Use the scope required by the test
-        if test.scope_name == 'music':
-            test.unity.dash.reveal_music_scope()
-        # Start the search
-        test.keyboard.type(good.search)
+        search_music_scope(test, good.search)        
         result = self.get_result(test)
-        # The name of the result is different between home scope and music scope
-        # :-/ -- vila 2013-04-04
-        test.assertTrue(good.name in result.name)
-        # We got the right one, preview it
-        result.preview()
-        test.assertThat(test.unity.dash.view.preview_displaying,
-                        Eventually(Equals(True)))
-        test.assertThat(test.unity.dash.view.get_preview_container,
-                        Eventually(NotEquals(None)))
-        container = test.unity.dash.view.get_preview_container()
+        test.addCleanup(ensure_preview_closed, test)
+        preview_result(test, result)
         # We have the preview now
-        return Preview(self.user, good, container)
+        return Preview(self.user, good)
 
 
 class WindowWithGood(Window):
@@ -69,24 +105,13 @@
 
 class Preview(WindowWithGood):
 
-    def __init__(self, user, good, container):
+    _DOWNLOAD_BUTTON_ID = 'show_purchase_preview'
+
+    def __init__(self, user, good):
         super(Preview, self).__init__(user, good)
-        self.container = container
-
-
-    def get_dash_preview(self):
-        content = self.container.get_children_by_type(udash.PreviewContent)[0]
-        preview = content.get_current_preview()
-        return preview
-
-    def good_displayed(self):
-        preview = self.get_dash_preview()
-        # FIXME: At some point, self.good.name == preview.text_boxes[0].text
-        # used to be True... we need some other way now -- vila 2013-04-03
-        return True
-
-    def get_message_replacing_action(self):
-        preview = self.get_dash_preview()
+
+    def get_message_replacing_action(self, test):
+        preview = get_current_preview()
         # FIXME: Far from pretty but at least we can get it. There are two
         # issues below: [2] may break if more StaticCairoTexts are added and
         # the 'get_properties()['text'] may be brittle (but that would mean
@@ -96,21 +121,14 @@
         message = preview.text_boxes[2].get_properties()['text']
         return message
 
-    def get_download_button(self):
-        preview = self.get_dash_preview()
-        # FIXME: Urgh, we can't access the action button by name anymore,
-        # relying on the fact that there is only one button for now. -- vila
-        # 2013-05-17
-        download = preview.get_children_by_type(udash.ActionButton)[0]
+    def get_download_button(self, test): 
+        preview = get_current_preview(test)
+        download = preview.get_action_by_id(self._DOWNLOAD_BUTTON_ID)
         return download
 
     def click_download(self, test):
-        download = self.get_download_button()
-        # FIXME: MusicPreview should allow executing the action but it's
-        # currently broken (http://pad.lv/1163930) -- vila 2013-04-03
-        mouse = udash.get_mouse()
-        mouse.move(download.x, download.y)
-        mouse.click()
+        preview = get_current_preview(test)
+        preview.execute_action_by_id(self._DOWNLOAD_BUTTON_ID)
         # FIXME: The current implementation diverges from the design spec by
         # going straight to the web without presenting a window explaining why
         # the good can't be bought while also displaying the good. As of today,
@@ -124,8 +142,8 @@
 
     def __init__(self, user, good):
         super(GotoU1, self).__init__(user, good)
-        if self.user.logged_in:
-            if self.user.payment_method == 'expired':
+        if self.user.is_logged_in():
+            if self.user.get_payment_type() == 'expired':
                 self.message = ('Your card has expired.'
                                 'To add a new payment method, please visit...')
             else:

=== modified file 'tests/schema.py'
--- tests/schema.py	2013-05-10 06:21:41 +0000
+++ tests/schema.py	2013-06-19 20:36:26 +0000
@@ -15,5 +15,8 @@
     class ubuntuone(schema.Section):
         ubuntuone_server_url = schema.StringOption()
 
+    class musicsearch(schema.Section):
+        musicsearch_server_url = schema.StringOption()
+
 
 schema = InDashPaymentsSchema

=== modified file 'tests/test_dash.py'
--- tests/test_dash.py	2013-05-17 13:00:48 +0000
+++ tests/test_dash.py	2013-06-19 20:36:26 +0000
@@ -1,34 +1,40 @@
-import autopilot
+import unity.tests as utests
+
 from autopilot.matchers import Eventually
-from testtools.matchers import Contains, Equals, GreaterThan
-import unity.tests as utests
+from testtools.matchers import Equals
+
+from tests import dash
 
 
 class TestDash(utests.UnityTestCase):
 
-    # This test needs to be upgraded to catch up with autopilot and unity
-    # recent versions.
-    def xtest_select_preview(self):
-        self.unity.dash.ensure_visible()
+    def setUp(self):
+        super(TestDash, self).setUp()
         self.addCleanup(self.unity.dash.ensure_hidden)
-        scope = self.unity.dash.get_current_scope()
-        self.keyboard.type("hendrix")
-        results_category = scope.get_category_by_name("More suggestions")
-        refresh_results_fn = lambda: len(results_category.get_results())
-        self.assertThat(refresh_results_fn, Eventually(GreaterThan(1)))
-        # Select first result
-        self.keyboard.press_and_release('Enter')
-        # We have the preview now
-        self.keyboard.press_and_release('Enter')
-        self.assertTrue(self.bamf.wait_until_application_is_running(
-                'firefox.desktop', 10.0))
-        firefox = self.bamf.get_running_applications_by_desktop_file(
-            'firefox.desktop')[0]
-        self.addCleanup(firefox.get_windows()[0].close)
-        # FIXME: We can't get the right title as we receive the window too
-        # soon. -- vila 2013-02-21
-#        for w in firefox.get_windows():
-#            print 'title: %s' % (w.title)
-#        import pdb; pdb.set_trace()
-#        self.assertEqual('Log in - Mozilla Firefox',
-#                         firefox.get_windows()[0].title)
+
+    def test_open_music_scope(self):
+        self.unity.dash.reveal_music_scope()
+        current_scope = self.unity.dash.get_current_scope()
+        self.assertEquals(current_scope.name, 'music.scope')
+
+    def test_search_music_scope(self):
+        dash.search_music_scope(self, 'Hendrix')
+        first_result = dash.get_first_result_from_category(
+            self, 'More suggestions')
+        self.assertIn('Hendrix', first_result.name)
+
+    def test_open_and_close_music_result(self):
+        dash.search_music_scope(self, 'Hendrix')
+        first_result = dash.get_first_result_from_category(
+            self, 'More suggestions')
+        dash.preview_result(self, first_result)
+        self.assertThat(
+            self.unity.dash.preview_displaying, Eventually(Equals(True)))
+        preview = dash.get_current_preview(self)
+        self.assertIn('Hendrix', preview.text_boxes[0].text)
+        self.assertEquals(preview.get_num_actions(), 1)
+        download_button = preview.get_action_by_id('show_purchase_preview')
+        self.assertEqual(download_button.label, 'Download')
+        dash.close_preview(self)
+        self.assertThat(
+            self.unity.dash.preview_displaying, Eventually(Equals(False)))

=== modified file 'tests/test_purchase_good.py'
--- tests/test_purchase_good.py	2013-05-17 13:00:48 +0000
+++ tests/test_purchase_good.py	2013-06-19 20:36:26 +0000
@@ -1,3 +1,6 @@
+import os
+import subprocess
+
 from sst import actions as sactions
 
 # FIXME do not use django config to get the server settings.
@@ -22,9 +25,24 @@
         # Set the urls of the servers that will be used by the user.
         self.user.set_servers_data(
             sso_server_url=conf.settings.OPENID_SSO_SERVER_URL,
+            pay_server_url=conf.settings.PAY_SERVER_URL,
+            consumer_id=conf.settings.CONSUMER_ID,
             ubuntuone_server_url=conf.settings.UBUNTUONE_SERVER_URL)
         # Arbitrarily using a good that is known to work
         self.good = goods.Good(u'Jimi Hendrix', 'hendrix')
+        self._run_music_lens()
+
+    def _run_music_lens(self):
+        os.environ['MUSICSTORE_URI'] = (
+            conf.settings.MUSICSEARCH_SERVER_URL + '/v1/')
+        os.environ['U1_STAGING_AUTHENTICATION'] = (
+            conf.settings.OPENID_SSO_SERVER_URL + '/')
+        os.environ['U1_STAGING_WEBAPI'] = (
+            conf.settings.UBUNTUONE_SERVER_URL + '/')
+        os.system('pkill unity-music')
+        subprocess.Popen(
+            '/usr/lib/x86_64-linux-gnu/unity-lens-music/'
+            'unity-musicstore-daemon')
 
     def preview_good(self):
         home = dash.Home(self.user)
@@ -39,22 +57,10 @@
 
 class TestUserCannotPay(TestPurchaseGood):
 
-    scenarios = [(name, {'scope_name': name}) for name in ('home', 'music',)]
-
     def test_user_not_logged_in(self):
         self.assertFalse(self.user.is_logged_in())
         self.preview_good()
-        if self.scope_name == 'music':
-            # There is a workaround in place for the music scope only that
-            # forbids testing the rest of the workflow
-            self.assertIs(None, self.preview.get_download_button())
-            message = self.preview.get_message_replacing_action()
-            self.assertEqual('Before you can purchase music you need'
-                             ' to log in to the Ubuntu One app', message)
-            return
-        goto_u1 = self.purchase_good()
-        # diverges from the design spec, we go directly to the web
-        # self.assertTrue(goto_u1.good_displayed()) 
+        self.purchase_good()
         browser = browsers.Browser(self)
         # We've been redirected to the web
         browser.switch_to_new_window(self)
@@ -65,27 +71,14 @@
     def test_no_payment_method_stored(self):
         # Log in with a newly created user, and set no payment method to him.
         self.user.login(self)
-        self.user.payment_method = None
+        self.assertIs(self.user.get_payment_type(), None)
         self.preview_good()
         goto_u1 = self.purchase_good()
         self.assertTrue(goto_u1.good_displayed())
         self.assertIn('add a payment method', goto_u1.message)
-        # The default browser is launched to propose paying 
-        browser = goto_u1.click_goto_u1()
-        # User is sent to the web
-        self.assertTrue(browser.is_running())
-        self.assertEqual('https://pay.ubuntu.com', browser.current_url)
-
-    def test_pay_method_expired(self):
-        # Users's payment has expired
-        self.user.login(self)
-        self.user.payment_method = 'expired'
-        self.preview_good()
-        goto_u1 = self.purchase_good()
-        self.assertTrue(goto_u1.good_displayed())
-        self.assertIn('card has expired', goto_u1.message)
-        # The default browser is launched to propose paying 
-        browser = goto_u1.click_goto_u1()
-        # User is sent to the web
-        self.assertTrue(browser.is_running())
-        self.assertEqual('https://pay.ubuntu.com', browser.current_url)
+        self.skipTest('We are blocked at this point because of bug #1185486.')
+        # The default browser is launched to propose paying 
+        #browser = goto_u1.click_goto_u1()
+        # User is sent to the web
+        #self.assertTrue(browser.is_running())
+        #self.assertEqual(conf.settings.PAY_SERVER_URL, browser.current_url)

=== modified file 'tests/test_session.py'
--- tests/test_session.py	2013-02-20 15:53:53 +0000
+++ tests/test_session.py	2013-06-19 20:36:26 +0000
@@ -1,6 +1,6 @@
 import tests
 
-from gi.repository import Gio, Gtk
+from gi.repository import Gio
 
 class TestGSettings(tests.TestCase):