feat: Add user config to specify if servers should be run before tests. By default they will not be run.

Author: jlareo

.gitignore

@@ -339,3 +339,6 @@ ASALocalRun/
 # BeatPulse healthcheck temp database
 healthchecksdb
 *.snk
+
+# Ignore user config file
+/src/SocketIOClient.Test/user.json

src/SocketIOClient.Test/Configuration/UserConfig.cs

@@ -0,0 +1,8 @@
+namespace SocketIOClient.Test.Configuration
+{
+    public class UserConfig
+    {
+        public bool RunServers { get; set; } = false;
+        public bool StopServersAfterRun { get; set; } = false;
+    }
+}

src/SocketIOClient.Test/Configuration/UserConfigManager.cs

@@ -0,0 +1,21 @@
+using System.IO;
+
+namespace SocketIOClient.Test.Configuration
+{
+    public class UserConfigManager
+    {
+        private const string configFileName = "user.json";
+
+        public bool Exists =>  File.Exists(configFileName);
+
+        public UserConfig Get()
+        {
+            if (!this.Exists) 
+            {
+                return null;
+            }
+
+            return System.Text.Json.JsonSerializer.Deserialize<UserConfig>(File.ReadAllText(configFileName));
+        }
+    }
+}

src/SocketIOClient.Test/Configuration/user_sample.json

@@ -0,0 +1,5 @@
+// Rename "user_sample.json" to "user.json" and copy to output directory (comment must be removed)
+{
+  "RunServers": true,
+  "StopServersAfterRun": true
+}

src/SocketIOClient.Test/SocketIOClient.Test.csproj

@@ -28,6 +28,9 @@
     <None Update="Files\tianlongbabu.epub">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="user.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
 </Project>

src/SocketIOClient.Test/SocketIOTests/AssemblyIntegrationTest.cs

@@ -1,4 +1,5 @@
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using SocketIOClient.Test.Configuration;
 using SocketIOClient.Test.SocketIOTests.V4;
 using System;
 using System.Collections.Generic;
@@ -17,10 +18,14 @@ public class AssemblyIntegrationTest
             new ServerV4Manager()
         };
 
+        private static UserConfig UserConfig => new UserConfigManager().Get() ?? new UserConfig();
+
+        private static bool IsRunningOnAzureDevOps => Environment.GetEnvironmentVariable("SYSTEM_DEFINITIONID") != null;
+
         [AssemblyInitialize]
         public static void Initialize(TestContext context)
         {
-            if (!IsRunningOnAzureDevOps())
+            if (!IsRunningOnAzureDevOps && UserConfig.RunServers)
             {
                 foreach (var server in Servers)
                 {
@@ -35,18 +40,13 @@ public static void Initialize(TestContext context)
         [AssemblyCleanup]
         public static void Cleanup()
         {
-            if (!IsRunningOnAzureDevOps())
+            if (!IsRunningOnAzureDevOps && UserConfig.RunServers && UserConfig.StopServersAfterRun)
             {
                 foreach (var server in Servers)
                 {
                     server.Destroy();
                 }
             }
         }
-
-        private static bool IsRunningOnAzureDevOps()
-        {
-            return Environment.GetEnvironmentVariable("SYSTEM_DEFINITIONID") != null;
-        }
     }
 }