SNOW-1902246 Feature flag for experimental authentication (#1172)

Author: sfc-gh-knozderko

Snowflake.Data.Tests/UnitTests/Configuration/ClientFeatureFlagsTest.cs

@@ -0,0 +1,50 @@
+using System;
+using NUnit.Framework;
+using Moq;
+using Snowflake.Data.Configuration;
+using Snowflake.Data.Core.Tools;
+
+namespace Snowflake.Data.Tests.UnitTests.Configuration
+{
+    [TestFixture]
+    public class ClientFeatureFlagsTest
+    {
+        [Test]
+        [TestCase(ClientFeatureFlags.EnabledExperimentalAuthenticationVariableName, "true", true)]
+        [TestCase(ClientFeatureFlags.EnabledExperimentalAuthenticationVariableName, "TRUE", true)]
+        [TestCase(ClientFeatureFlags.EnabledExperimentalAuthenticationVariableName, "false", false)]
+        [TestCase(ClientFeatureFlags.EnabledExperimentalAuthenticationVariableName, "", false)]
+        [TestCase(ClientFeatureFlags.EnabledExperimentalAuthenticationVariableName, null, false)]
+        [TestCase(ClientFeatureFlags.EnabledExperimentalAuthenticationVariableName, "not a bool value", false)]
+        [TestCase("OTHER_VARIABLE_NAME", "true", false)]
+        public void TestEnabledExperimentalAuthentication(string variableName, string variableValue, bool expectedValue) {
+            // arrange
+            var environmentOperations = new Mock<EnvironmentOperations>();
+            environmentOperations
+                .Setup(e => e.GetEnvironmentVariable(variableName))
+                .Returns(variableValue);
+
+            // act
+            var clientFeatures = new ClientFeatureFlags(environmentOperations.Object);
+
+            // assert
+            Assert.AreEqual(expectedValue, clientFeatures.IsEnabledExperimentalAuthentication);
+        }
+
+        [Test]
+        public void TestDisabledExperimentalAuthenticationWhenCouldNotReadEnvVariable()
+        {
+            // arrange
+            var environmentOperations = new Mock<EnvironmentOperations>();
+            environmentOperations
+                .Setup(e => e.GetEnvironmentVariable(ClientFeatureFlags.EnabledExperimentalAuthenticationVariableName))
+                .Throws(() => new Exception("Could not read environmental variable"));
+
+            // act
+            var clientFeatures = new ClientFeatureFlags(environmentOperations.Object);
+
+            // assert
+            Assert.IsFalse(clientFeatures.IsEnabledExperimentalAuthentication);
+        }
+    }
+}

Snowflake.Data/Configuration/ClientFeatureFlags.cs

@@ -0,0 +1,43 @@
+using System;
+using Snowflake.Data.Core.Tools;
+using Snowflake.Data.Log;
+
+namespace Snowflake.Data.Configuration
+{
+    internal class ClientFeatureFlags
+    {
+        private static readonly SFLogger s_logger = SFLoggerFactory.GetLogger<ClientFeatureFlags>();
+        public bool IsEnabledExperimentalAuthentication { get; set; }
+
+        public static readonly ClientFeatureFlags Instance = new ClientFeatureFlags(EnvironmentOperations.Instance);
+
+        internal const string EnabledExperimentalAuthenticationVariableName = "SF_ENABLE_EXPERIMENTAL_AUTHENTICATION";
+        private const bool EnabledExperimentalAuthenticationDefaultValue = false;
+
+        internal ClientFeatureFlags(EnvironmentOperations environmentOperations)
+        {
+            IsEnabledExperimentalAuthentication = ReadEnabledExperimentalAuthentication(environmentOperations);
+        }
+
+        private bool ReadEnabledExperimentalAuthentication(EnvironmentOperations environmentOperations)
+        {
+            try
+            {
+                var isEnabledString = environmentOperations.GetEnvironmentVariable(EnabledExperimentalAuthenticationVariableName);
+                if (string.IsNullOrEmpty(isEnabledString))
+                {
+                    s_logger.Debug($"Variable '{EnabledExperimentalAuthenticationVariableName}' not set. Using the default value: {EnabledExperimentalAuthenticationDefaultValue}");
+                    return EnabledExperimentalAuthenticationDefaultValue;
+                }
+                var isEnabled = bool.Parse(isEnabledString);
+                s_logger.Debug($"Variable '{EnabledExperimentalAuthenticationVariableName}' was read as: {isEnabled}");
+                return isEnabled;
+            }
+            catch (Exception exception)
+            {
+                s_logger.Error($"Could not get or parse '{EnabledExperimentalAuthenticationVariableName}' variable. Used the default value: {EnabledExperimentalAuthenticationDefaultValue}.", exception);
+                return EnabledExperimentalAuthenticationDefaultValue;
+            }
+        }
+    }
+}