Skip to content

Commit 6b999ee

Browse files
aaltataaltat
committed
Release notes for 4.2.0
1 parent e409751 commit 6b999ee

File tree

1 file changed

+193
-0
lines changed

1 file changed

+193
-0
lines changed

‎docs/SeleniumLibrary-4.2.0.rst‎

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
=====================
2+
SeleniumLibrary 4.2.0
3+
=====================
4+
5+
6+
.. default-role:: code
7+
8+
9+
SeleniumLibrary_ is a web testing library for `Robot Framework`_ that utilizes
10+
the Selenium_ tool internally. SeleniumLibrary 4.2.0 is a new release with
11+
embedding screenshot to log.html and possibility add executable_path in the Open
12+
Browser keyword. Also the Open Browser options argument supports defining complex
13+
Python data object, like example dictionary. The most important fixes are in the
14+
Press Keys keyword and when EventFiringWebDriver is used with WebElements as
15+
locators.
16+
17+
All issues targeted for SeleniumLibrary v4.2.0 can be found
18+
from the `issue tracker`_.
19+
20+
If you have pip_ installed, just run
21+
22+
::
23+
24+
pip install --upgrade robotframework-seleniumlibrary
25+
26+
to install the latest available release or use
27+
28+
::
29+
30+
pip install robotframework-seleniumlibrary==4.2.0
31+
32+
to install exactly this version. Alternatively you can download the source
33+
distribution from PyPI_ and install it manually.
34+
35+
SeleniumLibrary 4.2.0 was released on Thursday January 30, 2020. SeleniumLibrary supports
36+
Python 2.7 and 3.5+, Selenium 3.141.0 and Robot Framework 3.1.2. This is last release which
37+
contains new development for Python 2.7 and users should migrate to Python 3.
38+
39+
.. _Robot Framework: http://robotframework.org
40+
.. _SeleniumLibrary: https://github.com/robotframework/SeleniumLibrary
41+
.. _Selenium: http://seleniumhq.org
42+
.. _pip: http://pip-installer.org
43+
.. _PyPI: https://pypi.python.org/pypi/robotframework-seleniumlibrary
44+
.. _issue tracker: https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av4.2.0
45+
46+
47+
.. contents::
48+
:depth: 2
49+
:local:
50+
51+
Most important enhancements
52+
===========================
53+
54+
Fix Press Keys to support multiple key pressing (`#1489`_, rc 1)
55+
-----------------------------------------------------------------
56+
Fixes Press Keys keyword to send multiple keys with in single keyword. When multiple keys where send
57+
keyword did clear the previous keys from a input field. Now this issue is fixed.
58+
59+
When EventFiringWebDriver is enabled, elements from `Get WebElement(s)` keywords are not recoginized as instance of WebElement (`#1538`_, rc 1)
60+
------------------------------------------------------------------------------------------------------------------------------------------------
61+
When EventFiringWebDriver is enabled, WebElements could not be used as locators in keywords. This raised and exception.
62+
This problem is not fixed and using EventFiringWebDriver and WebElements as locators is possible.
63+
64+
Input Password keyword should also prevent password being visible from the Selenium logging (`#1454`_, rc 1)
65+
------------------------------------------------------------------------------------------------------------
66+
Input Password keyword suppress the Selenium logging and the password is not anymore visible in the log.html
67+
file. Please note that password is visible if Robot Framework logging reveals the variable content, usually
68+
with trace log level.
69+
70+
Open Browser keyword options argument does not support parsing complex structures. (`#1530`_, rc 1)
71+
---------------------------------------------------------------------------------------------------
72+
The options argument did not support dictionary objects or other complex Python object in the Open Browser
73+
keyword. Example dictionaries where used to enable mobile emulation in the Chrome browser. After this
74+
enhancement complex object are supported in the options argument.
75+
76+
Backwards incompatible changes
77+
==============================
78+
79+
Raise minimum required Selenium version to 3.141 to ease support for Selenium 4 (`#1493`_, rc 1)
80+
-----------------------------------------------------------------------------------------------
81+
The minimum required Selenium version is raised to 3.141. This allowed to cleanup SeleniumLibrary code base and
82+
to ease support for Selenium 4. Based on the Selenium 4 alpha releases, SeleniumLibrary should be fully
83+
compatible with Selenium 4.
84+
85+
86+
Drop Robot Framework 3.0.x support (`#1513`_, rc 1)
87+
---------------------------------------------------
88+
SeleniumLibrary supports Robot Framework 3.1.2 and older Robot Framework versions are not anymore supported. Older
89+
versions may work, but support is not given by this project. SeleniumLibrary should be also compatible with
90+
Robot Framework 3.2, this is based on the beta 1 release.
91+
92+
Acknowledgements
93+
================
94+
95+
When EventFiringWebDriver is enabled, elements from `Get WebElement(s)` keywords are not recoginized as instance of WebElement (`#1538`_, rc 1)
96+
-----------------------------------------------------------------------------------------------------------------------------------------------
97+
Many thanks for rasjani providing PR to fix EventFiringWebDriver and using WebElements as locators.
98+
99+
If JavaScript code is long then Execute JavaScrpt will fail in windows (`#1524`_, rc 1)
100+
---------------------------------------------------------------------------------------
101+
Many thanks to lmartorella improving of the Execute JavaScript keyword to work better
102+
in Windows OS.
103+
104+
'Handle Alert' keyword treats all exceptions as timeout (`#1500`_, rc 1)
105+
------------------------------------------------------------------------
106+
Many thanks to Zeckie improving error message in the Handle Alert keyword.
107+
108+
Close Browser does not delete alias (`#1416`_, rc 1)
109+
----------------------------------------------------
110+
Many thanks to anton264 improving closing browser functionality so that browser alias is deleted.
111+
112+
add ability of embedding screenshots as base64 encoded images in the ... (`#1497`_, rc 1)
113+
-----------------------------------------------------------------------------------------
114+
Many thanks to bitcoder for enabling embedding screenshot in to the log.html file.
115+
116+
Full list of fixes and enhancements
117+
===================================
118+
119+
.. list-table::
120+
:header-rows: 1
121+
122+
* - ID
123+
- Type
124+
- Priority
125+
- Summary
126+
* - `#1493`_
127+
- enhancement
128+
- critical
129+
- Raise minimum required Selenium version to 3.14 to ease support for Selenium 4
130+
* - `#1489`_
131+
- bug
132+
- high
133+
- Fix Press Keys to support multiple key pressing
134+
* - `#1538`_
135+
- bug
136+
- high
137+
- When EventFiringWebDriver is enabled, elements from `Get WebElement(s)` keywords are not recoginized as instance of WebElement
138+
* - `#1454`_
139+
- enhancement
140+
- high
141+
- Input Password keyword should also prevent password being visible from the Selenium logging
142+
* - `#1513`_
143+
- enhancement
144+
- high
145+
- Drop Robot Framework 3.0.x support
146+
* - `#1530`_
147+
- enhancement
148+
- high
149+
- Open Browser keyword options argument does not support parsing complex structures.
150+
* - `#1496`_
151+
- bug
152+
- medium
153+
- Fix Create WebDriver examples
154+
* - `#1524`_
155+
- bug
156+
- medium
157+
- If JavaScript code is long then Execute JavaScrpt will fail in windows
158+
* - `#1473`_
159+
- enhancement
160+
- medium
161+
- Open Browser keyword and Selenium options with Windows path needs double escaping
162+
* - `#1483`_
163+
- enhancement
164+
- medium
165+
- add support to embed screenshots in reports
166+
* - `#1500`_
167+
- enhancement
168+
- medium
169+
- 'Handle Alert' keyword treats all exceptions as timeout
170+
* - `#1536`_
171+
- enhancement
172+
- medium
173+
- Add possibility to configure executable_path in the Open Browser keywords
174+
* - `#1416`_
175+
- bug
176+
- low
177+
- Close Browser does not delete alias
178+
179+
Altogether 13 issues. View on the `issue tracker <https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av4.2.0>`__.
180+
181+
.. _#1493: https://github.com/robotframework/SeleniumLibrary/issues/1493
182+
.. _#1489: https://github.com/robotframework/SeleniumLibrary/issues/1489
183+
.. _#1538: https://github.com/robotframework/SeleniumLibrary/issues/1538
184+
.. _#1454: https://github.com/robotframework/SeleniumLibrary/issues/1454
185+
.. _#1513: https://github.com/robotframework/SeleniumLibrary/issues/1513
186+
.. _#1530: https://github.com/robotframework/SeleniumLibrary/issues/1530
187+
.. _#1496: https://github.com/robotframework/SeleniumLibrary/issues/1496
188+
.. _#1524: https://github.com/robotframework/SeleniumLibrary/issues/1524
189+
.. _#1473: https://github.com/robotframework/SeleniumLibrary/issues/1473
190+
.. _#1483: https://github.com/robotframework/SeleniumLibrary/issues/1483
191+
.. _#1500: https://github.com/robotframework/SeleniumLibrary/issues/1500
192+
.. _#1536: https://github.com/robotframework/SeleniumLibrary/issues/1536
193+
.. _#1416: https://github.com/robotframework/SeleniumLibrary/issues/1416

0 commit comments

Comments
 (0)