Adding Python code to launch BlackBerry browser automatically

The BlackBerry10 browser doesn't launch automatically with WebDriver, which
makes automated testing problematic. This patch enables the automatic
launching of the BlackBerry10 browser, if the user has the proper env.
setup.

This patch assumes the IP/port of the device. The user must provide location
of required tools and device password.

Code review updates:
* making BB tools easier
* Fixed up python styling issues (pep8). Added a better description of the args.
* Realized that blackberry tools when installed with the WebWorks SDK are in the path
so changed it so those are handled by default. Also made the 'typical' ip address
used to be the default, now the user only needs to supply a device password if
everything is setup in the standard way.
* Added some directions/hints on getting the webworks SDK, location should never
change.
* Removing Wait(3) + improving errors
* I found a better way to wait for the BB10 browser to launch, so
it now polls until the browser launches and is ready.
* Improved error messaging to give more details for end user.
* Switching to WebDriverWait
last patch had the potential to get stuck in an infinite loop. Updated
code to use WebDriverWait to watch for the browser to load. Also lead to
much cleaner code.
* Using LOAD_TIMEOUT for easier customization
* Had a CONTS created but never used it. Using it now, reduced to 5s
as that still consistently works.
* Fixing Stackswallowing + nits
* Stack is now properly passed along with an exception. Added message when loading
browser

Signed-off-by: Luke Inman-Semerau <[email protected]>

Author: Rory Craig-Barnes

py/build.desc

@@ -24,6 +24,10 @@ py_test(
   deps = [ ":test_phantomjs" ],
   browsers = [ "phantomjs" ])
 
+py_test(
+  name = "blackberry_test",
+  deps = [ ":test_blackberry" ],
+  browsers = [ "blackberry" ])
 
 py_test(
   name = "chrome_test",
@@ -65,6 +69,7 @@ py_test(
     "chrome",
     "ff",
     "ie",
+    "blackberry",
     "phantomjs",
     "remote_firefox",
     "safari",

py/selenium/webdriver/__init__.py

@@ -24,6 +24,7 @@
 from .ie.webdriver import WebDriver as Ie
 from .opera.webdriver import WebDriver as Opera
 from .safari.webdriver import WebDriver as Safari
+from .blackberry.webdriver import WebDriver as BlackBerry
 from .phantomjs.webdriver import WebDriver as PhantomJS
 from .android.webdriver import WebDriver as Android
 from .remote.webdriver import WebDriver as Remote

py/selenium/webdriver/blackberry/__init__.py

@@ -0,0 +1,18 @@
+#!/usr/bin/python
+#
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

py/selenium/webdriver/blackberry/webdriver.py

@@ -0,0 +1,115 @@
+#!/usr/bin/python
+#
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+import os
+import platform
+import time
+import subprocess
+
+from selenium.webdriver.remote.command import Command
+from selenium.webdriver.remote.webdriver import WebDriver as RemoteWebDriver
+from selenium.common.exceptions import WebDriverException
+from selenium.webdriver.support.ui import WebDriverWait
+
+LOAD_TIMEOUT = 5
+
+
+class WebDriver(RemoteWebDriver):
+    """
+    Controls the BlackBerry Browser and allows you to drive it.
+
+    :Args:
+     - device_password - password for the BlackBerry device or emulator you are
+       trying to drive
+     - bb_tools_dir path to the blackberry-deploy executable. If the default
+       is used it assumes it is in the $PATH
+     - hostip - the ip for the device you are trying to drive. Falls back to
+       169.254.0.1 which is the default ip used
+     - port - the port being used for WebDriver on device. defaults to 1338
+     - desired_capabilities: Dictionary object with non-browser specific
+       capabilities only, such as "proxy" or "loggingPref".
+
+    Note: To get blackberry-deploy you will need to install the BlackBerry
+          WebWorks SDK - the default install will put it in the $PATH for you.
+          Download at https://developer.blackberry.com/html5/downloads/
+    """
+    def __init__(self, device_password, bb_tools_dir=None,
+                 hostip='169.254.0.1', port=1338, desired_capabilities={}):
+        remote_addr = 'http://{}:{}'.format(hostip, port)
+
+        filename = 'blackberry-deploy'
+        if platform.system() == "Windows":
+            filename += '.bat'
+
+        if bb_tools_dir is not None:
+            if os.path.isdir(bb_tools_dir):
+                bb_deploy_location = os.path.join(bb_tools_dir, filename)
+                if not os.path.isfile(bb_deploy_location):
+                    raise WebDriverException('Invalid blackberry-deploy location: {}'.format(bb_deploy_location))
+            else:
+                raise WebDriverException('Invalid blackberry tools location, must be a directory: {}'.format(bb_tools_dir))
+        else:
+            bb_deploy_location = filename
+
+        """
+        Now launch the BlackBerry browser before allowing anything else to run.
+        """
+        try:
+            launch_args = [bb_deploy_location,
+                           '-launchApp',
+                           str(hostip),
+                           '-package-name', 'sys.browser',
+                           '-package-id', 'gYABgJYFHAzbeFMPCCpYWBtHAm0',
+                           '-password', str(device_password)]
+
+            with open(os.devnull, 'w') as fp:
+                p = subprocess.Popen(launch_args, stdout=fp)
+
+            returncode = p.wait()
+
+            if returncode == 0:
+                # wait for the BlackBerry10 browser to load.
+                is_running_args = [bb_deploy_location,
+                                   '-isAppRunning',
+                                   str(hostip),
+                                   '-package-name', 'sys.browser',
+                                   '-package-id', 'gYABgJYFHAzbeFMPCCpYWBtHAm0',
+                                   '-password', str(device_password)]
+
+                WebDriverWait(None, LOAD_TIMEOUT)\
+                    .until(lambda x: subprocess.check_output(is_running_args)
+                           .find('result::true'),
+                           message='waiting for BlackBerry10 browser to load')
+
+                RemoteWebDriver.__init__(self,
+                                         command_executor=remote_addr,
+                                         desired_capabilities=desired_capabilities)
+            else:
+                raise WebDriverException('blackberry-deploy failed to launch browser')
+        except Exception as e:
+            raise WebDriverException('Something went wrong launching blackberry-deploy', stacktrace=getattr(e, 'stacktrace', None))
+
+    def quit(self):
+        """
+        Closes the browser and shuts down the
+        """
+        try:
+            RemoteWebDriver.quit(self)
+        except http_client.BadStatusLine:
+            pass

rake-tasks/browsers.rb

@@ -49,6 +49,16 @@
     :browser_name => "chrome",
     :available => chrome?
   },
+  "blackberry" => {
+    :python => {
+      :ignore => "blackberry",
+      :dir => "blackberry",
+      :file_string => "blackberry",
+      :class => "BlackBerry",
+      :constructor_args => "device_password='password'"
+    },
+    :browser_name => "blackberry"
+  },
   "phantomjs" => {
     :python => {
       :ignore => "phantomjs",