Merge lp:~elopio/canonical-identity-provider/refactory_with_u1testutils-1 into lp:canonical-identity-provider/release

[Leo Arias]

Use page object on the common acceptance helpers.

This is the first safe point of the refactor. I haven't changed any API, so there are some things left TODO.
In the next branches we will be deprecating this helpers, in favor of base test cases that will do all the page navigation and the tests will need to focus only on one or two pages.

[Leo Arias (elopio)]

$ ./scripts/run-acceptance-tests dev
[...]
----------------------------------------------------------------------
Ran 110 tests in 1628.942s

OK

[Leo Arias (elopio)]

$ ./scripts/run-acceptance-tests dev
----------------------------------------------------------------------
Ran 110 tests in 1308.872s

OK

Save again :)

[Leo Arias (elopio)]

This branch requires https://code.launchpad.net/~elopio/u1-test-utils/open_on_init/+merge/159533 to land first.

[Ricardo Kirkner (ricardokirkner)]

l. 35,37: no need to have the extra whitespace
l. 53: we could be using the new data-qa-id attrs for looking up elements (for better disambiguation)
l. 365,378: why did you remove the extended=true param?

review: Needs Fixing

[Ricardo Kirkner (ricardokirkner)]

l. 19-20, we could replace this with helpers.logout_and_in()

[Leo Arias (elopio)]

I removed the extended=true because it prints the page on the test log. The htmls are huge, so it doesn't help understanding what's wrong. We get the html with screenshot=True. I filed a bug on SST to change the name of that parameter.

[Leo Arias (elopio)]

<elopio> pindonga: I was planning to add the data-qa-id's in next branches, as I wanted this just to be a reorg of the actions.
<elopio> can I leave it like this?
<elopio> pindonga: and I removed the extended=true because it prints the page on the test log.
<pindonga> yup, comment that on the mp though pls

[Ricardo Kirkner (ricardokirkner)]

Despite the resistance to nit-picking, LGTM. Many things are being changed in a subsequent MP according to elopio, so not worth changing right now.

review: Approve

[Ricardo Kirkner (ricardokirkner)]

LGTM

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~elopio/canonical-identity-provider/refactory_with_u1testutils-1 into lp:canonical-identity-provider failed. Below is the output from the failed tests.

Updating download cache at dir /mnt/tarmac/isd-download-cache
Using saved parent location: bzr+ssh://bazaar.launchpad.net/~canonical-isd-hackers/+junk/download-cache/
No revisions or tags to pull.
[localhost] local: which virtualenv
[localhost] local: /usr/bin/python /usr/bin/virtualenv --version
[localhost] local: /usr/bin/python /usr/bin/virtualenv --distribute --clear .env
Not deleting .env/bin
New python executable in .env/bin/python
Installing distribute.............................................................................................................................................................................................done.
Installing pip...............done.
[localhost] local: dpkg -l libpq-dev 2> /dev/null | grep '^ii' | wc -l
[localhost] local: dpkg -l libxml2-dev 2> /dev/null | grep '^ii' | wc -l
[localhost] local: dpkg -l libxslt1-dev 2> /dev/null | grep '^ii' | wc -l
[localhost] local: dpkg -l memcached 2> /dev/null | grep '^ii' | wc -l
[localhost] local: dpkg -l postgresql-plpython-9.1 2> /dev/null | grep '^ii' | wc -l
[localhost] local: dpkg -l python-dev 2> /dev/null | grep '^ii' | wc -l
[localhost] local: dpkg -l python-m2crypto 2> /dev/null | grep '^ii' | wc -l
[localhost] local: dpkg -l swig 2> /dev/null | grep '^ii' | wc -l
[localhost] local: dpkg -l config-manager 2> /dev/null | grep '^ii' | wc -l
[localhost] local: dpkg -l python-egenix-mx-base-dev 2> /dev/null | grep '^ii' | wc -l
[localhost] local: rm -rf M2Crypto*
[localhost] local: ln -s /usr/lib/python2.7/dist-packages/M2Crypto* .
[localhost] local: /usr/lib/config-manager/cm.py update /tmp/tmpqiWvt2
[localhost] local: . /mnt/tarmac/cache/canonical-identity-provider/.env/bin/activate && make install PACKAGES="-r /mnt/tarmac/cache/canonical-identity-provider/requirements.txt"
pip install --find-links=file:///mnt/tarmac/isd-download-cache --no-index pip==dev
Ignoring indexes: http://pypi.python.org/simple/
Downloading/unpacking pip==dev
  Running setup.py egg_info for package pip

    warning: no files found matching '*.html' under directory 'docs'
    warning: no previously-included files matching '*.txt' found under directory 'docs/_build'
    no previously-included directories found matching 'docs/_build/_sources'
