Replace EnvironmentName with Environments #7733 (#7899)

Tratcher · web-flow · commit ff79e9bda510 · 2019-02-25T08:13:48.000-08:00
diff --git a/src/Hosting/Abstractions/src/EnvironmentName.cs b/src/Hosting/Abstractions/src/EnvironmentName.cs
@@ -6,10 +6,11 @@ namespace Microsoft.AspNetCore.Hosting
     /// <summary>
     /// Commonly used environment names.
     /// </summary>
+    [System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.Extensions.Hosting.Environments.", error: false)]
     public static class EnvironmentName
     {
         public static readonly string Development = "Development";
         public static readonly string Staging = "Staging";
         public static readonly string Production = "Production";
     }
-}
+}
diff --git a/src/Hosting/Hosting/src/Internal/HostingEnvironment.cs b/src/Hosting/Hosting/src/Internal/HostingEnvironment.cs
@@ -9,7 +9,7 @@ namespace Microsoft.AspNetCore.Hosting.Internal
     public class HostingEnvironment : IHostingEnvironment, Extensions.Hosting.IHostingEnvironment, IWebHostEnvironment
 #pragma warning restore CS0618 // Type or member is obsolete
     {
-        public string EnvironmentName { get; set; } = Hosting.EnvironmentName.Production;
+        public string EnvironmentName { get; set; } = Extensions.Hosting.Environments.Production;
 
         public string ApplicationName { get; set; }
 
diff --git a/src/Hosting/Hosting/test/StartupManagerTests.cs b/src/Hosting/Hosting/test/StartupManagerTests.cs
@@ -11,6 +11,7 @@
 using Microsoft.AspNetCore.Hosting.Tests.Internal;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Options;
 using Xunit;
 
@@ -510,7 +511,7 @@ public void CustomProviderFactoryCallsConfigureContainer()
             serviceCollection.AddSingleton<IServiceProviderFactory<MyContainer>, MyContainerFactory>();
             var services = serviceCollection.BuildServiceProvider();
 
-            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartup), EnvironmentName.Development);
+            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartup), Environments.Development);
 
             var app = new ApplicationBuilder(services);
             app.ApplicationServices = startup.ConfigureServicesDelegate(serviceCollection);
@@ -526,7 +527,7 @@ public void CustomServiceProviderFactoryStartupBaseClassCallsConfigureContainer(
             serviceCollection.AddSingleton<IServiceProviderFactory<MyContainer>, MyContainerFactory>();
             var services = serviceCollection.BuildServiceProvider();
 
-            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartupBaseClass), EnvironmentName.Development);
+            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartupBaseClass), Environments.Development);
 
             var app = new ApplicationBuilder(services);
             app.ApplicationServices = startup.ConfigureServicesDelegate(serviceCollection);
@@ -542,13 +543,13 @@ public void CustomServiceProviderFactoryEnvironmentBasedConfigureContainer()
             serviceCollection.AddSingleton<IServiceProviderFactory<MyContainer>, MyContainerFactory>();
             var services = serviceCollection.BuildServiceProvider();
 
-            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartupEnvironmentBased), EnvironmentName.Production);
+            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartupEnvironmentBased), Environments.Production);
 
             var app = new ApplicationBuilder(services);
             app.ApplicationServices = startup.ConfigureServicesDelegate(serviceCollection);
 
             Assert.IsType<MyContainer>(app.ApplicationServices);
-            Assert.Equal(((MyContainer)app.ApplicationServices).Environment, EnvironmentName.Production);
+            Assert.Equal(((MyContainer)app.ApplicationServices).Environment, Environments.Production);
         }
 
         [Fact]
@@ -557,7 +558,7 @@ public void CustomServiceProviderFactoryThrowsIfNotRegisteredWithConfigureContai
             var serviceCollection = new ServiceCollection();
             var services = serviceCollection.BuildServiceProvider();
 
-            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartup), EnvironmentName.Development);
+            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartup), Environments.Development);
 
             Assert.Throws<InvalidOperationException>(() => startup.ConfigureServicesDelegate(serviceCollection));
         }
@@ -568,7 +569,7 @@ public void CustomServiceProviderFactoryThrowsIfNotRegisteredWithConfigureContai
             var serviceCollection = new ServiceCollection();
             var services = serviceCollection.BuildServiceProvider();
 
-            Assert.Throws<InvalidOperationException>(() => StartupLoader.LoadMethods(services, typeof(MyContainerStartupBaseClass), EnvironmentName.Development));
+            Assert.Throws<InvalidOperationException>(() => StartupLoader.LoadMethods(services, typeof(MyContainerStartupBaseClass), Environments.Development));
         }
 
         [Fact]
