(#59) Add property to IChocolateyPackageSearchMetadata

This commit adds a new property to the IChocolateyPackageSearchMetadata
interface, and implements this property on all instances of this
interface.

This is required, since we need a mechanism to store the information
about _where_ a package was located.  When running the FindPackage
method in Chocolatey.CLI, the retured metadata class doesn't have this
information, however, at the time of calling this method, we do know
what source is being used, so we can record this information, we just
need a property to store it.  Once stored, it can then be retrieved
furhter upstream as/when required.

Typically, properties on the IChocolateyPackageSearchMetadata interface
don't have a public set, since they are typically initialised when being
created, however, since we are only setting this property once the meta
data is returned, we need there to be a public set method for this
property.

Due to a failing build on GitHub Actions, the CA1416 entry has been
added to the NoWarn attribute in the props file, so that the build does
not fail.  It is unclear why this is now causing a problem, when it
wasn't before, but it was felt that this was a safe change, since an
override for this warning already exists when running the build in a
different environment.

Author: gep13

build/common.project.props

@@ -50,7 +50,7 @@
     <MicroBuildDirectory>$(SolutionPackagesFolder)microsoft.visualstudioeng.microbuild.core\1.0.0\build\</MicroBuildDirectory>
     <MicrosoftDotNetBuildTasksFeedFilePath>$(SolutionPackagesFolder)microsoft.dotnet.build.tasks.feed\6.0.0-beta.20528.5\tools\netcoreapp2.1\Microsoft.DotNet.Build.Tasks.Feed.dll</MicrosoftDotNetBuildTasksFeedFilePath>
     <MicrosoftDotNetMaestroTasksFilePath>$(SolutionPackagesFolder)microsoft.dotnet.maestro.tasks\1.1.0-beta.21378.2\tools\netcoreapp3.1\Microsoft.DotNet.Maestro.Tasks.dll</MicrosoftDotNetMaestroTasksFilePath>
-    <NoWarn>$(NoWarn);NU5105;MSB3277</NoWarn>
+    <NoWarn>$(NoWarn);NU5105;MSB3277;CA1416</NoWarn>
     <!-- additional warnings new in .NET 6 that we need to disable when building with source-build -->
     <NoWarn Condition="'$(DotNetBuildFromSource)' == 'true'">$(NoWarn);CS1998;CA1416;CS0618;CS1574</NoWarn>
   </PropertyGroup>
@@ -295,7 +295,7 @@
                                $(RepositoryRootDirectory)src\NuGet.Core\NuGet.Versioning\NuGet.Versioning.csproj;
                                $(RepositoryRootDirectory)src\NuGet.Core\NuGet.Credentials\NuGet.Credentials.csproj;
                                $(RepositoryRootDirectory)src\NuGet.Core\NuGet.LibraryModel\\NuGet.LibraryModel.csproj;"/>
-    
+
     <CoreUnitTestProjects Include="$(RepositoryRootDirectory)test\NuGet.Core.Tests\NuGet.Commands.Test\NuGet.Commands.Test.csproj;
                                    $(RepositoryRootDirectory)test\NuGet.Core.Tests\NuGet.Common.Test\NuGet.Common.Test.csproj;
                                    $(RepositoryRootDirectory)test\NuGet.Core.Tests\NuGet.Configuration.Test\NuGet.Configuration.Test.csproj;

src/NuGet.Clients/NuGet.VisualStudio.Internal.Contracts/PublicAPI.Unshipped.txt

@@ -1 +1,3 @@
 #nullable enable
+NuGet.VisualStudio.Internal.Contracts.TransitivePackageSearchMetadata.AvailableVersionSource.get -> string!
+NuGet.VisualStudio.Internal.Contracts.TransitivePackageSearchMetadata.AvailableVersionSource.set -> void

src/NuGet.Clients/NuGet.VisualStudio.Internal.Contracts/TransitivePackageSearchMetadata.cs

@@ -63,6 +63,12 @@ public partial class TransitivePackageSearchMetadata : IPackageSearchMetadata
 
         public bool PrefixReserved => _packageSearchMetadata.PrefixReserved;
 
+        public string AvailableVersionSource
+        {
+            get => _packageSearchMetadata.AvailableVersionSource;
+            set => _packageSearchMetadata.AvailableVersionSource = value;
+        }
+
         public LicenseMetadata LicenseMetadata => _packageSearchMetadata.LicenseMetadata;
 
         public IEnumerable<PackageVulnerabilityMetadata> Vulnerabilities => _packageSearchMetadata.Vulnerabilities;

src/NuGet.Core/NuGet.Protocol/Model/ChocolateyLocalPackageSearchMetadata.cs

@@ -187,5 +187,10 @@ public Uri BugTrackerUrl
         /// Not applicable to local packages
         /// </remarks>
         public string PackageScanFlagResult => null;
+
+        /// <remarks>
+        /// Not applicable to local packages
+        /// </remarks>
+        public string AvailableVersionSource { get; set; }
     }
 }

src/NuGet.Core/NuGet.Protocol/Model/ChocolateyPackageSearchMetadata.cs

@@ -76,5 +76,7 @@ public partial class PackageSearchMetadata : IPackageSearchMetadata
         public DateTime? PackageScanResultDate { get; set; }
         [JsonIgnore]
         public string PackageScanFlagResult { get; set; }
+        [JsonIgnore]
+        public string AvailableVersionSource { get; set; }
     }
 }

src/NuGet.Core/NuGet.Protocol/Model/ChocolateyPackageSearchMetadataV2Feed.cs

@@ -85,6 +85,7 @@ public IEnumerable<DownloadCache> DownloadCache
         public string PackageScanStatus { get; private set; }
         public DateTime? PackageScanResultDate { get; private set; }
         public string PackageScanFlagResult { get; private set; }
+        public string AvailableVersionSource { get; set; }
 
         private void FinishInitialization(V2FeedPackageInfo package)
         {

src/NuGet.Core/NuGet.Protocol/Model/IChocolateyPackageSearchMetadata.cs

@@ -44,5 +44,7 @@ public partial interface IPackageSearchMetadata
         string PackageScanStatus { get; }
         DateTime? PackageScanResultDate { get; }
         string PackageScanFlagResult { get; }
+
+        string AvailableVersionSource { get; set; }
     }
 }

src/NuGet.Core/NuGet.Protocol/Model/PackageSearchMetadataBuilder.cs

@@ -77,6 +77,7 @@ public partial class ClonedPackageSearchMetadata : IPackageSearchMetadata
             [Obsolete("PackagePath is recommended in place of PackageReader")]
             public Func<PackageReaderBase> PackageReader { get; set; }
             public string PackagePath { get; set; }
+            public string AvailableVersionSource { get; set; }
         }
 
         private PackageSearchMetadataBuilder(IPackageSearchMetadata metadata)
@@ -168,6 +169,7 @@ public IPackageSearchMetadata Build()
                 PackageScanStatus = _metadata.PackageScanStatus,
                 PackageScanResultDate = _metadata.PackageScanResultDate,
                 PackageScanFlagResult = _metadata.PackageScanFlagResult,
+                AvailableVersionSource = _metadata.AvailableVersionSource
 
                 //////////////////////////////////////////////////////////
                 // End - Chocolatey Specific Modification

src/NuGet.Core/NuGet.Protocol/PublicAPI/net472/PublicAPI.Unshipped.txt

@@ -0,0 +1,10 @@
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.set -> void

src/NuGet.Core/NuGet.Protocol/PublicAPI/netcoreapp5.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,10 @@
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.set -> void