Skip to content

Add framework specific environment variables for plugin discovery #2986

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
nkolev92 merged 3 commits into from
Aug 9, 2019
Merged

Add framework specific environment variables for plugin discovery #2986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77cadfc
Add framework specific environment variables for plugin discovery
nkolev92 Aug 6, 2019
8452554
fix the failing unit tests
nkolev92 Aug 7, 2019
bed471e
fix unit tests, cleanup unnecessary files
nkolev92 Aug 9, 2019
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
4 changes: 3 additions & 1 deletion src/NuGet.Core/NuGet.Protocol/Plugins/EnvironmentVariableConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,7 @@ internal static class EnvironmentVariableConstants
internal const string IdleTimeout = "NUGET_PLUGIN_IDLE_TIMEOUT_IN_SECONDS";
internal const string PluginPaths = "NUGET_PLUGIN_PATHS";
internal const string RequestTimeout = "NUGET_PLUGIN_REQUEST_TIMEOUT_IN_SECONDS";
internal const string DesktopPluginPaths = "NUGET_NETFX_PLUGIN_PATHS";
internal const string CorePluginPaths = "NUGET_NETCORE_PLUGIN_PATHS";
}
}
}
11 changes: 9 additions & 2 deletions src/NuGet.Core/NuGet.Protocol/Plugins/PluginManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,8 +304,15 @@ private void Initialize(IEnvironmentVariableReader reader,
{
throw new ArgumentNullException(nameof(pluginFactoryCreator));
}

_rawPluginPaths = reader.GetEnvironmentVariable(EnvironmentVariableConstants.PluginPaths);
#if IS_DESKTOP
_rawPluginPaths = reader.GetEnvironmentVariable(EnvironmentVariableConstants.DesktopPluginPaths);
#else
_rawPluginPaths = reader.GetEnvironmentVariable(EnvironmentVariableConstants.CorePluginPaths);
#endif
if (string.IsNullOrEmpty(_rawPluginPaths))
{
_rawPluginPaths = reader.GetEnvironmentVariable(EnvironmentVariableConstants.PluginPaths);
}

_connectionOptions = ConnectionOptions.CreateDefault(reader);

Expand Down
13 changes: 0 additions & 13 deletions test/NuGet.Core.Tests/NuGet.Credentials.Test/CredentialTestConstants.cs
View file
Open in desktop

This file was deleted.

16 changes: 11 additions & 5 deletions test/NuGet.Core.Tests/NuGet.Credentials.Test/PluginManagerMock.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,16 +194,22 @@ public void Dispose()
private void EnsureAllEnvironmentVariablesAreCalled(string pluginFilePath)
{
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == CredentialTestConstants.PluginPathsEnvironmentVariable)))
It.Is<string>(value => value == EnvironmentVariableConstants.PluginPaths)))
.Returns(pluginFilePath);
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == CredentialTestConstants.PluginRequestTimeoutEnvironmentVariable)))
It.Is<string>(value => value == EnvironmentVariableConstants.CorePluginPaths)))
.Returns((string)null);
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.DesktopPluginPaths)))
.Returns((string)null);
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.RequestTimeout)))
.Returns("RequestTimeout");
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == CredentialTestConstants.PluginIdleTimeoutEnvironmentVariable)))
It.Is<string>(value => value == EnvironmentVariableConstants.IdleTimeout)))
.Returns("IdleTimeout");
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == CredentialTestConstants.PluginHandshakeTimeoutEnvironmentVariable)))
It.Is<string>(value => value == EnvironmentVariableConstants.HandshakeTimeout)))
.Returns("HandshakeTimeout");
}

Expand Down Expand Up @@ -260,4 +266,4 @@ private void EnsureFactorySetupCalls(string pluginFilePath)
.ReturnsAsync(_plugin.Object);
}
}
}
}
17 changes: 11 additions & 6 deletions test/NuGet.Core.Tests/NuGet.Credentials.Test/SecurePluginCredentialProviderBuilderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,17 +129,22 @@ internal PluginManagerBuilderMock(List<KeyValuePair<string, PluginFileState>> pl
var reader = new Mock<IEnvironmentVariableReader>(MockBehavior.Strict);

reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == CredentialTestConstants.PluginPathsEnvironmentVariable)))
It.Is<string>(value => value == EnvironmentVariableConstants.PluginPaths)))
.Returns(string.Join(";", plugins.Select(e => e.Key)));

reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == CredentialTestConstants.PluginRequestTimeoutEnvironmentVariable)))
It.Is<string>(value => value == EnvironmentVariableConstants.CorePluginPaths)))
.Returns((string)null);
reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.DesktopPluginPaths)))
.Returns((string)null);
reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.RequestTimeout)))
.Returns("b");
reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == CredentialTestConstants.PluginIdleTimeoutEnvironmentVariable)))
It.Is<string>(value => value == EnvironmentVariableConstants.IdleTimeout)))
.Returns("c");
reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == CredentialTestConstants.PluginHandshakeTimeoutEnvironmentVariable)))
It.Is<string>(value => value == EnvironmentVariableConstants.HandshakeTimeout)))
.Returns("d");

var pluginDiscoverer = new Mock<IPluginDiscoverer>(MockBehavior.Strict);
Expand Down Expand Up @@ -182,4 +187,4 @@ private PluginManager CreateDefaultPluginManager()
new Lazy<string>(() => _testDirectory.Path));
}
}
}
}
152 changes: 135 additions & 17 deletions test/NuGet.Core.Tests/NuGet.Protocol.Tests/Plugins/PluginManagerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,116 @@ public async Task TryGetSourceAgnosticPluginAsync_WhenCacheFileIndicatesIndicate
}
}

