Skip to content

Plugin discovery: make "nuget-plugin-*" plugin pattern matching cases sensitive #6255

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.

Sign up for GitHub

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

Merged
Nigusu-Allehu merged 8 commits into from
Feb 27, 2025
Merged

Plugin discovery: make "nuget-plugin-*" plugin pattern matching cases sensitive #6255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6536741
Plugin discovery: make linux case sensitive
Nigusu-Allehu Feb 5, 2025
da5e800
Cleanup
Nigusu-Allehu Feb 7, 2025
2fac115
assert
Nigusu-Allehu Feb 7, 2025
c05a6f0
Do not assert count
Nigusu-Allehu Feb 7, 2025
cd7c65c
Use PathUtility
Nigusu-Allehu Feb 7, 2025
5850afb
test in !Desktop only
Nigusu-Allehu Feb 8, 2025
6956d47
Case sensitive
Nigusu-Allehu Feb 25, 2025
66db33f
test
Nigusu-Allehu Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions src/NuGet.Core/NuGet.Protocol/Plugins/PluginDiscoverer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,14 +192,11 @@ internal List<PluginFile> GetPluginsInNuGetPluginPaths()
if (File.Exists(path))
{
FileInfo fileInfo = new FileInfo(path);
if (fileInfo.Name.StartsWith("nuget-plugin-", StringComparison.CurrentCultureIgnoreCase))
if (IsValidPluginFile(fileInfo))
{
// A DotNet tool plugin
if (IsValidPluginFile(fileInfo))
{
PluginFile pluginFile = new PluginFile(fileInfo.FullName, new Lazy<PluginFileState>(() => PluginFileState.Valid), requiresDotnetHost: false);
pluginFiles.Add(pluginFile);
}
PluginFile pluginFile = new PluginFile(fileInfo.FullName, new Lazy<PluginFileState>(() => PluginFileState.Valid), requiresDotnetHost: false);
pluginFiles.Add(pluginFile);
}
else
{
Expand Down Expand Up @@ -274,6 +271,11 @@ private static List<PluginFile> GetNetToolsPluginsInDirectory(string directoryPa
/// <returns></returns>
internal static bool IsValidPluginFile(FileInfo fileInfo)
{
if (!fileInfo.Name.StartsWith("nuget-plugin-", StringComparison.Ordinal))
{
return false;
}

if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
return fileInfo.Extension.Equals(".exe", StringComparison.OrdinalIgnoreCase) ||
Expand Down
33 changes: 27 additions & 6 deletions test/NuGet.Core.Tests/NuGet.Protocol.Tests/Plugins/PluginDiscovererTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,13 +519,34 @@ public void GetPluginsInNuGetPluginPaths_NoEnvironmentVariables_ReturnsNoPlugins
Assert.Empty(plugins);
}

[PlatformTheory(Platform.Windows)]
[InlineData("nuget-plugin-auth.exe", true)]
[InlineData("nuget-plugin-AUTH.bat", true)]
[InlineData("nuGet-plugin-auth.exe", false)]
[InlineData("NUGet-PLUGIN-auth.bat", false)]
public void IsValidPlugin_IsCaseSensitive(string file, bool isValid)
{
// Arrange
using TestDirectory testDirectory = TestDirectory.Create();
var workingPath = testDirectory.Path;
var pluginFilePath = Path.Combine(workingPath, file);
File.Create(pluginFilePath);
var fileInfo = new FileInfo(pluginFilePath);

// Act
bool result = PluginDiscoverer.IsValidPluginFile(fileInfo);

// Assert
Assert.Equal(isValid, result);
}

[PlatformFact(Platform.Windows)]
public void IsValidPluginFile_ExeFile_ReturnsTrue()
{
// Arrange
using TestDirectory testDirectory = TestDirectory.Create();
var workingPath = testDirectory.Path;
var pluginFilePath = Path.Combine(workingPath, "plugin.exe");
var pluginFilePath = Path.Combine(workingPath, "nuget-plugin-.exe");
File.Create(pluginFilePath);
var fileInfo = new FileInfo(pluginFilePath);

Expand All @@ -542,7 +563,7 @@ public void IsValidPluginFile_Windows_NonExecutableFile_ReturnsFalse()
// Arrange
using TestDirectory testDirectory = TestDirectory.Create();
var workingPath = testDirectory.Path;
var nonPluginFilePath = Path.Combine(workingPath, "plugin.txt");
var nonPluginFilePath = Path.Combine(workingPath, "nuget-plugin-.txt");
File.Create(nonPluginFilePath);
var fileInfo = new FileInfo(nonPluginFilePath);

Expand All @@ -559,7 +580,7 @@ public void IsValidPluginFile_Unix_ExecutableFile_ReturnsTrue()
// Arrange
using TestDirectory testDirectory = TestDirectory.Create();
var workingPath = testDirectory.Path;
var pluginFilePath = Path.Combine(workingPath, "plugin");
var pluginFilePath = Path.Combine(workingPath, "nuget-plugin-");
File.Create(pluginFilePath).Dispose();

#if NET8_0_OR_GREATER
Expand All @@ -585,7 +606,7 @@ public void IsExecutable_FileIsExecutable_ReturnsTrue()
// Arrange
using TestDirectory testDirectory = TestDirectory.Create();
var workingPath = testDirectory.Path;
var pluginFilePath = Path.Combine(workingPath, "plugin");
var pluginFilePath = Path.Combine(workingPath, "nuget-plugin-");
File.Create(pluginFilePath);

// Set execute permissions
Expand All @@ -606,7 +627,7 @@ public void IsExecutable_FileIsNotExecutable_ReturnsFalse()
// Arrange
using TestDirectory testDirectory = TestDirectory.Create();
var workingPath = testDirectory.Path;
var pluginFilePath = Path.Combine(workingPath, "plugin");
var pluginFilePath = Path.Combine(workingPath, "nuget-plugin-");
File.Create(pluginFilePath);

// Remove execute permissions
Expand All @@ -627,7 +648,7 @@ public void IsExecutable_FileWithSpace_ReturnsTrue()
// Arrange
using TestDirectory testDirectory = TestDirectory.Create();
var workingPath = testDirectory.Path;
var pluginFilePath = Path.Combine(workingPath, "plugin with space");
var pluginFilePath = Path.Combine(workingPath, "nuget-plugin- with space");
File.Create(pluginFilePath).Dispose();

// Set execute permissions
Expand Down