Reqnroll

https://docs.reqnroll.net/latest
Admin
Reqnroll is an open-source .NET test automation tool for Behavior Driven Development (BDD), enabling...
Tokens:104,707
Snippets:833
Trust Score:7.5
Update:1 day ago
Show doc for...
Tokens:
Raw
### Scenario Outline with Examples table

Source: https://docs.reqnroll.net/latest/gherkin/gherkin-reference.html

Uses a template with <start>, <eat>, and <left> parameters and an Examples table to run the scenario once per row. The steps are never run directly; parameters are replaced before matching.

```gherkin
Scenario Outline: eating
  Given there are <start> cucumbers
  When I eat <eat> cucumbers
  Then I should have <left> cucumbers

  Examples:
    | start | eat | left |
    |    12 |   5 |    7 |
    |    20 |   5 |   15 |
```

--------------------------------

### New step example

Source: https://docs.reqnroll.net/latest/guides/migrating-from-specflow.html

Example of a new step written in Gherkin.

```gherkin
When I have 42 cucumbers in my belly
```

--------------------------------

### Feature file: accessing example arguments

Source: https://docs.reqnroll.net/latest/automation/scenario-context.html

Defines a scenario with an Examples table to demonstrate accessing the current example arguments via ScenarioInfo.

```gherkin
Scenario: Accessing the current example 

When I use examples in my scenario
Then the examples are available in ScenarioInfo 

    Examples:
    | Sport      | TeamSize |
    | Soccer     | 11       |
    | Basketball | 6        |
```

--------------------------------

### Step definition: accessing example arguments

Source: https://docs.reqnroll.net/latest/automation/scenario-context.html

Step definitions that retrieve the current example arguments from ScenarioInfo.Arguments and print them to the console.

```csharp
public class ScenarioExamplesDemo
{
    private ScenarioInfo _scenarioInfo;

    public ScenarioExamplesDemo(ScenarioInfo scenarioInfo)
    {
        _scenarioInfo = scenarioInfo;
    }

    [When(@"I use examples in my scenario")]
    public void IUseExamplesInMyScenario() {}

    [Then(@"the examples are available in ScenarioInfo")]
    public void TheExamplesAreAvailableInScenarioInfo()
    {
        var currentArguments = _scenarioInfo.Arguments;
        var currentSport = currentArguments["Sport"];
        var currentTeamSize = currentArguments["TeamSize"];
        Console.WriteLine($"The current sport is {currentSport}");
        Console.WriteLine($"The current sport allows teams of {currentTeamSize} players");
    }
}
```

--------------------------------

### Feature-level Background example (MultipleSiteSupport.feature)

Source: https://docs.reqnroll.net/latest/gherkin/gherkin-reference.html

Shows a Background section placed before scenarios in a Feature. The Background steps run before each scenario, after any Before hooks. The example includes three scenarios that use the background context.

```gherkin
Feature: Multiple site support
  Only blog owners can post to a blog, except administrators,
  who can post to all blogs.

  Background:
    Given a global administrator named "Greg"
    And a blog named "Greg's anti-tax rants"
    And a customer named "Dr. Bill"
    And a blog named "Expensive Therapy" owned by "Dr. Bill"

  Scenario: Dr. Bill posts to his own blog
    Given I am logged in as Dr. Bill
    When I try to post to "Expensive Therapy"
    Then I should see "Your article was published."

  Scenario: Dr. Bill tries to post to somebody else's blog, and fails
    Given I am logged in as Dr. Bill
    When I try to post to "Greg's anti-tax rants"
    Then I should see "Hey! That's not your blog!"

  Scenario: Greg posts to a client's blog
    Given I am logged in as Greg
    When I try to post to "Expensive Therapy"
    Then I should see "Your article was published."
```

--------------------------------

### CSV: Extending product list with example table

Source: https://docs.reqnroll.net/latest/integrations/externaldata.html

Combines CSV data with an example table, resulting in 4 products (3 from CSV plus 'Cheesecake').

```gherkin
@DataSource:products.csv
Scenario Outline: Valid product prices are calculated (Outline)	
	Given the customer has put 1 pcs of <product> to the basket
	When the basket price is calculated
	Then the basket price should be greater than zero
Examples: 
	| product    |
	| Cheesecake |
```

--------------------------------

