Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kieran-ryan/behave-cucumber-matcher

Behave step matcher for Cucumber Expressions
https://github.com/kieran-ryan/behave-cucumber-matcher

behave cucumber python

Last synced: 16 days ago
JSON representation

Behave step matcher for Cucumber Expressions

Awesome Lists containing this project

README 

        
# Behave Cucumber Matcher



[![Release version](https://img.shields.io/pypi/v/behave-cucumber-matcher.svg?color=green)](https://pypi.python.org/pypi/ruff)

[![License](https://img.shields.io/pypi/l/behave-cucumber-matcher.svg)](https://pypi.python.org/pypi/behave-cucumber-matcher)

[![Python versions](https://img.shields.io/pypi/pyversions/behave-cucumber-matcher.svg)](https://pypi.org/pypi/behave-cucumber-matcher)

![Supported platforms](https://img.shields.io/badge/platforms-macOS%20%7C%20Windows%20%7C%20Linux-green)

![Cucumber](https://img.shields.io/badge/cucumber-gray?style=flat&logo=cucumber)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

![Pipeline status](https://github.com/kieran-ryan/behave-cucumber-matcher/actions/workflows/main.yml/badge.svg)



Behave step matcher for [Cucumber Expressions](https://github.com/cucumber/cucumber-expressions).



## Installation



`behave-cucumber-matcher` is available via [PyPI](https://pypi.org/project/behave_cucumber_matcher/):



```console

pip install behave-cucumber-matcher

```



## Usage



Import and specify the matcher inside `environment.py` of your `features` directory.



```python

from behave.matchers import use_step_matcher

from behave_cucumber_matcher import CUCUMBER_EXPRESSIONS_MATCHER



# Specify to use the Cucumber Expressions step matcher

use_step_matcher(CUCUMBER_EXPRESSIONS_MATCHER)

```



Create a scenario inside `color.feature` of your `features` directory:



```gherkin

Feature: Color selection



  Rule: User can select a profile color



    Scenario: User selects a valid color

      Given I am on the profile settings page

      When I select the theme colour "red"

      Then the profile colour should be "red"

```



Create step definitions inside `color.py` of your `features/steps` directory:



```python

from behave import given, then, when

from behave_cucumber_matcher import parameter_registry

from cucumber_expressions.parameter_type import ParameterType



# Define the parameter type

color = ParameterType(

    name="color",

    regexp="red|blue|yellow",

    type=str,

)



# Pass the parameter type to the registry instance

parameter_registry.define_parameter_type(color)



@given("I am on the profile customisation/settings page")

def step_given(context):

    assert True



# Reference the parameter type in the step definition pattern

@when('I select the theme colo(u)r "{color}"')

def step_when(context, selected_color):

    assert selected_color

    context.selected_color = selected_color



@then('the profile colo(u)r should be "{color}"')

def step_then(context, displayed_color):

    assert displayed_color

    assert context.selected_color == displayed_color

```



The necessary files are now in place to execute your gherkin scenario.



```console

repository/

  └── features/

      ├── steps/

      │   └── color.py

      ├── environment.py

      └── color.feature

```



Finally, execute Behave. The scenario will run with the step definitions using the Cucumber Expressions parameter type.



```console

$ behave

Feature: Color selection # features/color.feature:1

  Rule: User can select a profile color

  Scenario: User selects a valid color      # features/color.feature:5

    Given I am on the profile settings page # features/steps/color.py:20 0.000s

    When I select the theme colour "red"    # features/steps/color.py:26 0.000s

    Then the profile colour should be "red" # features/steps/color.py:32 0.000s



1 feature passed, 0 failed, 0 skipped

1 scenario passed, 0 failed, 0 skipped

3 steps passed, 0 failed, 0 skipped, 0 undefined

Took 0m0.001s

```



For detailed usage of _behave_, see the [official documentation](https://behave.readthedocs.io).



## Acknowledgements



Based on the Behave step matcher base class and built on the architecture of [cuke4behave](https://gitlab.com/cuke4behave/cuke4behave) by [Dev Kumar Gupta](https://github.com/mrkaiser), with extended type hints, a fix for detecting patterns without arguments, a default parameter type registry, additional documentation for arguments and return types, direct import of the matcher at package level rather than via its module, backwards compatibility with Cucumber Expressions missing parameter type defaults, and a global parameter type registry.



## License



`behave-cucumber-matcher` is licensed under the [MIT License](https://opensource.org/licenses/MIT)