Skip to content
Allure report logoAllure Report
Main Navigation ModulesDocumentationStart

English

Español

English

Español

Appearance

Sidebar Navigation

Introduction

Install & Upgrade

Install for Windows

Install for macOS

Install for Linux

Install for Node.js

Upgrade Allure

Getting started

How to view a report

Improving readability of your test reports

Improving navigation in your test report

Features

Test steps

Attachments

Test statuses

Sorting and filtering

Defect categories

Visual analytics

Test stability analysis

History and retries

Timeline

Export to CSV

Export metrics

Guides

JUnit 5 parametrization

JUnit 5 & Selenide: screenshots and attachments

JUnit 5 & Selenium: screenshots and attachments

Setting up JUnit 5 with GitHub Actions

Pytest parameterization

Pytest & Selenium: screenshots and attachments

Pytest & Playwright: screenshots and attachments

Pytest & Playwright: videos

Playwright parameterization

How it works

Overview

Test result file

Container file

Categories file

Environment file

Executor file

History files

Integrations

Azure DevOps

Bamboo

GitHub Actions

Jenkins

JetBrains IDEs

TeamCity

Visual Studio Code

Frameworks

Behat

Getting started

Configuration

Reference

Behave

Getting started

Configuration

Reference

Codeception

Getting started

Configuration

Reference

CodeceptJS

Getting started

Configuration

Reference

Cucumber.js

Getting started

Configuration

Reference

Cucumber-JVM

Getting started

Configuration

Reference

Cucumber.rb

Getting started

Configuration

Reference

Cypress

Getting started

Configuration

Reference

Jasmine

Getting started

Configuration

Reference

JBehave

Getting started

Configuration

Reference

Jest

Getting started

Configuration

Reference

JUnit 4

Getting started

Configuration

Reference

JUnit 5

Getting started

Configuration

Reference

Mocha

Getting started

Configuration

Reference

Newman

Getting started

Configuration

Reference

NUnit

Getting started

Configuration

Reference

PHPUnit

Getting started

Configuration

Reference

Playwright

Getting started

Configuration

Reference

pytest

Getting started

Configuration

Reference

Pytest-BDD

Getting started

Configuration

Reference

Reqnroll

Getting started

Configuration

Reference

REST Assured

Getting started

Configuration

Robot Framework

Getting started

Configuration

Reference

RSpec

Getting started

Configuration

Reference

SpecFlow

Getting started

Configuration

Reference

Spock

Getting started

Configuration

Reference

TestNG

Getting started

Configuration

Reference

Vitest

Getting started

Configuration

Reference

WebdriverIO

Getting started

Configuration

Reference

xUnit.net

Getting started

Configuration

Reference

On this page

Allure xUnit.net configuration ​

This page describes the configuration options that affect the behavior of Allure xUnit.net.

By default, Allure xUnit.net tries to read the allureConfig.json file in the same directory where the test assembly is located. To make sure the file is present there, edit the file properties in your IDE or manually in your *.csproj file and set the corresponding item's CopyToOutputDirectory to either Always or PreserveNewest. For example:

xml
<Project Sdk="Microsoft.NET.Sdk">
    <!-- ... -->
    <ItemGroup>
        <None Update="specflow.json">
            <CopyToOutputDirectory>Always</CopyToOutputDirectory>
        </None>
    </ItemGroup>
</Project>

Alternatively, use the ALLURE_CONFIG environment variable to specify a relative or absolute path of the configuration file.

allure.directory ​

Path to the directory where Allure xUnit.net will save the test results, see How it works. If the directory does not exist, it will be created. Defaults to allure-results.

Note that the path is treated as relative to the build output directory of the project. When building and running tests from an IDE, this is typically different from the solution folder. Multiple ../ elements may be needed if you want to put the test results into a directory in the solution folder.

json
{
  "allure": {
    "directory": "../../../../../allure-results"
  }
}

allure.links ​

List of patterns that can be used to construct full URLs from short identifiers.

Each pattern must be a string containing a placeholder surrounded by curly brackets, for example: {issue}. When processing a link, Allure xUnit.net selects the pattern whose placeholder matches the link type (as specified using the Link or [AllureLink] arguments). The placeholder is then replaced by the short identifier.

For example, with the configuration below, the link BUG-123 of type issue will be translated to https://issues.example.com/BUG-123.

json
{
  "allure": {
    "links": [
      "https://issues.example.com/{issue}",
      "https://tms.example.com/{tms}",
      "https://jira.example.com/browse/{jira}"
    ]
  }
}

allure.xunitRunnerReporter ​

The secondary reporter that should be used alongside Allure xUnit.net.

Allowed values are:

  • auto (the default) — select a secondary reporter automatically, similar to how a test runner selects a reporter. This will only select among the xUnit.net reporters that are “environmentally enabled”.

    If there are no environmentally enabled reporters other than Allure xUnit.net, this value is identical to none.

    If there is only one environmentally enabled reporter other than Allure xUnit.net, this value is identical to specifying its reporter switch explicitly.

    In all other cases, Allure xUnit.net will select one of the environmentally enabled reporters, but the algorithm of this selection is not determined.

  • none — do not use a secondary reporter.

  • the reporter switch of the reporter, e.g., teamcity.

  • the fully qualified name of the reporter class, e.g. Xunit.Runner.Reporters.TeamCityReporter, xunit.runner.reporters.netcoreapp10, Version=2.5.2.0, Culture=neutral, PublicKeyToken=8d05b1bb7a6fdb6c. Note that the fully qualified name is often framework-dependent and changes for each new version of the reporter. Because of that, using the fully qualified name is not recommended for most cases. However, it may be useful for large projects, where selection by the reporter switch would significantly slow down the startup.

json
{
  "allure": {
    "xunitRunnerReporter": "teamcity"
  }
}

allure.failExceptions ​

A list of exception types which, when thrown from a step, should cause it to have the Failed status. In case of any other exception, the Broken status is assigned to the step.

::: notes Currently, the setting only affects the statuses of individual test steps. For the status of a test as a whole, see Distinguish between test statuses. :::

The default list includes the Xunit.Sdk.XunitException class and the Xunit.Sdk.IAssertionException interface. The setting, if not empty, overrides the default list. When looking for matches, Allure xUnit.net uses not only the exception class's own full name but also all its interfaces and base classes.

With the example configuration below, a step will be considered failed if it throws Xunit.Sdk.IAssertionException, MyNamespace.MyCustomException, or anything that derives from them. At the same time, any other exception will make the step broken.

json
{
  "allure": {
    "failExceptions": ["Xunit.Sdk.IAssertionException", "MyNamespace.MyCustomException"]
  }
}
Pager
Previous pageGetting started
Next pageReference
Powered by

Join our newsletter

Allure TestOps
  • Overview
  • Why choose us
  • Cloud
  • Self-hosted
  • Success Stories
Company
  • Documentation
  • Blog
  • About us
  • Contact
  • Events
© 2025 Qameta Software Inc. All rights reserved.