### editor section example configuration

Source: https://docs.reqnroll.net/latest/ide-integrations/visual-studio/settings.html

Example JSON configuration for the editor section, showing how to set showStepCompletionAfterStepKeywords and gherkinFormat options like indentFeatureChildren, indentSteps, indentAndSteps, and tableCellPaddingSize.

```json
{
  "ide": {
    "editor": {
      "showStepCompletionAfterStepKeywords": true,
      "gherkinFormat": {
        "indentFeatureChildren": false,
        "indentSteps": true,
        "indentAndSteps": false,
        "tableCellPaddingSize": 1
      }
    }
  }
}
```

--------------------------------

### Install Reqnroll templates and add configuration file

Source: https://docs.reqnroll.net/latest/installation/configuration.html

Use these .NET CLI commands to install the Reqnroll templates and add a reqnroll.json configuration file to your project.

```bash
dotnet new install Reqnroll.Templates.DotNet
dotnet new reqnroll-config
```

--------------------------------

### Install Reqnroll templates with dotnet new install

Source: https://docs.reqnroll.net/latest/installation/setup-project.html

Installs the Reqnroll project templates so you can create new Reqnroll projects with the dotnet new command.

```bash
dotnet new install Reqnroll.Templates.DotNet
```

--------------------------------

### Horizontal Table Example

Source: https://docs.reqnroll.net/latest/automation/datatable-helpers.html

Feature file example showing a horizontal table layout for updating an account. The table has columns for Name and Bank Account Balance.

```gherkin
Given I update the account with the following data:
    | Name     | Bank Account Balance |
    | Jane Doe | 2500.75              |
```

--------------------------------

### Feature file: scenario info example

Source: https://docs.reqnroll.net/latest/automation/scenario-context.html

Defines a scenario with feature, rule, and scenario tags, and a step that verifies the ScenarioInfo fields.

```gherkin
@feature_tag
Feature: My feature

@rule_tag
Rule: My rule

@scenario_tag1 @scenario_tag2
Scenario: Showing information of the scenario

When I execute any scenario
Then the ScenarioInfo contains the following information
    | Field         | Value                                               |
    | Title         | Showing information of the scenario                 |
    | Tags          | scenario_tag1, scenario_tag2                        |
    | CombinedTags  | scenario_tag1, scenario_tag2, feature_tag, rule_tag |
```

--------------------------------

### Vertical Table Example

Source: https://docs.reqnroll.net/latest/automation/datatable-helpers.html

Feature file example showing a vertical table layout for updating an account. The table has Property and Value columns.

```gherkin
Given I update the account with the following data:
    | Property             | Value     |
    | Name                 | Jane Doe  |
    | Bank Account Balance | 2500.75   |
```

--------------------------------

### Feature File: Multiple Givens with And and But

Source: https://docs.reqnroll.net/latest/gherkin/gherkin-reference.html

Shows the same scenario as the previous example but using And and But to replace repeated Given and Then keywords, making the steps read more fluidly.

```gherkin
Scenario: Multiple Givens
  Given one thing
  And another thing
  And yet another thing
  When I open my eyes
  Then I should see something
  But I shouldn't see something else
```

--------------------------------

### reqnroll.json configuration example

Source: https://docs.reqnroll.net/latest/guides/migrating-from-specflow.html

Example of a reqnroll.json configuration file with the official JSON schema reference, a feature language setting, and a bindingAssemblies entry. Rename specflow.json to reqnroll.json and update the renamed settings as recommended.

```json
{
  "$schema": "https://schemas.reqnroll.net/reqnroll-config-latest.json",

  "language": {
    "feature": "hu-HU"
  },
  "bindingAssemblies": [
    {
      "assembly": "ExternalStepDefs"
    }
  ]
}
```

--------------------------------

### Rule-level Background example (OverdueTasks.feature)

Source: https://docs.reqnroll.net/latest/gherkin/gherkin-reference.html

Shows a Background section placed inside a Rule, before its scenarios. The Background steps run before each scenario in that Rule. The example includes two scenarios that use the background context.

```gherkin
Feature: Overdue tasks
  Let users know when tasks are overdue, even when using other
  features of the app

  Rule: Users are notified about overdue tasks on first use of the day
    Background:
      Given I have overdue tasks

    Scenario: First use of the day
      Given I last used the app yesterday
      When I use the app
      Then I am notified about overdue tasks

    Scenario: Already used today
      Given I last used the app earlier today
      When I use the app
      Then I am not notified about overdue tasks
  ...
```

