/
ByExtended.java
318 lines (282 loc) · 10.5 KB
/
ByExtended.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
/**
* Copyright (c) 2013, Persado Intellectual Property Limited. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the Persado Intellectual Property Limited nor the names
* of its contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*
*/
package com.persado.oss.quality.stevia.selenium.core.controllers.webdriverapi;
import java.lang.reflect.Method;
import java.util.List;
import java.util.regex.Pattern;
import org.openqa.selenium.By;
import org.openqa.selenium.InvalidElementStateException;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.SearchContext;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.internal.FindsByCssSelector;
import org.openqa.selenium.internal.FindsByXPath;
import org.openqa.selenium.remote.RemoteWebElement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.persado.oss.quality.stevia.selenium.core.SteviaContext;
import com.persado.oss.quality.stevia.selenium.core.controllers.WebDriverWebController;
public abstract class ByExtended extends By {
private static final Logger LOG = LoggerFactory.getLogger(ByExtended.class);
/**
* Finds elements via the driver's underlying W3 Selector engine. If the
* browser does not implement the Selector API, a best effort is made to
* emulate the API. In this case, we strive for at least CSS2 support, but
* offer no guarantees.
*/
public static By cssSelector(final String selector) {
if (selector == null)
throw new IllegalArgumentException(
"Cannot find elements when the selector is null");
return new ByCssSelectorExtended(selector);
}
/**
* @param xpathExpression The xpath to use
* @return a By which locates elements via XPath
*/
public static By xpath(final String xpathExpression) {
if (xpathExpression == null)
throw new IllegalArgumentException(
"Cannot find elements when the XPath expression is null.");
return new ByXPathExtended(xpathExpression);
}
public static class ByCssSelectorExtended extends ByCssSelector {
private String ownSelector;
public ByCssSelectorExtended(String selector) {
super(selector);
ownSelector = selector;
}
@Override
public WebElement findElement(SearchContext context) {
try {
if (context instanceof FindsByCssSelector) {
return ((FindsByCssSelector) context)
.findElementByCssSelector(ownSelector);
}
} catch (InvalidElementStateException e) {
return findElementBySizzleCss(context, ownSelector);
} catch (WebDriverException e) {
if (e.getMessage().startsWith(
"An invalid or illegal string was specified")) {
return findElementBySizzleCss(context, ownSelector);
}
throw e;
}
throw new WebDriverException("Driver does not support finding an element by selector: " + ownSelector);
}
@Override
public List<WebElement> findElements(SearchContext context) {
try {
if (context instanceof FindsByCssSelector) {
return ((FindsByCssSelector) context)
.findElementsByCssSelector(ownSelector);
}
} catch (InvalidElementStateException e) {
return findElementsBySizzleCss(context, ownSelector);
} catch (WebDriverException e) {
if (e.getMessage().startsWith(
"An invalid or illegal string was specified")) {
return findElementsBySizzleCss(context, ownSelector);
}
throw e;
}
throw new WebDriverException("Driver does not support finding an element by selector: " + ownSelector);
}
@Override
public String toString() {
return "ByExtended.selector: " + ownSelector;
}
/********************************* SIZZLE SUPPORT CODE**************************************/
/**
* Find element by sizzle css.
* @param context
*
* @param cssLocator
* the cssLocator
* @return the web element
*/
@SuppressWarnings("unchecked")
public WebElement findElementBySizzleCss(SearchContext context, String cssLocator) {
List<WebElement> elements = findElementsBySizzleCss(context, cssLocator);
if (elements != null && elements.size() > 0 ) {
return elements.get(0);
}
return null;
}
private void fixLocator(SearchContext context, String cssLocator,
WebElement element) {
if (element instanceof RemoteWebElement) {
try {
Class[] parameterTypes = new Class[] { SearchContext.class,
String.class, String.class };
Method m = element.getClass().getDeclaredMethod(
"setFoundBy", parameterTypes);
m.setAccessible(true);
Object[] parameters = new Object[] { context,
"css selector", cssLocator };
m.invoke(element, parameters);
} catch (Exception fail) {
//NOOP Would like to log here?
}
}
}
private WebDriver getDriver() {
WebDriverWebController controller = ((WebDriverWebController) SteviaContext.getWebController());
return controller.getDriver();
}
/**
* Find elements by sizzle css.
*
* @param cssLocator
* the cssLocator
* @return the list of the web elements that match this locator
*/
@SuppressWarnings("unchecked")
public List<WebElement> findElementsBySizzleCss(SearchContext context, String cssLocator) {
injectSizzleIfNeeded();
String javascriptExpression = createSizzleSelectorExpression(cssLocator);
List<WebElement> elements = (List<WebElement>) ((JavascriptExecutor) getDriver())
.executeScript(javascriptExpression);
if (elements.size() > 0) {
for (WebElement el : elements) {
fixLocator(context, cssLocator, el);
}
}
return elements;
}
/**
* Creates the sizzle selector expression.
*
* @param cssLocator
* the cssLocator
* @return string that represents the sizzle selector expression.
*/
private String createSizzleSelectorExpression(String cssLocator) {
return "return Sizzle(\"" + cssLocator + "\")";
}
/**
* Inject sizzle if needed.
*/
private void injectSizzleIfNeeded() {
if (!sizzleLoaded())
injectSizzle();
}
/**
* Check if the Sizzle library is loaded.
*
* @return the true if Sizzle is loaded in the web page
*/
public Boolean sizzleLoaded() {
Boolean loaded;
try {
loaded = (Boolean) ((JavascriptExecutor) getDriver())
.executeScript("return Sizzle()!=null");
} catch (WebDriverException e) {
loaded = false;
}
return loaded;
}
/**
* Inject sizzle 1.8.2
*/
public void injectSizzle() {
((JavascriptExecutor) getDriver())
.executeScript(" var headID = document.getElementsByTagName(\"head\")[0];"
+ "var newScript = document.createElement('script');"
+ "newScript.type = 'text/javascript';"
+ "newScript.src = 'https://raw.github.com/jquery/sizzle/1.8.2/sizzle.js';"
+ "headID.appendChild(newScript);");
}
/**
* ******************** SIZZLE SUPPORT CODE
*/
}
public static class ByXPathExtended extends ByXPath {
private final String ownXpathExpression;
public ByXPathExtended(String xpathExpression) {
super(xpathExpression);
ownXpathExpression = xpathExpression;
}
@Override
public List<WebElement> findElements(SearchContext context) {
long t0 = System.currentTimeMillis();
try {
return ((FindsByXPath) context)
.findElementsByXPath(ownXpathExpression);
} finally {
long l = System.currentTimeMillis()-t0;
if (l > 100) {
LOG.warn("SLOW findElements() = {}ms. Slow selector : {} ", l, ownXpathExpression);
}
}
}
@Override
public WebElement findElement(SearchContext context) {
long t0 = System.currentTimeMillis();
try {
int indexOf = ownXpathExpression.indexOf("//", 3);
if (indexOf > -1) { // we found an // inside the selector
String[] splitSelectors = ownXpathExpression.substring(2).split(Pattern.quote("//"));
WebElement parent = ((FindsByXPath) context).findElementByXPath("//"+splitSelectors[0]);
for (int i = 1; i < splitSelectors.length; i++) {
if (parent == null) {
throw new WebDriverException("Failed to match the parent selector : "+splitSelectors[i-1]);
}
WebElement found = parent.findElement(By.xpath(".//"+splitSelectors[i]));
if (found != null) {
parent = found;
} else {
throw new WebDriverException("Failed to match the selector : "+splitSelectors[i]+" within "+ownXpathExpression);
}
}
// by here, we should have the parent WebElement to contain what we want.
//LOG.info("Found compount selector : "+parent.toString());
return parent;
}
// simple case: one selector
return ((FindsByXPath) context).findElementByXPath(ownXpathExpression);
} finally {
long l = System.currentTimeMillis()-t0;
if (l > 100) {
LOG.warn("SLOW findElement() = {}ms. Slow selector : {} ", l, ownXpathExpression);
}
}
}
@Override
public String toString() {
return "ByExtended.xpath: " + ownXpathExpression;
}
}
}