ENH: IE support

Author: lf2a

botcity/web/browsers/__init__.py

@@ -3,6 +3,7 @@
 from . import chrome
 from . import firefox
 from . import edge
+from . import ie
 
 
 class Browser(str, enum.Enum):
@@ -13,10 +14,12 @@ class Browser(str, enum.Enum):
         CHROME (str): Google Chrome
         FIREFOX (str): Mozilla Firefox
         EDGE (str): Microsoft Edge
+        IE (str): Microsoft Internet Explorer
     """
     CHROME = "chrome"
     FIREFOX = "firefox"
     EDGE = "edge"
+    IE = "ie"
 
 
 BROWSER_CONFIGS = {
@@ -41,4 +44,11 @@ class Browser(str, enum.Enum):
         "capabilities": edge.default_capabilities,
         "wait_for_downloads": edge.wait_for_downloads
     },
+    Browser.IE: {
+        "driver": "IEDriverServer",
+        "class": ie.Ie,
+        "options": ie.default_options,
+        "capabilities": ie.default_capabilities,
+        "wait_for_downloads": ie.wait_for_downloads
+    },
 }

botcity/web/browsers/ie.py

@@ -0,0 +1,37 @@
+from typing import Dict
+
+from selenium.webdriver import Ie  # noqa: F401, F403
+from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+from selenium.webdriver.ie.options import Options
+
+
+def default_options(headless=False, download_folder_path=None, user_data_dir=None) -> Options:
+    """Retrieve the default options for this browser curated by BotCity.
+
+    Useful links:
+    IE Driver Documentation: https://www.selenium.dev/documentation/ie_driver_server/
+    IE Command-Line Options: https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/general-info/hh826025(v=vs.85)
+
+    Returns:
+        Options: The Internet Explorer options.
+    """
+    ie_options = Options()
+    ie_options.add_argument("-embedding")
+    ie_options.add_argument("-extoff")
+    ie_options.add_argument("-k")
+    return ie_options
+
+
+def default_capabilities() -> Dict:
+    """Fetch the default capabilities for this browser.
+
+    Returns:
+        Dict: Dictionary with the default capabilities defined.
+    """
+    return DesiredCapabilities.INTERNETEXPLORER.copy()
+
+
+def wait_for_downloads(driver):
+    """Wait for all downloads to finish.
+    """
+    raise NotImplementedError('wait_for_downloads not yet supported')

docs/browsers.md

@@ -15,6 +15,8 @@ from botcity.web.browsers.chrome import default_options, default_capabilities
 #from botcity.web.browsers.firefox import default_options, default_capabilities
 # For Edge
 #from botcity.web.browsers.edge import default_options, default_capabilities
+# For IE
+#from botcity.web.browsers.ie import default_options, default_capabilities
 
 
 class Bot(WebBot):
@@ -77,3 +79,19 @@ Here are the documentation for the methods mentioned above for each of the suppo
 ::: botcity.web.browsers.edge.default_capabilities
     rendering:
       heading_level: 4
+
+### IE
+::: botcity.web.browsers.ie.default_options
+    rendering:
+      heading_level: 4
+::: botcity.web.browsers.ie.default_capabilities
+    rendering:
+      heading_level: 4
+
+#### Important
+
+If you have any questions about the driver see [IE Driver Server Documentation](https://www.selenium.dev/documentation/ie_driver_server/).
+
+See the [list of supported arguments in IE](https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/general-info/hh826025(v=vs.85)).
+
+During execution some errors may occur, [see the list of common errors](https://testguild.com/selenium-webdriver-fix-for-3-common-ie-errors/).