Merge lp:~elopio/u1-test-utils/sso-helpers-1 into lp:u1-test-utils

[Leo Arias]

[lp:~elopio/u1-test-utils/sso-helpers-1]

53. By Leo Arias on 2013-04-13

Renamed test open page to make it clearer.

54. By Leo Arias on 2013-04-13

Added a password confirmation that defaults to the user password.

55. By Leo Arias on 2013-04-13

Added the Anonymous subheader and various page attributes.

56. By Leo Arias on 2013-04-13

Fixed lint.

57. By Leo Arias on 2013-04-13

Typo.

58. By Leo Arias on 2013-04-13

Added the check parameter.

59. By Leo Arias on 2013-04-13

Added the h1 to the log in page.

60. By Leo Arias on 2013-04-14

Remove the \ character that escapes the url paths, before opening the page.

61. By Leo Arias on 2013-04-14

Added a better error message for assert_url_path. Added attributes to SSO pages.

62. By Leo Arias on 2013-04-14

Raise a NotImplementedError for the pages with parameters in the path.

63. By Leo Arias on 2013-04-14

Typo, inverted the order.

64. By Leo Arias on 2013-04-14

Typo. Inverted the order of the special characters.

65. By Leo Arias on 2013-04-14

Pass the right argument to the parent.

66. By Leo Arias on 2013-04-14

Updated the id of the account link.

67. By Leo Arias on 2013-04-14

Do not receive the user name if it will not use it.

68. By Leo Arias on 2013-04-14

Inherit from UserSubheader.

=== modified file 'u1testutils/sso/sst/__init__.py'
--- u1testutils/sso/sst/__init__.py	2013-04-09 19:06:01 +0000
+++ u1testutils/sso/sst/__init__.py	2013-04-14 03:49:22 +0000
@@ -33,7 +33,7 @@
 
     """
     log_in = pages.LogIn()
-    create_account = log_in.go_to_create_new_account()
+    create_account = log_in.subheader.go_to_create_new_account()
     create_account.create_ubuntu_sso_account(user)
 
     if is_site_recognized:
@@ -61,7 +61,7 @@
     """
     vlink = mail.get_verification_link_for_address(user.email)
     sst.actions.go_to(vlink)
-    validate_email = pages.ValidateEmail(user.full_name)
+    validate_email = pages.CompleteEmailAddressValidation()
     validate_email.confirm()
 
 
@@ -117,4 +117,4 @@
 
     """
     your_account = pages.YourAccount(user_name)
-    return your_account.sub_header.log_out()
+    return your_account.subheader.log_out()

=== modified file 'u1testutils/sso/sst/pages.py'
--- u1testutils/sso/sst/pages.py	2013-04-12 18:09:38 +0000
+++ u1testutils/sso/sst/pages.py	2013-04-14 03:49:22 +0000
@@ -21,27 +21,35 @@
 from u1testutils.sst import log_action
 
 
-class LogIn(u1testutils.sst.Page):
+class PageWithAnonymousSubheader(u1testutils.sst.Page):
+
+    def __init__(self, check=True):
+        super(PageWithAnonymousSubheader, self).__init__(check)
+        self.subheader = _AnonymousSubheader()
+
+
+class _AnonymousSubheader(object):
+
+    @log_action(logging.info)
+    def go_to_create_new_account(self):
+        """Go to the Create new account page."""
+        new_account_link = sst.actions.get_element(id='new-account-link')
+        sst.actions.click_link(new_account_link)
+        return CreateAccount()
+
+
+class LogIn(PageWithAnonymousSubheader):
     """Log in page of the Ubuntu Single Sign On website.
 
-    This is a subclass of the Page object. It extends the assert_page_is_open
-    method with additional verifications and adds methods for the actions
-    available in this page.
-
-    Instance variables:
-    title -- The title of the page.
-    url_path -- The path of the page.
+    This is a subclass of the PageWithAnonymousSubheader object to add
+    methods for the actions available in this page.
 
     """
 
     title = 'Log in'
     url_path = '/'
-
-    def assert_page_is_open(self):
-        """Assert that the page is open."""
-        super(LogIn, self).assert_page_is_open()
-        sst.actions.assert_element(tag='h1', text='Ubuntu Single Sign On')
-        sst.actions.assert_element(tag='h2', text='Are you new?')
+    headings1 = ['Ubuntu Single Sign On']
+    headings2 = ['Log in to Ubuntu Single Sign On', 'Are you new?']
 
     @log_action(logging.info)
     def log_in_to_site_recognized(self, user=None):
@@ -93,28 +101,18 @@
             css_class='btn', name='continue')
         sst.actions.click_button(continue_button)
 
-    @log_action(logging.info)
-    def go_to_create_new_account(self):
-        """Go to the Create new account page."""
-        new_account_link = sst.actions.get_element(id='new-account-link')
-        sst.actions.click_link(new_account_link)
-        return CreateAccount()
-
-
-class CreateAccount(u1testutils.sst.Page):
+
+class CreateAccount(PageWithAnonymousSubheader):
     """Create account page of the Ubuntu Single Sign On website.
 
