-
-
Notifications
You must be signed in to change notification settings - Fork 8k
/
EventFiringDecoratorTest.java
439 lines (362 loc) · 15.1 KB
/
EventFiringDecoratorTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package org.openqa.selenium.support.events;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.assertj.core.api.Assertions.assertThatNoException;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import static org.mockito.Mockito.withSettings;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Tag;
import org.openqa.selenium.Alert;
import org.openqa.selenium.By;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.ImmutableCapabilities;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.RemoteWebDriver;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.stream.Collectors;
import java.util.stream.Stream;
@Tag("UnitTests")
public class EventFiringDecoratorTest {
static class CollectorListener implements WebDriverListener {
protected final StringBuilder acc = new StringBuilder();
@Override
public void beforeAnyCall(Object target, Method method, Object[] args) {
acc.append("beforeAnyCall ").append(method.getName()).append("\n");
}
@Override
public void afterAnyCall(Object target, Method method, Object[] args, Object result) {
acc.append("afterAnyCall ").append(method.getName()).append("\n");
}
@Override
public void beforeAnyWebDriverCall(WebDriver driver, Method method, Object[] args) {
acc.append("beforeAnyWebDriverCall ").append(method.getName()).append("\n");
}
@Override
public void afterAnyWebDriverCall(WebDriver driver, Method method, Object[] args, Object result) {
acc.append("afterAnyWebDriverCall ").append(method.getName()).append("\n");
}
}
@Test
public void shouldFireWebDriverEvents() {
WebDriver driver = mock(WebDriver.class);
CollectorListener listener = new CollectorListener() {
@Override
public void beforeGet(WebDriver driver, String url) {
acc.append("beforeGet\n");
}
@Override
public void afterGet(WebDriver driver, String url) {
acc.append("afterGet\n");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
decorated.get("http://example.com/");
assertThat(listener.acc.toString().trim()).isEqualTo(
String.join("\n",
"beforeAnyCall get",
"beforeAnyWebDriverCall get",
"beforeGet",
"afterGet",
"afterAnyWebDriverCall get",
"afterAnyCall get"));
}
@Test
public void shouldFireWeElementEvents() {
WebDriver driver = mock(WebDriver.class);
WebElement element = mock(WebElement.class);
when(driver.findElement(any())).thenReturn(element);
CollectorListener listener = new CollectorListener() {
@Override
public void beforeFindElement(WebDriver driver, By locator) {
acc.append("beforeFindElement").append("\n");
}
@Override
public void afterFindElement(WebDriver driver, By locator, WebElement result) {
acc.append("afterFindElement").append("\n");
}
@Override
public void beforeAnyWebElementCall(WebElement element, Method method, Object[] args) {
acc.append("beforeAnyWebElementCall ").append(method.getName()).append("\n");
}
@Override
public void afterAnyWebElementCall(WebElement element, Method method, Object[] args,
Object result) {
acc.append("afterAnyWebElementCall ").append(method.getName()).append("\n");
}
@Override
public void beforeClick(WebElement element) {
acc.append("beforeClick").append("\n");
}
@Override
public void afterClick(WebElement element) {
acc.append("afterClick").append("\n");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
decorated.findElement(By.id("test")).click();
assertThat(listener.acc.toString().trim()).isEqualTo(
String.join("\n",
"beforeAnyCall findElement",
"beforeAnyWebDriverCall findElement",
"beforeFindElement",
"afterFindElement",
"afterAnyWebDriverCall findElement",
"afterAnyCall findElement",
"beforeAnyCall click",
"beforeAnyWebElementCall click",
"beforeClick",
"afterClick",
"afterAnyWebElementCall click",
"afterAnyCall click"));
}
@Test
public void shouldFireNavigationEvents() {
WebDriver driver = mock(WebDriver.class);
WebDriver.Navigation navigation = mock(WebDriver.Navigation.class);
when(driver.navigate()).thenReturn(navigation);
CollectorListener listener = new CollectorListener() {
@Override
public void beforeAnyNavigationCall(WebDriver.Navigation navigation, Method method, Object[] args) {
acc.append("beforeAnyNavigationCall ").append(method.getName()).append("\n");
}
@Override
public void afterAnyNavigationCall(WebDriver.Navigation navigation, Method method,
Object[] args, Object result) {
acc.append("afterAnyNavigationCall ").append(method.getName()).append("\n");
}
@Override
public void beforeBack(WebDriver.Navigation navigation) {
acc.append("beforeBack").append("\n");
}
@Override
public void afterBack(WebDriver.Navigation navigation) {
acc.append("afterBack").append("\n");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
decorated.navigate().back();
assertThat(listener.acc.toString().trim()).isEqualTo(
String.join("\n",
"beforeAnyCall navigate",
"beforeAnyWebDriverCall navigate",
"afterAnyWebDriverCall navigate",
"afterAnyCall navigate",
"beforeAnyCall back",
"beforeAnyNavigationCall back",
"beforeBack",
"afterBack",
"afterAnyNavigationCall back",
"afterAnyCall back"));
}
@Test
public void shouldFireAlertEvents() {
WebDriver driver = mock(WebDriver.class);
WebDriver.TargetLocator switchTo = mock(WebDriver.TargetLocator.class);
Alert alert = mock(Alert.class);
when(driver.switchTo()).thenReturn(switchTo);
when(switchTo.alert()).thenReturn(alert);
CollectorListener listener = new CollectorListener() {
@Override
public void beforeAnyAlertCall(Alert alert, Method method, Object[] args) {
acc.append("beforeAnyAlertCall ").append(method.getName()).append("\n");
}
@Override
public void afterAnyAlertCall(Alert alert, Method method, Object[] args, Object result) {
acc.append("afterAnyAlertCall ").append(method.getName()).append("\n");
}
@Override
public void beforeDismiss(Alert alert) {
acc.append("beforeDismiss").append("\n");
}
@Override
public void afterDismiss(Alert alert) {
acc.append("afterDismiss").append("\n");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
decorated.switchTo().alert().dismiss();
assertThat(listener.acc.toString().trim()).isEqualTo(
String.join("\n",
"beforeAnyCall switchTo",
"beforeAnyWebDriverCall switchTo",
"afterAnyWebDriverCall switchTo",
"afterAnyCall switchTo",
"beforeAnyCall alert",
"afterAnyCall alert",
"beforeAnyCall dismiss",
"beforeAnyAlertCall dismiss",
"beforeDismiss",
"afterDismiss",
"afterAnyAlertCall dismiss",
"afterAnyCall dismiss"));
}
@Test
public void shouldAllowToExecuteJavaScript() {
WebDriver driver = mock(WebDriver.class, withSettings()
.extraInterfaces(JavascriptExecutor.class));
when(((JavascriptExecutor) driver).executeScript("sum", "2", "2")).thenReturn("4");
CollectorListener listener = new CollectorListener() {
@Override
public void beforeExecuteScript(WebDriver driver, String script, Object[] args) {
acc.append(script).append("(");
acc.append(Stream.of(args).map(Object::toString).collect(Collectors.joining(", ")));
acc.append(")\n");
}
@Override
public void afterExecuteScript(WebDriver driver, String script, Object[] args, Object result) {
acc.append(script).append("(");
acc.append(Stream.of(args).map(Object::toString).collect(Collectors.joining(", ")));
acc.append(") = ").append(result).append("\n");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
((JavascriptExecutor) decorated).executeScript("sum", "2", "2");
assertThat(listener.acc.toString().trim()).isEqualTo(
String.join("\n",
"beforeAnyCall executeScript",
"beforeAnyWebDriverCall executeScript",
"sum(2, 2)",
"sum(2, 2) = 4",
"afterAnyWebDriverCall executeScript",
"afterAnyCall executeScript"));
}
@Test
public void shouldSuppressExceptionInBeforeAnyCall() {
WebDriver driver = mock(WebDriver.class);
WebDriverListener listener = new WebDriverListener() {
@Override
public void beforeAnyCall(Object target, Method method, Object[] args) {
throw new RuntimeException("listener");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
assertThatNoException().isThrownBy(decorated::getWindowHandle);
}
@Test
public void shouldSuppressExceptionInBeforeClassMethodCall() {
WebDriver driver = mock(WebDriver.class);
WebDriverListener listener = new WebDriverListener() {
@Override
public void beforeAnyWebDriverCall(WebDriver driver, Method method, Object[] args) {
throw new RuntimeException("listener");
}
};
WebDriver decorated = new EventFiringDecorator(listener).decorate(driver);
assertThatNoException().isThrownBy(decorated::getWindowHandle);
}
@Test
public void shouldSuppressExceptionInBeforeMethod() {
WebDriver driver = mock(WebDriver.class);
WebDriverListener listener = new WebDriverListener() {
@Override
public void beforeGetWindowHandle(WebDriver driver) {
throw new RuntimeException("listener");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
assertThatNoException().isThrownBy(decorated::getWindowHandle);
}
@Test
public void shouldSuppressExceptionInAfterAnyCall() {
WebDriver driver = mock(WebDriver.class);
WebDriverListener listener = new WebDriverListener() {
@Override
public void afterAnyCall(Object target, Method method, Object[] args, Object result) {
throw new RuntimeException("listener");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
assertThatNoException().isThrownBy(decorated::getWindowHandle);
}
@Test
public void shouldSuppressExceptionInAfterClassMethodCall() {
WebDriver driver = mock(WebDriver.class);
WebDriverListener listener = new WebDriverListener() {
@Override
public void afterAnyWebDriverCall(WebDriver driver, Method method, Object[] args,
Object result) {
throw new RuntimeException("listener");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
assertThatNoException().isThrownBy(decorated::getWindowHandle);
}
@Test
public void shouldSuppressExceptionInAfterMethod() {
WebDriver driver = mock(WebDriver.class);
WebDriverListener listener = new WebDriverListener() {
@Override
public void afterGetWindowHandle(WebDriver driver, String result) {
throw new RuntimeException("listener");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
assertThatNoException().isThrownBy(decorated::getWindowHandle);
}
@Test
public void shouldSuppressExceptionInOnError() {
WebDriver driver = mock(WebDriver.class);
when(driver.getWindowHandle()).thenThrow(new WebDriverException());
WebDriverListener listener = new WebDriverListener() {
@Override
public void onError(Object target, Method method, Object[] args, InvocationTargetException e) {
throw new RuntimeException("listener");
}
};
WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
assertThatExceptionOfType(WebDriverException.class)
.isThrownBy(decorated::getWindowHandle);
}
@Test
void shouldBeAbleToDecorateAChildClassOfWebDriver() {
RemoteWebDriver driver = mock(RemoteWebDriver.class);
when(driver.getCapabilities()).thenReturn(new ImmutableCapabilities("browserName", "firefox"));
WebDriverListener listener = new WebDriverListener() {
@Override
public void onError(Object target, Method method, Object[] args, InvocationTargetException e) {
throw new RuntimeException("listener");
}
};
RemoteWebDriver decorated =
new EventFiringDecorator<>(RemoteWebDriver.class, listener).decorate(driver);
Capabilities caps = decorated.getCapabilities();
assertThat(caps.getBrowserName()).isEqualTo("firefox");
}
@Test
void shouldBeAbleToCallDecoratedMethodForDecoratedChildClass() {
RemoteWebDriver driver = mock(RemoteWebDriver.class);
when(driver.getWindowHandle()).thenThrow(new WebDriverException());
WebDriverListener listener = new WebDriverListener() {
@Override
public void onError(Object target, Method method, Object[] args, InvocationTargetException e) {
throw new RuntimeException("listener");
}
};
RemoteWebDriver decorated =
new EventFiringDecorator<>(RemoteWebDriver.class, listener).decorate(driver);
assertThatExceptionOfType(WebDriverException.class)
.isThrownBy(decorated::getWindowHandle);
}
}