New context-based state management model for allure-csharp

.github/workflows/build.yml

@@ -21,14 +21,15 @@ jobs:
     name: "Build"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.0.2
+      - uses: actions/checkout@v3.5.3
 
       - name: 'Setup .NET Core SDK'
-        uses: actions/setup-dotnet@v2.1.0
+        uses: actions/setup-dotnet@v3.2.0
         with:
           dotnet-version: |
             3.1.x
             6.0.x
+            7.0.x
 
       - name: 'Restore packages'
         run: dotnet restore ${{ env.SOLUTION_PATH }} --packages ${{ env.RESTORE_OUTPUT_PATH }}
@@ -38,5 +39,5 @@ jobs:
 
       - name: 'Run tests'
         run: |
-          dotnet test Allure.Net.Commons.Tests/Allure.Net.Commons.Tests.csproj --no-restore --configuration ${{ env.BUILD_CONFIGURATION }}
-          dotnet test Allure.SpecFlowPlugin.Tests/Allure.SpecFlowPlugin.Tests.csproj --no-restore --configuration ${{ env.BUILD_CONFIGURATION }}
+          dotnet test Allure.Net.Commons.Tests/Allure.Net.Commons.Tests.csproj --no-build --configuration ${{ env.BUILD_CONFIGURATION }}
+          dotnet test Allure.SpecFlowPlugin.Tests/Allure.SpecFlowPlugin.Tests.csproj --no-build --configuration ${{ env.BUILD_CONFIGURATION }}

.github/workflows/publish.yml

@@ -14,14 +14,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.0.2
+      - uses: actions/checkout@v3.5.3
 
       - name: 'Setup .NET Core SDK'
-        uses: actions/setup-dotnet@v2.1.0
+        uses: actions/setup-dotnet@v3.2.0
         with:
           dotnet-version: |
             3.1.x
             6.0.x
+            7.0.x
 
       - name: 'Restore packages'
         run: dotnet restore ${{ env.SOLUTION_PATH }} --packages ${{ env.RESTORE_OUTPUT_PATH }}

Allure.Features/Allure.Features.csproj

@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>netcoreapp3.1</TargetFramework>
+	<LangVersion>11</LangVersion>
     <IsPackable>false</IsPackable>
     <OutputPath>bin</OutputPath>
   </PropertyGroup>

Allure.Features/TestData/After Feature Failure.feature

@@ -5,7 +5,7 @@ Feature: After Feature Failure
   Scenario: After Feature Failure 1
     Given Step is 'passed'
 
-  @broken
+  @failed
   Scenario: After Feature Failure 3
     Given Step is 'failed'
 

Allure.Features/TestData/Before Feature Failure.feature

@@ -2,4 +2,4 @@
 Feature: Before Feature Failure
 
   @broken
-  Scenario: Unknown
+  Scenario: Feature hook failure placeholder

Allure.Features/TestData/Invalid Steps.feature

@@ -12,7 +12,7 @@
     Given Step is 'passed'
     And I don't have such step too
 
-  @broken
+  @failed
   Scenario: Failed step followed by invalid step
     Given Step is 'failed'
     Given I don't have such step

Allure.NUnit.Examples/Allure.NUnit.Examples.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
+	<LangVersion>11</LangVersion>
     <IsPackable>false</IsPackable>
     <OutputType>Library</OutputType>
   </PropertyGroup>

Allure.NUnit.Examples/BaseTest.cs

@@ -1,19 +1,11 @@
-using Allure.Net.Commons;
-using NUnit.Allure.Attributes;
+using NUnit.Allure.Attributes;
 using NUnit.Allure.Core;
-using NUnit.Framework;
 
 namespace Allure.NUnit.Examples
 {
     [AllureNUnit]
     [AllureParentSuite("Root Suite")]
     public class BaseTest
     {
-        [OneTimeSetUp]
-        public void CleanupResultDirectory()
-        {
-            AllureExtensions.WrapSetUpTearDownParams(() => { AllureLifecycle.Instance.CleanupResultDirectory(); },
-                "Clear Allure Results Directory");
-        }
     }
 }

Allure.NUnit/Allure.NUnit.csproj

@@ -2,6 +2,7 @@
 
     <PropertyGroup>
         <TargetFramework>netstandard2.0</TargetFramework>
+		<LangVersion>11</LangVersion>
         <Version>2.10-SNAPSHOT</Version>
         <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
         <Company>Qameta Software</Company>

Allure.NUnit/Attributes/AllureDisplayIgnoredAttribute.cs

