Add ability to use custom labels in SpecFlow plugin (#284)

* add parsing custom label as key-value

* Add new unit test to check custom label

* fix label regex

Co-authored-by: Aleksandr Kulakov <a.kulakov@dodopizza.com>

Author: evgeniy-skt

Allure.Features/TestData/Labels.feature

@@ -17,4 +17,7 @@ Feature: Labels
   Scenario: [v1.2 accounting] [core.update] Update test
 
   @passed @epic:v.2.0 @story:security @package:com.company.security @class:main @method:getACL
-  Scenario: [v1.2 / v.2.0 security] [core.update] [com.company.security.main.getACL] Get ACL test
+  Scenario: [v1.2 / v.2.0 security] [core.update] [com.company.security.main.getACL] Get ACL test
+      
+  @passed @label:layer:e2e @label:as_id:9894 @label:custom_label:pepa
+  Scenario: Layer e2e (label)

Allure.Features/allureConfig.json

@@ -31,7 +31,8 @@
     },
     "labels": {
       "owner": "^owner:?(.+)",
-      "severity": "^(normal|blocker|critical|minor|trivial)"
+      "severity": "^(normal|blocker|critical|minor|trivial)",
+      "label": "^label:([\\w]+):(.+)"
     },
     "links": {
       "link": "^link:(.+)",

Allure.SpecFlowPlugin.Tests/IntegrationTests.cs

@@ -169,6 +169,18 @@ public void ShouldParseTags()
       });
     }
 
+    [Test]
+    public void ShouldParseCustomLabel()
+    {
+      var scenarios = allureTestResults
+        .Where(x => x.labels.Any(l => l.value == "labels"));
+
+      var labels = scenarios.SelectMany(x => x.labels);
+
+      Assert.That(labels.Where(x => x.value == "pepa").Select(l => l.name),
+        Has.Exactly(1).Items.And.All.EqualTo("custom_label"));
+    }
+
     [Test]
     public void ShouldAddParametersForScenarioExamples()
     {

Allure.SpecFlowPlugin/PluginConfiguration.cs

@@ -46,6 +46,7 @@ public class Labels
     {
         public string owner { get; set; }
         public string severity { get; set; }
+        public string label { get; set; }
     }
 
     public class Links

Allure.SpecFlowPlugin/PluginHelper.cs

@@ -236,6 +236,13 @@ private static Tuple<List<Label>, List<Link>> GetTags(FeatureInfo featureInfo, S
           continue;
         }
 
+        // label
+        if (GetLabelProps(PluginConfiguration.labels.label, tagValue, out var props))
+        {
+          result.Item1.Add(new Label { name = props.Key, value = props.Value});
+          continue;
+        }
+        
         // tag
         result.Item1.Add(Label.Tag(tagValue));
       }
@@ -261,37 +268,66 @@ private static (List<Parameter> parameters, string hash) GetParameters(ScenarioI
 
     private static bool TryUpdateValueByMatch(string expression, ref string value)
     {
-      if (string.IsNullOrWhiteSpace(value) || string.IsNullOrWhiteSpace(expression))
+      var matchedGroups = GetMatchedGroups(expression, value);
+
+      if (!matchedGroups.Any()) return false;
+      
+      if (matchedGroups.Count == 1)
+        value = matchedGroups[0];
+      else
+        value = matchedGroups[1];
+      return true;
+    }
+
+    private static bool GetLabelProps(string expression, string value, out KeyValuePair<string, string> props)
+    {
+      props = default;
+       
+      var matchedGroups = GetMatchedGroups(expression, value);
+
+      if (matchedGroups.Count != 3)
         return false;
+      
+      props = new KeyValuePair<string, string>(matchedGroups[1], matchedGroups[2]);
+      return true;
+
+    }
+    
+    private static List<string> GetMatchedGroups(string expression, string value)
+    {
+      var matchedGroups = new List<string>();
+      if (string.IsNullOrWhiteSpace(value) || string.IsNullOrWhiteSpace(expression))
+        return matchedGroups;
 
       Regex regex = null;
       try
       {
         regex = new Regex(expression,
-            RegexOptions.Compiled | RegexOptions.Singleline | RegexOptions.IgnoreCase);
+          RegexOptions.Compiled | RegexOptions.Singleline | RegexOptions.IgnoreCase);
       }
       catch (Exception)
       {
-        return false;
+        return matchedGroups;
       }
 
       if (regex == null)
-        return false;
+        return matchedGroups;
 
       if (regex.IsMatch(value))
       {
         var groups = regex.Match(value).Groups;
-        if (groups?.Count == 1)
-          value = groups[0].Value;
-        else
-          value = groups[1].Value;
 
-        return true;
+        for (var i = 0; i < groups.Count; i++)
+        {
+          matchedGroups.Add(groups[i].Value);
+        }
+
+        return matchedGroups;
       }
 
-      return false;
+      return matchedGroups;
     }
-
+    
     private static int GetDeterministicHashCode(this string str)
     {
       unchecked

Allure.SpecFlowPlugin/README.md

@@ -111,6 +111,20 @@ Scenario: ....
 ```
 will set current scenario severity in Allure report as Blocker
 
+#### Label
+You can add Label for your scenarios using tags. It can be configured in `allureConfig.json`
+``` json
+ "labels": {
+      "label": "^label:([\\w]+):(.+)"
+    },
+```
+The following scenario
+``` cucumber
+@label:layer:e2e: @label:as_id:123
+Scenario: ....
+```
+will set current scenario Layer as e2e and Id as 123 in Allure report
+
 #### Tables conversion
 Table arguments in SpecFlow steps can be converted either to step csv-attacments or step parameters in the Allure report. The conversion is configurable in `specflow:stepArguments` config section.
 With `specflow:stepArguments:convertToParameters` set to `true` the following table arguments will be represented as parameters: