Improved test configuration performance (#135 #168)

Author: ivaylokenov

src/MyTested.AspNetCore.Mvc.Abstractions/Internal/Application/TestApplication.cs

@@ -48,7 +48,8 @@ public static class TestApplication
         private static bool initialiazed;
 
         private static string testAssemblyName;
-        private static TestConfiguration testConfiguration;
+        private static IConfigurationBuilder configurationBuilder;
+        private static TestConfiguration configuration;
 
         private static IHostingEnvironment environment;
 
@@ -72,8 +73,7 @@ static TestApplication()
 #if NET451
             FindTestAssembly();
 #endif
-
-            PrepareTestConfiguration();
+            
             FindTestAssemblyName();
         }
 
@@ -115,7 +115,7 @@ internal static Type StartupType
 
             set
             {
-                if (startupType != null && TestConfiguration.General.AsynchronousTests)
+                if (startupType != null && Configuration().General().AsynchronousTests())
                 {
                     throw new InvalidOperationException("Multiple Startup types per test project while running asynchronous tests is not supported. Either set 'General.AsynchronousTests' in the 'testconfig.json' file to 'false' or separate your tests into different test projects. The latter is recommended. If you choose the first option, you may need to disable asynchronous testing in your preferred test runner too.");
                 }
@@ -163,31 +163,38 @@ internal static IHostingEnvironment Environment
             }
         }
 
-        public static TestConfiguration TestConfiguration
+        internal static string ApplicationName =>
+            Configuration().General().ApplicationName()
+                ?? TestAssembly?.GetName().Name
+                ?? StartupAssemblyName
+                ?? PlatformServices.Default.Application.ApplicationName;
+        
+        public static TestConfiguration Configuration()
         {
-            get
+            if (configuration == null || AdditionalConfiguration != null)
             {
-                if (testConfiguration == null || AdditionalConfiguration != null)
+                if (configurationBuilder == null)
                 {
-                    testConfiguration = TestConfiguration.With(PrepareTestConfiguration());
-                    PrepareLicensing();
+                    configurationBuilder = new ConfigurationBuilder()
+                        .AddJsonFile("testconfig.json", optional: true);
                 }
 
-                return testConfiguration;
+                AdditionalConfiguration?.Invoke(configurationBuilder);
+                AdditionalConfiguration = null;
+
+                configuration = TestConfiguration.With(configurationBuilder.Build());
+
+                PrepareLicensing();
             }
-        }
 
