feat(commons): globalLabels config property (#598)

Author: delatrie

Allure.NUnit/Core/AllureNUnitHelper.cs

@@ -108,6 +108,7 @@ internal static TestResult CreateTestResult(ITest test)
                         GetClassName(test.ClassName)
                     ),
                     ..ModelFunctions.EnumerateEnvironmentLabels(),
+                    ..ModelFunctions.EnumerateGlobalLabels(),
                 ]
             };
             UpdateTestDataFromAllureAttributes(test, testResult);

Allure.Net.Commons.Tests/ConfigurationTests.cs

@@ -2,6 +2,7 @@
 using System;
 using System.IO;
 using Newtonsoft.Json.Linq;
+using System.Collections.Generic;
 
 namespace Allure.Net.Commons.Tests
 {
@@ -57,5 +58,22 @@ public void ShouldConfigureIndentation()
             var json = @"{""allure"":{""indentOutput"": true}}";
             Assert.That(new AllureLifecycle(JObject.Parse(json)).AllureConfiguration.IndentOutput, Is.True);
         }
+
+        [Test]
+        public void ShouldConfigureGlobalLabels()
+        {
+            var json = @"{""allure"":{""globalLabels"":{""foo"":""bar"",""baz"":""qux""}}}";
+
+            var config = new AllureLifecycle(JObject.Parse(json)).AllureConfiguration;
+
+            Assert.That(
+                config.GlobalLabels,
+                Is.EqualTo(new Dictionary<string, string>
+                {
+                    { "foo", "bar" },
+                    { "baz", "qux" },
+                })
+            );
+        }
     }
 }

Allure.Net.Commons.Tests/FunctionTests/ModelFunctionTests/GlobalLabelsTests.cs

@@ -0,0 +1,76 @@
+using NUnit.Framework;
+using Allure.Net.Commons.Functions;
+using System.Collections.Generic;
+using System.Linq;
+using Allure.Net.Commons.Configuration;
+
+namespace Allure.Net.Commons.Tests.FunctionTests.ModelFunctionTests;
+
+class GlobalLabelsTests
+{
+    AllureConfiguration config;
+
+    [SetUp]
+    public void SetUpEnvSource()
+    {
+        this.config = new();
+        ModelFunctions.Config = this.config;
+    }
+
+    [TearDown]
+    public void RemoveEnvSource()
+    {
+        ModelFunctions.Config = null;
+    }
+
+    [Test]
+    public void ShouldNotThrowIfGlobalLabelsNull()
+    {
+        this.config.GlobalLabels = null;
+
+        Assert.That(
+            () => ModelFunctions.EnumerateGlobalLabels().ToList(),
+            Throws.Nothing
+        );
+    }
+
+    [Test]
+    public void ShouldIncludeGlobalLabel()
+    {
+        this.config.GlobalLabels["foo"] = "bar";
+        this.config.GlobalLabels["baz"] = "qux";
+
+        Assert.That(
+            ModelFunctions.EnumerateGlobalLabels(),
+            Is.EquivalentTo(new Label[]
+            {
+                new() { name = "foo", value = "bar" },
+                new() { name = "baz", value = "qux" },
+            }).UsingPropertiesComparer()
+        );
+    }
+
+    [Test]
+    public void ShouldIgnoreNullValues()
+    {
+        this.config.GlobalLabels["foo"] = null;
+
+        Assert.That(ModelFunctions.EnumerateGlobalLabels(), Is.Empty);
+    }
+
+    [Test]
+    public void ShouldIgnoreEmptyValues()
+    {
+        this.config.GlobalLabels["foo"] = "";
+
+        Assert.That(ModelFunctions.EnumerateGlobalLabels(), Is.Empty);
+    }
+
+    [Test]
+    public void ShouldIgnoreEmptyNames()
+    {
+        this.config.GlobalLabels[""] = "foo";
+
+        Assert.That(ModelFunctions.EnumerateGlobalLabels(), Is.Empty);
+    }
+}

Allure.Net.Commons/AllureLifecycle.cs

@@ -687,9 +687,6 @@ void UpdateContext(Func<AllureContext, AllureContext> updateFn)
         this.Context = updateFn(this.Context);
     }
 
