Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robertfausk/behat-screenshot-image-driver-url

This package is an image driver for the bex/behat-screenshot behat extension which can upload the screenshot to local web server dir and print the url of the uploaded image.
https://github.com/robertfausk/behat-screenshot-image-driver-url

Last synced: 19 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/robertfausk/behat-screenshot-image-driver-url
Owner: robertfausk
License: mit
Created: 2020-03-29T22:00:41.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2020-12-13T16:23:19.000Z (about 4 years ago)
Last Synced: 2024-11-15T23:39:30.068Z (about 1 month ago)
Language: PHP
Size: 175 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # ImageDriver-URL for Behat-ScreenshotExtension

[![Latest Stable Version](https://poser.pugx.org/robertfausk/mink-panther-driver/v/stable.svg)](https://packagist.org/packages/robertfausk/behat-screenshot-image-driver-url)

[![Latest Unstable Version](https://poser.pugx.org/robertfausk/behat-screenshot-image-driver-url/v/unstable.svg)](https://packagist.org/packages/robertfausk/behat-screenshot-image-driver-url)

[![Total Downloads](https://poser.pugx.org/robertfausk/behat-screenshot-image-driver-url/downloads.svg)](https://packagist.org/packages/robertfausk/behat-screenshot-image-driver-url)

[![License](https://poser.pugx.org/robertfausk/behat-screenshot-image-driver-url/license.svg)](https://packagist.org/packages/robertfausk/behat-screenshot-image-driver-url)

[![Build Status](https://travis-ci.org/robertfausk/behat-screenshot-image-driver-url.svg?branch=master)](https://travis-ci.org/robertfausk/behat-screenshot-image-driver-url)

[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/robertfausk/behat-screenshot-image-driver-url/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/robertfausk/behat-screenshot-image-driver-url/)

[![Code Coverage](https://scrutinizer-ci.com/g/robertfausk/behat-screenshot-image-driver-url/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/robertfausk/behat-screenshot-image-driver-url/)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

![PHP7 Compatible](https://img.shields.io/travis/php-v/robertfausk/behat-screenshot-image-driver-url/master?style=flat-square)

[![Open Issues](https://img.shields.io/github/issues-raw/robertfausk/behat-screenshot-image-driver-url?style=flat-square)](https://github.com/robertfausk/behat-screenshot-image-driver-url/issues)

[![Closed Issues](https://img.shields.io/github/issues-closed-raw/robertfausk/behat-screenshot-image-driver-url?style=flat-square)](https://github.com/robertfausk/behat-screenshot-image-driver-url/issues?q=is%3Aissue+is%3Aclosed)

[![Contributors](https://img.shields.io/github/contributors/robertfausk/behat-screenshot-image-driver-url?style=flat-square)](https://github.com/robertfausk/behat-screenshot-image-driver-url/graphs/contributors)

![Contributors](https://img.shields.io/maintenance/yes/2020?style=flat-square)

This package is an image driver for the [bex/behat-screenshot](https://github.com/elvetemedve/behat-screenshot) behat extension which can upload the screenshot to local web server dir and print the url of the uploaded image.

If you are in a docker like environment then this extension provide the url in log output. 

## Installation

Install by adding to your `composer.json`:

```bash

composer require --dev robertfausk/behat-screenshot-image-driver-url

```

## Configuration

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

```yml

default:

  extensions:

    Bex\Behat\ScreenshotExtension:

      active_image_drivers: url

```

You have to choose where to upload files and the web address:

```yml

default:

    extensions:

        Bex\Behat\ScreenshotExtension:

            active_image_drivers: url

            image_drivers:

                url:

                    screenshot_directory: /var/www/html/public/screenshots # your local web server dir where the image gets saved

                    screenshot_url: https://acme/screenshots # used for creation of web url; could also be something like https://localhost:9000/screenshots

                    # you can use something similar in your ci:

                    # screenshot_url: https://acme.test.my-company.com/screenshots

                    

```

## Usage

When a step fails a screenshot will be taken and put into web server directory. URL of the uploaded image will be displayed in the Behat log.

So you can open it directly from log output:

```bash

  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 /var/www/html/public/screenshots/IMAGE_LINK.png or https://acme/screenshots/IMAGE_LINK.png

    Then I should have a skipped step # FeatureContext::skippedStep()

```

![console output example of behat screenshot image driver url](doc/images/console_output.png)

### How to upgrade?

Have a look at [CHANGELOG](CHANGELOG.md) for detailed information.