Merge pull request #12 from Chris-Wolfgang/develop

Develop Issue #7

Author: Chris-Wolfgang

ConsoleAppTemplate/ConsoleAppTemplate/AppSettings.Development.json

@@ -0,0 +1,12 @@
+// TODO If you are using UseMultiEnvironment then you can delete this file
+
+{
+    // TODO : Add your connection strings here
+    "ConnectionStrings": {
+
+    },
+    // TODO : Add your app settings here creating multiple sections as necessary
+    "SampleConfiguration": {
+        "CommandTimeout": 1000
+    }
+}

ConsoleAppTemplate/ConsoleAppTemplate/AppSettings.Production.json

@@ -0,0 +1,12 @@
+// TODO If you are using UseMultiEnvironment then you can delete this file
+
+{
+    // TODO : Add your connection strings here
+    "ConnectionStrings": {
+
+    },
+    // TODO : Add your app settings here creating multiple sections as necessary
+    "SampleConfiguration": {
+        "CommandTimeout": 2000
+    }
+}

ConsoleAppTemplate/ConsoleAppTemplate/AppSettings.json

@@ -0,0 +1,11 @@
+// TODO If you are using UseMultiEnvironment then you can delete this file
+{
+    // TODO : Add your connection strings here
+    "ConnectionStrings": {
+
+    },
+    // TODO : Add your app settings here creating multiple sections as necessary
+    "SampleConfiguration": {
+        "CommandTimeout": 100
+    }
+}

ConsoleAppTemplate/ConsoleAppTemplate/ConsoleAppTemplate.csproj

@@ -13,4 +13,16 @@
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.4" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Update="AppSettings.Development.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="AppSettings.Production.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="AppSettings.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+
 </Project>

ConsoleAppTemplate/ConsoleAppTemplate/Framework/IHostBuilderExtensions.cs

@@ -0,0 +1,86 @@
+using ConsoleAppTemplate.Model;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
+
+namespace ConsoleAppTemplate.Framework
+{
+    internal static class IHostBuilderExtensions
+    {
+        public static IHostBuilder UseSingleEnvironment(this IHostBuilder builder)
+        {
+            var config = new SingleEnvironmentConfiguration
+            {
+                BasePath = ConfigurationPath.Combine(AppContext.BaseDirectory),
+                ConfigFile = new ConfigurationFile
+                {
+                    Name = "AppSettings.json",
+                    Optional = false,
+                    ReloadOnChange = true
+                }
+            };
+
+            return UseSingleEnvironment(builder, config);
+        }
+
+
+
+        public static IHostBuilder UseSingleEnvironment(this IHostBuilder builder, SingleEnvironmentConfiguration config)
+         {
+            builder
+                .ConfigureAppConfiguration((context, configurationBuilder) =>
+                {
+                    configurationBuilder
+                        .SetBasePath(config.BasePath)
+                        .AddJsonFile(config.ConfigFile.Name, optional: config.ConfigFile.Optional,
+                            reloadOnChange: config.ConfigFile.ReloadOnChange)
+                        .AddEnvironmentVariables();
+                });
+
+            return builder;
+        }
+
+
+
+        public static IHostBuilder UseMultiEnvironment(this IHostBuilder builder)
+        {
+            var environment = Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");
+            if (string.IsNullOrWhiteSpace(environment))
+            {
+                Environment.FailFast("System variable DOTNET_ENVIRONMENT is not set.");
+            }
+
+            var config = new MultiEnvironmentConfiguration
+            {
+                BasePath = ConfigurationPath.Combine(AppContext.BaseDirectory),
+                ConfigFile = new ConfigurationFile
+                {
+                    Name = $"AppSettings.{environment}.json",
+                    Optional = false,
+                    ReloadOnChange = true
+                }
+            };
+
+            return UseMultiEnvironment(builder, config);
+        }
+
+
+
+        public static IHostBuilder UseMultiEnvironment(this IHostBuilder builder, MultiEnvironmentConfiguration config)
+        {
+            builder
+                .ConfigureAppConfiguration((context, configurationBuilder) =>
+                {
+                    configurationBuilder
+                        .SetBasePath(config.BasePath)
+                        .AddJsonFile(config.ConfigFile.Name, optional: config.ConfigFile.Optional,
+                            reloadOnChange: config.ConfigFile.ReloadOnChange)
+                        .AddEnvironmentVariables();
+                });
+
+            return builder;
+        }
+
+
+
+    }
+}