--------------------------------

### FillInstance with InstanceCreationOptions

Source: https://docs.reqnroll.net/latest/automation/datatable-helpers.html

Uses FillInstance with InstanceCreationOptions to control property population. The example sets VerifyAllColumnsBound to true, which likely verifies that all columns are bound to properties.

```csharp
[Given(@"I update the account with the following data:")]
public void GivenIUpdateTheAccountWithTheFollowingData(DataTable table)
{
    var existingAccount = GetExistingAccount();
    
    var options = new InstanceCreationOptions 
    { 
        VerifyAllColumnsBound = true 
    };
    
    table.FillInstance(existingAccount, options);
}
```

--------------------------------

### Person record for RequireTableToProvideAllConstructorParameters example

Source: https://docs.reqnroll.net/latest/automation/datatable-helpers.html

Test object record with three parameters: FirstName, LastName, and Age. Used to demonstrate constructor selection behavior.

```csharp
public record Person(string FirstName, string LastName, int Age);
```

--------------------------------

### Feature File: All done with asterisk steps

Source: https://docs.reqnroll.net/latest/gherkin/gherkin-reference.html

Shows the same scenario as the previous example but using asterisks (*) instead of And for the list of items, making it read like bullet points.

```gherkin
Scenario: All done
  Given I am out shopping
  * I have eggs
  * I have milk
  * I have butter
  When I check my list
  Then I don't need anything
```

--------------------------------

### Start Selenium for scenarios tagged with @web and @automated

Source: https://docs.reqnroll.net/latest/automation/scoped-bindings.html

This C# example defines a binding class that uses ScenarioContext to check if the scenario has the 'automated' tag in addition to the 'web' tag, and starts Selenium if so. The BeforeScenario hook is scoped to the 'web' tag, and the condition inside checks for the 'automated' tag.

```csharp
[Binding]
public class Binding
{
    ScenarioContext _scenarioContext;

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

    [BeforeScenario("web")]
    public static void BeforeWebScenario()
    {
        if(_scenarioContext.ScenarioInfo.Tags.Contains("automated"))
            StartSelenium();
    }
}
```

--------------------------------

### Example test project file without ReqnrollEmbedFeatureFiles

Source: https://docs.reqnroll.net/latest/installation/configuring-build.html

A basic MSBuild project file for a test project using Reqnroll. This is the starting point before enabling the ReqnrollEmbedFeatureFiles build variable.

```xml
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net9.0</TargetFramework>
    ...
  </PropertyGroup>
  ...
</Project>
```

--------------------------------

### GuessTheWord.feature - Example Gherkin feature file

Source: https://docs.reqnroll.net/latest/gherkin/gherkin-reference.html

Shows a complete Gherkin feature file with two scenarios. Comments are allowed at the start of a line, and indentation uses two spaces. The trailing portion of each step is matched to a step definition.

```gherkin
Feature: Guess the word

  # The first example has two steps
  Scenario: Maker starts a game
    When the Maker starts a game
    Then the Maker waits for a Breaker to join

  # The second example has three steps
  Scenario: Breaker joins a game
    Given the Maker has started a game with the word "silky"
    When the Breaker joins the Maker's game
    Then the Breaker must guess a word with 5 characters
```

--------------------------------

### Feature File: All done with And steps

Source: https://docs.reqnroll.net/latest/gherkin/gherkin-reference.html

Shows a scenario using And to chain Given steps, listing items like eggs, milk, and butter. This is the conventional style before using asterisks.

```gherkin
Scenario: All done
  Given I am out shopping
  And I have eggs
  And I have milk
  And I have butter
  When I check my list
  Then I don't need anything
```

--------------------------------

### CSV: @DataSource above example table

Source: https://docs.reqnroll.net/latest/integrations/externaldata.html

Shows placing the @DataSource tag above the example table instead of the scenario.

```gherkin
Scenario Outline: Valid product prices are calculated (Outline, example annotation)
	Given the customer has put 1 pcs of <product> to the basket
	When the basket price is calculated
	Then the basket price should be greater than zero
@DataSource:products.csv
Examples: 
	| product    |
	| Cheesecake |
```

