Add testData parameter to package list and V2 autocomplete (#8211)

joelverhagen · web-flow · commit 8159753f388f · 2020-09-18T11:02:48.000-07:00
Related to #8172
diff --git a/src/NuGetGallery/Controllers/ApiController.cs b/src/NuGetGallery/Controllers/ApiController.cs
@@ -1018,11 +1018,16 @@ protected internal virtual Stream ReadPackageFromRequest()
         public virtual async Task<ActionResult> GetPackageIds(
             string partialId,
             bool? includePrerelease,
+            bool? testData,
             string semVerLevel = null)
         {
             return new JsonResult
             {
-                Data = await _autocompletePackageIdsQuery.Execute(partialId, includePrerelease, semVerLevel),
+                Data = await _autocompletePackageIdsQuery.Execute(
+                    partialId,
+                    includePrerelease,
+                    testData,
+                    semVerLevel),
                 JsonRequestBehavior = JsonRequestBehavior.AllowGet
             };
         }
@@ -1032,11 +1037,16 @@ public virtual async Task<ActionResult> GetPackageIds(
         public virtual async Task<ActionResult> GetPackageVersions(
             string id,
             bool? includePrerelease,
+            bool? testData,
             string semVerLevel = null)
         {
             return new JsonResult
             {
-                Data = await _autocompletePackageVersionsQuery.Execute(id, includePrerelease, semVerLevel),
+                Data = await _autocompletePackageVersionsQuery.Execute(
+                    id,
+                    includePrerelease,
+                    testData,
+                    semVerLevel),
                 JsonRequestBehavior = JsonRequestBehavior.AllowGet
             };
         }
diff --git a/src/NuGetGallery/Controllers/PackagesController.cs b/src/NuGetGallery/Controllers/PackagesController.cs
@@ -949,7 +949,8 @@ public virtual async Task<ActionResult> DisplayPackage(string id, string version
                             packageType: null,
                             sortOrder: null,
                             context: SearchFilter.ODataSearchContext,
-                            semVerLevel: SemVerLevelKey.SemVerLevel2);
+                            semVerLevel: SemVerLevelKey.SemVerLevel2,
+                            includeTestData: true);
 
                         searchFilter.IncludeAllVersions = true;
 
@@ -1147,6 +1148,7 @@ public virtual async Task<ActionResult> ListPackages(PackageListSearchViewModel
             var page = searchAndListModel.Page;
             var q = searchAndListModel.Q;
             var includePrerelease = searchAndListModel.Prerel ?? true;
+            var includeTestData = searchAndListModel.TestData ?? false;
 
             if (page < 1)
             {
@@ -1203,7 +1205,8 @@ public virtual async Task<ActionResult> ListPackages(PackageListSearchViewModel
                         packageType: searchAndListModel.PackageType,
                         sortOrder: searchAndListModel.SortBy,
                         context: SearchFilter.UISearchContext,
-                        semVerLevel: SemVerLevelKey.SemVerLevel2);
+                        semVerLevel: SemVerLevelKey.SemVerLevel2,
+                        includeTestData: includeTestData);
 
                     results = await searchService.Search(searchFilter);
 
@@ -1231,7 +1234,8 @@ public virtual async Task<ActionResult> ListPackages(PackageListSearchViewModel
                     packageType: searchAndListModel.PackageType,
                     sortOrder: searchAndListModel.SortBy,
                     context: SearchFilter.UISearchContext,
-                    semVerLevel: SemVerLevelKey.SemVerLevel2);
+                    semVerLevel: SemVerLevelKey.SemVerLevel2,
+                    includeTestData: includeTestData);
 
                 results = await searchService.Search(searchFilter);
             }
diff --git a/src/NuGetGallery/Infrastructure/Lucene/ExternalSearchService.cs b/src/NuGetGallery/Infrastructure/Lucene/ExternalSearchService.cs
@@ -3,7 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Linq;
 using System.Threading.Tasks;
 using System.Web;
