Get Log for firefox and firefox profile kw

Jani Mikkonen · Jani Mikkonen · commit b075dcefc22a · 2019-09-15T16:42:59.000+03:00
Added support for Get Log keyword to return browser type logs for
Firefox.

In order for get_log() to return anything meaningful, firefox profile
needs to have right properties. These can be generated by Generate
Firefox Profile.
diff --git a/README.md b/README.md
@@ -163,6 +163,14 @@ tests do show they work.
 
   * Sets arbituary attribute of the element into provided value
 
+* Get Log   **log_type**
+
+  * Returns log_type logs from current browser. If Browser is firefox and profile generated with Generate Firefox Profile keyword is used, Get Log is also able to return browser type logs for it.
+
+* Generate Firefox Profile **options** **accept_untrusted_certs** **proxy**
+
+  * Generates firefox with given options. Also can disable ssl cert checking and setting the proxy.
+
 # Keyword Documentation
 
 Keyword documentation [here](https://salabs.github.io/robotframework-seleniumtestability/index.html) and if you need to create one for offline usage:
diff --git a/assets/templates/code.js b/assets/templates/code.js
@@ -89,3 +89,13 @@ var redirectTrigger = function() {
   var redirurl = "https://httpbin.org/redirect-to?url=" + cur + "&status_code=302"
   window.location = redirurl
 }
+
+
+var logTrigger = function() {
+  console.log("LOGTRIGGER: log")
+  console.error("LOGTRIGGER: error")
+  console.debug("LOGTRIGGER: debug")
+  console.trace("LOGTRIGGER: trace")
+  console.info("LOGTRIGGER: info")
+  logTriggerError()
+}
diff --git a/assets/templates/index.html b/assets/templates/index.html
@@ -70,9 +70,12 @@
   <body>
       <table border="1">
         <tr>
-          <td> 
+          <td>
               <button id="redirect-button" type="button" name="redirect" onClick="redirectTrigger()">Redirect loop</button>
-            </td>
+          </td>
+          <td>
+              <button id="log-button" type="button" name="log" onClick="logTrigger()">Log Something</button>
+          </td>
         </tr>
         <tr>
             <td>
diff --git a/atest/keywords.robot b/atest/keywords.robot
@@ -17,9 +17,10 @@ Setup Web Environment
   [Arguments]  ${BROWSER}  ${URL}
   [Documentation]  Opens a browser with given url
   ${URL}=  Set Variable  ${URL}
+  ${FF_PROFILE}=     Generate Firefox Profile
   Set Selenium Timeout  10 seconds
   Set Selenium Speed  0 seconds
-  Open Browser  ${URL}  browser=${BROWSER}
+  Open Browser  ${URL}  browser=${BROWSER}      ff_profile_dir=${FF_PROFILE.path}
   Wait For Document Ready
 
 Start Flask App
diff --git a/atest/logs.robot b/atest/logs.robot
@@ -2,33 +2,42 @@
 Documentation   Verifies log fetching
 Suite Setup     Start Flask App
 Suite Teardown  Stop Flask App
-Test Teardown   Teardown Web Environment
 Test Template   Test Get Log
+Test Teardown   Teardown Web Environment
 Library         SeleniumLibrary  plugins=${CURDIR}/../src/SeleniumTestability;True;29 seconds;False
 Resource        keywords.robot
 Library         Collections
 
 *** Test Cases ***
 Logs With Firefox
-  ${FF}  loggingPrefs  0
+  ${FF}   loggingPrefs  2  7  11
 
 Logs With Chrome
-  ${GC}  goog:loggingPrefs  10
+  ${GC}   goog:loggingPrefs  2  5  10
 
 *** Keywords ***
 Local Setup Test Environment
-  [Arguments]  ${BROWSER}  ${PREFS}  ${ROWS}
+  [Arguments]  ${BROWSER}  ${PREFS}
   [Documentation]  normal test setup but with desired_capabilities added
   ${cap}=  Generate Capabilities with Logging Prefs  ${BROWSER}  ${PREFS}
-  Open Browser  ${URL}  browser=${BROWSER}  desired_capabilities=${cap}
+  ${FF_PROFILE}=     Generate Firefox Profile
+  Open Browser  ${URL}  browser=${BROWSER}  desired_capabilities=${cap}  ff_profile_dir=${FF_PROFILE.path}
   Wait For Document Ready
-  FOR  ${idx}  IN RANGE  ${ROWS}
-    Execute Javascript  console.log("Hello World ${idx}")
-  END
 
 Test Get Log
-  [Arguments]  ${BROWSER}  ${PREFS}  ${ROWS}
+  [Arguments]  ${BROWSER}  ${PREFS}  ${ROWS}  ${FIRST}  ${SECOND}
   [Documentation]  Verifies get_log returns something when possible and doesnt cause errors
-  Local Setup Test Environment  ${BROWSER}  ${PREFS}  ${ROWS}
+  Local Setup Test Environment  ${BROWSER}  ${PREFS}
+  Click Button    id:log-button
+  ${LOG}=  Get Log  browser
+  Length Should Be  ${LOG}  ${FIRST}
+  FOR  ${idx}  IN RANGE  ${ROWS}
+    Execute Javascript  console.log("Hello World ${idx}")
+    Execute Javascript  console.info("Hello World ${idx} as info")
+    Execute Javascript  console.warn("Hello World ${idx} as warn")
+    Execute Javascript  console.error("Hello World ${idx} as error")
+    Execute Javascript  console.trace("Hello World ${idx} as trace")
+    Execute Javascript  console.debug("Hello World ${idx} as debug")
+  END
   ${LOG}=  Get Log  browser
-  Length Should Be  ${LOG}  ${ROWS}
+  Length Should Be  ${LOG}  ${SECOND}
diff --git a/src/SeleniumTestability/plugin.py b/src/SeleniumTestability/plugin.py
@@ -6,15 +6,19 @@
 from .listener import TestabilityListener
 from .javascript import JS_LOOKUP
 from .logger import get_logger, argstr, kwargstr
-from .types import WebElementType, LocatorType, OptionalBoolType, OptionalStrType, BrowserLogsType, OptionalDictType
+from .types import WebElementType, LocatorType, OptionalBoolType, OptionalStrType, BrowserLogsType, OptionalDictType, is_firefox
 from robot.utils import is_truthy, timestr_to_secs, secs_to_timestr
 from selenium.webdriver.support.ui import WebDriverWait
 from selenium.common.exceptions import TimeoutException, WebDriverException
 from http.cookies import SimpleCookie
 from furl import furl
 from typing import Dict, Callable, Any
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+from selenium.webdriver import FirefoxProfile
 import wrapt
+import re
+import json
+from time import time
 
 
 @wrapt.decorator
@@ -171,6 +175,7 @@ def __init__(
         self.hidden_elements = {}  # type: Dict[str, str]
         self.browser_warn_shown = False
         self.empty_log_warn_shown = False
+        self.ff_log_pos = {}  # type: Dict[str, int]
 
     @log_wrapper
     def _inject_testability(self: "SeleniumTestability") -> None:
@@ -502,19 +507,58 @@ def element_should_not_be_blocked(self: "SeleniumTestability", locator: LocatorT
         if is_blocked:
             raise AssertionError("Element with locator {} is blocked".format(locator))
 
+    def _get_ff_log(self: "SeleniumTestability", name: str) -> BrowserLogsType:
+        matcher = r"^(?P<source>JavaScript|console)(\s|\.)(?P<level>warn.*?|debug|trace|log|error|info):\s(?P<message>.*)$"
+        LEVEL_LOOKUP = {
+            "log": "INFO",
+            "warn": "WARN",
+            "warning": "WARN",
+            "error": "SEVERE",
+            "info": "INFO",
+            "trace": "SEVERE",
+            "debug": "DEBUG",
+        }
+        SOURCE_LOOKUP = {"JavaScript": "javascript", "console": "console-api"}
+        log = []
+        skip_lines = self.ff_log_pos.get(name, 0)
+        buff = []
+        with open(name, "r") as f:
+            buff = f.read().split("\n")
+        self.ff_log_pos[name] = skip_lines + len(buff)
+        buff = buff[skip_lines:]
+
+        for line in buff:
+            matches = re.search(matcher, line)
+            if matches:
+                row = {
+                    "level": LEVEL_LOOKUP[matches.group("level")],
+                    "message": matches.group("message"),
+                    "source": SOURCE_LOOKUP[matches.group("source")],
+                    "timestamp": int(time() * 1000),
+                }
+                log.append(json.dumps(row))
+        return log
+
     @log_wrapper
     @keyword
     def get_log(self: "SeleniumTestability", log_type: str = "browser") -> BrowserLogsType:
         """
-        Returns logs determined by ``log_type`` from the current browser.
+        Returns logs determined by ``log_type`` from the current browser. What is returned
+        depends on desired_capabilities passed to `Open Browser`.
+
+        Note: On firefox, the firefox profile has to have `devtools.console.stdout.content` property to be set.
+        This can be done automatically with `Generate Firefox Profile` and then pass that to `Open Browser`.
         """
         ret = []  # type: BrowserLogsType
         try:
-            ret = self.ctx.driver.get_log(log_type)
+            if is_firefox(self.ctx.driver) and log_type == "browser":
+                ret = self._get_ff_log(self.ctx.driver.service.log_file.name)
+            else:
+                ret = self.ctx.driver.get_log(log_type)
         except WebDriverException:
             if not self.browser_warn_shown:
                 self.browser_warn_shown = True
-                self.warn("Current browser does not support fetching logs from the browser")
+                self.warn("Current browser does not support fetching logs from the browser with log_type: {}".format(log_type))
                 return []
         if not ret and not self.empty_log_warn_shown:
             self.empty_log_warn_shown = True
@@ -534,7 +578,6 @@ def get_default_capabilities(self: "SeleniumTestability", browser_name: str) ->
             self.logger.debug(e)
             return None
 
-
     @log_wrapper
     @keyword
     def set_element_attribute(self: "SeleniumTestability", locator: LocatorType, attribute: str, value: str) -> None:
@@ -543,3 +586,27 @@ def set_element_attribute(self: "SeleniumTestability", locator: LocatorType, att
         """
         from_element = self.el.find_element(locator)
         self.ctx.driver.execute_script(JS_LOOKUP["set_element_attribute"], from_element, attribute, value)
+
+    @log_wrapper
+    @keyword
+    def generate_firefox_profile(
+        self: "SeleniumTestability",
+        options: OptionalDictType = None,
+        accept_untrusted_certs: bool = False,
+        proxy: OptionalStrType = None,
+    ) -> FirefoxProfile:
+        profile = FirefoxProfile()
+        if options:
+            for key, value in options.items():  # type: ignore
+                profile.set_preference(key, value)
+
+        profile.set_preference("devtools.console.stdout.content", True)
+
+        if accept_untrusted_certs:
+            profile.accept_untrusted_certs
+
+        if proxy:
+            profile.set_proxy(proxy)
+
+        profile.update_preferences()
+        return profile
diff --git a/src/SeleniumTestability/types.py b/src/SeleniumTestability/types.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 from typing import Union, Optional, List
-from selenium.webdriver.support.event_firing_webdriver import EventFiringWebElement
+from selenium.webdriver.support.event_firing_webdriver import EventFiringWebElement, EventFiringWebDriver
+from selenium.webdriver import Firefox
 from selenium.webdriver.remote.webelement import WebElement
 from psutil import Process
 
@@ -11,3 +12,13 @@
 OptionalDictType = Optional[str]
 BrowserLogsType = List[str]
 ProcessType = Union[Process, int]
+FirefoxWebDriverType = Union[Firefox, EventFiringWebDriver]
+
+
+def is_firefox(webdriver: FirefoxWebDriverType) -> bool:
+    if isinstance(webdriver, Firefox):
+        return True
+    if isinstance(webdriver, EventFiringWebDriver):
+        if isinstance(webdriver.wrapped_driver, Firefox):
+            return True
+    return False