--------------------------------

### Automate steps in PriceCalculationStepDefinitions.cs

Source: https://docs.reqnroll.net/latest/quickstart/index.html

Provides the full step definition class with Given, When, and Then methods. The Given steps prepare the basket, the When step invokes CalculatePrice, and the Then step asserts the expected price.

```csharp
namespace ReqnrollQuickstart.Specs.StepDefinitions;

[Binding]
public class PriceCalculationStepDefinitions
{
    private readonly PriceCalculator _priceCalculator = new();
    private readonly Dictionary<string, int> _basket = new();
    private decimal _calculatedPrice;

    [Given("the client started shopping")]
    public void GivenTheClientStartedShopping()
    {
        _basket.Clear();
        _calculatedPrice = 0.0m;
    }

    [Given("the client added {int} pcs of {string} to the basket")]
    public void GivenTheClientAddedPcsOfToTheBasket(int quantity, string product)
    {
        _basket.Add(product, quantity);
    }

    [When("the basket is prepared")]
    public void WhenTheBasketIsPrepared()
    {
        _calculatedPrice = _priceCalculator.CalculatePrice(_basket);
    }

    [Then("the basket price should be ${float}")]
    public void ThenTheBasketPriceShouldBe(decimal expectedPrice)
    {
        Assert.AreEqual(expectedPrice, _calculatedPrice);
    }
}
```

--------------------------------

### Feature file: Show the type of step we're currently on

Source: https://docs.reqnroll.net/latest/automation/scenario-context.html

Gherkin feature file defining a scenario with Given, When, and Then steps to demonstrate the CurrentScenarioBlock property.

```gherkin
Scenario: Show the type of step we're currently on
    Given I have a Given step
    And I have another Given step
    When I have a When step
    Then I have a Then step
```

--------------------------------

### Install Reqnroll.Microsoft.Extensions.DependencyInjection via NuGet

Source: https://docs.reqnroll.net/latest/integrations/dependency-injection.html

Use this Package Manager command to install the Reqnroll.Microsoft.Extensions.DependencyInjection plugin into your Reqnroll project. Requires Microsoft.Extensions.DependencyInjection v6.0.0 or above.

```powershell
PM> Install-Package Reqnroll.Microsoft.Extensions.DependencyInjection
```

--------------------------------

### Install Reqnroll.Autofac plugin via NuGet

Source: https://docs.reqnroll.net/latest/integrations/autofac.html

Install the Reqnroll.Autofac package into your Reqnroll project using the Package Manager Console. Supports Autofac v4.0.0 or above.

```powershell
PM> Install-Package Reqnroll.Autofac
```

--------------------------------

### Example ide Configuration in reqnroll.json

Source: https://docs.reqnroll.net/latest/ide-integrations/visual-studio/settings.html

Shows the 'ide' section of the reqnroll.json file with editor and traceability settings. The editor section configures step completion and Gherkin formatting, while the traceability section defines tag links for issue tracking. Build the project for changes to take effect.

```json
"ide": {
  "editor": {
    "showStepCompletionAfterStepKeywords": true,
    "gherkinFormat": {
      "indentFeatureChildren": false,
      "indentSteps": true
    }
  },
  "traceability": {
    "tagLinks": [
      {
        "tagPattern": "issue:(?<id>\\d+)",
        "urlTemplate": "https://github.com/org/repo/issues/{id}"
      }
    ]
  }
}
```

--------------------------------

### Install Reqnroll.Windsor NuGet package

Source: https://docs.reqnroll.net/latest/integrations/windsor.html

Use this command in the Package Manager Console to install the Reqnroll.Windsor plugin into your Reqnroll project. Requires Castle Windsor v5.0.1 or above.

```powershell
PM> Install-Package Reqnroll.Windsor
```

--------------------------------

### C# Project File (.csproj) after replacing SpecFlow packages with Reqnroll

Source: https://docs.reqnroll.net/latest/guides/migrating-from-specflow.html

Example project file after removing SpecFlow packages and adding Reqnroll.MsTest. Shows the required package references for a test project using MSTest.

