NBehave Wiki & Documentation Rss Feed

Updated Wiki: Documentation

Lazydev — Mon, 26 Nov 2012 20:30:44 GMT

Documentation is now on github

Updated Wiki: Documentation

Lazydev — Mon, 26 Nov 2012 20:26:29 GMT

Documentation

Is now on the github wiki

Getting started
Getting started with the Visual Studio 2010 plugin
Getting Started with Resharper plugin
Integrate into build process
Using NBehave as syntactic sugar in unit tests
Code generation
Limited TestDriven.NET support for text files
Fluent interfaces
Embedded Runner

Please use the discussions section to leave messages. Since there are no notifications for wiki comments, they will likely never be read

Updated Wiki: Home

Lazydev — Sun, 14 Oct 2012 11:40:13 GMT

We are moving to Github:

https://github.com/nbehave/NBehave

Vision Statement

Based on Dan North's initial vision of rbehave and utilizing the behavioral domain specific language (DSL) of Behavior Driven Design (BDD) we created the NBehave framework. The primary goal of NBehave is a framework for defining and executing application requirement goals. These characterizations are modeled after the Behavioral Driven Design (BDD) terms Story, Scenario, Given, When, Then. Relying on a syntax that is lightweight and targeted at product owners (a few "quotes" mostly), the code becomes an executable and self-describing requirements document. The definitions within the actual unit test of the application coupled with the organic nature of the architecture and ubiquity of the domain model translates these concepts into becoming one cohesive amalgam. With the help of Domain Driven Design, the code actually becomes what we have always wanted, living requirements that are constantly asserted on to ensure their viability and accuracy from inception to implementation. Can you say true traceability!

Content

Getting started
Features
Set Up

Updated Wiki: Documentation

Lazydev — Thu, 09 Aug 2012 13:14:24 GMT

Documentation

Getting started
Getting started with the Visual Studio 2010 plugin
Getting Started with Resharper plugin
Integrate into build process
Using NBehave as syntactic sugar in unit tests
Code generation
Limited TestDriven.NET support for text files
Fluent interfaces
Embedded Runner

Please use the discussions section to leave messages. Since there are no notifications for wiki comments, they will likely never be read

Updated Wiki: Getting started

Lazydev — Wed, 08 Aug 2012 21:18:10 GMT

Getting started

* Write a scenario
* Create matching C# Scenario class
* Running the scenario
* Define the steps for your scenario
* Run your successful scenario!

Write a scenario

Start Visual Studio (or whatever editor you like).
Create a scenario using the words Given, When, Then, And and But.

Given I am not logged in
When I log in as Morgan with a password SecretPassw0rd
Then I should see a message, "Welcome, Morgan!"

Save the scenario in file. The file should have a meaningful name, eg: user_logs_in_successfully.feature

Create matching C# Scenario class

Create a C# class, that matches the text scenario name. You can choose to use CamelCase or underscores just as your feature file.
It should have the same name as your scenario, but not required. e.g. UserLogsInSuccessfully or user_logs_in_successfully.feature works fine.
Add a reference to _NBehave.Narrator.Framework.dll.
To assert on the scenario outcome you can use NBehave's extensions to either NUnit, XUnit, MbUnit or MsTest, lets use NUnit so add a reference to nbehave.spec.framework.dll, nbehave.spec.nunit and nunit.framework.dll.
You can also use almost any test framework if you like directly.

Running the scenario

To run the scenario open a console window and run

>NBehave-Console.exe  NameOfDll.dll /sf=user_logs_in_successfully.feature

NameOfDll.dll is the name of the assembly that contains your classes that are decorated with the attribute ActionSteps

You should get an output that looks something like this.

NBehave version 0.4.5.183
Copyright Â© NBehave 2007-2009
All Rights Reserved.

Runtime Environment -
   OS Version: Microsoft Windows NT 5.1.2600 Service Pack 3
  CLR Version: 2.0.50727.3603

Scenario: 1.user_logs_in_successfully
Given I am not logged in - PENDING
When I log in as Morgan with a password SecretPassw0rd - PENDING
Then I should see a message, "Welcome, Morgan!" - PENDING

P
Scenarios run: 1, Failures: 0, Pending: 1
Steps 3, failed 0, pending 3

