SNOW-2681481 Split unit and integration test infrastructure (#1276)

Author: sfc-gh-mgemra

Snowflake.Data.Tests/IntegrationTests/FileUploadDownloadLargeFilesIT.cs

@@ -5,9 +5,8 @@
 using Snowflake.Data.Client;
 using Snowflake.Data.Tests.Util;
 
-namespace Snowflake.Data.Tests
+namespace Snowflake.Data.Tests.IntegrationTests
 {
-
     [TestFixture]
     public class FileUploadDownloadLargeFilesIT : SFBaseTest
     {

Snowflake.Data.Tests/IntegrationTests/IntegrationTestSetup.cs

@@ -0,0 +1,78 @@
+using System;
+using System.Data;
+using NUnit.Framework;
+using Snowflake.Data.Client;
+
+namespace Snowflake.Data.Tests.IntegrationTests
+{
+    [SetUpFixture]
+    public class IntegrationTestSetup
+    {
+        [OneTimeSetUp]
+        public void SetupIntegrationTests()
+        {
+            var testConfig = TestEnvironment.TestConfig;
+            ModifySchema(testConfig.schema, SchemaAction.Create);
+        }
+
+        [OneTimeTearDown]
+        public void CleanupIntegrationTests()
+        {
+            var testConfig = TestEnvironment.TestConfig;
+
+            if (testConfig == null)
+                return;
+
+            ModifySchema(testConfig.schema, SchemaAction.Drop);
+        }
+
+        private enum SchemaAction
+        {
+            Create,
+            Drop
+        }
+
+        private static void ModifySchema(string schemaName, SchemaAction schemaAction)
+        {
+            var testConfig = TestEnvironment.TestConfig;
+
+            using (IDbConnection conn = new SnowflakeDbConnection())
+            {
+                conn.ConnectionString = BuildConnectionString(testConfig);
+                conn.Open();
+                var dbCommand = conn.CreateCommand();
+
+                switch (schemaAction)
+                {
+                    case SchemaAction.Create:
+                        dbCommand.CommandText = $"CREATE OR REPLACE SCHEMA {schemaName}";
+                        break;
+                    case SchemaAction.Drop:
+                        dbCommand.CommandText = $"DROP SCHEMA IF EXISTS {schemaName}";
+                        break;
+                    default:
+                        Assert.Fail($"Not supported action on schema: {schemaAction}");
+                        break;
+                }
+
+                try
+                {
+                    dbCommand.ExecuteNonQuery();
+                }
+                catch (InvalidOperationException e)
+                {
+                    Assert.Fail($"Unable to {schemaAction.ToString().ToLower()} schema {schemaName}:\n{e.StackTrace}");
+                }
+            }
+        }
+
+        private static string BuildConnectionString(TestConfig config)
+        {
+            return $"scheme={config.protocol};host={config.host};port={config.port};" +
+                   $"certRevocationCheckMode=enabled;account={config.account};role={config.role};" +
+                   $"db={config.database};warehouse={config.warehouse};" +
+                   $"user={config.user};password={config.password};";
+        }
+    }
+}
+

Snowflake.Data.Tests/SFBaseTest.cs

@@ -8,7 +8,6 @@
 using System.Runtime.InteropServices;
 using NUnit.Framework;
 using Snowflake.Data.Client;
-using Snowflake.Data.Core.Tools;
 using Snowflake.Data.Log;
 using Snowflake.Data.Tests.Util;
 
@@ -22,9 +21,37 @@ namespace Snowflake.Data.Tests
     using Newtonsoft.Json.Serialization;
 
     /*
-     * This is the base class for all tests that call blocking methods in the library - it uses MockSynchronizationContext to verify that
+     * Base infrastructure shared by all test classes - provides common test utilities
+     */
+    public class BaseTestInfrastructure
+    {
+        protected virtual string TestName => TestContext.CurrentContext.Test.MethodName;
+        protected string TestNameWithWorker => TestName + TestContext.CurrentContext.WorkerId?.Replace("#", "_");
+    }
+
+    /*
+     * Base class for unit tests - it uses MockSynchronizationContext to verify that
+     * there are no async deadlocks in the library
+     */
+    [TestFixture]
+    public class UnitTestBase : BaseTestInfrastructure
+    {
+        [SetUp]
+        public static void SetUpMockContext()
+        {
+            MockSynchronizationContext.SetupContext();
+        }
+
+        [TearDown]
+        public static void TearDownMockContext()
+        {
+            MockSynchronizationContext.Verify();
+        }
+    }
+
+    /*
+     * Base class for integration tests that call blocking methods in the library - it uses MockSynchronizationContext to verify that
      * there are no async deadlocks in the library
-     *
      */
     [TestFixture]
     public class SFBaseTest : SFBaseTestAsync
@@ -43,8 +70,7 @@ public static void TearDownContext()
     }
 
     /*
-     * This is the base class for all tests that call async methods in the library - it does not use a special SynchronizationContext
-     *
+     * Base class for integration tests that call async methods - provides database connection infrastructure
      */
     [TestFixture]
     [FixtureLifeCycle(LifeCycle.InstancePerTestCase)]
@@ -276,7 +302,6 @@ public void Setup()
             Assert.IsTrue(cloud == null || cloud == "AWS" || cloud == "AZURE" || cloud == "GCP", "{0} is not supported. Specify AWS, AZURE or GCP as cloud environment", cloud);
 
             TestConfig = ReadTestConfig();
-            ModifySchema(TestConfig.schema, SchemaAction.CREATE);
         }
 
         private static TestConfig ReadTestConfig()
@@ -361,12 +386,6 @@ internal static TestConfig ReadTestConfigFile(string fileName)
             }
         }
 
