// Return true if there are any matches, false otherwise.
private async Task <bool> SearchForTemplateMatchesAsync()
{
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(_environment, _commandInput, _defaultLanguage);
SearchResults searchResults = await searchCoordinator.SearchAsync();
if (searchResults.AnySources)
{
// Only show the searching online message if there are sources to search.
// It's a bit out of order to do the search first, then display the message.
// But there's no way to know whether or not there are sources without searching.
// ...theoretically the search source initialization is separate from the search, but the initialization is most of the work.
Reporter.Output.WriteLine(LocalizableStrings.SearchingOnlineNotification.Bold().Red());
}
else
{
return(false);
}
foreach (TemplateSourceSearchResult sourceResult in searchResults.MatchesBySource)
{
string sourceHeader = string.Format(LocalizableStrings.SearchResultSourceIndicator, sourceResult.SourceDisplayName);
Reporter.Output.WriteLine(sourceHeader);
Reporter.Output.WriteLine(new string('-', sourceHeader.Length));
foreach (TemplatePackSearchResult matchesForPack in sourceResult.PacksWithMatches.Values)
{
DisplayResultsForPack(matchesForPack);
Reporter.Output.WriteLine();
}
}
return(searchResults.MatchesBySource.Count > 0);
}
#pragma warning restore xUnit1004 // Test methods should not be skipped
public async Task CacheSkipInvalidTemplatesTest()
{
string cacheLocation = TestUtils.CreateTemporaryFolder();
string v2FileLocation = SetupInvalidTemplateCache(cacheLocation);
var environment = A.Fake <IEnvironment>();
var engineEnvironmentSettings = _environmentSettingsHelper.CreateEnvironment(hostIdentifier: this.GetType().Name, virtualize: true, environment: environment);
var templatePackageManager = new TemplatePackageManager(engineEnvironmentSettings);
engineEnvironmentSettings.Components.AddComponent(typeof(ITemplateSearchProviderFactory), new NuGetMetadataSearchProviderFactory());
NewCommand myCommand = (NewCommand)NewCommandFactory.Create("new", _ => engineEnvironmentSettings.Host, _ => new TelemetryLogger(null, false), new NewCommandCallbacks());
var parseResult = myCommand.Parse($"new search --unknown");
SearchCommandArgs args = new SearchCommandArgs((SearchCommand)parseResult.CommandResult.Command, parseResult);
var templatePackages = await templatePackageManager.GetManagedTemplatePackagesAsync(false, default).ConfigureAwait(false);
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(engineEnvironmentSettings);
CliSearchFiltersFactory factory = new CliSearchFiltersFactory(templatePackages);
A.CallTo(() => environment.GetEnvironmentVariable("DOTNET_NEW_SEARCH_FILE_OVERRIDE")).Returns(v2FileLocation);
var searchResults = await searchCoordinator.SearchAsync(
factory.GetPackFilter(args),
CliSearchFiltersFactory.GetMatchingTemplatesFilter(args),
default).ConfigureAwait(false);
Assert.Equal(1, searchResults.Count);
Assert.Single(searchResults, result => result.Provider.Factory.DisplayName == "NuGet.org");
var nugetSearchResults = searchResults.Single(result => result.Provider.Factory.DisplayName == "NuGet.org");
Assert.Equal(0, nugetSearchResults.SearchHits.Count);
}
public async Task CacheSearchCliSymbolNameFilterTest()
{
TemplateDiscoveryMetadata mockTemplateDiscoveryMetadata = SetupDiscoveryMetadata(true);
MockCliNuGetMetadataSearchSource.SetupMockData(mockTemplateDiscoveryMetadata);
_engineEnvironmentSettings.SettingsLoader.Components.Register(typeof(MockCliNuGetMetadataSearchSource));
INewCommandInput commandInput = new MockNewCommandInput("foo").WithTemplateOption("framework", "netcoreapp2.0");
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(_engineEnvironmentSettings, commandInput, DefaultLanguage);
SearchResults searchResults = await searchCoordinator.SearchAsync().ConfigureAwait(false);
Assert.True(searchResults.AnySources);
Assert.Equal(1, searchResults.MatchesBySource.Count);
Assert.Equal(1, searchResults.MatchesBySource[0].PacksWithMatches.Count);
Assert.Single(searchResults.MatchesBySource[0].PacksWithMatches[_packTwoInfo].TemplateMatches.Where(t => string.Equals(t.Info.Name, _fooTwoTemplate.Name)));
INewCommandInput shortNameCommandInput = new MockNewCommandInput("foo").WithTemplateOption("f", "netcoreapp2.0");
TemplateSearchCoordinator shortNameSearchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(_engineEnvironmentSettings, shortNameCommandInput, DefaultLanguage);
SearchResults shortNameSearchResults = await searchCoordinator.SearchAsync().ConfigureAwait(false);
Assert.True(shortNameSearchResults.AnySources);
Assert.Equal(1, shortNameSearchResults.MatchesBySource.Count);
Assert.Equal(1, shortNameSearchResults.MatchesBySource[0].PacksWithMatches.Count);
Assert.Single(shortNameSearchResults.MatchesBySource[0].PacksWithMatches[_packTwoInfo].TemplateMatches.Where(t => string.Equals(t.Info.Name, _fooTwoTemplate.Name)));
}
public async Task CacheSearchPackageFilterTest(string commandTemplate, string commandPackage, int packMatchCount, int templateMatchCount)
{
TemplateDiscoveryMetadata mockTemplateDiscoveryMetadata = SetupDiscoveryMetadata(false);
MockCliNuGetMetadataSearchSource.SetupMockData(mockTemplateDiscoveryMetadata);
EngineEnvironmentSettings.SettingsLoader.Components.Register(typeof(MockCliNuGetMetadataSearchSource));
Dictionary <string, string> rawCommandInputs = new Dictionary <string, string>();
MockNewCommandInput commandInput = new MockNewCommandInput(rawCommandInputs)
{
TemplateName = commandTemplate,
PackageFilter = commandPackage
};
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(EngineEnvironmentSettings, commandInput, DefaultLanguage);
SearchResults searchResults = await searchCoordinator.SearchAsync();
Assert.True(searchResults.AnySources);
if (packMatchCount == 0)
{
Assert.Equal(0, searchResults.MatchesBySource.Count);
}
else
{
Assert.Equal(1, searchResults.MatchesBySource.Count);
Assert.Equal(packMatchCount, searchResults.MatchesBySource[0].PacksWithMatches.Count);
Assert.Equal(templateMatchCount, searchResults.MatchesBySource[0].PacksWithMatches[_packThreeInfo].TemplateMatches.Count);
}
}
public async Task CacheSearchLanguageMismatchFilterTest()
{
TemplateDiscoveryMetadata mockTemplateDiscoveryMetadata = SetupDiscoveryMetadata(false);
MockCliNuGetMetadataSearchSource.SetupMockData(mockTemplateDiscoveryMetadata);
_engineEnvironmentSettings.SettingsLoader.Components.Register(typeof(MockCliNuGetMetadataSearchSource));
MockNewCommandInput commandInput = new MockNewCommandInput("bar", "VB");
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(_engineEnvironmentSettings, commandInput, DefaultLanguage);
SearchResults searchResults = await searchCoordinator.SearchAsync().ConfigureAwait(false);
Assert.True(searchResults.AnySources);
Assert.Equal(0, searchResults.MatchesBySource.Count);
}
public async Task CacheSearchCliSymbolNameMismatchFilterTest()
{
TemplateDiscoveryMetadata mockTemplateDiscoveryMetadata = SetupDiscoveryMetadata(true);
MockCliNuGetMetadataSearchSource.SetupMockData(mockTemplateDiscoveryMetadata);
_engineEnvironmentSettings.SettingsLoader.Components.Register(typeof(MockCliNuGetMetadataSearchSource));
// "tfm" is not a vaild symbol for the "foo" template. So it should not match.
INewCommandInput commandInput = new MockNewCommandInput("foo").WithTemplateOption("tfm", "netcoreapp2.0");
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(_engineEnvironmentSettings, commandInput, DefaultLanguage);
SearchResults searchResults = await searchCoordinator.SearchAsync().ConfigureAwait(false);
Assert.True(searchResults.AnySources);
Assert.Equal(0, searchResults.MatchesBySource.Count);
}
public async Task CacheSearchLanguageFilterTest()
{
TemplateDiscoveryMetadata mockTemplateDiscoveryMetadata = SetupDiscoveryMetadata(false);
MockCliNuGetMetadataSearchSource.SetupMockData(mockTemplateDiscoveryMetadata);
_engineEnvironmentSettings.SettingsLoader.Components.Register(typeof(MockCliNuGetMetadataSearchSource));
Dictionary <string, string> rawCommandInputs = new Dictionary <string, string>();
MockNewCommandInput commandInput = new MockNewCommandInput("bar", "F#");
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(_engineEnvironmentSettings, commandInput, DefaultLanguage);
SearchResults searchResults = await searchCoordinator.SearchAsync().ConfigureAwait(false);
Assert.True(searchResults.AnySources);
Assert.Equal(1, searchResults.MatchesBySource.Count);
Assert.Equal(1, searchResults.MatchesBySource[0].PacksWithMatches.Count);
Assert.Single(searchResults.MatchesBySource[0].PacksWithMatches[_packThreeInfo].TemplateMatches.Where(t => string.Equals(t.Info.Name, _barFSharpTemplate.Name)));
}
public async Task CacheSearchNameMatchTest()
{
TemplateDiscoveryMetadata mockTemplateDiscoveryMetadata = SetupDiscoveryMetadata(false);
MockCliNuGetMetadataSearchSource.SetupMockData(mockTemplateDiscoveryMetadata);
EngineEnvironmentSettings.SettingsLoader.Components.Register(typeof(MockCliNuGetMetadataSearchSource));
INewCommandInput commandInput = new MockNewCommandInput("foo");
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(EngineEnvironmentSettings, commandInput, DefaultLanguage);
SearchResults searchResults = await searchCoordinator.SearchAsync();
Assert.True(searchResults.AnySources);
Assert.Equal(1, searchResults.MatchesBySource.Count);
Assert.Equal(2, searchResults.MatchesBySource[0].PacksWithMatches.Count);
Assert.Single(searchResults.MatchesBySource[0].PacksWithMatches[_packOneInfo].TemplateMatches.Where(t => string.Equals(t.Info.Name, _fooOneTemplate.Name)));
Assert.Single(searchResults.MatchesBySource[0].PacksWithMatches[_packTwoInfo].TemplateMatches.Where(t => string.Equals(t.Info.Name, _fooTwoTemplate.Name)));
}
public async Task CacheSearchCliSymbolNameFilterTest()
{
TemplateDiscoveryMetadata mockTemplateDiscoveryMetadata = SetupDiscoveryMetadata(true);
MockCliNuGetMetadataSearchSource.SetupMockData(mockTemplateDiscoveryMetadata);
EngineEnvironmentSettings.SettingsLoader.Components.Register(typeof(MockCliNuGetMetadataSearchSource));
// The template symbol is "Framework" (capital "F"). This checks that the host specific override is applied
Dictionary <string, string> rawCommandInputs = new Dictionary <string, string>()
{
{ "framework", "netcoreapp2.0" }
};
INewCommandInput commandInput = new MockNewCommandInput(rawCommandInputs)
{
TemplateName = "foo"
};
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(EngineEnvironmentSettings, commandInput, DefaultLanguage);
SearchResults searchResults = await searchCoordinator.SearchAsync();
Assert.True(searchResults.AnySources);
Assert.Equal(1, searchResults.MatchesBySource.Count);
Assert.Equal(1, searchResults.MatchesBySource[0].PacksWithMatches.Count);
Assert.Single(searchResults.MatchesBySource[0].PacksWithMatches[_packTwoInfo].TemplateMatches.Where(t => string.Equals(t.Info.Name, _fooTwoTemplate.Name)));
// same check, except with the short version of Framework, namely "f"
Dictionary <string, string> shortNameCheckRawCommandInputs = new Dictionary <string, string>()
{
{ "f", "netcoreapp2.0" }
};
INewCommandInput shortNameCommandInput = new MockNewCommandInput(shortNameCheckRawCommandInputs)
{
TemplateName = "foo"
};
TemplateSearchCoordinator shortNameSearchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(EngineEnvironmentSettings, shortNameCommandInput, DefaultLanguage);
SearchResults shortNameSearchResults = await searchCoordinator.SearchAsync();
Assert.True(shortNameSearchResults.AnySources);
Assert.Equal(1, shortNameSearchResults.MatchesBySource.Count);
Assert.Equal(1, shortNameSearchResults.MatchesBySource[0].PacksWithMatches.Count);
Assert.Single(shortNameSearchResults.MatchesBySource[0].PacksWithMatches[_packTwoInfo].TemplateMatches.Where(t => string.Equals(t.Info.Name, _fooTwoTemplate.Name)));
}
public async Task CacheSearchTagFilterTest(string commandTemplate, string commandTag, int packMatchCount, int templateMatchCount)
{
string cacheLocation = TestUtils.CreateTemporaryFolder();
string v1FileLocation = SetupDiscoveryMetadata(cacheLocation, false);
string v2FileLocation = SetupTemplateCache(cacheLocation, false);
var environment = A.Fake <IEnvironment>();
var engineEnvironmentSettings = _environmentSettingsHelper.CreateEnvironment(
virtualize: true,
environment: environment,
additionalComponents: BuiltInTemplatePackagesProviderFactory.GetComponents(includeTestTemplates: false));
var templatePackageManager = new TemplatePackageManager(engineEnvironmentSettings);
engineEnvironmentSettings.Components.AddComponent(typeof(ITemplateSearchProviderFactory), new NuGetMetadataSearchProviderFactory());
NewCommand myCommand = (NewCommand)NewCommandFactory.Create("new", _ => engineEnvironmentSettings.Host, _ => new TelemetryLogger(null, false), new NewCommandCallbacks());
var parseResult = myCommand.Parse($"new search {commandTemplate} --tag {commandTag}");
SearchCommandArgs args = new SearchCommandArgs((SearchCommand)parseResult.CommandResult.Command, parseResult);
var templatePackages = await templatePackageManager.GetManagedTemplatePackagesAsync(false, default).ConfigureAwait(false);
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(engineEnvironmentSettings);
CliSearchFiltersFactory factory = new CliSearchFiltersFactory(templatePackages);
foreach (var location in new[] { v1FileLocation, v2FileLocation })
{
A.CallTo(() => environment.GetEnvironmentVariable("DOTNET_NEW_SEARCH_FILE_OVERRIDE")).Returns(location);
var searchResults = await searchCoordinator.SearchAsync(
factory.GetPackFilter(args),
CliSearchFiltersFactory.GetMatchingTemplatesFilter(args),
default).ConfigureAwait(false);
Assert.Equal(1, searchResults.Count);
Assert.Single(searchResults, result => result.Provider.Factory.DisplayName == "NuGet.org");
var nugetSearchResults = searchResults.Single(result => result.Provider.Factory.DisplayName == "NuGet.org");
Assert.Equal(packMatchCount, nugetSearchResults.SearchHits.Count);
if (packMatchCount != 0)
{
Assert.Equal(templateMatchCount, nugetSearchResults.SearchHits.Sum(res => res.MatchedTemplates.Count));
}
}
}
public async Task CacheSearchTypeFilterTest(string commandTemplate, string commandType, int matchCount)
{
TemplateDiscoveryMetadata mockTemplateDiscoveryMetadata = SetupDiscoveryMetadata(false);
MockCliNuGetMetadataSearchSource.SetupMockData(mockTemplateDiscoveryMetadata);
_engineEnvironmentSettings.SettingsLoader.Components.Register(typeof(MockCliNuGetMetadataSearchSource));
MockNewCommandInput commandInput = new MockNewCommandInput(commandTemplate, type: commandType);
TemplateSearchCoordinator searchCoordinator = CliTemplateSearchCoordinatorFactory.CreateCliTemplateSearchCoordinator(_engineEnvironmentSettings, commandInput, DefaultLanguage);
SearchResults searchResults = await searchCoordinator.SearchAsync().ConfigureAwait(false);
Assert.True(searchResults.AnySources);
if (matchCount == 0)
{
Assert.Equal(0, searchResults.MatchesBySource.Count);
}
else
{
Assert.Equal(1, searchResults.MatchesBySource.Count);
Assert.Equal(matchCount, searchResults.MatchesBySource[0].PacksWithMatches.Count);
}
}