Pending:
1)  (1.user_logs_in_successfully): No matching Action found for "Given I am not logged in"
No matching Action found for "When I log in as Morgan with a password SecretPassw0rd"
No matching Action found for "Then I should see a message, "Welcome, Morgan!""

What’s happening is that NBehave cannot find matching methods in the ActionSteps class corresponding the to steps in the text scenario.

Define the steps for your scenario

In the class you created (UserLogsInSuccessfully), write a method for each step, then annotate that method using NBehave attributes GivenAttribute, WhenAttribute or ThenAttribute, depending on whether the step sets up a context (Given), performs some events that you’re interested in (When) or describes the desired outcome (Then).

The value of the attributes should match the steps you described in your scenario. You can capture arguments to pass through to your steps using a prefix, ”$”, before the argument.

using NBehave.Narrator.Framework;
using NBehave.Spec.NUnit;

[ActionSteps]
public class UserLogsInSuccessfully
{
    // some code to setup _currentPage
    // ...

    [Given("I am not logged in")]
    public void LogOut()
    {
        _currentPage.click("logout");
    }

    [When("I log in as $username with a password $password")]
    public void LogIn(string username, string password)
    {
        _currentPage.click("login");
    }

    [Then("I should see a message, \"$message\"")]
    public void CheckMessage(string message)
    {
        _currentPage.ToString().ShouldContain(message);
    }
}

Run your successful scenario!

If you now re-run your scenario, you’ll find that the PENDING messages are gone and your scenario has run successfully.

Configure scenarios

While sensible and most useful default values are provided, NBehave has been designed to be configurable to suit most developers’ requirements.
Learn more about scenario files

Updated Wiki: Languages

Lazydev — Wed, 08 Aug 2012 21:15:26 GMT

So not everyone has english as their primary language so its possible to write in your native language.

All you have to do is add a line to your text files, it must be the first line in the text file!

So, here is a calculator example in swedish

# language: se
Givet att jag knappat in 5
Och att jag knappat in 4
När jag summerar
Då ska resultatet vara 9

and the attribute to match the Given step looks like this

[Given(@"att jag knappat in $number")]
public void GivenNumber(int number)
{
    //code here
}

Currently only english and Swedish are added so if your language isnt there you have to add it yourself. You do that by editing the file languages.yml, you will find it along with the other nbehave files. And please, send us a patch with the added language.

Updated Wiki: Comments

Lazydev — Wed, 08 Aug 2012 21:15:09 GMT

If you want to add a comments in your text files you do it by starting the line with a # (whitespaces are ignored) like this

# a comment
    # this is a comment with leading spaces which is allowed

This is not a legal comment, the entire row is treated as a step

Given a number #only integers allowed

Updated Wiki: Tables

Lazydev — Wed, 08 Aug 2012 21:14:55 GMT

Tables work somewhat like Examples

Lets look at an example:

Feature: Table support in nbehave
Scenario: a table
  Given a list of people:
    |Name   |Country|
    |Morgan |Sweden |
    |Jimmy  |Sweden |
    |Jimmy  |USA    |
  When I search for people from Sweden
  Then I should find:
    |Name  |Country|
    |Morgan|Sweden |
    |Jimmy |Sweden |

And here is the code to implement the feature

using System.Collections.Generic;
using System.Linq;
using NBehave.Narrator.Framework;
using NBehave.Spec.NUnit;

namespace NBehave.Examples.Tables
{
    public class People
    {
        public string Name { get; set; }
        public string Country { get; set; }
    }

    [ActionSteps]
    public class Table
    {
        private List<People> _people;
        private List<People> _found;

        [BeforeScenario]
        public void Init()
        {
            _people = new List<People>();
        }

        [Given("a list of people:")]
        public void List_of_people(string name, string country)
        {
            _people.Add(new People { Name = name.Trim(), Country = country.Trim() });
        }

        [When(@"I search for people from $country")]
        public void SearchByCountry(string country)
        {
            _found = _people.Where(p => p.Country == country).ToList();
        }

        [Then(@"I should find:")]
        public void Should_Find(string name, string country)
        {
            var found = _found.Where(p => p.Name == name.Trim() && p.Country == country.Trim());
            found.Count().ShouldEqual(1);
        }
    }
}

