tonyair
/
silverstripe-behat-extension
mirror of https://github.com/silverstripe/silverstripe-behat-extension
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #123 from open-sausages/pulls/4.0/psr2 

Convert to PSR-2 standard
This commit is contained in:
Hamish Friedlander 2016-08-10 09:45:01 +07:00 committed by GitHub
parent 987505a576 1eb1004957
commit ce3c0bb6c7
20 changed files with 1998 additions and 1768 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.travis.yml
View File

@ -3,11 +3,24 @@ language: php
sudo: false
php:
- 5.5
- 5.6
script:
- vendor/bin/phpunit tests
env:
matrix:
- PHPUNIT_TEST=1
- PHPCS_TEST=1
matrix:
include:
- php: 5.5
env: PHPUNIT_TEST=1
before_script:
- composer install --dev --prefer-dist
- pyrus install pear/PHP_CodeSniffer
- phpenv rehash
script:
- "if [ \"$PHPUNIT_TEST\" = \"1\" ]; then vendor/bin/phpunit tests; fi"
- "if [ \"$PHPCS_TEST\" = \"1\" ]; then phpcs --standard=PSR2 -n src/ tests/; fi"

3
init.php
View File

@ -9,8 +9,7 @@
* with this source code in the file LICENSE.
*/
spl_autoload_register(function($class)
{
spl_autoload_register(function ($class) {
if (false !== strpos($class, 'SilverStripe\\BehatExtension')) {
require_once(__DIR__ . '/src/' . str_replace('\\', '/', $class) . '.php');
return true;

4
src/SilverStripe/BehatExtension/Compiler/CoreInitializationPass.php
View File

@ -2,8 +2,8 @@
namespace SilverStripe\BehatExtension\Compiler;
use Symfony\Component\DependencyInjection\ContainerBuilder,
Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
/**
* Loads SilverStripe core. Required to initialize autoloading.

17
src/SilverStripe/BehatExtension/Compiler/MinkExtensionBaseUrlPass.php
View File

@ -2,8 +2,8 @@
namespace SilverStripe\BehatExtension\Compiler;
use Symfony\Component\DependencyInjection\ContainerBuilder,
Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
/**
* Behat\SilverStripe container compilation pass.
@ -30,12 +30,13 @@ class MinkExtensionBaseUrlPass implements CompilerPassInterface
} elseif ($envPath = $this->findEnvironmentConfigFile($frameworkPath)) {
// Otherwise try to retrieve it from _ss_environment
include_once $envPath;
if(
isset($_FILE_TO_URL_MAPPING)
if (isset($_FILE_TO_URL_MAPPING)
&& !($container->hasParameter('behat.mink.base_url') && $container->getParameter('behat.mink.base_url'))
) {
$baseUrl = $this->findBaseUrlFromMapping(dirname($frameworkPath), $_FILE_TO_URL_MAPPING);
if($baseUrl) $container->setParameter('behat.mink.base_url', $baseUrl);
if ($baseUrl) {
$container->setParameter('behat.mink.base_url', $baseUrl);
}
}
}
@ -60,7 +61,8 @@ class MinkExtensionBaseUrlPass implements CompilerPassInterface
* @param String Absolute start path to search upwards from
* @return Boolean Absolute path to environment file
*/
protected function findEnvironmentConfigFile($path) {
protected function findEnvironmentConfigFile($path)
{
$envPath = null;
$envFile = '_ss_environment.php'; //define the name of the environment file
$path = '.'; //define the dir to start scanning from (have to add the trailing slash)
@ -87,7 +89,8 @@ class MinkExtensionBaseUrlPass implements CompilerPassInterface
* @param Array Map of paths to host names
* @return String URL
*/
protected function findBaseUrlFromMapping($path, $mapping) {
protected function findBaseUrlFromMapping($path, $mapping)
{
$fullPath = $path;
$url = null;
while ($path && $path != "/" && !preg_match('/^[A-Z]:\\\\$/', $path)) {

17
src/SilverStripe/BehatExtension/Console/Processor/InitProcessor.php
View File

@ -2,12 +2,12 @@
namespace SilverStripe\BehatExtension\Console\Processor;
use Symfony\Component\DependencyInjection\ContainerInterface,
Symfony\Component\Console\Command\Command,
Symfony\Component\Console\Input\InputArgument,
Symfony\Component\Console\Input\InputInterface,
Symfony\Component\Console\Output\OutputInterface,
Symfony\Component\Console\Input\InputOption;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputOption;
use Behat\Behat\Console\Processor\InitProcessor as BaseProcessor;
@ -33,7 +33,10 @@ class InitProcessor extends BaseProcessor
{
parent::configure($command);
$command->addOption('--namespace', null, InputOption::VALUE_OPTIONAL,
$command->addOption(
'--namespace',
null,
InputOption::VALUE_OPTIONAL,
"Optional namespace for FeatureContext, defaults to <foldername>\\Test\\Behaviour.\n"
);
}

14
src/SilverStripe/BehatExtension/Console/Processor/LocatorProcessor.php
View File

@ -2,11 +2,11 @@
namespace SilverStripe\BehatExtension\Console\Processor;
use Symfony\Component\DependencyInjection\ContainerInterface,
Symfony\Component\Console\Command\Command,
Symfony\Component\Console\Input\InputArgument,
Symfony\Component\Console\Input\InputInterface,
Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Behat\Behat\Console\Processor\LocatorProcessor as BaseProcessor;
@ -34,7 +34,9 @@ class LocatorProcessor extends BaseProcessor
*/
public function configure(Command $command)
{
$command->addArgument('features', InputArgument::OPTIONAL,
$command->addArgument(
'features',
InputArgument::OPTIONAL,
"Feature(s) to run. Could be:".
"\n- a dir (<comment>src/to/module/Features/</comment>), " .
"\n- a feature (<comment>src/to/module/Features/*.feature</comment>), " .

212
src/SilverStripe/BehatExtension/Context/BasicContext.php
View File

@ -2,15 +2,15 @@
namespace SilverStripe\BehatExtension\Context;
use Behat\Behat\Context\BehatContext,
Behat\Behat\Context\Step,
Behat\Behat\Event\StepEvent,
Behat\Behat\Event\ScenarioEvent;
use Behat\Behat\Context\BehatContext;
use Behat\Behat\Context\Step;
use Behat\Behat\Event\StepEvent;
use Behat\Behat\Event\ScenarioEvent;
use Behat\Mink\Driver\Selenium2Driver;
use Behat\Gherkin\Node\PyStringNode,
Behat\Gherkin\Node\TableNode;
use Behat\Gherkin\Node\PyStringNode;
use Behat\Gherkin\Node\TableNode;
// PHPUnit
require_once BASE_PATH . '/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php';
@ -51,7 +51,8 @@ class BasicContext extends BehatContext
*
* @param array $parameters context parameters (set them up through behat.yml)
*/
public function __construct(array $parameters) {
public function __construct(array $parameters)
{
// Initialize your context here
$this->context = $parameters;
}
@ -61,7 +62,8 @@ class BasicContext extends BehatContext
*
* @return \Behat\Mink\Session
*/
public function getSession($name = null) {
public function getSession($name = null)
{
return $this->getMainContext()->getSession($name);
}
@ -71,7 +73,8 @@ class BasicContext extends BehatContext
* Excluding scenarios with @modal tag is required,
* because modal dialogs stop any JS interaction
*/
public function appendErrorHandlerBeforeStep(StepEvent $event) {
public function appendErrorHandlerBeforeStep(StepEvent $event)
{
try {
$javascript = <<<JS
window.onerror = function(message, file, line, column, error) {
@ -102,7 +105,8 @@ JS;
* Excluding scenarios with @modal tag is required,
* because modal dialogs stop any JS interaction
*/
public function readErrorHandlerAfterStep(StepEvent $event) {
public function readErrorHandlerAfterStep(StepEvent $event)
{
try {
$page = $this->getSession()->getPage();
@ -133,7 +137,8 @@ JS;
*
* @BeforeStep
*/
public function handleAjaxBeforeStep(StepEvent $event) {
public function handleAjaxBeforeStep(StepEvent $event)
{
try {
$ajaxEnabledSteps = $this->getMainContext()->getAjaxSteps();
$ajaxEnabledSteps = implode('|', array_filter($ajaxEnabledSteps));
@ -180,7 +185,8 @@ JS;
*
* @AfterStep ~@modal
*/
public function handleAjaxAfterStep(StepEvent $event) {
public function handleAjaxAfterStep(StepEvent $event)
{
try {
$ajaxEnabledSteps = $this->getMainContext()->getAjaxSteps();
$ajaxEnabledSteps = implode('|', array_filter($ajaxEnabledSteps));
@ -204,11 +210,13 @@ JS;
}
}
public function handleAjaxTimeout() {
public function handleAjaxTimeout()
{
$timeoutMs = $this->getMainContext()->getAjaxTimeout();
// Wait for an ajax request to complete, but only for a maximum of 5 seconds to avoid deadlocks
$this->getSession()->wait($timeoutMs,
$this->getSession()->wait(
$timeoutMs,
"(typeof window.__ajaxStatus !== 'undefined' ? window.__ajaxStatus() : 'no ajax') !== 'waiting'"
);
@ -222,7 +230,8 @@ JS;
*
* @AfterStep
*/
public function takeScreenshotAfterFailedStep(StepEvent $event) {
public function takeScreenshotAfterFailedStep(StepEvent $event)
{
if (4 === $event->getResult()) {
try {
$this->takeScreenshot($event);
@ -237,7 +246,8 @@ JS;
*
* @AfterScenario
*/
public function closeModalDialog(ScenarioEvent $event) {
public function closeModalDialog(ScenarioEvent $event)
{
try {
// Only for failed tests on CMS page
if (4 === $event->getResult()) {
@ -262,14 +272,16 @@ JS;
*
* @AfterScenario @assets
*/
public function cleanAssetsAfterScenario(ScenarioEvent $event) {
public function cleanAssetsAfterScenario(ScenarioEvent $event)
{
foreach (\File::get() as $file) {
$file->delete();
}
\Filesystem::removeFolder(ASSETS_PATH, true);
}
public function takeScreenshot(StepEvent $event) {
public function takeScreenshot(StepEvent $event)
{
$driver = $this->getSession()->getDriver();
// quit silently when unsupported
if (!($driver instanceof Selenium2Driver)) {
@ -282,7 +294,9 @@ JS;
$screenshotPath = null;
$path = $this->getMainContext()->getScreenshotPath();
if(!$path) return; // quit silently when path is not set
if (!$path) {
return;
} // quit silently when path is not set
\Filesystem::makeFolder($path);
$path = realpath($path);
@ -310,7 +324,8 @@ JS;
/**
* @Then /^I should be redirected to "([^"]+)"/
*/
public function stepIShouldBeRedirectedTo($url) {
public function stepIShouldBeRedirectedTo($url)
{
if ($this->getMainContext()->canIntercept()) {
$client = $this->getSession()->getDriver()->getClient();
$client->followRedirects(true);
@ -325,7 +340,8 @@ JS;
/**
* @Given /^the page can't be found/
*/
public function stepPageCantBeFound() {
public function stepPageCantBeFound()
{
$page = $this->getSession()->getPage();
assertTrue(
// Content from ErrorPage default record
@ -338,19 +354,23 @@ JS;
/**
* @Given /^I wait (?:for )?([\d\.]+) second(?:s?)$/
*/
public function stepIWaitFor($secs) {
public function stepIWaitFor($secs)
{
$this->getSession()->wait((float)$secs*1000);
}
/**
* @Given /^I press the "([^"]*)" button$/
*/
public function stepIPressTheButton($button) {
public function stepIPressTheButton($button)
{
$page = $this->getSession()->getPage();
$els = $page->findAll('named', array('link_or_button', "'$button'"));
$matchedEl = null;
foreach ($els as $el) {
if($el->isVisible()) $matchedEl = $el;
if ($el->isVisible()) {
$matchedEl = $el;
}
}
assertNotNull($matchedEl, sprintf('%s button not found', $button));
$matchedEl->click();
@ -363,7 +383,8 @@ JS;
*
* @Given /^I (?:press|follow) the "([^"]*)" (?:button|link), confirming the dialog$/
*/
public function stepIPressTheButtonConfirmingTheDialog($button) {
public function stepIPressTheButtonConfirmingTheDialog($button)
{
$this->stepIPressTheButton($button);
$this->iConfirmTheDialog();
}
@ -374,7 +395,8 @@ JS;
*
* @Given /^I (?:press|follow) the "([^"]*)" (?:button|link), dismissing the dialog$/
*/
public function stepIPressTheButtonDismissingTheDialog($button) {
public function stepIPressTheButtonDismissingTheDialog($button)
{
$this->stepIPressTheButton($button);
$this->iDismissTheDialog();
}
@ -382,7 +404,8 @@ JS;
/**
* @Given /^I (click|double click) "([^"]*)" in the "([^"]*)" element$/
*/
public function iClickInTheElement($clickType, $text, $selector) {
public function iClickInTheElement($clickType, $text, $selector)
{
$clickTypeMap = array(
"double click" => "doubleclick",
"click" => "click"
@ -402,7 +425,8 @@ JS;
*
* @Given /^I (click|double click) "([^"]*)" in the "([^"]*)" element, confirming the dialog$/
*/
public function iClickInTheElementConfirmingTheDialog($clickType, $text, $selector) {
public function iClickInTheElementConfirmingTheDialog($clickType, $text, $selector)
{
$this->iClickInTheElement($clickType, $text, $selector);
$this->iConfirmTheDialog();
}
@ -412,7 +436,8 @@ JS;
*
* @Given /^I (click|double click) "([^"]*)" in the "([^"]*)" element, dismissing the dialog$/
*/
public function iClickInTheElementDismissingTheDialog($clickType, $text, $selector) {
public function iClickInTheElementDismissingTheDialog($clickType, $text, $selector)
{
$this->iClickInTheElement($clickType, $text, $selector);
$this->iDismissTheDialog();
}
@ -420,7 +445,8 @@ JS;
/**
* @Given /^I type "([^"]*)" into the dialog$/
*/
public function iTypeIntoTheDialog($data) {
public function iTypeIntoTheDialog($data)
{
$data = array(
'text' => $data,
);
@ -430,7 +456,8 @@ JS;
/**
* @Given /^I confirm the dialog$/
*/
public function iConfirmTheDialog() {
public function iConfirmTheDialog()
{
$this->getSession()->getDriver()->getWebDriverSession()->accept_alert();
$this->handleAjaxTimeout();
}
@ -438,7 +465,8 @@ JS;
/**
* @Given /^I dismiss the dialog$/
*/
public function iDismissTheDialog() {
public function iDismissTheDialog()
{
$this->getSession()->getDriver()->getWebDriverSession()->dismiss_alert();
$this->handleAjaxTimeout();
}
@ -446,7 +474,8 @@ JS;
/**
* @Given /^(?:|I )attach the file "(?P<path>[^"]*)" to "(?P<field>(?:[^"]|\\")*)" with HTML5$/
*/
public function iAttachTheFileTo($field, $path) {
public function iAttachTheFileTo($field, $path)
{
// Remove wrapped button styling to make input field accessible to Selenium
$js = <<<JS
var input = jQuery('[name="$field"]');
@ -466,7 +495,8 @@ JS;
*
* @Given /^I select "([^"]*)" from "([^"]*)" input group$/
*/
public function iSelectFromInputGroup($value, $labelText) {
public function iSelectFromInputGroup($value, $labelText)
{
$page = $this->getSession()->getPage();
$parent = null;
@ -476,7 +506,9 @@ JS;
}
}
if(!$parent) throw new \InvalidArgumentException(sprintf('Input group with label "%s" cannot be found', $labelText));
if (!$parent) {
throw new \InvalidArgumentException(sprintf('Input group with label "%s" cannot be found', $labelText));
}
foreach ($parent->findAll('css', 'label') as $option) {
if ($option->getText() == $value) {
@ -484,12 +516,18 @@ JS;
// First, look for inputs referenced by the "for" element on this label
$for = $option->getAttribute('for');
if ($for) $input = $parent->findById($for);
if ($for) {
$input = $parent->findById($for);
}
// Otherwise look for inputs _inside_ the label
if (!$input) $input = $option->find('css', 'input');
if (!$input) {
$input = $option->find('css', 'input');
}
if(!$input) throw new \InvalidArgumentException(sprintf('Input "%s" cannot be found', $value));
if (!$input) {
throw new \InvalidArgumentException(sprintf('Input "%s" cannot be found', $value));
}
$this->getSession()->getDriver()->click($input->getXPath());
}
@ -501,9 +539,11 @@ JS;
*
* @Then /^(?:|I )put a breakpoint$/
*/
public function iPutABreakpoint() {
public function iPutABreakpoint()
{
fwrite(STDOUT, "\033[s \033[93m[Breakpoint] Press \033[1;93m[RETURN]\033[0;93m to continue...\033[0m");
while (fgets(STDIN, 1024) == '') {}
while (fgets(STDIN, 1024) == '') {
}
fwrite(STDOUT, "\033[u");
return;
@ -516,7 +556,8 @@ JS;
*
* @Transform /^(?:(the|a)) time of (?<val>.*)$/
*/
public function castRelativeToAbsoluteTime($prefix, $val) {
public function castRelativeToAbsoluteTime($prefix, $val)
{
$timestamp = strtotime($val);
if (!$timestamp) {
throw new \InvalidArgumentException(sprintf(
@ -534,7 +575,8 @@ JS;
*
* @Transform /^(?:(the|a)) datetime of (?<val>.*)$/
*/
public function castRelativeToAbsoluteDatetime($prefix, $val) {
public function castRelativeToAbsoluteDatetime($prefix, $val)
{
$timestamp = strtotime($val);
if (!$timestamp) {
throw new \InvalidArgumentException(sprintf(
@ -552,7 +594,8 @@ JS;
*
* @Transform /^(?:(the|a)) date of (?<val>.*)$/
*/
public function castRelativeToAbsoluteDate($prefix, $val) {
public function castRelativeToAbsoluteDate($prefix, $val)
{
$timestamp = strtotime($val);
if (!$timestamp) {
throw new \InvalidArgumentException(sprintf(
@ -563,27 +606,33 @@ JS;
return date($this->dateFormat, $timestamp);
}
public function getDateFormat() {
public function getDateFormat()
{
return $this->dateFormat;
}
public function setDateFormat($format) {
public function setDateFormat($format)
{
$this->dateFormat = $format;
}
public function getTimeFormat() {
public function getTimeFormat()
{
return $this->timeFormat;
}
public function setTimeFormat($format) {
public function setTimeFormat($format)
{
$this->timeFormat = $format;
}
public function getDatetimeFormat() {
public function getDatetimeFormat()
{
return $this->datetimeFormat;
}
public function setDatetimeFormat($format) {
public function setDatetimeFormat($format)
{
$this->datetimeFormat = $format;
}
@ -595,7 +644,8 @@ JS;
* @Then /^the "(?P<name>(?:[^"]|\\")*)" (?P<type>(?:(field|button))) should (?P<negate>(?:(not |)))be disabled/
* @Then /^the (?P<type>(?:(field|button))) "(?P<name>(?:[^"]|\\")*)" should (?P<negate>(?:(not |)))be disabled/
*/
public function stepFieldShouldBeDisabled($name, $type, $negate) {
public function stepFieldShouldBeDisabled($name, $type, $negate)
{
$page = $this->getSession()->getPage();
if ($type == 'field') {
$element = $page->findField($name);
@ -623,7 +673,8 @@ JS;
* @Then /^the "(?P<field>(?:[^"]|\\")*)" field should be enabled/
* @Then /^the field "(?P<field>(?:[^"]|\\")*)" should be enabled/
*/
public function stepFieldShouldBeEnabled($field) {
public function stepFieldShouldBeEnabled($field)
{
$page = $this->getSession()->getPage();
$fieldElement = $page->findField($field);
assertNotNull($fieldElement, sprintf("Field '%s' not found", $field));
@ -642,7 +693,8 @@ JS;
*
* @Given /^I (?:follow|click) "(?P<link>[^"]*)" in the "(?P<region>[^"]*)" region$/
*/
public function iFollowInTheRegion($link, $region) {
public function iFollowInTheRegion($link, $region)
{
$context = $this->getMainContext();
$regionObj = $context->getRegionObj($region);
assertNotNull($regionObj);
@ -663,7 +715,8 @@ JS;
*
* @Given /^I fill in "(?P<field>[^"]*)" with "(?P<value>[^"]*)" in the "(?P<region>[^"]*)" region$/
*/
public function iFillinTheRegion($field, $value, $region){
public function iFillinTheRegion($field, $value, $region)
{
$context = $this->getMainContext();
$regionObj = $context->getRegionObj($region);
assertNotNull($regionObj, "Region Object is null");
@ -688,7 +741,8 @@ JS;
*
* @Given /^I should (?P<negate>(?:(not |)))see "(?P<text>[^"]*)" in the "(?P<region>[^"]*)" region$/
*/
public function iSeeTextInRegion($negate, $text, $region) {
public function iSeeTextInRegion($negate, $text, $region)
{
$context = $this->getMainContext();
$regionObj = $context->getRegionObj($region);
assertNotNull($regionObj);
@ -720,7 +774,6 @@ JS;
throw new \Exception($message);
}
}
}
/**
@ -728,7 +781,8 @@ JS;
*
* @Given /^I select the "([^"]*)" radio button$/
*/
public function iSelectTheRadioButton($radioLabel) {
public function iSelectTheRadioButton($radioLabel)
{
$session = $this->getSession();
$radioButton = $session->getPage()->find('named', array(
'radio', $this->getSession()->getSelectorsHandler()->xpathLiteral($radioLabel)
@ -740,7 +794,8 @@ JS;
/**
* @Then /^the "([^"]*)" table should contain "([^"]*)"$/
*/
public function theTableShouldContain($selector, $text) {
public function theTableShouldContain($selector, $text)
{
$table = $this->getTable($selector);
$element = $table->find('named', array('content', "'$text'"));
@ -750,7 +805,8 @@ JS;
/**
* @Then /^the "([^"]*)" table should not contain "([^"]*)"$/
*/
public function theTableShouldNotContain($selector, $text) {
public function theTableShouldNotContain($selector, $text)
{
$table = $this->getTable($selector);
$element = $table->find('named', array('content', "'$text'"));
@ -760,7 +816,8 @@ JS;
/**
* @Given /^I click on "([^"]*)" in the "([^"]*)" table$/
*/
public function iClickOnInTheTable($text, $selector) {
public function iClickOnInTheTable($text, $selector)
{
$table = $this->getTable($selector);
$element = $table->find('xpath', sprintf('//*[count(*)=0 and contains(.,"%s")]', $text));
@ -778,13 +835,15 @@ JS;
*
* @return Behat\Mink\Element\NodeElement
*/
protected function getTable($selector) {
protected function getTable($selector)
{
$selector = $this->getSession()->getSelectorsHandler()->xpathLiteral($selector);
$page = $this->getSession()->getPage();
$candidates = $page->findAll(
'xpath',
$this->getSession()->getSelectorsHandler()->selectorToXpath(
"xpath", ".//table[(./@id = $selector or contains(./@title, $selector))]"
"xpath",
".//table[(./@id = $selector or contains(./@title, $selector))]"
)
);
@ -818,7 +877,8 @@ JS;
* Assumptions: the two texts appear in their conjunct parent element once
* @Then /^I should see the text "(?P<textBefore>(?:[^"]|\\")*)" (before|after) the text "(?P<textAfter>(?:[^"]|\\")*)" in the "(?P<element>[^"]*)" element$/
*/
public function theTextBeforeAfter($textBefore, $order, $textAfter, $element) {
public function theTextBeforeAfter($textBefore, $order, $textAfter, $element)
{
$ele = $this->getSession()->getPage()->find('css', $element);
assertNotNull($ele, sprintf('%s not found', $element));
@ -843,7 +903,8 @@ JS;
*
* @Given /^I wait for (\d+) seconds until I see the "([^"]*)" element$/
**/
public function iWaitXUntilISee($wait, $selector) {
public function iWaitXUntilISee($wait, $selector)
{
$page = $this->getSession()->getPage();
$this->spin(function ($page) use ($page, $selector) {
@ -865,7 +926,8 @@ JS;
*
* @Given /^I wait until I see the "([^"]*)" element$/
*/
public function iWaitUntilISee($selector) {
public function iWaitUntilISee($selector)
{
$page = $this->getSession()->getPage();
$this->spin(function ($page) use ($page, $selector) {
$element = $page->find('css', $selector);
@ -885,7 +947,8 @@ JS;
*
* @Given /^I wait until I see the text "([^"]*)"$/
*/
public function iWaitUntilISeeText($text){
public function iWaitUntilISeeText($text)
{
$page = $this->getSession()->getPage();
$session = $this->getSession();
$this->spin(function ($page) use ($page, $session, $text) {
@ -905,7 +968,8 @@ JS;
/**
* @Given /^I scroll to the bottom$/
*/
public function iScrollToBottom() {
public function iScrollToBottom()
{
$javascript = 'window.scrollTo(0, Math.max(document.documentElement.scrollHeight, document.body.scrollHeight, document.documentElement.clientHeight));';
$this->getSession()->executeScript($javascript);
}
@ -913,7 +977,8 @@ JS;
/**
* @Given /^I scroll to the top$/
*/
public function iScrollToTop() {
public function iScrollToTop()
{
$this->getSession()->executeScript('window.scrollTo(0,0);');
}
@ -926,7 +991,8 @@ JS;
*
* @Given /^I scroll to the "([^"]*)" (field|link|button)$/
*/
public function iScrollToField($locator, $type) {
public function iScrollToField($locator, $type)
{
$page = $this->getSession()->getPage();
$el = $page->find('named', array($type, "'$locator'"));
assertNotNull($el, sprintf('%s element not found', $locator));
@ -948,7 +1014,8 @@ JS;
*
* @Given /^I scroll to the "(?P<locator>(?:[^"]|\\")*)" element$/
*/
public function iScrollToElement($locator) {
public function iScrollToElement($locator)
{
$el = $this->getSession()->getPage()->find('css', $locator);
assertNotNull($el, sprintf('The element "%s" is not found', $locator));
@ -971,7 +1038,8 @@ JS;
* @return bool Returns true if the lambda returns successfully
* @throws \Exception Thrown if the wait threshold is exceeded without the lambda successfully returning
*/
public function spin($lambda, $wait = 60) {
public function spin($lambda, $wait = 60)
{
for ($i = 0; $i < $wait; $i++) {
try {
if ($lambda($this)) {
@ -998,8 +1066,8 @@ JS;
/**
* We have to catch exceptions and log somehow else otherwise behat falls over
*/
protected function logException($e){
protected function logException($e)
{
file_put_contents('php://stderr', 'Exception caught: '.$e);
}
}

25
src/SilverStripe/BehatExtension/Context/EmailContext.php
View File

@ -2,15 +2,15 @@
namespace SilverStripe\BehatExtension\Context;
use Behat\Behat\Context\ClosuredContextInterface,
Behat\Behat\Context\TranslatedContextInterface,
Behat\Behat\Context\BehatContext,
Behat\Behat\Context\Step,
Behat\Behat\Event\FeatureEvent,
Behat\Behat\Event\ScenarioEvent,
Behat\Behat\Exception\PendingException;
use Behat\Gherkin\Node\PyStringNode,
Behat\Gherkin\Node\TableNode;
use Behat\Behat\Context\ClosuredContextInterface;
use Behat\Behat\Context\TranslatedContextInterface;
use Behat\Behat\Context\BehatContext;
use Behat\Behat\Context\Step;
use Behat\Behat\Event\FeatureEvent;
use Behat\Behat\Event\ScenarioEvent;
use Behat\Behat\Exception\PendingException;
use Behat\Gherkin\Node\PyStringNode;
use Behat\Gherkin\Node\TableNode;
use Symfony\Component\DomCrawler\Crawler;
// PHPUnit
@ -87,7 +87,9 @@ class EmailContext extends BehatContext
$from = ($direction == 'from') ? $email : null;
$match = $this->mailer->findEmail($to, $from, $subject);
$allMails = $this->mailer->findEmails($to, $from);
$allTitles = $allMails ? '"' . implode('","', array_map(function($email) {return $email->Subject;}, $allMails)) . '"' : null;
$allTitles = $allMails ? '"' . implode('","', array_map(function ($email) {
return $email->Subject;
}, $allMails)) . '"' : null;
if (trim($negate)) {
assertNull($match);
} else {
@ -230,7 +232,8 @@ class EmailContext extends BehatContext
* Assumes an email has been identified by a previous step.
* @Then /^the email should (not |)contain the following data:$/
*/
public function theEmailContainFollowingData($negate, TableNode $table) {
public function theEmailContainFollowingData($negate, TableNode $table)
{
if (!$this->lastMatchedEmail) {
throw new \LogicException('No matched email found from previous step');
}

184
src/SilverStripe/BehatExtension/Context/FixtureContext.php
View File

@ -2,18 +2,16 @@
namespace SilverStripe\BehatExtension\Context;
use Behat\Behat\Context\BehatContext,
Behat\Behat\Event\ScenarioEvent,
Behat\Gherkin\Node\PyStringNode,
Behat\Gherkin\Node\TableNode,
SilverStripe\Filesystem\Storage\AssetStore;
use Behat\Behat\Context\BehatContext;
use Behat\Behat\Event\ScenarioEvent;
use Behat\Gherkin\Node\PyStringNode;
use Behat\Gherkin\Node\TableNode;
use SilverStripe\Filesystem\Storage\AssetStore;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\Versioning\Versioned;
use SilverStripe\Security\Permission;
// PHPUnit
require_once BASE_PATH . '/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php';
@ -46,18 +44,21 @@ class FixtureContext extends BehatContext
*/
protected $createdAssets = array();
public function __construct(array $parameters) {
public function __construct(array $parameters)
{
$this->context = $parameters;
}
public function getSession($name = null) {
public function getSession($name = null)
{
return $this->getMainContext()->getSession($name);
}
/**
* @return \FixtureFactory
*/
public function getFixtureFactory() {
public function getFixtureFactory()
{
if (!$this->fixtureFactory) {
$this->fixtureFactory = \Injector::inst()->create('FixtureFactory', 'FixtureContextFactory');
}
@ -67,28 +68,32 @@ class FixtureContext extends BehatContext
/**
* @param \FixtureFactory $factory
*/
public function setFixtureFactory(\FixtureFactory $factory) {
public function setFixtureFactory(\FixtureFactory $factory)
{
$this->fixtureFactory = $factory;
}
/**
* @param String
*/
public function setFilesPath($path) {
public function setFilesPath($path)
{
$this->filesPath = $path;
}
/**
* @return String
*/
public function getFilesPath() {
public function getFilesPath()
{
return $this->filesPath;
}
/**
* @BeforeScenario @database-defaults
*/
public function beforeDatabaseDefaults(ScenarioEvent $event) {
public function beforeDatabaseDefaults(ScenarioEvent $event)
{
\SapphireTest::empty_temp_db();
DB::get_conn()->quiet();
$dataClasses = \ClassInfo::subclassesFor('SilverStripe\\ORM\\DataObject');
@ -101,14 +106,16 @@ class FixtureContext extends BehatContext
/**
* @AfterScenario
*/
public function afterResetDatabase(ScenarioEvent $event) {
public function afterResetDatabase(ScenarioEvent $event)
{
\SapphireTest::empty_temp_db();
}
/**
* @AfterScenario
*/
public function afterResetAssets(ScenarioEvent $event) {
public function afterResetAssets(ScenarioEvent $event)
{
$store = $this->getAssetStore();
if (is_array($this->createdAssets)) {
foreach ($this->createdAssets as $asset) {
@ -122,7 +129,8 @@ class FixtureContext extends BehatContext
*
* @Given /^(?:(an|a|the) )"(?<type>[^"]+)" "(?<id>[^"]+)"$/
*/
public function stepCreateRecord($type, $id) {
public function stepCreateRecord($type, $id)
{
$class = $this->convertTypeToClass($type);
$fields = $this->prepareFixture($class, $id);
$this->fixtureFactory->createObject($class, $id, $fields);
@ -133,7 +141,8 @@ class FixtureContext extends BehatContext
*
* @Given /^(?:(an|a|the) )"(?<type>[^"]+)" "(?<id>[^"]+)" has (?:(an|a|the) )"(?<field>.*)" "(?<value>.*)"$/
*/
public function stepCreateRecordHasField($type, $id, $field, $value) {
public function stepCreateRecordHasField($type, $id, $field, $value)
{
$class = $this->convertTypeToClass($type);
$fields = $this->convertFields(
$class,
@ -157,7 +166,8 @@ class FixtureContext extends BehatContext
*
* @Given /^(?:(an|a|the) )"(?<type>[^"]+)" "(?<id>[^"]+)" (?:(with|has)) (?<data>".*)$/
*/
public function stepCreateRecordWithData($type, $id, $data) {
public function stepCreateRecordWithData($type, $id, $data)
{
$class = $this->convertTypeToClass($type);
preg_match_all(
'/"(?<key>[^"]+)"\s*=\s*"(?<value>[^"]+)"/',
@ -189,7 +199,8 @@ class FixtureContext extends BehatContext
*
* @Given /^(?:(an|a|the) )"(?<type>[^"]+)" "(?<id>[^"]+)" has the following data$/
*/
public function stepCreateRecordWithTable($type, $id, $null, TableNode $fieldsTable) {
public function stepCreateRecordWithTable($type, $id, $null, TableNode $fieldsTable)
{
$class = $this->convertTypeToClass($type);
// TODO Support more than one record
$fields = $this->convertFields($class, $fieldsTable->getRowsHash());
@ -213,12 +224,15 @@ class FixtureContext extends BehatContext
*
* @Given /^(?:(an|a|the) )"(?<type>[^"]+)" "(?<id>[^"]+)" is a (?<relation>[^\s]*) of (?:(an|a|the) )"(?<relationType>[^"]+)" "(?<relationId>[^"]+)"/
*/
public function stepUpdateRecordRelation($type, $id, $relation, $relationType, $relationId) {
public function stepUpdateRecordRelation($type, $id, $relation, $relationType, $relationId)
{
$class = $this->convertTypeToClass($type);
$relationClass = $this->convertTypeToClass($relationType);
$relationObj = $this->fixtureFactory->get($relationClass, $relationId);
if(!$relationObj) $relationObj = $this->fixtureFactory->createObject($relationClass, $relationId);
if (!$relationObj) {
$relationObj = $this->fixtureFactory->createObject($relationClass, $relationId);
}
$data = array();
if ($relation == 'child') {
@ -243,7 +257,8 @@ class FixtureContext extends BehatContext
break;
default:
throw new \InvalidArgumentException(sprintf(
'Invalid relation "%s"', $relation
'Invalid relation "%s"',
$relation
));
}
}
@ -255,7 +270,8 @@ class FixtureContext extends BehatContext
* @example I assign the "TaxonomyTerm" "For customers" to the "Page" "Page1"
* @Given /^I assign (?:(an|a|the) )"(?<type>[^"]+)" "(?<value>[^"]+)" to (?:(an|a|the) )"(?<relationType>[^"]+)" "(?<relationId>[^"]+)"$/
*/
public function stepIAssignObjToObj($type, $value, $relationType, $relationId) {
public function stepIAssignObjToObj($type, $value, $relationType, $relationId)
{
self::stepIAssignObjToObjInTheRelation($type, $value, $relationType, $relationId, null);
}
@ -267,28 +283,37 @@ class FixtureContext extends BehatContext
* @example I assign the "TaxonomyTerm" "For customers" to the "Page" "Page1" in the "Terms" relation
* @Given /^I assign (?:(an|a|the) )"(?<type>[^"]+)" "(?<value>[^"]+)" to (?:(an|a|the) )"(?<relationType>[^"]+)" "(?<relationId>[^"]+)" in the "(?<relationName>[^"]+)" relation$/
*/
public function stepIAssignObjToObjInTheRelation($type, $value, $relationType, $relationId, $relationName) {
public function stepIAssignObjToObjInTheRelation($type, $value, $relationType, $relationId, $relationName)
{
$class = $this->convertTypeToClass($type);
$relationClass = $this->convertTypeToClass($relationType);
// Check if this fixture object already exists - if not, we create it
$relationObj = $this->fixtureFactory->get($relationClass, $relationId);
if(!$relationObj) $relationObj = $this->fixtureFactory->createObject($relationClass, $relationId);
if (!$relationObj) {
$relationObj = $this->fixtureFactory->createObject($relationClass, $relationId);
}
// Check if there is relationship defined in many_many (includes belongs_many_many)
$manyField = null;
$oneField = null;
if ($relationObj->many_many()) {
$manyField = array_search($class, $relationObj->many_many());
if($manyField && strlen($relationName) > 0) $manyField = $relationName;
if ($manyField && strlen($relationName) > 0) {
$manyField = $relationName;
}
}
if (empty($manyField) && $relationObj->has_many()) {
$manyField = array_search($class, $relationObj->has_many());
if($manyField && strlen($relationName) > 0) $manyField = $relationName;
if ($manyField && strlen($relationName) > 0) {
$manyField = $relationName;
}
}
if (empty($manyField) && $relationObj->has_one()) {
$oneField = array_search($class, $relationObj->has_one());
if($oneField && strlen($relationName) > 0) $oneField = $relationName;
if ($oneField && strlen($relationName) > 0) {
$oneField = $relationName;
}
}
if (empty($manyField) && empty($oneField)) {
throw new \Exception("'$relationClass' has no relationship (has_one, has_many and many_many) with '$class'!");
@ -296,13 +321,19 @@ class FixtureContext extends BehatContext
// Get the searchable field to check if the fixture object already exists
$temObj = new $class;
if(isset($temObj->Name)) $field = "Name";
else if(isset($temObj->Title)) $field = "Title";
else $field = "ID";
if (isset($temObj->Name)) {
$field = "Name";
} elseif (isset($temObj->Title)) {
$field = "Title";
} else {
$field = "ID";
}
// Check if the fixture object exists - if not, we create it
$obj = DataObject::get($class)->filter($field, $value)->first();
if(!$obj) $obj = $this->fixtureFactory->createObject($class, $value);
if (!$obj) {
$obj = $this->fixtureFactory->createObject($class, $value);
}
// If has_many or many_many, add this fixture object to the relation object
// If has_one, set value to the joint field with this fixture object's ID
if ($manyField) {
@ -321,7 +352,8 @@ class FixtureContext extends BehatContext
*
* @Given /^(?:(an|a|the) )"(?<type>[^"]+)" "(?<id>[^"]+)" is (?<state>[^"]*)$/
*/
public function stepUpdateRecordState($type, $id, $state) {
public function stepUpdateRecordState($type, $id, $state)
{
$class = $this->convertTypeToClass($type);
/** @var DataObject|Versioned $obj */
$obj = $this->fixtureFactory->get($class, $id);
@ -350,7 +382,8 @@ class FixtureContext extends BehatContext
break;
default:
throw new \InvalidArgumentException(sprintf(
'Invalid state: "%s"', $state
'Invalid state: "%s"',
$state
));
}
}
@ -366,7 +399,8 @@ class FixtureContext extends BehatContext
*
* @Given /^there are the following ([^\s]*) records$/
*/
public function stepThereAreTheFollowingRecords($dataObject, PyStringNode $string) {
public function stepThereAreTheFollowingRecords($dataObject, PyStringNode $string)
{
$yaml = array_merge(array($dataObject . ':'), $string->getLines());
$yaml = implode("\n ", $yaml);
@ -381,9 +415,12 @@ class FixtureContext extends BehatContext
*
* @Given /^(?:(an|a|the) )"member" "(?<id>[^"]+)" belonging to "(?<groupId>[^"]+)"$/
*/
public function stepCreateMemberWithGroup($id, $groupId) {
public function stepCreateMemberWithGroup($id, $groupId)
{
$group = $this->fixtureFactory->get('SilverStripe\\Security\\Group', $groupId);
if(!$group) $group = $this->fixtureFactory->createObject('SilverStripe\\Security\\Group', $groupId);
if (!$group) {
$group = $this->fixtureFactory->createObject('SilverStripe\\Security\\Group', $groupId);
}
$member = $this->fixtureFactory->createObject('SilverStripe\\Security\\Member', $id);
$member->Groups()->add($group);
@ -394,7 +431,8 @@ class FixtureContext extends BehatContext
*
* @Given /^(?:(an|a|the) )"member" "(?<id>[^"]+)" belonging to "(?<groupId>[^"]+)" with (?<data>.*)$/
*/
public function stepCreateMemberWithGroupAndData($id, $groupId, $data) {
public function stepCreateMemberWithGroupAndData($id, $groupId, $data)
{
$class = 'SilverStripe\\Security\\Member';
preg_match_all(
'/"(?<key>[^"]+)"\s*=\s*"(?<value>[^"]+)"/',
@ -407,7 +445,9 @@ class FixtureContext extends BehatContext
);
$group = $this->fixtureFactory->get('SilverStripe\\Security\\Group', $groupId);
if(!$group) $group = $this->fixtureFactory->createObject('SilverStripe\\Security\\Group', $groupId);
if (!$group) {
$group = $this->fixtureFactory->createObject('SilverStripe\\Security\\Group', $groupId);
}
$member = $this->fixtureFactory->createObject($class, $id, $fields);
$member->Groups()->add($group);
@ -418,20 +458,22 @@ class FixtureContext extends BehatContext
*
* @Given /^(?:(an|a|the) )"group" "(?<id>[^"]+)" (?:(with|has)) permissions (?<permissionStr>.*)$/
*/
public function stepCreateGroupWithPermissions($id, $permissionStr) {
public function stepCreateGroupWithPermissions($id, $permissionStr)
{
// Convert natural language permissions to codes
preg_match_all('/"([^"]+)"/', $permissionStr, $matches);
$permissions = $matches[1];
$codes = Permission::get_codes(false);
$group = $this->fixtureFactory->get('SilverStripe\\Security\\Group', $id);
if(!$group) $group = $this->fixtureFactory->createObject('SilverStripe\\Security\\Group', $id);
if (!$group) {
$group = $this->fixtureFactory->createObject('SilverStripe\\Security\\Group', $id);
}
foreach ($permissions as $permission) {
$found = false;
foreach ($codes as $code => $details) {
if(
$permission == $code
if ($permission == $code
|| $permission == $details['name']
) {
Permission::grant($group->ID, $code);
@ -440,7 +482,8 @@ class FixtureContext extends BehatContext
}
if (!$found) {
throw new \InvalidArgumentException(sprintf(
'No permission found for "%s"', $permission
'No permission found for "%s"',
$permission
));
}
}
@ -453,7 +496,8 @@ class FixtureContext extends BehatContext
*
* @Given /^I go to (?:(an|a|the) )"(?<type>[^"]+)" "(?<id>[^"]+)"/
*/
public function stepGoToNamedRecord($type, $id) {
public function stepGoToNamedRecord($type, $id)
{
$class = $this->convertTypeToClass($type);
$record = $this->fixtureFactory->get($class, $id);
if (!$record) {
@ -476,7 +520,8 @@ class FixtureContext extends BehatContext
*
* @Then /^there should be a (?<type>(file|folder) )"(?<path>[^"]*)"/
*/
public function stepThereShouldBeAFileOrFolder($type, $path) {
public function stepThereShouldBeAFileOrFolder($type, $path)
{
assertFileExists($this->joinPaths(BASE_PATH, $path));
}
@ -487,7 +532,8 @@ class FixtureContext extends BehatContext
*
* @Then /^there should be a filename "(?<filename>[^"]*)" with hash "(?<hash>[a-fA-Z0-9]+)"/
*/
public function stepThereShouldBeAFileWithTuple($filename, $hash) {
public function stepThereShouldBeAFileWithTuple($filename, $hash)
{
$exists = $this->getAssetStore()->exists($filename, $hash);
assertTrue((bool)$exists, "A file exists with filename $filename and hash $hash");
}
@ -498,7 +544,8 @@ class FixtureContext extends BehatContext
*
* @Transform /^([^"]+)$/
*/
public function lookupFixtureReference($string) {
public function lookupFixtureReference($string)
{
if (preg_match('/^=>/', $string)) {
list($className, $identifier) = explode('.', preg_replace('/^=>/', '', $string), 2);
$id = $this->fixtureFactory->getId($className, $identifier);
@ -517,7 +564,8 @@ class FixtureContext extends BehatContext
/**
* @Given /^(?:(an|a|the) )"(?<type>[^"]*)" "(?<id>[^"]*)" was (?<mod>(created|last edited)) "(?<time>[^"]*)"$/
*/
public function aRecordWasLastEditedRelative($type, $id, $mod, $time) {
public function aRecordWasLastEditedRelative($type, $id, $mod, $time)
{
$class = $this->convertTypeToClass($type);
$fields = $this->prepareFixture($class, $id);
$record = $this->fixtureFactory->createObject($class, $id, $fields);
@ -545,15 +593,19 @@ class FixtureContext extends BehatContext
* @param array $data
* @return array Prepared $data with additional injected fields
*/
protected function prepareFixture($class, $identifier, $data = array()) {
protected function prepareFixture($class, $identifier, $data = array())
{
if ($class == 'File' || is_subclass_of($class, 'File')) {
$data = $this->prepareAsset($class, $identifier, $data);
}
return $data;
}
protected function prepareAsset($class, $identifier, $data = null) {
if(!$data) $data = array();
protected function prepareAsset($class, $identifier, $data = null)
{
if (!$data) {
$data = array();
}
$relativeTargetPath = (isset($data['Filename'])) ? $data['Filename'] : $identifier;
$relativeTargetPath = preg_replace('/^' . ASSETS_DIR . '\/?/', '', $relativeTargetPath);
$sourcePath = $this->joinPaths($this->getFilesPath(), basename($relativeTargetPath));
@ -604,7 +656,8 @@ class FixtureContext extends BehatContext
*
* @return AssetStore
*/
protected function getAssetStore() {
protected function getAssetStore()
{
return singleton('AssetStore');
}
@ -616,7 +669,8 @@ class FixtureContext extends BehatContext
* @param String
* @return String Class name
*/
protected function convertTypeToClass($type) {
protected function convertTypeToClass($type)
{
$type = trim($type);
// Try direct mapping
@ -646,25 +700,31 @@ class FixtureContext extends BehatContext
* @param array $fields Map of field names or aliases to their values.
* @return array Map of actual object properties to their values.
*/
protected function convertFields($class, $fields) {
protected function convertFields($class, $fields)
{
$labels = singleton($class)->fieldLabels();
foreach ($fields as $fieldName => $fieldVal) {
if ($fieldLabelKey = array_search($fieldName, $labels)) {
unset($fields[$fieldName]);
$fields[$labels[$fieldLabelKey]] = $fieldVal;
}
}
return $fields;
}
protected function joinPaths() {
protected function joinPaths()
{
$args = func_get_args();
$paths = array();
foreach($args as $arg) $paths = array_merge($paths, (array)$arg);
foreach($paths as &$path) $path = trim($path, '/');
if (substr($args[0], 0, 1) == '/') $paths[0] = '/' . $paths[0];
foreach ($args as $arg) {
$paths = array_merge($paths, (array)$arg);
}
foreach ($paths as &$path) {
$path = trim($path, '/');
}
if (substr($args[0], 0, 1) == '/') {
$paths[0] = '/' . $paths[0];
}
return join('/', $paths);
}
}

14
src/SilverStripe/BehatExtension/Context/Initializer/SilverStripeAwareInitializer.php
View File

@ -2,8 +2,8 @@
namespace SilverStripe\BehatExtension\Context\Initializer;
use Behat\Behat\Context\Initializer\InitializerInterface,
Behat\Behat\Context\ContextInterface;
use Behat\Behat\Context\Initializer\InitializerInterface;
use Behat\Behat\Context\ContextInterface;
use SilverStripe\BehatExtension\Context\SilverStripeAwareContextInterface;
@ -122,7 +122,9 @@ class SilverStripeAwareInitializer implements InitializerInterface
public function setAjaxSteps($ajaxSteps)
{
if($ajaxSteps) $this->ajaxSteps = $ajaxSteps;
if ($ajaxSteps) {
$this->ajaxSteps = $ajaxSteps;
}
}
public function getAjaxSteps()
@ -170,11 +172,13 @@ class SilverStripeAwareInitializer implements InitializerInterface
return $this->screenshotPath;
}
public function getRegionMap(){
public function getRegionMap()
{
return $this->regionMap;
}
public function setRegionMap($regionMap) {
public function setRegionMap($regionMap)
{
$this->regionMap = $regionMap;
}

4
src/SilverStripe/BehatExtension/Context/LoginContext.php
View File

@ -8,8 +8,6 @@ use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Group;
use SilverStripe\Security\Member;
// PHPUnit
require_once BASE_PATH . '/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php';
@ -70,7 +68,7 @@ class LoginContext extends BehatContext
*
* @Given /^I am logged in with "([^"]*)" permissions$/
*/
function iAmLoggedInWithPermissions($permCode)
public function iAmLoggedInWithPermissions($permCode)
{
if (!isset($this->cache_generatedMembers[$permCode])) {
$group = Group::get()->filter('Title', "$permCode group")->first();

133
src/SilverStripe/BehatExtension/Context/SilverStripeContext.php
View File

@ -2,16 +2,16 @@
namespace SilverStripe\BehatExtension\Context;
use Behat\Behat\Context\Step,
Behat\Behat\Event\FeatureEvent,
Behat\Behat\Event\ScenarioEvent,
Behat\Behat\Event\SuiteEvent;
use Behat\Behat\Context\Step;
use Behat\Behat\Event\FeatureEvent;
use Behat\Behat\Event\ScenarioEvent;
use Behat\Behat\Event\SuiteEvent;
use Behat\Gherkin\Node\PyStringNode;
use Behat\MinkExtension\Context\MinkContext;
use Behat\Mink\Driver\GoutteDriver,
Behat\Mink\Driver\Selenium2Driver,
Behat\Mink\Exception\UnsupportedDriverActionException,
Behat\Mink\Exception\ElementNotFoundException;
use Behat\Mink\Driver\GoutteDriver;
use Behat\Mink\Driver\Selenium2Driver;
use Behat\Mink\Exception\UnsupportedDriverActionException;
use Behat\Mink\Exception\ElementNotFoundException;
use SilverStripe\BehatExtension\Context\SilverStripeAwareContextInterface;
@ -72,61 +72,77 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
*
* @param array $parameters context parameters (set them up through behat.yml)
*/
public function __construct(array $parameters) {
public function __construct(array $parameters)
{
// Initialize your context here
$this->context = $parameters;
$this->testSessionEnvironment = new \TestSessionEnvironment();
}
public function setDatabase($databaseName) {
public function setDatabase($databaseName)
{
$this->databaseName = $databaseName;
}
public function setAjaxSteps($ajaxSteps) {
if($ajaxSteps) $this->ajaxSteps = $ajaxSteps;
public function setAjaxSteps($ajaxSteps)
{
if ($ajaxSteps) {
$this->ajaxSteps = $ajaxSteps;
}
}
public function getAjaxSteps() {
public function getAjaxSteps()
{
return $this->ajaxSteps;
}
public function setAjaxTimeout($ajaxTimeout) {
public function setAjaxTimeout($ajaxTimeout)
{
$this->ajaxTimeout = $ajaxTimeout;
}
public function getAjaxTimeout() {
public function getAjaxTimeout()
{
return $this->ajaxTimeout;
}
public function setAdminUrl($adminUrl) {
public function setAdminUrl($adminUrl)
{
$this->adminUrl = $adminUrl;
}
public function getAdminUrl() {
public function getAdminUrl()
{
return $this->adminUrl;
}
public function setLoginUrl($loginUrl) {
public function setLoginUrl($loginUrl)
{
$this->loginUrl = $loginUrl;
}
public function getLoginUrl() {
public function getLoginUrl()
{
return $this->loginUrl;
}
public function setScreenshotPath($screenshotPath) {
public function setScreenshotPath($screenshotPath)
{
$this->screenshotPath = $screenshotPath;
}
public function getScreenshotPath() {
public function getScreenshotPath()
{
return $this->screenshotPath;
}
public function getRegionMap(){
public function getRegionMap()
{
return $this->regionMap;
}
public function setRegionMap($regionMap){
public function setRegionMap($regionMap)
{
$this->regionMap = $regionMap;
}
@ -138,7 +154,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
* @param String $region Region name or CSS selector
* @return MinkElement|null
*/
public function getRegionObj($region) {
public function getRegionObj($region)
{
// Try to find regions directly by CSS selector.
try {
$regionObj = $this->getSession()->getPage()->find(
@ -184,7 +201,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
/**
* @BeforeScenario
*/
public function before(ScenarioEvent $event) {
public function before(ScenarioEvent $event)
{
if (!isset($this->databaseName)) {
throw new \LogicException(
'Context\'s $databaseName has to be set when implementing SilverStripeAwareContextInterface.'
@ -224,7 +242,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
*
* @return array
*/
public function getTestSessionState() {
public function getTestSessionState()
{
$extraParams = array();
parse_str(getenv('TESTSESSION_PARAMS'), $extraParams);
return array_merge(
@ -242,7 +261,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
* @param $url
* @return array|mixed Parsed URL
*/
public function parseUrl($url) {
public function parseUrl($url)
{
$url = parse_url($url);
$url['vars'] = array();
if (!isset($url['fragment'])) {
@ -263,7 +283,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
* @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) {
public function isCurrentUrlSimilarTo($url)
{
$current = $this->parseUrl($this->getSession()->getCurrentUrl());
$test = $this->parseUrl($url);
@ -291,7 +312,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
*
* @return string
*/
public function getBaseUrl() {
public function getBaseUrl()
{
return $this->getMinkParameter('base_url') ?: '';
}
@ -304,7 +326,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
* @return string
* @throws \InvalidArgumentException
*/
public function joinUrlParts() {
public function joinUrlParts()
{
if (0 === func_num_args()) {
throw new \InvalidArgumentException('Need at least one argument');
}
@ -318,12 +341,12 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
return implode('/', $parts);
}
public function canIntercept() {
public function canIntercept()
{
$driver = $this->getSession()->getDriver();
if ($driver instanceof GoutteDriver) {
return true;
}
else {
} else {
if ($driver instanceof Selenium2Driver) {
return false;
}
@ -336,7 +359,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
/**
* @Given /^(.*) without redirection$/
*/
public function theRedirectionsAreIntercepted($step) {
public function theRedirectionsAreIntercepted($step)
{
if ($this->canIntercept()) {
$this->getSession()->getDriver()->getClient()->followRedirects(false);
}
@ -348,39 +372,51 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
* 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) {
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 ($fields) {
foreach ($fields as $f) {
if ($f->isVisible()) {
$f->setValue($value);
return;
}
}
}
throw new ElementNotFoundException(
$this->getSession(), 'form field', 'id|name|label|value', $field
$this->getSession(),
'form field',
'id|name|label|value',
$field
);
}
/**
* Overwritten to click the first *visable* link the DOM.
*/
public function clickLink($link) {
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 ($links) {
foreach ($links as $l) {
if ($l->isVisible()) {
$l->click();
return;
}
}
}
throw new ElementNotFoundException(
$this->getSession(), 'link', 'id|name|label|value', $link
$this->getSession(),
'link',
'id|name|label|value',
$link
);
}
@ -392,7 +428,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
*
* @Given /^the current date is "([^"]*)"$/
*/
public function givenTheCurrentDateIs($date) {
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));
@ -415,7 +452,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
*
* @Given /^the current time is "([^"]*)"$/
*/
public function givenTheCurrentTimeIs($time) {
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));
@ -435,7 +473,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
*
* @override /^(?:|I )select "(?P<option>(?:[^"]|\\")*)" from "(?P<select>(?:[^"]|\\")*)"$/
*/
public function selectOption($select, $option) {
public function selectOption($select, $option)
{
// Find field
$field = $this
->getSession()
@ -457,7 +496,8 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
*
* @When /^(?:|I )select "(?P<option>(?:[^"]|\\")*)" from "(?P<select>(?:[^"]|\\")*)" with javascript$/
*/
public function selectOptionWithJavascript($select, $option) {
public function selectOptionWithJavascript($select, $option)
{
$select = $this->fixStepArgument($select);
$option = $this->fixStepArgument($option);
$page = $this->getSession()->getPage();
@ -480,7 +520,9 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
$value = $field->getValue();
$newValue = $opt->getAttribute('value');
if (is_array($value)) {
if(!in_array($newValue, $value)) $value[] = $newValue;
if (!in_array($newValue, $value)) {
$value[] = $newValue;
}
} else {
$value = $newValue;
}
@ -499,5 +541,4 @@ class SilverStripeContext extends MinkContext implements SilverStripeAwareContex
EOS;
$this->getSession()->getDriver()->executeScript($script);
}
}

13
src/SilverStripe/BehatExtension/Extension.php
View File

@ -2,10 +2,10 @@
namespace SilverStripe\BehatExtension;
use Symfony\Component\Config\FileLocator,
Symfony\Component\DependencyInjection\ContainerBuilder,
Symfony\Component\DependencyInjection\Loader\YamlFileLoader,
Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Behat\Behat\Extension\ExtensionInterface;
@ -41,7 +41,8 @@ class Extension implements ExtensionInterface
$loader->load('silverstripe.yml');
$behatBasePath = $container->getParameter('behat.paths.base');
$config['framework_path'] = realpath(sprintf('%s%s%s',
$config['framework_path'] = realpath(sprintf(
'%s%s%s',
rtrim($behatBasePath, DIRECTORY_SEPARATOR),
DIRECTORY_SEPARATOR,
ltrim($config['framework_path'], DIRECTORY_SEPARATOR)
@ -78,7 +79,7 @@ class Extension implements ExtensionInterface
*
* @param ArrayNodeDefinition $builder
*/
function getConfig(ArrayNodeDefinition $builder)
public function getConfig(ArrayNodeDefinition $builder)
{
$builder->
children()->

1
src/SilverStripe/BehatExtension/MinkExtension.php
View File

@ -16,5 +16,4 @@ class MinkExtension extends \Behat\MinkExtension\Extension
parent::getCompilerPasses()
);
}
}

61
src/SilverStripe/BehatExtension/Utility/TestMailer.php
View File

@ -7,14 +7,16 @@ namespace SilverStripe\BehatExtension\Utility;
* but saves emails in {@link TestSessionEnvironment}
* to share the state between PHP calls (CLI vs. browser).
*/
class TestMailer extends \Mailer {
class TestMailer extends \Mailer
{
/**
* @var TestSessionEnvironment
*/
protected $testSessionEnvironment;
public function __construct() {
public function __construct()
{
$this->testSessionEnvironment = \Injector::inst()->get('TestSessionEnvironment');
}
@ -22,7 +24,8 @@ class TestMailer extends \Mailer {
* Send a plain-text email.
* TestMailer will merely record that the email was asked to be sent, without sending anything.
*/
public function sendPlain($to, $from, $subject, $plainContent, $attachedFiles = false, $customHeaders = false) {
public function sendPlain($to, $from, $subject, $plainContent, $attachedFiles = false, $customHeaders = false)
{
$this->saveEmail(array(
'Type' => 'plain',
'To' => $to,
@ -41,8 +44,16 @@ class TestMailer extends \Mailer {
* Send a multi-part HTML email
* TestMailer will merely record that the email was asked to be sent, without sending anything.
*/
public function sendHTML($to, $from, $subject, $htmlContent, $attachedFiles = false, $customHeaders = false,
$plainContent = false, $inlineImages = false) {
public function sendHTML(
$to,
$from,
$subject,
$htmlContent,
$attachedFiles = false,
$customHeaders = false,
$plainContent = false,
$inlineImages = false
) {
$this->saveEmail(array(
'Type' => 'html',
@ -61,9 +72,12 @@ class TestMailer extends \Mailer {
/**
* Clear the log of emails sent
*/
public function clearEmails() {
public function clearEmails()
{
$state = $this->testSessionEnvironment->getState();
if(isset($state->emails)) unset($state->emails);
if (isset($state->emails)) {
unset($state->emails);
}
$this->testSessionEnvironment->applyState($state);
}
@ -78,7 +92,8 @@ class TestMailer extends \Mailer {
* @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles',
* 'customHeaders', 'htmlContent', 'inlineImages'
*/
public function findEmail($to = null, $from = null, $subject = null, $content = null) {
public function findEmail($to = null, $from = null, $subject = null, $content = null)
{
$matches = $this->findEmails($to, $from, $subject, $content);
//got the count of matches emails
$emailCount = count($matches);
@ -97,7 +112,8 @@ class TestMailer extends \Mailer {
* @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles',
* 'customHeaders', 'htmlContent', 'inlineImages'
*/
public function findEmails($to = null, $from = null, $subject = null, $content = null) {
public function findEmails($to = null, $from = null, $subject = null, $content = null)
{
$matches = array();
$args = func_get_args();
$state = $this->testSessionEnvironment->getState();
@ -106,25 +122,36 @@ class TestMailer extends \Mailer {
$matched = true;
foreach (array('To', 'From', 'Subject', 'Content') as $i => $field) {
if(!isset($email->$field)) continue;
if (!isset($email->$field)) {
continue;
}
$value = (isset($args[$i])) ? $args[$i] : null;
if ($value) {
if($value[0] == '/') $matched = preg_match($value, $email->$field);
else $matched = ($value == $email->$field);
if(!$matched) break;
if ($value[0] == '/') {
$matched = preg_match($value, $email->$field);
} else {
$matched = ($value == $email->$field);
}
if (!$matched) {
break;
}
}
if($matched) $matches[] = $email;
}
if ($matched) {
$matches[] = $email;
}
}
return $matches;
}
protected function saveEmail($data) {
protected function saveEmail($data)
{
$state = $this->testSessionEnvironment->getState();
if(!isset($state->emails)) $state->emails = array();
if (!isset($state->emails)) {
$state->emails = array();
}
$state->emails[] = array_filter($data);
$this->testSessionEnvironment->applyState($state);
}
}

25
tests/Context/SilverStripeContextTest.php
View File

@ -1,10 +1,11 @@
<?php
namespace SilverStripe\BehatExtension\Tests;
use SilverStripe\BehatExtension\Context\SilverStripeContext,
Behat\Mink\Mink;
use SilverStripe\BehatExtension\Context\SilverStripeContext;
use Behat\Mink\Mink;
class SilverStripeContextTest extends \PHPUnit_Framework_TestCase {
class SilverStripeContextTest extends \PHPUnit_Framework_TestCase
{
protected $backupGlobals = false;
@ -12,7 +13,8 @@ class SilverStripeContextTest extends \PHPUnit_Framework_TestCase {
* @expectedException \LogicException
* @expectedExceptionMessage Cannot find 'region_map' in the behat.yml
*/
public function testGetRegionObjThrowsExceptionOnUnknownSelector() {
public function testGetRegionObjThrowsExceptionOnUnknownSelector()
{
$context = $this->getContextMock();
$context->getRegionObj('.unknown');
}
@ -21,13 +23,15 @@ class SilverStripeContextTest extends \PHPUnit_Framework_TestCase {
* @expectedException \LogicException
* @expectedExceptionMessage Cannot find the specified region in the behat.yml
*/
public function testGetRegionObjThrowsExceptionOnUnknownRegion() {
public function testGetRegionObjThrowsExceptionOnUnknownRegion()
{
$context = $this->getContextMock();
$context->setRegionMap(array('MyRegion' => '.my-region'));
$context->getRegionObj('.unknown');
}
public function testGetRegionObjFindsBySelector() {
public function testGetRegionObjFindsBySelector()
{
$context = $this->getContextMock();
$context->getSession()->getPage()
->expects($this->any())
@ -37,7 +41,8 @@ class SilverStripeContextTest extends \PHPUnit_Framework_TestCase {
$this->assertNotNull($obj);
}
public function testGetRegionObjFindsByRegion() {
public function testGetRegionObjFindsByRegion()
{
$context = $this->getContextMock();
$el = $this->getElementMock();
$context->getSession()->getPage()
@ -51,7 +56,8 @@ class SilverStripeContextTest extends \PHPUnit_Framework_TestCase {
$this->assertNotNull($obj);
}
protected function getContextMock() {
protected function getContextMock()
{
$pageMock = $this->getMockBuilder('Behat\Mink\Element\DocumentElement')
->disableOriginalConstructor()
->setMethods(array('find'))
@ -75,7 +81,8 @@ class SilverStripeContextTest extends \PHPUnit_Framework_TestCase {
return $context;
}
protected function getElementMock() {
protected function getElementMock()
{
return $this->getMockBuilder('Behat\Mink\Element\Element')
->disableOriginalConstructor()
->getMock();

4
tests/bootstrap.php
View File

@ -1,5 +1,7 @@
<?php
$frameworkPath = __DIR__ . '/../framework';
$frameworkDir = basename($frameworkPath);
if(!defined('BASE_PATH')) define('BASE_PATH', dirname($frameworkPath));
if (!defined('BASE_PATH')) {
define('BASE_PATH', dirname($frameworkPath));
}
require_once $frameworkPath . '/core/Core.php';