Using MSBuild task to run the XmlSerializer directly #117406
There are no files selected for viewing
This file contains hidden or 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,77 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Microsoft.Build.Framework; | ||
| using Microsoft.Build.Utilities; | ||
| using System; | ||
| using System.Collections.Generic; | ||
|
|
||
| namespace Microsoft.XmlSerializer.Generator | ||
| { | ||
| /// <summary> | ||
| /// MSBuild task to run the Microsoft.XmlSerializer.Generator directly, | ||
| /// without spawning a new process. | ||
| /// </summary> | ||
| public class GenerateXmlSerializers : Task | ||
| { | ||
| /// <summary> | ||
| /// Path to the target assembly (usually the output DLL). | ||
| /// </summary> | ||
| [Required] | ||
| public string AssemblyPath { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Optional path to a response file containing additional generator arguments. | ||
| /// </summary> | ||
| public string RspFilePath { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Force regeneration of serializers even if they exist. | ||
| /// </summary> | ||
| public bool Force { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Run in quiet mode with minimal output. | ||
| /// </summary> | ||
| public bool Quiet { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// If true, errors during serializer generation will be suppressed. | ||
| /// </summary> | ||
| public bool IgnoreErrors { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Executes the XmlSerializer generator. | ||
| /// </summary> | ||
| public override bool Execute() | ||
| { | ||
| var args = new List<string>(); | ||
|
|
||
| if (!string.IsNullOrEmpty(AssemblyPath)) | ||
| args.Add(AssemblyPath); | ||
|
|
||
| if (Force) | ||
| args.Add("--force"); | ||
|
|
||
| if (Quiet) | ||
| args.Add("--quiet"); | ||
|
|
||
| if (!string.IsNullOrEmpty(RspFilePath)) | ||
| args.Add(RspFilePath); | ||
|
|
||
| Sgen sgen = new Sgen(); | ||
| Sgen.InfoWriter = new InfoTextWriter(Log); | ||
| Sgen.WarningWriter = new WarningTextWriter(Log); | ||
| Sgen.ErrorWriter = new ErrorTextWriter(Log); | ||
|
|
||
| int exitCode = sgen.Run(args.ToArray()); | ||
|
Comment on lines
+62
to
+67
There was a problem hiding this comment. Now that Sgen is no longer a CLI tool, you should add properties to the MSBuild task and to the |
||
|
|
||
| if (exitCode != 0) | ||
| { | ||
| Log.LogError("XmlSerializer failed with exit code {0}.", exitCode); | ||
| } | ||
|
|
||
| return IgnoreErrors || exitCode == 0; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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,95 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System; | ||
| using System.IO; | ||
| using System.Text; | ||
| using Microsoft.Build.Framework; | ||
| using Microsoft.Build.Utilities; | ||
|
|
||
| namespace Microsoft.XmlSerializer.Generator | ||
| { | ||
| internal sealed class InfoTextWriter : TextWriter | ||
|
There was a problem hiding this comment. You can combine the three internal sealed class DelegatedTextWriter(Action<string> fWrite) : TextWriter
{
public override Encoding Encoding => Encoding.UTF8;
public override void Write(string? value)
{
if (!string.IsNullOrEmpty(value))
{
fWrite(value)
}
}
public override void WriteLine(string? value) => Write(value);
}And then create them in the task like |
||
| { | ||
| private readonly TaskLoggingHelper _log; | ||
|
|
||
| public InfoTextWriter(TaskLoggingHelper log) | ||
| { | ||
| _log = log ?? throw new ArgumentNullException(nameof(log)); | ||
| } | ||
|
|
||
| public override Encoding Encoding => Encoding.UTF8; | ||
|
|
||
| public override void Write(string? value) | ||
| { | ||
| if (!string.IsNullOrEmpty(value)) | ||
| { | ||
| _log.LogMessage(MessageImportance.High, value); | ||
|
There was a problem hiding this comment. We should decide if the messages should have high importance, or which of them should. |
||
| } | ||
| } | ||
|
|
||
| public override void WriteLine(string? value) | ||
| { | ||
| if (!string.IsNullOrEmpty(value)) | ||
| { | ||
| _log.LogMessage(MessageImportance.High, value); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| internal sealed class WarningTextWriter : TextWriter | ||
| { | ||
| private readonly TaskLoggingHelper _log; | ||
|
|
||
| public WarningTextWriter(TaskLoggingHelper log) | ||
| { | ||
| _log = log ?? throw new ArgumentNullException(nameof(log)); | ||
| } | ||
|
|
||
| public override Encoding Encoding => Encoding.UTF8; | ||
|
|
||
| public override void Write(string? value) | ||
| { | ||
| if (!string.IsNullOrEmpty(value)) | ||
| { | ||
| _log.LogWarning(value); | ||
| } | ||
| } | ||
|
|
||
| public override void WriteLine(string? value) | ||
| { | ||
| if (!string.IsNullOrEmpty(value)) | ||
| { | ||
| _log.LogWarning(value); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| internal sealed class ErrorTextWriter : TextWriter | ||
| { | ||
| private readonly TaskLoggingHelper _log; | ||
|
|
||
| public ErrorTextWriter(TaskLoggingHelper log) | ||
| { | ||
| _log = log ?? throw new ArgumentNullException(nameof(log)); | ||
| } | ||
|
|
||
| public override Encoding Encoding => Encoding.UTF8; | ||
|
|
||
| public override void Write(string? value) | ||
| { | ||
| if (!string.IsNullOrEmpty(value)) | ||
| { | ||
| _log.LogError(value); | ||
| } | ||
| } | ||
|
|
||
| public override void WriteLine(string? value) | ||
| { | ||
| if (!string.IsNullOrEmpty(value)) | ||
| { | ||
| _log.LogError(value); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>netstandard2.0</TargetFramework> | ||
|
|
@@ -22,22 +22,24 @@ | |
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Compile Include="GenerateXmlSerializers.cs" /> | ||
| <Compile Include="LogWriter.cs" /> | ||
| <Compile Include="Sgen.cs" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <!-- Set an empty PackagePath to place this file in the root of the package --> | ||
| <None Include="build\prefercliruntime" PackagePath="" Pack="true" /> | ||
| <None Include="build\Microsoft.XmlSerializer.Generator.targets" PackagePath="build" Pack="true" /> | ||
| <None Include="build\dotnet-Microsoft.XmlSerializer.Generator.runtimeconfig.json" PackagePath="lib\netstandard2.0" Pack="true" /> | ||
|
There was a problem hiding this comment. We should make sure a There was a problem hiding this comment. We've had to abandon this approach because the Task was being run in msbuild running on .NET Framework when building in Visual Studio. We can't do that because we depend on implementation that lives in the .NET runtime to do some of the work. Would including a .deps.json file allow us to run the Task using .NET when building on Visual Studio? There was a problem hiding this comment. No, that's not yet supported and is tracked in dotnet/msbuild#4834. |
||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageDownloadAndReference Include="Microsoft.Build.Framework" Version="$(MicrosoftBuildFrameworkVersion)" Folder="ref/netstandard2.0" /> | ||
| <PackageDownloadAndReference Include="Microsoft.Build.Utilities.Core" Version="$(MicrosoftBuildUtilitiesCoreVersion)" Folder="ref/netstandard2.0" /> | ||
| </ItemGroup> | ||
|
|
||
| <Import Project="$(RepositoryEngineeringDir)PackageDownloadAndReference.targets" /> | ||
| <Import Project="GenerateThisAssemblyCs.targets" /> | ||
| <Import Project="GenerateNupkgProps.targets" /> | ||
|
|
||
|
|
||
This file contains hidden or 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 hidden or 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 | ||
|---|---|---|---|---|
|
|
@@ -48,7 +48,8 @@ | |||
| <Delete Condition="Exists('$(_SerializerPdbIntermediateFolder)') == 'true'" Files="$(_SerializerPdbIntermediateFolder)" ContinueOnError="true"/> | ||||
| <Delete Condition="Exists('$(_SerializerCsIntermediateFolder)') == 'true'" Files="$(_SerializerCsIntermediateFolder)" ContinueOnError="true"/> | ||||
| <Message Text="Running Serialization Tool" Importance="normal" /> | ||||
|
There was a problem hiding this comment.
Suggested change
Not strictly needed, MSBuild binary logs keep track of when tasks start. |
||||
| <UsingTask TaskName="GenerateXmlSerializers" AssemblyFile="$(MSBuildThisFileDirectory)/../lib/netstandard2.0/dotnet-Microsoft.XmlSerializer.Generator.dll" /> | ||||
|
There was a problem hiding this comment.
|
||||
| <GenerateXmlSerializers AssemblyPath="$(IntermediateOutputPath)$(AssemblyName)$(TargetExt)" RspFilePath="$(_SgenRspFilePath)" Force="true" Quiet="true" IgnoreErrors="true" /> | ||||
| <Warning Condition="Exists('$(_SerializerCsIntermediateFolder)') != 'true'" Text="$(_SGenWarningText)" /> | ||||
| <Csc Condition="Exists('$(_SerializerCsIntermediateFolder)') and !Exists('$(_CscRspFilePath)')" ContinueOnError="true" OutputAssembly="$(_SerializerDllIntermediateFolder)" References="@(ReferencePath);@(IntermediateAssembly)" Optimize="$(Optimize)" EmitDebugInformation="$(DebugSymbols)" Sources="$(_SerializerCsIntermediateFolder);$(_SerializerCsAssemblyInfoIntermediateFolder)" TargetType="Library" ToolExe="$(CscToolExe)" ToolPath="$(CscToolPath)" DisabledWarnings="$(_SerializationAssemblyDisabledWarnings)"/> | ||||
| <Csc Condition="Exists('$(_SerializerCsIntermediateFolder)') and Exists('$(_CscRspFilePath)')" ContinueOnError="true" OutputAssembly="$(_SerializerDllIntermediateFolder)" References="@(ReferencePath);@(IntermediateAssembly)" Optimize="$(Optimize)" EmitDebugInformation="$(DebugSymbols)" Sources="$(_SerializerCsIntermediateFolder);$(_SerializerCsAssemblyInfoIntermediateFolder)" TargetType="Library" ResponseFiles="$(_CscRspFilePath)" ToolExe="$(CscToolExe)" ToolPath="$(CscToolPath)" DisabledWarnings="$(_SerializationAssemblyDisabledWarnings)"/> | ||||
|
|
||||
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.
These two are always true and we should update Sgen to remove all code that would run if they were false.