@@ -13,7 +13,6 @@ namespace NUnit.Allure.Attributes
     public class AllureDisplayIgnoredAttribute : NUnitAttribute, ITestAction
     {
         private readonly string _suiteName;
-        private string _ignoredContainerId;
 
         public AllureDisplayIgnoredAttribute(string suiteNameForIgnoredTests = "Ignored")
         {
@@ -22,13 +21,11 @@ public AllureDisplayIgnoredAttribute(string suiteNameForIgnoredTests = "Ignored"
 
         public void BeforeTest(ITest suite)
         {
-            _ignoredContainerId = suite.Id + "-ignored";
-            var fixture = new TestResultContainer
+            AllureLifecycle.Instance.StartTestContainer(new()
             {
-                uuid = _ignoredContainerId,
+                uuid = suite.Id + "-ignored",
                 name = suite.ClassName
-            };
-            AllureLifecycle.Instance.StartTestContainer(fixture);
+            });
         }
 
         public void AfterTest(ITest suite)
@@ -37,12 +34,19 @@ public void AfterTest(ITest suite)
             if (suite.HasChildren)
             {
                 var ignoredTests =
-                    GetAllTests(suite).Where(t => t.RunState == RunState.Ignored || t.RunState == RunState.Skipped);
+                    GetAllTests(suite).Where(
+                        t => t.RunState == RunState.Ignored
+                            || t.RunState == RunState.Skipped
+                    );
                 foreach (var test in ignoredTests)
                 {
-                    AllureLifecycle.Instance.UpdateTestContainer(_ignoredContainerId, t => t.children.Add(test.Id));
+                    AllureLifecycle.Instance.UpdateTestContainer(
+                        t => t.children.Add(test.Id)
+                    );
 
-                    var reason = test.Properties.Get(PropertyNames.SkipReason).ToString();
+                    var reason = test.Properties.Get(
+                        PropertyNames.SkipReason
+                    ).ToString();
 
                     var ignoredTestResult = new TestResult
                     {
@@ -66,12 +70,12 @@ public void AfterTest(ITest suite)
                         }
                     };
                     AllureLifecycle.Instance.StartTestCase(ignoredTestResult);
-                    AllureLifecycle.Instance.StopTestCase(ignoredTestResult.uuid);
-                    AllureLifecycle.Instance.WriteTestCase(ignoredTestResult.uuid);
+                    AllureLifecycle.Instance.StopTestCase();
+                    AllureLifecycle.Instance.WriteTestCase();
                 }
 
-                AllureLifecycle.Instance.StopTestContainer(_ignoredContainerId);
-                AllureLifecycle.Instance.WriteTestContainer(_ignoredContainerId);
+                AllureLifecycle.Instance.StopTestContainer();
+                AllureLifecycle.Instance.WriteTestContainer();
             }
         }
 

Allure.NUnit/Core/AllureExtendedConfiguration.cs

