Implement SourceLink for Windows PDBs #18539
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| // Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using System; | ||
| using System.Diagnostics; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using System.Reflection.Metadata; | ||
| using System.Reflection.PortableExecutable; | ||
| using System.Text; | ||
| using Microsoft.CodeAnalysis.CSharp.Test.Utilities; | ||
| using Microsoft.CodeAnalysis.Debugging; | ||
| using Microsoft.CodeAnalysis.Emit; | ||
| using Microsoft.CodeAnalysis.Test.Utilities; | ||
| using Roslyn.Test.Utilities; | ||
| using Xunit; | ||
|
|
||
| namespace Microsoft.CodeAnalysis.CSharp.UnitTests.PDB | ||
| { | ||
| public class PDBSourceLinkTests : CSharpPDBTestBase | ||
| { | ||
| [Theory] | ||
| [InlineData(DebugInformationFormat.Pdb)] | ||
| [InlineData(DebugInformationFormat.PortablePdb)] | ||
| public void SourceLink(DebugInformationFormat format) | ||
| { | ||
| string source = @" | ||
| using System; | ||
|
|
||
| class C | ||
| { | ||
| public static void Main() | ||
| { | ||
| Console.WriteLine(); | ||
| } | ||
| } | ||
| "; | ||
| var sourceLinkBlob = Encoding.UTF8.GetBytes(@" | ||
| { | ||
| ""documents"": { | ||
|
There was a problem hiding this comment. Nit: open brace on new line #WontFix There was a problem hiding this comment. This is not C# ;) #WontFix |
||
| ""f:/build/*"" : ""https://raw.githubusercontent.com/my-org/my-project/1111111111111111111111111111111111111111/*"" | ||
| } | ||
| } | ||
| "); | ||
|
|
||
| var c = CreateStandardCompilation(Parse(source, "f:/build/foo.cs"), options: TestOptions.DebugDll); | ||
|
|
||
| var pdbStream = new MemoryStream(); | ||
| c.EmitToArray(EmitOptions.Default.WithDebugInformationFormat(format), pdbStream: pdbStream, sourceLinkStream: new MemoryStream(sourceLinkBlob)); | ||
|
|
||
| var actualData = PdbValidation.GetSourceLinkData(pdbStream); | ||
| AssertEx.Equal(sourceLinkBlob, actualData); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void SourceLink_Embedded() | ||
| { | ||
| string source = @" | ||
| using System; | ||
|
|
||
| class C | ||
| { | ||
| public static void Main() | ||
| { | ||
| Console.WriteLine(); | ||
| } | ||
| } | ||
| "; | ||
| var sourceLinkBlob = Encoding.UTF8.GetBytes(@" | ||
| { | ||
| ""documents"": { | ||
| ""f:/build/*"" : ""https://raw.githubusercontent.com/my-org/my-project/1111111111111111111111111111111111111111/*"" | ||
| } | ||
| } | ||
| "); | ||
| var c = CreateStandardCompilation(Parse(source, "f:/build/foo.cs"), options: TestOptions.DebugDll); | ||
|
|
||
| var peBlob = c.EmitToArray(EmitOptions.Default.WithDebugInformationFormat(DebugInformationFormat.Embedded), sourceLinkStream: new MemoryStream(sourceLinkBlob)); | ||
|
|
||
| using (var peReader = new PEReader(peBlob)) | ||
| { | ||
| var embeddedEntry = peReader.ReadDebugDirectory().Single(e => e.Type == DebugDirectoryEntryType.EmbeddedPortablePdb); | ||
|
|
||
| using (var embeddedMetadataProvider = peReader.ReadEmbeddedPortablePdbDebugDirectoryData(embeddedEntry)) | ||
| { | ||
| var pdbReader = embeddedMetadataProvider.GetMetadataReader(); | ||
|
|
||
| var actualBlob = | ||
| (from cdiHandle in pdbReader.GetCustomDebugInformation(EntityHandle.ModuleDefinition) | ||
| let cdi = pdbReader.GetCustomDebugInformation(cdiHandle) | ||
| where pdbReader.GetGuid(cdi.Kind) == PortableCustomDebugInfoKinds.SourceLink | ||
| select pdbReader.GetBlobBytes(cdi.Value)).Single(); | ||
|
|
||
| AssertEx.Equal(sourceLinkBlob, actualBlob); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(DebugInformationFormat.Pdb)] | ||
| [InlineData(DebugInformationFormat.Embedded)] | ||
| [InlineData(DebugInformationFormat.PortablePdb)] | ||
| public void SourceLink_Errors(DebugInformationFormat format) | ||
| { | ||
| string source = @" | ||
| using System; | ||
|
|
||
| class C | ||
| { | ||
| public static void Main() | ||
| { | ||
| Console.WriteLine(); | ||
| } | ||
| } | ||
| "; | ||
| var sourceLinkStream = new TestStream(canRead: true, readFunc: (_, __, ___) => { throw new Exception("Error!"); }); | ||
|
There was a problem hiding this comment. Hopefully, discards will be supported in lambdas soon ;-) #Resolved There was a problem hiding this comment. |
||
|
|
||
| var c = CreateStandardCompilation(Parse(source, "f:/build/foo.cs"), options: TestOptions.DebugDll); | ||
| var pdbStream = format != DebugInformationFormat.Embedded ? new MemoryStream() : null; | ||
| var result = c.Emit(new MemoryStream(), pdbStream, options: EmitOptions.Default.WithDebugInformationFormat(format), sourceLinkStream: sourceLinkStream); | ||
| result.Diagnostics.Verify( | ||
| // error CS0041: Unexpected error writing debug information -- 'Error!' | ||
| Diagnostic(ErrorCode.FTL_DebugEmitFailure).WithArguments("Error!").WithLocation(1, 1)); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(DebugInformationFormat.Pdb)] | ||
| [InlineData(DebugInformationFormat.PortablePdb)] | ||
| public void SourceLink_Empty(DebugInformationFormat format) | ||
| { | ||
| string source = @" | ||
| using System; | ||
|
|
||
| class C | ||
| { | ||
| public static void Main() | ||
| { | ||
| Console.WriteLine(); | ||
| } | ||
| } | ||
| "; | ||
| var sourceLinkBlob = new byte[0]; | ||
|
|
||
| var c = CreateStandardCompilation(Parse(source, "f:/build/foo.cs"), options: TestOptions.DebugDll); | ||
|
|
||
| var pdbStream = new MemoryStream(); | ||
| c.EmitToArray(EmitOptions.Default.WithDebugInformationFormat(format), pdbStream: pdbStream, sourceLinkStream: new MemoryStream(sourceLinkBlob)); | ||
| pdbStream.Position = 0; | ||
|
There was a problem hiding this comment. Is this position reset necessary? Maybe There was a problem hiding this comment. |
||
| var bs = Roslyn.Utilities.StreamExtensions.ReadAllBytes(pdbStream); | ||
| var actualData = PdbValidation.GetSourceLinkData(pdbStream); | ||
| AssertEx.Equal(sourceLinkBlob, actualData); | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the VB command-line parser have a similar change? #Resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, forgot about that.
In reply to: 113746766 [](ancestors = 113746766)