/
GrapheneConfiguration.java
218 lines (190 loc) · 6.9 KB
/
GrapheneConfiguration.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
/**
* JBoss, Home of Professional Open Source
* Copyright 2013, Red Hat, Inc. and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.arquillian.graphene.spi.configuration;
import java.lang.annotation.Annotation;
import java.net.MalformedURLException;
import java.net.URL;
import org.jboss.arquillian.config.descriptor.api.ArquillianDescriptor;
import org.jboss.arquillian.drone.configuration.ConfigurationMapper;
import org.jboss.arquillian.drone.spi.DroneConfiguration;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.How;
/**
* <p>
* Graphene configuration can be defined in arquillian.xml or system properties.
* </p>
*
* <h4>System Properties</h4>
*
* <pre>
* -Darq.extension.webdriver.waitAjaxInterval=3
* </pre>
*
* <h4>arquillian.xml configuration</h4>
*
* <pre>
* <arquillian>
* <extension qualifier="graphene">
* <property name="waitAjaxInterval">3</property>
* </extension>
* </arquillian>
* </pre>
*
* @author <a href="mailto:jpapouse@redhat.com">Jan Papousek</a>
*/
public class GrapheneConfiguration implements DroneConfiguration<GrapheneConfiguration> {
private long waitAjaxInterval = 2;
private long waitGuiInterval = 1;
private long waitModelInterval = 5;
private long waitGuardInterval = waitAjaxInterval;
private long javascriptInstallationLimit = 5;
private String defaultElementLocatingStrategy = How.ID_OR_NAME.toString().toLowerCase();
private String scheme = null;
private String url = null;
/**
* Specifies default location strategy when no parameter is given to {@link FindBy} annotated injection point.
*/
public How getDefaultElementLocatingStrategy() {
return How.valueOf(defaultElementLocatingStrategy.toUpperCase());
}
/**
* Get a default internal for waiting for AJAX operations.
*/
public long getWaitAjaxInterval() {
return waitAjaxInterval;
}
/**
* Get a default internal for waiting for Request Guards
*/
public long getWaitGuardInterval() {
return waitGuardInterval;
}
/**
* Get a default internal for waiting for GUI operations.
*/
public long getWaitGuiInterval() {
return waitGuiInterval;
}
/**
* Get a default internal for waiting for time-consuming, typically server-side operations.
*/
public long getWaitModelInterval() {
return waitModelInterval;
}
/**
* How long should Graphene wait before it fails to install a JavaScript extension into a page.
*/
public long getJavascriptInstallationLimit() {
return javascriptInstallationLimit;
}
/**
* Default scheme to use for every Location annotation. Use FQCN of scheme to use.
*/
public String getScheme() {
return scheme;
}
/**
* default url when container would inject null value to ArquillianResource otherwise
*/
public String getUrl() {
return url;
}
/**
* Validates that configuration is correct
*/
public void validate() {
if (waitAjaxInterval <= 0) {
throw new IllegalArgumentException("The waitAjaxInterval property has to be a positive number.");
}
if (waitGuiInterval <= 0) {
throw new IllegalArgumentException("The waitGuiInterval property has to be a positive number.");
}
if (waitModelInterval <= 0) {
throw new IllegalArgumentException("The waitModelInterval property has to be a positive number.");
}
if (waitGuardInterval <= 0) {
throw new IllegalArgumentException("The waitGuardInterval property has to be a positive number.");
}
if (javascriptInstallationLimit <= 0) {
throw new IllegalArgumentException("The javascriptInstallationLimut property has to a positive number.");
}
if (scheme != null && scheme.isEmpty()) {
throw new IllegalArgumentException("The scheme property has to be a non-empty string.");
}
if (url != null && !canConstructURL(url)) {
throw new IllegalArgumentException("The custom url you provided is not valid url address: " + url);
}
try {
How.valueOf(defaultElementLocatingStrategy.toUpperCase());
} catch (IllegalArgumentException ex) {
String values = "";
for (How value : How.values()) {
values += value.toString().toLowerCase() + ", ";
}
throw new IllegalArgumentException("The defaultElementLocatingStrategy property has to be one of the: " + values
+ " and was: "
+ ((defaultElementLocatingStrategy.length() != 0) ? defaultElementLocatingStrategy : "empty"), ex);
}
}
/*
* (non-Javadoc)
*
* @see org.jboss.arquillian.drone.spi.DroneConfiguration#getConfigurationName()
*/
@Override
public String getConfigurationName() {
return "graphene";
}
/*
* (non-Javadoc)
*
* @see
* org.jboss.arquillian.drone.spi.DroneConfiguration#configure(org.jboss.arquillian.config.descriptor.api.ArquillianDescriptor
* , java.lang.Class)
*/
@Override
public GrapheneConfiguration configure(ArquillianDescriptor descriptor, Class<? extends Annotation> qualifier) {
return ConfigurationMapper.fromArquillianDescriptor(descriptor, this, qualifier);
}
/**
* Checks if {@code url} is a valid address.
*
* @param url
* @return true if {@code url} can be used as URL, false otherwise
*/
private boolean canConstructURL(String url) {
if (url == null || url.isEmpty()) {
return false;
}
boolean canConstruct;
try {
final URL currentUrl = new URL(url);
if (currentUrl.getProtocol() != null) {
this.scheme = currentUrl.getProtocol();
}
canConstruct = true;
} catch (MalformedURLException ex) {
canConstruct = false;
}
return canConstruct;
}
}