Merge remote-tracking branch 'origin/main' into nunit-refactorings-1

allure-framework · Dec 30, 2022 · 2cb811b · 2cb811b
2 parents 21e5e44 + 0c4bf81
commit 2cb811b
Show file tree

Hide file tree

Showing 13 changed files with 192 additions and 30 deletions.
diff --git a/Allure.Commons.NetCore.Nuget.Tests/Allure.Commons.NetCore.Nuget.Tests.csproj b/Allure.Commons.NetCore.Nuget.Tests/Allure.Commons.NetCore.Nuget.Tests.csproj
@@ -8,7 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="Allure.Commons" Version="3.0.0.1" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
     <PackageReference Include="NUnit" Version="3.12.0" />
     <PackageReference Include="NUnit3TestAdapter" Version="3.16.1" />
   </ItemGroup>

diff --git a/Allure.Features/Allure.Features.csproj b/Allure.Features/Allure.Features.csproj
@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
     <PackageReference Include="Castle.Core" Version="4.4.1" />
     <PackageReference Include="NUnit" Version="3.13.2" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.0.0" />

diff --git a/Allure.NUnit.Examples/Allure.NUnit.Examples.csproj b/Allure.NUnit.Examples/Allure.NUnit.Examples.csproj
@@ -8,8 +8,8 @@
 
   <ItemGroup>
     <PackageReference Include="NUnit" Version="3.13.3" />
-    <PackageReference Include="NUnit3TestAdapter" Version="3.17.0" PrivateAssets="all" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.4" />
+    <PackageReference Include="NUnit3TestAdapter" Version="3.17.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Allure.NUnit.Examples/AllureAsyncLifeCycleTests.cs b/Allure.NUnit.Examples/AllureAsyncLifeCycleTests.cs
@@ -0,0 +1,68 @@
+using System;
+using System.Text;
+using System.Threading.Tasks;
+using Allure.Net.Commons;
+using NUnit.Allure.Attributes;
+using NUnit.Allure.Core;
+using NUnit.Framework;
+
+namespace Allure.NUnit.Examples
+{
+    [AllureNUnit]
+    public class AllureAsyncLifeCycleTests
+    {
+        [Test]
+        public async Task AsyncTest_With_AllureStepAttribute()
+        {
+            Console.WriteLine("> Сalling async method with [AllureStep] ...");
+            await StepWithAttribute();
+            Console.WriteLine("  Done!");
+        }
+
+        [AllureStep("Calling StepWithAttribute")]
+        private async Task StepWithAttribute()
+        {
+            // switching thread on async
+            Console.WriteLine($"  > Delay...");
+            await Task.Delay(1000);
+            Console.WriteLine($"    Done!");
+
+            // use internally allure steps storage on different thread
+            Console.WriteLine($"  > AddAttachment...");
+            AllureLifecycle.Instance.AddAttachment("attachment-name", "text/plain", Encoding.UTF8.GetBytes("attachment-value"));
+            Console.WriteLine($"    Done!");
+        }
+
+        [Test]
+        public async Task AsyncTest_With_WrapInStep()
+        {
+            Console.WriteLine("> StepLevel1...");
+            await AllureLifecycle.Instance.WrapInStepAsync(
+                async () => await StepLevel1()
+            );
+            Console.WriteLine("  Done!");
+        }
+
+        private async Task StepLevel1()
+        {
+            Console.WriteLine("  > StepLevel2...");
+            await AllureLifecycle.Instance.WrapInStepAsync(
+                async () => await StepLevel2()
+            );
+            Console.WriteLine("    Done!");
+        }
+
+        private async Task StepLevel2()
+        {
+            // switching thread on async
+            Console.WriteLine($"    > Sleep...");
+            await Task.Delay(1000);
+            Console.WriteLine($"      Done!");
+
+            // use internally allure steps storage on different thread
+            Console.WriteLine($"    > AddAttachment...");
+            AllureLifecycle.Instance.AddAttachment("attachment-name", "text/plain", Encoding.UTF8.GetBytes("attachment-value"));
+            Console.WriteLine($"      Done!");
+        }
+    }
+}
diff --git a/Allure.NUnit/Core/AllureExtensions.cs b/Allure.NUnit/Core/AllureExtensions.cs
@@ -4,6 +4,7 @@
 using Allure.Net.Commons;
 using NUnit.Framework.Internal;
 using System.Linq;
+using System.Threading.Tasks;
 
 namespace NUnit.Allure.Core
 {
@@ -83,7 +84,7 @@ public static void WrapInStep(this AllureLifecycle lifecycle, Action action, str
                 throw;
             }
         }
-        
+
         /// <summary>
         /// Wraps Func into AllureStep.
         /// </summary>