-        internal static string ApplicationName =>
-            TestConfiguration.General.ApplicationName
-                ?? TestAssembly?.GetName().Name
-                ?? StartupAssemblyName
-                ?? PlatformServices.Default.Application.ApplicationName;
+            return configuration;
+        }
 
         public static void TryInitialize()
         {
             lock (Sync)
             {
-                if (!initialiazed && TestConfiguration.General.AutomaticStartup)
+                if (!initialiazed && Configuration().General().AutomaticStartup())
                 {
                     var defaultStartupType = TryFindDefaultStartupType();
 
@@ -267,7 +274,7 @@ internal static Type TryFindDefaultStartupType()
         {
             var applicationAssembly = TestAssembly ?? Assembly.Load(new AssemblyName(testAssemblyName));
 
-            var defaultStartupType = TestConfiguration.General.StartupType ?? $"{Environment.EnvironmentName}Startup";
+            var defaultStartupType = Configuration().General().StartupType() ?? $"{Environment.EnvironmentName}Startup";
 
             // check root of the test project
             var startup =
@@ -292,21 +299,10 @@ private static void Initialize()
 
             initialiazed = true;
         }
-
-        private static IConfiguration PrepareTestConfiguration()
-        {
-            var configurationBuilder = new ConfigurationBuilder()
-                .AddJsonFile("testconfig.json", optional: true);
-
-            AdditionalConfiguration?.Invoke(configurationBuilder);
-            AdditionalConfiguration = null;
-
-            return configurationBuilder.Build();
-        }
-
+        
         private static void FindTestAssemblyName()
         {
-            testAssemblyName = TestConfiguration.General.TestAssemblyName
+            testAssemblyName = Configuration().General().TestAssemblyName()
                 ?? TestAssembly?.GetName().Name
                 ?? DependencyContext
                     .Default
@@ -318,7 +314,7 @@ private static void FindTestAssemblyName()
         private static void PrepareLicensing()
         {
             TestCounter.SetLicenseData(
-                TestConfiguration.Licenses,
+                Configuration().Licenses(),
                 DateTime.ParseExact(ReleaseDate, "yyyy-MM-dd", CultureInfo.InvariantCulture),
                 TestAssembly?.GetName().Name ?? StartupAssemblyName);
         }
@@ -328,7 +324,7 @@ private static IHostingEnvironment PrepareEnvironment()
             return new HostingEnvironment
             {
                 ApplicationName = ApplicationName,
-                EnvironmentName = TestConfiguration.General.EnvironmentName,
+                EnvironmentName = Configuration().General().EnvironmentName(),
                 ContentRootPath = PlatformServices.Default.Application.ApplicationBasePath
             };
         }
@@ -515,6 +511,8 @@ private static void TryLockedInitialization()
         private static void Reset()
         {
             initialiazed = false;
+            configurationBuilder = null;
+            configuration = null;
             environment = null;
             startupType = null;
             serviceProvider = null;
@@ -531,29 +529,29 @@ private static void Reset()
             RoutingServiceRegistrationPlugins.Clear();
             InitializationPlugins.Clear();
             LicenseValidator.ClearLicenseDetails();
-    }
+        }
 
 #if NET451
-    private static void FindTestAssembly()
-    {
-        var executingAssembly = Assembly.GetExecutingAssembly();
-
-        var stackTrace = new StackTrace(false);
-
-        foreach (var frame in stackTrace.GetFrames())
+        private static void FindTestAssembly()
         {
-            var method = frame.GetMethod();
-            var methodAssembly = method?.DeclaringType?.Assembly;
+            var executingAssembly = Assembly.GetExecutingAssembly();
+
+            var stackTrace = new StackTrace(false);
 
-            if (methodAssembly != null
-                && methodAssembly != executingAssembly
-                && !methodAssembly.FullName.StartsWith(TestFrameworkName))
+            foreach (var frame in stackTrace.GetFrames())
             {
-                TestAssembly = methodAssembly;
-                return;
+                var method = frame.GetMethod();
+                var methodAssembly = method?.DeclaringType?.Assembly;
+
+                if (methodAssembly != null
+                    && methodAssembly != executingAssembly
+                    && !methodAssembly.FullName.StartsWith(TestFrameworkName))
+                {
+                    TestAssembly = methodAssembly;
+                    return;
+                }
             }
         }
-    }
 #endif
-}
+    }
 }

src/MyTested.AspNetCore.Mvc.Configuration/Internal/Configuration/BaseConfiguration.cs

@@ -12,7 +12,7 @@ public BaseConfiguration(IConfiguration configuration)
             this.Configuration = configuration;
         }
 
-        protected IConfiguration Configuration
+        public IConfiguration Configuration
         {
             get
             {

src/MyTested.AspNetCore.Mvc.Configuration/Internal/Configuration/GeneralTestConfiguration.cs

@@ -18,18 +18,18 @@ public GeneralTestConfiguration(IConfiguration configuration)
             this.Prefix = "General";
         }
 
-        public bool AsynchronousTests => this.GetValue(AsynchronousTestsConfigKey, true);
+        public bool AsynchronousTests() => this.GetValue(AsynchronousTestsConfigKey, true);
 
-        public string WebAssemblyName => this.GetValue(WebAssemblyNameConfigKey);
+        public string WebAssemblyName() => this.GetValue(WebAssemblyNameConfigKey);
 
-        public string TestAssemblyName => this.GetValue(TestAssemblyNameConfigKey);
+        public string TestAssemblyName() => this.GetValue(TestAssemblyNameConfigKey);
 
-        public bool AutomaticStartup => this.GetValue(AutomaticStartupConfigKey, true);
+        public bool AutomaticStartup() => this.GetValue(AutomaticStartupConfigKey, true);
 
-        public string StartupType => this.GetValue(StartupTypeConfigKey);
+        public string StartupType() => this.GetValue(StartupTypeConfigKey);
 
-        public string ApplicationName => this.GetValue(ApplicationNameConfigKey);
+        public string ApplicationName() => this.GetValue(ApplicationNameConfigKey);
 
-        public string EnvironmentName => this.GetValue(EnvironmentNameConfigKey, "Test");
+        public string EnvironmentName() => this.GetValue(EnvironmentNameConfigKey, "Test");
     }
 }

