Make the MSBuild runtime assembly check more correct #360
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
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,66 @@ | ||
| # MSBL001 - MSBuild runtime package is referenced without Runtime Assets excluded | ||
|
|
||
| ## Error Message | ||
|
|
||
| > A PackageReference to the package '{PackageId}' at version '{Version}' is present in this project without ExcludeAssets="runtime" set. This can cause errors at run-time due to MSBuild assembly-loading. | ||
|
|
||
| ## Cause | ||
|
|
||
| This error occurs when your project references MSBuild NuGet packages (such as `Microsoft.Build`, `Microsoft.Build.Framework`, `Microsoft.Build.Utilities.Core`, etc.) without excluding their runtime assets. When you use Microsoft.Build.Locator, you want MSBuildLocator to load MSBuild assemblies from an installed Visual Studio or .NET SDK instance, not from the NuGet packages in your output directory. | ||
|
|
||
| ## Why This Is a Problem | ||
|
|
||
| When MSBuild runtime assemblies are copied to your application's output directory, your application may load these assemblies instead of the MSBuild installation that MSBuildLocator registered. This can lead to several runtime issues: | ||
|
|
||
| 1. **Assembly version conflicts**: Your application loads MSBuild assemblies from your output directory while MSBuildLocator tries to load from a different MSBuild installation | ||
| 2. **Missing SDKs and build logic**: The MSBuild assemblies in your output directory don't include the SDKs, targets, and build logic needed to build real projects | ||
| 3. **Inconsistent behavior**: Your application may behave differently than `MSBuild.exe`, `dotnet build`, or Visual Studio when evaluating projects | ||
|
|
||
| ## Example Runtime Error | ||
|
|
||
| Without `ExcludeAssets="runtime"`, you may encounter errors like: | ||
|
|
||
| ``` | ||
| System.IO.FileNotFoundException: Could not load file or assembly 'Microsoft.Build, Version=15.1.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a' or one of its dependencies. | ||
| ``` | ||
|
|
||
| Or: | ||
|
|
||
| ``` | ||
| System.InvalidOperationException: SDK 'Microsoft.NET.Sdk' could not be resolved. The SDK resolver "Microsoft.DotNet.MSBuildSdkResolver" returned null. | ||
| ``` | ||
|
|
||
| This happens because your application loads MSBuild assemblies from your bin folder (e.g., version 15.5.180) while MSBuildLocator has registered a different MSBuild installation (e.g., version 17.0) to use at runtime. The .NET runtime gets confused about which assemblies to use, leading to version conflicts and missing dependencies. | ||
|
|
||
| ## Solution | ||
|
|
||
| Add `ExcludeAssets="runtime"` to all MSBuild PackageReferences in your project file: | ||
|
|
||
| ```xml | ||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.Build" ExcludeAssets="runtime" /> | ||
| <PackageReference Include="Microsoft.Build.Framework" ExcludeAssets="runtime" /> | ||
| <PackageReference Include="Microsoft.Build.Utilities.Core" ExcludeAssets="runtime" /> | ||
| ... | ||
| </ItemGroup> | ||
| ``` | ||
|
|
||
| This tells NuGet to use these packages only for compilation, not at runtime. At runtime, MSBuildLocator will load MSBuild assemblies from the registered Visual Studio or .NET SDK installation. | ||
|
|
||
| ## Alternative: Disable the Check (Not Recommended) | ||
|
|
||
| If you need to distribute MSBuild assemblies with your application (not recommended), you can disable this check by setting the following property in your project file: | ||
|
|
||
| ```xml | ||
| <PropertyGroup> | ||
| <DisableMSBuildAssemblyCopyCheck>true</DisableMSBuildAssemblyCopyCheck> | ||
| </PropertyGroup> | ||
| ``` | ||
|
|
||
| **Warning**: Disabling this check means you must distribute all of MSBuild and its associated toolset with your application, which is generally not recommended. The MSBuild team does not support this scenario, and you may encounter issues with SDK resolution and build logic. | ||
|
|
||
| ## Related Documentation | ||
|
|
||
| - [Use Microsoft.Build.Locator](https://learn.microsoft.com/visualstudio/msbuild/updating-an-existing-application#use-microsoftbuildlocator) | ||
| - [MSBuildLocator on GitHub](https://github.com/microsoft/MSBuildLocator) | ||
|
|
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 |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Microsoft.Build.Locator | ||
|
|
||
| Microsoft.Build.Locator helps you locate and register MSBuild assemblies provided with Visual Studio or the .NET SDK. This is essential when you need to use MSBuild APIs in your application to evaluate or build projects. | ||
|
|
||
| ## Why do I need this? | ||
|
|
||
| When using MSBuild's .NET API to load and build projects, you need access to the SDKs and build logic distributed with Visual Studio or the .NET SDK, not just the MSBuild APIs. MSBuildLocator helps you find these installations and set up your application to use them, ensuring your code gets the same view of projects as `MSBuild.exe`, `dotnet build`, or Visual Studio. | ||
|
|
||
| ## Quick Start | ||
|
|
||
| Before using any MSBuild APIs, register MSBuild assemblies: | ||
|
|
||
| ```csharp | ||
| using Microsoft.Build.Locator; | ||
| using Microsoft.Build.Evaluation; | ||
|
|
||
| // Register defaults before using any MSBuild types | ||
| MSBuildLocator.RegisterDefaults(); | ||
|
|
||
| // Now you can safely use MSBuild APIs. | ||
| // NOTE: due the the way that the CLR loads assemblies, you MUST | ||
| // register MSBuild through Locator before any types from | ||
| // the MSBuild assemblies are used in your application. | ||
| // The safest way to ensure this is to put any MSBuild API | ||
| // access into a separate method. | ||
| LoadProject(); | ||
|
|
||
| void LoadProject() | ||
| { | ||
| var project = new Project("MyProject.csproj"); | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| For more control over which MSBuild instance to use: | ||
|
|
||
| ```csharp | ||
| using Microsoft.Build.Locator; | ||
|
|
||
| // Query available MSBuild instances | ||
| var instances = MSBuildLocator.QueryVisualStudioInstances().ToArray(); | ||
|
|
||
| // Register a specific instance | ||
| var instance = instances.OrderByDescending(i => i.Version).First(); | ||
| MSBuildLocator.RegisterInstance(instance); | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
| For complete documentation, see [Use Microsoft.Build.Locator](https://learn.microsoft.com/visualstudio/msbuild/updating-an-existing-application#use-microsoftbuildlocator) on Microsoft Learn. | ||
|
|
||
| ## Samples | ||
|
|
||
| See the [BuilderApp](https://github.com/microsoft/MSBuildLocator/blob/a349ee7ffd889cd7634d3fd8b413bf9f29244b50/samples/BuilderApp) sample for a full | ||
| exploration of the MSBuildLocator library and capabilities. | ||
|
|
||
|
|
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,25 +1,26 @@ | ||
| <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
| <Target Name="EnsureMSBuildAssembliesNotCopied" AfterTargets="ResolvePackageAssets" Condition="'$(DisableMSBuildAssemblyCopyCheck)' != 'true'"> | ||
| <ItemGroup> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.Build'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.Build.Framework'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.Build.Utilities.Core'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.Build.Tasks.Core'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.Build.Engine'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.Build.Conversion.Core'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.Build.Runtime'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.Build.Localization'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.Build.Engine'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'Microsoft.NET.StringTools'))" /> | ||
| <_MSBuildAssembliesCopyLocalItems Include="@(RuntimeCopyLocalItems->WithMetadataValue('NuGetPackageId', 'NuGet.Frameworks'))" /> | ||
| <MSBuildAssembliesCopyLocalItems Include="@(_MSBuildAssembliesCopyLocalItems->WithMetadataValue('CopyLocal', 'true')->WithMetadataValue('AssetType', 'runtime'))" /> | ||
|
Member
Author
There was a problem hiding this comment. Once we have the candidate set, we can find just the ones that are runtime assets and were copylocal'd. |
||
| <_DistinctMSBuildPackagesReferencedPoorly Include="@(MSBuildAssembliesCopyLocalItems->Metadata('NuGetPackageId')->Distinct())" /> | ||
|
Member
Author
There was a problem hiding this comment. such assets will have the nuget package id and version metadata on them, so we can distinct the IDs easily and make nice error messages. |
||
| </ItemGroup> | ||
|
|
||
| <Error | ||
| Condition="@(_DistinctMSBuildPackagesReferencedPoorly->Count()) > 0" | ||
| Code="MSBL001" | ||
| Text="A PackageReference to the package '%(_DistinctMSBuildPackagesReferencedPoorly.NuGetPackageId)' at version '%(_DistinctMSBuildPackagesReferencedPoorly.NuGetPackageVersion)' is present in this project without ExcludeAssets="runtime" set. This can cause errors at run-time due to MSBuild assembly-loading." | ||
| HelpLink="https://aka.ms/msbuild/locator/diagnostics/MSBL001" | ||
| /> | ||
| </Target> | ||
| </Project> | ||
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.
ResolvePackageAssets creates RuntimeCopyLocalItems for all dependencies, so we have to filter those down to just the ones that came from the MSbuild-related dependencies we want to flag.