Fix RuntimeConfigurationReader to support SelfContained builds (#1705)

pfeigl · web-flow · commit c2e6aeecb963 · 2024-11-18T19:30:52.000+01:00
diff --git a/coverlet.sln b/coverlet.sln
@@ -88,6 +88,8 @@ Project("{778DAE3C-4631-46EA-AA77-85C1314464D9}") = "coverlet.tests.projectsampl
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "coverlet.tests.utils", "test\coverlet.tests.utils\coverlet.tests.utils.csproj", "{0B109210-03CB-413F-888C-3023994AA384}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "coverlet.tests.projectsample.wpf8.selfcontained", "test\coverlet.tests.projectsample.wpf8.selfcontained\coverlet.tests.projectsample.wpf8.selfcontained.csproj", "{71004336-9896-4AE5-8367-B29BB1680542}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -190,6 +192,10 @@ Global
 		{0B109210-03CB-413F-888C-3023994AA384}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{0B109210-03CB-413F-888C-3023994AA384}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{0B109210-03CB-413F-888C-3023994AA384}.Release|Any CPU.Build.0 = Release|Any CPU
+		{71004336-9896-4AE5-8367-B29BB1680542}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{71004336-9896-4AE5-8367-B29BB1680542}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{71004336-9896-4AE5-8367-B29BB1680542}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{71004336-9896-4AE5-8367-B29BB1680542}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -220,6 +226,7 @@ Global
 		{351A034E-E642-4DB9-A21D-F71C8151C243} = {2FEBDE1B-83E3-445B-B9F8-5644B0E0E134}
 		{03400776-1F9A-4326-B927-1CA9B64B42A1} = {2FEBDE1B-83E3-445B-B9F8-5644B0E0E134}
 		{0B109210-03CB-413F-888C-3023994AA384} = {2FEBDE1B-83E3-445B-B9F8-5644B0E0E134}
+		{71004336-9896-4AE5-8367-B29BB1680542} = {2FEBDE1B-83E3-445B-B9F8-5644B0E0E134}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {9CA57C02-97B0-4C38-A027-EA61E8741F10}
diff --git a/src/coverlet.core/Instrumentation/CecilAssemblyResolver.cs b/src/coverlet.core/Instrumentation/CecilAssemblyResolver.cs
@@ -318,6 +318,11 @@ public RuntimeConfigurationReader(string runtimeConfigFile)
         return runtimeOptionsElement["frameworks"].Select(x => (x["name"]?.Value<string>(), x["version"]?.Value<string>())).ToList();
       }
 
+      if (runtimeOptionsElement?["includedFrameworks"] != null)
+      {
+        return runtimeOptionsElement["includedFrameworks"].Select(x => (x["name"]?.Value<string>(), x["version"]?.Value<string>())).ToList();
+      }
+
       throw new InvalidOperationException($"Unable to read runtime configuration from {_runtimeConfigFile}.");
     }
   }
diff --git a/test/coverlet.integration.tests/WpfResolverTests.cs b/test/coverlet.integration.tests/WpfResolverTests.cs
@@ -43,5 +43,33 @@ public void TestInstrument_NetCoreSharedFrameworkResolver()
           "sample assembly shall be resolved");
       Assert.NotEmpty(assemblies);
     }
+
+    [ConditionalFact]
+    [SkipOnOS(OS.Linux, "WPF only runs on Windows")]
+    [SkipOnOS(OS.MacOS, "WPF only runs on Windows")]
+    public void TestInstrument_NetCoreSharedFrameworkResolver_SelfContained()
+    {
+      string buildConfiguration = TestUtils.GetAssemblyBuildConfiguration().ToString().ToLowerInvariant();
+      string wpfProjectPath = TestUtils.GetTestProjectPath("coverlet.tests.projectsample.wpf8.selfcontained");
+      string testBinaryPath = Path.Combine(TestUtils.GetTestBinaryPath("coverlet.tests.projectsample.wpf8.selfcontained"), $"{buildConfiguration}_win-x64");
+      Assert.True(DotnetCli($"build \"{wpfProjectPath}\"", out string output, out string error));
+      string assemblyLocation = Directory.GetFiles(testBinaryPath, "coverlet.tests.projectsample.wpf8.selfcontained.dll", SearchOption.AllDirectories).First();
+
+      var mockLogger = new Mock<ILogger>();
+      var resolver = new NetCoreSharedFrameworkResolver(assemblyLocation, mockLogger.Object);
+      var compilationLibrary = new CompilationLibrary(
+          "package",
+          "System.Drawing",
+          "0.0.0.0",
+          "sha512-not-relevant",
+          Enumerable.Empty<string>(),
+          Enumerable.Empty<Dependency>(),
+          true);
+
+      var assemblies = new List<string>();
+      Assert.True(resolver.TryResolveAssemblyPaths(compilationLibrary, assemblies),
+          "sample assembly shall be resolved");
+      Assert.NotEmpty(assemblies);
+    }
   }
 }
