Move magic strings to constants. Logger now calls setExecutionEnvironment from powertoolsconfigurations. Update tests

Author: hjgraca

libraries/src/AWS.Lambda.Powertools.Common/Core/Constants.cs

@@ -80,4 +80,14 @@ internal static class Constants
     ///     Constant for LAMBDA_TASK_ROOT environment variable
     /// </summary>
     internal const string LambdaTaskRoot = "LAMBDA_TASK_ROOT";
+    
+    /// <summary>
+    ///     Constant for AWS_EXECUTION_ENV environment variable
+    /// </summary>
+    internal const string AwsExecutionEnvironmentVariableName = "AWS_EXECUTION_ENV";
+    
+    /// <summary>
+    ///     Constant for Powertools feature identifier fo AWS_EXECUTION_ENV environment variable
+    /// </summary>
+    internal const string FeatureContextIdentifier = "PT";
 }

libraries/src/AWS.Lambda.Powertools.Common/Core/IPowertoolsEnvironment.cs

@@ -1,36 +1,37 @@
 namespace AWS.Lambda.Powertools.Common;
 
 /// <summary>
-/// 
+/// Interface for PowertoolsEnvironment
 /// </summary>
 public interface IPowertoolsEnvironment
 {
     /// <summary>
-    /// 
+    /// Get environment variable by variable name
     /// </summary>
     /// <param name="variableName"></param>
-    /// <returns></returns>
+    /// <returns>Environment variable</returns>
     string GetEnvironmentVariable(string variableName);
+    
     /// <summary>
-    /// 
+    /// Set environment variable
     /// </summary>
     /// <param name="variableName"></param>
-    /// <param name="value"></param>
+    /// <param name="value">Setting this to null will remove environment variable with that name</param>
     void SetEnvironmentVariable(string variableName, string value);
 
     /// <summary>
-    /// 
+    /// Get the calling Type Assembly Name
     /// </summary>
     /// <param name="type"></param>
     /// <typeparam name="T"></typeparam>
-    /// <returns></returns>
+    /// <returns>Assembly Name</returns>
     string GetAssemblyName<T>(T type);
 
     /// <summary>
-    /// 
+    /// Get the calling Type Assembly Version
     /// </summary>
     /// <param name="type"></param>
     /// <typeparam name="T"></typeparam>
-    /// <returns></returns>
+    /// <returns>Assembly Version in the Major.Minor.Build format</returns>
     string GetAssemblyVersion<T>(T type);
 }

libraries/src/AWS.Lambda.Powertools.Common/Core/SystemWrapper.cs

@@ -93,7 +93,7 @@ public void SetEnvironmentVariable(string variable, string value)
     /// <inheritdoc />
     public void SetExecutionEnvironment<T>(T type)
     {
-        const string envName = "AWS_EXECUTION_ENV";
+        const string envName = Constants.AwsExecutionEnvironmentVariableName;
 
         var envValue = new StringBuilder();
 
@@ -122,12 +122,12 @@ private string ParseAssemblyName(string assemblyName)
         try
         {
             var parsedName = assemblyName.Substring(assemblyName.LastIndexOf(".", StringComparison.Ordinal)+1);
-            return $"PTFeature/{parsedName}";
+            return $"{Constants.FeatureContextIdentifier}/{parsedName}";
         }
         catch
         {
             //NOOP
         }
-        return $"PTFeature/{assemblyName}";
+        return $"{Constants.FeatureContextIdentifier}/{assemblyName}";
     }
 }

libraries/src/AWS.Lambda.Powertools.Logging/Internal/PowertoolsLogger.cs

@@ -77,7 +77,7 @@ public PowertoolsLogger(
         (_name, _powertoolsConfigurations, _systemWrapper, _getCurrentConfig) = (name,
             powertoolsConfigurations, systemWrapper, getCurrentConfig);
 
-        systemWrapper.SetExecutionEnvironment(this);
+        _powertoolsConfigurations.SetExecutionEnvironment(this);
     }
 
     /// <summary>

libraries/tests/AWS.Lambda.Powertools.Common.Tests/Core/PowertoolsEnvironmentTest.cs

@@ -16,7 +16,7 @@ public void Set_Execution_Environment()
         systemWrapper.SetExecutionEnvironment(this);
 
         // Assert
