Provide MSB5009 error with project's name and it's GUID #5835
Conversation
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
The MSB5009 - SolutionParseNestedProjectError has been printed for a certain project but without specifying the project's name or even GUID which was making this issue difficult to debug. To make it more developer/user friendly, the MSB5009 error has been provided with the invalid project's name and GUID embedded in the error message. Message is extended by string arguments separate for ProjectName and ProjectGUID, so from now on it's required to add them as a BuildEventFileInfo constructor arguments. NOTE: Though error message is automaticaly generated for each language, some are still not translated.
The extended MSB5009 error message requires ProjectName and ProjectGuid
as arguments otherwise raw "{0}" will be displayed to the console in
case of error.
The MSB5009 error messsage is used in other places than the one covered
in the extension implementation, so each place using this error has to
be covered with the changes.
NOTE: The only exception is the SolutionFile.ParseNestedProjects() method
which uses the MSB5009 error too, but at the point of calling this error,
there are no project's name nor GUID available to display, so it should
continue to use the original error message string.
To make it possible:
- the original error string has been kept,
- while the extended one has been renamed to
"SolutionParseNestedProjectErrorWithNameAndGuid"
to indicate it's extended content and required arguments
Leaving the MSB5009 error message in the original form for
SolutionFile.ParseNestedProject() method doesn't mean that no
information will be given to developer/user.
Note that it already calls the BuildEventFileInfo constructor with full
path and current line's number, which will ease the debugging in case of
having MSB5009 error.
New unit test covering the enhanced MSB5009 error checks whether: - MSB5009 error is thrown for incorrectly nested project in solution - error contains the name of incorrectly nested project - error contains the GUID of incorrectly nested project NOTE: The solution file used for this unit test is the original solution file given as an example of the original error which these changes fix. Please see: dotnet#4835
There was a problem hiding this comment.
Thanks! Your test did what the other tests around here did, but Shouldly offers us a nicer way to do it, so I pushed a switch to that mechanism.
Including @KathleenDollard for opinions on the error message (in addition to mine).
Forgind
reviewed
Oct 28, 2020
Co-authored-by: Rainer Sigwald <[email protected]>
Forgind
approved these changes
Nov 10, 2020
|
I was just about to deliver the review remarks, but thank you for the commitment! |
|
Thanks, @BartoszKlonowski |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request fixes: #4836
Changes introduced in this delivery extends the MSB5009 with additional information about the incorrectly nested project within the solution. Additional details are:
NOTE: original MSB5009 error is kept in the resources for backward compatibility (see commit messages) while the extended MSB5009 can be easily invoked with extended name.
Changes done in this delivery are:
NOTE:
SolutionFile.ParseNestedProjects()method has the original error kept, as it does specify at least the line of the solution file with the incorrect project. Moreover, at the moment of throwing the error, there's no possibility of getting the name of the project.For more details about each change please see the commit message.
Example
of original MSB5009 error vs the extended version presented below. For both cases the same solution file was used, which is the solution file mentioned before available to get from the original issue.
The original error:
The extended version (the results of this following PR):