-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Add clear error message (MSB4233) for .NET runtime tasks on MSBuild 17.14 #12662
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: vs17.14
Are you sure you want to change the base?
Conversation
|
Hello @@copilot, I noticed that you’re changing an .swr file or any file under src/Package/MSBuild.VSSetup.. Please make sure to validate this change by an experimental VS insertion. This is accomplished by pushing to an exp/* branch, which requires write permissions to this repo. |
baronfel
left a comment
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.
@copilot some things to clean up
| exception.ProjectFile.ShouldBe(projectFile); | ||
| exception.LineNumber.ShouldBe(lineNumber); | ||
| exception.ColumnNumber.ShouldBe(columnNumber); | ||
| exception.ErrorCode.ShouldBe("MSB4233"); | ||
| exception.Message.ShouldContain(taskName); | ||
| exception.Message.ShouldContain(taskLocation); | ||
| exception.Message.ShouldContain(".NET"); | ||
| exception.Message.ShouldContain("MSBuild 18.0"); | ||
| exception.Message.ShouldContain("Visual Studio 2026"); |
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.
for all the test assertions in this file, only the error code, task name, and task location are really important. the rest is synthetic data that's irrelevant.
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.
Simplified the test assertions to only verify the error code (MSB4233), task name, and task location. The other assertions (project file, line number, column number) were testing synthetic data that isn't relevant to this scenario. (commit: 9b5c9eb)
| throw new Exceptions.InvalidProjectFileException( | ||
| configuration.ProjectFileOfTask, | ||
| configuration.LineNumberOfTask, | ||
| configuration.ColumnNumberOfTask, | ||
| 0, | ||
| 0, | ||
| ResourceUtilities.FormatResourceStringIgnoreCodeAndKeyword("TaskRuntimeNET", configuration.TaskName, configuration.TaskLocation), | ||
| null, | ||
| null, | ||
| null); | ||
| } |
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.
we shouldn't be throwing the exception directly - use the helper functions that the rest of the codebase uses for throwing InvalidProjectFile errors
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.
Changed to use ProjectFileErrorUtilities.ThrowInvalidProjectFile helper function instead of directly throwing the exception. This follows the pattern used throughout the codebase and properly constructs the BuildEventFileInfo. (commit: 9b5c9eb)
src/Build/Resources/Strings.resx
Outdated
| </data> | ||
| <data name="TaskRuntimeNET" xml:space="preserve"> | ||
| <value>MSB4233: The task "{0}" from assembly "{1}" was specified to load with the .NET runtime, but this version of MSBuild does not support loading tasks with that runtime. To load .NET tasks, MSBuild 18.0 or Visual Studio 2026 must be used.</value> | ||
| <comment>{StrBegin="MSB4233: "}LOCALIZATION: .NET should not be localized.</comment> |
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.
The {Locked="<content goes here>"} syntax can be used to communicated to localizers that specific terms should not be translated. Use it for the .NET, MSBuild and Visual Studio 2026 tokens.
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.
Added {Locked=".NET"}{Locked="MSBuild"}{Locked="Visual Studio 2026"} to the resource string comment to ensure these terms are not translated by localizers. (commit: 9b5c9eb)
|
@copilot please also add end-to-end tests for the MSBuild CLI and MSBuild API usage that load a Project that consumes a .NET Runtime Task and fails appropriately. You won't be able to run these because they are windows-only, so follow existing patterns for Framework-only end-to-end tests and we can let CI try to verify them. |
Added end-to-end tests for both BuildManager API and MSBuild CLI usage:
(commit: 4c8c0d7) |
|
@copilot compilation is failing on the
If this type actually visible when targeting .NET Framework? |
Yes, The code at line 57 is inside a Can you confirm which commit SHA the failing build is using? The |
|
@copilot remove the NodeProviderOutOfProcTaskHost_Tests - they've served their purpose and we can't directly use the HandshakeOptions type. |
Removed |
|
This is ready for review now - once reviews are good we'll want to take this to VS QB |
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.
Pull Request Overview
Adds a specific error (MSB4233) when a task declares Runtime="NET" on MSBuild 17.14 (.NET Framework build) to replace a previously confusing failure, plus tests validating behavior and localized resource entries.
- Introduces early runtime check in NodeProviderOutOfProcTaskHost.AcquireAndSetUpHost to throw a clear InvalidProjectFile error.
- Adds new resource string (TaskRuntimeNET) with localization placeholders.
- Provides end-to-end API and CLI tests for both failing (.NET runtime task) and succeeding (normal task) scenarios.
Reviewed Changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/MSBuild.UnitTests/DotNetRuntimeTask_CLI_Tests.cs | Adds CLI tests verifying MSB4233 appears for Runtime="NET" and normal tasks still succeed. |
| src/Build/Resources/xlf/Strings.zh-Hant.xlf | Adds localized (untranslated initial) entry for new MSB4233 error. |
| src/Build/Resources/xlf/Strings.zh-Hans.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.tr.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.ru.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.pt-BR.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.pl.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.ko.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.ja.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.it.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.fr.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.es.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.de.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/xlf/Strings.cs.xlf | Adds localized entry for MSB4233 error. |
| src/Build/Resources/Strings.resx | Defines the new TaskRuntimeNET resource string and localization locking comments. |
| src/Build/BackEnd/Components/Communications/NodeProviderOutOfProcTaskHost.cs | Adds runtime flag check and throws MSB4233 before host launch. |
| src/Build.UnitTests/BackEnd/DotNetRuntimeTask_EndToEnd_Tests.cs | Adds BuildManager and ProjectInstance API tests for MSB4233 behavior and success path. |
src/Build.UnitTests/BackEnd/DotNetRuntimeTask_EndToEnd_Tests.cs
Outdated
Show resolved
Hide resolved
src/Build.UnitTests/BackEnd/DotNetRuntimeTask_EndToEnd_Tests.cs
Outdated
Show resolved
Hide resolved
- Added MSB4233 error code reference in comment - Clarified that .NET Core/5+ MSBuild (18.0+) supports .NET runtime tasks - Explained that this prevents confusing "MSBuild.dll not found" error Co-authored-by: baronfel <[email protected]>
- Simplify test assertions to only check error code, task name, and task location - Use ProjectFileErrorUtilities.ThrowInvalidProjectFile helper instead of direct exception throw - Add Locked syntax for .NET, MSBuild, and Visual Studio 2026 in resource string Co-authored-by: baronfel <[email protected]>
- Add BuildManager API tests in DotNetRuntimeTask_EndToEnd_Tests.cs - Add MSBuild CLI tests in DotNetRuntimeTask_CLI_Tests.cs - Tests verify MSB4233 error is shown with clear message - Tests use WindowsFullFrameworkOnlyFact since feature is Framework-only - Tests follow existing patterns and will run in CI on Windows Co-authored-by: baronfel <[email protected]>
The unit tests in NodeProviderOutOfProcTaskHost_Tests.cs directly used the internal HandshakeOptions type, which caused compilation issues in multi-targeting scenarios. The end-to-end tests in DotNetRuntimeTask_EndToEnd_Tests.cs and DotNetRuntimeTask_CLI_Tests.cs provide sufficient coverage for the MSB4233 error handling without requiring direct access to internal types. Co-authored-by: baronfel <[email protected]>
Remove #nullable disable directive from DotNetRuntimeTask_EndToEnd_Tests.cs and DotNetRuntimeTask_CLI_Tests.cs to enable nullable reference type checking. Co-authored-by: baronfel <[email protected]>
Co-authored-by: Rainer Sigwald <[email protected]>
- Update comment in NodeProviderOutOfProcTaskHost.cs to clarify version (18.0+) - Remove redundant tests that don't add value: - BuildManager_WithoutDotNetRuntime_Succeeds - ProjectInstance_WithDotNetRuntimeTask_ShowsClearError - MSBuildCLI_WithoutDotNetRuntime_Succeeds - Keep only the essential test that verifies MSB4233 error for Runtime="NET" tasks Co-authored-by: baronfel <[email protected]>
- Remove custom task building code from MSBuildCLI_WithDotNetRuntimeTask_ShowsClearError - Use ProcessIdTask from Microsoft.Build.Engine.UnitTests assembly (same as EndToEnd test) - Remove unused System.IO using statement - Test is now simpler, faster, and consistent with the EndToEnd test Co-authored-by: rainersigwald <[email protected]>
- Change UsingTask to use AssemblyFile with the actual path to ProcessIdTask assembly - Get path using typeof(ProcessIdTask).Assembly.Location - This ensures MSBuild CLI can locate the task without relying on assembly resolution - Add System using statement for typeof Co-authored-by: rainersigwald <[email protected]>
- Remove direct typeof(ProcessIdTask) reference that caused CS0234 error - Construct path to Microsoft.Build.Engine.UnitTests.dll dynamically at runtime - Use Assembly.GetExecutingAssembly().Location and Path.Combine - Add necessary using statements (System.IO, System.Reflection) - This avoids compile-time dependency on ProcessIdTask type Co-authored-by: YuliiaKovalova <[email protected]>
f9d9b3e to
e9715d0
Compare
|
@copilot fix the issue |
…ror-message-for-net-tasks
…al variable Extract logger.Errors[0].Message to a local variable before calling ShouldContain to resolve CS8604 nullable reference warning. The variable assignment ensures the null-state analysis understands the value is not null. Co-authored-by: YuliiaKovalova <[email protected]>
Fixed the nullable reference warning by extracting |
|
@copilot I see other issues |
- Add null-forgiving operator and ShouldNotBeNull assertion for error message - This resolves CS8600 and CS8604 nullable reference warnings - Tests now properly handle nullable string from logger.Errors[0].Message Co-authored-by: YuliiaKovalova <[email protected]>
|
@copilot the test fails with Project "C:\Users\VssAdministrator\AppData\Local\Temp\wcxc1rpv.cs3\MSBuildTemp\Temporary138a2b57c7794ffe8000debafd185ea1\test.proj" on node 1 (TestTask target(s)). Build FAILED. "C:\Users\VssAdministrator\AppData\Local\Temp\wcxc1rpv.cs3\MSBuildTemp\Temporary138a2b57c7794ffe8000debafd185ea1\test.proj" (TestTask target) (1) -> Time Elapsed 00:00:00.43 ============== |
The test was failing because it tried to load the assembly from the wrong directory. Now it properly navigates to the sibling Microsoft.Build.Engine.UnitTests output directory to find the DLL. Co-authored-by: YuliiaKovalova <[email protected]>
Fixed the assembly path construction in the CLI test. The test was looking for |

Summary
This PR adds a clear error message (MSB4233) when users try to use tasks with
Runtime="NET"on MSBuild 17.14 (.NET Framework), which doesn't support .NET runtime tasks.Changes
NodeProviderOutOfProcTaskHost.AcquireAndSetUpHost()to detectHandshakeOptions.NETflagInvalidProjectFileExceptionwith clear error message (MSB4233) before attempting to launch task host#if NETFRAMEWORKsince .NET Core/5+ builds (18.0+) support .NET runtime tasksTesting
WindowsFullFrameworkOnlyFactand will run in CI on WindowsFixes #12661
Original prompt
Fixes #12661
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.