Add Rebuild.UnitTests #51778
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
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,22 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the LICENSE file in the project root for more information. --> | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <OutputType>Library</OutputType> | ||
| <RootNamespace>Microsoft.CodeAnalysis.Rebuild.UnitTests</RootNamespace> | ||
| <AllowUnsafeBlocks>true</AllowUnsafeBlocks> | ||
| <TargetFrameworks>net5.0;net472</TargetFrameworks> | ||
| </PropertyGroup> | ||
| <ItemGroup Label="Project References"> | ||
| <ProjectReference Include="..\Portable\Microsoft.CodeAnalysis.csproj" /> | ||
| <ProjectReference Include="..\..\CSharp\Portable\Microsoft.CodeAnalysis.CSharp.csproj" /> | ||
| <ProjectReference Include="..\..\VisualBasic\Portable\Microsoft.CodeAnalysis.VisualBasic.vbproj" /> | ||
| <ProjectReference Include="..\..\Test\Core\Microsoft.CodeAnalysis.Test.Utilities.csproj" /> | ||
| <ProjectReference Include="..\..\Test\Resources\Core\Microsoft.CodeAnalysis.Compiler.Test.Resources.csproj" /> | ||
| <ProjectReference Include="..\..\Test\Utilities\CSharp\Microsoft.CodeAnalysis.CSharp.Test.Utilities.csproj" /> | ||
| <ProjectReference Include="..\Rebuild\Rebuild.csproj" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" /> | ||
| </ItemGroup> | ||
| </Project> |
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,126 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Collections.Generic; | ||
| using System.Collections.Immutable; | ||
| using System.Linq; | ||
| using System; | ||
| using System.Reflection.PortableExecutable; | ||
| using BuildValidator; | ||
| using Castle.Core.Logging; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CSharp; | ||
| using Microsoft.CodeAnalysis.CSharp.Test.Utilities; | ||
| using Microsoft.CodeAnalysis.Emit; | ||
| using Microsoft.CodeAnalysis.Test.Utilities; | ||
| using Microsoft.Extensions.Logging; | ||
| using Xunit; | ||
| using System.IO; | ||
| using System.Threading; | ||
| using Microsoft.CodeAnalysis.VisualBasic; | ||
| using System.Text; | ||
|
|
||
| namespace Microsoft.CodeAnalysis.Rebuild.UnitTests | ||
| { | ||
| public class OptionRoundTripTests : CSharpTestBase | ||
| { | ||
| public static readonly object[][] s_platforms = ((Platform[])Enum.GetValues(typeof(Platform))).Select(p => new[] { (object)p }).ToArray(); | ||
|
|
||
| [Theory] | ||
| [MemberData(nameof(s_platforms))] | ||
| public void Platform_RoundTrip(Platform platform) | ||
| { | ||
| const string path = "test"; | ||
|
|
||
| var original = CreateCompilation( | ||
| "class C { static void Main() { } }", | ||
| options: TestOptions.DebugExe.WithPlatform(platform)); | ||
|
|
||
| original.VerifyDiagnostics(); | ||
|
|
||
| var originalBytes = original.EmitToArray(new EmitOptions(debugInformationFormat: DebugInformationFormat.Embedded)); | ||
| var peReader = new PEReader(originalBytes); | ||
| Assert.True(peReader.TryOpenAssociatedPortablePdb(path, path => null, out var provider, out _)); | ||
| var pdbReader = provider!.GetMetadataReader(); | ||
|
|
||
| var factory = LoggerFactory.Create(configure => { }); | ||
| var logger = factory.CreateLogger(path); | ||
| // TODO: shouldn't need to pass a logger. | ||
|
There was a problem hiding this comment. If we need an There was a problem hiding this comment. Yes, but it feels like users of the public API shouldn't be required to provide a logger, and shouldn't provide it as its own parameter. Maybe a property on an options object that can be specified if the user wants, but not a parameter to public API that they have to deal with. |
||
| var bc = new BuildConstructor(logger); | ||
|
|
||
| var optionsReader = new CompilationOptionsReader(logger, pdbReader, peReader); | ||
|
|
||
| var sources = original.SyntaxTrees.Select(st => | ||
| { | ||
| var text = st.GetText(); | ||
| return new ResolvedSource(OnDiskPath: null, text, new SourceFileInfo(path, text.ChecksumAlgorithm, text.GetChecksum().ToArray(), text, embeddedCompressedHash: null)); | ||
| }).ToImmutableArray(); | ||
|
There was a problem hiding this comment.
Could use There was a problem hiding this comment. I think this project is missing an IVT to MS.CA for this. I will punt on it for now if that's ok. |
||
| var references = original.References.ToImmutableArray(); | ||
| var (compilation, isError) = bc.CreateCompilation(optionsReader, path, sources, references); | ||
|
|
||
| Assert.False(isError); | ||
| Assert.Equal(platform, compilation!.Options.Platform); | ||
|
|
||
| // TODO: we should be able to get byte-for-byte equality here. | ||
| // it will probably be necessary to expose some diagnostic facility in the Rebuild API to figure out what's wrong here. | ||
|
|
||
| // using var rebuildStream = new MemoryStream(); | ||
| // var result = BuildConstructor.Emit(rebuildStream, new FileInfo(path), optionsReader, compilation, logger, CancellationToken.None); | ||
| // Assert.Empty(result.Diagnostics); | ||
| // Assert.True(result.Success); | ||
| // Assert.Equal(originalBytes.ToArray(), rebuildStream.ToArray()); | ||
| } | ||
|
|
||
| [Theory] | ||
| [MemberData(nameof(s_platforms))] | ||
| public void Platform_RoundTrip_VB(Platform platform) | ||
| { | ||
| const string path = "test"; | ||
|
|
||
| var original = CreateVisualBasicCompilation( | ||
| path, | ||
| compilationOptions: new VisualBasicCompilationOptions(outputKind: OutputKind.ConsoleApplication, platform: platform), | ||
| encoding: Encoding.UTF8, | ||
| code: @" | ||
| Class C | ||
| Shared Sub Main() | ||
| End Sub | ||
| End Class"); | ||
|
|
||
| original.VerifyDiagnostics(); | ||
|
|
||
| var originalBytes = original.EmitToArray(new EmitOptions(debugInformationFormat: DebugInformationFormat.Embedded)); | ||
| var peReader = new PEReader(originalBytes); | ||
| Assert.True(peReader.TryOpenAssociatedPortablePdb(path, path => null, out var provider, out _)); | ||
| var pdbReader = provider!.GetMetadataReader(); | ||
|
|
||
| var factory = LoggerFactory.Create(configure => { }); | ||
| var logger = factory.CreateLogger(path); | ||
| // TODO: shouldn't need to pass a logger. | ||
| var bc = new BuildConstructor(logger); | ||
|
|
||
| var optionsReader = new CompilationOptionsReader(logger, pdbReader, peReader); | ||
|
|
||
| var sources = original.SyntaxTrees.Select(st => | ||
| { | ||
| var text = st.GetText(); | ||
| return new ResolvedSource(OnDiskPath: null, text, new SourceFileInfo(path, text.ChecksumAlgorithm, text.GetChecksum().ToArray(), text, embeddedCompressedHash: null)); | ||
| }).ToImmutableArray(); | ||
| var references = original.References.ToImmutableArray(); | ||
| var (compilation, isError) = bc.CreateCompilation(optionsReader, path, sources, references); | ||
|
|
||
| Assert.False(isError); | ||
| Assert.Equal(platform, compilation!.Options.Platform); | ||
|
|
||
| // TODO: we should be able to get byte-for-byte equality here. | ||
| // it will probably be necessary to expose some diagnostic facility in the Rebuild API to figure out what's wrong here. | ||
|
|
||
| // using var rebuildStream = new MemoryStream(); | ||
| // var result = BuildConstructor.Emit(rebuildStream, new FileInfo(path), optionsReader, compilation, logger, CancellationToken.None); | ||
| // Assert.Empty(result.Diagnostics); | ||
| // Assert.True(result.Success); | ||
| // Assert.Equal(originalBytes.ToArray(), rebuildStream.ToArray()); | ||
| } | ||
| } | ||
| } | ||
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.
Platform can't be determined from the CLR/PE header flags of the dll? Seems like it should be possible.
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.
It may be possible, but I wasn't able to get all the values to round trip. The CoffHeader.Machine, for example, is not enough information. There must be other bits that imply
Platform.AnyCpuandPlatform.AnyCpu32BitPreferredthat I just wasn't able to find.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.
These are stored in CorHeader flags:
https://source.dot.net/#System.Reflection.Metadata/System/Reflection/PortableExecutable/CorHeader.cs,1f6cfc9c2185aaf4,references
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.
Filed #51941 to make sure we get to this. Thanks