Merge branch 'master' into webdriver-element

(Resolved) Conflicts:
	src/Selenium2Library/__init__.py

Author: emanlove

.travis.yml

@@ -14,9 +14,10 @@ before_script:
   - "export DISPLAY=:99.0"
   - "sh -e /etc/init.d/xvfb start"
 script:
-  - "python test/run_tests.py python $BROWSER --noncritical ignore_${BROWSER}_error"
+  - "firefox --version"
+  - "python test/run_tests.py python $BROWSER --noncritical known_issue_-_travisci"
 env:
   matrix:
   - BROWSER=firefox
   #- BROWSER=ie # will be added when we have completed SauceLabs CI
-  #- BROWSER=safari # will be added after #247 merged
+  #- BROWSER=safari # will be added after #247 merged

CHANGES.rst

@@ -3,6 +3,42 @@ Release Notes
 
 1.7 (unreleased)
 ----------------
+- Fixed ‘NoSuchWindowException' issue. Running keyword 'Select Window' after 'Close Window'
+  will trigger this issue if locator has prefix 'name=','title=' or 'url='. Also fixed same
+  issue for keywords 'Get Window Ids', 'Get Window Titles' and 'Get Window Names'.
+  [divfor]
+  
+- Corrected error message in new keyword 'Wait Until Element Is Not
+  Visible' to reflect element being visible instead of not visible.
+  [joepurdy]
+
+- Stop using private browsing with default Firefox profile.
+  [ombre42]
+
+- Added new keyword 'Wait Until Element Is Not Visible'.
+  [deiga]
+
+- Added new keyword 'Element Should Not Contain'.
+  [molsky]
+
+- Added new keyword 'Wait Until Page Does Not Contain Element'.
+  [molsky]
+
+- Added new locator strategy, scLocator, for finding SmartClient and SmartGWT elements.
+  [IlfirinPL]
+
+- Edited acceptance test scripts to automatically make known issues for the currently
+  known browser and python version noncritical. Also added a noncritical case to the
+  travis config for situations where testing is failing on travis for an unknown reason.
+- 'Capture Screenshot' now attempts to create its containing directory if the directory
+  specified in the filename does not exist.
+- 'Choose File' now fails if the file doesn't exist
+- Added new keywords 'Add Location Strategy' and 'Remove Location Strategy'
+  [zephraph]
+
+- Added 'Get Window Position' and 'Set Window Position' keywords matching the
+  Selenium functionality.
+  [ktarasz]
 
 1.6
 ---
@@ -15,7 +51,7 @@ Release Notes
 
 - Fixed issue where the browser failed to properly register if 'Open Browser'
   did not complete.
-  [Mika Batsman][elizaleong][emanlove] 
+  [Mika Batsman][elizaleong][emanlove]
 
 - Added support for negative indices for rows and columns in table-related
   keywords.
@@ -25,7 +61,7 @@ Release Notes
   prefix 'partial link'.
   [lina1]
 
-- Added new keyword 'Clear Element Text' for clearing the text of text entry 
+- Added new keyword 'Clear Element Text' for clearing the text of text entry
   elements.
   [emanlove]
 
@@ -85,7 +121,7 @@ continuous integration builds to go green by fixing internal tests.
 - Raise exception in selecting non-existing item in list. Error handling varies
   between single-select and multi-select lists. See keyword documentation for
   more information.
-  [adwu73][emanlove] 
+  [adwu73][emanlove]
 
 - Added 'Get Window Size' and 'Set Window Size' keywords matching the
   Selenium functionality.
@@ -98,11 +134,11 @@ continuous integration builds to go green by fixing internal tests.
 
 - Beautified README.rst.
   [j1z0][emanlove]
-  
+
 - Changed press key test to use Line Feed (\10) instead of
   Carriage Return (\13).
   [emanlove]
- 
+
 - Added new keyword 'Click Element At Coordinates'.
   [aaltat][pierreroth64][ombre42][emanlove]
 
@@ -153,7 +189,7 @@ continuous integration builds to go green by fixing internal tests.
   [emanlove]
 
 - Use Selenium's Select class within Selenium2Library's "Select *" keywords.
-  Optimization of certain "Select *" keywords to increase performance. 
+  Optimization of certain "Select *" keywords to increase performance.
   [emanlove] [schminitz]
 
 - Replace maximize current browser window from JS to webdriver.

doc/Selenium2Library.html

@@ -1,16 +1,15 @@
 import os
 from keywords import *