```xml
<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <!-- test project dependencies (MsTest) -->
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
    <PackageReference Include="MSTest.TestAdapter" Version="3.2.0" />
    <PackageReference Include="MSTest.TestFramework" Version="3.2.0" />

    <!-- Reqnroll -->
    <PackageReference Include="Reqnroll.MsTest" Version="2.0.0" />
  </ItemGroup>
  [...]
</Project>
```

--------------------------------

### Scenario with Tags on Examples (Unsupported)

Source: https://docs.reqnroll.net/latest/integrations/mstest.html

Shows a Gherkin scenario with tags on Examples that are not sent to test execution in MsTest. The tags @Test and @Acceptance are not available for filtering or reporting.

```gherkin
Scenario: Sample Scenario  
   Given sample step

@Test
Examples:  
| User   |  
| Tester |

@Acceptance
Examples:  
| User   |  
| Acc    |
```

--------------------------------

### Example environment variables for custom build system

Source: https://docs.reqnroll.net/latest/extend/build-metadata-provider.html

Shell commands to set environment variables expected by a custom build metadata provider. Includes CUSTOM_BUILD_ID, CUSTOM_BUILD_URL, CUSTOM_BUILD_NUMBER, CUSTOM_SCM_REMOTE, CUSTOM_SCM_REVISION, CUSTOM_SCM_BRANCH, and CUSTOM_SCM_TAG (empty for non-tag builds).

```bash
# Example environment variables for your custom system
export CUSTOM_BUILD_ID="12345"
export CUSTOM_BUILD_URL="https://build.mycompany.com/builds/12345"
export CUSTOM_BUILD_NUMBER="1.2.3-build.12345"
export CUSTOM_SCM_REMOTE="https://scm.mycompany.com/repo/myproject.git"
export CUSTOM_SCM_REVISION="a1b2c3d4e5f6789012345678901234567890abcd"
export CUSTOM_SCM_BRANCH="main"
export CUSTOM_SCM_TAG=""  # Empty if not a tag build
```

--------------------------------

### Implement IBuildMetadataProvider (C#)

Source: https://docs.reqnroll.net/latest/extend/build-metadata-provider.html

Custom implementation of IBuildMetadataProvider that reads environment variables to build BuildMetadata. Returns null if the custom build environment is not detected. Uses IEnvironmentWrapper to access environment variables.

```csharp
using Reqnroll.EnvironmentAccess;

namespace MyCompany.CustomScm.ReqnrollPlugin
{
    public class CustomBuildMetadataProvider : IBuildMetadataProvider
    {
        private readonly IEnvironmentWrapper _environment;

        public CustomBuildMetadataProvider(IEnvironmentWrapper environment)
        {
            _environment = environment;
        }

        public BuildMetadata GetBuildMetadata()
        {
            // Check if we're running in your custom build environment
            var customBuildId = GetEnvironmentVariable("CUSTOM_BUILD_ID");
            if (string.IsNullOrEmpty(customBuildId))
                return null; // Not running in our custom environment

            // Extract metadata from your custom environment variables
            var buildUrl = GetEnvironmentVariable("CUSTOM_BUILD_URL");
            var buildNumber = GetEnvironmentVariable("CUSTOM_BUILD_NUMBER");
            var remote = GetEnvironmentVariable("CUSTOM_SCM_REMOTE");
            var revision = GetEnvironmentVariable("CUSTOM_SCM_REVISION");
            var branch = GetEnvironmentVariable("CUSTOM_SCM_BRANCH");
            var tag = GetEnvironmentVariable("CUSTOM_SCM_TAG");

            return new BuildMetadata(buildUrl, buildNumber, remote, revision, branch, tag)
            {
                ProductName = "Custom Build System"
            };
        }

        private string GetEnvironmentVariable(string variable)
        {
            var result = _environment.GetEnvironmentVariable(variable);
            return result is ISuccess<string> success ? success.Result : null;
        }
    }
}
```

--------------------------------

### CSV: Scenario with product and price parameters

Source: https://docs.reqnroll.net/latest/integrations/externaldata.html

Uses both <product> and <price> from the CSV file to verify the basket price.

```gherkin
@DataSource:products.csv
Scenario: The basket price is calculated correctly
	Given the price of <product> is €<price>
	And the customer has put 1 pcs of <product> to the basket
	When the basket price is calculated
	Then the basket price should be €<price>
```

--------------------------------

### CSV: Basic scenario with product parameter

