Enhanced to support seleniumbox

examples/webdriver/etc/testbed.yaml

@@ -3,6 +3,16 @@
 
 
 devices:
+    # an example for seleniumbox implementation
+    seleniumbox:
+        type: browser
+        connections:
+            webdriver:
+                class: genie.webdriver.connectors.WebDriverConnector
+                driver: "any"
+                version: "any"
+                testname: "TEST"
+                token: "" #seleniumbox token
 
     # the following is an example of firefox browser
     firefox:

src/genie/webdriver/connectors.py

@@ -1,10 +1,37 @@
-
 from importlib import import_module
 
 from selenium import webdriver
 
 from pyats.connections import BaseConnection
 
+from string import Template
+
+import logging
+
+import requests
+
+import selenium
+
+import random
+
+import json
+
+import os
+
+log = logging.getLogger(os.path.basename(__file__))
+log.setLevel(logging.INFO)
+
+selenium_box_url = "https://seleniumbox.cisco.com/wd/hub"
+
+# REST API End point to get browser details.
+selenium_box_browser_details = "https://seleniumbox.cisco.com/e34/" \
+                               "api/browser/details?name=$browser"
+
+# Change this to set the last n browsers
+browser_limit = -3
+
+browsers = ['chrome', 'firefox']
+
 
 class WebDriverConnector(BaseConnection):
 
@@ -19,7 +46,6 @@ def __init__(self, *args, **kwargs):
 
         self.driver = None
 
-
     def connect(self):
 
         # do nothing if already connected
@@ -31,39 +57,71 @@ def connect(self):
 
         # remove credentials block if present
         credentials = connection_info.pop('credentials', None)
-
+        browser_name = None
+        browser_version = None
+        driver = None
         # rename ip -> host, cast to str type
         try:
             driver_name = connection_info.pop('driver')
-            driver = getattr(webdriver, driver_name)
-
+            if 'any' == str(driver_name).lower():
+                driver_name = random.choice(browsers)
+                driver = getattr(webdriver, driver_name.title())
+            else:
+                driver = getattr(webdriver, driver_name.title())
+            browser_name = str(driver_name)
         except KeyError:
-            raise ValueError('Missing driver: definition in YAML connection '
-                             'section') from None
-
+            log.info('Missing driver: definition in YAML connection section')
         except AttributeError:
-            raise ValueError('No such driver type: %s' % driver) from None
+            log.info('No such driver type: %s' % driver)
 
         # remove class
         connection_info.pop('class')
 
-        # check if 'service' and 'options' is passed to connect()
+        # check if 'token' is passed to connect()
         # if passed, add to connection_info
-        if hasattr(self, 'service'):
-            connection_info['service'] = self.service
-        if hasattr(self, 'options'):
-            connection_info['options'] = self.options
-        elif 'options' in connection_info:
-            # derive 'options' from testbed yaml
-            connection_options = connection_info.pop('options')
-            options = import_module(f"selenium.webdriver.{driver_name.lower()}.options")
-            connect_options = options.Options()
-            for k, v in connection_options.items():
-                setattr(connect_options, k, v)
-            connection_info['options'] = connect_options
-
-        # create class
-        self.driver = driver(**connection_info)
+        try:
+            token = connection_info['token']
+            if token:
+                version = connection_info['version']
+                supported_browsers = WebDriverConnector.__supported_browsers__()
+                log.info(supported_browsers)
+                if 'any' == version.lower():
+                    browser_version = random.choice(supported_browsers[
+                                                        browser_name]["versions"])
+                else:
+                    browser_version = version
+            log.info(f"Chosen Browser Name : {browser_name}")
+            log.info(f"Chosen Browser version : {browser_version}")
+            if browser_name and browser_version:
+                if selenium.__version__ == "3.141.0":
+                    self.driver = webdriver.Remote(desired_capabilities={
+                        "browserName": browser_name,
+                        "e34:token": token,
+                        "e34:video": True,
+                        "acceptInsecureCerts": True,
+                        "e34:l_testName": connection_info['testname'],
+                        "e34:per_test_timeout_ms": 1800000,
+                        "version": str(browser_version)},
+                        command_executor=selenium_box_url)
+        except KeyError:
+            log.info("Token not found.")
+            # check if 'service' and 'options' is passed to connect()
+            # if passed, add to connection_info
+            if hasattr(self, 'service'):
+                connection_info['service'] = self.service
+            if hasattr(self, 'options'):
+                connection_info['options'] = self.options
+            elif 'options' in connection_info:
+                # derive 'options' from testbed yaml
+                connection_options = connection_info.pop('options')
+                options = import_module(f"selenium.webdriver.{driver_name.lower()}.options")
+                connect_options = options.Options()
+                for k, v in connection_options.items():
+                    setattr(connect_options, k, v)
+                connection_info['options'] = connect_options
+
+            # create class
+            self.driver = driver(**connection_info)
 
     def disconnect(self):
         self.driver.quit()
@@ -80,7 +138,7 @@ def __getattr__(self, attr):
         if hasattr(self.driver, attr):
             return getattr(self.driver, attr)
         else:
-            raise AttributeError("'%s' object has no attribute '%s" 
+            raise AttributeError("'%s' object has no attribute '%s"
                                  % (type(self).__name__, attr))
 
     def __dir__(self):
@@ -92,5 +150,37 @@ def execute(self):
         return self.driver.execute
 
     def configure(self, *args, **kwargs):
-        raise RuntimeError("'%s' class does not support configure command" 
+        raise RuntimeError("'%s' class does not support configure command"
                            % type(self).__name__)
+
+    @staticmethod
+    def __supported_browsers__():
+        """
+        constructs
+         chrome:
+            versions: ['83', '86', '88']
+         firefox:
+            versions: ['77', '82', '85']
+         MicrosoftEdge:
+            versions: ['94', '95', '96']
+        :returns: Latest supported browsers from seleniumbox
+        """
+        url = Template(selenium_box_browser_details)
+        supported_browsers = dict()
+        supported_browsers.update({'chrome': {'versions': list()}})
+        supported_browsers.update({'firefox': {'versions': list()}})
+        supported_browsers.update({'edge': {'versions': list()}})
+        try:
+            for browser in supported_browsers.keys():
+                browser_versions = requests.get(
+                    url.substitute(browser=browser))
+                result = json.loads(browser_versions.text)
+                browser_version_lst = result['tags']
+                supported_browsers[browser].update(
+                    {'versions': sorted([int(browser_version[:browser_version.find('.')])
+                                         for browser_version in browser_version_lst])[browser_limit:]})
+        except Exception as e:
+            supported_browsers = None
+            log.error("Connection Failed: seleniumbox.cisco.com")
+
+        return supported_browsers