php-webdriver/WebDriverBase.php at master · troelskn/php-webdriver · GitHub

History

299 lines (268 loc) · 9.45 KB

Raw

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

<?php

// Licensed 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.

abstract class WebDriverBase {

public static function throwException($status_code, $message, $results) {

switch ($status_code) {

case 0:

// Success

break;

case 1:

throw new IndexOutOfBoundsWebDriverError($message, $results);

case 2:

throw new NoCollectionWebDriverError($message, $results);

case 3:

throw new NoStringWebDriverError($message, $results);

case 4:

throw new NoStringLengthWebDriverError($message, $results);

case 5:

throw new NoStringWrapperWebDriverError($message, $results);

case 6:

throw new NoSuchDriverWebDriverError($message, $results);

case 7:

throw new NoSuchElementWebDriverError($message, $results);

case 8:

throw new NoSuchFrameWebDriverError($message, $results);

case 9:

throw new UnknownCommandWebDriverError($message, $results);

case 10:

throw new ObsoleteElementWebDriverError($message, $results);

case 11:

throw new ElementNotDisplayedWebDriverError($message, $results);

case 12:

throw new InvalidElementStateWebDriverError($message, $results);

case 13:

throw new UnhandledWebDriverError($message, $results);

case 14:

throw new ExpectedWebDriverError($message, $results);

case 15:

throw new ElementNotSelectableWebDriverError($message, $results);

case 16:

throw new NoSuchDocumentWebDriverError($message, $results);

case 17:

throw new UnexpectedJavascriptWebDriverError($message, $results);

case 18:

throw new NoScriptResultWebDriverError($message, $results);

case 19:

throw new XPathLookupWebDriverError($message, $results);

case 20:

throw new NoSuchCollectionWebDriverError($message, $results);

case 21:

throw new TimeOutWebDriverError($message, $results);

case 22:

throw new NullPointerWebDriverError($message, $results);

case 23:

throw new NoSuchWindowWebDriverError($message, $results);

case 24:

throw new InvalidCookieDomainWebDriverError($message, $results);

case 25:

throw new UnableToSetCookieWebDriverError($message, $results);

case 26:

throw new UnexpectedAlertOpenWebDriverError($message, $results);

case 27:

throw new NoAlertOpenWebDriverError($message, $results);

case 28:

throw new ScriptTimeoutWebDriverError($message, $results);

case 29:

throw new InvalidElementCoordinatesWebDriverError($message, $results);

case 30:

throw new IMENotAvailableWebDriverError($message, $results);

case 31:

throw new IMEEngineActivationFailedWebDriverError($message, $results);

case 32:

throw new InvalidSelectorWebDriverError($message, $results);

}

abstract protected function methods();

protected $url;

public function __construct($url = 'http://localhost:4444/wd/hub') {

$this->url = $url;

}

public function __toString() {

return $this->url;

}

public function getURL() {

return $this->url;

}

/**

* Curl request to webdriver server.

* $http_method 'GET', 'POST', or 'DELETE'

* $command If not defined in methods() this function will throw.

* $params If an array(), they will be posted as JSON parameters

* If a number or string, "/$params" is appended to url

* $extra_opts key=>value pairs of curl options to pass to curl_setopt()

protected function curl(

$http_method,

$command,

$params = null,

$extra_opts = array()) {

if ($params && is_array($params) && $http_method !== 'POST') {

throw new Exception(sprintf(

'The http method called for %s is %s but it has to be POST' .

' if you want to pass the JSON params %s',

$command,

$http_method,

json_encode($params)));

}

$url = sprintf('%s%s', $this->url, $command);

if ($params && (is_int($params) || is_string($params))) {

$url .= '/' . $params;

}

$curl = curl_init($url);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

curl_setopt(

$curl,

CURLOPT_HTTPHEADER,

array(

'Content-Type: application/json;charset=UTF-8',

'Accept: application/json'));

if ($http_method === 'POST') {

curl_setopt($curl, CURLOPT_POST, true);

if ($params && is_array($params)) {

curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($params));

}

} else if ($http_method == 'DELETE') {

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');

}

foreach ($extra_opts as $option => $value) {

curl_setopt($curl, $option, $value);

}

$raw_results = trim(WebDriverEnvironment::CurlExec($curl));

$info = curl_getinfo($curl);

if ($error = curl_error($curl)) {

$msg = sprintf(

'Curl error thrown for http %s to %s',

$http_method,

$url);

if ($params && is_array($params)) {

$msg .= sprintf(' with params: %s', json_encode($params));

}

throw new WebDriverCurlException($msg . "\n\n" . $error);

}

curl_close($curl);

$results = json_decode($raw_results, true);

$value = null;

if (is_array($results) && array_key_exists('value', $results)) {

$value = $results['value'];

}

$message = null;

if (is_array($value) && array_key_exists('message', $value)) {

$message = $value['message'];

}

self::throwException($results['status'], $message, $results);

return array('value' => $value, 'info' => $info);

}

public function __call($name, $arguments) {

if (count($arguments) > 1) {

throw new Exception(

'Commands should have at most only one parameter,' .

' which should be the JSON Parameter object');

}

if (preg_match('/^(get|post|delete)/', $name, $matches)) {

$http_method = strtoupper($matches[0]);

$webdriver_command = strtolower(substr($name, strlen($http_method)));

$default_http_method = $this->getHTTPMethod($webdriver_command);

if ($http_method === $default_http_method) {

throw new Exception(sprintf(

'%s is the default http method for %s. Please just call %s().',

$http_method,

$webdriver_command,

$webdriver_command));

}

$methods = $this->methods();

if (!in_array($http_method, $methods[$webdriver_command])) {

throw new Exception(sprintf(

'%s is not an available http method for the command %s.',

$http_method,

$webdriver_command));

}

} else {

$webdriver_command = $name;

$http_method = $this->getHTTPMethod($webdriver_command);

}

$results = $this->curl(

$http_method,

'/' . $webdriver_command,

array_shift($arguments));

return $results['value'];

}

private function getHTTPMethod($webdriver_command) {

if (!array_key_exists($webdriver_command, $this->methods())) {

throw new Exception(sprintf(

'%s is not a valid webdriver command.',

$webdriver_command));

}

$methods = $this->methods();

$http_methods = (array) $methods[$webdriver_command];

return array_shift($http_methods);

}

function find($selector) {

$all = $this->findAll($selector);

if (count($all) > 1) {

throw new Exception("Selector returned more than one result");

}

return empty($all) ? null : $all[0];

}

function findAll($selector) {

try {

return $this->elements('xpath', $selector);

} catch (NoSuchElementWebDriverError $ex) {

return array();

}

function findVisible($selector) {

$all = $this->findAllVisible($selector);

if (count($all) > 1) {

throw new Exception("Selector returned more than one result");

}

return empty($all) ? null : $all[0];

}

function findAllVisible($selector) {

$result = array();

foreach ($this->findAll($selector) as $element) {

if ($element->displayed()) {

$result[] = $element;

}

return $result;

}

function waitForElementPresent($selector, $timeout = 30) {

while ($timeout) {

try {

$el = $this->find($selector);

} catch (ElementNotDisplayedWebDriverError $ex) { /* squelch */ }

if ($el && $el->displayed()) {

usleep(100000); // .1s -> We wait because for some animations, the element might have a brief initial state of being visible, before it starts the transitioning. This pause makes the code more robust to that kind of cases.

if ($el && $el->displayed()) {

return $el;

}

sleep(1);

$timeout--;

}

throw new WaitForElementTimeOutWebDriverError("Element not found while waiting");

}

function setValue($text) {

if ($text === "" || $text === null) {

$this->clear();

} else {

$this->value(array('value' => str_split($text)));

}

function getValue() {

return $this->attribute('value');

}

php-webdriver/WebDriverBase.php at master · troelskn/php-webdriver · GitHub

Expand file tree

Breadcrumbs

WebDriverBase.php

Latest commit

History

Breadcrumbs

WebDriverBase.php

File metadata and controls