@@ -578,7 +579,7 @@ public void CustomServiceProviderFactoryFailsWithOverloadsInStartup()
             serviceCollection.AddSingleton<IServiceProviderFactory<MyContainer>, MyContainerFactory>();
             var services = serviceCollection.BuildServiceProvider();
 
-            Assert.Throws<InvalidOperationException>(() => StartupLoader.LoadMethods(services, typeof(MyContainerStartupWithOverloads), EnvironmentName.Development));
+            Assert.Throws<InvalidOperationException>(() => StartupLoader.LoadMethods(services, typeof(MyContainerStartupWithOverloads), Environments.Development));
         }
 
         [Fact]
@@ -588,7 +589,7 @@ public void BadServiceProviderFactoryFailsThatReturnsNullServiceProviderOverridd
             serviceCollection.AddSingleton<IServiceProviderFactory<MyContainer>, MyBadContainerFactory>();
             var services = serviceCollection.BuildServiceProvider();
 
-            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartup), EnvironmentName.Development);
+            var startup = StartupLoader.LoadMethods(services, typeof(MyContainerStartup), Environments.Development);
 
             var app = new ApplicationBuilder(services);
             app.ApplicationServices = startup.ConfigureServicesDelegate(serviceCollection);
@@ -629,12 +630,12 @@ public void ConfigureServices(IServiceCollection services)
 
             public void ConfigureDevelopmentContainer(MyContainer container)
             {
-                container.Environment = EnvironmentName.Development;
+                container.Environment = Environments.Development;
             }
 
             public void ConfigureProductionContainer(MyContainer container)
             {
-                container.Environment = EnvironmentName.Production;
+                container.Environment = Environments.Production;
             }
 
             public void Configure(IApplicationBuilder app)
diff --git a/src/Hosting/Hosting/test/WebHostConfigurationsTests.cs b/src/Hosting/Hosting/test/WebHostConfigurationsTests.cs
@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using Microsoft.AspNetCore.Hosting.Internal;
 using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
 using Xunit;
 
 namespace Microsoft.AspNetCore.Hosting.Tests
@@ -18,7 +19,7 @@ public void ReadsParametersCorrectly()
                 { WebHostDefaults.WebRootKey, "wwwroot"},
                 { WebHostDefaults.ApplicationKey, "MyProjectReference"},
                 { WebHostDefaults.StartupAssemblyKey, "MyProjectReference" },
-                { WebHostDefaults.EnvironmentKey, EnvironmentName.Development},
+                { WebHostDefaults.EnvironmentKey, Environments.Development},
                 { WebHostDefaults.DetailedErrorsKey, "true"},
                 { WebHostDefaults.CaptureStartupErrorsKey, "true" },
                 { WebHostDefaults.SuppressStatusMessagesKey, "true" }
@@ -29,7 +30,7 @@ public void ReadsParametersCorrectly()
             Assert.Equal("wwwroot", config.WebRoot);
             Assert.Equal("MyProjectReference", config.ApplicationName);
             Assert.Equal("MyProjectReference", config.StartupAssembly);
-            Assert.Equal(EnvironmentName.Development, config.Environment);
+            Assert.Equal(Environments.Development, config.Environment);
             Assert.True(config.CaptureStartupErrors);
             Assert.True(config.DetailedErrors);
             Assert.True(config.SuppressStatusMessages);
@@ -38,10 +39,10 @@ public void ReadsParametersCorrectly()
         [Fact]
         public void ReadsOldEnvKey()
         {
-            var parameters = new Dictionary<string, string>() { { "ENVIRONMENT", EnvironmentName.Development } };
+            var parameters = new Dictionary<string, string>() { { "ENVIRONMENT", Environments.Development } };
             var config = new WebHostOptions(new ConfigurationBuilder().AddInMemoryCollection(parameters).Build());
 
-            Assert.Equal(EnvironmentName.Development, config.Environment);
+            Assert.Equal(Environments.Development, config.Environment);
         }
 
         [Theory]
diff --git a/src/Hosting/Hosting/test/WebHostTests.cs b/src/Hosting/Hosting/test/WebHostTests.cs
@@ -812,8 +812,8 @@ public void EnvDefaultsToProductionIfNoConfig()
 #pragma warning disable CS0618 // Type or member is obsolete
                 var env2 = host.Services.GetService<AspNetCore.Hosting.IHostingEnvironment>();
 #pragma warning restore CS0618 // Type or member is obsolete
