ApiBrowserConfiguration::onTestEnded() - Code Metrics - Inspection of "Preparing 2.2.0 release" - minkphp/phpunit-mink - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 420f16...68b944 )

by Alexander

created 2016-06-26 09:07 UTC

ApiBrowserConfiguration::onTestEnded() B

↳ Parent: ApiBrowserConfiguration

Complexity

Conditions	4
Paths	3

Size

Total Lines	22
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	4

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	22
ccs	13
cts	13
cp	1
rs	8.9197
cc	4
eloc	11
nc	3
nop	1
crap	4

<?php
/**
 * This file is part of the phpunit-mink library.
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * @copyright Alexander Obuhovich <[email protected]>
 * @link      https://github.com/aik099/phpunit-mink
 */

namespace aik099\PHPUnit\BrowserConfiguration;


use aik099\PHPUnit\APIClient\IAPIClient;
use aik099\PHPUnit\BrowserTestCase;
use aik099\PHPUnit\Event\TestEndedEvent;
use aik099\PHPUnit\Event\TestEvent;
use aik099\PHPUnit\MinkDriver\DriverFactoryRegistry;
use Behat\Mink\Driver\Selenium2Driver;
use Behat\Mink\Session;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

/**
 * Browser configuration tailored to use with API-based service.
 *
 * @method string getApiUsername() Returns API username.
 * @method string getApiKey() Returns API key.
 */
abstract class ApiBrowserConfiguration extends BrowserConfiguration
{

	/**
	 * The build number.
	 */
	const BUILD_NUMBER_CAPABILITY = 'build';

	/**
	 * The test name.
	 */
	const NAME_CAPABILITY = 'name';

	/**
	 * Creates browser configuration.
	 *
	 * @param EventDispatcherInterface $event_dispatcher        Event dispatcher.
	 * @param DriverFactoryRegistry    $driver_factory_registry Driver factory registry.
	 */
	public function __construct(
		EventDispatcherInterface $event_dispatcher,
		DriverFactoryRegistry $driver_factory_registry
	) {
		$this->defaults['driver'] = 'selenium2';
		$this->defaults['apiUsername'] = '';
		$this->defaults['apiKey'] = '';

		parent::__construct($event_dispatcher, $driver_factory_registry);
	}

	/**
	 * Sets API username.
	 *
	 * To be called from TestCase::setUp().
	 *
	 * @param string $api_username API username.
	 *
	 * @return self
	 */
	public function setApiUsername($api_username)
	{
		return $this->setParameter('apiUsername', $api_username);
	}

	/**
	 * Sets API key.
	 *
	 * To be called from TestCase::setUp().
	 *
	 * @param string $api_key API key.
	 *
	 * @return self
	 */
	public function setApiKey($api_key)
	{
		return $this->setParameter('apiKey', $api_key);
	}

	/**
	 * Sets API username.
	 *
	 * Used internally to to allow using "api_username" parameter and avoid BC break.
	 *
	 * @param string $api_username API username.
	 *
	 * @return     self
	 * @deprecated
	 */
	protected function setApi_username($api_username)
	{
		return $this->setApiUsername($api_username);
	}

	/**
	 * Sets API key.
	 *
	 * Used internally to to allow using "api_key" parameter and avoid BC break.
	 *
	 * @param string $api_key API key.
	 *
	 * @return     self
	 * @deprecated
	 */
	protected function setApi_key($api_key)
	{
		return $this->setApiKey($api_key);
	}

	/**
	 * Returns port from browser configuration.
	 *
	 * @return integer
	 */
	public function getPort()
	{
		return 80;
	}

	/**
	 * Returns browser name from browser configuration.
	 *
	 * @return string
	 */
	public function getBrowserName()
	{
		$browser_name = parent::getBrowserName();

		return strlen($browser_name) ? $browser_name : 'chrome';
	}

	/**
	 * Hook, called from "BrowserTestCase::setUp" method.
	 *
	 * @param TestEvent $event Test event.
	 *
	 * @return void
	 */
	public function onTestSetup(TestEvent $event)
	{
		if ( !$event->validateSubscriber($this->getTestCase()) ) {
			return;
		}

		parent::onTestSetup($event);

		$desired_capabilities = $this->getDesiredCapabilities();
		$desired_capabilities[self::NAME_CAPABILITY] = $this->getJobName($event->getTestCase());

		if ( getenv('BUILD_NUMBER') ) {
			$desired_capabilities[self::BUILD_NUMBER_CAPABILITY] = getenv('BUILD_NUMBER'); // Jenkins.
		}
		elseif ( getenv('TRAVIS_BUILD_NUMBER') ) {
			$desired_capabilities[self::BUILD_NUMBER_CAPABILITY] = getenv('TRAVIS_BUILD_NUMBER');
		}

		$this->setDesiredCapabilities($desired_capabilities);
	}

