added optional message param to the Title Should Be function (#1044)

Added optional message param to the Title Should Be function

Author: rubygeek

CHANGES.rst

@@ -1,6 +1,10 @@
 Release Notes
 =============
 
+3.1.0
+-----
+- Added a message param to `Title Should Be` to display custom error message [rubygeek]
+
 3.0.0
 -----
 - Added 'Get Locations' keyword [thaffenden]

src/SeleniumLibrary/keywords/browsermanagement.py

@@ -23,7 +23,7 @@
 
 from SeleniumLibrary.base import keyword, LibraryComponent
 from SeleniumLibrary.locators import WindowManager
-from SeleniumLibrary.utils import (is_falsy, is_truthy, secs_to_timestr,
+from SeleniumLibrary.utils import (is_falsy, is_truthy, is_noney, secs_to_timestr,
                                    timestr_to_secs, SELENIUM_VERSION)
 
 
@@ -303,12 +303,19 @@ def log_title(self):
         return title
 
     @keyword
-    def title_should_be(self, title):
-        """Verifies that current page title equals ``title``."""
+    def title_should_be(self, title, message=None):
+        """Verifies that current page title equals ``title``.
+
+        The ``message`` argument can be used to override the default error
+        message. 
+        
+        ``message`` argument is new in SeleniumLibrary 3.1.
+        """
         actual = self.get_title()
         if actual != title:
-            raise AssertionError("Title should have been '%s' but was '%s'."
-                                 % (title, actual))
+            if is_noney(message):
+                message = "Title should have been '%s' but was '%s'." % (title, actual)
+            raise AssertionError(message)
         self.info("Page title is '%s'." % title)
 
     @keyword

test/acceptance/keywords/content_assertions.robot

@@ -25,6 +25,10 @@ Title Should Be
     Run Keyword And Expect Error
     ...    Title should have been 'not a title' but was '(root)/index.html'.
     ...    Title Should Be    not a title
+    Run Keyword And Expect Error
+    ...    Page title was not expected
+    ...    Title Should Be    not a title   message=Page title was not expected
+
 
 Page Should Contain
     [Documentation]    LOG 2:5 Current page contains text 'needle'.