Openbuildings\Spiderling\Driver_Selenium_Connection

Complexity

Total Complexity

20

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

61.02%

Importance

Changes	6
Bugs	1	Features	3

10 Methods

Rating	Name	Duplication	Size	Complexity
A	is_started()	0	4	1
A	server()	0	9	2
A	__construct()	0	7	2
A	start()	0	9	2
A	reuse_session()	0	20	3
A	new_session()	0	10	2
A	get()	0	4	1
A	post()	0	11	2
A	delete()	0	7	1
B	call()	0	32	4

<?php

namespace Openbuildings\Spiderling;

/**
 * Connect to selenium service.
 * Send requests to selenium
 *
 * @package    Openbuildings\Spiderling
 * @author     Ivan Kerin
 * @copyright  (c) 2013 OpenBuildings Ltd.
 * @license    http://spdx.org/licenses/BSD-3-Clause
 */
class Driver_Selenium_Connection
{
	/**
	 * The current selenium session id
	 * @var string
	 */
	protected $_session_id;

	/**
	 * The selenium server url
	 * @var string
	 */
	protected $_server = 'http://localhost:4444/wd/hub/';

	public function server($server = NULL)
	{
		if ($server !== NULL)
		{
			$this->_server = $server;
			return $this;
		}
		return $this->_server;
	}

	public function __construct($server = NULL)
	{
		if ($server)
		{
			$this->server($server);
		}
	}

	/**
	 * Start a new selenium session, based on passed desired capabilities.
	 * Reuses the session if possible
	 *
	 * @param  array $desiredCapabilities
	 */
	public function start(array $desiredCapabilities = NULL)
	{
		if ( ! ($this->_session_id = $this->reuse_session()))
		{
			$this->_session_id = $this->new_session($desiredCapabilities);

It seems like $this->new_session($desiredCapabilities) of type object<Openbuildings\Spiderling\new> is incompatible with the declared type string of property $_session_id.

		}

		$this->_server .= "session/{$this->_session_id}/";
	}

	/**
	 * Check if a session has been started
	 * @return boolean
	 */
	public function is_started()
	{
		return (bool) $this->_session_id;
	}

	/**
	 * Try to reuse an existing selenium session, return the reused id
	 * @return string
	 */
	public function reuse_session()
	{
		$sessions = $this->get('sessions');
		foreach ($sessions as $session)
		{
			$id = $session['id'];
			try
			{
				$this->get("session/$id/window_handle");
				return $id;
			}
			// @codeCoverageIgnoreStart
			// This cannot be tested because of selenium bug (can't close main window)
			catch (Exception_Selenium $exception)
			{
				$this->delete("session/$id");
			}
			// @codeCoverageIgnoreEnd
		}
	}

	/**
	 * Initiate a new session, based on the desired capabilities
	 * @param  array $desiredCapabilities
	 * @return new session
	 */
	public function new_session(array $desiredCapabilities = NULL)
	{
		if ( ! $desiredCapabilities)
		{
			$desiredCapabilities = array('browserName' => 'firefox');
		}

		$session = $this->post('session', array('desiredCapabilities' => $desiredCapabilities));
		return $session['webdriver.remote.sessionid'];
	}

	/**
	 * Perform a get request to the selenium server
	 * @param  string $command
	 * @return mixed
	 */
	public function get($command)
	{
		return $this->call($command);
	}

	/**
	 * Perform a post request to the selenium server
	 * @param  string $command
	 * @param  array  $params
	 * @return mixed
	 */
	public function post($command, array $params)
	{
		$options = array();
		$options[CURLOPT_POST] = TRUE;

		if ($params) {

The expression $params of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

			$options[CURLOPT_POSTFIELDS] = json_encode($params);
		}

		return $this->call($command, $options);
	}

	/**
	 * Perform a delete request to the selenium server
	 * @param  string $command
	 * @return mixed
	 */
	public function delete($command)
	{
		$options = array();
		$options[CURLOPT_CUSTOMREQUEST] = 'DELETE';

		return $this->call($command, $options);
	}

	/**
	 * Perform a request to the selenium server, using curl
	 * @param  string $command
	 * @param  array  $options curl options
	 * @return mixed
	 */
	public function call($command, array $options = array())
	{
		$curl = curl_init();
		$options[CURLOPT_URL] = $this->server().$command;
		$options[CURLOPT_RETURNTRANSFER] = TRUE;
		$options[CURLOPT_FOLLOWLOCATION] = TRUE;
		$options[CURLOPT_HTTPHEADER] = array(
			'Content-Type: application/json;charset=UTF-8',
			'Accept: application/json',
		);

		curl_setopt_array($curl, $options);

		$raw = trim(curl_exec($curl));

		$result = json_decode($raw, TRUE);

		$error = curl_error($curl);

		curl_close($curl);

		if ($error)
			throw new Exception_Driver('Curl ":command" throws exception :error', array(':command' => $command, ':error' => $error));

		if ($result['status'] == 10)
			throw new Exception_Staleelement();

		if ($result['status'] != 0)
			throw new Exception_Selenium($result['status']);

		return $result['value'];
	}
}