@@ -114,6 +115,75 @@ public static T WrapInStep<T>(this AllureLifecycle lifecycle, Func<T> func, stri
             }
         }
 
+        /// <summary>
+        /// Wraps async Action into AllureStep.
+        /// </summary>
+        public static async Task WrapInStepAsync(
+            this AllureLifecycle lifecycle,
+            Func<Task> action,
+            string stepName = "",
+            [CallerMemberName] string callerName = ""
+        )
+        {
+            if (string.IsNullOrEmpty(stepName)) stepName = callerName;
+
+            var id = Guid.NewGuid().ToString();
+            var stepResult = new StepResult { name = stepName };
+            try
+            {
+                lifecycle.StartStep(id, stepResult);
+                await action();
+                lifecycle.StopStep(step => stepResult.status = Status.passed);
+            }
+            catch (Exception e)
+            {
+                lifecycle.StopStep(step =>
+                {
+                    step.statusDetails = new StatusDetails
+                    {
+                        message = e.Message,
+                        trace = e.StackTrace
+                    };
+                    step.status = AllureNUnitHelper.GetNUnitStatus();
+                });
+                throw;
+            }
+        }
+
+        /// <summary>
+        /// Wraps async Func into AllureStep.
+        /// </summary>
+        public static async Task<T> WrapInStepAsync<T>(
+            this AllureLifecycle lifecycle,
+            Func<Task<T>> func,
+            string stepName = "",
+            [CallerMemberName] string callerName = ""
+        )
+        {
+            if (string.IsNullOrEmpty(stepName)) stepName = callerName;
+            var id = Guid.NewGuid().ToString();
+            var stepResult = new StepResult { name = stepName };
+            try
+            {
+                lifecycle.StartStep(id, stepResult);
+                var result = await func();
+                lifecycle.StopStep(step => stepResult.status = Status.passed);
+                return result;
+            }
+            catch (Exception e)
+            {
+                lifecycle.StopStep(step =>
+                {
+                    step.statusDetails = new StatusDetails
+                    {
+                        message = e.Message,
+                        trace = e.StackTrace
+                    };
+                    step.status = AllureNUnitHelper.GetNUnitStatus();
+                });
+                throw;
+            }
+        }
 
         /// <summary>
         /// AllureNUnit AddScreenDiff wrapper method.

diff --git a/Allure.NUnit/Core/AllureNUnitAttribute.cs b/Allure.NUnit/Core/AllureNUnitAttribute.cs
@@ -1,5 +1,6 @@
 using System;
-using System.Threading;
+using System.Collections.Concurrent;
+using Allure.Net.Commons;
 using NUnit.Framework;
 using NUnit.Framework.Interfaces;
 
@@ -8,23 +9,42 @@ namespace NUnit.Allure.Core
     [AttributeUsage(AttributeTargets.Interface | AttributeTargets.Class)]
     public class AllureNUnitAttribute : PropertyAttribute, ITestAction
     {
-        private readonly ThreadLocal<AllureNUnitHelper> _allureNUnitHelper = new ThreadLocal<AllureNUnitHelper>(true);
+        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;
+        }
+
+        [Obsolete("wrapIntoStep parameter is obsolete. Use [AllureStep] method attribute")]
         public AllureNUnitAttribute(bool wrapIntoStep = true)
+        {
+            _isWrappedIntoStep = wrapIntoStep;
+        }
+
+        public AllureNUnitAttribute()
         {
         }
 
         public void BeforeTest(ITest test)
         {
-            _allureNUnitHelper.Value = new AllureNUnitHelper(test);
-            _allureNUnitHelper.Value.StartTestContainer();
-            _allureNUnitHelper.Value.StartTestCase();
+            var helper = new AllureNUnitHelper(test);
+            _allureNUnitHelper.AddOrUpdate(test.Id, helper, (key, existing) => helper);
+            helper.StartTestContainer();
+            helper.StartTestCase();
         }
 
         public void AfterTest(ITest test)
         {
-            _allureNUnitHelper.Value.StopTestCase();
-            _allureNUnitHelper.Value.StopTestContainer();
+            if (_allureNUnitHelper.TryGetValue(test.Id, out var helper))
+            {
+                helper.StopTestCase();
+                helper.StopTestContainer();
+            }
         }
 
         public ActionTargets Targets => ActionTargets.Test;

diff --git a/Allure.Net.Commons.Tests/Allure.Net.Commons.Tests.csproj b/Allure.Net.Commons.Tests/Allure.Net.Commons.Tests.csproj
@@ -8,7 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="Castle.Core" Version="5.0.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.2.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
     <PackageReference Include="Moq" Version="4.18.1" />
     <PackageReference Include="NUnit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />

