silverstripe-behat-extension/src/SilverStripe/BehatExtension/Context/SilverStripeContext.php

504 lines
14 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\BehatExtension\Context;
use Behat\Behat\Context\Step,
2014-01-26 22:50:20 +01:00
Behat\Behat\Event\FeatureEvent,
Behat\Behat\Event\ScenarioEvent,
Behat\Behat\Event\SuiteEvent;
use Behat\Gherkin\Node\PyStringNode;
use Behat\MinkExtension\Context\MinkContext;
use Behat\Mink\Driver\GoutteDriver,
2014-01-26 22:50:20 +01:00
Behat\Mink\Driver\Selenium2Driver,
Behat\Mink\Exception\UnsupportedDriverActionException,
Behat\Mink\Exception\ElementNotFoundException;
use SilverStripe\BehatExtension\Context\SilverStripeAwareContextInterface;
use Symfony\Component\Yaml\Yaml;
// Mink etc.
require_once 'vendor/autoload.php';
require_once BASE_PATH . '/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php';
/**
* SilverStripeContext
*
* Generic context wrapper used as a base for Behat FeatureContext.
*/
class SilverStripeContext extends MinkContext implements SilverStripeAwareContextInterface
{
2014-01-26 22:50:20 +01:00
protected $databaseName;
/**
* @var Array Partial string match for step names
* that are considered to trigger Ajax request in the CMS,
* and hence need special timeout handling.
* @see \SilverStripe\BehatExtension\Context\BasicContext->handleAjaxBeforeStep().
*/
protected $ajaxSteps;
/**
* @var Int Timeout in milliseconds, after which the interface assumes
* that an Ajax request has timed out, and continues with assertions.
*/
protected $ajaxTimeout;
/**
* @var String Relative URL to the SilverStripe admin interface.
*/
protected $adminUrl;
/**
* @var String Relative URL to the SilverStripe login form.
*/
protected $loginUrl;
/**
* @var String Relative path to a writeable folder where screenshots can be stored.
* If set to NULL, no screenshots will be stored.
*/
protected $screenshotPath;
protected $context;
protected $testSessionEnvironment;
2014-01-26 22:50:20 +01:00
/**
* Initializes context.
* Every scenario gets it's own context object.
*
* @param array $parameters context parameters (set them up through behat.yml)
*/
public function __construct(array $parameters) {
// Initialize your context here
$this->context = $parameters;
$this->testSessionEnvironment = new \TestSessionEnvironment();
2014-01-26 22:50:20 +01:00
}
public function setDatabase($databaseName) {
$this->databaseName = $databaseName;
}
public function setAjaxSteps($ajaxSteps) {
if($ajaxSteps) $this->ajaxSteps = $ajaxSteps;
}
public function getAjaxSteps() {
return $this->ajaxSteps;
}
public function setAjaxTimeout($ajaxTimeout) {
$this->ajaxTimeout = $ajaxTimeout;
}
public function getAjaxTimeout() {
return $this->ajaxTimeout;
}
public function setAdminUrl($adminUrl) {
$this->adminUrl = $adminUrl;
}
public function getAdminUrl() {
return $this->adminUrl;
}
public function setLoginUrl($loginUrl) {
$this->loginUrl = $loginUrl;
}
public function getLoginUrl() {
return $this->loginUrl;
}
public function setScreenshotPath($screenshotPath) {
$this->screenshotPath = $screenshotPath;
}
public function getScreenshotPath() {
return $this->screenshotPath;
}
2014-03-19 02:53:00 +01:00
public function getRegionMap(){
return $this->regionMap;
}
public function setRegionMap($regionMap){
$this->regionMap = $regionMap;
}
/**
* Returns MinkElement based off region defined in .yml file.
* Also supports direct CSS selectors and regions identified by a "data-title" attribute.
* When using the "data-title" attribute, ensure not to include double quotes.
*
* @param String $region Region name or CSS selector
2014-03-19 02:53:00 +01:00
* @return MinkElement|null
*/
public function getRegionObj($region) {
// Try to find regions directly by CSS selector.
try {
$regionObj = $this->getSession()->getPage()->find(
'css',
// Escape CSS selector
(false !== strpos($region, "'")) ? str_replace("'", "\'", $region) : $region
);
if($regionObj) {
return $regionObj;
}
} catch(\Symfony\Component\CssSelector\Exception\SyntaxErrorException $e) {
// fall through to next case
}
// Fall back to region identified by data-title.
// Only apply if no double quotes exist in search string,
// which would break the CSS selector.
if(false === strpos($region, '"')) {
$regionObj = $this->getSession()->getPage()->find(
'css',
'[data-title="' . $region . '"]'
);
if($regionObj) {
return $regionObj;
}
}
2014-03-19 02:53:00 +01:00
// Look for named region
2015-04-07 13:15:22 +02:00
if(!$this->regionMap) {
2014-03-19 02:53:00 +01:00
throw new \LogicException("Cannot find 'region_map' in the behat.yml");
}
2015-04-07 13:15:22 +02:00
if(!array_key_exists($region, $this->regionMap)) {
2014-03-19 02:53:00 +01:00
throw new \LogicException("Cannot find the specified region in the behat.yml");
}
2015-04-07 13:15:22 +02:00
$regionObj = $this->getSession()->getPage()->find('css', $region);
2014-03-19 02:53:00 +01:00
if(!$regionObj) {
throw new ElementNotFoundException("Cannot find the specified region on the page");
}
return $regionObj;
}
2014-01-26 22:50:20 +01:00
/**
* @BeforeScenario
*/
public function before(ScenarioEvent $event) {
if (!isset($this->databaseName)) {
throw new \LogicException(
'Context\'s $databaseName has to be set when implementing SilverStripeAwareContextInterface.'
);
}
$state = $this->getTestSessionState();
$this->testSessionEnvironment->startTestSession($state);
// Optionally import database
if(!empty($state['importDatabasePath'])) {
$this->testSessionEnvironment->importDatabase(
$state['importDatabasePath'],
!empty($state['requireDefaultRecords']) ? $state['requireDefaultRecords'] : false
);
} else if(!empty($state['requireDefaultRecords']) && $state['requireDefaultRecords']) {
$this->testSessionEnvironment->requireDefaultRecords();
}
// Fixtures
$fixtureFile = (!empty($state['fixture'])) ? $state['fixture'] : null;
if($fixtureFile) {
$this->testSessionEnvironment->loadFixtureIntoDb($fixtureFile);
}
2014-02-24 23:33:12 +01:00
if($screenSize = getenv('BEHAT_SCREEN_SIZE')) {
list($screenWidth, $screenHeight) = explode('x', $screenSize);
$this->getSession()->resizeWindow((int)$screenWidth, (int)$screenHeight);
} else {
$this->getSession()->resizeWindow(1024, 768);
2014-02-24 23:33:12 +01:00
}
2014-01-26 22:50:20 +01:00
}
/**
* Returns a parameter map of state to set within the test session.
* Takes TESTSESSION_PARAMS environment variable into account for run-specific configurations.
*
2014-01-26 22:50:20 +01:00
* @return array
*/
public function getTestSessionState() {
$extraParams = array();
parse_str(getenv('TESTSESSION_PARAMS'), $extraParams);
return array_merge(
array(
'database' => $this->databaseName,
'mailer' => 'SilverStripe\BehatExtension\Utility\TestMailer',
),
$extraParams
);
}
/**
* Parses given URL and returns its components
*
* @param $url
* @return array|mixed Parsed URL
*/
public function parseUrl($url) {
$url = parse_url($url);
$url['vars'] = array();
if (!isset($url['fragment'])) {
$url['fragment'] = null;
}
if (isset($url['query'])) {
parse_str($url['query'], $url['vars']);
}
return $url;
}
/**
* Checks whether current URL is close enough to the given URL.
* Unless specified in $url, get vars will be ignored
* Unless specified in $url, fragment identifiers will be ignored
*
* @param $url string URL to compare to current URL
* @return boolean Returns true if the current URL is close enough to the given URL, false otherwise.
*/
public function isCurrentUrlSimilarTo($url) {
$current = $this->parseUrl($this->getSession()->getCurrentUrl());
$test = $this->parseUrl($url);
if ($current['path'] !== $test['path']) {
return false;
}
if (isset($test['fragment']) && $current['fragment'] !== $test['fragment']) {
return false;
}
foreach ($test['vars'] as $name => $value) {
if (!isset($current['vars'][$name]) || $current['vars'][$name] !== $value) {
return false;
}
}
return true;
}
/**
* Returns base URL parameter set in MinkExtension.
* It simplifies configuration by allowing to specify this parameter
* once but makes code dependent on MinkExtension.
*
* @return string
*/
public function getBaseUrl() {
return $this->getMinkParameter('base_url') ?: '';
}
/**
* Joins URL parts into an URL using forward slash.
* Forward slash usages are normalised to one between parts.
* This method takes variable number of parameters.
*
* @param $...
* @return string
* @throws \InvalidArgumentException
*/
public function joinUrlParts() {
if (0 === func_num_args()) {
throw new \InvalidArgumentException('Need at least one argument');
}
$parts = func_get_args();
$trimSlashes = function(&$part) {
$part = trim($part, '/');
};
array_walk($parts, $trimSlashes);
return implode('/', $parts);
}
public function canIntercept() {
$driver = $this->getSession()->getDriver();
if ($driver instanceof GoutteDriver) {
return true;
}
else {
if ($driver instanceof Selenium2Driver) {
return false;
}
}
throw new UnsupportedDriverActionException('You need to tag the scenario with "@mink:goutte" or
"@mink:symfony". Intercepting the redirections is not supported by %s', $driver);
}
/**
* @Given /^(.*) without redirection$/
*/
public function theRedirectionsAreIntercepted($step) {
if ($this->canIntercept()) {
$this->getSession()->getDriver()->getClient()->followRedirects(false);
}
return new Step\Given($step);
}
/**
* Fills in form field with specified id|name|label|value.
* Overwritten to select the first *visible* element, see https://github.com/Behat/Mink/issues/311
*/
public function fillField($field, $value) {
$value = $this->fixStepArgument($value);
$fields = $this->getSession()->getPage()->findAll('named', array(
'field', $this->getSession()->getSelectorsHandler()->xpathLiteral($field)
));
if($fields) foreach($fields as $f) {
if($f->isVisible()) {
$f->setValue($value);
return;
2014-01-26 22:50:20 +01:00
}
}
2014-01-26 22:50:20 +01:00
throw new ElementNotFoundException(
$this->getSession(), 'form field', 'id|name|label|value', $field
);
}
/**
* Overwritten to click the first *visable* link the DOM.
*/
public function clickLink($link) {
$link = $this->fixStepArgument($link);
$links = $this->getSession()->getPage()->findAll('named', array(
'link', $this->getSession()->getSelectorsHandler()->xpathLiteral($link)
));
if($links) foreach($links as $l) {
if($l->isVisible()) {
$l->click();
return;
2014-01-26 22:50:20 +01:00
}
}
throw new ElementNotFoundException(
$this->getSession(), 'link', 'id|name|label|value', $link
);
}
2014-01-26 22:02:56 +01:00
/**
* Sets the current date. Relies on the underlying functionality using
* {@link SS_Datetime::now()} rather than PHP's system time methods like date().
* Supports ISO fomat: Y-m-d
* Example: Given the current date is "2009-10-31"
*
* @Given /^the current date is "([^"]*)"$/
*/
public function givenTheCurrentDateIs($date) {
$newDatetime = \DateTime::createFromFormat('Y-m-d', $date);
if(!$newDatetime) {
throw new InvalidArgumentException(sprintf('Invalid date format: %s (requires "Y-m-d")', $date));
}
$state = $this->testSessionEnvironment->getState();
$oldDatetime = \DateTime::createFromFormat('Y-m-d H:i:s', isset($state->datetime) ? $state->datetime : null);
if($oldDatetime) {
$newDatetime->setTime($oldDatetime->format('H'), $oldDatetime->format('i'), $oldDatetime->format('s'));
}
$state->datetime = $newDatetime->format('Y-m-d H:i:s');
$this->testSessionEnvironment->applyState($state);
}
/**
* Sets the current time. Relies on the underlying functionality using
* {@link \SS_Datetime::now()} rather than PHP's system time methods like date().
* Supports ISO fomat: H:i:s
* Example: Given the current time is "20:31:50"
*
* @Given /^the current time is "([^"]*)"$/
*/
public function givenTheCurrentTimeIs($time) {
$newDatetime = \DateTime::createFromFormat('H:i:s', $date);
if(!$newDatetime) {
throw new InvalidArgumentException(sprintf('Invalid date format: %s (requires "H:i:s")', $date));
}
$state = $this->testSessionEnvironment->getState();
$oldDatetime = \DateTime::createFromFormat('Y-m-d H:i:s', isset($state->datetime) ? $state->datetime : null);
if($oldDatetime) {
$newDatetime->setDate($oldDatetime->format('Y'), $oldDatetime->format('m'), $oldDatetime->format('d'));
}
$state->datetime = $newDatetime->format('Y-m-d H:i:s');
$this->testSessionEnvironment->applyState($state);
}
/**
* Selects option in select field with specified id|name|label|value.
*
* @override /^(?:|I )select "(?P<option>(?:[^"]|\\")*)" from "(?P<select>(?:[^"]|\\")*)"$/
*/
public function selectOption($select, $option) {
// Find field
$field = $this
->getSession()
->getPage()
->findField($this->fixStepArgument($select));
// If field is visible then select it as per normal
if($field && $field->isVisible()) {
parent::selectOption($select, $option);
} else {
$this->selectOptionWithJavascript($select, $option);
}
}
/**
* Selects option in select field with specified id|name|label|value using javascript
* This method uses javascript to allow selection of options that may be
* overridden by javascript libraries, and thus hide the element.
*
* @When /^(?:|I )select "(?P<option>(?:[^"]|\\")*)" from "(?P<select>(?:[^"]|\\")*)" with javascript$/
*/
public function selectOptionWithJavascript($select, $option) {
$select = $this->fixStepArgument($select);
$option = $this->fixStepArgument($option);
$page = $this->getSession()->getPage();
// Find field
$field = $page->findField($select);
if (null === $field) {
throw new ElementNotFoundException($this->getSession(), 'form field', 'id|name|label|value', $select);
}
// Find option
$opt = $field->find('named', array(
'option', $this->getSession()->getSelectorsHandler()->xpathLiteral($option)
));
if (null === $opt) {
throw new ElementNotFoundException($this->getSession(), 'select option', 'value|text', $option);
}
// Merge new option in with old handling both multiselect and single select
$value = $field->getValue();
$newValue = $opt->getAttribute('value');
if(is_array($value)) {
if(!in_array($newValue, $value)) $value[] = $newValue;
} else {
$value = $newValue;
}
$valueEncoded = json_encode($value);
// Inject this value via javascript
$fieldID = $field->getAttribute('ID');
$script = <<<EOS
(function($) {
$("#$fieldID")
.val($valueEncoded)
2014-06-19 07:14:06 +02:00
.change()
.trigger('liszt:updated')
.trigger('chosen:updated');
})(jQuery);
EOS;
$this->getSession()->getDriver()->executeScript($script);
}
}