Installing collected packages: pip
  Found existing installation: pip 1.1
    Uninstalling pip:
      Successfully uninstalled pip
  Running setup.py install for pip

    warning: no files found matching '*.html' under directory 'docs'
    warning: no previously-included files matching '*.txt' found under directory 'docs/_build'
    no previously-included directories found matching 'docs/_build/_sources'
    Installing pip script to /mnt/tarmac/cache/canonical-identity-provider/.env/bin
    Installing pip-2.7 script to /mnt/tarmac/cache/canonical-identity-provider/.env/bin
Successfully installed pip
Cleaning up...
pip install --find-links=. --no-index -r /mnt/tarmac/cache/canonical-identity-provider/requirements.txt
Ignoring indexes: http://pypi.python.org...

=== modified file 'identityprovider/tests/acceptance/devices/add_device.py'
--- identityprovider/tests/acceptance/devices/add_device.py	2013-01-24 17:02:52 +0000
+++ identityprovider/tests/acceptance/devices/add_device.py	2013-04-19 19:28:26 +0000
@@ -15,8 +15,6 @@
     get_element,
     go_to,
     set_radio_value,
-    start,
-    stop,
     write_textfield,
 )
 from u1testutils.sst import config
@@ -126,8 +124,7 @@
 
 # Stop the browser and restart to ensure 2F Flag is still set
 #  Tests defect #930377
-stop()
-start()
+helpers.logout()
 helpers.login()
 go_to(urls.DEVICES)
 

=== added file 'identityprovider/tests/acceptance/pages.py'
--- identityprovider/tests/acceptance/pages.py	1970-01-01 00:00:00 +0000
+++ identityprovider/tests/acceptance/pages.py	2013-04-19 19:28:26 +0000
@@ -0,0 +1,94 @@
+# Copyright 2013 Canonical Ltd.
+# This software is licensed under the GNU Affero General Public License
+# version 3 (see the file LICENSE).
+
+import logging
+
+import sst.actions
+import u1testutils.sso.sst.pages
+
+from u1testutils.sst import log_action
+
+
+class YourEmailAddresses(u1testutils.sso.sst.pages.PageWithUserSubheader):
+
+    title = "{0}'s email addresses"
+    url_path = '/+emails'
+
+    def assert_title(self):
+        user_name = self.subheader.get_user_name()
+        sst.actions.assert_title(self.title.format(user_name))
+
+    @log_action(logging.info)
+    def add_email(self, email_address):
+        sst.actions.write_textfield('id_newemail', email_address)
+        sst.actions.click_button(sst.actions.get_element(name='continue'))
+
+    @log_action(logging.info)
+    def delete_email(self):
+        remove_link = sst.actions.get_element(tag='a', text='Delete')
+        sst.actions.click_link(remove_link)
+        return DeleteEmail()
+
+
+class EnterConfirmationCode(u1testutils.sso.sst.pages.PageWithUserSubheader):
+
+    title = 'Enter confirmation code'
+    url_path = '/+enter_token'
+
+    @log_action(logging.info)
+    def confirm(self, confirmation_code, email_address):
+        self._fill_confirmation_form(confirmation_code, email_address)
+        self._continue()
+        return u1testutils.sso.sst.pages.CompleteEmailValidation()
+
+    def _fill_confirmation_form(self, confirmation_code, email_address):
+        sst.actions.write_textfield('id_confirmation_code', confirmation_code)
+        sst.actions.write_textfield('id_email', email_address)
+
+    def _continue(self):
+        sst.actions.click_button(sst.actions.get_element(name='continue'))
+
+    @log_action(logging.info)
+    def confirm_with_error(self, confirmation_code, email_address):
+        self._fill_confirmation_form(confirmation_code, email_address)
+        self._continue()
+        return self
+
+
+class DeleteEmail(u1testutils.sso.sst.pages.PageWithUserSubheader):
+
+    title = 'Delete unverified email'
+    url_path = '/+remove-email'
+
+    @log_action(logging.info)
+    def confirm(self):
+        confirm_button = sst.actions.get_element(name='delete')
+        sst.actions.click_button(confirm_button)
+        user_name = self.subheader.get_user_name()
+        return YourEmailAddresses(user_name)
+
+
+class ResetPassword(u1testutils.sso.sst.pages.PageWithAnonymousSubheader):
+
+    title = 'Reset password'
+    url_path = '/+forgot_password'
+    headings1 = [
+        'Ubuntu Single Sign On',
+        'Reset your Ubuntu Single Sign On password'
+    ]
+
+    @log_action(logging.info)
+    def request_password_reset(self, email_address):
+        sst.actions.write_textfield('id_email', email_address)
+        # 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')
+        sst.actions.click_button(sst.actions.get_element(name='continue'))
+
+
+class LogInFromRedirect(u1testutils.sso.sst.pages.LogIn):
+
+    url_path = '/.*/\+decide'
+    is_url_path_regex = True
+    headings2 = ['Log in', 'Are you new?']