ConsoleAppTemplate/ConsoleAppTemplate/Model/ConfigurationFile.cs

@@ -0,0 +1,9 @@
+namespace ConsoleAppTemplate.Model;
+
+internal record ConfigurationFile
+{
+    public required string Name { get; init; }
+    public bool Optional { get; init; }
+    public bool ReloadOnChange { get; init; }
+
+}

ConsoleAppTemplate/ConsoleAppTemplate/Model/MultiEnvironmentConfiguration.cs

@@ -0,0 +1,8 @@
+namespace ConsoleAppTemplate.Model;
+
+internal record MultiEnvironmentConfiguration
+{
+    public required string BasePath { get; init; }
+
+    public required ConfigurationFile ConfigFile { get; init; }
+}

ConsoleAppTemplate/ConsoleAppTemplate/Model/SampleConfiguration.cs

@@ -0,0 +1,8 @@
+namespace ConsoleAppTemplate.Model;
+
+internal record SampleConfiguration
+{
+    public int CommandTimeout { get; set; }
+
+
+}

ConsoleAppTemplate/ConsoleAppTemplate/Model/SingleEnvironmentConfiguration.cs

@@ -0,0 +1,8 @@
+namespace ConsoleAppTemplate.Model;
+
+internal record SingleEnvironmentConfiguration
+{
+    public required string BasePath { get; init; }
+
+    public required ConfigurationFile ConfigFile { get; init; }
+}

ConsoleAppTemplate/ConsoleAppTemplate/Program.cs

@@ -1,5 +1,8 @@
 using ConsoleAppTemplate.Command;
+using ConsoleAppTemplate.Framework;
+using ConsoleAppTemplate.Model;
 using McMaster.Extensions.CommandLineUtils;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 
@@ -29,20 +32,34 @@ internal class Program
         private static async Task<int> Main(string[] args)
         {
             return await new HostBuilder()
+                // TODO Uncomment this line to use a single environment configuration file
+                //.UseSingleEnvironment()
+                // TODO Uncomment this line to use a multienvironment configuration file
+                .UseMultiEnvironment()
+
                 .ConfigureServices((context, collection) =>
                 {
                     collection.AddSingleton<IReporter, ConsoleReporter>();
+                    collection.AddSingleton<SampleConfiguration>(provider =>
+                    {
+                        // Get the configuration from the host builder
+                        var config = provider.GetService<IConfiguration>();
+                        
+                        // Load SampleConfiguration section from the config file
+                        var sc =  config.GetSection("SampleConfiguration").Get<SampleConfiguration>();
+                         return sc;
+                    });
                 })
                 .RunCommandLineApplicationAsync<Program>(args);
         }
 
 
-
         /// <summary>
         /// This method is called if the user does not specify a sub command
         /// </summary>
         /// <param name="application"></param>
         /// <param name="reporter"></param>
+        /// <param name="sampleConfiguration"></param>
         /// <returns>0 on success or any positive number for failure</returns>
         /// <remarks>
         /// - If you are not using sub commands you can rewrite this method to meet your needs
@@ -53,9 +70,13 @@ private static async Task<int> Main(string[] args)
         internal int OnExecute
         (
             CommandLineApplication<Program> application,
-            IReporter reporter
+            IReporter reporter,
+            SampleConfiguration sampleConfiguration
         )
         {
+            
+            reporter.Output($"\nCommandTimeout from config file: {sampleConfiguration.CommandTimeout}\n\n");
+
             // TODO if you are using not using sub commands then you can remove the lines below and replace with your own code
             application.ShowHelp();
             return ExitCode.Success;
@@ -65,6 +86,7 @@ IReporter reporter
             // TODO Add your code here
             reporter.Warn("Your code here");
 
+
             // TODO Return 0 for success and any positive number for failure
             return ExitCode.Success;
         }