The difference from Examles is that with tables, the Given step in this example is executed 3 times, one time for each row.
After that the When step is executed,
and last the Then step is executed two times, one time for each row.

Updated Wiki: Examples

Lazydev — Wed, 08 Aug 2012 21:14:33 GMT

Instead of repeating the same example and only change the values you can use examples.

You write an example like this:

Feature: add, subtract, divide and multiply

Scenario: Add numbers
	Given I have entered [num1] into the calculator
	And I have entered [num2] into the calculator
	When I add the numbers
	Then the sum should be [result]
	
Examples:
|num1|num2|result|
|   1|   2|     3|
|  -1|   2|     1|
|   1|  -2|    -1|
|  -2|  -3|    -5|

and the code for the steps is implemented

using NBehave.Narrator.Framework;
using NBehave.Spec.NUnit;

namespace NBehave.Examples.Calculator_table.Steps
{
    [ActionSteps]
    public class AddNumbers
    {
        private Calculator _calculator;

        [BeforeScenario]
        public void SetUp_scenario()
        {
            _calculator = new Calculator();
        }

        [Given(@"I have entered $number into the calculator")]
        public void Enter_number(int number)
        {
            _calculator.Enter(number);
        }

        [When(@"I add the numbers")]
        public void Add()
        {
            _calculator.Add();
        }

        [Then(@"the sum should be $result")]
        public void Result(int result)
        {
            _calculator.Value().ShouldEqual(result);
        }
    }
}

Updated Wiki: ActionSteps

Lazydev — Wed, 08 Aug 2012 21:14:05 GMT

Steps

To link your specification in a textfile to code, you add the attribute Nbehave.Narrator.ActionStepsAttribute on the class where you intend to implement your steps.
Each step in the text file need to be mapped to a method in a class with the ActionSteps attribute, this is done with the attributes Given, When and Then. The three attributes works the same way.
The easiest way is to just add the attribute to a method and name the method as the actionstep in the text file with spaces replaced with underscores, ex:
In the textfile you may have

Given I have a Greeting system

This is easily mapped with the following code

[Given]
public void Given_I_have_a_greeting_system() 
{
   // code 
}

or you can do it this way

[Given("I have a greeting system")]
public void GreetingSystem() 
{
   // code 
}

If you need parameters you use the name of the parameter in the method name like this:

Given my name is Morgan

[Given("my name is $userName")]
public void UserName(string userName) 
{
   // code 
}

The $userName in the string is mapped to the input parameter userName so that you can write
Given my name is Morgan
nbehave will call the UserName method with Morgan as the value of the parameter.

There's also the option to write your step like this

[Given]
public void Given_my_name_is_userName(string userName) 
{
   // code 
}

In this case the method name will be used as step text. This is equivalent to the previous example.
The function name will be turned into a [Given("my name is $userName")].
The parameter names will be match with the first occurrance in the method name using this method.

More control!

If you need more control over the parameters sent to a method you can specify a regular expression to map out parameters from the textfile to a method.
Ex: ”Given my name is Morgan Persson”
And you want to map ”Morgan Persson” to one parameter, this cannot be done with only [Given] so you have to specify a regular expression:

[Given(@”my name is (?<userName>\w+\s\w+)$”)]
public void Given_my_name_is(string userName) 
{
   // code 
}

Its important that you match the parameter names in the function with the group names in your regular expression or Nbehave wont be able to match things together.

Alias

Its possible to have multiple attributes on the same method so that your scenarios can be worded differently.

[Given("my name is $userName")]
[Given("a user named $userName")]
public void UserName(string userName) 
{
   // code 
}

Arrays

If you need a parameter to a step that is an array you must specify a regular expression that match comma separated values.

[Given(@”a list of numbers\s+(?<values>(\d+,?\s*)+)”)]
public void Given_array(int[] values) 
{
   // code 
}

Will match:

Given a list of numbers 1, 2, 3, 5, 8

Updated Wiki: Code generation

Lazydev — Wed, 08 Aug 2012 21:13:35 GMT

When you have created a new step file you can let nbehave generate skeleton step methods by runnning nbehave-console.exe with the parameter /codegen
Example:

nbehave-console.exe MyAssembly.dll /sf=myfeature.feature /codegen

The code generator isnt very good at spotting a parameter from any other word so you have to edit the steps and add the parameters yourself.
Its also may generate multiple methods for the same step so beware of this. Our suggestion is that you move forward in small steps to mitigate this.