@@ -71,7 +70,8 @@ private async Task<SearchResults> SearchCore(SearchFilter filter, bool raw)
                 explain: false,
                 getAllVersions: filter.IncludeAllVersions,
                 supportedFramework: filter.SupportedFramework,
-                semVerLevel: filter.SemVerLevel);
+                semVerLevel: filter.SemVerLevel,
+                includeTestData: filter.IncludeTestData);
 
             SearchResults results = null;
             if (result.IsSuccessStatusCode)
diff --git a/src/NuGetGallery/Infrastructure/Lucene/GallerySearchClient.cs b/src/NuGetGallery/Infrastructure/Lucene/GallerySearchClient.cs
@@ -58,7 +58,8 @@ public async Task<ServiceResponse<JObject>> GetDiagnostics()
             bool explain = false,
             bool getAllVersions = false,
             string supportedFramework = null,
-            string semVerLevel = null)
+            string semVerLevel = null,
+            bool includeTestData = false)
         {
             IDictionary<string, string> nameValue = new Dictionary<string, string>();
             nameValue.Add("q", query);
@@ -110,6 +111,11 @@ public async Task<ServiceResponse<JObject>> GetDiagnostics()
                 nameValue.Add("countOnly", "true");
             }
 
+            if (includeTestData)
+            {
+                nameValue.Add("testData", "true");
+            }
+
             var qs = new FormUrlEncodedContent(nameValue);
             var queryString = await qs.ReadAsStringAsync();
 
diff --git a/src/NuGetGallery/Infrastructure/Lucene/ISearchClient.cs b/src/NuGetGallery/Infrastructure/Lucene/ISearchClient.cs
@@ -24,6 +24,7 @@ public interface ISearchClient
         /// <param name="getAllVersions">GetAllVersions</param>
         /// <param name="supportedFramework">SupportedFramework</param>
         /// <param name="semVerLevel">SemVerLevel</param>
+        /// <param name="includeTestData">Whether or not to include test data in the results.</param>
         /// <returns></returns>
         Task<ServiceResponse<SearchModels.SearchResults>> Search(
             string query,
@@ -38,7 +39,8 @@ public interface ISearchClient
             bool explain,
             bool getAllVersions,
             string supportedFramework,
-            string semVerLevel);
+            string semVerLevel,
+            bool includeTestData);
 
         /// <summary>
         /// Returns the search diag.
diff --git a/src/NuGetGallery/OData/SearchService/SearchAdaptor.cs b/src/NuGetGallery/OData/SearchService/SearchAdaptor.cs
@@ -39,7 +39,15 @@ public static class SearchAdaptor
             { GalleryConstants.SearchSortNames.TotalDownloadsDesc, SortOrder.TotalDownloadsDescending },
         };
 
