Allure.Net.Commons
2.12.1
dotnet add package Allure.Net.Commons --version 2.12.1
NuGet\Install-Package Allure.Net.Commons -Version 2.12.1
<PackageReference Include="Allure.Net.Commons" Version="2.12.1" />
paket add Allure.Net.Commons --version 2.12.1
#r "nuget: Allure.Net.Commons, 2.12.1"
// Install Allure.Net.Commons as a Cake Addin #addin nuget:?package=Allure.Net.Commons&version=2.12.1 // Install Allure.Net.Commons as a Cake Tool #tool nuget:?package=Allure.Net.Commons&version=2.12.1
Allure.Net.Commons
Allure.Net.Commons is a library for creating custom Allure adapters for .NET test frameworks.
- Learn more about Allure Report at https://allurereport.org
- 📚 Documentation – discover official documentation for Allure Report
- ❓ Questions and Support – get help from the team and community
- 📢 Official announcements – stay updated with our latest news and updates
- 💬 General Discussion – engage in casual conversations, share insights and ideas with the community
- 🖥️ Live Demo — explore a live example of Allure Report in action
The library can be used by any project that targets a framework compatible with .NET Standard 2.0 (.NET Framework 4.6.1+, .NET Core 2.0+, .NET 5.0+, and more). See the complete list here.
Note for users of Mac with Apple silicon
If you're developing on a Mac machine with Apple silicon, make sure you have Rosetta installed. Follow this article for the instructions: https://support.apple.com/en-us/HT211861
You may also install Rosetta via the CLI:
/usr/sbin/softwareupdate --install-rosetta --agree-to-license
Configuration
The Allure lifecycle is configured via a JSON file with the default name
allureConfig.json
. NuGet package installs allureConfig.Template.json
, which
you can use as an example. There are two ways to specify config file location:
- Set the ALLURE_CONFIG environment variable to the full path of the file.
- Add
allureConfig.json
to the project and ensure it's copied to the project output directory next toAllure.Net.Commons.dll
:<ItemGroup> <None Update="allureConfig.json"> <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> </None> </ItemGroup>
The Allure lifecycle will start with the default configuration settings if no allureConfig.json
is provided.
The unparsed configuration can be accessed via
AllureLifeCycle.Instance.JsonConfiguration
. Adapters can use it to read
extended configuration properties they need. Check an example
here.
The parsed configuration object can be accessed via
AllureLifeCycle.Instance.Configuration
.
An example of the configuration file is provided below:
{
"allure": {
"directory": "allure-results",
"title": "custom run title",
"links":
[
"https://example.org/{link}",
"https://example.org/{issue}",
"https://example.org/{tms}"
],
"failExceptions": [
"MyNamespace.MyAssertionException"
]
}
}
The directory
property defaults to "allure-results"
.
All link pattern placeholders will be replaced with the URL value of the corresponding link type. Given the configuration above, the following transformation will be made:
link(type: "issue", url: "BUG-01") => https://example.org/BUG-01
failExceptions
must be an array of strings, each representing the full name of
an exception type. If an unhandled exception occurs whose type matches one of
the provided types, the test/step/fixture is considered failed. Otherwise, it's
considered broken. An exception's type matches a name if:
- Its full name equals the provided name, OR
- One of its base classes matches the name, OR
- It implements an interface that matches the name.
Runtime API
Use this API to enhance the report at runtime.
The AllureApi facade
Use the Allure.Net.Commons.AllureApi
class to access the most commonly used
functions.
Metadata
SetTestName
SetFixtureName
SetStepName
SetDescription
SetDescriptionHtml
SetDescriptionHtml
AddLabels
AddLabel
SetLabel
SetSeverity
SetOwner
SetAllureId
AddTags
AddLinks
AddLink
AddIssue
AddTmsItem
Hierrarchies
AddParentSuite
SetParentSuite
AddSuite
SetSuite
AddSubSuite
SetSubSuite
AddEpic
SetEpic
AddFeature
SetFeature
AddStory
SetStory
Lambda steps
Step(string, Action): void
- step action.Step<T>(string, Func<T>): T
- step function.Step(string, Func<Task>): Task
- async step action.Step<T>(string, Func<Task<T>>): T
- async step function.
Noop step
Step(string)
Attachments
- AddAttachment - adds an attachment to the current step, fixture, or test.
- AddScreenDiff - adds needed artifacts to the current test case to be used with screen-diff-plugin
The ExtendedApi facade
Use this class to access some less commonly used functions.
Explicit step management
[!NOTE] Use the functions below only if lambda steps don't suit your needs.
StartStep(string): void
StartStep(string, Action<StepResult>): void
PassStep(): void
PassStep(Action<StepResult>): void
FailStep(): void
FailStep(Action<StepResult>): void
BreakStep(): void
BreakStep(Action<StepResult>): void
Lambda fixtures
Before(string, Action): void
- setup fixture action.Before<T>(string, Func<T>): T
- setup fixture function.Before(string, Func<Task>): Task
- async setup fixture action.Before<T>(string, Func<Task<T>>): T
- async setup fixture function.After(string, Action): void
- teardown fixture action.After<T>(string, Func<T>): T
- teardown fixture function.After(string, Func<Task>): Task
- async teardown fixture action.After<T>(string, Func<Task<T>>): T
- async teardown fixture function.
Explicit fixture management
[!NOTE] Use the functions below only if lambda fixtures don't suit your needs.
StartBeforeFixture(string): void
StartAfterFixture(string): void
PassFixture(): void
PassFixture(Action<FixtureResult>): void
FailFixture(): void
FailFixture(Action<FixtureResult>): void
BreakFixture(): void
BreakFixture(Action<FixtureResult>): void
The integration API
This API is designed for adapter or library authors. You may still use it as a test author, but we recommend considering the Runtime API first.
AllureLifecycle
The AllureLifecycle
class provides methods to manipulate the Allure context while responding to the
test framework's events. Use AllureLifecycle.Instance
property to access it.
Fixture context control
- StartBeforeFixture
- StartAfterFixture
- UpdateFixture
- StopFixture
Test context control
- ScheduleTestCase
- StartTestCase
- UpdateTestCase
- StopTestCase
- WriteTestCase
Step context control
- StartStep
- UpdateStep
- StopStep
Utility Methods
- CleanupResultDirectory - can be used in test run setup to clean old result files
Context capturing
The methods above operate on the current Allure context. This context flows naturally as a part of ExecutionContext and is subject to the same constraints. Notably, changes made in an async callee can't be observed by the caller.
Use the following methods of AllureLifecycle
to capture the current Allure
context and to operate on the captured context later:
- Context
- RunInContext
Example:
public static async Task Caller(ScenarioContext scenario)
{
await Callee(scenario);
AllureLifecycle.Instance.RunInContext(
scenario.Get<AllureContext>(), // Get the previously captured context
() =>
{
// The test context required by the below methods wouldn't be
// visible if they weren't wrapped with RunInContext.
AllureLifecycle.Instance.StopTestCase();
AllureLifecycle.Instance.WriteTestCase();
}
);
}
public static async Task Callee(ScenarioContext scenario)
{
AllureLifecycle.Instance.StartTestCase(
new(){ uuid = Guid.NewGuid().ToString() }
);
// Capture the context in an object of the test framework's object model
scenario.Set(AllureLifecycle.Instance.Context);
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- AspectInjector (>= 2.8.1)
- MimeTypesMap (>= 1.0.8)
- Newtonsoft.Json (>= 13.0.3)
- System.Collections.Immutable (>= 5.0.0)
NuGet packages (7)
Showing the top 5 NuGet packages that depend on Allure.Net.Commons:
Package | Downloads |
---|---|
Allure.NUnit
Create beautiful reports from your NUnit tests. |
|
Allure.Xunit
Create beautiful reports from your xUnit.net tests. |
|
Allure.SpecFlow
Create beautiful reports from your SpecFlow tests. |
|
Allure.Reqnroll
Create beautiful reports from your Reqnroll tests. |
|
Empyrean.Core.Allure
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.12.1 | 115,829 | 6/4/2024 |
2.12.0 | 117,393 | 4/2/2024 |
2.11.0 | 153,448 | 11/29/2023 |
2.10.0 | 57,004 | 10/16/2023 |
2.10.0-preview.1 | 5,624 | 9/22/2023 |
2.9.5-preview.1 | 120,548 | 3/22/2023 |
2.9.4-preview.6 | 51,451 | 2/13/2023 |
2.9.4-preview.5 | 140 | 2/13/2023 |
2.9.4-preview.2 | 14,938 | 1/2/2023 |
2.9.4-preview.1 | 187 | 12/30/2022 |
2.9.3-preview.1 | 5,161 | 12/23/2022 |
2.9.2-preview.1 | 13,628 | 9/19/2022 |
2.9.1-preview.7-nunit-fixtures | 2,024 | 8/2/2022 |
2.9.1-preview.6-nunit-fixtures | 163 | 7/27/2022 |
2.9.1-preview.5 | 180 | 7/27/2022 |
2.9.1-preview.3 | 145 | 7/12/2022 |
2.9.1-preview.2 | 161 | 7/12/2022 |
2.9.0 | 1,251 | 7/8/2022 |