3. Create Test Runner and Get Code Stubs

You can run JBehave tests in various ways. In this tutorial, we will create a new class that extends the JUnitStories class. It allows running JBehave tests as normal JUnit tests.

1. Create a new class that extends the JUnitStories class:

   

   Click the image to enlarge it.

2. This class must implement the storyPaths method that returns the paths to the feature files. Add the following method to the class:

   Java

   Java

   import org.jbehave.core.junit.JUnitStories;
   
   import java.util.Arrays;
   import java.util.List;
   
   public class UndoTypingTest extends JUnitStories {
       
       protected List<String> storyPaths() {
           return Arrays.asList("UndoFeature.story");
       }
   }

3. To command JBehave to generate code snippets for the missing test steps, add the configuration method to the class:

   Java

   Java

   import org.jbehave.core.configuration.Configuration;
   import org.jbehave.core.configuration.MostUsefulConfiguration;
   import org.jbehave.core.reporters.Format;
   import org.jbehave.core.reporters.StoryReporterBuilder;
   
   public class UndoTypingTest extends JUnitStories {
   
       @Override
       public Configuration configuration() {
           return new MostUsefulConfiguration()
                   .useStoryReporterBuilder(new StoryReporterBuilder()
                       .withFormats(Format.CONSOLE));
       }
   
       ...
   
   }

4. Also, we need to "tell" the runner where it should look for step definitions:

   • Add a new class in the same package as the test runner. This class will contain step definitions.

   • Add the stepsFactory method:

     Java

     Java

     import org.jbehave.core.steps.InjectableStepsFactory;
     import org.jbehave.core.steps.InstanceStepsFactory;
     
     public class UndoTypingTest extends JUnitStories {
     
         @Override
         public InjectableStepsFactory stepsFactory() {
             return new InstanceStepsFactory(configuration(),
                     // Create an instance of the class with step definitions
                     new UndoTypingSteps());
     }
     
         ...
     
     }

Final Code

The final code of the runner class is as follows:

Example

ExampleExample

Java

Java

package com.example.jbehave.test;

import org.jbehave.core.configuration.Configuration;
import org.jbehave.core.configuration.MostUsefulConfiguration;
import org.jbehave.core.junit.JUnitStories;
import org.jbehave.core.reporters.Format;
import org.jbehave.core.reporters.StoryReporterBuilder;
import org.jbehave.core.steps.InjectableStepsFactory;
import org.jbehave.core.steps.InstanceStepsFactory;

import java.util.Arrays;
import java.util.List;

public class UndoTypingTest extends JUnitStories {

    // Specify a class with step definitions
    @Override
    public InjectableStepsFactory stepsFactory() {
        return new InstanceStepsFactory(configuration(), new UndoTypingSteps());
    }

    // Configure the test runner
    @Override
    public Configuration configuration() {
        return new MostUsefulConfiguration()
                // Configure the story report
                .useStoryReporterBuilder(new StoryReporterBuilder()
                        // Post the report to the console
                        .withFormats(Format.CONSOLE));
    }

    // Specify a feature file
    protected List<String> storyPaths() {
        return Arrays.asList("UndoFeature.story");
    }

}

In IntelliJ IDEA, you can run JUnit tests in different ways: from the Run menu, from the Project panel, from the context menu of the code editor. In this tutorial, we will show you how to run tests as part of a Maven build.

1. Open the Maven Projects panel.

   Note:

   If the Maven Project panel is hidden, select View > Tool Window > Maven Projects from the main menu.

2. Select the test phase from the Lifecycle list.

3. Click Run on the panel’s toolbar:

   

   Click the image to enlarge it.

The Run panel shows the test log:

Click the image to enlarge it.

JBehave skips undefined test steps and generates code snippets for the missing test steps. You can find the generated snippets in the test log:

Example

ExampleExample

Running com.example.jbehave.test.UndoTypingTest
Processing system properties {}
Using controls EmbedderControls[batch=false,skip=false,generateViewAfterStories=true,ignoreFailureInStories=false,ignoreFailureInView=false,verboseFailures=false,verboseFiltering=false,storyTimeouts=300,threads=1,failOnStoryTimeout=false]

(BeforeStories)

Running story UndoFeature.story

(UndoFeature.story)
Scenario: Run the "Undo" command using hotkeys
Given I open Notepad (PENDING)
And there is no text in Notepad (PENDING)
When I type "Some text" (PENDING)
And I press [Ctrl + z] (PENDING)
Then I should see no text in Notepad (PENDING)
@Given("I open Notepad")
@Pending
public void givenIOpenNotepad() {
  // PENDING
}

@Given("there is no text in Notepad")
@Pending
public void givenThereIsNoTextInNotepad() {
  // PENDING
}

@When("I type \"Some text\"")
@Pending
public void whenITypeSomeText() {
  // PENDING
}

@When("I press [Ctrl + z]")
@Pending
public void whenIPressCtrlZ() {
  // PENDING
}

@Then("I should see no text in Notepad")
@Pending
public void thenIShouldSeeNoTextInNotepad() {
  // PENDING
}




(AfterStories)

Generating reports view to 'C:\IdeaProjects\JBehaveWithTestLeft\target\jbehave' using formats '[console]' and view properties '{navigator=ftl/jbehave-navigator.ftl, views=ftl/jbehave-views.ftl, reports=ftl/jbehave-reports.ftl, nonDecorated=ftl/jbehave-report-non-decorated.ftl, decorated=ftl/jbehave-report-decorated.ftl, maps=ftl/jbehave-maps.ftl}'
Reports view generated with 3 stories (of which 2 pending) containing 2 scenarios (of which 2 pending)
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.75 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

1. Create a new class in the same package as the test runner.

2. Open the test log and copy the generated code snippets.

3. Paste the code snippets to the created class. Now, you should have a class with a number of method stubs:

   Java

   Java

   public class UndoTypingSteps {
       @Given("I open Notepad")
       @Pending
       public void givenIOpenNotepad() {
           // PENDING
       }
   
       @Given("there is no text in Notepad")
       @Pending
       public void givenThereIsNoTextInNotepad() {
           // PENDING
       }
   
       @When("I type \"Some text\"")
       @Pending
       public void whenITypeSomeText() {
           // PENDING
       }
   
       @When("I press [Ctrl + z]")
       @Pending
       public void whenIPressCtrlZ() {
           // PENDING
       }
   
       @Then("I should see no text in Notepad")
       @Pending
       public void thenIShouldSeeNoTextInNotepad() {
           // PENDING
       }
   }

   Each method corresponds to a test step and consists of the following elements:

   • Annotation - The @Given, @When or @Then annotation that specifies the block of the scenario the test step belongs to.

     Note:

     The @Pending annotation commands JBehave to skip the method, since it is not implemented.

   • Annotation parameter - A regular expression that represents the text of the test step after a keyword.

   • Java method - The method to execute.

4. Currently, there are errors in the class. To fix them, import the following classes:

   Java

   Java

   import org.jbehave.core.annotations.Given;
   import org.jbehave.core.annotations.Pending;
   import org.jbehave.core.annotations.Then;
   import org.jbehave.core.annotations.When;