=== modified file 'identityprovider/tests/acceptance/shared/helpers.py'
--- identityprovider/tests/acceptance/shared/helpers.py	2013-04-12 16:27:10 +0000
+++ identityprovider/tests/acceptance/shared/helpers.py	2013-04-19 19:28:26 +0000
@@ -1,15 +1,15 @@
 import re
 from urllib import quote
 
+import u1testutils.sso.sst.pages
+
 from django.conf import settings
 from sst.actions import (
     assert_checkbox_value,
     assert_text_contains,
     assert_title,
-    assert_title_contains,
     assert_url,
     click_button,
-    click_link,
     exists_element,
     get_base_url,
     get_current_url,
@@ -19,13 +19,15 @@
     set_radio_value,
     skip,
     wait_for,
-    write_textfield,
 )
 from sst import config
-
 from u1testutils import mail
-from u1testutils.sso import mail as sso_mail
+from u1testutils.sso import (
+    data,
+    mail as sso_mail
+)
 
+from identityprovider.tests.acceptance import pages
 from identityprovider.tests.acceptance.shared import devices, urls
 
 
@@ -51,30 +53,34 @@
         email_address = mail.make_unique_test_email_address()
 
     vcode = None
-    go_to(urls.NEW_ACCOUNT)
-    wait_for(assert_title, 'Create account')
-    fill_registration_form(email_address, displayname, password)
-    click_button(get_element(name='continue'))
+
+    create_account = u1testutils.sso.sst.pages.CreateAccount(open_page=True)
+
+    user = data.User(displayname, email_address, password)
+    create_account.create_ubuntu_sso_account(user)
 
     vcode = None
     if 'allow_unverified' in config.flags:
-        wait_for(assert_title_contains, "%s's details" % displayname)
+        u1testutils.sso.sst.pages.YourAccount(user.full_name)
         # default is not to verify for ALLOW_UNVERIFIED
         if verify is None:
             verify = False
         if verify:
             vlink = sso_mail.get_verification_link_for_address(email_address)
             go_to(vlink)
-            click_button(get_element(css_class='btn'))
+            validate_email = \
+                u1testutils.sso.sst.pages.CompleteEmailValidation()
+            validate_email.confirm()
     else:
