Replace usages of Assembly.CodeBase with Assembly.Location (#22258)

pranavkm · web-flow · commit dc29f03548b5 · 2020-05-27T12:01:34.000-07:00
Fixes #14827
diff --git a/src/Hosting/Hosting/src/StaticWebAssets/StaticWebAssetsLoader.cs b/src/Hosting/Hosting/src/StaticWebAssets/StaticWebAssetsLoader.cs
@@ -1,12 +1,11 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-using System;
+#nullable enable
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Reflection;
-using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.FileProviders;
 
@@ -26,12 +25,10 @@ public class StaticWebAssetsLoader
         /// <param name="configuration">The host <see cref="IConfiguration"/>.</param>
         public static void UseStaticWebAssets(IWebHostEnvironment environment, IConfiguration configuration)
         {
-            using (var manifest = ResolveManifest(environment, configuration))
+            using var manifest = ResolveManifest(environment, configuration);
+            if (manifest != null)
             {
-                if (manifest != null)
-                {
-                    UseStaticWebAssetsCore(environment, manifest);
-                }
+                UseStaticWebAssetsCore(environment, manifest);
             }
         }
 
@@ -56,14 +53,14 @@ internal static void UseStaticWebAssetsCore(IWebHostEnvironment environment, Str
             }
         }
 
-        internal static Stream ResolveManifest(IWebHostEnvironment environment, IConfiguration configuration)
+        internal static Stream? ResolveManifest(IWebHostEnvironment environment, IConfiguration configuration)
         {
             try
             {
                 var manifestPath = configuration.GetValue<string>(WebHostDefaults.StaticWebAssetsKey);
                 var filePath = manifestPath ?? ResolveRelativeToAssembly(environment);
-                
-                if (File.Exists(filePath))
+
+                if (filePath != null && File.Exists(filePath))
                 {
                     return File.OpenRead(filePath);
                 }
@@ -81,21 +78,16 @@ internal static Stream ResolveManifest(IWebHostEnvironment environment, IConfigu
             }
         }
 
-        private static string ResolveRelativeToAssembly(IWebHostEnvironment environment)
+        private static string? ResolveRelativeToAssembly(IWebHostEnvironment environment)
         {
             var assembly = Assembly.Load(environment.ApplicationName);
-            return Path.Combine(Path.GetDirectoryName(GetAssemblyLocation(assembly)), $"{environment.ApplicationName}.StaticWebAssets.xml");
-        }
-
-        internal static string GetAssemblyLocation(Assembly assembly)
-        {
-            if (Uri.TryCreate(assembly.CodeBase, UriKind.Absolute, out var result) &&
-                result.IsFile && string.IsNullOrWhiteSpace(result.Fragment))
+            if (string.IsNullOrEmpty(assembly.Location))
             {
-                return result.LocalPath;
+                return null;
             }
 
-            return assembly.Location;
+            return Path.Combine(Path.GetDirectoryName(assembly.Location)!, $"{environment.ApplicationName}.StaticWebAssets.xml");
         }
     }
 }
+#nullable restore
diff --git a/src/Hosting/Hosting/test/StaticWebAssets/StaticWebAssetsFileProviderTests.cs b/src/Hosting/Hosting/test/StaticWebAssets/StaticWebAssetsFileProviderTests.cs
@@ -153,7 +153,7 @@ public void GetFileInfo_DoesNotMatch_IncompletePrefixSegments()
             var expectedResult = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
             var provider = new StaticWebAssetsFileProvider(
                 "_cont",
-                Path.GetDirectoryName(new Uri(typeof(StaticWebAssetsFileProviderTests).Assembly.CodeBase).LocalPath));
+                Path.GetDirectoryName(typeof(StaticWebAssetsFileProviderTests).Assembly.Location));
 
             // Act
             var file = provider.GetFileInfo("/_content/Microsoft.AspNetCore.TestHost.StaticWebAssets.xml");
@@ -169,7 +169,7 @@ public void GetFileInfo_Prefix_RespectsOsCaseSensitivity()
             var expectedResult = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
             var provider = new StaticWebAssetsFileProvider(
                 "_content",
-                Path.GetDirectoryName(new Uri(typeof(StaticWebAssetsFileProviderTests).Assembly.CodeBase).LocalPath));
+                Path.GetDirectoryName(typeof(StaticWebAssetsFileProviderTests).Assembly.Location));
 
             // Act
             var file = provider.GetFileInfo("/_CONTENT/Microsoft.AspNetCore.Hosting.StaticWebAssets.xml");
