VariantsPlugin 2.0.5

ReqNRoll Plugin: Tag Variant Extender

Repository

This plugin extends the functionality of ReqNRoll by enabling automatic generation of additional test cases based on tag variants, ensuring comprehensive test coverage.

Features

Variants Plugin notes

One of the following unit test providers package should be installed:

• Reqnroll.NUnit
• Reqnroll.XUnit
• Reqnroll.MSTest

Installation

1. Add the plugin via NuGet:

   dotnet add package VariantsPlugin
   

2. Ensure your project references ReqNRoll and is set up correctly.

Usage

Step 1: Add Variant Key at reqnroll.json

{
    "variantkey": "Browser"
}

Step 2: Annotate Scenarios with Tags

Use tags in your scenarios:

@Browser:Chrome
@Browser:Firefox
Scenario: Access Dashboard
  Given the user is logged in
  When they navigate to the dashboard
  Then they should see their account summary

Step 3: Access the variant

The variant key/value can then be accessed via the ScenarioContext static or injected class.

[Binding]
public sealed class Hooks
{
    private readonly ScenarioContext _scenarioContext;
    private IWebDriver _driver;

    public Hooks(ScenarioContext scenarioContext)
    {
        _scenarioContext = scenarioContext;
    }

    [BeforeScenario]
    public void BeforeScenario()
    {
        _scenarioContext.TryGetValue("Browser", out var browser);

        switch (browser)
        {
            case "Chrome":
                _driver = SetupChromeDriver();
                break;
            case "Firefox":
                _driver = SetupFirefoxDriver();
                break;
            default:
                _driver = SetupChromeDriver();
                break;
        }
        _scenarioContext.ScenarioContainer.RegisterInstanceAs(_driver);
    }
    ...
}

Step 4: Run Your Tests

The plugin generates scenarios for all tag combinations.

Example Output

For the following configuration in reqnroll.json:

"variantkey": "Browser"

@Browser:Chrome @Browser:Firefox @Browser:Safari
Scenario: This is a scenario
    Given this
    When that 
    Then this

A scenario tagged with @Browser will generate tests for:

In every Test generated, Scenario Context includes the specified Variant. For Example in test "This_is_a_scenario_Chrome" ScenarioContext["Browser"] contains "Chrome".

Configuration Options

Requirements

• .NET Version: .NET 7.0 or higher
• Dependencies: ReqNRoll version >= 3.1.2

Contribution

We welcome contributions! If you have suggestions, bug reports, or feature requests:

1. Open an issue on the repository.
2. Submit a pull request with your changes.

Additional Functionality (Only for NUnit): Retry Mechanism

Step 1: Enable retries at reqnroll.json

{
  "VariantKey": "Operator",
  "IsRetryActive": {
    "Enabled": true,
    "ApplyGlobally": true,
    "GlobalMaxRetries": 4
  }
}

ApplyGlobally adds retries to all tests of your framework and GlobalMaxRetries is the number of retries that are going to be applied for all tests.

If GlobalMaxRetries is set to true Enabled (simple tag retry functionality) mentioned below won't work.

Step 2: Use Retry Tag to Scenario Level or Feature level

@Retry
Scenario: This is a scenario
    Given this
    When that 
    Then this

Hint: Retry tag applies retry up to 3 times. If you need to have more or less use @Retry(n) tag.

License

This plugin is licensed under the MIT License. See LICENSE for details.

Contact

For support or inquiries, reach out to AnThivaios at anthivaios@gmail.com.