lexsoft/drupal-behat-contexts

Simple context to help debugging tests with some steps.

1.0 2018-07-05 16:04 UTC

Requires

• php: >=5.3.0
• behat/behat: ~3.0
• drupal/drupal-extension: ~3.4.1
• twig/twig: ~1.0

GPL-2.0-or-later

• Alexandru

• testing
• Behat
• drupal
• lexsoft

README

Contexts that we use with Behat 3.x tests on Drupal sites.

How?

• The tool can be installed easily with composer.
• Defining the formatter in the behat.yml file
• Modifying the settings in the behat.ymlfile

Installation

Prerequisites

This extension requires:

• PHP 5.3.x or higher
• Behat 3.x or higher

Through composer

The easiest way to keep your suite updated is to use Composer:

Install with composer:

$ composer require --dev lexsoft/drupal-behat-contexts

Install using composer.json

Add DrupalBehatContexts to the list of dependencies inside your composer.json.

{
    "require": {
        "behat/behat": "3.*@stable",
        "drupal/drupal-extension": "3.*@stable",
        "lexsoft/drupal-behat-contexts": "1.*",
    },
    "minimum-stability": "dev",
    "config": {
        "bin-dir": "bin/"
    }
}

Then simply install it with composer:

$ composer install --dev --prefer-dist

You can read more about Composer on its official webpage.

Configure

Each context may have its own configuration, see each context section.

Contexts

DebugContext

Simple context to help debugging tests with some steps. Additionally, it hooks in the after step event to add a step that generates an error report on failed steps.

This report includes:

• A file with the HTML page content.
• A file with the current URL and the error exception dump.
• If available, a file with current page state.

Steps

• Then capture full page with a width of :width

  Saves a screenshot of current page with the given width to a file.

• Then capture full page with a width of :width with name :filename in configured directory (screenshots_path).

  Saves a screenshot of current page with the given width to a given filename in configured directory (screenshots_path).

• Then capture full page with width of :width to :path

  Saves a screenshot of current page with the given width to a file in the given path. If path is relative screenshots_path config value is used as root.

• Then capture full page with width of :width to :path with name :filename

  Saves a screenshot of current page with the given width to a file in the given path to a given filename. If path is relative screenshots_path config value is used as root.

• Then save last response

  Saves page content to a file.

• Then save last response to :path

  Saves page content to a file in the given path.

• Then save last response to :path

  Halts test for a given amount of seconds. Useful when debugging tests with timing issues. Don't use this step in real tests.

Configuration

Add DebugContext to your suite.

This is an example when bootstrap directorty is in DRUPALROOT/sites/all/tests/behat/bootstrap.

default:
  autoload:
    '': %paths.base%\tests\features\bootstrap # This works with windows for linux change the path
  suites:
    default:
      paths:
        - %paths.base%\tests\features # This works with windows for linux change the path
      contexts:
        - Drupal\DrupalExtension\Context\DrupalContext
        - Drupal\DrupalExtension\Context\DrushContext
        - Drupal\DrupalExtension\Context\MessageContext
        - Drupal\DrupalExtension\Context\MinkContext
        - Drupal\DrupalExtension\Context\MarkupContext
        - lexsoft\DrupalBehatContexts\Context\UIContext
        - lexsoft\DrupalBehatContexts\Context\DrupalOrganicGroupsExtendedContext
        - lexsoft\DrupalBehatContexts\Context\DrupalExtendedContext
        - lexsoft\DrupalBehatContexts\Context\BrowserSizeContext:
            parameters:
        - lexsoft\DrupalBehatContexts\Context\DebugContext:
            parameters:
              'report_on_error': true
              'error_reporting_path': "%paths.base%\\tests\\errors\\reports\\" # This works with windows for linux change the path
              'screenshots_path': "%paths.base%\\tests\\errors\\screenshots\\" # This works with windows for linux change the path
              'page_contents_path': "%paths.base%\\tests\\errors\\pages\\" # This works with windows for linux change the path

Parameters

• report_on_error: If true error reports are generated on failed steps.
• error_reporting_path: Path where reports are saved.
• screenshots_path: Path where screenshots are saved. Report screenshots are saved in the report path, here only screenshots from capture full page steps are saved.
• page_contents_path: Path where page contents are saved. Report page contents are saved in the report path, here only page contents from save page content steps are saved.

BrowserSizeContext

This contexts allows to resize the browser to a given set of sizes. It should be used with a real browser driver like Selenium. Its main purpose is to ease tests that depends on window size.

Keep in mind that browser window size may not change between scenarios or features, even differnet test execution. For example, if you use PhantomJS the same browser is used for all tests execution (given that PhantomJS is not terminated and executed again). So if a test changes the window size next tests with the @javadcript tag will be performed with that window size.

Steps

• Given (that )browser window size is :size size

  Changes window broeser size to the given size. The size must be one of the default ones or one of the sizes declared in the configuration.

Configuration

Add BrowserSizeContext to your suite.

To declare sizes and make them available use the context params:

- lexsoft\DrupalBehatContexts\BrowserSizeContext:
    parameters:
      sizes:
        Default:
          width: 1200
          height: 800
        Full:
          width: 1200
          height: 800
        My custom size:
          width: 1440
          height: 960

The context has some default values. If a size is defined with same name as one of the default sizes the dimensions are overwritten. If a completely new size is defined is simply added to the available size.

DrupalExtendedContext

This context extends DrupalRawContext with steps related to Drupal and its modules.

Steps

• Then form :type element :label should be required

  Checks a form element is required. File input type is not supported.

• Then form :type element :label should not be required

  Checks a form element is required. File input type is not supported.

• Given I run elysia cron

  Runs Elysia cron.

Configuration

No configuration needed.

IUContext

This context provides steps for certain UI elements.

Steps

• Given I select :option from :select chosen.js select box

  Selects and option from a Chosen select widget. Only for sinlge selection, it doesn't work with multiple selection enabled or tag style.

  See https://harvesthq.github.io/chosen/

Configuration

No configuration needed.