-    This is a subclass of the Page object. It adds methods for the actions
-    available in this page.
-
-    Instance variables:
-    title -- The title of the page.
-    url_path -- The path of the page.
+    This is a subclass of the PageWithAnonymousSubheader object to add
+    methods for the actions available in this page.
 
     """
 
     title = 'Create account'
     url_path = '/\+new_account'
+    headings1 = ['Ubuntu Single Sign On', 'Create an account']
 
     @log_action(logging.info)
     def create_ubuntu_sso_account(self, user):
@@ -128,32 +126,35 @@
         self._fill_new_account_form(user)
         self._click_continue()
 
-    def _fill_new_account_form(self, user):
+    def _fill_new_account_form(self, user, password_confirmation=None):
+        if password_confirmation is None:
+            password_confirmation = user.password
         sst.actions.write_textfield('id_displayname', user.full_name)
         sst.actions.write_textfield('id_email', user.email)
         sst.actions.write_textfield('id_password', user.password)
-        sst.actions.write_textfield('id_passwordconfirm', user.password)
+        sst.actions.write_textfield(
+            'id_passwordconfirm', password_confirmation)
+        # Even though the recaptcha field is ignored for our tests, we do
+        # want to verify that it is on the page.
+        sst.actions.write_textfield('recaptcha_response_field', 'ignored')
 
     def _click_continue(self):
         continue_button = sst.actions.get_element(name='continue')
         sst.actions.click_button(continue_button)
 
 
-class RegistrationMailSent(u1testutils.sst.Page):
-    """Registration mail sent page of the Ubuntu Single Sign On website.
-
-    This is a subclass of the Page object. It extends the assert_page_is_open
-    method with additional verifications and adds methods for the actions
-    available in this page.
-
-    Instance variables:
-    title -- The title of the page.
-    url_path -- The path of the page.
+class AccountCreationMailSent(PageWithAnonymousSubheader):
+    """AccountCreation mail sent page of the Ubuntu Single Sign On website.
+
+    This is a subclass of the PageWithAnonymousSubheader object to add methods
+    for the actions available in this page.
 
     """
 
-    title = 'Registration mail sent'
+    title = 'Account creation mail sent'
     url_path = '/\+new_account'
+    headings1 = ['Account creation mail sent']
+    headings2 = ["Haven't received it?"]
 
     @log_action(logging.info)
     def confirm_email_to_site_recognized(self, confirmation_code):
@@ -197,8 +198,27 @@
         sst.actions.click_button(continue_button)
 
 
-class ValidateEmail(u1testutils.sst.Page):
-    """Validate email address confirmation page.
+class PageWithUserSubheader(u1testutils.sst.Page):
+
+    def __init__(self, check=True):
+        super(PageWithUserSubheader, self).__init__(check)
+        self.subheader = _UserSubheader()
+
+
+class _UserSubheader(object):
+
+    @log_action(logging.info)
+    def log_out(self):
+        """Log out from the web site."""
+        sst.actions.click_link('logout-link')
+        return YouHaveBeenLoggedOut()
+
+    def get_user_name(self):
+        return sst.actions.get_element(id='account').text
+
+
+class CompleteEmailValidation(PageWithUserSubheader):
+    """Complete email address validation page.
 
     This is a subclass of the Page object. It adds methods for the actions
     available in this page.
@@ -210,11 +230,15 @@
     """
 
     title = "Complete email address validation"
-    url_path = '/token/.*/\+newemail/*.@*.'
-
-    def __init__(self, user_name):
-        self.user_name = user_name
-        super(ValidateEmail, self).__init__()
+    url_path = '/token/.*/\+newemail/.*@.*'
+
+    def __init__(self, check=True):
+        super(CompleteEmailValidation, self).__init__(check)
+
+    def open_page(self, check=True):
+        # TODO we can receive the token and email as parameters.
+        # Currently not needed.
+        raise NotImplementedError('Not yet implemented.')
 
     def _click_continue_button(self):
         continue_button = sst.actions.get_element(css_class='btn',
@@ -228,11 +252,13 @@
     @log_action(logging.info)
     def confirm(self):
         self._click_continue_button()
-        return YourAccount(self.user_name)
+        user_name = self.subheader.get_user_name()
+        return YourAccount(user_name)
 
     @log_action(logging.info)
     def cancel(self):
-        return YourAccount(self.user_name)
+        user_name = self.subheader.get_user_name()
+        return YourAccount(user_name)
 
 
 class SiteNotRecognized(u1testutils.sst.Page):
@@ -248,9 +274,13 @@
 
     """
 
-    title = 'Authenticate to .+'
+    title = '^Authenticate to .+'
     url_path = '/.*/\+decide'
 
+    def open_page(self, check=True):
+        # TODO we can receive the token as parameter. Currently not needed.
+        raise NotImplementedError('Not yet implemented.')
+
     def assert_page_is_open(self):
         """Assert that the page is open.
 
@@ -286,7 +316,7 @@
         sst.actions.click_button(sign_me_in_button)
 
 
-class YourAccount(u1testutils.sst.Page):
+class YourAccount(PageWithUserSubheader):
     """Your account page of the Ubuntu Single Sign On website.
 
     This is a subclass of the Page object. It extends the constructor to
