Behavior-driven development (or BDD) is an agile software development technique that encourages collaboration between developers, QA and non-technical or business participants in a software project.

behave uses tests written in a natural language style, backed up by Python code.

First, install *behave*._

Now make a directory called "features/". In that directory create a file called "example.feature" containing:

.. code-block:: gherkin

# -- FILE: features/example.feature
Feature: Showing off behave

  Scenario: Run a simple test
    Given we have behave installed
     When we implement 5 tests
     Then behave will test them for us!

Make a new directory called "features/steps/". In that directory create a file called "example_steps.py" containing:

.. code-block:: python

# -- FILE: features/steps/example_steps.py
from behave import given, when, then, step

@given('we have behave installed')
def step_impl(context):
    pass

@when('we implement {number:d} tests')
def step_impl(context, number):  # -- NOTE: number is converted into integer
    assert number > 1 or number == 0
    context.tests_count = number

@then('behave will test them for us!')
def step_impl(context):
    assert context.failed is False
    assert context.tests_count >= 0

Run behave:

.. code-block:: console

$ behave
Feature: Showing off behave # features/example.feature:2

  Scenario: Run a simple test          # features/example.feature:4
    Given we have behave installed     # features/steps/example_steps.py:4
    When we implement 5 tests          # features/steps/example_steps.py:8
    Then behave will test them for us! # features/steps/example_steps.py:13

1 feature passed, 0 failed, 0 skipped
1 scenario passed, 0 failed, 0 skipped
3 steps passed, 0 failed, 0 skipped, 0 undefined

Now, continue reading to learn how to get the most out of behave. To get started, we recommend the tutorial_ and then the feature testing language_ and api_ references.

.. _Install *behave*.: https://behave.readthedocs.io/en/stable/install/ .. _tutorial: https://behave.readthedocs.io/en/stable/tutorial/ .. _feature testing language: https://behave.readthedocs.io/en/stable/gherkin/ .. _api: https://behave.readthedocs.io/en/stable/api/

More Information

behave documentation: latest edition, stable edition, PDF
behave.example_: Behave Examples and Tutorials (docs, executable examples).
changelog_ (latest changes)

.. _behave documentation: https://behave.readthedocs.io/ .. _changelog: https://github.com/behave/behave/blob/main/CHANGES.rst .. _behave.example: https://github.com/behave/behave.example

.. _latest edition: https://behave.readthedocs.io/en/latest/ .. _stable edition: https://behave.readthedocs.io/en/stable/ .. _PDF: https://behave.readthedocs.io/_/downloads/en/latest/pdf/

Keywords

BDD

behavior-driven-development

FAQs

What is behave?

Is behave well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install