@@ -6,10 +6,14 @@ namespace NUnit.Allure.Core
 {
     internal class AllureExtendedConfiguration : AllureConfiguration
     {
-        public HashSet<string> BrokenTestData { get; set; } = new HashSet<string>();
+        public HashSet<string> BrokenTestData { get; set; } = new();
 
         [JsonConstructor]
-        protected AllureExtendedConfiguration(string title, string directory, HashSet<string> links) : base(title,
+        protected AllureExtendedConfiguration(
+            string title,
+            string directory,
+            HashSet<string> links
+        ) : base(title,
             directory, links)
         {
         }

Allure.NUnit/Core/AllureExtensions.cs

@@ -58,15 +58,22 @@ public static void WrapSetUpTearDownParams(Action action, string customName = ""
         /// Wraps Action into AllureStep.
         /// </summary>
         [Obsolete("Use [AllureStep] method attribute")]
-        public static void WrapInStep(this AllureLifecycle lifecycle, Action action, string stepName = "", [CallerMemberName] string callerName = "")
+        public static void WrapInStep(
+            this AllureLifecycle lifecycle,
+            Action action,
+            string stepName = "",
+            [CallerMemberName] string callerName = ""
+        )
         {
-            if (string.IsNullOrEmpty(stepName)) stepName = callerName;
+            if (string.IsNullOrEmpty(stepName))
+            {
+                stepName = callerName;
+            }
 
-            var id = Guid.NewGuid().ToString();
             var stepResult = new StepResult {name = stepName};
             try
             {
-                lifecycle.StartStep(id, stepResult);
+                lifecycle.StartStep(stepResult);
                 action.Invoke();
                 lifecycle.StopStep(step => stepResult.status = Status.passed);
             }
@@ -88,14 +95,22 @@ public static void WrapInStep(this AllureLifecycle lifecycle, Action action, str
         /// <summary>
         /// Wraps Func into AllureStep.
         /// </summary>
-        public static T WrapInStep<T>(this AllureLifecycle lifecycle, Func<T> func, string stepName = "", [CallerMemberName] string callerName = "")
+        public static T WrapInStep<T>(
+            this AllureLifecycle lifecycle,
+            Func<T> func,
+            string stepName = "",
+            [CallerMemberName] string callerName = ""
+        )
         {
-            if (string.IsNullOrEmpty(stepName)) stepName = callerName;
-            var id = Guid.NewGuid().ToString();
+            if (string.IsNullOrEmpty(stepName))
+            {
+                stepName = callerName;
+            }
+
             var stepResult = new StepResult {name = stepName};
             try
             {
-                lifecycle.StartStep(id, stepResult);
+                lifecycle.StartStep(stepResult);
                 var result = func.Invoke();
                 lifecycle.StopStep(step => stepResult.status = Status.passed);
                 return result;
@@ -125,13 +140,15 @@ public static async Task WrapInStepAsync(
             [CallerMemberName] string callerName = ""
         )
         {
-            if (string.IsNullOrEmpty(stepName)) stepName = callerName;
+            if (string.IsNullOrEmpty(stepName))
+            {
+                stepName = callerName;
+            }
 
-            var id = Guid.NewGuid().ToString();
             var stepResult = new StepResult { name = stepName };
             try
             {
-                lifecycle.StartStep(id, stepResult);
+                lifecycle.StartStep(stepResult);
                 await action();
                 lifecycle.StopStep(step => stepResult.status = Status.passed);
             }
@@ -160,12 +177,15 @@ public static async Task<T> WrapInStepAsync<T>(
             [CallerMemberName] string callerName = ""
         )
         {
-            if (string.IsNullOrEmpty(stepName)) stepName = callerName;
-            var id = Guid.NewGuid().ToString();
+            if (string.IsNullOrEmpty(stepName))
+            {
+                stepName = callerName;
+            }
+
             var stepResult = new StepResult { name = stepName };
             try
             {
-                lifecycle.StartStep(id, stepResult);
+                lifecycle.StartStep(stepResult);
                 var result = await func();
                 lifecycle.StopStep(step => stepResult.status = Status.passed);
                 return result;
@@ -184,16 +204,5 @@ public static async Task<T> WrapInStepAsync<T>(
                 throw;
             }
         }
-
-        /// <summary>
-        /// AllureNUnit AddScreenDiff wrapper method.
-        /// </summary>
-        public static void AddScreenDiff(this AllureLifecycle lifecycle, string expected, string actual, string diff)
-        {
-            var storageMain = lifecycle.GetType().GetField("storage", BindingFlags.NonPublic | BindingFlags.Instance).GetValue(lifecycle);
-            var storageInternal = storageMain.GetType().GetField("storage", BindingFlags.NonPublic | BindingFlags.Instance).GetValue(storageMain);
-            var keys = (storageInternal as System.Collections.Concurrent.ConcurrentDictionary<string, object>).Keys.ToList();
-            AllureLifecycle.Instance.AddScreenDiff(keys.Find(key => key.Contains("-tr-")), expected, actual, diff);
-        }
     }
 }

Allure.NUnit/Core/AllureNUnitAttribute.cs

@@ -1,8 +1,5 @@
 using System;
 using System.Collections.Concurrent;
-using Allure.Net.Commons;
-using NUnit.Engine;
-using NUnit.Engine.Extensibility;
 using NUnit.Framework;
 using NUnit.Framework.Interfaces;
 using NUnit.Framework.Internal;
@@ -12,21 +9,11 @@ namespace NUnit.Allure.Core
     [AttributeUsage(AttributeTargets.Interface | AttributeTargets.Class)]
     public class AllureNUnitAttribute : PropertyAttribute, ITestAction, IApplyToContext
     {
-        private readonly ConcurrentDictionary<string, AllureNUnitHelper> _allureNUnitHelper = new ConcurrentDictionary<string, AllureNUnitHelper>();
-        private readonly bool _isWrappedIntoStep;
-
-        static AllureNUnitAttribute()
-        {
-            //!_! This is essential for async tests.
-            //!_! Async tests are working on different threads, so
-            //!_! default ManagedThreadId-separated behaviour in some cases fails on cross-thread execution.
-            AllureLifecycle.CurrentTestIdGetter = () => TestContext.CurrentContext.Test.FullName;
-        }
+        private readonly ConcurrentDictionary<string, AllureNUnitHelper> _allureNUnitHelper = new();
 
         [Obsolete("wrapIntoStep parameter is obsolete. Use [AllureStep] method attribute")]
         public AllureNUnitAttribute(bool wrapIntoStep = true)
         {
-            _isWrappedIntoStep = wrapIntoStep;
         }
 
         public AllureNUnitAttribute()
@@ -36,7 +23,11 @@ public AllureNUnitAttribute()
         public void BeforeTest(ITest test)
         {
             var helper = new AllureNUnitHelper(test);
-            _allureNUnitHelper.AddOrUpdate(test.Id, helper, (key, existing) => helper);
+            _allureNUnitHelper.AddOrUpdate(
+                test.Id,
+                helper,
+                (key, existing) => helper
+            );
 
             if (test.IsSuite)
             {
@@ -64,7 +55,8 @@ public void AfterTest(ITest test)
             }
         }
 
-        public ActionTargets Targets => ActionTargets.Test | ActionTargets.Suite;
+        public ActionTargets Targets =>
+            ActionTargets.Test | ActionTargets.Suite;
 
         public void ApplyToContext(TestExecutionContext context)
         {