src/MyTested.AspNetCore.Mvc.Configuration/Internal/Configuration/TestConfiguration.cs

@@ -1,38 +1,48 @@
 namespace MyTested.AspNetCore.Mvc.Internal.Configuration
 {
+    using System;
     using System.Collections.Generic;
     using Microsoft.Extensions.Configuration;
 
     public class TestConfiguration : BaseConfiguration
     {
         private const string LicenseConfigKey = "License";
         private const string LicensesConfigKey = "Licenses";
-        
+
+        private readonly IDictionary<Type, BaseConfiguration> configurationTypes;
+
         private TestConfiguration(IConfiguration configuration)
             : base(configuration)
         {
-            this.General = new GeneralTestConfiguration(this.Configuration);
-            this.Controllers = new ControllersTestConfiguration(this.Configuration);
+            this.configurationTypes = new Dictionary<Type, BaseConfiguration>();
         }
+
+        public GeneralTestConfiguration General()
+            => this.GetConfiguration(() => new GeneralTestConfiguration(this.Configuration));
 
-        public GeneralTestConfiguration General { get; private set; }
+        public IEnumerable<string> Licenses()
+        {
+            var license = this.Configuration[LicenseConfigKey];
+            if (license != null)
+            {
+                return new[] { license };
+            }
 
-        public ControllersTestConfiguration Controllers { get; private set; }
+            var licenses = new List<string>();
+            this.Configuration.GetSection(LicensesConfigKey).Bind(licenses);
+            return licenses;
+        }
 
-        public IEnumerable<string> Licenses
+        public TConfiguration GetConfiguration<TConfiguration>(Func<TConfiguration> configurationFactory)
+            where TConfiguration : BaseConfiguration
         {
-            get
+            var typeOfConfiguration = typeof(TConfiguration);
+            if (!this.configurationTypes.ContainsKey(typeOfConfiguration))
             {
-                var license = this.Configuration[LicenseConfigKey];
-                if (license != null)
-                {
-                    return new[] { license };
-                }
-
-                var licenses = new List<string>();
-                this.Configuration.GetSection(LicensesConfigKey).Bind(licenses);
-                return licenses;
+                this.configurationTypes[typeOfConfiguration] = configurationFactory();
             }
+
+            return (TConfiguration)this.configurationTypes[typeOfConfiguration];
         }
 
         public static TestConfiguration With(IConfiguration configuration)

src/MyTested.AspNetCore.Mvc.Controllers/Builders/Controllers/ControllerBuilder.cs

@@ -3,6 +3,7 @@
     using Components;
     using Contracts.Controllers;
     using Internal.Application;
+    using Internal.Configuration;
     using Internal.Contracts;
     using Internal.TestContexts;
     using Microsoft.AspNetCore.Mvc.Controllers;
@@ -24,7 +25,10 @@ public partial class ControllerBuilder<TController> : BaseComponentBuilder<TCont
         public ControllerBuilder(ControllerTestContext testContext)
             : base(testContext)
         {
-            this.EnabledModelStateValidation = TestApplication.TestConfiguration.Controllers.ModelStateValidation;
+            this.EnabledModelStateValidation = TestApplication
+                .Configuration()
+                .Controllers()
+                .ModelStateValidation();
         }
 
         public bool EnabledModelStateValidation { get; set; }

src/MyTested.AspNetCore.Mvc.Configuration/Internal/Configuration/ControllersTestConfiguration.cs renamed to src/MyTested.AspNetCore.Mvc.Controllers/Internal/Configuration/ControllersTestConfiguration.cs

@@ -12,6 +12,6 @@ public ControllersTestConfiguration(IConfiguration configuration)
             this.Prefix = "Controllers";
         }
 
-        public bool ModelStateValidation => this.GetValue(ModelStateValidationConfigKey, true);
+        public bool ModelStateValidation() => this.GetValue(ModelStateValidationConfigKey, true);
     }
 }

src/MyTested.AspNetCore.Mvc.Controllers/Internal/Configuration/TestConfigurationControllersExtensions.cs

@@ -0,0 +1,8 @@
+namespace MyTested.AspNetCore.Mvc.Internal.Configuration
+{
+    public static class TestConfigurationControllersExtensions
+    {
+        public static ControllersTestConfiguration Controllers(this TestConfiguration testConfiguration)
+            => testConfiguration.GetConfiguration(() => new ControllersTestConfiguration(testConfiguration.Configuration));
+    }
+}