-        wait_for(assert_title_contains, 'Account creation mail sent')
+        mail_sent = u1testutils.sso.sst.pages.AccountCreationMailSent()
         # old flow requries verify, usually
         if verify is None:
             verify = True
         if verify:
             vcode = sso_mail.get_verification_code_for_address(email_address)
-            write_textfield(get_element(name='confirmation_code'), vcode)
-            click_button(get_element(css_class='btn'))
+            # TODO add the site not recognized parameter and use the right
+            # public method.
+            mail_sent._confirm_email(vcode)
 
     _LAST_EMAIL = email_address
     _LAST_PASSWORD = password
@@ -83,34 +89,24 @@
 
 
 def fill_registration_form(
-        email,
-        displayname="My Name",
-        password="Admin007",
-        passwordconf=None):
+        email, displayname="My Name", password="Admin007", passwordconf=None):
 
-    if passwordconf is None:
-        passwordconf = password
-    write_textfield('id_displayname', displayname)
-    write_textfield('id_email', email)
-    write_textfield('id_password', password)
-    write_textfield('id_passwordconfirm', passwordconf)
-    if exists_element(id='recaptcha_response_field'):
-        write_textfield('recaptcha_response_field', 'ignored')
+    user = data.User(displayname, email, password)
+    create_account = u1testutils.sso.sst.pages.CreateAccount(open_page=True)
+    # TODO we either make the fill public, or call a public higher method,
+    # The latter sounds better.
+    create_account._fill_new_account_form(user, passwordconf)
 
 
 def add_email(address, verify=False):
-    go_to(urls.EMAILS)
-    wait_for(assert_title_contains, "'s email addresses")
-    write_textfield('id_newemail', address)
-    click_button(get_element(name='continue'))
+    your_email_addresses = pages.YourEmailAddresses(open_page=True)
+    your_email_addresses.add_email(address)
     code = sso_mail.get_verification_code_for_address(address)
     if verify:
-        go_to(urls.ENTER_TOKEN)
-        wait_for(write_textfield, 'id_confirmation_code', code)
-        write_textfield('id_email', address)
-        click_button(get_element(name='continue'))
-        assert_title('Complete email address validation')
-        click_button(get_element(name='continue'))
+        enter_confirmation_code = pages.EnterConfirmationCode(open_page=True)
+        complete_email_validation = enter_confirmation_code.confirm(
+            code, address)
+        complete_email_validation.confirm()
     return code
 
 
@@ -154,21 +150,20 @@
 
 
 def delete_email():
-    go_to(urls.EMAILS)
-    remove_link = get_element(tag='a', text='Delete')
-    click_link(remove_link)
-    confirm_button = get_element(name='delete')
-    click_button(confirm_button)
+    your_email_addresses = pages.YourEmailAddresses(open_page=True)
+    delete_email_confirmation = your_email_addresses.delete_email()
+    delete_email_confirmation.confirm()
 
 
 def try_to_validate_email(address, code, finish_validation=True):
-    go_to(urls.ENTER_TOKEN)
-    wait_for(write_textfield, 'id_confirmation_code', code)
-    write_textfield('id_email', address)
-    click_button(get_element(name='continue'))
+    # TODO implement the navigation and use the right public methods.
+    enter_confirmation_code = pages.EnterConfirmationCode(open_page=True)
+    enter_confirmation_code._fill_confirmation_form(
+        code, address)
+    enter_confirmation_code._continue()
     if finish_validation:
-        assert_title('Complete email address validation')
-        click_button(get_element(name='continue'))
+        complete = u1testutils.sso.sst.pages.CompleteEmailValidation()
+        complete.confirm()
 
 
 def login_or_register_account(device_cleanup=False):
@@ -190,10 +185,12 @@
     if email is None and password is None:
         email = _LAST_EMAIL
         password = _LAST_PASSWORD
