-
Notifications
You must be signed in to change notification settings - Fork 1
Tags and Attributes
Tags control how scenarios are categorised and filtered in the generated reports.
Mark a scenario as a "happy path" to support filtering in the HTML reports.
| Framework | How to mark |
|---|---|
| xUnit |
[HappyPath] attribute on the test method |
| NUnit |
[HappyPath] attribute on the test method |
| MSTest |
[HappyPath] attribute on the test method |
| BDDfy | .WithTags("happy-path") |
| LightBDD |
[HappyPath] attribute on the scenario method (from Kronikol.LightBDD.Core — extends LabelAttribute) |
| ReqNRoll |
@happy-path tag on the Gherkin scenario |
In the HTML reports, happy path scenarios are sorted first within each feature and display a "Happy Path" badge. Use the "Happy Paths Only" toggle in the filtering toolbar to show only happy path scenarios.
Associate a feature/test class with an API endpoint. This appears as metadata in the reports.
| Framework | How to set |
|---|---|
| xUnit |
[Endpoint("/api/cake")] attribute on the test class |
| NUnit |
[Endpoint("/api/cake")] attribute on the test fixture class |
| MSTest |
[Endpoint("/api/cake")] attribute on the test class |
| BDDfy | .WithTags("endpoint:/api/cake") |
| ReqNRoll |
@endpoint:/api/cake tag on the Gherkin Feature
|
Assign categories to scenarios for grouping and filtering in the reports. Categories appear as filterable tags in the search bar using the @tag syntax.
| Framework | How to set |
|---|---|
| xUnit |
[Trait("Category", "smoke")] attribute on the test method |
| NUnit |
[Category("smoke")] attribute on the test method |
| MSTest |
[TestCategory("smoke")] attribute on the test method |
| BDDfy | .WithTags("category:smoke") |
| LightBDD |
[Label("smoke")] attribute on the scenario method |
| ReqNRoll |
@category:smoke tag on the Gherkin scenario or feature |
In the HTML reports, categories are searchable using @smoke in the search bar. See Search Syntax#Tag Filtering (@tag).
Labels provide additional metadata attached to features and scenarios. In LightBDD, labels are set via [Label("...")] attributes and appear in the report alongside the scenario name. In ReqNRoll/BDDfy, tags that don't match the happy-path, endpoint:, or category: prefixes are treated as general labels.
Gherkin DocString content (triple-quoted blocks in .feature files) is captured as part of scenario steps and rendered as <pre> code blocks in the HTML reports. The optional media type (e.g. json, xml) specified after the opening """ delimiter controls syntax highlighting in the rendered output.
| Framework | How to use |
|---|---|
| ReqNRoll | Use triple-quoted """ blocks in .feature files. Optionally specify a media type: """json
|
Step comments (text annotations on individual test steps) are captured and rendered in the HTML reports below the step text. In LightBDD, step comments are added via the StepExecution.Current.Comment() API.
Getting Started
Common Tasks
Integration Guides
- Integration xUnit3
- Integration xUnit2
- Integration NUnit
- Integration MSTest
- Integration TUnit
- Integration BDDfy xUnit3
- Integration LightBDD xUnit2
- Integration LightBDD xUnit3
- Integration LightBDD TUnit
- Integration ReqNRoll xUnit2
- Integration ReqNRoll xUnit3
- Integration ReqNRoll TUnit
Extensions
- Integration AtlasDataApi Extension
- Integration BigQuery Extension
- Integration Bigtable Extension
- Integration BlobStorage Extension
- Integration ClickHouse Extension
- Integration CloudStorage Extension
- Integration CosmosDB Extension
- Integration Dapper Extension
- Integration DynamoDB Extension
- Integration EF Core Relational Extension
- Integration Elasticsearch Extension
- Integration EventBridge Extension
- Integration EventHubs Extension
- Integration Grpc Extension
- Integration Kafka Extension
- Integration MassTransit Extension
- Integration MongoDB Extension
- Integration MySqlConnector Extension
- Integration Npgsql Extension
- Integration Oracle Extension
- Integration PubSub Extension
- Integration Redis Extension
- Integration S3 Extension
- Integration ServiceBus Extension
- Integration SNS Extension
- Integration Spanner Extension
- Integration SqlClient Extension
- Integration Sqlite Extension
- Integration SQS Extension
- Integration StorageQueues Extension
- Integration OpenTelemetry Extension
- Integration DispatchProxy Extension
- Integration MediatR Extension
- Integration PlantUML IKVM
Configuration
- Tracking Dependencies
- Tracking Custom Dependencies
- HTTP Tracking Setup
- Report Configuration
- Diagram Customisation
- Phase-Aware Tracking
- Content Formatting
- PlantUML Server Configuration
Features
- Generated Reports
- Search Syntax
- Component Diagrams
- PlantUML Browser Rendering
- Inline SVG Rendering
- Internal Flow Tracking
- Tags and Attributes
- Excluding Requests
- Excluded Headers
- Multi-Host Test Architectures
- Event-Driven Architecture Testing
- Service Bus Tracking Patterns
- Background Thread Correlation
- Parallel-Safe Background Correlation
- Event & Message Tracking
- Assertion Tracking
- Step Tracking
- Tabular Attributes
- Large Response and Diagram Handling
- Diagnostics and Debugging
- CI Summary Integration
- CI Artifact Upload
- Merging Parallel Reports
Reference