Updated Wiki: IntegrateBuild

Lazydev — Wed, 08 Aug 2012 21:12:45 GMT

Integrate with build

There are 3 ways to integrate NBehave in your build.

Updated Wiki: Getting started

Lazydev — Wed, 08 Aug 2012 21:12:02 GMT

Getting started

* Write a scenario
* Create matching C# Scenario class
* Running the scenario
* Define the steps for your scenario
* Run your successful scenario!

Write a scenario

Start Visual Studio (or whatever editor you like).
Create a scenario using the words Given, When, Then, And and But (only in 0.5.0 or newer).

Given I am not logged in
When I log in as Morgan with a password SecretPassw0rd
Then I should see a message, "Welcome, Morgan!"

Save the scenario in file. The file should have a meaningful name, eg: user_logs_in_successfully.feature

Create matching C# Scenario class

Running the scenario

To run the scenario open a console window and run

>NBehave-Console.exe  NameOfDll.dll /sf=user_logs_in_successfully.feature

NameOfDll.dll is the name of the assembly that contains your classes that are decorated with the attribute ActionSteps

You should get an output that looks something like this.

NBehave version 0.4.5.183
Copyright Â© NBehave 2007-2009
All Rights Reserved.

Runtime Environment -
   OS Version: Microsoft Windows NT 5.1.2600 Service Pack 3
  CLR Version: 2.0.50727.3603

Scenario: 1.user_logs_in_successfully
Given I am not logged in - PENDING
When I log in as Morgan with a password SecretPassw0rd - PENDING
Then I should see a message, "Welcome, Morgan!" - PENDING

P
Scenarios run: 1, Failures: 0, Pending: 1
Steps 3, failed 0, pending 3

Pending:
1)  (1.user_logs_in_successfully): No matching Action found for "Given I am not logged in"
No matching Action found for "When I log in as Morgan with a password SecretPassw0rd"
No matching Action found for "Then I should see a message, "Welcome, Morgan!""

What’s happening is that NBehave cannot find matching methods in the ActionSteps class corresponding the to steps in the text scenario.

Define the steps for your scenario

using NBehave.Narrator.Framework;
using NBehave.Spec.NUnit;

[ActionSteps]
public class UserLogsInSuccessfully
{
    // some code to setup _currentPage
    // ...

    [Given("I am not logged in")]
    public void LogOut()
    {
        _currentPage.click("logout");
    }

    [When("I log in as $username with a password $password")]
    public void LogIn(string username, string password)
    {
        _currentPage.click("login");
    }

    [Then("I should see a message, \"$message\"")]
    public void CheckMessage(string message)
    {
        _currentPage.ToString().ShouldContain(message);
    }
}

Run your successful scenario!

If you now re-run your scenario, you’ll find that the PENDING messages are gone and your scenario has run successfully.

Configure scenarios

While sensible and most useful default values are provided, NBehave has been designed to be configurable to suit most developers’ requirements.
Learn more about scenario files

Updated Wiki: Documentation

Lazydev — Wed, 08 Aug 2012 21:10:49 GMT

Documentation

Getting started
Getting started with the Visual Studio 2010 plugin
Getting Started with Resharper plugin
Integrate into build process
Using NBehave as syntactic sugar in unit tests
Code generation
Limited TestDriven.NET support for text files
Fluent interfaces
Embedded Runner

New Comment on "Getting started"

harryhazza — Fri, 27 Jul 2012 09:17:42 GMT

Correction, I WAS using 0.5.0! I have even tried the /codegen flag which does NOT generate the same code as is written above! Will try the examples included in the installation ...

New Comment on "Getting started"

harryhazza — Fri, 27 Jul 2012 09:07:52 GMT

Hi, using vs2010 and NBehave 0.5.1, Jun 11 2011, Beta, followed steps exactly as above and it always says PENDING. Will remove the beta and try 0.5.0 ...

New Comment on "Getting started with the Visual Studio 2010 plugin"

ewascent — Wed, 02 Nov 2011 19:09:24 GMT

I am unsure from these directions how to enable the plugin in TFS. I have run the installer locally, selected the the VS 2010 Plugin checkbox, imported the example files into a TFS project, added them to the solution, built, and right clicked on the One strike.feature file. I do not get the context menu above.

