README

This package is an image driver for the bex/behat-screenshot behat extension which can upload the screenshot to UploadPie and print the url of the uploaded image.

Installation

Install by adding to your composer.json:

composer require --dev bex/behat-screenshot-image-driver-uploadpie

Configuration

Enable the image driver in the Behat-ScreenshotExtension's config in behat.yml like this:

default:
  extensions:
    Bex\Behat\ScreenshotExtension:
      active_image_drivers: upload_pie

You must configure the authentication like this (you can register here):

default:
  extensions:
    Bex\Behat\ScreenshotExtension:
      active_image_drivers: upload_pie
      image_drivers:
        upload_pie:
          auth: 'API_KEY' # can be your authentication key or and environment variable name

You can configure the expire time of the uploaded image (by default it is 30m) like this:

default:
  extensions:
    Bex\Behat\ScreenshotExtension:
      active_image_drivers: upload_pie
      image_drivers:
        upload_pie:
          expire: '1h' # possible values: '30m', '1h', '6h', '1d', '1w'

Usage

When you run behat and a step fails then the Behat-ScreenshotExtension will automatically take the screenshot and will pass it to the image driver, which will upload it and returns the URL of the uploaded image. So you will see something like this:

  Scenario:                           # features/feature.feature:2
    Given I have a step               # FeatureContext::passingStep()
    When I have a failing step        # FeatureContext::failingStep()
      Error (Exception)
Screenshot has been taken. Open image at http://uploadpie.com/idoftheimage
    Then I should have a skipped step # FeatureContext::skippedStep()