@@ -305,32 +335,14 @@
     title = "{0}'s details"
     url_path = '/'
 
-    def __init__(self, user_name):
+    def __init__(self, user_name, check=True):
         self.title = self.title.format(user_name)
-        super(YourAccount, self).__init__()
-        self.sub_header = _UserSubHeader()
-
-
-class _UserSubHeader(object):
-
-    @log_action(logging.info)
-    def log_out(self):
-        """Log out from the web site."""
-        sst.actions.click_link('logout-link')
-        return YouHaveBeenLoggedOut()
-
-
-class YouHaveBeenLoggedOut(u1testutils.sst.Page):
-    """Your account page of the Ubuntu Single Sign On website.
-
-    This is a subclass of the Page object.
-
-    Instance variables:
-    title -- The title of the page. It's build when the page is instantiated
-        using the user name.
-    url_path -- The path of the page.
-
-    """
+        super(YourAccount, self).__init__(check)
+
+
+class YouHaveBeenLoggedOut(PageWithAnonymousSubheader):
+    """Your account page of the Ubuntu Single Sign On website."""
 
     title = 'You have been logged out'
     url_path = '/\+logout'
+    headings1 = ['Ubuntu Single Sign On', 'You have been logged out']

=== modified file 'u1testutils/sst/__init__.py'
--- u1testutils/sst/__init__.py	2013-04-12 16:02:03 +0000
+++ u1testutils/sst/__init__.py	2013-04-14 03:49:22 +0000
@@ -73,10 +73,14 @@
             self.assert_page_is_open()
 
     @log_action(logging.info)
-    def open_page(self):
+    def open_page(self, check=True):
         """Open the page."""
         assert self.url_path is not None
-        sst.actions.go_to(self.url_path)
+        # We need to remove the \ used to escape the special characters of the
+        # path.
+        sst.actions.go_to(self.url_path.replace('\\', ''))
+        if check:
+            self.assert_page_is_open()
         return self
 
     def assert_page_is_open(self):
@@ -117,7 +121,9 @@
         current_url_path = urlparse.urlparse(current_url).path
         # Make sure that there are no more characters at the end of the path.
         url_path_regexp = self.url_path + '$'
-        assert re.match(url_path_regexp, current_url_path)
+        assert re.match(url_path_regexp, current_url_path), \
+            "The current URL path {0} doesn't match {1}".format(
+                current_url_path, url_path_regexp)
 
     def assert_headings1(self):
         """Assert the h1 elements of the page."""

=== modified file 'u1testutils/sst/selftests/unit/test_pages.py'
--- u1testutils/sst/selftests/unit/test_pages.py	2013-04-12 16:02:03 +0000
+++ u1testutils/sst/selftests/unit/test_pages.py	2013-04-14 03:49:22 +0000
@@ -23,6 +23,12 @@
 
 class PageTestCase(testtools.TestCase):
 
+    def create_patch(self, name):
+        patcher = mock.patch(name)
+        thing = patcher.start()
+        self.addCleanup(patcher.stop)
+        return thing
+
     def test_assert_page_is_open_on_instantiation(self):
         with mock.patch.object(Page, 'assert_page_is_open') as mock_assert:
             Page()
@@ -33,19 +39,42 @@
             Page(check=False)
             assert not mock_assert.called
 
-    def test_open_page(self):
+    def test_open_page_goes_to_url_path(self):
         page = Page(check=False)
         page.url_path = '/test/path'
         with mock.patch('sst.actions.go_to') as mock_action:
-            returned_page = page.open_page()
+            returned_page = page.open_page(check=False)
         mock_action.assert_called_with('/test/path')
         self.assertEquals(page, returned_page)
 
+    def test_open_page_asserts_page_is_opened(self):
+        self.create_patch('sst.actions.go_to')
+        with mock.patch.object(Page, 'assert_page_is_open') as mock_assert:
+            page = Page(check=False)
+            page.url_path = '/test/path'
+            page.open_page()
+            mock_assert.assert_called_once_with()
+
+    def test_open_page_wihtout_check(self):
+        self.create_patch('sst.actions.go_to')
+        with mock.patch.object(Page, 'assert_page_is_open') as mock_assert:
+            page = Page(check=False)
+            page.url_path = '/test/path'
+            page.open_page(check=False)
+            assert not mock_assert.called
+
     def test_open_page_without_path(self):
         page = Page(check=False)
         page.url_path = None
         self.assertRaises(AssertionError, page.open_page)
 
+    def test_open_page_with_special_character_in_url_path(self):
+        page = Page(check=False)
+        page.url_path = '/test/\+path'
+        with mock.patch('sst.actions.go_to') as mock_action:
+            page.open_page(check=False)
+        mock_action.assert_called_with('/test/+path')
+
 
 class PageWithOnlyHeadingsAssertions(Page):