Is it possible to override step definitions in a behat context?

Question

Is it possible to have have a subcontext class extend another subcontext and override functions?

At present I have

class TestContext extends BehatContext {
    /**
     * @Given /^a testScenarioExists$/
     */
    public function aTestscenarioexists() {
        echo "I am a generic test scenario\n";
    }
}

and

class SpecialTestContext extends TestContext {
    /**
     * @Given /^a testScenarioExists$/
     */
    public function aTestscenarioexists() {
       echo "I am a special test scenario\n";
    }
}

In feature context I tell it us the SpecialTestContext as a subcontext.

When I run the test behat complains with

[Behat\Behat\Exception\RedundantException]
Step "/^a testScenarioExists$/" is already defined in SpecialTestContext::aTestscenarioexists()

Can somebody please point in me the right direction with this ?

To give some further info as to why I'm trying to achieve this what I am trying to achieve is the ability to run scenarios with different environments, and have the environment specified in the gherkin file, for example:

Scenario: Test with generic environment
Given I am in the environment "generic"
    And a test scenario exists

Scenario: Test with specialised environment
Given I am in the environment "specialised"
    And a test scenario exists

I then can use add some code in FeatureContext to load up the correct sub-context.

score 10 · Answer 1 · answered Jul 23 '13 at 16:52

As Rob Squires mentioned, the dynamic context loading will not work.

But I do have a workaround for overriding step definitions, that I use regularly. Don't annotate your method. Behat will pick up the annotation of the overridden method in the superclass, and will map that method name to the matching step. When a matching step is found, the method in your subclass will be invoked. To make it obvious, I've taken to using the @override annotation for this. The @override annotation has no special meaning to Behat.

class SpecialTestContext extends TestContext {
    /**
     * @override Given /^a testScenarioExists$/
     */
    public function aTestscenarioexists() {
       echo "I am a special test scenario\n";
    }
}

This is the actual solution - overriding methods in subclass, without changing the pattern docblock. — Artur Bodera, Mar 28 '14 at 12:56

score 4 · Answer 2 · answered Apr 08 '13 at 23:36

In short...this is not possible : http://docs.behat.org/guides/2.definitions.html#redundant-step-definitions

In terms of loading subcontexts dynamically, this is not possible :

Subcontexts are loaded at 'compile time' - ie. in the main FeatureContext constructor
By the time the first step definition is run, behat has already collected all annotations and mapped them to step definitions, no more can/should be added

Check this out to understand how a Context behaves : http://docs.behat.org/guides/4.context.html#contexts-lifetime

Couple of wider things to consider :

Anything captured in a gherkin scenario must be understandable by non-developers, (or at the very least developers who didn't write the system!). A scenario should convey in-full, one (ideally no more) business rule without having to dig into any code
You don't want to hide too much logic up in step definitions, any rules should be captured in a gherkin scenario
It's up to your how you organise your FeatureContexts, however your going to want to do this by themes/domains within your system, for example:
- a DatabaseContext may be concerned with reading + writing to a test db
- an ApiContext may contain steps concerned with validating an api within your system
- an CommandContext may be concerned with validating your systems console commands

Just updating the links provided above. * http://docs.behat.org/en/latest/user_guide/context/definitions.html#redundant-step-definitions * http://docs.behat.org/en/latest/user_guide/context.html#contexts-lifetime — aczietlow, Aug 24 '17 at 17:07

score 0 · Answer 3 · answered Sep 18 '13 at 19:31

0

Overwrited method cannot be defined with the same sentence.

class SpecialTestContext extends TestContext {

  public function aTestscenarioexists() {
    echo "I am a special test scenario\n";
  }
}

answered Sep 18 '13 at 19:31

Lawondyss

85
6

Is it possible to override step definitions in a behat context?

3 Answers3