@@ -185,7 +185,7 @@ public void GetDirectoryContents_Prefix_RespectsOsCaseSensitivity()
             var expectedResult = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
             var provider = new StaticWebAssetsFileProvider(
                 "_content",
-                Path.GetDirectoryName(new Uri(typeof(StaticWebAssetsFileProviderTests).Assembly.CodeBase).LocalPath));
+                Path.GetDirectoryName(typeof(StaticWebAssetsFileProviderTests).Assembly.Location));
 
             // Act
             var directory = provider.GetDirectoryContents("/_CONTENT");
diff --git a/src/Hosting/Hosting/test/StaticWebAssets/StaticWebAssetsLoaderTests.cs b/src/Hosting/Hosting/test/StaticWebAssets/StaticWebAssetsLoaderTests.cs
@@ -89,7 +89,7 @@ public void ResolveManifest_UsesConfigurationKey_WhenProvided()
   <ContentRoot Path=""/Path"" BasePath=""/BasePath"" />
 </StaticWebAssets>
 ";
-            var path = Path.ChangeExtension(new Uri(typeof(StaticWebAssetsLoader).Assembly.CodeBase).LocalPath, ".StaticWebAssets.xml");
+            var path = Path.ChangeExtension(typeof(StaticWebAssetsLoader).Assembly.Location, ".StaticWebAssets.xml");
             var environment = new HostingEnvironment()
             {
                 ApplicationName = "NonExistingDll"
diff --git a/src/Identity/test/Identity.FunctionalTests/Infrastructure/ServerFactory.cs b/src/Identity/test/Identity.FunctionalTests/Infrastructure/ServerFactory.cs
@@ -66,7 +66,7 @@ private void UpdateApplicationParts(IWebHostBuilder builder) =>
 
         private void UpdateStaticAssets(IWebHostBuilder builder)
         {
-            var manifestPath = Path.GetDirectoryName(new Uri(typeof(ServerFactory<,>).Assembly.CodeBase).LocalPath);
+            var manifestPath = Path.GetDirectoryName(typeof(ServerFactory<,>).Assembly.Location);
             builder.ConfigureAppConfiguration((ctx, cb) =>
             {
                 if (ctx.HostingEnvironment.WebRootFileProvider is CompositeFileProvider composite)
diff --git a/src/Mvc/Mvc.Core/src/ApplicationParts/RelatedAssemblyAttribute.cs b/src/Mvc/Mvc.Core/src/ApplicationParts/RelatedAssemblyAttribute.cs
@@ -66,7 +66,7 @@ internal static IReadOnlyList<Assembly> GetRelatedAssemblies(
 
             // MVC will specifically look for related parts in the same physical directory as the assembly.
             // No-op if the assembly does not have a location.
-            if (assembly.IsDynamic || string.IsNullOrEmpty(assembly.CodeBase))
+            if (assembly.IsDynamic || string.IsNullOrEmpty(assembly.Location))
             {
                 return Array.Empty<Assembly>();
             }
@@ -78,7 +78,7 @@ internal static IReadOnlyList<Assembly> GetRelatedAssemblies(
             }
 
             var assemblyName = assembly.GetName().Name;
-            var assemblyLocation = GetAssemblyLocation(assembly);
+            var assemblyLocation = assembly.Location;
             var assemblyDirectory = Path.GetDirectoryName(assemblyLocation);
 
             var relatedAssemblies = new List<Assembly>();
@@ -112,16 +112,5 @@ internal static IReadOnlyList<Assembly> GetRelatedAssemblies(
 
             return relatedAssemblies;
         }
-
-        internal static string GetAssemblyLocation(Assembly assembly)
-        {
-            if (Uri.TryCreate(assembly.CodeBase, UriKind.Absolute, out var result) && 
-                result.IsFile && string.IsNullOrWhiteSpace(result.Fragment))
-            {
-                return result.LocalPath;
-            }
-
-            return assembly.Location;
-        }
     }
 }
diff --git a/src/Mvc/Mvc.Core/test/ApplicationParts/RelatedAssemblyPartTest.cs b/src/Mvc/Mvc.Core/test/ApplicationParts/RelatedAssemblyPartTest.cs
@@ -75,88 +75,6 @@ public void GetRelatedAssemblies_LoadsRelatedAssembly()
             Assert.Equal(new[] { relatedAssembly }, result);
         }
 
-        [Fact]
-        public void GetAssemblyLocation_UsesCodeBase()
-        {
-            // Arrange
-            var destination = Path.Combine(AssemblyDirectory, "RelatedAssembly.dll");
-            var codeBase = "file://x:/file/Assembly.dll";
-            var expected = new Uri(codeBase).LocalPath;
-            var assembly = new TestAssembly
-            {
-                CodeBaseSettable = codeBase,
-            };
-
-            // Act
-            var actual = RelatedAssemblyAttribute.GetAssemblyLocation(assembly);
-            Assert.Equal(expected, actual);
-        }
-
-        [Fact]
-        public void GetAssemblyLocation_UsesLocation_IfCodeBaseIsNotLocal()
-        {
-            // Arrange
-            var destination = Path.Combine(AssemblyDirectory, "RelatedAssembly.dll");
-            var expected = Path.Combine(AssemblyDirectory, "Some-Dir", "Assembly.dll");
-            var assembly = new TestAssembly
-            {
-                CodeBaseSettable = "https://www.microsoft.com/test.dll",
-                LocationSettable = expected,
-            };
-
-            // Act
-            var actual = RelatedAssemblyAttribute.GetAssemblyLocation(assembly);
-            Assert.Equal(expected, actual);
-        }
-
-        [Fact]
-        public void GetAssemblyLocation_CodeBase_HasPoundCharacterUnixPath()
-        {
-            var destination = Path.Combine(AssemblyDirectory, "RelatedAssembly.dll");
-            var expected = @"/etc/#NIN/dotnetcore/tryx/try1.dll";
-            var assembly = new TestAssembly
-            {
-                CodeBaseSettable = "file:///etc/#NIN/dotnetcore/tryx/try1.dll",
-                LocationSettable = expected,
-            };
-
-            // Act
-            var actual = RelatedAssemblyAttribute.GetAssemblyLocation(assembly);
-            Assert.Equal(expected, actual);
-        }
-
-        [Fact]
-        public void GetAssemblyLocation_CodeBase_HasPoundCharacterUNCPath()
-        {
-            var destination = Path.Combine(AssemblyDirectory, "RelatedAssembly.dll");
-            var expected = @"\\server\#NIN\dotnetcore\tryx\try1.dll";
-            var assembly = new TestAssembly
-            {
-                CodeBaseSettable = "file://server/#NIN/dotnetcore/tryx/try1.dll",
-                LocationSettable = expected,
-            };
-
-            // Act
-            var actual = RelatedAssemblyAttribute.GetAssemblyLocation(assembly);
-            Assert.Equal(expected, actual);
-        }
-
-        [Fact]
-        public void GetAssemblyLocation_CodeBase_HasPoundCharacterDOSPath()
-        {
-            var destination = Path.Combine(AssemblyDirectory, "RelatedAssembly.dll");
-            var expected = @"C:\#NIN\dotnetcore\tryx\try1.dll";
-            var assembly = new TestAssembly
-            {
-                CodeBaseSettable = "file:///C:/#NIN/dotnetcore/tryx/try1.dll",
-                LocationSettable = expected,
-            };
-
-            // Act
-            var actual = RelatedAssemblyAttribute.GetAssemblyLocation(assembly);
-            Assert.Equal(expected, actual);
-        }
-
         private class TestAssembly : Assembly
         {
             public override AssemblyName GetName()
@@ -166,10 +84,6 @@ public override AssemblyName GetName()
 
             public string AttributeAssembly { get; set; }
 
-            public string CodeBaseSettable { get; set; } = Path.Combine(AssemblyDirectory, "MyAssembly.dll");
-
-            public override string CodeBase => CodeBaseSettable;
-
             public string LocationSettable { get; set; } = Path.Combine(AssemblyDirectory, "MyAssembly.dll");
 
             public override string Location => LocationSettable;
diff --git a/src/Servers/IIS/IIS/test/IIS.Tests/Utilities/TestServer.cs b/src/Servers/IIS/IIS/test/IIS.Tests/Utilities/TestServer.cs
@@ -30,7 +30,7 @@ public class TestServer: IDisposable, IStartup
         private const string HWebCoreDll = "hwebcore.dll";
 
         internal static string HostableWebCoreLocation => Environment.ExpandEnvironmentVariables($@"%windir%\system32\inetsrv\{HWebCoreDll}");
-        internal static string BasePath => Path.Combine(Path.GetDirectoryName(new Uri(typeof(TestServer).Assembly.CodeBase).AbsolutePath),
+        internal static string BasePath => Path.Combine(Path.GetDirectoryName(typeof(TestServer).Assembly.Location),
                                                         "ANCM",
                                                         Environment.Is64BitProcess ? "x64" : "x86");
 
@@ -45,7 +45,7 @@ public class TestServer: IDisposable, IStartup
         private readonly Action<IApplicationBuilder> _appBuilder;
         private readonly ILoggerFactory _loggerFactory;
         private readonly hostfxr_main_fn _hostfxrMainFn;
-        
+
         private Uri BaseUri => new Uri("http://localhost:" + _currentPort);
         public HttpClient HttpClient { get; private set; }
         public TestConnection CreateConnection() => new TestConnection(_currentPort);
@@ -88,7 +88,7 @@ private void Start()
         {
             LoadLibrary(HostableWebCoreLocation);
             _appHostConfigPath = Path.GetTempFileName();
-            
+
             set_main_handler(_hostfxrMainFn);
 
             Retry(() =>
@@ -159,7 +159,7 @@ public void Dispose()
 
             // WebCoreShutdown occasionally AVs
             // This causes the dotnet test process to crash
-            // To avoid this, we have to wait to shutdown 
+            // To avoid this, we have to wait to shutdown
             // and pass in true to immediately shutdown the hostable web core
             // Both of these seem to be required.
             Thread.Sleep(100);

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,11 @@`
`1`	`1`	`// Copyright (c) .NET Foundation. All rights reserved.`
`2`	`2`	`// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.`
`3`	`3`
`4`		`-using System;`
	`4`	`+#nullable enable`
`5`	`5`	`using System.Collections.Generic;`
`6`	`6`	`using System.IO;`
`7`	`7`	`using System.Linq;`
`8`	`8`	`using System.Reflection;`
`9`		`-using Microsoft.AspNetCore.Hosting;`
`10`	`9`	`using Microsoft.Extensions.Configuration;`
`11`	`10`	`using Microsoft.Extensions.FileProviders;`
`12`	`11`
`@@ -26,12 +25,10 @@ public class StaticWebAssetsLoader`
`26`	`25`	`/// <param name="configuration">The host <see cref="IConfiguration"/>.</param>`
`27`	`26`	`public static void UseStaticWebAssets(IWebHostEnvironment environment, IConfiguration configuration)`
`28`	`27`	`{`
`29`		`- using (var manifest = ResolveManifest(environment, configuration))`
	`28`	`+ using var manifest = ResolveManifest(environment, configuration);`
	`29`	`+ if (manifest != null)`
`30`	`30`	`{`
`31`		`- if (manifest != null)`
`32`		`- {`
`33`		`- UseStaticWebAssetsCore(environment, manifest);`
`34`		`- }`
	`31`	`+ UseStaticWebAssetsCore(environment, manifest);`
`35`	`32`	`}`
`36`	`33`	`}`
`37`	`34`
`@@ -56,14 +53,14 @@ internal static void UseStaticWebAssetsCore(IWebHostEnvironment environment, Str`
`56`	`53`	`}`
`57`	`54`	`}`
`58`	`55`
`59`		`- internal static Stream ResolveManifest(IWebHostEnvironment environment, IConfiguration configuration)`
	`56`	`+ internal static Stream? ResolveManifest(IWebHostEnvironment environment, IConfiguration configuration)`
`60`	`57`	`{`
`61`	`58`	`try`
`62`	`59`	`{`
`63`	`60`	`var manifestPath = configuration.GetValue<string>(WebHostDefaults.StaticWebAssetsKey);`
`64`	`61`	`var filePath = manifestPath ?? ResolveRelativeToAssembly(environment);`
`65`		`-`
`66`		`- if (File.Exists(filePath))`
	`62`	`+`
	`63`	`+ if (filePath != null && File.Exists(filePath))`
`67`	`64`	`{`
`68`	`65`	`return File.OpenRead(filePath);`
`69`	`66`	`}`
`@@ -81,21 +78,16 @@ internal static Stream ResolveManifest(IWebHostEnvironment environment, IConfigu`
`81`	`78`	`}`
`82`	`79`	`}`
`83`	`80`
`84`		`- private static string ResolveRelativeToAssembly(IWebHostEnvironment environment)`
	`81`	`+ private static string? ResolveRelativeToAssembly(IWebHostEnvironment environment)`
`85`	`82`	`{`
`86`	`83`	`var assembly = Assembly.Load(environment.ApplicationName);`
`87`		`- return Path.Combine(Path.GetDirectoryName(GetAssemblyLocation(assembly)), $"{environment.ApplicationName}.StaticWebAssets.xml");`
`88`		`- }`
`89`		`-`
`90`		`- internal static string GetAssemblyLocation(Assembly assembly)`
`91`		`- {`
`92`		`- if (Uri.TryCreate(assembly.CodeBase, UriKind.Absolute, out var result) &&`
`93`		`- result.IsFile && string.IsNullOrWhiteSpace(result.Fragment))`
	`84`	`+ if (string.IsNullOrEmpty(assembly.Location))`
`94`	`85`	`{`
`95`		`- return result.LocalPath;`
	`86`	`+ return null;`
`96`	`87`	`}`
`97`	`88`
`98`		`- return assembly.Location;`
	`89`	`+ return Path.Combine(Path.GetDirectoryName(assembly.Location)!, $"{environment.ApplicationName}.StaticWebAssets.xml");`
`99`	`90`	`}`
`100`	`91`	`}`
`101`	`92`	`}`
	`93`	`+#nullable restore`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ public void ResolveManifest_UsesConfigurationKey_WhenProvided()`
`89`	`89`	`<ContentRoot Path=""/Path"" BasePath=""/BasePath"" />`
`90`	`90`	`</StaticWebAssets>`
`91`	`91`	`";`
`92`		`- var path = Path.ChangeExtension(new Uri(typeof(StaticWebAssetsLoader).Assembly.CodeBase).LocalPath, ".StaticWebAssets.xml");`
	`92`	`+ var path = Path.ChangeExtension(typeof(StaticWebAssetsLoader).Assembly.Location, ".StaticWebAssets.xml");`
`93`	`93`	`var environment = new HostingEnvironment()`
`94`	`94`	`{`
`95`	`95`	`ApplicationName = "NonExistingDll"`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ private void UpdateApplicationParts(IWebHostBuilder builder) =>`
`66`	`66`
`67`	`67`	`private void UpdateStaticAssets(IWebHostBuilder builder)`
`68`	`68`	`{`
`69`		`- var manifestPath = Path.GetDirectoryName(new Uri(typeof(ServerFactory<,>).Assembly.CodeBase).LocalPath);`
	`69`	`+ var manifestPath = Path.GetDirectoryName(typeof(ServerFactory<,>).Assembly.Location);`
`70`	`70`	`builder.ConfigureAppConfiguration((ctx, cb) =>`
`71`	`71`	`{`
`72`	`72`	`if (ctx.HostingEnvironment.WebRootFileProvider is CompositeFileProvider composite)`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ internal static IReadOnlyList<Assembly> GetRelatedAssemblies(`
`66`	`66`
`67`	`67`	`// MVC will specifically look for related parts in the same physical directory as the assembly.`
`68`	`68`	`// No-op if the assembly does not have a location.`
`69`		`- if (assembly.IsDynamic \|\| string.IsNullOrEmpty(assembly.CodeBase))`
	`69`	`+ if (assembly.IsDynamic \|\| string.IsNullOrEmpty(assembly.Location))`
`70`	`70`	`{`
`71`	`71`	`return Array.Empty<Assembly>();`
`72`	`72`	`}`
`@@ -78,7 +78,7 @@ internal static IReadOnlyList<Assembly> GetRelatedAssemblies(`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`var assemblyName = assembly.GetName().Name;`
`81`		`- var assemblyLocation = GetAssemblyLocation(assembly);`
	`81`	`+ var assemblyLocation = assembly.Location;`
`82`	`82`	`var assemblyDirectory = Path.GetDirectoryName(assemblyLocation);`
`83`	`83`
`84`	`84`	`var relatedAssemblies = new List<Assembly>();`
`@@ -112,16 +112,5 @@ internal static IReadOnlyList<Assembly> GetRelatedAssemblies(`
`112`	`112`
`113`	`113`	`return relatedAssemblies;`
`114`	`114`	`}`
`115`		`-`
`116`		`- internal static string GetAssemblyLocation(Assembly assembly)`
`117`		`- {`
`118`		`- if (Uri.TryCreate(assembly.CodeBase, UriKind.Absolute, out var result) &&`
`119`		`- result.IsFile && string.IsNullOrWhiteSpace(result.Fragment))`
`120`		`- {`
`121`		`- return result.LocalPath;`
`122`		`- }`
`123`		`-`
`124`		`- return assembly.Location;`
`125`		`- }`
`126`	`115`	`}`
`127`	`116`	`}`