Discover plugins installed using Net tools by Nigusu-Allehu · Pull Request #5990 · NuGet/NuGet.Client

Nigusu-Allehu · 2024-08-24T19:20:23Z

Bug

Description

This PR makes sure NuGet discovers credential providers installed using .NET tools.
dotnet tool install <provider package name> --global should install the tool and add its path to the PATH environmental varibale. Iterate through all the paths in PATH and all the files in the path to find the plugins. By design, we expect these plugins to be named nuget-plugin*.

This PR introduces a new TFM, net8.0, to NuGet.Protocol. The primary reason for adding net8.0 support is to take advantage of newer APIs, specifically File.GetUnixFileMode(fileInfo.FullName), which simplifies handling file permissions in Unix-based systems.

Plugin discovery method

The discovery is done based on which environmental variable has been specified

If NUGET_NETFX_PLUGIN_PATHS or NUGET_NETCORE_PLUGIN_PATHS have been specified, use the old discovery method to look up non dotnet tools plugins in the paths added in the env variable.
If NUGET_NETFX_PLUGIN_PATHS and NUGET_NETCORE_PLUGIN_PATHS have not been specified
- if NUGET_PLUGIN_PATHS specified,
  - Collect the set of plugins the env variable is pointing to: They could be donet tools or non dotnet tools plugin files.
- if NUGET_PLUGIN_PATHS not specified,
  - Discover all plugins using the default discovery method

Default discovery method

For dotnet tools
- Traverse all the directories specified in PATH env variable, and search for executable nuget-plugin-*files
For non dotnet tools
- %UserProfile%/.nuget/plugins

PR Checklist

Meaningful title, helpful description and a linked NuGet/Home issue
Added tests
Link to an issue or pull request to update docs if this PR changes settings, environment variables, new feature, etc. Document .net tools Plugin feature Home#13858

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs

src/NuGet.Core/NuGet.Protocol/NuGet.Protocol.csproj

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs

test/NuGet.Core.Tests/NuGet.Protocol.Tests/Plugins/PluginDiscovererTests.cs

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs

src/NuGet.Core/NuGet.Protocol/NuGet.Protocol.csproj

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs

src/NuGet.Core/NuGet.Protocol/Plugins/PluginManager.cs

src/NuGet.Core/NuGet.Protocol/Plugins/PluginFile.cs

Nigusu-Allehu · 2024-10-08T00:02:30Z

test/NuGet.Core.Tests/NuGet.Protocol.Tests/Plugins/PluginDiscovererTests.cs

+        }
+
+        [PlatformFact(Platform.Windows)]
+        public void GetNetToolsPluginFiles_WithNuGetPluginPaths_ReturnsPluginsInNuGetPluginPathOnly()


Test priority of the discovery methods we have. This test makes sure we prioritize the environmental variables.

kartheekp-ms

Great progress. Left few comments on the new changes proposed.

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs

jgonz120

This looks fine to me. There were a couple of instances where you're checking for null results from private/internal methods which don't return null.

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs

test/NuGet.Core.Tests/NuGet.Protocol.Tests/Plugins/PluginDiscovererTests.cs

kartheekp-ms · 2024-10-22T18:24:58Z

test/NuGet.Core.Tests/NuGet.Protocol.Tests/Plugins/PluginDiscovererTests.cs

+            File.Create(pluginFilePath);
+
+            // Remove execute permissions
+            var process = new Process();


nit: There is an opportunity to refactor here because we set/remove execute permissions for files in all the new tests. I think we can create a private utility method and invoke it from the tests as needed. Please feel free to address it a follow-up issue.

kartheekp-ms · 2024-10-22T20:59:10Z

test/NuGet.Core.Tests/NuGet.Protocol.Tests/Plugins/PluginDiscovererTests.cs

+            process.StartInfo.UseShellExecute = false;
+            process.StartInfo.RedirectStandardOutput = true;
+            process.Start();
+            process.WaitForExit();


Given that Process.WaitForExit waits indefinitely for the process to exit, while addressing this comment you might want to consider this code by changing it to the following:

Assert.True(process.WaitForExit(1000), userMessage: "some string that helps to troubleshoot the issue");

With this approach, the test fails gracefully if the process doesn't complete on time for any unknown reason.

Nigusu-Allehu requested a review from a team as a code owner August 24, 2024 19:20

Nigusu-Allehu marked this pull request as draft August 24, 2024 19:20

Nigusu-Allehu self-assigned this Aug 26, 2024

dotnet-policy-service bot added the Status:No recent activity PRs that have not had any recent activity and will be closed if the label is not removed label Sep 3, 2024

Nigusu-Allehu removed the Status:No recent activity PRs that have not had any recent activity and will be closed if the label is not removed label Sep 3, 2024

Nigusu-Allehu marked this pull request as ready for review September 3, 2024 19:21

zivkan reviewed Sep 3, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

Nigusu-Allehu requested a review from zivkan September 4, 2024 22:56

