Allure sdk

.github/workflows/test.yml

@@ -3,6 +3,7 @@ name: Test
 env:
   SOLUTION_PATH: allure-csharp.slnx
   BUILD_CONFIGURATION: 'Release'
+  PACK_CONFIGURATION: 'Publish'
 
 on:
   workflow_dispatch:
@@ -53,7 +54,7 @@ jobs:
           dotnet pack ${{ env.SOLUTION_PATH }}\
             --no-restore\
             --no-build\
-            --configuration ${{ env.BUILD_CONFIGURATION }}
+            --configuration ${{ env.PACK_CONFIGURATION }}
 
       - name: Build test samples
         run: |
@@ -77,6 +78,10 @@ jobs:
             --no-restore\
             --no-build\
             --configuration ${{ env.BUILD_CONFIGURATION }}
+          npx -y allure@3 run --config ./.allurerc.mjs --rerun 2 --environment="${{ env.BUILD_CONFIGURATION }}" --dump="allure-results-sdk" -- dotnet run --project ./tests/Allure.Net.Sdk.Tests\
+            --no-restore\
+            --no-build\
+            --configuration ${{ env.BUILD_CONFIGURATION }}
           npx -y allure@3 run --config ./.allurerc.mjs --rerun 2 --environment="${{ env.BUILD_CONFIGURATION }}" --dump="allure-results-testing-platform" -- dotnet run --project ./tests/Allure.TestingPlatform.Tests\
             --no-restore\
             --no-build\

allure-csharp.slnx

@@ -55,6 +55,9 @@
     <Project Path="src/Allure.Net.Commons/Allure.Net.Commons.csproj">
       <BuildType Solution="Publish|*" Project="Release" />
     </Project>
+    <Project Path="src/Allure.Net.Sdk/Allure.Net.Sdk.csproj">
+      <BuildType Solution="Publish|*" Project="Release" />
+    </Project>
     <Project Path="src/Allure.NUnit/Allure.NUnit.csproj">
       <BuildType Solution="Publish|*" Project="Release" />
     </Project>
@@ -78,6 +81,9 @@
     <Project Path="tests/Allure.Net.Tests/Allure.Net.Tests.csproj">
       <Build Solution="Publish|*" Project="false" />
     </Project>
+    <Project Path="tests/Allure.Net.Sdk.Tests/Allure.Net.Sdk.Tests.csproj">
+      <Build Solution="Publish|*" Project="false" />
+    </Project>
     <Project Path="tests/Allure.NUnit.Tests/Allure.NUnit.Tests.csproj">
       <Build Solution="Publish|*" Project="false" />
     </Project>

src/Allure.Net.Commons/Functions/ModelFunctions.cs

