Support for processing metaproj references from a solution file #1259
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| // Copyright (c) .NET Foundation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using Microsoft.Build.Framework; | ||
| using Microsoft.Build.Utilities; | ||
|
|
||
| namespace NuGet.Build.Tasks | ||
| { | ||
| /// <summary> | ||
| /// Convert .metaproj paths to project paths. | ||
| /// </summary> | ||
| public class GetRestoreSolutionProjectsTask : Task | ||
| { | ||
| private const string MetaProjExtension = ".metaproj"; | ||
|
|
||
| /// <summary> | ||
| /// Solution project references. | ||
| /// </summary> | ||
| [Required] | ||
| public ITaskItem[] ProjectReferences { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Root path used for resolving the absolute project paths. | ||
| /// </summary> | ||
| [Required] | ||
| public string SolutionFilePath { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Output items | ||
| /// </summary> | ||
| [Output] | ||
| public ITaskItem[] OutputProjectReferences { get; set; } | ||
|
|
||
| public override bool Execute() | ||
| { | ||
| // Log inputs | ||
| var log = new MSBuildLogger(Log); | ||
| log.LogDebug($"(in) ProjectReferences '{string.Join(";", ProjectReferences.Select(p => p.ItemSpec))}'"); | ||
| log.LogDebug($"(in) SolutionFilePath '{SolutionFilePath}'"); | ||
|
|
||
| var entries = new List<ITaskItem>(); | ||
| var parentDirectory = Path.GetDirectoryName(SolutionFilePath); | ||
|
|
||
| foreach (var project in ProjectReferences) | ||
| { | ||
| if (string.IsNullOrEmpty(project.ItemSpec)) | ||
|
There was a problem hiding this comment. Should it fail or warn on invalid value? There was a problem hiding this comment. It should not be, but if it is the error/warning would be very unhelpful since it would not refer to anything. This protects against that. |
||
| { | ||
| continue; | ||
| } | ||
|
|
||
| var projectPath = Path.GetFullPath(Path.Combine(parentDirectory, project.ItemSpec)); | ||
|
|
||
| // Check for the metaproj extension, this is auto generated by solutions instead of | ||
| // the actual project path when build order is set. For the purpose of restore | ||
| // the order is not important so we remove the extension to get the real project path. | ||
| if (projectPath.EndsWith(MetaProjExtension, StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| // Remove .metaproj from the path. | ||
| projectPath = projectPath.Substring(0, projectPath.Length - MetaProjExtension.Length); | ||
|
There was a problem hiding this comment. can you instead do Path.Combine(Path.GetDirectoryName(file), Path.GetFileNameWithoutExtension(file) ) There was a problem hiding this comment. I did that initially but simplified to this. We know here exactly what needs to happen, an extra helper isn't needed. There was a problem hiding this comment. Either way would work fine though There was a problem hiding this comment. i'd prefer being more verbose and call the helpers but your call. In reply to: 107747427 [](ancestors = 107747427) |
||
| } | ||
|
|
||
| // Clone items using the modified path | ||
| var newEntry = new TaskItem(projectPath, project.CloneCustomMetadata()); | ||
| entries.Add(newEntry); | ||
| } | ||
|
|
||
| OutputProjectReferences = entries.ToArray(); | ||
|
|
||
| return true; | ||
| } | ||
| } | ||
| } | ||
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
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.
Can
ItemSpecbe null or empty?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 can't be 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.
Then it's inconsistent with line 50 where you check the same value for 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.
It checks for empty also