Source: https://docs.reqnroll.net/latest/integrations/externaldata.html

Treats the scenario as a scenario outline, replacing <product> with values from products.csv.

```gherkin
@DataSource:products.csv
Scenario: Valid product prices are calculated
	Given the customer has put 1 piece of <product> in the basket
	When the basket price is calculated
	Then the basket price should be greater than zero
```

--------------------------------

### Step definition using CreateInstance with ValueTuple

Source: https://docs.reqnroll.net/latest/automation/datatable-helpers.html

Example step definition using table.CreateInstance<(string name, DateTime birthDate, int heightInInches, decimal bankAccountBalance)>() to map a DataTable to a ValueTuple. Parameter names do not matter, but the number and types must match. Mapping more than 7 properties is not supported and throws an exception.

```csharp
[Given(@"Given I entered the following data into the new account form:")]
public void GivenIEnteredTheFollowingDataIntoTheNewAccountForm(DataTable table)
{
    var account = table.CreateInstance<(string name, DateTime birthDate, int heightInInches, decimal bankAccountBalance)>();

    // account.name is "John Galt"
    // account.heightInInches is 72
    // account.bankAccountBalance is 1234.56
}
```

--------------------------------

### Using CreateInstance and CreateSet

Source: https://docs.reqnroll.net/latest/extend/value-retrievers.html

Shows how to convert a DataTable to a single instance or a set of instances.

```csharp
    [Given(@"I have the following people")]
    public void x(DataTable table)
    {
        var person = table.CreateInstance<Person>();
        // OR
        var people = table.CreateSet<Person>();
    }
```

--------------------------------

### Instance field example for sharing data between steps

Source: https://docs.reqnroll.net/latest/automation/sharing-data-between-bindings.html

This example shows how to store the result of an MVC action in an instance field to use it in a later step. The binding class is instantiated per scenario, so the field is scoped to the scenario.

```csharp
[Binding]
public class SearchSteps
{
    private ActionResult actionResult;

    [When(@"I perform a simple search on '(.*)'")]
    public void WhenIPerformASimpleSearchOn(string searchTerm)
    {
        var controller = new CatalogController();
        actionResult = controller.Search(searchTerm);
    }

    [Then(@"the book list should exactly contain book '(.*)'")]
    public void ThenTheBookListShouldExactlyContainBook(string title)
    {
         var books = actionResult.Model<List<Book>>();
         CustomAssert.Any(books, b => b.Title == title);
    }
}
```

--------------------------------

### Step definitions using injected VerifySettings

Source: https://docs.reqnroll.net/latest/integrations/verify.html

C# step definitions that inject VerifySettings and use Verifier.Verify to snapshot the result.

```csharp
[Binding]
internal class StepDefinitions
{
    private readonly VerifySettings _settings;
    private int _result;

    public StepDefinitions(VerifySettings settings)
    {
        _settings = settings;
    }
    
    [When("I calculate (\d+) + (\d+)")]
    public void WhenICalculate(int v1, int v2)
    {
        _result = v1 + v2; // simulate calling the SUT to get the result
    }
    
    [Then("I expect the result is correct")]
    public void ThenIExpectTheResultIsCorrect()
    {
        Verifier.Verify(_result, _settings);
    }
}
```

--------------------------------

### vstest.console.exe filter for @done

Source: https://docs.reqnroll.net/latest/execution/executing-specific-scenarios.html

Command-line example using vstest.console.exe with /TestCaseFilter to run scenarios with @done tag.

```bash
vstest.console.exe "C:\Temp\BookShop.AcceptanceTests.dll" /TestCaseFilter:"TestCategory=done"
```

--------------------------------

### Calculator.feature - Example feature file

Source: https://docs.reqnroll.net/latest/gherkin/feature-files.html

A sample Gherkin feature file describing calculator addition. It includes a Feature, Rule, and a tagged Scenario with Given/When/Then steps. Use this as a template for writing feature files.

```gherkin
Feature: Calculator

Simple calculator for adding two numbers

Rule: Add should calculate the sum of the entered numbers

@mytag
Scenario: Add two numbers
	Given the first number is 50
	And the second number is 70
	When the two numbers are added
	Then the result should be 120
```

--------------------------------

### Shirt and Color classes

Source: https://docs.reqnroll.net/latest/extend/value-retrievers.html

