timitao/behatclipboard

v1.0.6 2015-04-14 10:58 UTC

README

License Latest Stable Version Latest Unstable Version Total Downloads SensioLabsInsight Scrutinizer Code Quality Build Status

BehatClipboard

BehatClipboard is an integration layer between contexts in Behat 3.0+ and it provides:

  • Additional service for Behat Clipboard,
  • base Behat\ClipboardExtension\Context\FeatureContext context which provides base step definitions for your contexts,
  • allow to share data between contexts - all,
  • allow to use keys, in scenarios - and will be replaced, in: ** TableNode ** PyString ** Value

Purpose of this is that, I'm testing REST API. In return I get JSON that want call universal way. I'm saving last respond to clipboard and freely call this by clipboard(last_response.body.KEY.KEY.KEY)

Flow

System generate a container that hold data. We could save there and read inside context. Clipboard will we shared between all context that implement interface Behat\ClipboardExtension\Context\ClipboardContextAwareInterface;

Extension add event for transform data in scenario with given prefix and pattern.

In default, it will look for example: clipboard(test1), where test1 is key from clipboard and replace in scenario before execute step. The transform not depend on given context.

Given Clipboard save the value "10" on key "test1"
#in next step clipboard.test1 will be transformed to 10, and send to step
And Clipboard over key "clipboard(test1)" have "10" 

Minimum functionality you need to implement in your context is saving to clipboard. Like in Behat\ClipboardExtension\Context\FeatureContext:

/**
 * @Then Clipboard save the value :arg1 on key :arg2
 *
 * @param $arg1
 * @param $arg2
 */
public function clipboardSaveTheValueOnKey($arg1, $arg2)
{
    $this->clipboard->set($arg2, $arg1);
}

Installing extension

The easiest way to install is by using Composer:

$> curl -sS https://getcomposer.org/installer | php
$> php composer.phar require timitao/behatclipboard='1.0.*'

or composer.json

"require": {
    "timitao/behatclipboard": "1.0.*"
},

Action

Base context allow:

  • save value on key to clipboard
  • check containing KEY by clipboard
  • copy from KEY1 to KEY2
  • save multi values by TableNode
  • save PyString by key

Examples

Look at this clipboard.feature

Default

We can define default values for clipboard by:

extensions:
    Behat\ClipboardExtension\ClipboardExtension:
        defaults:
            key1: value1
            key2.key2 : value2

Extra

Additionally, it assist dotNotification.

If you save array on [test=>[test2=>15]] in scenario, you could call this by

  • clipboard(test1) to get [test2=>15]
  • clipboard(test.test2) to get 15

Configuration

Actually used configuration:

  • prefix - prefix for recognise data in scenario to replace. Default: clipboard
  • pattern - pattern that will be complete with prefix and looking data to transform from clipboard. Default: /%s\(([a-zA-Z0-9_\.\-]+)\)/

Suggestion

Suggested to use with Behat Assert Context.

Versioning

Staring version 1.0.0, will follow Semantic Versioning v2.0.0.

Contributors

  • Tomasz Kunicki TimiTao [lead developer]