ILSpy/ILSpy.Tests/Metadata/EmbeddedPdbTreeTests.cs

// Copyright (c) 2026 AlphaSierraPapa for the SharpDevelop Team
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

using System.Linq;
using System.Threading.Tasks;

using Avalonia.Headless.NUnit;

using AwesomeAssertions;

using ICSharpCode.ILSpy.Properties;

using ILSpy.AppEnv;
using ILSpy.Commands;
using ILSpy.Metadata;
using ILSpy.Metadata.DebugTables;
using ILSpy.TreeNodes;
using ILSpy.ViewModels;
using ILSpy.Views;

using NUnit.Framework;

namespace ICSharpCode.ILSpy.Tests.Metadata;

[TestFixture]
public class EmbeddedPdbTreeTests
{
	[AvaloniaTest]
	public async Task Expanding_DebugDirectory_Surfaces_Embedded_PDB_Metadata_Subtree()
	{
		// Modern .NET SDK Debug builds default to DebugType=embedded, so the test DLL
		// itself ships with an embedded portable PDB. Loading it confirms expanding the
		// host module's Debug Directory exposes a "Debug Metadata (Embedded)" node whose
		// own Tables subtree contains the PDB-only tables (Document and friends) — the
		// canonical entry point for browsing debug metadata in the live app.

		var window = AppComposition.Current.GetExport<MainWindow>();
		window.Show();
		var vm = (MainWindowViewModel)window.DataContext!;
		await vm.AssemblyTreeModel.WaitForAssembliesAsync(minimumCount: 1);

		// ICSharpCode.Decompiler ships with an embedded portable PDB (no separate .pdb in
		// the build output) — use it as the fixture rather than the test DLL itself, which
		// the test SDK builds with portable + sidecar PDB.
		var testDllPath = typeof(ICSharpCode.Decompiler.Metadata.MetadataFile).Assembly.Location;
		var registry = AppComposition.Current.GetExport<MainMenuCommandRegistry>();
		var openCommand = registry.Commands
			.Single(c => c.Metadata.Header == nameof(Resources._Open))
			.CreateExport().Value;
		openCommand.Execute(testDllPath);

		await Waiters.WaitForAsync(() =>
			vm.AssemblyTreeModel.AssemblyList!.GetAssemblies().Any(a =>
				string.Equals(a.FileName, testDllPath, System.StringComparison.OrdinalIgnoreCase)));
		var loaded = vm.AssemblyTreeModel.AssemblyList!.GetAssemblies()
			.First(a => string.Equals(a.FileName, testDllPath, System.StringComparison.OrdinalIgnoreCase));
		await loaded.GetLoadResultAsync();

		var assemblyNode = vm.AssemblyTreeModel.FindNode<AssemblyTreeNode>(loaded.ShortName);
		assemblyNode.EnsureLazyChildren();
		var metadataNode = assemblyNode.Children.OfType<MetadataTreeNode>().Single();
		metadataNode.EnsureLazyChildren();

		var debugDirectoryNode = metadataNode.Children.OfType<DebugDirectoryTreeNode>().Single();
		debugDirectoryNode.EnsureLazyChildren();

		// The embedded-PDB sub-tree is a MetadataTreeNode whose own children include a
		// MetadataTablesTreeNode listing the debug-only tables.
		var embeddedPdbNode = debugDirectoryNode.Children.OfType<MetadataTreeNode>().SingleOrDefault();
		(embeddedPdbNode is null).Should().BeFalse(
			"the test DLL ships with an embedded portable PDB, so the Debug Directory must expose its metadata as a nested MetadataTreeNode");
		embeddedPdbNode!.Text.Should().Be("Debug Metadata (Embedded)");

		embeddedPdbNode.EnsureLazyChildren();
		var pdbTables = embeddedPdbNode.Children.OfType<MetadataTablesTreeNode>().Single();
		pdbTables.EnsureLazyChildren();
		pdbTables.Children.OfType<DocumentTableTreeNode>().Should().NotBeEmpty(
			"the embedded PDB's Tables subtree must expose the Document table — the lead debug-only table that always has rows in a populated PDB");
	}
}