	/**
	 * Returns Job name for API service.
	 *
	 * @param BrowserTestCase $test_case Browser test case.
	 *
	 * @return string
	 */
	protected function getJobName(BrowserTestCase $test_case)
	{
		if ( $this->isShared() ) {
			return get_class($test_case);
		}

		return $test_case->toString();
	}

	/**
	 * Hook, called from "BrowserTestCase::run" method.
	 *
	 * @param TestEndedEvent $event Test ended event.
	 *
	 * @return void
	 */
	public function onTestEnded(TestEndedEvent $event)
	{
		if ( !$event->validateSubscriber($this->getTestCase()) ) {
			return;
		}

		parent::onTestEnded($event);

		$session = $event->getSession();

		if ( $session === null || !$session->isStarted() ) {
			// Session wasn't used in particular test.
			return;
		}

		$test_case = $event->getTestCase();

		$this->getAPIClient()->updateStatus(
			$this->getSessionId($session),
			$this->getTestStatus($test_case, $event->getTestResult())
		);
	}

	/**
	 * Returns API class for service interaction.
	 *
	 * @return IAPIClient
	 */
	public abstract function getAPIClient();

	/**
	 * Get Selenium2 current session id.
	 *
	 * @param Session $session Session.
	 *
	 * @return string
	 * @throws \RuntimeException When session was created using an unsupported driver.
	 */
	protected function getSessionId(Session $session)
	{
		$driver = $session->getDriver();

		if ( $driver instanceof Selenium2Driver ) {
			return $driver->getWebDriverSessionId();
		}

		throw new \RuntimeException('Unsupported session driver');
	}

}