-        [OneTimeTearDown]
-        public void Cleanup()
-        {
-            ModifySchema(TestConfig.schema, SchemaAction.DROP);
-        }
-
         [OneTimeSetUp]
         public void SetupTestPerformance()
         {
@@ -390,56 +409,6 @@ public void CreateTestTimeArtifact()
             File.WriteAllText($"..{separator}..{separator}..{separator}{GetOs()}_{dotnetVersion}_{cloudEnv}_performance.csv", resultText);
         }
 
-        private const string ConnectionStringFmt = "scheme={0};host={1};port={2};certRevocationCheckMode=enabled;" +
-                                                   "account={3};role={4};db={5};warehouse={6};user={7};password={8};";
-
-        private static string s_connectionString => string.Format(ConnectionStringFmt,
-            TestConfig.protocol,
-            TestConfig.host,
-            TestConfig.port,
-            TestConfig.account,
-            TestConfig.role,
-            TestConfig.database,
-            TestConfig.warehouse,
-            TestConfig.user,
-            TestConfig.password);
-
-        private enum SchemaAction
-        {
-            CREATE,
-            DROP
-        }
-
-        private static void ModifySchema(string schemaName, SchemaAction schemaAction)
-        {
-            using (IDbConnection conn = new SnowflakeDbConnection())
-            {
-                conn.ConnectionString = s_connectionString;
-                conn.Open();
-                var dbCommand = conn.CreateCommand();
-                switch (schemaAction)
-                {
-                    case SchemaAction.CREATE:
-                        dbCommand.CommandText = $"CREATE OR REPLACE SCHEMA {schemaName}";
-                        break;
-                    case SchemaAction.DROP:
-                        dbCommand.CommandText = $"DROP SCHEMA IF EXISTS {schemaName}";
-                        break;
-                    default:
-                        Assert.Fail($"Not supported action on schema: {schemaAction}");
-                        break;
-                }
-                try
-                {
-                    dbCommand.ExecuteNonQuery();
-                }
-                catch (InvalidOperationException e)
-                {
-                    Assert.Fail($"Unable to {schemaAction.ToString().ToLower()} schema {schemaName}:\n{e.StackTrace}");
-                }
-            }
-        }
-
         private static string GetOs()
         {
             if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))

