Prevent Input Password to reveal password from Selenium logs

aaltat · aaltat · commit 429a3489b923 · 2019-11-03T00:11:57.000+02:00
Fixes robotframework#1454
diff --git a/atest/acceptance/keywords/textfields.robot b/atest/acceptance/keywords/textfields.robot
@@ -25,6 +25,24 @@ Input Text and Input Password
     Submit Form
     Verify Location Is "forms/submit.html"
 
+Input Password Should Not Log Password String
+    [Tags]     NoGrid
+    [Setup]    Go To Page "forms/login.html"
+    [Documentation]
+    ...    LOG 2:1  INFO          Typing password into text field 'password_field'.
+    ...    LOG 2:2  DEBUG STARTS: POST http
+    ...    LOG 2:3  DEBUG STARTS: http
+    ...    LOG 2:4  DEBUG         Finished Request
+    ...    LOG 2:5  DEBUG STARTS: POST http
+    ...    LOG 2:6  DEBUG STARTS: http
+    ...    LOG 2:7  DEBUG         Finished Request
+    ...    LOG 2:8  INFO          Temporally setting log level to: NONE
+    ...    LOG 2:9  INFO          Log level changed from NONE to DEBUG.
+    ...    LOG 2:10 NONE
+    ...    LOG 3:1  INFO          Typing text 'username' into text field 'username_field'.
+    Input Password    password_field    password
+    Input Text        username_field    username
+
 Input Text and Input Password No Clear
     [Setup]    Go To Page "forms/login.html"
     Input Text        username_field    user    clear=False
diff --git a/src/SeleniumLibrary/keywords/formelement.py b/src/SeleniumLibrary/keywords/formelement.py
@@ -16,6 +16,8 @@
 
 import os
 
+from robot.libraries.BuiltIn import BuiltIn
+
 from SeleniumLibrary.base import LibraryComponent, keyword
 from SeleniumLibrary.errors import ElementNotFound
 from SeleniumLibrary.utils import is_noney, is_truthy
@@ -231,16 +233,15 @@ def input_password(self, locator, password, clear=True):
 
         | Input Password | password_field | ${PASSWORD} |
 
-        Notice also that SeleniumLibrary logs all the communication with
-        browser drivers using the DEBUG level, and the actual password can
-        be seen there. Additionally, Robot Framework logs all arguments using
-        the TRACE level. Tests must thus not be executed using level below
-        INFO if the password should not be logged in any format.
+        Please notice that Robot Framework logs all arguments using
+        the TRACE level and tests must not be executed using level below
+        DEBUG if the password should not be logged in any format.
 
-        The `clear` argument is new in SeleniumLibrary 4.0
+        The `clear` argument is new in SeleniumLibrary 4.0. Hiding password
+        logging from Selenium logs is new in SeleniumLibrary 4.2.
         """
         self.info("Typing password into text field '%s'." % locator)
-        self._input_text_into_text_field(locator, password, clear)
+        self._input_text_into_text_field(locator, password, clear, True)
 
     @keyword
     def input_text(self, locator, text, clear=True):
@@ -266,7 +267,7 @@ def input_text(self, locator, text, clear=True):
         argument are new in SeleniumLibrary 4.0
         """
         self.info("Typing text '%s' into text field '%s'." % (text, locator))
-        self._input_text_into_text_field(locator, text, clear)
+        self._input_text_into_text_field(locator, text, clear, False)
 
     @keyword
     def page_should_contain_textfield(self, locator, message=None, loglevel='TRACE'):
@@ -421,8 +422,15 @@ def _get_value_from_radio_buttons(self, elements):
                 return element.get_attribute('value')
         return None
 
-    def _input_text_into_text_field(self, locator, text, clear):
+    def _input_text_into_text_field(self, locator, text, clear, disable_log):
         element = self.find_element(locator)
         if is_truthy(clear):
             element.clear()
-        element.send_keys(text)
+        if disable_log:
+            self.info('Temporally setting log level to: NONE')
+            previous_level = BuiltIn().set_log_level('NONE')
+        try:
+            element.send_keys(text)
+        finally:
+            if disable_log:
+                BuiltIn().set_log_level(previous_level)
