Behat Autotesting. BDD Behaviour Driven Development

 behat -dl

.gitignore
/tests/bin
/tests/config.local
/tests/vendor

$ ./bin/behat
No scenarios
No steps
0m0.27s (26.79Mb)

Gherkin is a structured way to describe the expected behaviour of a feature

$ ./bin/behat --story-syntax
Testing the homepage

$ ./bin/behat --append-snippets
u features/bootstrap/FeatureContext.php - `I should see the welcome text` definition added

$ behat -di
  
default | Given I am logged in as a(n) :role
        | at `FeatureContext::iAmLoggedInAsAn()`
default | When I go to :path
        | at `FeatureContext::iGoTo()`
default | When I submit the form
        | at `FeatureContext::iSubmitTheForm()`
default | Then I can see the blog post
        | at `FeatureContext::iCanSeeTheBlogPost()`
default | Given I am logged in
        | at `FeatureContext::iAmLoggedIn()`
default | Then the user :name should have :number followers
        | at `FeatureContext::theUserShouldHaveFollowers()`
default | Given the following users:
        | at `FeatureContext::theFollowingUsers()`

$ ./bin/behat --story-syntax
Testing the homepage

$ ./bin/behat --append-snippets
u features/bootstrap/FeatureContext.php - `I should see the welcome text` definition added

<?php
/**
 * @Then I should see the welcome text
 */
public function iShouldSeeTheWelcomeText()
{
    throw new PendingException();
}
?>

Feature: Blog
  In order to promote the technical knowhow of our department
  As a technical lead
  I want to blog about our latest technical achievements
 
@api
Scenario: Blog post overview pager
  Given I have 15 blog posts
  When I visit the blog overview
  Then I should see 10 blog posts
  And I should see the next page link
  But I should not see the previous page link
  When I click the next page link
  Then I should see 5 blog posts
  And I should see the previous page link
  But I should not see the next page link
A home for our custom step definitions

$ mkdir -p src/Context

And in it, create the file containing our custom context. This is a class that implements the \Behat\Behat\Context\Context interface. A number of base classes ship with the Drupal Behat Extension, and it is recommended to extend RawDrupalContext as it contains a number of helpful methods which we can leverage. Most of these steps are quite straightforward to implement, you can find plenty of examples in \Drupal\DrupalExtension\Context\DrupalContext.
src/Context/BlogContext.php
<?php
 
/**
 * @file
 * Contains \Drupal\myproject\Context\BlogContext.
 */
 
namespace Drupal\myproject\Context;
 
use Drupal\DrupalExtension\Context\RawDrupalContext;
 
/**
 * Provides step definitions for the Blog feature.
 */
class BlogContext extends RawDrupalContext {
 
  /**
   * The earliest creation date of a blog post, relative to the current time.
   *
   * This is defined as -30 days, in seconds.
   */
  const MIN_DATE = -2592000;
 
  /**
   * Creates n blog posts with random title and content.
   *
   * @Given (I have ):number blog post(s)
   *
   * @param int $number
   *   The number of random blog posts to create.
   */
  public function createBlogPosts($number) {
    $number = (int) $number;
    if ($number < 1) {
      throw new \InvalidArgumentException('Invalid number.');
    }
    for ($i = 0 ; $i < $number ; $i++) {
      $blog_post = (object) array(
        'type' => 'blog',
        'title' => $this->getRandom()->string(),
        'body' => $this->getRandom()->string(),
        'status' => 1,
        // Use a random creation date in the past 7 days.
        'created' => date('Y-m-d h:i:s', rand(time() - self::MIN_DATE, time())),
      );
      $this->nodeCreate($blog_post);
    }
  }
 
  /**
   * @When (I )visit the blog overview
   * @When I am on the blog overview
   */
  public function iAmOnBlogOverview() {
    $this->visitPath('/blog');
  }
 
  /**
   * @Then I should see :number blog posts
   *
   * @param int $number
   *   The number of blog posts that should be seen.
   */
  public function assertBlogPostCount($number) {
    $this->assertSession()->elementsCount('css', 'article.node--type-blog', intval($number));
  }
 
}

<?php
 
/**
 * @file
 * Contains \FeatureContext.
 */
 
use Drupal\DrupalExtension\Context\RawDrupalContext;
use Behat\Behat\Context\SnippetAcceptingContext;
 
/**
 * Defines application features from the specific context.
 */
class FeatureContext extends RawDrupalContext implements SnippetAcceptingContext {
 
  /**
   * Initializes context.
   *
   * Every scenario gets its own context instance.
   * You can also pass arbitrary arguments to the
   * context constructor through behat.yml.
   */
  public function __construct() {
  }
 