-                Assert.Equal(EnvironmentName.Production, env.EnvironmentName);
-                Assert.Equal(EnvironmentName.Production, env2.EnvironmentName);
+                Assert.Equal(Environments.Production, env.EnvironmentName);
+                Assert.Equal(Environments.Production, env2.EnvironmentName);
             }
         }
 
@@ -822,7 +822,7 @@ public void EnvDefaultsToConfigValueIfSpecified()
         {
             var vals = new Dictionary<string, string>
             {
-                { "Environment", EnvironmentName.Staging }
+                { "Environment", Environments.Staging }
             };
 
             var builder = new ConfigurationBuilder()
@@ -835,8 +835,8 @@ public void EnvDefaultsToConfigValueIfSpecified()
 #pragma warning disable CS0618 // Type or member is obsolete
                 var env2 = host.Services.GetService<AspNetCore.Hosting.IHostingEnvironment>();
 #pragma warning restore CS0618 // Type or member is obsolete
-                Assert.Equal(EnvironmentName.Staging, env.EnvironmentName);
-                Assert.Equal(EnvironmentName.Staging, env.EnvironmentName);
+                Assert.Equal(Environments.Staging, env.EnvironmentName);
+                Assert.Equal(Environments.Staging, env.EnvironmentName);
             }
         }
 
@@ -873,7 +873,7 @@ public async Task IsEnvironment_Extension_Is_Case_Insensitive()
             {
                 await host.StartAsync();
                 var env = host.Services.GetRequiredService<IHostEnvironment>();
-                Assert.True(env.IsEnvironment(EnvironmentName.Production));
+                Assert.True(env.IsEnvironment(Environments.Production));
                 Assert.True(env.IsEnvironment("producTion"));
             }
         }
diff --git a/src/Hosting/samples/SampleStartups/StartupFullControl.cs b/src/Hosting/samples/SampleStartups/StartupFullControl.cs
@@ -4,6 +4,7 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 
 // Note that this sample will not run. It is only here to illustrate usage patterns.
@@ -25,7 +26,7 @@ public static void Main(string[] args)
                 .UseKestrel()
                 .UseContentRoot(Directory.GetCurrentDirectory()) // Override the content root with the current directory
                 .UseUrls("http://*:1000", "https://*:902")