-
-THIS_DIR = os.path.dirname(os.path.abspath(__file__))
-execfile(os.path.join(THIS_DIR, 'version.py'))
+from version import VERSION
+from utils import LibraryListener
 
 __version__ = VERSION
 
 class Selenium2Library(
-    _LoggingKeywords, 
-    _RunOnFailureKeywords, 
-    _BrowserManagementKeywords, 
-    _ElementKeywords, 
+    _LoggingKeywords,
+    _RunOnFailureKeywords,
+    _BrowserManagementKeywords,
+    _ElementKeywords,
     _TableElementKeywords,
     _FormElementKeywords,
     _SelectElementKeywords,
@@ -31,7 +30,7 @@ class Selenium2Library(
     = Before running tests =
 
     Prior to running test cases using Selenium2Library, Selenium2Library must be
-    imported into your Robot test suite (see `importing` section), and the 
+    imported into your Robot test suite (see `importing` section), and the
     `Open Browser` keyword must be used to open a browser to the desired location.
 
     **--- Note important change starting with Version 1.7.0 release ---**
@@ -100,7 +99,26 @@ class Selenium2Library(
     | css        | Table Should Contain `|` css=table.my_class `|` text               | Matches by @id or @name attribute |
     | xpath      | Table Should Contain `|` xpath=//table/[@name="my_table"] `|` text | Matches by @id or @name attribute |
 
-    *Timeouts*
+    = Custom Locators =
+
+    If more complex lookups are required than what is provided through the default locators, custom lookup strategies can
+    be created. Using custom locators is a two part process. First, create a keyword that returns the WebElement
+    that should be acted on.
+
+    | Custom Locator Strategy | [Arguments] | ${browser} | ${criteria} | ${tag} | ${constraints} |
+    |   | ${retVal}= | Execute Javascript | return window.document.getElementById('${criteria}'); |
+    |   | [Return] | ${retVal} |
+
+    This keyword is a reimplementation of the basic functionality of the `id` locator where `${browser}` is a reference
+    to the WebDriver instance and `${criteria}` is the text of the locator (i.e. everything that comes after the = sign).
+    To use this locator it must first be registered with `Add Location Strategy`.
+
+    Add Location Strategy  custom  Custom Locator Strategy
+
+    The first argument of `Add Location Strategy` specifies the name of the lookup strategy (which must be unique). After
+    registration of the lookup strategy, the usage is the same as other locators. See `Add Location Strategy` for more details.
+
+    = Timeouts =
 
     There are several `Wait ...` keywords that take timeout as an
     argument. All of these timeout arguments are optional. The timeout
@@ -150,3 +168,4 @@ def __init__(self, timeout=5.0, implicit_wait=0.0, run_on_failure='Capture Page
         self.set_selenium_timeout(timeout)
         self.set_selenium_implicit_wait(implicit_wait)
         self.register_keyword_to_run_on_failure(run_on_failure)
+        self.ROBOT_LIBRARY_LISTENER = LibraryListener()

src/Selenium2Library/__init__.py

@@ -258,6 +258,26 @@ def set_window_size(self, width, height):
         """
         return self._current_browser().set_window_size(width, height)
 
+    def get_window_position(self):
+        """Returns current window position as `x` then `y`.
+
+        Example:
+        | ${x} | ${y}= | Get Window Position |
+        """
+        position = self._current_browser().get_window_position()
+        return position['x'], position['y']
+
+    def set_window_position(self, x, y):
+        """Sets the position `x` and `y` of the current window to the specified values.
+
+        Example:
+        | Set Window Size | ${1000} | ${0}       |
+        | ${x} | ${y}= | Get Window Position |
+        | Should Be Equal | ${x}      | ${1000}   |
+        | Should Be Equal | ${y}      | ${0}      |
+        """
+        return self._current_browser().set_window_position(x, y)
+
     def select_frame(self, locator):
         """Sets frame identified by `locator` as current frame.
 

src/Selenium2Library/keywords/_browsermanagement.py

@@ -3,6 +3,7 @@
 from selenium.webdriver.remote.webelement import WebElement
 from Selenium2Library import utils
 from Selenium2Library.locators import ElementFinder
+from Selenium2Library.locators import CustomLocator
 from keywordgroup import KeywordGroup
 
 try:
@@ -72,6 +73,23 @@ def element_should_contain(self, locator, expected, message=''):
                           "its text was '%s'." % (locator, expected, actual)
             raise AssertionError(message)
 
+    def element_should_not_contain(self, locator, expected, message=''):
+        """Verifies element identified by `locator` does not contain text `expected`.
+
+        `message` can be used to override the default error message.
+
+        Key attributes for arbitrary elements are `id` and `name`. See
+        `Element Should Contain` for more details.
+        """
+        self._info("Verifying element '%s' does not contain text '%s'."
+                   % (locator, expected))
+        actual = self._get_text(locator)
+        if expected in actual:
+            if not message:
+                message = "Element '%s' should not contain text '%s' but " \
+                          "it did." % (locator, expected)
+            raise AssertionError(message)
+
     def frame_should_contain(self, locator, text, loglevel='INFO'):
         """Verifies frame identified by `locator` contains `text`.
 
@@ -602,6 +620,38 @@ def xpath_should_match_x_times(self, xpath, expected_xpath_count, message='', lo
         self._info("Current page contains %s elements matching '%s'."
                    % (actual_xpath_count, xpath))
 
+    # Public, custom
+    def add_location_strategy(self, strategy_name, strategy_keyword, persist=False):
+        """Adds a custom location strategy based on a user keyword. Location strategies are
+        automatically removed after leaving the current scope by default. Setting `persist`
+        to any non-empty string will cause the location strategy to stay registered throughout
+        the life of the test.
+
+        Trying to add a custom location strategy with the same name as one that already exists will
+        cause the keyword to fail.
+
+        Custom locator keyword example:
+        | Custom Locator Strategy | [Arguments] | ${browser} | ${criteria} | ${tag} | ${constraints} |
+        |   | ${retVal}= | Execute Javascript | return window.document.getElementById('${criteria}'); |
+        |   | [Return] | ${retVal} |
+
+        Usage example:
+        | Add Location Strategy | custom | Custom Locator Strategy |
+        | Page Should Contain Element | custom=my_id |
+
+        See `Remove Location Strategy` for details about removing a custom location strategy.
+        """
+        strategy = CustomLocator(strategy_name, strategy_keyword)
+        self._element_finder.register(strategy, persist)
+
+    def remove_location_strategy(self, strategy_name):
+        """Removes a previously added custom location strategy.
+        Will fail if a default strategy is specified.
+
+        See `Add Location Strategy` for details about adding a custom location strategy.
+        """
+        self._element_finder.unregister(strategy_name)
+
     # Private
 
     def _element_find(self, locator, first_only, required, tag=None):
@@ -733,4 +783,3 @@ def _page_should_not_contain_element(self, locator, tag, message, loglevel):
             raise AssertionError(message)
         self._info("Current page does not contain %s '%s'."
                    % (element_name, locator))
-

src/Selenium2Library/keywords/_element.py

@@ -165,17 +165,17 @@ def select_radio_button(self, group_name, value):
     # Public, text fields
 
     def choose_file(self, locator, file_path):
-        """Inputs the `file_path` into file input field found by `identifier`.
+        """Inputs the `file_path` into file input field found by `locator`.
 
         This keyword is most often used to input files into upload forms.
-        The file specified with `file_path` must be available on the same host 
+        The file specified with `file_path` must be available on the same host
         where the Selenium Server is running.
 
         Example:
         | Choose File | my_upload_field | /home/user/files/trades.csv |
         """
         if not os.path.isfile(file_path):
-            self._info("File '%s' does not exist on the local file system"
+            raise AssertionError("File '%s' does not exist on the local file system"
                         % file_path)
         self._element_find(locator, True, True).send_keys(file_path)
 
@@ -271,7 +271,7 @@ def textarea_should_contain(self, locator, expected, message=''):
         else:
             raise ValueError("Element locator '" + locator + "' did not match any elements.")
         self._info("Text area '%s' contains text '%s'." % (locator, expected))
-        
+
     def textarea_value_should_be(self, locator, expected, message=''):
         """Verifies the value in text area identified by `locator` is exactly `expected`.
 
@@ -290,7 +290,7 @@ def textarea_value_should_be(self, locator, expected, message=''):
         else:
             raise ValueError("Element locator '" + locator + "' did not match any elements.")
         self._info("Content of text area '%s' is '%s'." % (locator, expected))
-        
+
     # Public, buttons
 
     def click_button(self, locator):

src/Selenium2Library/keywords/_formelement.py

@@ -1,6 +1,7 @@
-import os
+import os, errno
 import robot
 from keywordgroup import KeywordGroup
+from robot.api import logger
 
 class _ScreenshotKeywords(KeywordGroup):
 
@@ -17,18 +18,30 @@ def capture_page_screenshot(self, filename=None):
         `selenium-screenshot-<counter>.png` under the directory where
         the Robot Framework log file is written into. The `filename` is
         also considered relative to the same directory, if it is not
-        given in absolute format.
+        given in absolute format. If an absolute or relative path is given
+        but the path does not exist it will be created. 
 
         `css` can be used to modify how the screenshot is taken. By default
         the bakground color is changed to avoid possible problems with
         background leaking when the page layout is somehow broken.
         """
         path, link = self._get_screenshot_paths(filename)
 
+        target_dir = os.path.dirname(path)
+        if not os.path.exists(target_dir):
+            try:
+                os.makedirs(target_dir)
+            except OSError as exc:
+                if exc.errno == errno.EEXIST and os.path.isdir(target_dir):
+                    pass
+                else: raise
+
         if hasattr(self._current_browser(), 'get_screenshot_as_file'):
-          self._current_browser().get_screenshot_as_file(path)
+          if not self._current_browser().get_screenshot_as_file(path):
+              raise RuntimeError('Failed to save screenshot ' + filename)
         else:
-          self._current_browser().save_screenshot(path)
+          if not self._current_browser().save_screenshot(path):
+            raise RuntimeError('Failed to save screenshot ' + filename)
 
         # Image is shown on its own row and thus prev row is closed on purpose
         self._html('</td></tr><tr><td colspan="3"><a href="%s">'