@@ -19,7 +19,7 @@ public static class ModelFunctions
 {
     /// <summary>
     /// Checks if an exception type, one of its base types, or one of the
-    /// interfaces it implements exists in the list of known execption types.
+    /// interfaces it implements exists in the list of known excecption types.
     /// </summary>
     /// <param name="knownErrorBases">The list of known exception types.</param>
     /// <param name="e">The exception to check.</param>

src/Allure.Net.Sdk/Allure.Net.Sdk.csproj

@@ -0,0 +1,25 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <RootNamespace>Allure.Sdk</RootNamespace>
+        <Description>Provides the API and utilities for building Allure integrations.</Description>
+        <PackageIcon>Allure-Color.png</PackageIcon>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\Allure.Net\Allure.Net.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="10.0.10" />
+        <PackageReference Include="System.Text.Json" Version="10.0.10" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\" />
+        <None Include="../../img/Allure-Color.png" Pack="true" PackagePath="\" />
+    </ItemGroup>
+
+</Project>

src/Allure.Net.Sdk/CompilerHints/IsExternalInit.cs

@@ -0,0 +1,20 @@
+using System.ComponentModel;
+
+#pragma warning disable IDE0130
+
+namespace System.Runtime.CompilerServices;
+
+/// <summary>
+/// Provides the compiler-required modifier type for init-only setters when
+/// targeting frameworks earlier than .NET 5, including .NET Standard. See
+/// <see href="https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/proposals/csharp-9.0/init#metadata-encoding">
+///   this article
+/// </see>
+/// and
+/// <see href="https://developercommunity.visualstudio.com/t/error-cs0518-predefined-type-systemruntimecompiler/1244809#TPIN-N1249582">
+///   this answer
+/// </see>
+/// for more details.
+/// </summary>
+[EditorBrowsable(EditorBrowsableState.Never)]
+internal static class IsExternalInit { }

src/Allure.Net.Sdk/CompilerHints/MaybeNullWhenAttribute.cs

@@ -0,0 +1,14 @@
+namespace System.Diagnostics.CodeAnalysis;
+
+/// <summary>
+/// Indicates that the parameter may be <see langword="null"/> when the method
+/// returns the specified value.
+/// This attribute is not included in .NET Standard 2.0, so it is defined locally.
+/// </summary>
+/// <param name="returnValue">
+/// The return value for which the parameter may be <see langword="null"/>.
+/// </param>
+[AttributeUsage(AttributeTargets.Parameter)]
+internal sealed class MaybeNullWhenAttribute(bool returnValue) : Attribute {
+    public bool ReturnValue { get; } = returnValue;
+}

src/Allure.Net.Sdk/CompilerHints/NotNullWhenAttribute.cs

@@ -0,0 +1,14 @@
+namespace System.Diagnostics.CodeAnalysis;
+
+/// <summary>
+/// Indicates that the parameter is not <see langword="null"/> when the method
+/// returns the specified value.
+/// This attribute is not included in .NET Standard 2.0, so it is defined locally.
+/// </summary>
+/// <param name="returnValue">
+/// The return value for which the parameter is not <see langword="null"/>.
+/// </param>
+[AttributeUsage(AttributeTargets.Parameter)]
+internal sealed class NotNullWhenAttribute(bool returnValue) : Attribute {
+    public bool ReturnValue { get; } = returnValue;
+}

src/Allure.Net.Sdk/Configuration/AllureConfiguration.cs

@@ -0,0 +1,56 @@
+using System;
+using System.Collections.Immutable;
+using System.IO;
+
+namespace Allure.Sdk.Configuration;
+
+/// <summary>
+/// Defines the common configuration used by an Allure runtime.
+/// </summary>
+public record class AllureConfiguration
+{
+    readonly string resultsDirectory =
+        Path.Combine(Environment.CurrentDirectory, "allure-results");
+
+    /// <summary>
+    /// Gets the host name recorded in generated test results.
+    /// </summary>
+    public string Hostname { get; init; } = Environment.MachineName;
+
+    /// <summary>
+    /// Gets the absolute path of the directory where Allure result files are written.
+    /// </summary>
+    public string ResultsDirectory
+    {
+        get => this.resultsDirectory;
+        init
+        {
+            this.resultsDirectory = Path.GetFullPath(value);
+        }
+    }
+
+    /// <summary>
+    /// Gets the link templates indexed by link type.
+    /// </summary>
+    public ImmutableDictionary<string, AllureLinkTemplate> LinkTemplates { get; init; } = [];
+
+    /// <summary>
+    /// Gets the exception type names that Allure treats as test failures.
+    /// </summary>
+    public ImmutableList<string> FailExceptions { get; init; } = [];
+
+    /// <summary>
+    /// Gets a value indicating whether generated JSON files are indented.
+    /// </summary>
+    public bool IndentOutput { get; init; } = false;
+
+    /// <summary>
+    /// Gets the labels applied to every test result.
+    /// </summary>
+    public ImmutableDictionary<string, string> GlobalLabels { get; init; } = [];
+
+    /// <summary>
+    /// Gets the assembly-qualified name of the runtime registration hook type.
+    /// </summary>
+    public string? RuntimeRegistrationHook { get; init; }
+}

src/Allure.Net.Sdk/Configuration/AllureLinkTemplate.cs

@@ -0,0 +1,16 @@
+namespace Allure.Sdk.Configuration;
+
+/// <summary>
+/// Defines templates used to expand a link URL and, optionally, its display name.
+/// </summary>
+/// <param name="UrlTemplate">
+/// The composite format string used to build the URL. Placeholder <c>{0}</c>
+/// represents the original link value.
+/// </param>
+/// <param name="NameTemplate">
+/// The optional composite format string used to build the display name.
+/// </param>
+public record class AllureLinkTemplate(
+    string UrlTemplate,
+    string? NameTemplate
+);

src/Allure.Net.Sdk/Configuration/DelegateConfigurationSource.cs

@@ -0,0 +1,48 @@
+using System;
+
+namespace Allure.Sdk.Configuration;
+
+/// <summary>
+/// Loads configuration by invoking a delegate.
+/// </summary>
+/// <typeparam name="TConfiguration">The configuration type.</typeparam>
+/// <param name="name">A human-readable name for the source.</param>
+/// <param name="factory">The delegate that creates the configuration.</param>
+public sealed class DelegateConfigurationSource<TConfiguration>(
+    string name,
+    Func<TConfiguration> factory
+) :
+    IAllureConfigurationSource<TConfiguration>
+
+    where TConfiguration : AllureConfiguration
+{
+    /// <inheritdoc/>
+    public string Name => name;
+
+    /// <inheritdoc/>
+    public bool CanLoad => true;
+
+    /// <inheritdoc/>
+    public TConfiguration LoadConfiguration() => factory();
+}
+
+/// <summary>
+/// Creates delegate-backed configuration sources.
+/// </summary>
+public static class DelegateConfigurationSource
+{
+    /// <summary>
+    /// Creates a configuration source that invokes the specified factory.
+    /// </summary>
+    /// <typeparam name="TConfiguration">The configuration type.</typeparam>
+    /// <param name="name">A human-readable name for the source.</param>
+    /// <param name="configurationFactory">The delegate that creates the configuration.</param>
+    /// <returns>The configuration source.</returns>
+    public static DelegateConfigurationSource<TConfiguration> Create<TConfiguration>(
+        string name,
+        Func<TConfiguration> configurationFactory
+    )
+        where TConfiguration : AllureConfiguration
+    =>
+        new(name, configurationFactory);
+}

src/Allure.Net.Sdk/Configuration/IAllureConfigurationSource.cs

@@ -0,0 +1,25 @@
+namespace Allure.Sdk.Configuration;
+
+/// <summary>
+/// Provides configuration values to an Allure runtime.
+/// </summary>
+/// <typeparam name="TConfiguration">The configuration type.</typeparam>
+public interface IAllureConfigurationSource<out TConfiguration>
+    where TConfiguration : AllureConfiguration
+{
+    /// <summary>
+    /// Gets a human-readable name for the source.
+    /// </summary>
+    string Name { get; }
+
+    /// <summary>
+    /// Gets a value indicating whether the source can currently load configuration.
+    /// </summary>
+    bool CanLoad { get; }
+
+    /// <summary>
+    /// Loads configuration from the source.
+    /// </summary>
+    /// <returns>The loaded configuration.</returns>
+    TConfiguration LoadConfiguration();
+}