-        Assert.Equal("PTFeature/Fake/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
+        Assert.Equal($"{Constants.FeatureContextIdentifier}/Fake/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
     }
 
     [Fact]
@@ -31,7 +31,7 @@ public void Set_Execution_Environment_WhenEnvironmentHasValue()
         systemWrapper.SetExecutionEnvironment(this);
 
         // Assert
-        Assert.Equal("ExistingValuesInUserAgent PTFeature/Fake/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
+        Assert.Equal($"ExistingValuesInUserAgent {Constants.FeatureContextIdentifier}/Fake/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
     }
 
     [Fact]
@@ -45,7 +45,7 @@ public void Set_Multiple_Execution_Environment()
         systemWrapper.SetExecutionEnvironment(this);
 
         // Assert
-        Assert.Equal("PTFeature/Fake/1.0.0 PTFeature/Fake/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
+        Assert.Equal($"{Constants.FeatureContextIdentifier}/Fake/1.0.0 {Constants.FeatureContextIdentifier}/Fake/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
     }
 
     [Fact]
@@ -58,7 +58,7 @@ public void Set_Execution_Real_Environment()
         systemWrapper.SetExecutionEnvironment(this);
 
         // Assert
-        Assert.Equal("PTFeature/Tests/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
+        Assert.Equal($"{Constants.FeatureContextIdentifier}/Tests/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
     }
 
     [Fact]
@@ -72,7 +72,7 @@ public void Set_Execution_Real_Environment_Multiple()
         systemWrapper.SetExecutionEnvironment(this);
 
         // Assert
-        Assert.Equal("PTFeature/Tests/1.0.0 PTFeature/Tests/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
+        Assert.Equal($"{Constants.FeatureContextIdentifier}/Tests/1.0.0 {Constants.FeatureContextIdentifier}/Tests/1.0.0", systemWrapper.GetEnvironmentVariable("AWS_EXECUTION_ENV"));
     }
 
     public void Dispose()

libraries/tests/AWS.Lambda.Powertools.Logging.Tests/PowertoolsLoggerTest.cs

@@ -1229,15 +1229,16 @@ public void Log_Set_Execution_Environment_Context()
             var assemblyName = "AWS.Lambda.Powertools.Logger";
             var assemblyVersion = "1.0.0";
 
-            var configurations = new Mock<IPowertoolsConfigurations>();
-
             var env = new Mock<IPowertoolsEnvironment>();
             env.Setup(x => x.GetAssemblyName(It.IsAny<PowertoolsLogger>())).Returns(assemblyName);
             env.Setup(x => x.GetAssemblyVersion(It.IsAny<PowertoolsLogger>())).Returns(assemblyVersion);
 
-            var systemWrapper = new SystemWrapper(env.Object);
+            // Act
+            
+            var wrapper = new SystemWrapper(env.Object);
+            var conf = new PowertoolsConfigurations(wrapper);
 
-            var logger = new PowertoolsLogger(loggerName,configurations.Object, systemWrapper, () => 
+            var logger = new PowertoolsLogger(loggerName,conf, wrapper, () => 
                 new LoggerConfiguration
                 {
                     Service = null,
@@ -1248,7 +1249,7 @@ public void Log_Set_Execution_Environment_Context()
             // Assert
             env.Verify(v =>
                 v.SetEnvironmentVariable(
-                    "AWS_EXECUTION_ENV", $"PTFeature/Logger/{assemblyVersion}"
+                    "AWS_EXECUTION_ENV", $"{Constants.FeatureContextIdentifier}/Logger/{assemblyVersion}"
                 ), Times.Once);
 
             env.Verify(v =>

libraries/tests/AWS.Lambda.Powertools.Metrics.Tests/MetricsTests.cs

@@ -25,7 +25,7 @@ public void Metrics_Set_Execution_Environment_Context()
         // Assert
         env.Verify(v =>
             v.SetEnvironmentVariable(
-                "AWS_EXECUTION_ENV", $"PTFeature/Metrics/{assemblyVersion}"
+                "AWS_EXECUTION_ENV", $"{Constants.FeatureContextIdentifier}/Metrics/{assemblyVersion}"
             ), Times.Once);
 
         env.Verify(v =>

libraries/tests/AWS.Lambda.Powertools.Tracing.Tests/XRayRecorderTests.cs

@@ -30,7 +30,7 @@ public void Tracing_Set_Execution_Environment_Context()
         // Assert
         env.Verify(v =>
             v.SetEnvironmentVariable(
-                "AWS_EXECUTION_ENV", $"PTFeature/Tracing/{assemblyVersion}"
+                "AWS_EXECUTION_ENV", $"{Constants.FeatureContextIdentifier}/Tracing/{assemblyVersion}"
             ), Times.Once);
 
         env.Verify(v =>