Merge lp:~elopio/u1-test-utils/url_paths_no_regexp into lp:u1-test-utils

[Leo Arias]

Changed the implementation of regex in url paths.

[Corey Goldberg (coreygoldberg)]

better.. thanks

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

=== modified file 'u1testutils/sso/sst/pages.py'
--- u1testutils/sso/sst/pages.py	2013-04-16 18:41:26 +0000
+++ u1testutils/sso/sst/pages.py	2013-04-16 18:41:26 +0000
@@ -117,7 +117,7 @@
     """
 
     title = 'Create account'
-    url_path = '/\+new_account'
+    url_path = '/+new_account'
     headings1 = ['Ubuntu Single Sign On', 'Create an account']
 
     @log_action(logging.info)
@@ -158,7 +158,7 @@
     """
 
     title = 'Account creation mail sent'
-    url_path = '/\+new_account'
+    url_path = '/+new_account'
     headings1 = ['Account creation mail sent']
     headings2 = ["Haven't received it?"]
 
@@ -229,23 +229,15 @@
     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.
-
     """
 
     title = "Complete email address validation"
-    url_path = '/token/.*/\+newemail/.*@.*'
+    url_path = '/token/.+/\+newemail/.+@.+'
+    is_url_path_regex = True
 
     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',
                                                   name='continue')
@@ -274,20 +266,13 @@
     method to check only the first part of the title, and adds methods for the
     actions available in this page.
 
-    Instance variables:
-    title -- The regular expression of the title of the page.
-    url_path -- The path of the page.
-
     """
 
     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):
+    url_path = '/.+/\+decide'
+    is_url_path_regex = True
+
+    def assert_title(self):
         """Assert that the page is open.
 
         We use a regular expression because the title has the URL of the site
@@ -332,9 +317,6 @@
     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.
-    sub_header -- The sub header menu displayed on the pages shown to logged
-        in users.
 
     """
 
@@ -350,5 +332,5 @@
     """Your account page of the Ubuntu Single Sign On website."""
 
     title = 'You have been logged out'
-    url_path = '/\+logout'
+    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-16 18:41:26 +0000
+++ u1testutils/sst/__init__.py	2013-04-16 18:41:26 +0000
@@ -51,10 +51,9 @@
 
     Instance variables:
     title -- The title of the page.
-    url_path -- The path of the page. It is a regular expression, so you can
-        use python's re special characters, but you will have to escape them
-        if they are part of the path. The URL structure is explained in the
-        documentation of python's urlparse.
+    url_path -- The path of the page.
+    is_url_path_regex -- If True, the url path will be considered as a regular
+        expression.
     headings1 -- A list with the expected text of the h1 elements. If it's
         empty, the h1 elements will not be checked.
     headings2 -- A list with the expected text of the h2 elements. If it's
@@ -64,6 +63,7 @@
 
     title = None
     url_path = None
+    is_url_path_regex = False
     headings1 = []
     headings2 = []
 
@@ -75,13 +75,15 @@
     @log_action(logging.info)
     def open_page(self, check=True):
         """Open the page."""
-        assert self.url_path is not None
-        # 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
+        if self.is_url_path_regex:
+            raise ValueError(
+                "We can't open a page with a regular expression on the path.")
+        else:
+            assert self.url_path is not None
+            sst.actions.go_to(self.url_path)
+            if check:
+                self.assert_page_is_open()
+            return self
 
     def assert_page_is_open(self):
         """Assert that the page is open and that no oops are displayed."""
@@ -117,14 +119,23 @@
 
     def assert_url_path(self):
         """Assert the path of the page URL."""
-        current_url = sst.actions.get_current_url()
-        current_url_path = urlparse.urlparse(current_url).path
+        if not self.is_url_path_regex:
+            assert self.url_path == self._get_current_url_path()
+        else:
+            self._assert_url_path_match()
+
+    def _assert_url_path_match(self):
         # Make sure that there are no more characters at the end of the path.
         url_path_regexp = self.url_path + '$'
+        current_url_path = self._get_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 _get_current_url_path(self):
+        current_url = sst.actions.get_current_url()
+        return urlparse.urlparse(current_url).path
+
     def assert_headings1(self):
         """Assert the h1 elements of the page."""
         self._assert_elements_text('h1', self.headings1)

=== modified file 'u1testutils/sst/selftests/acceptance/test_page.py'
--- u1testutils/sst/selftests/acceptance/test_page.py	2013-04-16 18:41:26 +0000
+++ u1testutils/sst/selftests/acceptance/test_page.py	2013-04-16 18:41:26 +0000
@@ -95,6 +95,15 @@
         self.page.open_page()
         self.page.assert_page_is_open()
 
+    def test_assert_page_with_url_path_regexp(self):
+        self.page.title = 'Test title'
+        self.page.url_path = '.+'
+        self.page.is_url_path_regex = True
+        self.page.headings1 = ['Test h1 1', 'Test h1 2']
+        self.page.headings2 = ['Test h2 1', 'Test h2 2']
+        self.page.open_page()
+        self.page.assert_page_is_open()
+
     def test_wrong_title(self):
         self.page.title = 'Wrong title'
         self.assertRaises(AssertionError, self.page.assert_title)
@@ -105,6 +114,7 @@
 
     def test_wrong_url_path_with_a_match(self):
         self.page.url_path = '/test_path'
+        self.page.is_url_path_regex = True
         with mock.patch('sst.actions.get_current_url') as mock_action:
             mock_url = 'http://test_netloc/wrong/test_path/wrong'
             mock_action.return_value = mock_url
@@ -112,6 +122,7 @@
 
     def test_wrong_url_path_with_a_suffix(self):
         self.page.url_path = '/test_path'
+        self.page.is_url_path_regex = True
         with mock.patch('sst.actions.get_current_url') as mock_action:
             mock_url = 'http://test_netloc/test_path/wrong'
             mock_action.return_value = mock_url

=== modified file 'u1testutils/sst/selftests/unit/test_pages.py'
--- u1testutils/sst/selftests/unit/test_pages.py	2013-04-16 18:41:26 +0000
+++ u1testutils/sst/selftests/unit/test_pages.py	2013-04-16 18:41:26 +0000
@@ -55,7 +55,7 @@
             page.open_page()
             mock_assert.assert_called_once_with()
 
-    def test_open_page_wihtout_check(self):
+    def test_open_page_without_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)
@@ -68,12 +68,11 @@
         page.url_path = None
         self.assertRaises(AssertionError, page.open_page)
 
-    def test_open_page_with_special_character_in_url_path(self):
+    def test_open_page_with_path_regex(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')
+        page.url_path = '/test/.*'
+        page.is_url_path_regex = True
+        self.assertRaises(ValueError, page.open_page)
 
 
 class PageWithOnlyHeadingsAssertions(Page):