veyra/friends-of-behat-mink-extension
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Simplify: fix fallback bug, reduce redundancy, restore step PHPDocs

Browse Source 
- FailureShowListener: fix show_tmp_dir fallback '' -> sys_get_temp_dir()
  (bug introduced by duplication with MinkContext::showLastResponse)
- SauceLabsFactory: simplify `is_bool($x) ? $x : (bool) $x` -> `(bool) $x`
- MinkExtension::load: extract $baseUrl/$browserName locals to avoid
  evaluating the same `?? ''` expression twice per line
- EnvironmentCapabilities: store TRAVIS_JOB_NUMBER and JENKINS_HOME
  getenv() results before the switch to avoid double calls per match
- MinkContext: restore PHPDoc comments on all step methods (Example lines
  for discoverability); keep PHP attributes, no @Given/@When/@Then tags

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Kamil Kokot
2026-06-12 17:50:42 +02:00
parent 47a9d45cd1
commit 2947994733
5 changed files with 210 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

198
src/Behat/MinkExtension/Context/MinkContext.php
View File

@@ -21,6 +21,12 @@ use Behat\Gherkin\Node\TableNode;
*/
class MinkContext extends RawMinkContext implements TranslatableContext
{
/**
* Opens homepage.
* Example: Given I am on "/"
* Example: When I go to "/"
* Example: And I go to "/".
*/
#[\Behat\Step\Given('/^(?:|I )am on (?:|the )homepage$/')]
#[\Behat\Step\When('/^(?:|I )go to (?:|the )homepage$/')]
public function iAmOnHomepage(): void
@@ -28,6 +34,12 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->visitPath('/');
}
/**
* Opens specified page.
* Example: Given I am on "http://batman.com"
* Example: And I am on "/articles/isBatmanBruceWayne"
* Example: When I go to "/articles/isBatmanBruceWayne".
*/
#[\Behat\Step\Given('/^(?:|I )am on "(?P<page>[^"]+)"$/')]
#[\Behat\Step\When('/^(?:|I )go to "(?P<page>[^"]+)"$/')]
public function visit(string $page): void
@@ -35,24 +47,42 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->visitPath($page);
}
/**
* Reloads current page.
* Example: When I reload the page
* Example: And I reload the page.
*/
#[\Behat\Step\When('/^(?:|I )reload the page$/')]
public function reload(): void
{
$this->getSession()->reload();
}
/**
* Moves backward one page in history.
* Example: When I move backward one page.
*/
#[\Behat\Step\When('/^(?:|I )move backward one page$/')]
public function back(): void
{
$this->getSession()->back();
}
/**
* Moves forward one page in history.
* Example: And I move forward one page.
*/
#[\Behat\Step\When('/^(?:|I )move forward one page$/')]
public function forward(): void
{
$this->getSession()->forward();
}
/**
* Presses button with specified id|name|title|alt|value.
* Example: When I press "Log In"
* Example: And I press "Log In".
*/
#[\Behat\Step\When('/^(?:|I )press "(?P<button>(?:[^"]|\\")*)"$/')]
public function pressButton(string $button): void
{
@@ -60,6 +90,11 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->getSession()->getPage()->pressButton($button);
}
/**
* Clicks link with specified id|title|alt|text.
* Example: When I follow "Log In"
* Example: And I follow "Log In".
*/
#[\Behat\Step\When('/^(?:|I )follow "(?P<link>(?:[^"]|\\")*)"$/')]
public function clickLink(string $link): void
{
@@ -67,6 +102,11 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->getSession()->getPage()->clickLink($link);
}
/**
* Fills in form field with specified id|name|label|value.
* Example: When I fill in "username" with: "bwayne"
* Example: And I fill in "bwayne" for "username".
*/
#[\Behat\Step\When('/^(?:|I )fill in "(?P<field>(?:[^"]|\\")*)" with "(?P<value>(?:[^"]|\\")*)"$/')]
#[\Behat\Step\When('/^(?:|I )fill in "(?P<field>(?:[^"]|\\")*)" with:$/')]
#[\Behat\Step\When('/^(?:|I )fill in "(?P<value>(?:[^"]|\\")*)" for "(?P<field>(?:[^"]|\\")*)"$/')]
@@ -77,6 +117,12 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->getSession()->getPage()->fillField($field, $value);
}
/**
* Fills in form fields with provided table.
* Example: When I fill in the following:
* | username | bruceWayne |
* | password | iLoveBats123 |.
*/
#[\Behat\Step\When('/^(?:|I )fill in the following:$/')]
public function fillFields(TableNode $fields): void
{
@@ -85,6 +131,11 @@ class MinkContext extends RawMinkContext implements TranslatableContext
}
}
/**
* Selects option in select field with specified id|name|label|value.
* Example: When I select "Bats" from "user_fears"
* Example: And I select "Bats" from "user_fears".
*/
#[\Behat\Step\When('/^(?:|I )select "(?P<option>(?:[^"]|\\")*)" from "(?P<select>(?:[^"]|\\")*)"$/')]
public function selectOption(string $select, string $option): void
{
@@ -93,6 +144,11 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->getSession()->getPage()->selectFieldOption($select, $option);
}
/**
* Selects additional option in select field with specified id|name|label|value.
* Example: When I additionally select "Deceased" from "parents_alive_status"
* Example: And I additionally select "Deceased" from "parents_alive_status".
*/
#[\Behat\Step\When('/^(?:|I )additionally select "(?P<option>(?:[^"]|\\")*)" from "(?P<select>(?:[^"]|\\")*)"$/')]
public function additionallySelectOption(string $select, string $option): void
{
@@ -101,6 +157,11 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->getSession()->getPage()->selectFieldOption($select, $option, true);
}
/**
* Checks checkbox with specified id|name|label|value.
* Example: When I check "Pearl Necklace"
* Example: And I check "Pearl Necklace".
*/
#[\Behat\Step\When('/^(?:|I )check "(?P<option>(?:[^"]|\\")*)"$/')]
public function checkOption(string $option): void
{
@@ -108,6 +169,11 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->getSession()->getPage()->checkField($option);
}
/**
* Unchecks checkbox with specified id|name|label|value.
* Example: When I uncheck "Broadway Plays"
* Example: And I uncheck "Broadway Plays".
*/
#[\Behat\Step\When('/^(?:|I )uncheck "(?P<option>(?:[^"]|\\")*)"$/')]
public function uncheckOption(string $option): void
{
@@ -115,6 +181,11 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->getSession()->getPage()->uncheckField($option);
}
/**
* Attaches file to field with specified id|name|label|value.
* Example: When I attach the file "bwayne_profile.png" to "profileImageUpload"
* Example: And I attach the file "bwayne_profile.png" to "profileImageUpload".
*/
#[\Behat\Step\When('/^(?:|I )attach the file "(?P<path>[^"]*)" to "(?P<field>(?:[^"]|\\")*)"$/')]
public function attachFileToField(string $field, string $path): void
{
@@ -134,108 +205,199 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->getSession()->getPage()->attachFileToField($field, $path);
}
/**
* Checks that current page PATH is equal to specified.
* Example: Then I should be on "/"
* Example: And I should be on "/bats"
* Example: And I should be on "http://google.com".
*/
#[\Behat\Step\Then('/^(?:|I )should be on "(?P<page>[^"]+)"$/')]
public function assertPageAddress(string $page): void
{
$this->assertSession()->addressEquals($this->locatePath($page));
}
/**
* Checks that current page is the homepage.
* Example: Then I should be on the homepage
* Example: And I should be on the homepage.
*/
#[\Behat\Step\Then('/^(?:|I )should be on (?:|the )homepage$/')]
public function assertHomepage(): void
{
$this->assertSession()->addressEquals($this->locatePath('/'));
}
/**
* Checks that current page PATH matches regular expression.
* Example: Then the url should match "superman is dead"
* Example: And the url should match "log in".
*/
#[\Behat\Step\Then('/^the (?i)url(?-i) should match (?P<pattern>"(?:[^"]|\\")*")$/')]
public function assertUrlRegExp(string $pattern): void
{
$this->assertSession()->addressMatches($this->fixStepArgument($pattern));
}
/**
* Checks that current page response status is equal to specified.
* Example: Then the response status code should be 200
* Example: And the response status code should be 400.
*/
#[\Behat\Step\Then('/^the response status code should be (?P<code>\d+)$/')]
public function assertResponseStatus(string $code): void
{
$this->assertSession()->statusCodeEquals((int) $code);
}
/**
* Checks that current page response status is not equal to specified.
* Example: Then the response status code should not be 501
* Example: And the response status code should not be 404.
*/
#[\Behat\Step\Then('/^the response status code should not be (?P<code>\d+)$/')]
public function assertResponseStatusIsNot(string $code): void
{
$this->assertSession()->statusCodeNotEquals((int) $code);
}
/**
* Checks that page contains specified text.
* Example: Then I should see "Who is the Batman?"
* Example: And I should see "Who is the Batman?".
*/
#[\Behat\Step\Then('/^(?:|I )should see "(?P<text>(?:[^"]|\\")*)"$/')]
public function assertPageContainsText(string $text): void
{
$this->assertSession()->pageTextContains($this->fixStepArgument($text));
}
/**
* Checks that page doesn't contain specified text.
* Example: Then I should not see "Batman is Bruce Wayne"
* Example: And I should not see "Batman is Bruce Wayne".
*/
#[\Behat\Step\Then('/^(?:|I )should not see "(?P<text>(?:[^"]|\\")*)"$/')]
public function assertPageNotContainsText(string $text): void
{
$this->assertSession()->pageTextNotContains($this->fixStepArgument($text));
}
/**
* Checks that page contains text matching specified pattern.
* Example: Then I should see text matching "Batman, the vigilante"
* Example: And I should not see "Batman, the vigilante".
*/
#[\Behat\Step\Then('/^(?:|I )should see text matching (?P<pattern>"(?:[^"]|\\")*")$/')]
public function assertPageMatchesText(string $pattern): void
{
$this->assertSession()->pageTextMatches($this->fixStepArgument($pattern));
}
/**
* Checks that page doesn't contain text matching specified pattern.
* Example: Then I should not see text matching "Bruce Wayne, the vigilante"
* Example: And I should not see "Bruce Wayne, the vigilante".
*/
#[\Behat\Step\Then('/^(?:|I )should not see text matching (?P<pattern>"(?:[^"]|\\")*")$/')]
public function assertPageNotMatchesText(string $pattern): void
{
$this->assertSession()->pageTextNotMatches($this->fixStepArgument($pattern));
}
/**
* Checks that HTML response contains specified string.
* Example: Then the response should contain "Batman is the hero Gotham deserves."
* Example: And the response should contain "Batman is the hero Gotham deserves.".
*/
#[\Behat\Step\Then('/^the response should contain "(?P<text>(?:[^"]|\\")*)"$/')]
public function assertResponseContains(string $text): void
{
$this->assertSession()->responseContains($this->fixStepArgument($text));
}
/**
* Checks that HTML response doesn't contain specified string.
* Example: Then the response should not contain "Bruce Wayne is a billionaire, play-boy, vigilante."
* Example: And the response should not contain "Bruce Wayne is a billionaire, play-boy, vigilante.".
*/
#[\Behat\Step\Then('/^the response should not contain "(?P<text>(?:[^"]|\\")*)"$/')]
public function assertResponseNotContains(string $text): void
{
$this->assertSession()->responseNotContains($this->fixStepArgument($text));
}
/**
* Checks that element with specified CSS contains specified text.
* Example: Then I should see "Batman" in the "heroes_list" element
* Example: And I should see "Batman" in the "heroes_list" element.
*/
#[\Behat\Step\Then('/^(?:|I )should see "(?P<text>(?:[^"]|\\")*)" in the "(?P<element>[^"]*)" element$/')]
public function assertElementContainsText(string $element, string $text): void
{
$this->assertSession()->elementTextContains('css', $element, $this->fixStepArgument($text));
}
/**
* Checks that element with specified CSS doesn't contain specified text.
* Example: Then I should not see "Bruce Wayne" in the "heroes_alter_egos" element
* Example: And I should not see "Bruce Wayne" in the "heroes_alter_egos" element.
*/
#[\Behat\Step\Then('/^(?:|I )should not see "(?P<text>(?:[^"]|\\")*)" in the "(?P<element>[^"]*)" element$/')]
public function assertElementNotContainsText(string $element, string $text): void
{
$this->assertSession()->elementTextNotContains('css', $element, $this->fixStepArgument($text));
}
/**
* Checks that element with specified CSS contains specified HTML.
* Example: Then the "body" element should contain "style=\"color:black;\""
* Example: And the "body" element should contain "style=\"color:black;\"".
*/
#[\Behat\Step\Then('/^the "(?P<element>[^"]*)" element should contain "(?P<value>(?:[^"]|\\")*)"$/')]
public function assertElementContains(string $element, string $value): void
{
$this->assertSession()->elementContains('css', $element, $this->fixStepArgument($value));
}
/**
* Checks that element with specified CSS doesn't contain specified HTML.
* Example: Then the "body" element should not contain "style=\"color:black;\""
* Example: And the "body" element should not contain "style=\"color:black;\"".
*/
#[\Behat\Step\Then('/^the "(?P<element>[^"]*)" element should not contain "(?P<value>(?:[^"]|\\")*)"$/')]
public function assertElementNotContains(string $element, string $value): void
{
$this->assertSession()->elementNotContains('css', $element, $this->fixStepArgument($value));
}
/**
* Checks that element with specified CSS exists on page.
* Example: Then I should see a "body" element
* Example: And I should see a "body" element.
*/
#[\Behat\Step\Then('/^(?:|I )should see an? "(?P<element>[^"]*)" element$/')]
public function assertElementOnPage(string $element): void
{
$this->assertSession()->elementExists('css', $element);
}
/**
* Checks that element with specified CSS doesn't exist on page.
* Example: Then I should not see a "canvas" element
* Example: And I should not see a "canvas" element.
*/
#[\Behat\Step\Then('/^(?:|I )should not see an? "(?P<element>[^"]*)" element$/')]
public function assertElementNotOnPage(string $element): void
{
$this->assertSession()->elementNotExists('css', $element);
}
/**
* Checks that form field with specified id|name|label|value has specified value.
* Example: Then the "username" field should contain "bwayne"
* Example: And the "username" field should contain "bwayne".
*/
#[\Behat\Step\Then('/^the "(?P<field>(?:[^"]|\\")*)" field should contain "(?P<value>(?:[^"]|\\")*)"$/')]
public function assertFieldContains(string $field, string $value): void
{
@@ -244,6 +406,11 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->assertSession()->fieldValueEquals($field, $value);
}
/**
* Checks that form field with specified id|name|label|value doesn't have specified value.
* Example: Then the "username" field should not contain "batman"
* Example: And the "username" field should not contain "batman".
*/
#[\Behat\Step\Then('/^the "(?P<field>(?:[^"]|\\")*)" field should not contain "(?P<value>(?:[^"]|\\")*)"$/')]
public function assertFieldNotContains(string $field, string $value): void
{
@@ -252,12 +419,22 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->assertSession()->fieldValueNotEquals($field, $value);
}
/**
* Checks that (?P<num>\d+) CSS elements exist on the page.
* Example: Then I should see 5 "div" elements
* Example: And I should see 5 "div" elements.
*/
#[\Behat\Step\Then('/^(?:|I )should see (?P<num>\d+) "(?P<element>[^"]*)" elements?$/')]
public function assertNumElements(string $num, string $element): void
{
$this->assertSession()->elementsCount('css', $element, intval($num));
}
/**
* Checks that checkbox with specified id|name|label|value is checked.
* Example: Then the "remember_me" checkbox should be checked
* Example: And the "remember_me" checkbox is checked.
*/
#[\Behat\Step\Then('/^the "(?P<checkbox>(?:[^"]|\\")*)" checkbox should be checked$/')]
#[\Behat\Step\Then('/^the "(?P<checkbox>(?:[^"]|\\")*)" checkbox is checked$/')]
#[\Behat\Step\Then('/^the checkbox "(?P<checkbox>(?:[^"]|\\")*)" (?:is|should be) checked$/')]
@@ -266,6 +443,12 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->assertSession()->checkboxChecked($this->fixStepArgument($checkbox));
}
/**
* Checks that checkbox with specified id|name|label|value is unchecked.
* Example: Then the "newsletter" checkbox should be unchecked
* Example: Then the "newsletter" checkbox should not be checked
* Example: And the "newsletter" checkbox is unchecked.
*/
#[\Behat\Step\Then('/^the "(?P<checkbox>(?:[^"]|\\")*)" checkbox should (?:be unchecked|not be checked)$/')]
#[\Behat\Step\Then('/^the "(?P<checkbox>(?:[^"]|\\")*)" checkbox is (?:unchecked|not checked)$/')]
#[\Behat\Step\Then('/^the checkbox "(?P<checkbox>(?:[^"]|\\")*)" should (?:be unchecked|not be checked)$/')]
@@ -275,12 +458,22 @@ class MinkContext extends RawMinkContext implements TranslatableContext
$this->assertSession()->checkboxNotChecked($this->fixStepArgument($checkbox));
}
/**
* Prints current URL to console.
* Example: Then print current URL
* Example: And print current URL.
*/
#[\Behat\Step\Then('/^print current URL$/')]
public function printCurrentUrl(): void
{
echo $this->getSession()->getCurrentUrl();
}
/**
* Prints last response to console.
* Example: Then print last response
* Example: And print last response.
*/
#[\Behat\Step\Then('/^print last response$/')]
public function printLastResponse(): void
{
@@ -289,6 +482,11 @@ class MinkContext extends RawMinkContext implements TranslatableContext
;
}
/**
* Opens last response content in browser.
* Example: Then show last response
* Example: And show last response.
*/
#[\Behat\Step\Then('/^show last response$/')]
public function showLastResponse(): void
{

2
src/Behat/MinkExtension/Listener/FailureShowListener.php
View File

@@ -81,7 +81,7 @@ class FailureShowListener implements EventSubscriberInterface
}
$showTmpDir = $this->parameters['show_tmp_dir'];
$filename = rtrim(is_string($showTmpDir) ? $showTmpDir : '', DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.uniqid().'.html';
$filename = rtrim(is_string($showTmpDir) ? $showTmpDir : sys_get_temp_dir(), DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.uniqid().'.html';
file_put_contents($filename, $this->mink->getSession()->getPage()->getContent());
system(sprintf(is_string($showCmd) ? $showCmd : '', escapeshellarg($filename)));
}

9
src/Behat/MinkExtension/ServiceContainer/Driver/EnvironmentCapabilities.php
View File

@@ -12,10 +12,13 @@ trait EnvironmentCapabilities
*/
private function guessEnvironmentCapabilities(): array
{
$travisJobNumber = getenv('TRAVIS_JOB_NUMBER');
$jenkinsHome = getenv('JENKINS_HOME');
switch (true) {
case (bool) getenv('TRAVIS_JOB_NUMBER'):
case (bool) $travisJobNumber:
return [
'tunnel-identifier' => getenv('TRAVIS_JOB_NUMBER'),
'tunnel-identifier' => $travisJobNumber,
'build' => getenv('TRAVIS_BUILD_NUMBER'),
'tags' => [
'Travis-CI',
@@ -23,7 +26,7 @@ trait EnvironmentCapabilities
],
];
case (bool) getenv('JENKINS_HOME'):
case (bool) $jenkinsHome:
return [
'tunnel-identifier' => getenv('JOB_NAME'),
'build' => getenv('BUILD_NUMBER'),

2
src/Behat/MinkExtension/ServiceContainer/Driver/SauceLabsFactory.php
View File

@@ -39,7 +39,7 @@ class SauceLabsFactory extends Selenium2Factory
public function buildDriver(array $config): Definition
{
$host = 'ondemand.saucelabs.com';
if (is_bool($config['connect']) ? $config['connect'] : (bool) $config['connect']) {
if ((bool) $config['connect']) {
$host = 'localhost:4445';
}

6
src/Behat/MinkExtension/ServiceContainer/MinkExtension.php
View File

@@ -98,8 +98,10 @@ class MinkExtension implements ExtensionInterface
unset($config['sessions']);
$container->setParameter('mink.parameters', $config);
$container->setParameter('mink.base_url', is_string($config['base_url'] ?? '') ? ($config['base_url'] ?? '') : '');
$container->setParameter('mink.browser_name', is_string($config['browser_name'] ?? '') ? ($config['browser_name'] ?? '') : '');
$baseUrl = $config['base_url'] ?? '';
$container->setParameter('mink.base_url', is_string($baseUrl) ? $baseUrl : '');
$browserName = $config['browser_name'] ?? '';
$container->setParameter('mink.browser_name', is_string($browserName) ? $browserName : '');
}
public function configure(ArrayNodeDefinition $builder): void