Cucumber features as documentation

Posted Over 9 years ago. Visible to the public. Repeats.

Cucumber allows for prose in features and scenarios. Example:

Feature: Cancel account

  There are several ways to cancel a user account. Admins need to 
  do it in complex cases, but normally, users can do it themselves.
  
  Scenario: User cancels his own account
    
    Users should be able to cancel an account themselves, so the 
    admins do not need to do it.
    
    Given a user account for "willy@astor.de"
    When I sign in as "willy@astor.de"
    And I follow "Cancel account"
    Then I should see "Account canceled"

By going beyond the single line descriptions we've accustomed to, we can provide all the information that is required to understand the intention and meaning of a feature/scenario. That way, future developers can quickly get an understanding of the application.

Dominik Schöler
Last edit
Over 1 year ago
Michael Leimstädtner
License
Source code in this card is licensed under the MIT License.
Posted by Dominik Schöler to makandra dev (2014-11-18 09:59)