Do not use two levels of helper objects for Selenium tests

Just define base class for Selenium testing which includes all the magic
and others will inherit from it.

Signed-off-by: Michal Čihař <michal@cihar.com>
This commit is contained in:
Michal Čihař 2014-02-17 14:01:48 +01:00
parent 5b93ccf150
commit bde484de57
2 changed files with 316 additions and 28 deletions

View File

@ -6,7 +6,7 @@
* @package PhpMyAdmin-test
* @subpackage Selenium
*/
require_once 'Helper.php';
require_once 'TestBase.php';
/**
* PmaSeleniumLoginTest class
@ -14,28 +14,8 @@ require_once 'Helper.php';
* @package PhpMyAdmin-test
* @subpackage Selenium
*/
class PmaSeleniumLoginTest extends PHPUnit_Extensions_Selenium2TestCase
class PmaSeleniumLoginTest extends PmaSeleniumBase
{
/**
* Helper Object
*
* @var Helper
*/
private $_helper;
/**
* Setup the browser environment to run the selenium test case
*
* @return void
*/
public function setUp()
{
$this->_helper = new Helper($this);
$this->setHost(PHPUNIT_HOST);
$this->setBrowser($this->_helper->getBrowserString());
$this->setBrowserUrl(TESTSUITE_PHPMYADMIN_HOST . TESTSUITE_PHPMYADMIN_URL);
}
/**
* Test for successful login
*
@ -43,9 +23,9 @@ class PmaSeleniumLoginTest extends PHPUnit_Extensions_Selenium2TestCase
*/
public function testSuccessfulLogin()
{
$this->_helper->login(TESTSUITE_USER, TESTSUITE_PASSWORD);
$this->assertTrue($this->_helper->isSuccessLogin());
$this->_helper->logOutIfLoggedIn();
$this->login(TESTSUITE_USER, TESTSUITE_PASSWORD);
$this->assertTrue($this->isSuccessLogin());
$this->logOutIfLoggedIn();
}
/**
@ -55,9 +35,9 @@ class PmaSeleniumLoginTest extends PHPUnit_Extensions_Selenium2TestCase
*/
public function testLoginWithWrongPassword()
{
$this->_helper->login("Admin", "Admin");
$this->assertTrue($this->_helper->isUnsuccessLogin());
$this->_helper->logOutIfLoggedIn();
$this->login("Admin", "Admin");
$this->assertTrue($this->isUnsuccessLogin());
$this->logOutIfLoggedIn();
}
}
?>

308
test/selenium/TestBase.php Normal file
View File