  /**
   * @Then I should see the next page link
   */
  public function assertNextPageLinkExists() {
    $this->assertSession()->elementExists('css', 'li.pager__item--next');
  }
 
  /**
   * @Then I should not see the next page link
   */
  public function assertNextPageLinkNotExists() {
    $this->assertSession()->elementNotExists('css', 'li.pager__item--next');
  }
 
  /**
   * @Then I should see the previous page link
   */
  public function assertPreviousPageLinkExists() {
    $this->assertSession()->elementExists('css', 'li.pager__item--previous');
  }
 
  /**
   * @Then I should not see the previous page link
   */
  public function assertPreviousPageLinkNotExists() {
    $this->assertSession()->elementNotExists('css', 'li.pager__item--previous');
  }
 
  /**
   * @When I click the next page link
   */
  public function clickNextPageLink() {
    $this->getSession()->getPage()->clickLink('Go to next page');
  }
}

$ ./bin/behat
Feature: Blog
  In order to promote the technical knowhow of our department
  As a technical lead
  I want to blog about our latest technical achievements
  @api @javascript
  Scenario: Blog post overview pager            # features/blog.feature:7
    Given I have 15 blog posts                  # Drupal\myproject\Context\BlogContext::createBlogPosts()
    When I visit the blog overview              # Drupal\myproject\Context\BlogContext::iAmOnBlogOverview()
    Then I should see 10 blog posts             # Drupal\myproject\Context\BlogContext::assertBlogPostCount()
    And I should see the next page link         # FeatureContext::assertNextPageLinkExists()
    And I should not see the previous page link # FeatureContext::assertPreviousPageLinkNotExists()
    When I click the next page link             # FeatureContext::clickNextPageLink()
    Then I should see 5 blog posts              # Drupal\myproject\Context\BlogContext::assertBlogPostCount()
    And I should see the previous page link     # FeatureContext::assertPreviousPageLinkExists()
    And I should not see the next page link     # FeatureContext::assertNextPageLinkNotExists()
1 scenario (1 passed)
9 steps (9 passed)
0m1.95s (37.89Mb)

All tests passed, great job!

In your project, update the behat.yml file to include the paths that you want to scan for files named MODULENAME.behat.inc. All step definitions in these files will become automatically available in all your tests:

Check if your PHP interpreter is correctly configured. You can check that in the preferences under the following path → File | Settings | Languages & Frameworks | PHP
    after setting up the PHP interpreter click on the 'i' to check if you have an access to the PHP configuration details. If yes you can proceed to the next step.
    the settings that are shown below on the picture are based on a local PHP interpreter. You can also configure a remote PHP interpreter (ex. interpreter installed on the VPS machine)



    more information about how to configure interpreters can be found here:
        Configuring Local PHP Interpreters
        Configuring Remote PHP Interpreters
        Setting up PHP

Setting up Behat configuration
    point the "path_to_your_project/bin/behat" as the path to Behat directory
    if the PHP interpreter is setup correctly and you point to a valid binary you should be able to see the Behat version. You can find an example on the picture below.



    you can also specify location of the default .yml Behat configuration file. This is an optional steop as you can also do that later during the set up of the 'run configuration'.
    more info can be found here:
        Behat 

To add a custom 'run configuration' you need to click on the dropdown menu in the 'run navigation bar section' and click 'Edit Configurations' (look at the picture below)



    more information about setting up 'run/debugging configurations' can be found here:
        Creating and Editing Run/Debug Configurations

The next step is clicking the '+' icon and picking 'Behat' option from the list (look at the picture below)



 Next thing you need to do is to provide some information regarding the test you want to run

    put the name of the configuration

    pick the test scope; here the most common option is 'File' or 'Scenario'

        'File' - sets run configuration for the given .feature file

        'Scenario' - sets run configuration for the given scenario of the selected .feature file

    click checkbox 'Use alternative configuration file' and point the path to the Behat .yml configuration on your environment (look at the picture below)



    after setting up 'test runner' click the 'Apply' and 'OK' buttons 
    more information regarding the Behat 'run configuration' can be found here:
        Run/Debug Configuration: Behat

Before running the configuration be sure that selected Behat configuration .yml file is setup for your current local environment (especially selenium port and browser).
To run the prepared configuration select the configuration on the dropdown menu in the 'run navigation bar section' and hit the 'Play' icon (look at the picture below)

After running the configuration you should see a similar output to the one on the picture presented below. If something is not configured you will receive an error message in the console window.



You can click on the given test step which is available in the executed configuration and by doing that you will be redirected to the step in the .feature file.

bin/behat -dl
bin/behat -di  #extended info