New Comment on "Using NBehave as syntactic sugar in unit tests"

fmanibo — Wed, 12 Oct 2011 09:27:38 GMT

Error 1 'NBehave.Narrator.Framework.Feature' does not contain a definition for 'AddStory' and no extension method 'AddStory' accepting a first argument of type 'NBehave.Narrator.Framework.Feature' could be found (are you missing a using directive or an assembly reference?) C:\Documents and Settings\FManibo\My Documents\Trainings\WCF REST\Lab 1\WCFRESTTraining\NBehavePoC\NBehavePoC.Test\Class1.cs 19 18 NBehavePoC.Test

New Comment on "Using NBehave as syntactic sugar in unit tests"

fmanibo — Wed, 12 Oct 2011 09:24:37 GMT

Is the ScenarioDrivenSpecBase for the 5.1 version also following the same Fluent methods, because I just downloaded it and copied this sample but AddStory() is not available.

New Comment on "MSBuildTask"

fmanibo — Wed, 12 Oct 2011 07:38:44 GMT

Error 1 The "NBehaveTask" task failed unexpectedly. System.IO.FileNotFoundException: Could not load file or assembly 'file:///C:\Documents and Settings\FManibo\My Documents\Trainings\WCF REST\Lab 1\WCFRESTTraining\NBehavePoC\bin\debug\NBehavePoC.Test.dll' or one of its dependencies. The system cannot find the file specified. File name: 'file:///C:\Documents and Settings\FManibo\My Documents\Trainings\WCF REST\Lab 1\WCFRESTTraining\NBehavePoC\bin\debug\NBehavePoC.Test.dll' at System.Reflection.RuntimeAssembly._nLoad(AssemblyName fileName, String codeBase, Evidence assemblySecurity, RuntimeAssembly locationHint, StackCrawlMark& stackMark, Boolean throwOnFileNotFound, Boolean forIntrospection, Boolean suppressSecurityChecks) at System.Reflection.RuntimeAssembly.nLoad(AssemblyName fileName, String codeBase, Evidence assemblySecurity, RuntimeAssembly locationHint, StackCrawlMark& stackMark, Boolean throwOnFileNotFound, Boolean forIntrospection, Boolean suppressSecurityChecks) at System.Reflection.RuntimeAssembly.InternalLoadAssemblyName(AssemblyName assemblyRef, Evidence assemblySecurity, StackCrawlMark& stackMark, Boolean forIntrospection, Boolean suppressSecurityChecks) at System.Reflection.RuntimeAssembly.InternalLoadFrom(String assemblyFile, Evidence securityEvidence, Byte[] hashValue, AssemblyHashAlgorithm hashAlgorithm, Boolean forIntrospection, Boolean suppressSecurityChecks, StackCrawlMark& stackMark) at System.Reflection.Assembly.LoadFrom(String assemblyFile) at NBehave.Narrator.Framework.RunnerBase.LoadAssembly(String assemblyPath) at NBehave.MSBuild.NBehaveTask.LoadAssemblies(IRunner runner) at NBehave.MSBuild.NBehaveTask.Execute() at Microsoft.Build.BackEnd.TaskExecutionHost.Microsoft.Build.BackEnd.ITaskExecutionHost.Execute() at Microsoft.Build.BackEnd.TaskBuilder.ExecuteInstantiatedTask(ITaskExecutionHost taskExecutionHost, TaskLoggingContext taskLoggingContext, TaskHost taskHost, ItemBucket bucket, TaskExecutionMode howToExecuteTask, Boolean& taskResult) WRN: Assembly binding logging is turned OFF. To enable assembly bind failure logging, set the registry value [HKLM\Software\Microsoft\Fusion!EnableLog] (DWORD) to 1. Note: There is some performance penalty associated with assembly bind failure logging. To turn this feature off, remove the registry value [HKLM\Software\Microsoft\Fusion!EnableLog]. C:\Documents and Settings\FManibo\My Documents\Trainings\WCF REST\Lab 1\WCFRESTTraining\NBehavePoC\NBehavePoC.Test\NBehavePoC.Test.csproj 79 5 NBehavePoC.Test I am also getting this error, and I need to restart VS and rebuild again without the NBehaveTask, reattach and rebuild.