Snowflake.Data.Tests/UnitTests/SFAzureClientTest.cs

@@ -18,7 +18,7 @@ namespace Snowflake.Data.Tests.UnitTests
     using Azure.Storage.Blobs.Models;
 
     [TestFixture, NonParallelizable]
-    class SFAzureClientTest : SFBaseTest
+    class SFAzureClientTest : UnitTestBase
     {
         // Mock data for file metadata
         const string EndPoint = "blob.core.windows.net";
@@ -56,7 +56,7 @@ class SFAzureClientTest : SFBaseTest
         SFFileMetadata _fileMetadata;
 
         [SetUp]
-        public new void BeforeTest()
+        public void BeforeTest()
         {
             t_downloadFileName = TestNameWithWorker + "_mockFileName.txt";
 

Snowflake.Data.Tests/UnitTests/SFFileTransferAgentTests.cs

@@ -15,7 +15,7 @@ namespace Snowflake.Data.Tests.UnitTests
     using System;
 
     [TestFixture]
-    class SFFileTransferAgentTest : SFBaseTest
+    class SFFileTransferAgentTest : UnitTestBase
     {
         // Mock data for file metadata
         [ThreadStatic] private static string t_locationStage;

Snowflake.Data.Tests/UnitTests/SFGCSClientTest.cs

@@ -16,7 +16,7 @@
 namespace Snowflake.Data.Tests.UnitTests
 {
     [TestFixture, NonParallelizable]
-    class SFGCSClientTest : SFBaseTest
+    class SFGCSClientTest : UnitTestBase
     {
         // Mock data for file metadata
         const string LocationStage = "mock-customer-stage";
@@ -50,7 +50,7 @@ class SFGCSClientTest : SFBaseTest
         SFFileMetadata _fileMetadata;
 
         [SetUp]
-        public new void BeforeTest()
+        public void BeforeTest()
         {
             t_downloadFileName = TestNameWithWorker + "_mockFileName.txt";
 

Snowflake.Data.Tests/UnitTests/SFRemoteStorageClientTest.cs

@@ -15,7 +15,7 @@ namespace Snowflake.Data.Tests.UnitTests
     using Moq;
 
     [TestFixture]
-    class SFRemoteStorageClientTest : SFBaseTest
+    class SFRemoteStorageClientTest : UnitTestBase
     {
         // Mock data for file metadata
         const string EndPoint = "mockEndPoint.com";
@@ -67,7 +67,7 @@ class SFRemoteStorageClientTest : SFBaseTest
         const bool IsAsync = true;
 
         [SetUp]
-        public new void BeforeTest()
+        public void BeforeTest()
         {
             t_realSourceFilePath = TestNameWithWorker + "_realSrcFilePath.txt";
             t_downloadFileName = TestNameWithWorker + "_mockFileName.txt";
@@ -117,7 +117,7 @@ class SFRemoteStorageClientTest : SFBaseTest
         }
 
         [TearDown]
-        public new void AfterTest()
+        public void AfterTest()
         {
             // Delete temporary files from upload
             if (File.Exists(_fileMetadata.realSrcFilePath))

Snowflake.Data.Tests/UnitTests/SFS3ClientTest.cs

@@ -16,7 +16,7 @@
 namespace Snowflake.Data.Tests.UnitTests
 {
     [TestFixture, NonParallelizable]
-    class SFS3ClientTest : SFBaseTest
+    class SFS3ClientTest : UnitTestBase
     {
         // Mock data for file metadata
         const string Endpoint = "[www.mockEndPoint.com]";
@@ -72,7 +72,7 @@ class SFS3ClientTest : SFBaseTest
         AmazonS3Config _clientConfig;
 
         [SetUp]
-        public new void BeforeTest()
+        public void BeforeTest()
         {
             t_downloadFileName = TestNameWithWorker + "_mockFileName.txt";