chrisolof / drupalextension

An integration layer between Behat, Mink Extension, and Drupal.

Behat Drupal Extension

The Drupal Extension is an integration layer between Behat, Mink Extension, and Drupal. It provides step definitions for common testing scenarios specific to Drupal sites.

The Drupal Extension 5.x supports Drupal 9 and 10, utilizes Behat 3.2+ and runs on:

• PHP 7.4, 8.0, 8.1 with Drupal 9
• PHP 8.1 with Drupal 10.

Use it for testing your Drupal site.

If you're new to the Drupal Extension, we recommend starting with the Full documentation

Quick start

1. Install using Composer:

   mkdir projectdir
   cd projectdir
   curl -sS https://getcomposer.org/installer | php
   COMPOSER_BIN_DIR=bin php composer.phar require drupal/drupal-extension='~5.0'

2. In the projectdir, create a file called behat.yml. Below is the minimal configuration. Many more options are covered in the Full documentation

   default:
     suites:
       default:
         contexts:
           - Drupal\DrupalExtension\Context\DrupalContext
     extensions:
       Drupal\MinkExtension:
         # Guzzle is used as HTTP client. You can configure the Guzzle request
         # options by setting `browserkit_http.guzzle_request_options`. For
         # instance the following configuration will disable SSL peer verification:
         # browserkit_http:
         #   guzzle_request_options:
         #     verify: false
         # See \GuzzleHttp\RequestOptions for all built-in Guzzle request options
         browserkit_http: ~
         base_url: http://example.org/  # Replace with your site's URL
       Drupal\DrupalExtension:
         blackbox: ~

1. In the projectdir, run

  ``` bash
  bin/behat --init
  ```

1. Find pre-defined steps to work with using:

  ```bash
  bin/behat -di
  ```

1. Define your own steps in `projectdir\features\FeatureContext.php`

1. Start adding your [feature files](http://behat.org/en/latest/user_guide/gherkin.html)
 to the `features` directory of your repository.

## Credits

* Originally developed by [Jonathan Hedstrom](https://github.com/jhedstrom) with great help from [eliza411](https://github.com/eliza411)
* Maintainers
 * [Pieter Frenssen](https://github.com/pfrenssen)
 * [All these great contributors](https://github.com/jhedstrom/drupalextension/graphs/contributors)

## Additional resources

* [Behat Drupal Extension documentation](https://behat-drupal-extension.readthedocs.org)
* [Behat documentation](http://docs.behat.org)
* [Mink documentation](http://mink.behat.org)
* [Drupal Behat group](http://groups.drupal.org/behat)

## Examples and code snippets

* [Complex node creation, with field collections and entity references](https://gist.github.com/jhedstrom/5708233)
* [Achievements module support](https://gist.github.com/jhedstrom/9633067)
* [Drupal form element visibility](https://gist.github.com/pbuyle/7698675)
* [Track down PHP notices](https://www.godel.com.au/blog/use-behat-track-down-php-notices-they-take-over-your-drupal-site-forever)
* [Support for sites using basic HTTP authentication](https://gist.github.com/jhedstrom/5bc5192d6dacbf8cc459)

## Release notes

See [CHANGELOG](CHANGELOG.md).

## Contributing

Features and bug fixes are welcome! First-time contributors can jump in with the
issues tagged [good first issue](https://github.com/jhedstrom/drupalextension/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).

See [CONTRIBUTING.md](https://github.com/jhedstrom/drupalextension/blob/master/CONTRIBUTING.md) for more information.