-    static string CreateUuid() =>
-        Guid.NewGuid().ToString("N");
-
     static Action<T> Chain<T>(params Action<T>[] actions) => v =>
     {
         foreach (var action in actions)

Allure.Net.Commons/Configuration/AllureConfiguration.cs

@@ -20,10 +20,11 @@ protected AllureConfiguration(string title, string directory, HashSet<string> li
 
         public string Title { get; init; }
         public string Directory { get; init; } = AllureConstants.DEFAULT_RESULTS_FOLDER;
-        public HashSet<string> Links { get; } = new HashSet<string>();
+        public HashSet<string> Links { get; } = [];
         public List<string> FailExceptions { get; set; }
         public bool UseLegacyIds { get; set; } = false;
         public bool IndentOutput { get; set; } = false;
+        public Dictionary<string, string> GlobalLabels { get; set; } = [];
 
         public static AllureConfiguration ReadFromJObject(JObject jObject)
         {

Allure.Net.Commons/Functions/ModelFunctions.cs

@@ -4,6 +4,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Threading;
+using Allure.Net.Commons.Configuration;
 
 #nullable enable
 
@@ -127,6 +128,15 @@ public static IEnumerable<Label> EnumerateEnvironmentLabels()
         }
     }
 
+    /// <summary>
+    /// Returns a sequence of labels defined by the <c>globalLabels</c>
+    /// configuration property.
+    /// </summary>
+    public static IEnumerable<Label> EnumerateGlobalLabels() =>
+        from kv in Config.GlobalLabels ?? []
+        where !string.IsNullOrEmpty(kv.Key) && !string.IsNullOrEmpty(kv.Value)
+        select new Label { name = kv.Key, value = kv.Value };
+
     static bool ShouldAddEnvVarAsLabel(
         [NotNullWhen(true)] string? name,
         [NotNullWhen(true)] string? value
@@ -165,8 +175,17 @@ static IDictionary GetEnvironmentVariables() =>
     internal static void SetGetEnvironmentVariables(Func<IDictionary>? getEnvVars) =>
         GetEnvironmentVariablesBox.Value = getEnvVars;
 
+    internal static AllureConfiguration Config
+    {
+        get => ConfigBox.Value ?? AllureLifecycle.Instance.AllureConfiguration;
+        set => ConfigBox.Value = value;
+    }
+
     // To decouple from Environment.GetEnvironmentVariable
     static AsyncLocal<Func<IDictionary>?> GetEnvironmentVariablesBox { get; set; } = new();
 
+    // To decouple from AllureLifecycle.Instance.AllureConfiguration
+    static AsyncLocal<AllureConfiguration?> ConfigBox { get; set; } = new();
+
     #endregion
 }

Allure.Net.Commons/Schemas/allureConfig.schema.json

@@ -41,6 +41,13 @@
           "type": "boolean",
           "description": "If set to true, the output JSON files (*-result.json, *-container.json) will be indented to be more readable",
           "default": false
+        },
+        "globalLabels": {
+          "type": "object",
+          "description": "An object that defines the global labels, i.e., labels that are added to every test result produced during the test run. Empty values are ignored",
+          "additionalProperties": {
+            "type": "string"
+          }
         }
       }
     }

Allure.Reqnroll.Tests/Integration/TestSetup.cs

@@ -2,7 +2,7 @@
 using System;
 using System.IO;
 
-namespace Allure.SpecFlowPlugin.Tests
+namespace Allure.ReqnrollPlugin.Tests
 {
     [SetUpFixture]
     public class TestSetup

Allure.Reqnroll/Functions/MappingFunctions.cs

@@ -439,6 +439,7 @@ static List<Label> InitializeTestLabels(
     ) => [
         .. CreateDefaultLabels(featureInfo),
         .. ModelFunctions.EnumerateEnvironmentLabels(),
+        .. ModelFunctions.EnumerateGlobalLabels(),
         .. scenarioLabels ?? [],
     ];
 

Allure.SpecFlow.Tests.Samples/allureConfig.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/allure-framework/allure-csharp/2.13.0/Allure.SpecFlowPlugin/Schemas/allureConfig.schema.json",
+  "$schema": "https://raw.githubusercontent.com/allure-framework/allure-csharp/2.13.0/Allure.SpecFlow/Schemas/allureConfig.schema.json",
   "allure": {
     "title": "5994A3F7-AF84-46AD-9393-000BB45553CC",
     "directory": "allure-results",