-        public static SearchFilter GetSearchFilter(string q, int page, bool includePrerelease, string packageType, string sortOrder, string context, string semVerLevel)
+        public static SearchFilter GetSearchFilter(
+            string q,
+            int page,
+            bool includePrerelease,
+            string packageType,
+            string sortOrder,
+            string context,
+            string semVerLevel,
+            bool includeTestData)
         {
             page = page < 1 ? 1 : page; // pages are 1-based. 
             packageType = packageType ?? string.Empty;
@@ -52,6 +60,7 @@ public static SearchFilter GetSearchFilter(string q, int page, bool includePrere
                 IncludePrerelease = includePrerelease,
                 SemVerLevel = semVerLevel,
                 PackageType = packageType,
+                IncludeTestData = includeTestData,
             };
 
             if (sortOrder == null || !SortOrders.TryGetValue(sortOrder, out var sortOrderValue))
diff --git a/src/NuGetGallery/Queries/AutocompleteDatabasePackageIdsQuery.cs b/src/NuGetGallery/Queries/AutocompleteDatabasePackageIdsQuery.cs
@@ -23,6 +23,7 @@ public AutocompleteDatabasePackageIdsQuery(IReadOnlyEntityRepository<Package> pa
         public Task<IReadOnlyList<string>> Execute(
             string partialId,
             bool? includePrerelease = false,
+            bool? includeTestData = false, // ignored on this implementation
             string semVerLevel = null)
         {
             var query = _packageRepository.GetAll()
diff --git a/src/NuGetGallery/Queries/AutocompleteDatabasePackageVersionsQuery.cs b/src/NuGetGallery/Queries/AutocompleteDatabasePackageVersionsQuery.cs
@@ -22,6 +22,7 @@ public AutocompleteDatabasePackageVersionsQuery(IReadOnlyEntityRepository<Packag
         public Task<IReadOnlyList<string>> Execute(
             string id,
             bool? includePrerelease = false,
+            bool? includeTestData = false, // ignored on this implementation
             string semVerLevel = null)
         {
             if (string.IsNullOrWhiteSpace(id))
diff --git a/src/NuGetGallery/Queries/AutocompleteServicePackageIdsQuery.cs b/src/NuGetGallery/Queries/AutocompleteServicePackageIdsQuery.cs
@@ -20,11 +20,16 @@ public AutocompleteServicePackageIdsQuery(IAppConfiguration configuration, IResi
         public async Task<IReadOnlyList<string>> Execute(
             string partialId, 
             bool? includePrerelease,
+            bool? includeTestData,
             string semVerLevel = null)
         {
             partialId = partialId ?? string.Empty;
 
-            return await RunServiceQuery("take=30&q=" + Uri.EscapeUriString(partialId), includePrerelease, semVerLevel);
+            return await RunServiceQuery(
+                "take=30&q=" + Uri.EscapeUriString(partialId),
+                includePrerelease,
+                includeTestData,
+                semVerLevel);
         }
     }
 }
diff --git a/src/NuGetGallery/Queries/AutocompleteServicePackageVersionsQuery.cs b/src/NuGetGallery/Queries/AutocompleteServicePackageVersionsQuery.cs
@@ -20,14 +20,19 @@ public AutocompleteServicePackageVersionsQuery(IAppConfiguration configuration,
         public async Task<IReadOnlyList<string>> Execute(
             string id, 
             bool? includePrerelease,
+            bool? includeTestData,
             string semVerLevel = null)
         {
             if (string.IsNullOrWhiteSpace(id))
             {
                 throw new ArgumentNullException(nameof(id));
             }
 
-            return await RunServiceQuery("id=" + Uri.EscapeUriString(id), includePrerelease, semVerLevel);
+            return await RunServiceQuery(
+                "id=" + Uri.EscapeUriString(id),
+                includePrerelease,
+                includeTestData,
+                semVerLevel);
         }
     }
 }
diff --git a/src/NuGetGallery/Queries/AutocompleteServiceQuery.cs b/src/NuGetGallery/Queries/AutocompleteServiceQuery.cs
@@ -30,9 +30,10 @@ public AutocompleteServiceQuery(IAppConfiguration configuration, IResilientSearc
         public async Task<IReadOnlyList<string>> RunServiceQuery(
             string queryString, 
             bool? includePrerelease,
+            bool? includeTestData,
             string semVerLevel = null)
         {
-            queryString = BuildQueryString(queryString, includePrerelease, semVerLevel);
+            queryString = BuildQueryString(queryString, includePrerelease, includeTestData, semVerLevel);
             var result = await ExecuteQuery(queryString);
             var resultObject = JObject.Parse(result);
 
@@ -45,10 +46,19 @@ internal async Task<string> ExecuteQuery(string queryString)
             return await response.Content.ReadAsStringAsync();
         }
 
-        internal string BuildQueryString(string queryString, bool? includePrerelease, string semVerLevel = null)
+        internal string BuildQueryString(
+            string queryString,
+            bool? includePrerelease,
+            bool? includeTestData,
+            string semVerLevel = null)
         {
             queryString += $"&prerelease={includePrerelease ?? false}";
 
+            if (includeTestData == true)
+            {
+                queryString += "&testData=true";
+            }
+
             NuGetVersion semVerLevelVersion;
             if (!string.IsNullOrEmpty(semVerLevel) && NuGetVersion.TryParse(semVerLevel, out semVerLevelVersion))
             {
diff --git a/src/NuGetGallery/Queries/IAutocompletePackageIdsQuery.cs b/src/NuGetGallery/Queries/IAutocompletePackageIdsQuery.cs
@@ -11,6 +11,7 @@ public interface IAutocompletePackageIdsQuery
         Task<IReadOnlyList<string>> Execute(
             string partialId,
             bool? includePrerelease = false,
+            bool? includeTestData = false,
             string semVerLevel = null);
     }
 }
diff --git a/src/NuGetGallery/Queries/IAutocompletePackageVersionsQuery.cs b/src/NuGetGallery/Queries/IAutocompletePackageVersionsQuery.cs
@@ -11,6 +11,7 @@ public interface IAutocompletePackageVersionsQuery
         Task<IReadOnlyList<string>> Execute(
             string id,
             bool? includePrerelease = false,
+            bool? icnludeTestData = false,
             string semVerLevel = null);
     }
 }
diff --git a/src/NuGetGallery/Services/SearchFilter.cs b/src/NuGetGallery/Services/SearchFilter.cs
@@ -37,6 +37,8 @@ public class SearchFilter
 
         public bool IncludeAllVersions { get; set; }
 
+        public bool IncludeTestData { get; set; }
+
         /// <summary>
         /// Constructs a new search filter
         /// </summary>
diff --git a/src/NuGetGallery/Services/SearchSideBySideService.cs b/src/NuGetGallery/Services/SearchSideBySideService.cs
@@ -114,7 +114,8 @@ private async Task<SearchResults> SearchAsync(ISearchService searchService, stri
                 packageType: null,
                 sortOrder: null,
                 context: SearchFilter.UISearchContext,
-                semVerLevel: SemVerLevelKey.SemVerLevel2);
+                semVerLevel: SemVerLevelKey.SemVerLevel2,
+                includeTestData: false);
 
             searchFilter.Take = 10;
 
diff --git a/src/NuGetGallery/ViewModels/PackageListSearchViewModel.cs b/src/NuGetGallery/ViewModels/PackageListSearchViewModel.cs
@@ -10,5 +10,6 @@ public class PackageListSearchViewModel
         public bool? Prerel { get; set; }
         public string SortBy { get; set; }
         public string PackageType { get; set; }
+        public bool? TestData { get; set; }
     }
 }
