drevops/behat-screenshot

Behat extension and step definitions to create HTML and image screenshots on demand or when tests fail

1.2.0 2022-10-06 11:25 UTC

Requires

• behat/behat: ^3.3.1
• behat/mink-selenium2-driver: ^1.3
• symfony/finder: ^3.2|^4.0|^5.0|^6.0

Requires (Dev)

• behat/mink: ^1.8
• dealerdirect/phpcodesniffer-composer-installer: ^0.7
• drevops/behat-phpserver: ^1
• escapestudios/symfony2-coding-standard: ^3
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3
• symfony/process: ^5.3

GPL-2.0-or-later

• Alex Skrypnyk

README

Behat extension and step definitions to create HTML and image screenshots on demand or when tests fail.

Features

• Create a screenshot using I save screenshot or save screenshot step definition.
• Create a screenshot when test fails.
• Screenshot is saved as HTML page for Goutte driver.
• Screenshot is saved as both HTML and PNG image for Selenium driver.
• Screenshot directory can be specified through environment variable BEHAT_SCREENSHOT_DIR (useful for CI systems to override values in behat.yml).
• Screenshots can be purged after every test run by setting purge: true (useful during test debugging) or setting environment variable BEHAT_SCREENSHOT_PURGE=1.

Installation

composer require --dev drevops/behat-screenshot

Usage

Example behat.yml with default parameters:

default:
  suites:
    default:
      contexts:
        - DrevOps\BehatScreenshotExtension\Context\ScreenshotContext
        - FeatureContext
  extensions:
    DrevOps\BehatScreenshotExtension: ~

or with parameters:

default:
  suites:
    default:
      contexts:
        - DrevOps\BehatScreenshotExtension\Context\ScreenshotContext
        - FeatureContext
  extensions:
    DrevOps\BehatScreenshotExtension:
      dir: '%paths.base%/screenshots'
      fail: true
      fail_prefix: 'failed_'
      purge: false

In your feature:

  Given I am on "http://google.com"
  Then I save screenshot

You may optionally specify size of browser window in the screenshot step:

  Then I save 1440 x 900 screenshot
  And I save 800 x 600 screenshot

Options

• dir: path/to/dir (default %paths.base%/screenshots)

  Path to directory to save screenshots. Directory structure will be created if the directory does not exist.

• fail: true or false (default true)

  Capture screenshots for failed tests.

• fail_prefix: (default failed_)

  Prefix failed screenshots with fail_ string. Useful to distinguish failed and intended screenshots.

• purge: true or false (default false)

  Remove all files from the screenshots directory on each test run. Useful during debugging of tests. Can be overridden with BEHAT_SCREENSHOT_PURGE environment variable set to 1 or true.

Maintenance

Local development setup

1. Install Docker.
2. If using M1: cp default.docker-compose.override.yml docker-compose.override.yml
3. Start environment: docker-compose up -d --build.
4. Install dependencies: docker-compose exec phpserver composer install --ansi --no-suggest.

Lint code

docker-compose exec phpserver vendor/bin/phpcs

Run tests

docker-compose exec phpserver vendor/bin/behat

Enable Xdebug

XDEBUG_ENABLE=true docker-compose up -d phpserver

To disable, run

docker-compose up -d phpserver