1		<?php
2		/**
3		* This file is part of the phpunit-mink library.
4		* For the full copyright and license information, please view
5		* the LICENSE file that was distributed with this source code.
6		*
7		* @copyright Alexander Obuhovich <[email protected]>
8		* @link https://github.com/aik099/phpunit-mink
9		*/
10
11		namespace aik099\PHPUnit\BrowserConfiguration;
12
13
14		use aik099\PHPUnit\APIClient\IAPIClient;
15		use aik099\PHPUnit\BrowserTestCase;
16		use aik099\PHPUnit\Event\TestEndedEvent;
17		use aik099\PHPUnit\Event\TestEvent;
18		use aik099\PHPUnit\MinkDriver\DriverFactoryRegistry;
19		use Behat\Mink\Driver\Selenium2Driver;
20		use Behat\Mink\Session;
21		use Symfony\Component\EventDispatcher\EventDispatcherInterface;
22
23		/**
24		* Browser configuration tailored to use with API-based service.
25		*
26		* @method string getApiUsername() Returns API username.
27		* @method string getApiKey() Returns API key.
28		*/
29		abstract class ApiBrowserConfiguration extends BrowserConfiguration
30		{
31
32		/**
33		* The build number.
34		*/
35		const BUILD_NUMBER_CAPABILITY = 'build';
36
37		/**
38		* The test name.
39		*/
40		const NAME_CAPABILITY = 'name';
41
42		/**
43		* Creates browser configuration.
44		*
45		* @param EventDispatcherInterface $event_dispatcher Event dispatcher.
46		* @param DriverFactoryRegistry $driver_factory_registry Driver factory registry.
47		*/
48	113	public function __construct(
49		EventDispatcherInterface $event_dispatcher,
50		DriverFactoryRegistry $driver_factory_registry
51		) {
52	113	$this->defaults['driver'] = 'selenium2';
53	113	$this->defaults['apiUsername'] = '';
54	113	$this->defaults['apiKey'] = '';
55
56	113	parent::__construct($event_dispatcher, $driver_factory_registry);
57	113	}
58
59		/**
60		* Sets API username.
61		*
62		* To be called from TestCase::setUp().
63		*
64		* @param string $api_username API username.
65		*
66		* @return self
67		*/
68	15	public function setApiUsername($api_username)
69		{
70	15	return $this->setParameter('apiUsername', $api_username);
71		}
72
73		/**
74		* Sets API key.
75		*
76		* To be called from TestCase::setUp().
77		*
78		* @param string $api_key API key.
79		*
80		* @return self
81		*/
82	15	public function setApiKey($api_key)
83		{
84	15	return $this->setParameter('apiKey', $api_key);
85		}
86
87		/**
88		* Sets API username.
89		*
90		* Used internally to to allow using "api_username" parameter and avoid BC break.
91		*
92		* @param string $api_username API username.
93		*
94		* @return self
95		* @deprecated
96		*/
97		protected function setApi_username($api_username)
98		{
99		return $this->setApiUsername($api_username);
100		}
101
102		/**
103		* Sets API key.
104		*
105		* Used internally to to allow using "api_key" parameter and avoid BC break.
106		*
107		* @param string $api_key API key.
108		*
109		* @return self
110		* @deprecated
111		*/
112		protected function setApi_key($api_key)
113		{
114		return $this->setApiKey($api_key);
115		}
116
117		/**
118		* Returns port from browser configuration.
119		*
120		* @return integer
121		*/
122	18	public function getPort()
123		{
124	18	return 80;
125		}
126
127		/**
128		* Returns browser name from browser configuration.
129		*
130		* @return string
131		*/
132	18	public function getBrowserName()
133		{
134	18	$browser_name = parent::getBrowserName();
135
136	18	return strlen($browser_name) ? $browser_name : 'chrome';
137		}
138
139		/**
140		* Hook, called from "BrowserTestCase::setUp" method.
141		*
142		* @param TestEvent $event Test event.
143		*
144		* @return void
145		*/
146	24	public function onTestSetup(TestEvent $event)
147		{
148	24	if ( !$event->validateSubscriber($this->getTestCase()) ) {
149		return;
150		}
151
152	24	parent::onTestSetup($event);
153
154	24	$desired_capabilities = $this->getDesiredCapabilities();
155	24	$desired_capabilities[self::NAME_CAPABILITY] = $this->getJobName($event->getTestCase());
156
157	24	if ( getenv('BUILD_NUMBER') ) {
158	4	$desired_capabilities[self::BUILD_NUMBER_CAPABILITY] = getenv('BUILD_NUMBER'); // Jenkins.
159	4	}
160	20	elseif ( getenv('TRAVIS_BUILD_NUMBER') ) {
161	4	$desired_capabilities[self::BUILD_NUMBER_CAPABILITY] = getenv('TRAVIS_BUILD_NUMBER');
162	4	}
163
164	24	$this->setDesiredCapabilities($desired_capabilities);
165	24	}
166
167		/**
168		* Returns Job name for API service.
169		*
170		* @param BrowserTestCase $test_case Browser test case.
171		*
172		* @return string
173		*/
174	24	protected function getJobName(BrowserTestCase $test_case)
175		{
176	24	if ( $this->isShared() ) {
177	8	return get_class($test_case);
178		}
179
180	16	return $test_case->toString();
181		}
182
183		/**
184		* Hook, called from "BrowserTestCase::run" method.
185		*
186		* @param TestEndedEvent $event Test ended event.
187		*
188		* @return void
189		*/
190	10	public function onTestEnded(TestEndedEvent $event)
191		{
192	10	if ( !$event->validateSubscriber($this->getTestCase()) ) {
193	1	return;
194		}
195
196	10	parent::onTestEnded($event);
197
198	10	$session = $event->getSession();
199
200	10	if ( $session === null \|\| !$session->isStarted() ) {
201		// Session wasn't used in particular test.
202	4	return;
203		}
204
205	6	$test_case = $event->getTestCase();
206
207	6	$this->getAPIClient()->updateStatus(
208	6	$this->getSessionId($session),
209	4	$this->getTestStatus($test_case, $event->getTestResult())
210	4	);
211	4	}
212
213		/**
214		* Returns API class for service interaction.
215		*
216		* @return IAPIClient
217		*/
218		public abstract function getAPIClient();
219
220		/**
221		* Get Selenium2 current session id.
222		*
223		* @param Session $session Session.
224		*
225		* @return string
226		* @throws \RuntimeException When session was created using an unsupported driver.
227		*/
228	6	protected function getSessionId(Session $session)
229		{
230	6	$driver = $session->getDriver();
231
232	6	if ( $driver instanceof Selenium2Driver ) {
233	4	return $driver->getWebDriverSessionId();
234		}
235
236	2	throw new \RuntimeException('Unsupported session driver');
237		}
238
239		}
240

minkphp / phpunit-mink

Push — master ( 420f16...68b944 )

ApiBrowserConfiguration::onTestEnded() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like