diff --git a/tests/NuGetGallery.Facts/Queries/AutocompleteDatabasePackageIdsQueryFacts.cs b/tests/NuGetGallery.Facts/Queries/AutocompleteDatabasePackageIdsQueryFacts.cs
@@ -60,7 +60,7 @@ public async void ValidPackageIdShouldReturnIdsWhosePackageStatusIsAvailable()
             [InlineData("1.0.0-beta")]
             public async void WithValidSemVerLevelReturnIdsWhosePackagesSemVerLevelCompliant(string semVerLevel)
             {
-                var queryResult = await _packageIdsQuery.Execute("nuget", null, semVerLevel);
+                var queryResult = await _packageIdsQuery.Execute("nuget", null, null, semVerLevel);
 
                 var allIdsAreFromPackagesWithSemVerLevelCompliant = queryResult.All(id =>
                 {
diff --git a/tests/NuGetGallery.Facts/Queries/AutocompleteDatabasePackageVersionsQueryFacts.cs b/tests/NuGetGallery.Facts/Queries/AutocompleteDatabasePackageVersionsQueryFacts.cs
@@ -90,7 +90,7 @@ public async void ValidPackageIdShouldReturnVersionsWhosePackagesAreListed()
             [InlineData("1.0.0-beta")]
             public async void ValidPackageIdWithSemVerLevelReturnVersionsWhosePackagesHaveSemVerLevelCompliant(string semVerLevel)
             {
-                var queryResult = await _packageVersionsQuery.Execute("nuget", null, semVerLevel);
+                var queryResult = await _packageVersionsQuery.Execute("nuget", null, null, semVerLevel);
                 
                 var allVersionsAreFromPackagesWithSemVerLevelCompliant = queryResult.All(version =>
                 {
diff --git a/tests/NuGetGallery.Facts/Queries/AutocompleteServicePackageIdsQueryFacts.cs b/tests/NuGetGallery.Facts/Queries/AutocompleteServicePackageIdsQueryFacts.cs
@@ -51,7 +51,7 @@ private IResilientSearchClient GetResilientSearchClient()
         public async Task ExecuteReturns30ResultsForEmptyQuery()
         {
             var query = new AutocompleteServicePackageIdsQuery(GetConfiguration(), GetResilientSearchClient());
-            var result = await query.Execute("", false);
+            var result = await query.Execute("", false, false);
 
             Assert.True(result.Count() == 30);
             var request = Assert.Single(_testHandler.Requests);
@@ -62,7 +62,7 @@ public async Task ExecuteReturns30ResultsForEmptyQuery()
         public async Task ExecuteReturns30ResultsForNullQuery()
         {
             var query = new AutocompleteServicePackageIdsQuery(GetConfiguration(), GetResilientSearchClient());
-            var result = await query.Execute(null, false);
+            var result = await query.Execute(null, false, false);
             Assert.True(result.Count() == 30);
             var request = Assert.Single(_testHandler.Requests);
             Assert.Equal("https://example/autocomplete?take=30&q=&prerelease=False", request.RequestUri.AbsoluteUri);
@@ -72,24 +72,32 @@ public async Task ExecuteReturns30ResultsForNullQuery()
         public async Task ExecuteReturnsResultsForSpecificQuery()
         {
             var query = new AutocompleteServicePackageIdsQuery(GetConfiguration(), GetResilientSearchClient());
-            var result = await query.Execute("jquery", false);
+            var result = await query.Execute("jquery", false, false);
             Assert.Contains("jquery", result, StringComparer.OrdinalIgnoreCase);
             var request = Assert.Single(_testHandler.Requests);
             Assert.Equal("https://example/autocomplete?take=30&q=jquery&prerelease=False", request.RequestUri.AbsoluteUri);
         }
 
         [Theory]
-        [InlineData(true, null, "?take=30&q=Json&prerelease=True")]
-        [InlineData(true, "2.0.0", "?take=30&q=Json&prerelease=True&semVerLevel=2.0.0")]
-        [InlineData(false, null, "?take=30&q=Json&prerelease=False")]
-        [InlineData(false, "2.0.0", "?take=30&q=Json&prerelease=False&semVerLevel=2.0.0")]
-        public void PackageIdQueryBuildsCorrectQueryString(bool includePrerelease, string semVerLevel, string expectedQueryString)
+        [InlineData(true, false, null, "?take=30&q=Json&prerelease=True")]
+        [InlineData(true, false, "2.0.0", "?take=30&q=Json&prerelease=True&semVerLevel=2.0.0")]
+        [InlineData(false, false, null, "?take=30&q=Json&prerelease=False")]
+        [InlineData(false, false, "2.0.0", "?take=30&q=Json&prerelease=False&semVerLevel=2.0.0")]
+        [InlineData(true, true, null, "?take=30&q=Json&prerelease=True&testData=true")]
+        [InlineData(true, true, "2.0.0", "?take=30&q=Json&prerelease=True&testData=true&semVerLevel=2.0.0")]
+        [InlineData(false, true, null, "?take=30&q=Json&prerelease=False&testData=true")]
+        [InlineData(false, true, "2.0.0", "?take=30&q=Json&prerelease=False&testData=true&semVerLevel=2.0.0")]
+        public void PackageIdQueryBuildsCorrectQueryString(
+            bool includePrerelease,
+            bool includeTestData,
+            string semVerLevel,
+            string expectedQueryString)
         {
             // Arrange
             var query = new AutocompleteServicePackageIdsQuery(GetConfiguration(), GetResilientSearchClient());
 
             // Act
-            var actualQueryString = query.BuildQueryString("take=30&q=Json", includePrerelease, semVerLevel);
+            var actualQueryString = query.BuildQueryString("take=30&q=Json", includePrerelease, includeTestData, semVerLevel);
 
             // Assert
             Assert.Equal(expectedQueryString, actualQueryString);
diff --git a/tests/NuGetGallery.Facts/Queries/AutocompleteServicePackageVersionsQueryFacts.cs b/tests/NuGetGallery.Facts/Queries/AutocompleteServicePackageVersionsQueryFacts.cs
diff --git a/tests/NuGetGallery.Facts/Queries/AutocompleteServiceQueryFacts.cs b/tests/NuGetGallery.Facts/Queries/AutocompleteServiceQueryFacts.cs
diff --git a/tests/NuGetGallery.Facts/Services/SearchAdaptorFacts.cs b/tests/NuGetGallery.Facts/Services/SearchAdaptorFacts.cs
diff --git a/tests/NuGetGallery.FunctionalTests/PackageRetrieval/PackageListTests.cs b/tests/NuGetGallery.FunctionalTests/PackageRetrieval/PackageListTests.cs

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ public AutocompleteDatabasePackageIdsQuery(IReadOnlyEntityRepository<Package> pa`
`23`	`23`	`public Task<IReadOnlyList<string>> Execute(`
`24`	`24`	`string partialId,`
`25`	`25`	`bool? includePrerelease = false,`
	`26`	`+ bool? includeTestData = false, // ignored on this implementation`
`26`	`27`	`string semVerLevel = null)`
`27`	`28`	`{`
`28`	`29`	`var query = _packageRepository.GetAll()`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ public AutocompleteDatabasePackageVersionsQuery(IReadOnlyEntityRepository<Packag`
`22`	`22`	`public Task<IReadOnlyList<string>> Execute(`
`23`	`23`	`string id,`
`24`	`24`	`bool? includePrerelease = false,`
	`25`	`+ bool? includeTestData = false, // ignored on this implementation`
`25`	`26`	`string semVerLevel = null)`
`26`	`27`	`{`
`27`	`28`	`if (string.IsNullOrWhiteSpace(id))`
Original file line number	Diff line number	Diff line change
`@@ -20,11 +20,16 @@ public AutocompleteServicePackageIdsQuery(IAppConfiguration configuration, IResi`
`20`	`20`	`public async Task<IReadOnlyList<string>> Execute(`
`21`	`21`	`string partialId,`
`22`	`22`	`bool? includePrerelease,`
	`23`	`+ bool? includeTestData,`
`23`	`24`	`string semVerLevel = null)`
`24`	`25`	`{`
`25`	`26`	`partialId = partialId ?? string.Empty;`
`26`	`27`
`27`		`- return await RunServiceQuery("take=30&q=" + Uri.EscapeUriString(partialId), includePrerelease, semVerLevel);`
	`28`	`+ return await RunServiceQuery(`
	`29`	`+ "take=30&q=" + Uri.EscapeUriString(partialId),`
	`30`	`+ includePrerelease,`
	`31`	`+ includeTestData,`
	`32`	`+ semVerLevel);`
`28`	`33`	`}`
`29`	`34`	`}`
`30`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,14 +20,19 @@ public AutocompleteServicePackageVersionsQuery(IAppConfiguration configuration,`
`20`	`20`	`public async Task<IReadOnlyList<string>> Execute(`
`21`	`21`	`string id,`
`22`	`22`	`bool? includePrerelease,`
	`23`	`+ bool? includeTestData,`
`23`	`24`	`string semVerLevel = null)`
`24`	`25`	`{`
`25`	`26`	`if (string.IsNullOrWhiteSpace(id))`
`26`	`27`	`{`
`27`	`28`	`throw new ArgumentNullException(nameof(id));`
`28`	`29`	`}`
`29`	`30`
`30`		`- return await RunServiceQuery("id=" + Uri.EscapeUriString(id), includePrerelease, semVerLevel);`
	`31`	`+ return await RunServiceQuery(`
	`32`	`+ "id=" + Uri.EscapeUriString(id),`
	`33`	`+ includePrerelease,`
	`34`	`+ includeTestData,`
	`35`	`+ semVerLevel);`
`31`	`36`	`}`
`32`	`37`	`}`
`33`	`38`	`}`