Allure TestOps: Add Tags (#55)

* Add Tags

Author: andrey-brovko

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-[3.16.0] - 2022-09-12
+[3.17.0] - 2022-09-21
 
 ### Added
-- Allure TestOps: Add scenario
+- Allure TestOps: Add tags to a test case

GherkinSyncTool.Synchronizers.AllureTestOps/Client/AllureClientWrapper.cs

@@ -215,6 +215,20 @@ public void UploadStepAttachments(CreateTestCaseRequestExtended caseRequestExten
 
             ValidateResponse(response);
         }
+        
+        public List<Tag> GetAllTestTags()
+        {
+            var response = _allureClient.GetTagsAsync().Result;
+            ValidateResponse(response);
+            return response.Content;
+        }
+        
+        public Tag AddTestTags(string name)
+        {
+            var response = _allureClient.CreateTagAsync(new Tag {Name = name}).Result;
+            ValidateResponse(response);
+            return response.Content;
+        }
 
         private void UpdateTestCaseStepAttachments(CreateTestCaseRequestExtended caseToUpdate, TestCaseOverview testCaseOverview)
         {
@@ -236,6 +250,13 @@ private static bool AreTestCasesContentsEqual(TestCaseOverview currentCase, Crea
             if (!currentCase.Automated.Equals(caseToUpdate.CreateTestCaseRequest.Automated)) return false;
             if (!currentCase.Status.Id.Equals(caseToUpdate.CreateTestCaseRequest.StatusId)) return false;
             if (!currentCase.Description.Equals(caseToUpdate.CreateTestCaseRequest.Description)) return false;
+            
+            var caseToUpdateTagIds = caseToUpdate.CreateTestCaseRequest.Tags.Select(tag => tag.Id).ToList();
+            var currentCaseTagIds = currentCase.Tags.Select(tag => tag.Id).ToList();
+
+            if (currentCaseTagIds.Count != caseToUpdateTagIds.Count) return false;
+            if (currentCaseTagIds.Except(caseToUpdateTagIds).Any()) return false;
+
             return true;
         }
 

GherkinSyncTool.Synchronizers.AllureTestOps/Content/CaseContentBuilder.cs

@@ -12,10 +12,11 @@
 using NLog;
 using Quantori.AllureTestOpsClient.Model;
 using Refit;
-using Scenario = Gherkin.Ast.Scenario;
-using Step = Gherkin.Ast.Step;
 using AllureTestCaseStep = Quantori.AllureTestOpsClient.Model.Step;
 using AllureScenario = Quantori.AllureTestOpsClient.Model.Scenario;
+using Scenario = Gherkin.Ast.Scenario;
+using Step = Gherkin.Ast.Step;
+using Tag = Quantori.AllureTestOpsClient.Model.Tag;
 
 namespace GherkinSyncTool.Synchronizers.AllureTestOps.Content;
 
@@ -31,6 +32,7 @@ public class CaseContentBuilder
     private List<WorkflowSchema> _workflowSchemas;
     private Item _automatedWorkflowId;
     private Item _manualWorkflowId;
+    private List<Tag> _testTags;
 
     public List<WorkflowSchema> WorkflowSchemas =>
         _workflowSchemas ??= _allureClientWrapper.GetAllWorkflowSchemas(_allureTestOpsSettings.ProjectId).ToList();
@@ -42,6 +44,7 @@ public class CaseContentBuilder
         _automatedWorkflowId ??= WorkflowSchemas.FirstOrDefault(schema => schema.Type.Equals(TestType.Automated))!.Workflow;
 
     public Item ManualWorkflow => _manualWorkflowId ??= WorkflowSchemas.FirstOrDefault(schema => schema.Type.Equals(TestType.Manual))!.Workflow;
+    public  List<Tag> AllureTestTags => _testTags ??= _allureClientWrapper.GetAllTestTags();
 
     public CaseContentBuilder(AllureClientWrapper allureClientWrapper, Context context)
     {
@@ -61,14 +64,50 @@ public CreateTestCaseRequestExtended BuildCaseRequest(Scenario scenario, IFeatur
                 StatusId = AddStatus(scenario, featureFile),
                 WorkflowId = AddWorkflow(scenario, featureFile),
                 Description = AddDescription(scenario, featureFile),
-                Scenario = AddScenario(scenario, featureFile)
+                Scenario = AddScenario(scenario, featureFile),
+                Tags = AddTags(scenario, featureFile)
             },
             StepsAttachments = AddStepAttachments(scenario, featureFile)
         };
 
         return createTestCaseRequestExtended;
     }
 
+    private List<Tag> AddTags(Scenario scenario, IFeatureFile featureFile)
+    {
+        var allTags = GherkinHelper.GetAllTags(scenario, featureFile);
+        //Remove tags that will duplicate existing fields
+        RemoveTags(allTags, TagsConstants.Reference, TagsConstants.Automated, TagsConstants.Status);
+        
+        var result = new List<Tag>();
+        if (allTags.Any())
+        {
+            foreach (var tag in allTags)
+            {
+                var tagName = tag.Name.Replace("@", "");
+                var allureTag = AllureTestTags.FirstOrDefault(t => t.Name.Equals(tagName, StringComparison.InvariantCultureIgnoreCase));
+                if (allureTag is null)
+                {
+                    var newTag = _allureClientWrapper.AddTestTags(tagName);
+                    AllureTestTags.Add(newTag);
+                    result.Add(newTag);
+                    continue;
+                }
+                result.Add(new Tag {Id = allureTag.Id, Name = tagName});
+            }
+        }
+
+        return result;
+    }
+
+    private void RemoveTags(List<Gherkin.Ast.Tag> allTags, params string[] tagsToRemove)
+    {
+        foreach (var tagToRemove in tagsToRemove)
+        {
+            allTags.RemoveAll(tag => tag.Name.Contains(tagToRemove, StringComparison.InvariantCultureIgnoreCase));    
+        }
+    }
+
     private Dictionary<int, ByteArrayPart> AddStepAttachments(Scenario scenario, IFeatureFile featureFile)
     {
         var attachments = ExtractAttachments(scenario.Steps.ToList());
@@ -78,7 +117,7 @@ private Dictionary<int, ByteArrayPart> AddStepAttachments(Scenario scenario, IFe
         {
             var backgroundStepCount = background.Steps.Count();
             var attachmentsShifted = attachments.ToDictionary(attachment => attachment.Key + backgroundStepCount, attachment => attachment.Value);
-            
+
             var backgroundAttachments = ExtractAttachments(background.Steps.ToList());
             return backgroundAttachments.Concat(attachmentsShifted).ToDictionary(pair => pair.Key, pair => pair.Value);
         }
@@ -97,13 +136,13 @@ private Dictionary<int, ByteArrayPart> ExtractAttachments(List<Step> steps)
             switch (step.Argument)
             {
                 case DocString docString:
-                    
+
                     var textBytes = Encoding.ASCII.GetBytes(docString.Content);
                     result.Add(index, new ByteArrayPart(textBytes, "Text", "text/plain"));
                     break;
-                
+
                 case DataTable table:
-                    
+
                     var csvBytes = Encoding.ASCII.GetBytes(ConvertToCsvTable(table.Rows.ToList()));
                     result.Add(index, new ByteArrayPart(csvBytes, "Table", "text/csv"));
                     break;
@@ -171,11 +210,11 @@ private string AddDescription(Scenario scenario, IFeatureFile featureFile)
         if (background is not null && (!string.IsNullOrWhiteSpace(background.Name) || !string.IsNullOrWhiteSpace(background.Description)))
         {
             description.AppendLine($"**{background.Keyword}:** {background.Name}");
-            if(!string.IsNullOrWhiteSpace(background.Description)) description.AppendLine(background.Description);
+            if (!string.IsNullOrWhiteSpace(background.Description)) description.AppendLine(background.Description);
         }
 
         description.AppendLine($"**Feature file:** {featureFile.RelativePath}");
-        
+
         var examples = scenario.Examples.ToList();
 
         if (examples.Any())
@@ -210,6 +249,7 @@ private string ConvertToMarkdownTable(List<TableRow> tableRows)
         {
             table.Append($"{cell.Value}|");
         }
+
         table.AppendLine();
         table.Append("|");
         //Header delimiter

GherkinSyncTool.Synchronizers.AllureTestOps/Model/TagsConstants.cs

@@ -4,5 +4,6 @@ public static class TagsConstants
     {
         public const string Automated = "@Automated";
         public const string Status = "@Status:";
+        public const string Reference = "@Reference:";
     }
 }

GherkinSyncTool/GherkinSyncTool.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <AssemblyVersion>3.16.0</AssemblyVersion>
+        <AssemblyVersion>3.17.0</AssemblyVersion>
         <OutputType>Exe</OutputType>
         <TargetFrameworks>netcoreapp3.1;net5.0;net6.0</TargetFrameworks>
         <PackAsTool>true</PackAsTool>

Quantori.AllureTestOpsClient/IAllureClient.cs

@@ -57,7 +57,6 @@ public interface IAllureClient
         Task<IApiResponse<GetContentResponse<Status>>> GetStatusAsync(int? workflowId = null, int page = 0, int size = 100, string sort = null);
         #endregion
 
-        
         #region Workflow schema controller
         /// <summary>
         /// Find all workflow schemas for given project
@@ -71,10 +70,10 @@ public interface IAllureClient
         #endregion
 
         #region Workflow controller
+
         /// <summary>
         /// Find all workflow
         /// </summary>
-        /// <param name="projectId"></param>
         /// <param name="page"></param>
         /// <param name="size"></param>
         /// <param name="sort"></param>
@@ -121,5 +120,23 @@ public interface IAllureClient
         Task<IApiResponse<Scenario>> DeleteTestCaseScenarioAsync([AliasAs("id")] long testCaseId);
 
         #endregion
+        
+        #region Test tag controller
+        
+        /// <summary>
+        /// Find all test tags
+        /// </summary>
+        /// <returns></returns>
+        [Get("/api/rs/tag")]
+        Task<IApiResponse<List<Tag>>> GetTagsAsync();
+        
+        /// <summary>
+        /// Create a new test tag
+        /// </summary>
+        /// <returns></returns>
+        [Post("/api/rs/tag")]
+        Task<IApiResponse<Tag>> CreateTagAsync([Body] Tag tag);
+
+        #endregion
     }
 }

Quantori.AllureTestOpsClient/Model/Tag.cs

@@ -2,7 +2,7 @@
 {
     public class Tag
     {
-        public int Id { get; set; }
+        public long Id { get; set; }
         public string Name { get; set; }
     }
 }

README.md

@@ -77,6 +77,8 @@ GherkinSyncTool can be configured in three ways. The priority corresponds to the
 | BaseDirectory | Absolute or relative to application folder path that contains *.feature files                        | Yes      |
 | TagIdPrefix   | A tag prefix that will be used for mark test scenarios as synchronized with a test management system | No       |
 
+Allure TestOps note: `TagIdPrefix` should be configured to fill the 'as_id' Allure label correctly. For example, for Specflow TagIdPrefix should be equals `@label:as_id:` It is required to not duplicate manual and automated test cases. The test run result will be attached to the correct Allure test ID.
+
 ### Formatting settings
 
 | Parameter      | Description            | Required |