diff --git a/test/coverlet.tests.projectsample.wpf8.selfcontained/.editorconfig b/test/coverlet.tests.projectsample.wpf8.selfcontained/.editorconfig
@@ -0,0 +1,8 @@
+# top-most EditorConfig file
+# We don't want to import other EditorConfig files and we want
+# to ensure no rules are enabled for these asset source files.
+root = true
+
+[*.cs]
+# Default severity for all analyzer diagnostics
+dotnet_analyzer_diagnostic.severity = none
diff --git a/test/coverlet.tests.projectsample.wpf8.selfcontained/Program.cs b/test/coverlet.tests.projectsample.wpf8.selfcontained/Program.cs
@@ -0,0 +1,9 @@
+﻿// Copyright (c) Toni Solarin-Sodara
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace coverlet.tests.projectsample.wpf8.selfcontained;
+
+public static class Program
+{
+    public static void Main() { }
+}
diff --git a/test/coverlet.tests.projectsample.wpf8.selfcontained/TestClass.cs b/test/coverlet.tests.projectsample.wpf8.selfcontained/TestClass.cs
@@ -0,0 +1,12 @@
+﻿// Copyright (c) Toni Solarin-Sodara
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Windows.Controls;
+
+namespace coverlet.tests.projectsample.wpf8.selfcontained
+{
+    public class TestClass
+    {
+        public UserControl? Control { get; set; }
+    }
+}
diff --git a/test/coverlet.tests.projectsample.wpf8.selfcontained/coverlet.tests.projectsample.wpf8.selfcontained.csproj b/test/coverlet.tests.projectsample.wpf8.selfcontained/coverlet.tests.projectsample.wpf8.selfcontained.csproj
@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>WinExe</OutputType>
+    <TargetFramework>net8.0-windows</TargetFramework>
+    <Nullable>enable</Nullable>
+    <UseWpf>true</UseWpf>
+    <IsTestProject>false</IsTestProject>
+    <EnableWindowsTargeting>true</EnableWindowsTargeting>
+    <IsPackable>false</IsPackable>
+    <SelfContained>true</SelfContained>
+    <RuntimeIdentifier>win-x64</RuntimeIdentifier>
+  </PropertyGroup>
+
+</Project>
diff --git a/test/coverlet.tests.projectsample.wpf8/Program.cs b/test/coverlet.tests.projectsample.wpf8/Program.cs
@@ -1,7 +1,7 @@
 ﻿// Copyright (c) Toni Solarin-Sodara
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-namespace coverlet.tests.projectsample.wpf6;
+namespace coverlet.tests.projectsample.wpf8;
 
 public static class Program
 {
diff --git a/test/coverlet.tests.projectsample.wpf8/TestClass.cs b/test/coverlet.tests.projectsample.wpf8/TestClass.cs
@@ -3,7 +3,7 @@
 
 using System.Windows.Controls;
 
-namespace coverlet.tests.projectsample.wpf6
+namespace coverlet.tests.projectsample.wpf8
 {
     public class TestClass
     {

Original file line number	Diff line number	Diff line change
`@@ -318,6 +318,11 @@ public RuntimeConfigurationReader(string runtimeConfigFile)`
`318`	`318`	`return runtimeOptionsElement["frameworks"].Select(x => (x["name"]?.Value<string>(), x["version"]?.Value<string>())).ToList();`
`319`	`319`	`}`
`320`	`320`
	`321`	`+ if (runtimeOptionsElement?["includedFrameworks"] != null)`
	`322`	`+ {`
	`323`	`+ return runtimeOptionsElement["includedFrameworks"].Select(x => (x["name"]?.Value<string>(), x["version"]?.Value<string>())).ToList();`
	`324`	`+ }`
	`325`	`+`
`321`	`326`	`throw new InvalidOperationException($"Unable to read runtime configuration from {_runtimeConfigFile}.");`
`322`	`327`	`}`
`323`	`328`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`// Copyright (c) Toni Solarin-Sodara`
`2`	`2`	`// Licensed under the MIT license. See LICENSE file in the project root for full license information.`
`3`	`3`
`4`		`-namespace coverlet.tests.projectsample.wpf6;`
	`4`	`+namespace coverlet.tests.projectsample.wpf8;`
`5`	`5`
`6`	`6`	`public static class Program`
`7`	`7`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`using System.Windows.Controls;`
`5`	`5`
`6`		`-namespace coverlet.tests.projectsample.wpf6`
	`6`	`+namespace coverlet.tests.projectsample.wpf8`
`7`	`7`	`{`
`8`	`8`	`public class TestClass`
`9`	`9`	`{`