fix: update log_types documentation (Telefonica#202)

angel-ram · Dec 15, 2020 · fe468de · fe468de
1 parent 41aeab1
commit fe468de
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -8,6 +8,7 @@ v1.8.2
 
 - Add *get_driver_name* method to driver utils class
 - Add doc about how to configure Firefox device mode
+- Fix driver log types documentation
 
 v1.8.1
 ------
@@ -25,7 +26,7 @@ v1.8.0
 *Release date: 2020-10-05*
 
 - Allow lists in config properties instead of converting them to strings
-- Fix typo in documentation for configuration Server logs type
+- Fix typo in documentation for configuration Server log types
 - Include click action in InputText element
 - New config property 'automatic_context_selection' in [Driver] section for mobile tests with webview
 
@@ -39,7 +40,7 @@ v1.7.2
 
 - Move utils.py and path_utils.py files to utils folder maintaining backwards compatibility
 - Fix input text when element has a shadowroot and text contains quotation marks
-- New config property 'logs_types' in [Server] section to configure webdriver log types that should be downloaded
+- New config property 'log_types' in [Server] section to configure webdriver log types that should be downloaded
 
 v1.7.1
 ------

diff --git a/docs/remote_configuration.rst b/docs/remote_configuration.rst
@@ -65,7 +65,7 @@ log_types
 | Comma-separated list of webdriver log types that will be downloaded if remote test fails or if *logs_enabled* is true
 |
 | *all*: all available log types in remote server will be downloaded (default value)
-| '': setting an empty string, any log type will be downloaded
+| '': setting an empty string, no log types will be downloaded
 | *client,server*: in this example, only client and server logs will be downloaded
 
 

diff --git a/docs/tests_result_analysis.rst b/docs/tests_result_analysis.rst
@@ -69,6 +69,11 @@ in *[Server]* section in properties.cfg file ::
     [Server]
     log_types: client,server
 
+Notice that if using Chrome, log types can be enabled in *capabilities* section ::
+
+    [Capabilities]
+    goog___loggingPrefs: {'browser':'ALL', 'driver': 'ALL', 'performance': 'ALL'}
+
 In order to download webdriver logs even if the test passes, configure the property `logs_enabled <https://toolium.readthedocs.io/en/latest/remote_configuration.html#logs-enabled>`_
 in *[Server]* section in properties.cfg file ::