-                .UseEnvironment(EnvironmentName.Development)
+                .UseEnvironment(Environments.Development)
                 .UseWebRoot("public")
                 .ConfigureServices(services =>
                 {
diff --git a/src/Mvc/Mvc.Testing/src/WebApplicationFactory.cs b/src/Mvc/Mvc.Testing/src/WebApplicationFactory.cs
@@ -13,7 +13,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyModel;
 using Microsoft.Extensions.Hosting;
-using EnvironmentName = Microsoft.Extensions.Hosting.EnvironmentName;
 
 namespace Microsoft.AspNetCore.Mvc.Testing
 {
@@ -307,7 +306,7 @@ protected virtual IHostBuilder CreateHostBuilder()
             var hostBuilder = HostFactoryResolver.ResolveHostBuilderFactory<IHostBuilder>(typeof(TEntryPoint).Assembly)?.Invoke(Array.Empty<string>());
             if (hostBuilder != null)
             {
-                hostBuilder.UseEnvironment(EnvironmentName.Development);
+                hostBuilder.UseEnvironment(Environments.Development);
             }
             return hostBuilder;
         }
@@ -336,7 +335,7 @@ protected virtual IWebHostBuilder CreateWebHostBuilder()
             }
             else
             {
-                return builder.UseEnvironment(EnvironmentName.Development);
+                return builder.UseEnvironment(Environments.Development);
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,11 @@ namespace Microsoft.AspNetCore.Hosting`
`6`	`6`	`/// <summary>`
`7`	`7`	`/// Commonly used environment names.`
`8`	`8`	`/// </summary>`
	`9`	`+ [System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.Extensions.Hosting.Environments.", error: false)]`
`9`	`10`	`public static class EnvironmentName`
`10`	`11`	`{`
`11`	`12`	`public static readonly string Development = "Development";`
`12`	`13`	`public static readonly string Staging = "Staging";`
`13`	`14`	`public static readonly string Production = "Production";`
`14`	`15`	`}`
`15`		`-}`
	`16`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ namespace Microsoft.AspNetCore.Hosting.Internal`
`9`	`9`	`public class HostingEnvironment : IHostingEnvironment, Extensions.Hosting.IHostingEnvironment, IWebHostEnvironment`
`10`	`10`	`#pragma warning restore CS0618 // Type or member is obsolete`
`11`	`11`	`{`
`12`		`- public string EnvironmentName { get; set; } = Hosting.EnvironmentName.Production;`
	`12`	`+ public string EnvironmentName { get; set; } = Extensions.Hosting.Environments.Production;`
`13`	`13`
`14`	`14`	`public string ApplicationName { get; set; }`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -812,8 +812,8 @@ public void EnvDefaultsToProductionIfNoConfig()`
`812`	`812`	`#pragma warning disable CS0618 // Type or member is obsolete`
`813`	`813`	`var env2 = host.Services.GetService<AspNetCore.Hosting.IHostingEnvironment>();`
`814`	`814`	`#pragma warning restore CS0618 // Type or member is obsolete`
`815`		`- Assert.Equal(EnvironmentName.Production, env.EnvironmentName);`
`816`		`- Assert.Equal(EnvironmentName.Production, env2.EnvironmentName);`
	`815`	`+ Assert.Equal(Environments.Production, env.EnvironmentName);`
	`816`	`+ Assert.Equal(Environments.Production, env2.EnvironmentName);`
`817`	`817`	`}`
`818`	`818`	`}`
`819`	`819`
`@@ -822,7 +822,7 @@ public void EnvDefaultsToConfigValueIfSpecified()`
`822`	`822`	`{`
`823`	`823`	`var vals = new Dictionary<string, string>`
`824`	`824`	`{`
`825`		`- { "Environment", EnvironmentName.Staging }`
	`825`	`+ { "Environment", Environments.Staging }`
`826`	`826`	`};`
`827`	`827`
`828`	`828`	`var builder = new ConfigurationBuilder()`
`@@ -835,8 +835,8 @@ public void EnvDefaultsToConfigValueIfSpecified()`
`835`	`835`	`#pragma warning disable CS0618 // Type or member is obsolete`
`836`	`836`	`var env2 = host.Services.GetService<AspNetCore.Hosting.IHostingEnvironment>();`
`837`	`837`	`#pragma warning restore CS0618 // Type or member is obsolete`
`838`		`- Assert.Equal(EnvironmentName.Staging, env.EnvironmentName);`
`839`		`- Assert.Equal(EnvironmentName.Staging, env.EnvironmentName);`
	`838`	`+ Assert.Equal(Environments.Staging, env.EnvironmentName);`
	`839`	`+ Assert.Equal(Environments.Staging, env.EnvironmentName);`
`840`	`840`	`}`
`841`	`841`	`}`
`842`	`842`
`@@ -873,7 +873,7 @@ public async Task IsEnvironment_Extension_Is_Case_Insensitive()`
`873`	`873`	`{`
`874`	`874`	`await host.StartAsync();`
`875`	`875`	`var env = host.Services.GetRequiredService<IHostEnvironment>();`
`876`		`- Assert.True(env.IsEnvironment(EnvironmentName.Production));`
	`876`	`+ Assert.True(env.IsEnvironment(Environments.Production));`
`877`	`877`	`Assert.True(env.IsEnvironment("producTion"));`
`878`	`878`	`}`
`879`	`879`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,6 @@`
`13`	`13`	`using Microsoft.Extensions.DependencyInjection;`
`14`	`14`	`using Microsoft.Extensions.DependencyModel;`
`15`	`15`	`using Microsoft.Extensions.Hosting;`
`16`		`-using EnvironmentName = Microsoft.Extensions.Hosting.EnvironmentName;`
`17`	`16`
`18`	`17`	`namespace Microsoft.AspNetCore.Mvc.Testing`
`19`	`18`	`{`
`@@ -307,7 +306,7 @@ protected virtual IHostBuilder CreateHostBuilder()`
`307`	`306`	`var hostBuilder = HostFactoryResolver.ResolveHostBuilderFactory<IHostBuilder>(typeof(TEntryPoint).Assembly)?.Invoke(Array.Empty<string>());`
`308`	`307`	`if (hostBuilder != null)`
`309`	`308`	`{`
`310`		`- hostBuilder.UseEnvironment(EnvironmentName.Development);`
	`309`	`+ hostBuilder.UseEnvironment(Environments.Development);`
`311`	`310`	`}`
`312`	`311`	`return hostBuilder;`
`313`	`312`	`}`
`@@ -336,7 +335,7 @@ protected virtual IWebHostBuilder CreateWebHostBuilder()`
`336`	`335`	`}`
`337`	`336`	`else`
`338`	`337`	`{`
`339`		`- return builder.UseEnvironment(EnvironmentName.Development);`
	`338`	`+ return builder.UseEnvironment(Environments.Development);`
`340`	`339`	`}`
`341`	`340`	`}`
`342`	`341`