feat: Allowed to indicate the source of nuget package and whether it is a pre-release version. (#1659)

Author: workgroupengineering

src/BenchmarkDotNet/Jobs/JobExtensions.cs

@@ -329,25 +329,25 @@ public static Job WithEnvironmentVariable(this Job job, [NotNull] string key, [N
         /// </summary>
         /// <param name="job"></param>
         /// <param name="packageName">The NuGet package name</param>
-        /// <param name="packageVersion">The NuGet package version</param>
+        /// <param name="packageVersion">(optional)The NuGet package version</param>
+        /// <param name="source">(optional)Indicate the URI of the NuGet package source to use during the restore operation.</param>
+        /// <param name="prerelease">(optional)Allows prerelease packages to be installed.</param>
         /// <returns></returns>
-        public static Job WithNuGet(this Job job, string packageName, string packageVersion) => job.WithCore(j => j.Infrastructure.NuGetReferences = new NuGetReferenceList(j.Infrastructure.NuGetReferences ?? Array.Empty<NuGetReference>()) { new NuGetReference(packageName, packageVersion) });
-
-        /// <summary>
-        /// Runs the job with a specific NuGet dependency which will be resolved during the Job build process
-        /// </summary>
-        /// <param name="job"></param>
-        /// <param name="packageName">The NuGet package name, the latest version will be resolved</param>
-        /// <returns></returns>
-        public static Job WithNuGet(this Job job, string packageName) => job.WithNuGet(packageName, string.Empty);
+        public static Job WithNuGet(this Job job, string packageName, string packageVersion = null, Uri source = null, bool prerelease = false) =>
+            job.WithCore(j => j.Infrastructure.NuGetReferences =
+                new NuGetReferenceList(j.Infrastructure.NuGetReferences ?? Array.Empty<NuGetReference>())
+                    {
+                        new NuGetReference(packageName, packageVersion, source, prerelease)
+                    });
 
         /// <summary>
         /// Runs the job with a specific NuGet dependencies which will be resolved during the Job build process
         /// </summary>
         /// <param name="job"></param>
         /// <param name="nuGetReferences">A collection of NuGet dependencies</param>
         /// <returns></returns>
-        public static Job WithNuGet(this Job job, NuGetReferenceList nuGetReferences) => job.WithCore(j => j.Infrastructure.NuGetReferences = nuGetReferences);
+        public static Job WithNuGet(this Job job, NuGetReferenceList nuGetReferences) =>
+            job.WithCore(j => j.Infrastructure.NuGetReferences = nuGetReferences);
 
         // Accuracy
         /// <summary>

src/BenchmarkDotNet/Jobs/NugetReference.cs

@@ -6,7 +6,7 @@ namespace BenchmarkDotNet.Jobs
 {
     public class NuGetReference : IEquatable<NuGetReference>
     {
-        public NuGetReference(string packageName, string packageVersion)
+        public NuGetReference(string packageName, string packageVersion, Uri source = null, bool prerelease = false)
         {
             if (string.IsNullOrWhiteSpace(packageName))
                 throw new ArgumentException("message", nameof(packageName));
@@ -16,12 +16,15 @@ public NuGetReference(string packageName, string packageVersion)
             if (!string.IsNullOrWhiteSpace(PackageVersion) && !IsValidVersion(packageVersion))
                 throw new InvalidOperationException($"Invalid version specified: {packageVersion}");
 
-            PackageVersion = packageVersion;
-
+            PackageVersion = packageVersion ?? string.Empty;
+            PackageSource = source;
+            Prerelease = prerelease;
         }
 
         public string PackageName { get; }
         public string PackageVersion { get; }
+        public bool Prerelease { get; }
+        public Uri PackageSource { get; }
 
         public override bool Equals(object obj)
         {

src/BenchmarkDotNet/Toolchains/DotNetCli/DotNetCliCommand.cs

@@ -179,7 +179,7 @@ private static IEnumerable<string> GetNuGetAddPackageCommands(BenchmarkCase benc
 
             var nuGetRefs = benchmarkCase.Job.ResolveValue(InfrastructureMode.NuGetReferencesCharacteristic, resolver);
 
-            return nuGetRefs.Select(x => $"add package {x.PackageName}{(string.IsNullOrWhiteSpace(x.PackageVersion) ? string.Empty : " -v " + x.PackageVersion)}");
+            return nuGetRefs.Select(BuildAddPackageCommand);
         }
 
         private static string GetMandatoryMsBuildSettings(string buildConfiguration)
@@ -196,5 +196,27 @@ private static string GetMandatoryMsBuildSettings(string buildConfiguration)
 
             return $"{NoMsBuildZombieProcesses} {EnforceOptimizations}";
         }
+
+        private static string BuildAddPackageCommand(NuGetReference reference)
+        {
+            var commandBuilder = new StringBuilder();
+            commandBuilder.Append("add package ");
+            commandBuilder.Append(reference.PackageName);
+            if (!string.IsNullOrWhiteSpace(reference.PackageVersion))
+            {
+                commandBuilder.Append(" -v ");
+                commandBuilder.Append(reference.PackageVersion);
+            }
+            if (reference.PackageSource != null)
+            {
+                commandBuilder.Append(" -s ");
+                commandBuilder.Append(reference.PackageSource);
+            }
+            if (reference.Prerelease)
+            {
+                commandBuilder.Append(" --prerelease");
+            }
+            return commandBuilder.ToString();
+        }
     }
 }