Example POCO types with a custom Color type that requires a custom value retriever.

```csharp
    public class Shirt
    {
        public Guid Id { get; set; }
        public string Name { get; set; }
        public Color Color { get; set; }
    }

    public class Color
    {
        public string Name { get; set; }
    }
```

--------------------------------

### Create the Runtime Plugin (C#)

Source: https://docs.reqnroll.net/latest/extend/build-metadata-provider.html

Registers the custom build metadata provider in the global container via IRuntimePlugin. The assembly attribute declares the plugin type for Reqnroll discovery.

```csharp
using Reqnroll.BoDi;
using Reqnroll.Plugins;
using Reqnroll.EnvironmentAccess;

[assembly: RuntimePlugin(typeof(MyCompany.CustomScm.ReqnrollPlugin.CustomBuildMetadataPlugin))]

namespace MyCompany.CustomScm.ReqnrollPlugin
{
    public class CustomBuildMetadataPlugin : IRuntimePlugin
    {
        public void Initialize(RuntimePluginEvents runtimePluginEvents, 
                              RuntimePluginParameters runtimePluginParameters,
                              UnitTestProviderConfiguration unitTestProviderConfiguration)
        {
            // Register our custom implementation in the global container
            runtimePluginEvents.CustomizeGlobalDependencies += (sender, args) =>
            {
                args.ObjectContainer.RegisterTypeAs<CustomBuildMetadataProvider, IBuildMetadataProvider>();
            };
        }
    }
}
```

--------------------------------

### Example table with people data

Source: https://docs.reqnroll.net/latest/extend/value-retrievers.html

A Gherkin table used to demonstrate how Reqnroll maps table rows to objects.

```gherkin
Given I have the following people
| First Name | Last Name | Age | IsAdmin | 
| John       | Guppy     | 40  | true    |
```

--------------------------------

### Enable HTML formatter in reqnroll.json

Source: https://docs.reqnroll.net/latest/reporting/reqnroll-formatters.html

Configuration file example that enables the HTML formatter and sets the output file to reqnroll_report.html.

```json
{
  "$schema": "https://schemas.reqnroll.net/reqnroll-config-latest.json",

    "formatters": {
        "html" : { "outputFilePath" : "reqnroll_report.html" }
    }
}
```

--------------------------------

### SmartBuildMetadataProvider with complex environment detection

Source: https://docs.reqnroll.net/latest/extend/build-metadata-provider.html

C# class that detects the environment based on multiple indicators such as custom system variables, Docker environment, and build tool identifiers. Includes helper methods for variable retrieval and placeholder comments for metadata generation.

```csharp
public class SmartBuildMetadataProvider : IBuildMetadataProvider
{
    private readonly IEnvironmentWrapper _environment;

    public SmartBuildMetadataProvider(IEnvironmentWrapper environment)
    {
        _environment = environment;
    }

    public BuildMetadata GetBuildMetadata()
    {
        // Detect environment based on multiple indicators
        if (IsCustomSystemA())
            return GetCustomSystemAMetadata();
        
        if (IsCustomSystemB())
            return GetCustomSystemBMetadata();
            
        if (IsDockerEnvironment())
            return GetDockerEnvironmentMetadata();
            
        return null;
    }

    private bool IsCustomSystemA()
    {
        return !string.IsNullOrEmpty(GetVariable("CUSTOM_A_BUILD_ID")) &&
               !string.IsNullOrEmpty(GetVariable("CUSTOM_A_PROJECT"));
    }

    private bool IsCustomSystemB()
    {
        var buildTool = GetVariable("BUILD_TOOL");
        var buildId = GetVariable("BUILD_IDENTIFIER");
        return "CustomTool".Equals(buildTool, StringComparison.OrdinalIgnoreCase) &&
               !string.IsNullOrEmpty(buildId);
    }

    private bool IsDockerEnvironment()
    {
        return File.Exists("/.dockerenv") ||
               !string.IsNullOrEmpty(GetVariable("DOCKER_CONTAINER_ID"));
    }

    private string GetVariable(string name)
    {
        var result = _environment.GetEnvironmentVariable(name);
        return result is ISuccess<string> success ? success.Result : null;
    }

    // Implementation methods for GetCustomSystemAMetadata(), etc.
}
```
Tokens:
Raw