Initial implementation of new keyword

Author: emanlove

src/SeleniumLibrary/keywords/browsermanagement.py

@@ -26,9 +26,12 @@
 from SeleniumLibrary.base import keyword, LibraryComponent
 from SeleniumLibrary.locators import WindowManager
 from SeleniumLibrary.utils import timestr_to_secs, secs_to_timestr, _convert_timeout, _convert_delay
+from SeleniumLibrary.utils.path_formatter import _format_path_any
 
 from .webdrivertools import WebDriverCreator
+from ..utils import LogType
 
+DEFAULT_FILENAME_LOG = "{type}-log-{index}.txt"
 
 class BrowserManagementKeywords(LibraryComponent):
     def __init__(self, ctx):
@@ -552,6 +555,36 @@ def log_title(self) -> str:
         self.info(title)
         return title
 
+    @keyword
+    def get_log(self, type: LogType = None):    # filename, robotlog
+        """Gets the log for a given log type"""
+        log = self.driver.get_log(type)
+        self._save_log_to_file(DEFAULT_FILENAME_LOG, type, log)
+
+    def _save_log_to_file(self, filename, type, log):
+        path = self._get_log_path(filename, type)
+        self._create_directory(path)
+        with open(path, 'w', encoding='utf-8') as fh:
+            fh.write(log)
+
+    def _get_log_path(self, filename, type):
+        filename = filename.replace("/", os.sep)
+        filename = _format_path_any(filename, "type", type)
+        index = 0
+        while True:
+            index += 1
+            formatted = _format_path_any(filename, 'index', index)
+            path = os.path.join(directory, formatted)
+            # filename didn't contain {index} or unique path was found
+            if formatted == filename or not os.path.exists(path):
+                return path
+
+    def _create_directory(self, path):
+        target_dir = os.path.dirname(path)
+        if not os.path.exists(target_dir):
+            os.makedirs(target_dir)
+
+
     @keyword
     def title_should_be(self, title: str, message: Optional[str] = None):
         """Verifies that the current page title equals ``title``.

src/SeleniumLibrary/utils/__init__.py

@@ -25,6 +25,7 @@
     WINDOWS,
     _convert_timeout,
     _convert_delay,
+    LogType,
 )  # noqa
 
 

src/SeleniumLibrary/utils/path_formatter.py

@@ -18,6 +18,10 @@
 def _format_path(file_path, index):
     return file_path.format_map(_SafeFormatter(index=index))
 
+def _format_path_any(file_path, key, value):
+    d={}; d[key] = value
+    return file_path.format_map(_SafeFormatter(d))
+
 
 class _SafeFormatter(dict):
     def __missing__(self, key):

src/SeleniumLibrary/utils/types.py

@@ -16,6 +16,7 @@
 import os
 from datetime import timedelta
 from typing import Any
+from enum import Enum
 
 from robot.utils import is_string, timestr_to_secs
 from robot.utils import is_truthy, is_falsy  # noqa
@@ -44,3 +45,12 @@ def _convert_timeout(timeout):
 
 def type_converter(argument: Any) -> str:
     return type(argument).__name__.lower()
+
+
+class LogType(Enum):
+    """Enum that defines the type of log retrieved"""
+
+    BROWSER = "browser"
+    DRIVER  = "driver"
+    CLIENT  = "client"
+    SERVER  = "server"