Nigusu-Allehu added this to the 6.12 milestone Sep 5, 2024

Nigusu-Allehu changed the title ~~Discover Net tools installed plugins~~ Discover plugins installed using Net tools Sep 9, 2024

kartheekp-ms reviewed Sep 10, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/NuGet.Protocol.csproj Outdated Show resolved Hide resolved

zivkan reviewed Sep 10, 2024

View reviewed changes

Nigusu-Allehu requested review from kartheekp-ms and zivkan September 10, 2024 17:59

kartheekp-ms reviewed Sep 11, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

kartheekp-ms reviewed Sep 12, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

kartheekp-ms reviewed Sep 12, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

Nigusu-Allehu requested a review from kartheekp-ms September 12, 2024 18:51

kartheekp-ms reviewed Sep 13, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

kartheekp-ms reviewed Sep 13, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

kartheekp-ms reviewed Sep 13, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

kartheekp-ms reviewed Sep 13, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

Nigusu-Allehu requested a review from kartheekp-ms September 13, 2024 22:26

zivkan reviewed Sep 19, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

nkolev92 added the Merge next release PRs that should not be merged until the dev branch targets the next release label Sep 19, 2024

nkolev92 reviewed Sep 24, 2024

View reviewed changes

nkolev92 removed the Merge next release PRs that should not be merged until the dev branch targets the next release label Sep 27, 2024

Nigusu-Allehu commented Oct 8, 2024

View reviewed changes

Nigusu-Allehu and others added 7 commits October 15, 2024 15:35

Cleanup

704e61d

cleanup

32cab44

dispose directories

8424237

undo

ed12e51

fix netcore test

7466578

Fix linux tests

47f4d5d

Cleanup

3eab1a7

Nigusu-Allehu force-pushed the dev-nyenework-net-tools-plugin branch from 85141d8 to 3eab1a7 Compare October 15, 2024 23:01

clean up test conflict

2a36928

Nigusu-Allehu requested a review from nkolev92 October 15, 2024 23:35

nkolev92 approved these changes Oct 16, 2024

View reviewed changes

kartheekp-ms reviewed Oct 17, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

kartheekp-ms reviewed Oct 17, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

kartheekp-ms reviewed Oct 17, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Show resolved Hide resolved

Nigusu-Allehu added 2 commits October 17, 2024 11:35

Address comments

3f8b8db

Address comments

691c76e

jgonz120 approved these changes Oct 17, 2024

View reviewed changes

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs Outdated Show resolved Hide resolved

Nigusu-Allehu requested a review from kartheekp-ms October 17, 2024 19:30

kartheekp-ms reviewed Oct 21, 2024

View reviewed changes

test/NuGet.Core.Tests/NuGet.Protocol.Tests/Plugins/PluginDiscovererTests.cs Outdated Show resolved Hide resolved

Address comments

6abbc3d

Nigusu-Allehu mentioned this pull request Oct 22, 2024

[DCR]: VS Credential Provider exception messages are not displayed by NuGet in Output/Error List window logs. NuGet/Home#12068

Open

cleanup

7f017a4

kartheekp-ms reviewed Oct 22, 2024

View reviewed changes

kartheekp-ms approved these changes Oct 22, 2024

View reviewed changes

Nigusu-Allehu merged commit 6c1f792 into dev-feature-dot-net-tool-plugin-support Oct 22, 2024

Nigusu-Allehu deleted the dev-nyenework-net-tools-plugin branch October 22, 2024 18:52

kartheekp-ms reviewed Oct 22, 2024

View reviewed changes

Nigusu-Allehu mentioned this pull request Oct 24, 2024

Execute net tools plugins #6113

Merged

3 tasks

Nigusu-Allehu mentioned this pull request Nov 6, 2024

[Feature] Implement Support for NuGet Authentication Plugins as .NET Tools #6138

Merged

3 tasks

Conversation

Nigusu-Allehu commented Aug 24, 2024 • edited by kartheekp-ms Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bug

Description

This PR introduces a new TFM, net8.0, to NuGet.Protocol. The primary reason for adding net8.0 support is to take advantage of newer APIs, specifically File.GetUnixFileMode(fileInfo.FullName), which simplifies handling file permissions in Unix-based systems.

Plugin discovery method

Default discovery method

PR Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Nigusu-Allehu Oct 8, 2024

Choose a reason for hiding this comment

Uh oh!

kartheekp-ms left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jgonz120 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kartheekp-ms Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kartheekp-ms Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Nigusu-Allehu commented Aug 24, 2024 •

edited by kartheekp-ms

Loading

This PR introduces a new TFM, net8.0, to `NuGet.Protocol`. The primary reason for adding net8.0 support is to take advantage of newer APIs, specifically `File.GetUnixFileMode(fileInfo.FullName)`, which simplifies handling file permissions in Unix-based systems.

kartheekp-ms Oct 22, 2024 •

edited

Loading

kartheekp-ms Oct 22, 2024 •

edited

Loading