[Theory]
[InlineData(PluginFilePath)]
public async Task PluginManager_CreatePlugin_PrefersFrameworkSpecificEnvironmentVariable(string pluginPath)
{
var operationClaims = new[] { OperationClaim.Authentication };
var mockReader = new Mock<IEnvironmentVariableReader>(MockBehavior.Strict);
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.PluginPaths)))
.Returns("badPluginPath");
#if IS_DESKTOP
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.DesktopPluginPaths)))
.Returns(pluginPath);
#else
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.CorePluginPaths)))
.Returns(pluginPath);
#endif
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.RequestTimeout)))
.Returns("RequestTimeout");
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.IdleTimeout)))
.Returns("IdleTimeout");
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.HandshakeTimeout)))
.Returns("HandshakeTimeout");

using (var test = new PluginManagerTest(pluginPath, PluginFileState.Valid, operationClaims, mockReader))
{
var discoveryResult = new PluginDiscoveryResult(
new PluginFile(
PluginFilePath,
new Lazy<PluginFileState>(() => PluginFileState.Valid)));

Tuple<bool, PluginCreationResult> result = await test.PluginManager.TryGetSourceAgnosticPluginAsync(
discoveryResult,
OperationClaim.Authentication,
CancellationToken.None);
bool wasSomethingCreated = result.Item1;
PluginCreationResult creationResult = result.Item2;

Assert.True(wasSomethingCreated);
Assert.NotNull(creationResult);

Assert.Null(creationResult.Message);
Assert.Null(creationResult.Exception);
Assert.Same(test.Plugin, creationResult.Plugin);
Assert.NotNull(creationResult.PluginMulticlientUtilities);
Assert.Equal(operationClaims, creationResult.Claims);
}
}

[Theory]
[InlineData(PluginFilePath)]
public async Task PluginManager_CreatePlugin_EmptyFrameworkSpecificEnvironmentVariableFallsBackTo(string pluginPath)
{
var operationClaims = new[] { OperationClaim.Authentication };
var mockReader = new Mock<IEnvironmentVariableReader>(MockBehavior.Strict);
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.PluginPaths)))
.Returns(pluginPath);
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.DesktopPluginPaths)))
.Returns(" ");
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.CorePluginPaths)))
.Returns(" ");
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.RequestTimeout)))
.Returns("RequestTimeout");
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.IdleTimeout)))
.Returns("IdleTimeout");
mockReader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.HandshakeTimeout)))
.Returns("HandshakeTimeout");

using (var test = new PluginManagerTest(pluginPath, PluginFileState.Valid, operationClaims, mockReader))
{
var discoveryResult = new PluginDiscoveryResult(
new PluginFile(
PluginFilePath,
new Lazy<PluginFileState>(() => PluginFileState.Valid)));

Tuple<bool, PluginCreationResult> result = await test.PluginManager.TryGetSourceAgnosticPluginAsync(
discoveryResult,
OperationClaim.Authentication,
CancellationToken.None);
bool wasSomethingCreated = result.Item1;
PluginCreationResult creationResult = result.Item2;

Assert.True(wasSomethingCreated);
Assert.NotNull(creationResult);

Assert.Null(creationResult.Message);
Assert.Null(creationResult.Exception);
Assert.Same(test.Plugin, creationResult.Plugin);
Assert.NotNull(creationResult.PluginMulticlientUtilities);
Assert.Equal(operationClaims, creationResult.Claims);
}
}

private sealed class PluginManagerTest : IDisposable
{
private readonly Mock<IConnection> _connection;
private readonly Mock<IPluginFactory> _factory;
private readonly Mock<IPlugin> _plugin;
private readonly Mock<IPluginDiscoverer> _pluginDiscoverer;
private readonly Mock<IEnvironmentVariableReader> _reader;
private readonly string _pluginFilePath;
private readonly TestDirectory _testDirectory;

internal IPlugin Plugin { get; }
Expand All @@ -148,24 +250,38 @@ private sealed class PluginManagerTest : IDisposable
internal PluginManagerTest(
string pluginFilePath,
PluginFileState pluginFileState,
IReadOnlyList<OperationClaim> operationClaims)
IReadOnlyList<OperationClaim> operationClaims,
Mock<IEnvironmentVariableReader> mockEnvironmentVariableReader = null)
{
_pluginFilePath = pluginFilePath;
_reader = new Mock<IEnvironmentVariableReader>(MockBehavior.Strict);
_testDirectory = TestDirectory.Create();

_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.PluginPaths)))
.Returns(pluginFilePath);
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.RequestTimeout)))
.Returns("RequestTimeout");
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.IdleTimeout)))
.Returns("IdleTimeout");
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.HandshakeTimeout)))
.Returns("HandshakeTimeout");
if (mockEnvironmentVariableReader != null)
{
_reader = mockEnvironmentVariableReader;
}
else
{
_reader = new Mock<IEnvironmentVariableReader>(MockBehavior.Strict);

_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.PluginPaths)))
.Returns(pluginFilePath);
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.DesktopPluginPaths)))
.Returns((string)null);
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.CorePluginPaths)))
.Returns((string)null);
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.RequestTimeout)))
.Returns("RequestTimeout");
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.IdleTimeout)))
.Returns("IdleTimeout");
_reader.Setup(x => x.GetEnvironmentVariable(
It.Is<string>(value => value == EnvironmentVariableConstants.HandshakeTimeout)))
.Returns("HandshakeTimeout");
}

_pluginDiscoverer = new Mock<IPluginDiscoverer>(MockBehavior.Strict);

Expand Down Expand Up @@ -244,5 +360,7 @@ public void Dispose()
_factory.Verify();
}
}


}
}
}
Loading