Magiic Methods Navigation and Window, Test Navigation

Author: LuisRBarreras

SeleniumClient/CapabilityType.php

@@ -17,22 +17,22 @@
 
 abstract class CapabilityType {	
 
-	const browserName              = "browserName";
-	const version                  = "version";
-	const platform                 = "platform";	
-	const javascriptEnabled        = "javascriptEnabled";
-	const takesScreenshot          = "takesScreenshot";
-	const handlesAlerts            = "handlesAlerts";
-	const databaseEnabled          = "databaseEnabled";
-	const locationContextEnabled   = "locationContextEnabled";
-	const applicationCacheEnabled  = "applicationCacheEnabled";
-	const browserConnectionEnabled = "browserConnectionEnabled";
-	const cssSelectorsEnabled      = "cssSelectorsEnabled";
-	const webStorageEnabled        = "webStorageEnabled";
-	const rotatable                = "rotatable";
-	const acceptSslCerts           = "acceptSslCerts";
-	const nativeEvents             = "nativeEvents";
-	const proxy                    = "proxy";	
+	const BROWSER_NAME               = "browserName";
+	const VERSION                    = "version";
+	const PLATFORM                   = "platform";	
+	const JAVASCRIPT_ENABLED         = "javascriptEnabled";
+	const TAKES_SCREENSHOT           = "takesScreenshot";
+	const HANDLES_ALERT              = "handlesAlerts";
+	const DATABASE_ENABLED           = "databaseEnabled";
+	const LOCATION_CONTEXT_ENABLED   = "locationContextEnabled";
+	const APPLICATION_CACHE_ENABLED  = "applicationCacheEnabled";
+	const BROWSER_CONNECTION_ENABLED = "browserConnectionEnabled";
+	const CSS_SELECTORS_ENABLED      = "cssSelectorsEnabled";
+	const WEB_STORAGE_ENABLED        = "webStorageEnabled";
+	const ROTATABLE                  = "rotatable";
+	const ACCEPT_SSL_CERTS           = "acceptSslCerts";
+	const NATIVE_EVENTS              = "nativeEvents";
+	const PROXY                      = "proxy";	
 
 	public static function isValidCapabilityType($capabilityType)
 	{

SeleniumClient/DesiredCapabilities.php

@@ -17,6 +17,8 @@
 
 use SeleniumClient\CapabilityType;
 
+require_once __DIR__ . '/Exceptions.php';
+
 class DesiredCapabilities {	
 
 	private $_capabilities = null;
@@ -31,17 +33,17 @@ public function __construct($browser = null, $version = null, $platform = null)
 	{
 		if(isset($browser))
 		{
-			$this->setCapability(CapabilityType::browserName, $browser);
+			$this->setCapability(CapabilityType::BROWSER_NAME, $browser);
 		}
 
 		if(isset($version))
 		{
-			$this->setCapability(CapabilityType::version, $version);
+			$this->setCapability(CapabilityType::VERSION, $version);
 		}
 
 		if(isset($platform))
 		{
-			$this->setCapability(CapabilityType::platform, $platform);
+			$this->setCapability(CapabilityType::PLATFORM, $platform);
 		}
 	}
 
@@ -82,7 +84,7 @@ public function getCapability($capabilityType)
 	 */
 	public function getBrowserName()
 	{
-		return $this->getCapability(CapabilityType::browserName);
+		return $this->getCapability(CapabilityType::BROWSER_NAME);
 	}
 
 	/**
@@ -91,7 +93,7 @@ public function getBrowserName()
 	 */
 	public function getPlatform()
 	{
-		return $this->getCapability(CapabilityType::platform);
+		return $this->getCapability(CapabilityType::PLATFORM);
 	}
 
 	/**
@@ -100,7 +102,7 @@ public function getPlatform()
 	 */
 	public function  getVersion()
 	{
-		return $this->getCapability(CapabilityType::version);
+		return $this->getCapability(CapabilityType::VERSION);
 	}
 
 	/**
@@ -109,7 +111,7 @@ public function  getVersion()
 	 */
 	public function getIsJavaScriptEnabled()
 	{
-		return $this->getCapability(CapabilityType::javascriptEnabled);
+		return $this->getCapability(CapabilityType::JAVASCRIPT_ENABLED);
 	}	
 
 	/**
@@ -120,14 +122,32 @@ public function getIsJavaScriptEnabled()
 	 */
 	public function setCapability($capabilityType,$value)
 	{	
-		if(CapabilityType::isValidCapabilityType($capabilityType))
+		if($this->isValidCapabilityAndValue($capabilityType,$value))
 		{
 			$this->_capabilities[$capabilityType] = $value;
 		}
+	}
+
+	private function isValidCapabilityAndValue($capabilityType,$value)
+	{
+		if(CapabilityType::isValidCapabilityType($capabilityType))
+		{
+			switch($capabilityType)
+			{
+				case CapabilityType::BROWSER_NAME:
+					if(!BrowserType::isValidBrowserType($value)) { throw new InvalidBrowserTypeException("'{$value}' is not a valid browser type"); }
+					break;
+				case CapabilityType::PLATFORM:
+					if(!PlatformType::isValidPlatformType($value)) { throw new InvalidPlatformTypeException("'{$value}' is not a valid platform type"); }
+					break;
+			}
+		}
 		else
 		{
-			throw new \Exception("'".$capabilityType ."' is not an valid capability type");
+			throw new InvalidCapabilityTypeException("'{$capabilityType}' is not a valid capability type");
 		}
+
+		return true;
 	}
 
 	public function __toString()

SeleniumClient/Exceptions.php

@@ -1,16 +1,16 @@
 <?php
-// Copyright 2012-present Nearsoft, Inc
-
-// 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
+// Copyright 2012-present Nearsoft, Inc
+
+// 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.
 
 namespace SeleniumClient;
@@ -19,6 +19,12 @@ class WebDriverWaitTimeoutException extends \Exception {}
 
 class EmptyValueException extends \Exception { }
 
+class InvalidCapabilityTypeException extends \Exception { }
+
+class InvalidBrowserTypeException extends \Exception { }
+
+class InvalidPlatformTypeException extends \Exception { }
+
 class NotStringException extends \Exception
 {
 	public function __construct($functionName, $paramName) { parent::__construct("function {$functionName}: {$paramName} is not String."); }

SeleniumClient/WebDriver.php

@@ -29,14 +29,15 @@
 
 class WebDriver
 {
-	private $_hubUrl = null;
-	private $_sessionId = null;
+	private $_hubUrl               = null;
+	private $_sessionId            = null;
 	private $_screenshotsDirectory = null;
-	private $_environment = HttpFactory::PRODUCTIONMODE;
-	private $_capabilities = null;
-	private $_httpClient = null;
-	private $_options = null;
-    private $_navigate = null;
+	private $_environment          = HttpFactory::PRODUCTIONMODE;
+	private $_capabilities         = null;
+	private $_httpClient           = null;
+	private $_options              = null;
+    private $_navigate             = null;
+    private $_targetLocator        = null;
 
 	/**
 	 * @param DesiredCapabilities $desiredCapabilities
@@ -45,8 +46,8 @@ class WebDriver
 	 */
 	public function __construct(DesiredCapabilities $desiredCapabilities = null, $host = "http://localhost", $port = 4444)
 	{
-		$this->_hubUrl = $host . ":" . strval($port) . "/wd/hub";		
-		if(!isset($desiredCapabilities)) { $desiredCapabilities = new DesiredCapabilities("firefox"); }
+		$this->_hubUrl = "{$host}:{$port}/wd/hub";
+		isset($desiredCapabilities) ? : $desiredCapabilities = new DesiredCapabilities("firefox");
 		$this->_httpClient = HttpFactory::getClient($this->_environment);		
 		$this->startSession($desiredCapabilities);
 	}
@@ -231,6 +232,7 @@ public function getHttpClient()  { return $this->_httpClient; }
 	 */
 	public function getHubUrl() { return $this->_hubUrl; }
 
+
     /**
      * Get Navigation object
      * @return Selenium\Navigation
@@ -254,35 +256,51 @@ public function setNavigate($navigate)
 	 */
 	public function getSessionId() { return $this->_sessionId; }
 
-	/**
-	 * Get default screenshots directory
-	 * @return String
-	 */
-	public function getScreenShotsDirectory() { return $this->_screenshotsDirectory; }
-	
 	/**
 	 * Sets default screenshots directory for files to be stored in
 	 * @param String $value
 	 */
 	public function setScreenShotsDirectory($value) { $this->_screenshotsDirectory = $value; }
+
+	/**
+	 * Get default screenshots directory
+	 * @return String
+	 */
+	public function getScreenShotsDirectory() { return $this->_screenshotsDirectory; }
 
+    /**
+     * Get Navigation object
+     * @return Selenium\Navigation
+     */
+    public function navigate()
+    {
+        isset($this->_navigate) ? : $this->_navigate = new Navigation($this);
+        return $this->_navigate;
+    }
+
 	/**
 	 * Gets Options object
 	 * @return SeleniumClient\Options
 	 */
 	public function manage()
 	{
+
 		if(!$this->_options) {
 			$this->_options = new Options($this);
 		}
+		isset($this->_options) ? : $this->_options = new Options($this);
 		return $this->_options;
 	}
 
 	/**
 	 * Creates new target locator to be handled
 	 * @return \SeleniumClient\TargetLocator
 	 */
-	public function switchTo() { return new TargetLocator($this); }
+	public function switchTo()
+	{
+		isset($this->_targetLocator) ? : $this->_targetLocator = new TargetLocator($this);
+		return $this->_targetLocator;
+	}
 
 	/**
 	 * Starts new Selenium session
@@ -299,7 +317,8 @@ private function startSession(DesiredCapabilities $desiredCapabilities)
 		$command = new Commands\StartSession($this, $params);
 		$results = $command->execute();	
 		$this->_sessionId = $results['sessionId'];
-		$this->_capabilities = $this->getCapabilities();
+		$this->_capabilities = $results['value'];
+		return $this->_capabilities;
 	}
 
 	/**
@@ -332,7 +351,16 @@ public function quit()
 		$command = new Commands\Quit($this);
 		$command->execute();
 	}
-	
+
+	/**
+	 * Closes current window
+	 */
+	public function close()
+	{
+		$command = new Commands\CloseWindow($this);		
+		$command->execute();
+	}
+		
 	/**
 	 * Navigates to specified url
 	 * @param String $url
@@ -369,7 +397,7 @@ public function status()
 	 * Gets current page source
 	 * @return String
 	 */
-	public function pageSource()
+	public function getPageSource()
 	{
 		$command = new Commands\Source($this);		
 		$results = $command->execute();		
@@ -380,7 +408,7 @@ public function pageSource()
 	 * Gets current page title
 	 * @return String
 	 */
-	public function title()
+	public function getTitle()
 	{
 		$command = new Commands\Title($this);	
 		$results = $command->execute();	

SeleniumClient/Window.php

@@ -31,16 +31,7 @@ public function maximize() {
      	$commannd = new Commands\WindowMaximize($this->_driver, null, array('window_handle' => 'current'));
         $commannd->execute();
     }
-
-	/**
-	 * Closes current window
-	 */
-	public function close()
-	{
-		$command = new Commands\CloseWindow($this->_driver);		
-		$command->execute();
-	}
-	
+    
 	/**
 	 * Sets current window size
 	 * @param Integer $width

SeleniumClientTest/Demo/Demo2.php

@@ -6,6 +6,9 @@
 use SeleniumClient\WebDriver;
 use SeleniumClient\WebDriverWait;
 use SeleniumClient\DesiredCapabilities;
+use SeleniumClient\CapabilityType;
+use SeleniumClient\BrowserType;
+use SeleniumClient\PlatformType;
 
 class Demo2Test extends PHPUnit_Framework_TestCase
 {
@@ -19,9 +22,13 @@ public function setUp()
 	{
 		$this->_testUrl = "http://nearsoft-php-seleniumclient.herokuapp.com/SeleniumClientTest/SandBox/";
 
-		$desiredCapabilities = new DesiredCapabilities("firefox");
+		$desiredCapabilities = new DesiredCapabilities();
+		$desiredCapabilities->setCapability(CapabilityType::BROWSER_NAME, BrowserType::FIREFOX);
+		$desiredCapabilities->setCapability(CapabilityType::VERSION, "24.0");
+		$desiredCapabilities->setCapability(CapabilityType::PLATFORM, PlatformType::WINDOWS);		
 
 		$this->_driver = new WebDriver($desiredCapabilities);
+		//note that the actual capabilities supported may be different to the desired capabilities specified
 	}
 
 	public function tearDown()
@@ -52,7 +59,7 @@ public function testDemo2()
 
 		$this->assertEquals("test window", $webElement->getAttribute("value"));
 
-		$this->_driver->manage()->window()->close();
+		$this->_driver->close();
 
 		$this->_driver->switchTo()->window($mainWindowHandle);
 

SeleniumClientTest/Tests/AbstractTest.php

@@ -102,7 +102,7 @@ public function tearDown()
                     // try to close any other windows that were opened
                     try {
                         $this->_driver->switchTo()->window($handle);
-                        $this->_driver->manage()->window()->close();
+                        $this->_driver->close();
                     } catch ( Exception $e ) {
                     }
                 }