Support allureId attribute to permanent mapping result to existing te…

…st case (#26) * Support allureId attribute to permanent mapping result to existing test case * Support allureId attribute to permanent mapping result to existing test case: rename to AllureId from AllureAllureId Co-authored-by: Danila Polevshchikov <danila.polevshchikov@go-springtime.com>
Tinkoff · Jun 9, 2022 · 2aa6c96 · 2aa6c96
1 parent f8a685a
commit 2aa6c96
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 4 deletions.
diff --git a/Readme.md b/Readme.md
@@ -22,6 +22,7 @@ Allure.XUnit supports .NET Core 2.0 and later.
 * AllureLink
 * AllureEpic
 * AllureLabel
+* AllureId
 * AllureXunitTheory - attribute for display parametrized tests. Use ```InlineData```, ```MemberData```, ```ClassData```,
   XUnit attributes for pass parameters.
 
@@ -48,6 +49,7 @@ Most of the attributes can be used both on methods and classes.
 | AllureEpic        |  x  |  x  |
 | AllureLabel       |  x  |  x  |
 | AllureXunitTheory |  x  |     |
+| AllureId          |  x  |     |
 
 To override attribute value you can use `overwrite` param in attribute definition.
 In other case multiple values will be written in test results.

diff --git a/src/Allure.XUnit.Examples/Allure.XUnit.Examples.csproj b/src/Allure.XUnit.Examples/Allure.XUnit.Examples.csproj
@@ -12,7 +12,10 @@
           <PrivateAssets>all</PrivateAssets>
           <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3" />
+        <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
+          <PrivateAssets>all</PrivateAssets>
+          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
     </ItemGroup>
 
     <ItemGroup>

diff --git a/src/Allure.XUnit.Examples/ExampleUnitTests.cs b/src/Allure.XUnit.Examples/ExampleUnitTests.cs
@@ -61,5 +61,12 @@ public void TestMultipleTagsWithOverwrite()
         {
             Assert.True(!false);
         }
+
+        [AllureXunit(DisplayName = "Test mapped to existing test case #1 in allure")]
+        [AllureId("1")]
+        public void TestAllureIdMapping()
+        {
+            Assert.True(true);
+        }
     }
 }
diff --git a/src/Allure.XUnit/Allure.XUnit.csproj b/src/Allure.XUnit/Allure.XUnit.csproj
@@ -8,8 +8,8 @@
         <Title>Allure.XUnit</Title>
         <Authors>Shumakov Ivan</Authors>
         <Description>Allure.XUnit</Description>
-        <PackageProjectUrl>https://github.com/TinkoffCreditSystems/Allure.XUnit</PackageProjectUrl>
-        <RepositoryUrl>https://github.com/TinkoffCreditSystems/Allure.XUnit</RepositoryUrl>
+        <PackageProjectUrl>https://github.com/Tinkoff/Allure.XUnit</PackageProjectUrl>
+        <RepositoryUrl>https://github.com/Tinkoff/Allure.XUnit</RepositoryUrl>
         <PackageTags>allure; xunit;</PackageTags>
         <LangVersion>9</LangVersion>
     </PropertyGroup>

diff --git a/src/Allure.XUnit/AllureXunitHelper.cs b/src/Allure.XUnit/AllureXunitHelper.cs
@@ -197,6 +197,12 @@ private static void UpdateTestDataFromAttributes(TestResult testResult, ITestCas
                         testResult.description = descriptionAttribute.Description;
                         break;
 
+
+                    case AllureIdAttribute allureIdAttribute:
+                        var allureIdLabel = new Label {name = "as_id", value = allureIdAttribute.AllureId};
+                        testResult.labels.AddDistinct(allureIdLabel, false);
+                        break;
+
                     case AllureLabelAttribute labelAttribute:
                         var label = new Label()
                         {

diff --git a/src/Allure.XUnit/Attributes/AllureIdAttribute.cs b/src/Allure.XUnit/Attributes/AllureIdAttribute.cs
@@ -0,0 +1,19 @@
+using System;
+
+namespace Allure.Xunit.Attributes
+{
+    /// <summary>
+    /// Internal AllureId of test case, used to permanent mapping result to existing automatic test case. NB: don't confuse with "test case id" aka id for external TMS system.
+    /// https://docs.qameta.io/allure-testops/ecosystem/intellij-plugin/#link-tests-in-ide-to-tests-cases-in-allure-testops-via-allureid
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Method)]
+    public class AllureIdAttribute : Attribute, IAllureInfo
+    {
+        public AllureIdAttribute(string allureId)
+        {
+            AllureId = allureId;
+        }
+
+        public string AllureId { get; }
+    }
+}
diff --git a/src/Allure.Xunit.StepExtensions.Examples/Allure.Xunit.StepExtensions.Examples.csproj b/src/Allure.Xunit.StepExtensions.Examples/Allure.Xunit.StepExtensions.Examples.csproj
@@ -12,7 +12,7 @@
         <PackageReference Include="MethodBoundaryAspect.Fody" Version="2.0.145" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.0.0" />
         <PackageReference Include="xunit" Version="2.4.1" />
-        <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+        <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>