-    go_to(urls.HOME)
-    write_textfield('id_email', email)
-    write_textfield('id_password', password)
-    click_button(get_element(name='continue'))
+    log_in = u1testutils.sso.sst.pages.LogIn(open_page=True)
+    # TODO we need the user name too.
+    user = data.User('TODO', email, password)
+    # TODO add the site not recognized parameter and use the right public
+    # method.
+    log_in._log_in(user)
 
 
 def logout_and_in():
@@ -206,17 +203,13 @@
 
 
 def logout():
-    go_to(urls.LOGOUT)
+    u1testutils.sso.sst.pages.YouHaveBeenLoggedOut(open_page=True)
 
 
 def request_password_reset(email_address):
     logout()
-    go_to(urls.FORGOT_PASSWORD)
-    write_textfield('id_email', email_address)
-    # Even though the recaptcha field is ignored for our tests, we do
-    # want to verify that it is on the page.
-    write_textfield('recaptcha_response_field', 'ignored')
-    click_button(get_element(name='continue'))
+    reset_password = pages.ResetPassword(open_page=True)
+    reset_password.request_password_reset(email_address)
 
 
 def login_to_test_account():
@@ -254,12 +247,11 @@
 
 def login_from_redirect(email=settings.QA_ACCOUNT_EMAIL,
                         password=settings.QA_ACCOUNT_PASSWORD):
-    wait_for(assert_title, 'Log in')
-    write_textfield('id_email', email)
-    write_textfield('id_password', password)
-    click_button(get_element(name='continue'))
-    wait_for(assert_title_contains, 'Authenticate to')
-    click_button(get_element(name='yes'))
+    log_in = pages.LogInFromRedirect()
+    # TODO we also need the user name.
+    user = data.User('TODO', email, password)
+    site_not_recognized = log_in.log_in_to_site_not_recognized(user)
+    site_not_recognized.yes_sign_me_in()
 
 
 def check_2f_for_url(url):

=== modified file 'requirements/testing.txt'
--- requirements/testing.txt	2013-04-12 21:17:08 +0000
+++ requirements/testing.txt	2013-04-19 19:28:26 +0000
@@ -28,6 +28,6 @@
 zope.interface==4.0.1
 zope.schema==4.2.0
 zope.testbrowser==3.5.1
-bzr+http://bazaar.launchpad.net/~canonical-isd-qa/selenium-simple-test/trunk/@362
-bzr+http://bazaar.launchpad.net/~canonical-isd-hackers/u1-test-utils/trunk@48
+bzr+http://bazaar.launchpad.net/~canonical-isd-qa/selenium-simple-test/trunk/@376
+bzr+http://bazaar.launchpad.net/~canonical-isd-hackers/u1-test-utils/trunk@53
 bzr+ssh://bazaar.launchpad.net/~bloodearnest/+junk/test-email-server/

=== modified file 'scripts/acceptance-dev.sh'
--- scripts/acceptance-dev.sh	2013-04-09 12:35:33 +0000
+++ scripts/acceptance-dev.sh	2013-04-19 19:28:26 +0000
@@ -31,7 +31,7 @@
 sleep 10 # Time for the sso to start
 
 # run tests
-SST_BASE_URL="http://0.0.0.0:$PORT" fab acceptance:screenshot=true,report=xml,extended=true,flags="$SST_FLAGS"
+SST_BASE_URL="http://0.0.0.0:$PORT" fab acceptance:screenshot=true,report=xml,flags="$SST_FLAGS"
 
 # terminate sso server
 screen -X -S sso quit

=== modified file 'scripts/run-acceptance-tests'
--- scripts/run-acceptance-tests	2013-04-08 20:43:46 +0000
+++ scripts/run-acceptance-tests	2013-04-19 19:28:26 +0000
@@ -51,5 +51,5 @@
     # dev is special: we need to start it up.
     ./scripts/acceptance-dev.sh
 else
-    SST_BASE_URL="$SST_BASE_URL" fab acceptance:screenshot=true,report=xml,extended=true,flags="$SST_FLAGS"
+    SST_BASE_URL="$SST_BASE_URL" fab acceptance:screenshot=true,report=xml,flags="$SST_FLAGS"
 fi