💬 General Discussion – engage in casual conversations, share insights and ideas with the community
🖥️ Live Demo — explore a live example of Allure Report in action
Allure Xunit supports the following frameworks:
.NET Core 3.1,
.NET 5.0 or greater.
Quick start
Install the Allure.Xunit package and run the tests normally. In many cases,
allure should start automatically. The result files are created in the
allure-results directory in the target directory.
If that didn't happen, check out the Why the Allure results directory is empty?
section.
Previously, the package contained a mix of Allure.Xunit and Allure.XUnit
namespaces. Starting from 2.12.0, you should only use Allure.Xunit. The API is
still accessible through the old namespace, but that access is deprecated now
and will be removed in the future.
Deprecations and removals in 2.12.0
The following user API classes are now deprecated:
Allure.XUnit.Attachments - use Allure.Xunit.Attachments instead.
Attributes in Allure.XUnit.Attributes.Steps - use their counterparts from
Allure.Xunit.Attributes.Steps.
The following previously deprecated user API classes and methods were removed:
Using-style steps/fixtures:
Allure.Xunit.AllureAfter
Allure.Xunit.AllureBefore
Allure.Xunit.AllureStep
Allure.Xunit.AllureStepBase
Use the following alternatives instead:
Attributes from Allure.Xunit.Attributes.Steps ([AllureAfter],
[AllureBefore], or [AllureStep])
Functions from Allure.Net.Commons.AllureApi and
Allure.Net.Commons.ExtendedApi
Allure.Xunit.AllureAttachments - use
Allure.Net.Commons.AllureApi.AddAttachment instead.
Allure.Xunit.Steps - use functions from
Allure.Net.Commons.AllureApi and Allure.Net.Commons.ExtendedApi instead.
In Allure.Xunit.Attributes:
AllureXunitAttribute - use Xunit.FactAttribute instead.
AllureXunitTheoryAttribute - use Xunit.TheoryAttribute instead.
In Allure.Net.Commons.AllureLifecycle:
AddAttachment - use Allure.Net.Commons.AllureApi.AddAttachment
instead.
AddScreenDiff - use Allure.Net.Commons.AllureApi.AddScreenDiff
instead.
Allure.Net.Commons.Steps.CoreStepsHelper - use functions from
Allure.Net.Commons.AllureApi and Allure.Net.Commons.ExtendedApi instead.
Allure.Xunit.StepExtensions deprecation
There is no more need to use the separate Allure.XUnit.StepExtensions package.
You should uninstall it and use attributes from the
Allure.Xunit.Attributes.Steps namespace directly.
Known issues and limitations
MonoMod.Core issues
We rely on Harmony (which in turn uses MonoMod.Core) to:
Report arguments of theories in case they aren't reported by xUnit.net itself.
Implement selectie run (test plans).
Those features might not work in some rare circumstances, especially when testing the Release configuration. If you're affected, try switching to Debug as a workaround.
If you run your tests, but there is no Allure results directory (or it's empty),
xUnit.net may have preferred another reporter instead of allure.
You can force xUnit.net to select the allure reporter by providing it to the
runner. For xunit.runner.visualstudio, it could be done with the
xUnit.ReporterSwitch run setting:
dotnet test <test-project-name> -- xUnit.ReporterSwitch=allure
Alternatively, you may provide that option via a .runsettings file:
If you don't see xUnit.net logs, try increasing the verbosity level to normal or detailed:
dotnet test --logger 'console;verbosity=normal'
How to run Allure.Xunit together with another reporter?
xUnit.net only uses one reporter per run. But Allure Xunit allows you to bypass
that limitation. Learn more here.
How to use Allure Xunit in a CI environment?
A CI-specific reporter might be enabled in addition to Allure Xunit in some CI
environments like Azure DevOps or TeamCity. The result is that both reporters
become available to run. In such cases, xUnit.net may select any of them.
If xUnit.net selects Allure Xunit, the tests will be reported both to the
CI server and as Allure results.
If a CI-specific reporter is selected, the tests will only be reported to
the CI server.
