Also test optional fields in custom package information

sensslen · Feb 3, 2025 · dac7205 · dac7205
1 parent d503079
commit dac7205
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 14 deletions.
diff --git a/src/NuGetUtility/PackageInformationReader/CustomPackageInformation.cs b/src/NuGetUtility/PackageInformationReader/CustomPackageInformation.cs
@@ -5,5 +5,14 @@
 
 namespace NuGetUtility.PackageInformationReader
 {
-    public record struct CustomPackageInformation(string Id, INuGetVersion Version, string License, Uri? LicenseUrl = null, string? Copyright = null, string? Authors = null, string? Title = null, string? ProjectUrl = null, string? Summary = null, string? Description = null);
+    public record struct CustomPackageInformation(string Id,
+                                                  INuGetVersion Version,
+                                                  string License,
+                                                  string? Copyright = null,
+                                                  string? Authors = null,
+                                                  string? Title = null,
+                                                  string? ProjectUrl = null,
+                                                  string? Summary = null,
+                                                  string? Description = null,
+                                                  Uri? LicenseUrl = null);
 }
diff --git a/.../Helper/AutoFixture/NuGet/Versioning/CustomPackageInformationBuilderWithOptionalFileds.cs b/.../Helper/AutoFixture/NuGet/Versioning/CustomPackageInformationBuilderWithOptionalFileds.cs
@@ -0,0 +1,37 @@
+// Licensed to the projects contributors.
+// The license conditions are provided in the LICENSE file located in the project root
+
+using AutoFixture;
+using AutoFixture.Kernel;
+using NuGetUtility.PackageInformationReader;
+using NuGetUtility.Wrapper.NuGetWrapper.Versioning;
+
+namespace NuGetUtility.Test.Helper.AutoFixture.NuGet.Versioning
+{
+    internal class CustomPackageInformationBuilderWithOptionalFileds : ISpecimenBuilder
+    {
+        public object Create(object request, ISpecimenContext context)
+        {
+            if (request is System.Type t && t == typeof(CustomPackageInformation))
+            {
+                return new CustomPackageInformation(context.Create<string>(),
+                                                    context.Create<INuGetVersion>(),
+                                                    context.Create<string>(),
+                                                    CreateOptional<string>(context),
+                                                    CreateOptional<string>(context),
+                                                    CreateOptional<string>(context),
+                                                    CreateOptional<string>(context),
+                                                    CreateOptional<string>(context),
+                                                    CreateOptional<string>(context),
+                                                    CreateOptional<Uri>(context));
+            }
+
+            return new NoSpecimen();
+        }
+
+        private static T? CreateOptional<T>(ISpecimenContext context) where T : notnull
+        {
+            return context.Create<bool>() ? context.Create<T>() : default;
+        }
+    }
+}
diff --git a/tests/NuGetUtility.Test/LicenseValidator/UrlToLicenseMappingTest.cs b/tests/NuGetUtility.Test/LicenseValidator/UrlToLicenseMappingTest.cs
@@ -4,6 +4,7 @@
 using NuGetUtility.LicenseValidator;
 using OpenQA.Selenium;
 using OpenQA.Selenium.Chrome;
+using OpenQA.Selenium.Firefox;
 
 namespace NuGetUtility.Test.LicenseValidator
 {
@@ -44,15 +45,15 @@ private static Task<CompareResult> CompareLicense(string received, string verifi
             return Task.FromResult(new CompareResult((!string.IsNullOrWhiteSpace(verified)) && received.Contains(verified)));
         }
 
-        private sealed class DisposableWebDriver : IDisposable
+        private sealed class DisposableFirefoxWebDriver : IDisposable
         {
             private readonly IWebDriver _driver;
 
-            public DisposableWebDriver()
+            public DisposableFirefoxWebDriver()
             {
-                var options = new ChromeOptions();
+                var options = new FirefoxOptions();
                 options.AddArguments("--no-sandbox", "--disable-dev-shm-usage", "--headless");
-                _driver = new ChromeDriver(options);
+                _driver = new FirefoxDriver(options);
             }
 
             public void Dispose()

diff --git a/tests/NuGetUtility.Test/PackageInformationReader/PackageInformationReaderTest.cs b/tests/NuGetUtility.Test/PackageInformationReader/PackageInformationReaderTest.cs
@@ -25,6 +25,7 @@ public void SetUp()
             _customPackageInformation = Enumerable.Empty<CustomPackageInformation>().ToList();
             _fixture = new Fixture().Customize(new AutoNSubstituteCustomization());
             _fixture.Customizations.Add(new NuGetVersionBuilder());
+            _fixture.Customizations.Add(new CustomPackageInformationBuilderWithOptionalFileds());
             _repositories = Array.Empty<ISourceRepository>();
             _globalPackagesFolderUtility = Substitute.For<IGlobalPackagesFolderUtility>();
 
@@ -93,15 +94,15 @@ private static void CheckResult(ReferencedPackageWithContext[] result,
             LicenseType licenseType)
         {
             Assert.That(packages, Is.EquivalentTo(result.Select(s => new CustomPackageInformation(s.PackageInfo.Identity.Id,
-                                                                s.PackageInfo.Identity.Version,
-                                                                s.PackageInfo.LicenseMetadata!.License,
-                                                                s.PackageInfo.LicenseUrl,
-                                                                s.PackageInfo.Copyright,
-                                                                s.PackageInfo.Authors,
-                                                                s.PackageInfo.Title,
-                                                                s.PackageInfo.ProjectUrl,
-                                                                s.PackageInfo.Summary,
-                                                                s.PackageInfo.Description))));
+                                                                                                  s.PackageInfo.Identity.Version,
+                                                                                                  s.PackageInfo.LicenseMetadata!.License,
+                                                                                                  s.PackageInfo.Copyright,
+                                                                                                  s.PackageInfo.Authors,
+                                                                                                  s.PackageInfo.Title,
+                                                                                                  s.PackageInfo.ProjectUrl,
+                                                                                                  s.PackageInfo.Summary,
+                                                                                                  s.PackageInfo.Description,
+                                                                                                  s.PackageInfo.LicenseUrl))));
             foreach (ReferencedPackageWithContext r in result)
             {
                 Assert.That(r.Context, Is.EqualTo(project));
@@ -125,6 +126,7 @@ public async Task GetPackageInfo_Should_PreferLocalPackageCacheOverRepositories(
                 mockedInfo.ProjectUrl.Returns(info.ProjectUrl);
                 mockedInfo.Summary.Returns(info.Summary);
                 mockedInfo.Description.Returns(info.Description);
+                mockedInfo.LicenseUrl.Returns(info.LicenseUrl);
                 mockedInfo.LicenseMetadata.Returns(new LicenseMetadata(LicenseType.Expression, info.License));
                 mockedInfo.LicenseUrl.Returns(info.LicenseUrl);
                 _globalPackagesFolderUtility.GetPackage(identity).Returns(mockedInfo);
@@ -156,6 +158,7 @@ private static void SetupPackagesForRepositories(IEnumerable<CustomPackageInform
                 resultingInfo.Summary.Returns(package.Summary);
                 resultingInfo.Description.Returns(package.Description);
                 resultingInfo.ProjectUrl.Returns(package.ProjectUrl);
+                resultingInfo.LicenseUrl.Returns(package.LicenseUrl);
 
                 metadataReturningProperInformation.TryGetMetadataAsync(new PackageIdentity(package.Id, package.Version), Arg.Any<CancellationToken>()).
                     Returns(_ => Task.FromResult<IPackageMetadata?>(resultingInfo));