ScenarioBuilder extendability

We are implementing extensions on the fluent scenario builder to be able to run scenarios according to configuration data while running the tests. For example run specific tests only on specific environments (QA / Prod).

We have implement the feature by creating an extension method on the runner methods.

Examples

Extended Extension

public static async Task RunScenarioActionOnEnvironmentAsync<TContext>(
        this IBddRunner<TContext> runner,
        string env,
        params Expression<Action<TContext>>[] steps
)
{
    if (env.Equals(ConfigEnv))
    {
        await runner.RunScenarioActionsAsync(steps);
    }
    else
    {
        StepExecution.Current.IgnoreScenario(_message);
    }
}

Fluent Extension

public static async Task RunOnEnvAsync<TContext>(
    this IScenarioBuilder<TContext> builder,
    string env
)
{
    if (env.Equals(ConfigEnv))
    {
        await builder.RunAsync();
    }
    else
    {
        StepExecution.Current.IgnoreScenario(Message);
    }
}

Ideally, instead we want to add an extension method to be able to filter test scenarios which would be much cleaner + we can add more filters. But to implement such a feature we require to have a Dictionary in the ScenarioBuilder class to be able to add specific filters.

Usage

// extensions
public static IScenarioBuilder<TContext> FilterEnv<TContext>(this IScenarioBuilder<TContext> builder, string env)
{
    builder.Items.Add("ENV", env);
    return builder;
}

public static async Task RunWithFilters<TContext>(this IScenarioBuilder<TContext> builder)
{
    string env = (string)builder.Items["ENV"];
    if (env.Equals(ConfigEnv))
    {
        await builder.RunAsync();
    }
    else
    {
        StepExecution.Current.IgnoreScenario(Message);
    }
}

// usage in feature specs
public async Task Browsing_invoices()
{

    await Runner
        .NewScenario()
        .FilterEnv("QA") // our extension method
        .AddAsyncSteps(
            _ => Given_invoice("Invoice-1"),
            _ => Given_invoice("Invoice-2"))
        .AddSteps(
            When_I_request_all_historical_invoices)
        .AddSteps(
            _ => Then_I_should_see_invoices("Invoice-1", "Invoice-2"))
        .RunWithFilter(); // our extension method
}

If you agree I am happy to create a PR.

[Suremaker]

Hey, I did not have gitter before but created room there (https://gitter.im/LightBDD/LightBDD) and sent you an invite. Will add it to repo readme as well as I think it may be easier to ask questions there than via github issues

[Suremaker]

Cool, it’s good to hear it works for you.

In fact both mentioned attributes works on step and scenario methods as they implement both decorator interfaces.

See how the IgnoreScenarioAttribute implements IStepDecoratorAttribute here: https://github.com/LightBDD/LightBDD/blob/master/src/LightBDD.NUnit3/IgnoreScenarioAttribute.cs

… while example usage is described here: https://github.com/LightBDD/LightBDD/wiki/What-Is-New#2-declarative-way-for-ignoring-scenarios-and-steps