diff --git a/Allure.Net.Commons/AllureLifecycle.cs b/Allure.Net.Commons/AllureLifecycle.cs
@@ -1,8 +1,9 @@
 using System;
 using System.IO;
 using System.Runtime.CompilerServices;
-using Allure.Net.Commons.Helpers;
+using System.Threading;
 using Allure.Net.Commons.Configuration;
+using Allure.Net.Commons.Helpers;
 using Allure.Net.Commons.Storage;
 using Allure.Net.Commons.Writer;
 using HeyRed.Mime;
@@ -19,6 +20,9 @@ public class AllureLifecycle
         private readonly AllureStorage storage;
         private readonly IAllureResultsWriter writer;
 
+        /// <summary> Method to get the key for separation the steps for different tests. </summary>
+        public static Func<string> CurrentTestIdGetter { get; set; } = () => Thread.CurrentThread.ManagedThreadId.ToString();
+
         internal AllureLifecycle(): this(GetConfiguration())
         {
         }
@@ -29,10 +33,6 @@ internal AllureLifecycle(JObject config)
             AllureConfiguration = AllureConfiguration.ReadFromJObject(config);
             writer = new FileSystemResultsWriter(AllureConfiguration);
             storage = new AllureStorage();
-            lock (Lockobj)
-            {
-                instance = this;
-            }
         }
 
         public string JsonConfiguration { get; private set; }
@@ -49,7 +49,10 @@ public static AllureLifecycle Instance
                     lock (Lockobj)
                     {
                         if (instance == null)
-                            new AllureLifecycle();
+                        {
+                            var localInstance = new AllureLifecycle();
+                            Interlocked.Exchange(ref instance, localInstance);
+                        }
                     }
                 }
 

diff --git a/Allure.Net.Commons/Storage/AllureStorage.cs b/Allure.Net.Commons/Storage/AllureStorage.cs
@@ -1,19 +1,20 @@
-using System.Collections.Concurrent;
+using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Threading;
 
 namespace Allure.Net.Commons.Storage
 {
     internal class AllureStorage
     {
-        private readonly ThreadLocal<LinkedList<string>> stepContext = new ThreadLocal<LinkedList<string>>(() =>
-        {
-            return new LinkedList<string>();
-        });
+        private readonly ConcurrentDictionary<string, LinkedList<string>> stepContext = new();
 
-        private readonly ConcurrentDictionary<string, object> storage = new ConcurrentDictionary<string, object>();
+        private readonly ConcurrentDictionary<string, object> storage = new();
 
-        private LinkedList<string> Steps => stepContext.Value;
+        private LinkedList<string> Steps => stepContext.GetOrAdd(
+            AllureLifecycle.CurrentTestIdGetter(),
+            new LinkedList<string>()
+        );
 
         public T Get<T>(string uuid)
         {

diff --git a/Allure.SpecFlowPlugin.Tests/Allure.SpecFlowPlugin.Tests.csproj b/Allure.SpecFlowPlugin.Tests/Allure.SpecFlowPlugin.Tests.csproj
@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
     <PackageReference Include="NUnit" Version="3.13.2" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.0.0" />
   </ItemGroup>

diff --git a/Allure.SpecFlowPlugin/Allure.SpecFlowPlugin.csproj b/Allure.SpecFlowPlugin/Allure.SpecFlowPlugin.csproj
@@ -35,7 +35,7 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="CsvHelper" Version="27.1.0" />
+        <PackageReference Include="CsvHelper" Version="30.0.1" />
         <PackageReference Include="SpecFlow" Version="[3.9.8, 3.10)" />
         <PackageReference Include="System.Collections.Specialized" Version="4.3.0" />
     </ItemGroup>

diff --git a/Allure.SpecflowPlugin.Nuget.Tests/Allure.SpecflowPlugin.Nuget.Tests.csproj b/Allure.SpecflowPlugin.Nuget.Tests/Allure.SpecflowPlugin.Nuget.Tests.csproj
@@ -6,7 +6,7 @@
 
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
     <PackageReference Include="NUnit" Version="3.12.0" />
     <PackageReference Include="NUnit3TestAdapter" Version="3.16.1" />
     <PackageReference Include="SpecFlow.Tools.MsBuild.Generation" Version="3.1.97" />

diff --git a/Allure.XUnit.Examples/Allure.XUnit.Examples.csproj b/Allure.XUnit.Examples/Allure.XUnit.Examples.csproj
@@ -6,7 +6,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.0.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
         <PackageReference Include="xunit" Version="2.4.1" />
         <PackageReference Include="coverlet.collector" Version="3.1.2">
           <PrivateAssets>all</PrivateAssets>