Skip to content

Commit 1b5b8f1

Browse files
aaltataaltat
committed
Release notes for 4.0.0a1
1 parent 6e02b5e commit 1b5b8f1

File tree

1 file changed

+266
-0
lines changed

1 file changed

+266
-0
lines changed

‎docs/SeleniumLibrary-4.0.0a1.rst‎

Lines changed: 266 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,266 @@
1+
=======================
2+
SeleniumLibrary 4.0.0a1
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.0.0a1 is a new release with
11+
new plugin API and support for Selenium EventFiringWebdriver.There are also
12+
other enhancements and bug fixes.
13+
14+
All issues targeted for SeleniumLibrary v4.0.0 can be found
15+
from the `issue tracker`_.
16+
17+
If you have pip_ installed, just run
18+
19+
::
20+
21+
pip install --pre --upgrade robotframework-seleniumlibrary
22+
23+
to install the latest available release or use
24+
25+
::
26+
27+
pip install robotframework-seleniumlibrary==4.0.0a1
28+
29+
to install exactly this version. Alternatively you can download the source
30+
distribution from PyPI_ and install it manually.
31+
32+
SeleniumLibrary 4.0.0a1 was released on Thursday April 18, 2019. SeleniumLibrary supports
33+
Python 2.7 and 3.4+, Selenium 3.8.2 and
34+
Robot Framework 3.0.4 and 3.1.1.
35+
36+
.. _Robot Framework: http://robotframework.org
37+
.. _SeleniumLibrary: https://github.com/robotframework/SeleniumLibrary
38+
.. _Selenium: http://seleniumhq.org
39+
.. _pip: http://pip-installer.org
40+
.. _PyPI: https://pypi.python.org/pypi/robotframework-seleniumlibrary
41+
.. _issue tracker: https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av4.0.0
42+
43+
44+
.. contents::
45+
:depth: 2
46+
:local:
47+
48+
Most important enhancements
49+
===========================
50+
51+
SeleniumLibrary by creating plugin API. (`#1292`_, alpha 1)
52+
------------------------------------------------------------
53+
SeleniumLibrary 4.0 introduces a plugin API, which allows adding
54+
or modifying keywords directly in to the SeleniumLibrary. It also
55+
offers more wider access to the SeleniumLibrary internal methods.
56+
57+
More details can be found from the `plugin API`_ documentation.
58+
59+
60+
Selenium EventFiringWebdriver (`#1303`_, alpha 1)
61+
-------------------------------------------------
62+
SeleniumLibrary offers support for `Selenium EventFiringWebdriver`_ allowing
63+
users to import the EventFiringWebdriver class in to the SeleniumLibrary.
64+
More details can be found from the Selenium and SeleniumLibrary
65+
`EventFiringWebdriver documentation`_
66+
67+
Backwards incompatible changes
68+
==============================
69+
70+
Remove deprecated attributes of unofficial public API (`#1346`_, alpha 1)
71+
-------------------------------------------------------------------------
72+
The Selenium2Library 1.8 and older did not have public API, but
73+
it did have some methods which could be considered as part of a unofficial
74+
API. The SeleniumLibrary 3.0 created new public API and in the same time
75+
tried to keep as much as possible of the unofficial API in place. In
76+
same time with 3.0 release the old API was deprecated. The SeleniumLibrary
77+
4.0 removes the unofficial and deprecated API.
78+
79+
Drop Robot Framework 2.9 support in SeleniumLibrary. (`#1304`_, alpha 1)
80+
------------------------------------------------------------------------
81+
SeleniumLibrary does not anymore support Robot Framework 2.9 or older
82+
releases. Users are encouraged to migrate Robot Framework 3.0 or 3.1.
83+
84+
Raise minimum supported Selenium version to 3.8.1 (`#1305`_, alpha 1)
85+
---------------------------------------------------------------------
86+
Minimum supported Selenium version has been raised to 3.8.1.
87+
88+
Remove keywords which where officially deprecated in previos releases. (`#1274`_, alpha 1)
89+
------------------------------------------------------------------------------------------
90+
SeleniumLibrary has removed keyword which where loudly deprecated in the previous releases.
91+
User are encouraged to use the new keywords.
92+
93+
Update SeleniumLibrary is_truthy and is_falsy to follow Robot Framework 3.1 (`#1308`_, alpha 1)
94+
------------------------------------------------------------------------------------------------
95+
In previous SeleniumLibrary releases, string 0 was considered as true when evaluating
96+
boolean type. This is now changed and string 0 is considered as false.
97+
98+
Deprecated features
99+
===================
100+
101+
Deprecate loudly all silently deprecated keywords (`#1273`_, alpha 1)
102+
----------------------------------------------------------------------
103+
All keywords which where silently deprecated in the previous release, will now
104+
cause a deprecated warning.
105+
106+
Deprecate sizzle selector strategy (`#1336`_, alpha 1)
107+
-------------------------------------------------------
108+
Sizzle selector is deprecated.
109+
110+
Acknowledgements
111+
================
112+
113+
Also there has been many contributions from the community. Special thanks
114+
to all that provided an contribution to the project. Here is a list of
115+
contributions which have made pull request in to this release.
116+
117+
I would like to remind that providing code or updating documentation is
118+
not the only way to contribute. There has been lot of issues raised in
119+
the project issue tracker and feedback has been provided in the
120+
user group and in slack. I am grateful from all the feedback.
121+
122+
Wait For Location To Contain (`#1108`_, alpha 1)
123+
-------------------------------------------------
124+
Many thanks to acaovilla who provided Wait Until Location Contains keyword in the
125+
RoboCon sprints.
126+
127+
Add Wait Until Location Is keyword (`#1297`_, alpha 1)
128+
------------------------------------------------------
129+
Many thanks to acaovilla who provided Wait Until Location Is keyword. Sometime after
130+
the RoboCon.
131+
132+
Allow setting and getting window.innerWidth and window.innerHeight CSS properties (`#1363`_, alpha 1)
133+
-----------------------------------------------------------------------------------------------------
134+
Many thanks to ciccioman3, who enhanced the Set Window Size and Get Window Size keywords
135+
to support window.innerWidth and window.innerHeight css attributes.
136+
137+
Update readme to mention https://github.com/Omenia/webdrivermanager (`#1301`_, alpha 1)
138+
---------------------------------------------------------------------------------------
139+
Many thanks to rasjani, who updated documentation to mention scripted browser driver
140+
installation.
141+
142+
Full list of fixes and enhancements
143+
===================================
144+
145+
.. list-table::
146+
:header-rows: 1
147+
148+
* - ID
149+
- Type
150+
- Priority
151+
- Summary
152+
- Added
153+
* - `#1292`_
154+
- enhancement
155+
- critical
156+
- Allow extending SeleniumLibrary by creating plugin API.
157+
- alpha 1
158+
* - `#1303`_
159+
- enhancement
160+
- critical
161+
- Add support event_firing_webdriver
162+
- alpha 1
163+
* - `#1304`_
164+
- enhancement
165+
- critical
166+
- Drop Robot Framework 2.9 support in SeleniumLibrary.
167+
- alpha 1
168+
* - `#1305`_
169+
- enhancement
170+
- critical
171+
- Raise minimum supported Selenium version to 3.8.1
172+
- alpha 1
173+
* - `#1284`_
174+
- bug
175+
- medium
176+
- Default Capabilities not set correctly if remote_url and desired_capabilities are given
177+
- alpha 1
178+
* - `#1307`_
179+
- bug
180+
- medium
181+
- Get Cookies keyword will fail if the Selenium get_cookie method return value contains more keys than: name, value, path, domain, secure, httpOnly and expiry
182+
- alpha 1
183+
* - `#1108`_
184+
- enhancement
185+
- medium
186+
- Propose new keyword: Wait For Location To Contain
187+
- alpha 1
188+
* - `#1273`_
189+
- enhancement
190+
- medium
191+
- Deprecate loudly all silently deprecated keywords
192+
- alpha 1
193+
* - `#1274`_
194+
- enhancement
195+
- medium
196+
- Remove keywords which where officially deprecated in previos releases.
197+
- alpha 1
198+
* - `#1297`_
199+
- enhancement
200+
- medium
201+
- Add Wait Until Location Is keyword
202+
- alpha 1
203+
* - `#1308`_
204+
- enhancement
205+
- medium
206+
- Update SeleniumLibrary is_truthy and is_falsy to follow Robot Framework 3.1
207+
- alpha 1
208+
* - `#1330`_
209+
- enhancement
210+
- medium
211+
- Input Text and Input Password keywords should be configurable if they clear the input element before keywords types the text in
212+
- alpha 1
213+
* - `#1336`_
214+
- enhancement
215+
- medium
216+
- Deprecate sizzle selector strategy
217+
- alpha 1
218+
* - `#1346`_
219+
- enhancement
220+
- medium
221+
- Remove deprecated attributes of public API
222+
- alpha 1
223+
* - `#1363`_
224+
- enhancement
225+
- medium
226+
- Allow setting and getting window.innerWidth and window.innerHeight CSS properties
227+
- alpha 1
228+
* - `#449`_
229+
- bug
230+
- low
231+
- Update documentation on Choose File to show that it supports remote uploading
232+
- alpha 1
233+
* - `#1279`_
234+
- enhancement
235+
- low
236+
- Webdriver tools browser_alias may not be needed
237+
- alpha 1
238+
* - `#1301`_
239+
- enhancement
240+
- low
241+
- Update readme to mention https://github.com/Omenia/webdrivermanager
242+
- alpha 1
243+
244+
Altogether 18 issues. View on the `issue tracker <https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av4.0.0>`__.
245+
246+
.. _#1292: https://github.com/robotframework/SeleniumLibrary/issues/1292
247+
.. _#1303: https://github.com/robotframework/SeleniumLibrary/issues/1303
248+
.. _#1304: https://github.com/robotframework/SeleniumLibrary/issues/1304
249+
.. _#1305: https://github.com/robotframework/SeleniumLibrary/issues/1305
250+
.. _#1284: https://github.com/robotframework/SeleniumLibrary/issues/1284
251+
.. _#1307: https://github.com/robotframework/SeleniumLibrary/issues/1307
252+
.. _#1108: https://github.com/robotframework/SeleniumLibrary/issues/1108
253+
.. _#1273: https://github.com/robotframework/SeleniumLibrary/issues/1273
254+
.. _#1274: https://github.com/robotframework/SeleniumLibrary/issues/1274
255+
.. _#1297: https://github.com/robotframework/SeleniumLibrary/issues/1297
256+
.. _#1308: https://github.com/robotframework/SeleniumLibrary/issues/1308
257+
.. _#1330: https://github.com/robotframework/SeleniumLibrary/issues/1330
258+
.. _#1336: https://github.com/robotframework/SeleniumLibrary/issues/1336
259+
.. _#1346: https://github.com/robotframework/SeleniumLibrary/issues/1346
260+
.. _#1363: https://github.com/robotframework/SeleniumLibrary/issues/1363
261+
.. _#449: https://github.com/robotframework/SeleniumLibrary/issues/449
262+
.. _#1279: https://github.com/robotframework/SeleniumLibrary/issues/1279
263+
.. _#1301: https://github.com/robotframework/SeleniumLibrary/issues/1301
264+
.. _plugin API: https://github.com/robotframework/SeleniumLibrary/blob/master/docs/extending/extending_seleniumlibrary.rst
265+
.. _EventFiringWebdriver documentation: https://github.com/robotframework/SeleniumLibrary/blob/master/docs/extending/extending_seleniumlibrary.rst
266+
.. _Selenium EventFiringWebdriver: https://seleniumhq.github.io/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.event_firing_webdriver.html

0 commit comments

Comments
 (0)