@ -0,0 +1,308 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Base class for Selenium tests
*
* @package PhpMyAdmin-test
* @subpackage Selenium
*/
/**
* Returns list of Selenium configured browsers.
*/
function selenium_browsers() {
$bs_uname = getenv('BS_UNAME');
$bs_key = getenv('BS_KEY');
if ($bs_uname && $bs_key) {
return array(
array(
'browserName' => 'chrome',
'host' => 'hub.browserstack.com',
'port' => 80,
'desiredCapabilities' => array(
'version' => '30',
'browserstack.user' => BROWSERSTACK_USER,
'browserstack.key' => 'XQWDewaJsUzqYJRv8zhr',
'os' => 'OS X',
'os_version' => 'Mountain Lion'
)
),
array(
'browserName' => 'chrome',
'host' => 'hub.browserstack.com',
'port' => 80,
'desiredCapabilities' => array(
'version' => '30',
'browserstack.user' => BROWSERSTACK_USER,
'browserstack.key' => BROWSERSTACK_KEY,
'os' => 'Windows',
'os_version' => '8.1'
)
)
);
} else {
return array(
array(
'host' => '127.0.0.1',
)
);
}
}
/**
* Base class for Selenium tests.
*
* @package PhpMyAdmin-test
* @subpackage Selenium
*/
class PmaSeleniumBase extends PHPUnit_Extensions_Selenium2TestCase
{
/**
* Selenium browsers setup
*
* @access public
* @var browsers
*/
public static $browsers = selenium_browsers();
/**
* base URL for tests
*
* @access private
* @var base_url
*/
private static $base_url = TESTSUITE_PHPMYADMIN_HOST . TESTSUITE_PHPMYADMIN_URL;
/**
* mysqli object
*
* @access private
* @var mysqli
*/
private $_mysqli;
protected function setUp()
{
parent::setUp();
}
/**
* perform a login
*
* @param string $username Username
* @param string $password Password
*
* @return void
*/
public function login($username, $password)
{
$this->url($this->base_url);
$usernameField = $this->byId('input_username');
$usernameField->value($username);
$passwordField = $this->byId('input_password');
$passwordField->value($password);
$this->byId('input_go')->click();
}
/**
* Checks whether the login is successful
*
* @return boolean
*/
public function isSuccessLogin()
{
if ($this->isElementPresent("byXPath", "//*[@id=\"serverinfo\"]")) {
return true;
} else {
return false;
}
}
/**
* Checks whether the login is unsuccessful
*
* @return boolean
*/
public function isUnsuccessLogin()
{
if ($this->isElementPresent("byCssSelector", "div.error")) {
return true;
} else {
return false;
}
}
/**
* Used to go to the homepage
*
* @return void
*/
public function gotoHomepage()
{
$e = $this->byPartialLinkText("Server: ");
$e->click();
$this->waitForElementNotPresent('byCssSelector', 'div#loading_parent');
}
/**
* Establishes a connection with the local database
*
* @return void
*
* @throws Exception
*/
public function dbConnect()
{
if ($this->_mysqli === null) {
$this->_mysqli = new mysqli(
"localhost",
TESTSUITE_USER,
TESTSUITE_PASSWORD
);
if ($this->_mysqli->connect_errno) {
throw new Exception(
'Failed to connect to MySQL (' . $this->_mysqli->error . ')'
);
}
}
}
/**
* Executes a database query
*
* @param string $query SQL Query to be executed
*
* @return void|boolean|mysqli_result
*
* @throws Exception
*/
public function dbQuery($query)
{
if ($this->_mysqli === null) {
throw new Exception(
'MySQL not connected'
);
}
return $this->_mysqli->query($query);
}
/**
* Check if user is logged in to phpmyadmin
*
* @return boolean Where or not user is logged in
*/
public function isLoggedIn()
{
return $this->isElementPresent('byXPath', '//*[@id="serverinfo"]/a[1]');
}
/**
* Perform a logout, if logged in
*
* @return void
*/
public function logOutIfLoggedIn()
{
if ($this->isLoggedIn()) {
$this->byCssSelector("img.icon.ic_s_loggoff")->click();
}
}
/**
* Wait for an element to be present on the page
*
* @param string $func Locate using - byCss, byXPath, etc
* @param string $arg Selector
*
* @return PHPUnit_Extensions_Selenium2TestCase_Element Element waited for
*/
public function waitForElement($func, $arg)
{
$this->timeouts()->implicitWait(10000);
$element = call_user_func_array(
array($this, $func), array($arg)
);
$this->timeouts()->implicitWait(0);
return $element;
}
/**
* Wait for an element to disappear
*
* @param string $func Locate using - byCss, byXPath, etc
* @param string $arg Selector
*
* @return bool Whether or not the element disappeared
*/
public function waitForElementNotPresent($func, $arg)
{
while (true) {
if (!$this->isElementPresent($func, $arg)) {
return true;
}
usleep(100);
}
}
/**
* Check if element is present or not
*
* @param string $func Locate using - byCss, byXPath, etc
* @param string $arg Selector
*
* @return bool Whether or not the element is present
*/
public function isElementPresent($func, $arg)
{
try {
$element = call_user_func_array(
array($this, $func), array($arg)
);
} catch (PHPUnit_Extensions_Selenium2TestCase_WebDriverException $e) {
// Element not present
return false;
}
// Element Present
return true;
}
/**
* Get table cell data
*
* @param string $identifier Identifier: tableId.row.column
*
* @return text Data from the particular table cell
*/
public function getTable($identifier)
{
list($tableID, $row, $column) = explode(".", $identifier);
$sel = "table#{$tableID} tbody tr:nth-child({$row}) td:nth-child({$column})";
$element = $this->byCssSelector(
$sel
);
return $element->text();
}
/**
* Type text in textarea (CodeMirror enabled)
*
* @param string $text Text to type
*
* @return void
*/
public function typeInTextArea($text)
{
$text = str_replace(
"(",
PHPUnit_Extensions_Selenium2TestCase_Keys::SHIFT
. PHPUnit_Extensions_Selenium2TestCase_Keys::NUMPAD9
. PHPUnit_Extensions_Selenium2TestCase_Keys::NULL,
$text
);
$this->byClassName("CodeMirror-scroll")->click();
$this->keys($text);
}
}
?>