Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
BDD, Python style.
Python CSS
Pull request Compare This branch is 385 commits ahead, 191 commits behind behave:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
behave Merge branch 'master' of https://github.com/behave/behave
behave4cmd0 FIX issue #143, #177 related to logcapture/logging.
bin Merge branch 'master' of https://github.com/behave/behave
contrib/junit.xml BETTER-COMPATIBLE: skipped (was: skips).
docs Merge branch 'master' of https://github.com/behave/behave
etc Issue #161: JSONFormatter: Should use a slightly different output sch…
features Merge branch 'master' of https://github.com/behave/behave
issue.features FIX issue #181: Escape apostrophes in undefined steps snippets
more.features Issue #161: JSONFormatter: Should use a slightly different output sch…
paver_ext Update to latest changes in build environment.
requirements Fix various issues with tox usage (and pip).
selftest.features Apply fix for new UNDEFINED-STEP output schema.
test Merge branch 'master' of https://github.com/behave/behave
tools Merge branch 'master' of https://github.com/behave/behave
.coveragerc Issue #113: Cleanup some typos, unneeded party (cherry-picked).
.editorconfig Provide generic editor configuration description for this project.
.gitattributes Cleanup experimental parts
.gitignore Update from behave_master repository to current state.
.pycheckrc Provide configfile for pychecker.
.travis.yml Test-balloon10 for jython: allow jython builds to fail.
CHANGES.rst FIX issue #181: Escape apostrophes in undefined steps snippets
DEVELOP.rst Update to current state.
LICENSE AUTHORS: Add JE to authors.
MANIFEST.in Merge branch 'master' of https://github.com/behave/behave
PROJECT_INFO.rst BUMP-VERSION: 1.2.4a1 (was: 1.2.3)
README.rst Experiment: Try to use code-blocks.
VERSION.txt BUMP-VERSION: 1.2.4a1 (was: 1.2.3)
behave.ini FIX issue #194: Nested steps prevent that original stdout/stderr is r…
pavement.py clean: Update cleanup rule
pylintrc Pull-Request #79: Provide Support for Scenario Descriptions
setup.cfg Support building docs via 'setup.py docs' (or 'build_sphinx').
setup.py Merge branch 'master' of https://github.com/behave/behave
setuptools_behave.py Provide simple test runner to run behave tests from setup.py
tox.ini Fix various issues with tox usage (and pip).

README.rst

Behave

Travis CI Build Status Latest PyPI version Number of PyPI downloads

behave is behavior-driven development, Python style.

logo

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:

# -- 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:

# -- 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:

$ behave
Feature: Showin 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 the most of behave. To get started, we recommend the tutorial and then the feature testing language and api references.

More Information

Testing Domains

Behave and other BDD frameworks allow you to provide step libraries to reuse step definitions in similar projects that address the same problem domain.

Support of the following testing domains is currently known:

Testing Domain Name Description
Command-line behave4cmd Test command-line tools, like behave, etc. (coming soon).
Web Apps django-behave Test Django Web apps with behave.
Web, SMS, ... behaving Test Web Apps, Email, SMS, Personas (step library).
Something went wrong with that request. Please try again.