add tests for ApiListWriter.WriteReferencedAssemblies

Author: smdn

tests/Smdn.Reflection.ReverseGenerating.ListApi.Core/Smdn.Reflection.ReverseGenerating.ListApi.Core.Tests.csproj

@@ -30,6 +30,7 @@ SPDX-License-Identifier: MIT
     <ItemGroup>
       <TestProjects Include="$(TestAssemblyRootDirectory)\LibA\LibA.csproj" />
       <TestProjects Include="$(TestAssemblyRootDirectory)\LibB\LibB.csproj" />
+      <TestProjects Include="$(TestAssemblyRootDirectory)\LibReferencedAssemblies1\LibReferencedAssemblies1.csproj" />
     </ItemGroup>
 
     <!--

tests/Smdn.Reflection.ReverseGenerating.ListApi.Core/Smdn.Reflection.ReverseGenerating.ListApi/ApiListWriter.cs

@@ -17,6 +17,7 @@
 using Microsoft.Extensions.Logging.Console;
 using NUnit.Framework;
 using Smdn.IO;
+using Smdn.Reflection.ReverseGenerating.ListApi.Core; // TestAssemblyInfo
 
 namespace Smdn.Reflection.ReverseGenerating.ListApi;
 
@@ -526,4 +527,172 @@ public void WriteEmbeddedResources_HasNoEmbeddedResources(
       )
     );
   }
+
+  private static System.Collections.IEnumerable YieldTestCases_WriteReferencedAssemblies()
+  {
+    foreach (var writeReferencedAssemblies in new[] { true, false }) {
+#if NETCOREAPP3_1_OR_GREATER || NET6_0_OR_GREATER
+      yield return new object[] {
+        "Lib",
+        "netstandard2.1",
+        writeReferencedAssemblies,
+        new[] {
+          "netstandard, Version=2.1.",
+        }
+      };
+#endif
+#if NET6_0_OR_GREATER
+      yield return new object[] {
+        "Lib",
+        "net6.0",
+        writeReferencedAssemblies,
+        new[] {
+          "System.Runtime, Version=6.0.",
+        }
+      };
+#endif
+#if NET7_0_OR_GREATER
+      yield return new object[] {
+        "Lib",
+        "net7.0",
+        writeReferencedAssemblies,
+        new[] {
+          "System.Runtime, Version=7.0.",
+        }
+      };
+#endif
+#if NETCOREAPP3_1_OR_GREATER || NET6_0_OR_GREATER
+      yield return new object[] {
+        "LibB",
+        "netstandard2.1",
+        writeReferencedAssemblies,
+        new[] {
+          "netstandard, Version=2.1.",
+          "LibA, Version=",
+        }
+      };
+#endif
+#if NET6_0_OR_GREATER
+      yield return new object[] {
+        "LibB",
+        "net6.0",
+        writeReferencedAssemblies,
+        new[] {
+          "System.Runtime, Version=6.0.",
+          "LibA, Version=",
+        }
+      };
+#endif
+#if NETCOREAPP3_1_OR_GREATER || NET6_0_OR_GREATER
+      yield return new object[] {
+        "LibReferencedAssemblies1",
+        "netstandard2.1",
+        writeReferencedAssemblies,
+        new[] {
+          "netstandard, Version=2.1.",
+        }
+      };
+#endif
+#if NET6_0_OR_GREATER
+      yield return new object[] {
+        "LibReferencedAssemblies1",
+        "net6.0",
+        writeReferencedAssemblies,
+        new[] {
+          "System.Runtime, Version=6.0.",
+          "System.Threading, Version=6.0.",
+          "System.Xml.ReaderWriter, Version=6.0.",
+        }
+      };
+#endif
+#if NET7_0_OR_GREATER
+      yield return new object[] {
+        "LibReferencedAssemblies1",
+        "net7.0",
+        writeReferencedAssemblies,
+        new[] {
+          "System.Runtime, Version=7.0.",
+          "System.Threading, Version=7.0.",
+          "System.Xml.ReaderWriter, Version=7.0.",
+        }
+      };
+#endif
+    }
+  }
+
+  // Cannot use `WriteApiListFromSourceCode` for testing WriteReferencedAssemblies.
+  // The type of the assembly generated by CSharpCompilation.Emit and loaded by AssemblyLoader, will be System.Reflection.TypeLoading.Ecma.EcmaAssembly.
+  // And Assembly.TryGetRawMetadata returns false if the type of input assembl is System.Reflection.TypeLoading.Ecma.EcmaAssembly.
+  // Therefore, the referenced assemblies cannot be read from the assembly generated and loaded with WriteApiListFromSourceCode.
+  [TestCaseSource(nameof(YieldTestCases_WriteReferencedAssemblies))]
+  public void WriteReferencedAssemblies(
+    string assemblyFileName,
+    string targetFrameworkMoniker,
+    bool writeReferencedAssemblies,
+    string[] expectedReferencedAssemblies
+  )
+  {
+    var assemblyFile = new FileInfo(
+      TestAssemblyInfo.TestAssemblyPaths.First(f => f.Contains(targetFrameworkMoniker) && f.Contains(assemblyFileName))
+    );
+
+    var options = new ApiListWriterOptions();
+
+    options.Writer.WriteNullableAnnotationDirective = false;
+    options.Writer.WriteEmbeddedResources = false;
+    options.Writer.WriteReferencedAssemblies = writeReferencedAssemblies;
+
+    var generated = GenerateApiListFrom(assemblyFile, options);
+
+    if (writeReferencedAssemblies) {
+      StringAssert.Contains(
+        "//   Referenced assemblies:",
+        generated
+      );
+
+      foreach (var expectedReferencedAssembly in expectedReferencedAssemblies) {
+        StringAssert.Contains(
+          $"//     {expectedReferencedAssembly}",
+          generated
+        );
+      }
+    }
+    else {
+      StringAssert.DoesNotContain(
+        "//   Referenced assemblies:",
+        generated
+      );
+    }
+
+    string GenerateApiListFrom(FileInfo assemblyFile, ApiListWriterOptions options)
+    {
+      var ret = AssemblyLoader.UsingAssembly(
+        assemblyFile,
+        loadIntoReflectionOnlyContext: false,
+        arg: options,
+        logger: logger,
+        actionWithLoadedAssembly: static (assm, options) => {
+          var sb = new StringBuilder();
+          var writer = new ApiListWriter(new StringWriter(sb), assm, options);
+
+          writer.WriteAssemblyInfoHeader();
+          writer.WriteExportedTypes();
+
+          return sb.ToString();
+        },
+        context: out var context
+      );
+
+      // wait for the context to be collected
+      if (context is null)
+        return ret ?? string.Empty;
+
+      while (context.IsAlive) {
+        GC.Collect();
+        GC.WaitForPendingFinalizers();
+      }
+
+      return ret ?? string.Empty;
+    }
+  }
 }

tests/test-assm/LibReferencedAssemblies1/Class.cs

@@ -0,0 +1,6 @@
+public static class C {
+  public static void M(int p) { }
+  public static void M(System.Uri p) { }
+  public static void M(System.Threading.Mutex p) { }
+  public static void M(System.Xml.XmlDocument p) { }
+}

tests/test-assm/LibReferencedAssemblies1/LibReferencedAssemblies1.csproj

@@ -0,0 +1,7 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFrameworks>net6.0;netstandard2.1</TargetFrameworks>
+  </PropertyGroup>
+
+  <Import Project="..\..\..\src\Sdk.net7.0-preview.props" />
+</Project>