Enable custom CPS projects to be restored (#3644)

* Rename NetCore -> CPS

This better describes what these types do.

* Include C++ in CPS-based project check

The CPS capability indicates that the outer hierarchy of a project is owned by CPS, not that the project uses CPS. C++ will be using CPS-based components to light up PackageReference support and hence should pass this check.

* Unify PackageReferences checks

We were opt'ing CPS projects out of CpsProjectReferenceProjectProvider based on whether that had TargetFramework or TargetFrameworks properties, both are which are .NET-SDK specific.

C++/MSIX deployment and other custom projects don't have these properties.

* IsCPSCapabilityComplaint -> IsCPSCapabilityCompliant

* fix formatting

Author: davkean

src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/GlobalSuppressions.cs

@@ -74,13 +74,13 @@
 [assembly: SuppressMessage("Build", "CA1062:In externally visible method 'Task<IPackageSearchMetadata> MultiSourcePackageMetadataProvider.GetLocalPackageMetadataAsync(PackageIdentity identity, bool includePrerelease, CancellationToken cancellationToken)', validate parameter 'identity' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.MultiSourcePackageMetadataProvider.GetLocalPackageMetadataAsync(NuGet.Packaging.Core.PackageIdentity,System.Boolean,System.Threading.CancellationToken)~System.Threading.Tasks.Task{NuGet.Protocol.Core.Types.IPackageSearchMetadata}")]
 [assembly: SuppressMessage("Build", "CA1062:In externally visible method 'Task<IPackageSearchMetadata> MultiSourcePackageMetadataProvider.GetPackageMetadataAsync(PackageIdentity identity, bool includePrerelease, CancellationToken cancellationToken)', validate parameter 'identity' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.MultiSourcePackageMetadataProvider.GetPackageMetadataAsync(NuGet.Packaging.Core.PackageIdentity,System.Boolean,System.Threading.CancellationToken)~System.Threading.Tasks.Task{NuGet.Protocol.Core.Types.IPackageSearchMetadata}")]
 [assembly: SuppressMessage("Build", "CA1801:Parameter identity of method MergeDeprecationMetadataAsync is never used. Remove the parameter or use it in the method body.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.MultiSourcePackageMetadataProvider.MergeDeprecationMetadataAsync(NuGet.Packaging.Core.PackageIdentity,System.Collections.Generic.IEnumerable{NuGet.Protocol.Core.Types.IPackageSearchMetadata})~System.Threading.Tasks.Task{NuGet.Protocol.PackageDeprecationMetadata}")]
-[assembly: SuppressMessage("Build", "CA1305:The behavior of 'string.Format(string, object)' could vary based on the current user's locale settings. Replace this call in 'NetCorePackageReferenceProject.GetAssetsFilePathAsync(bool)' with a call to 'string.Format(IFormatProvider, string, params object[])'.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NetCorePackageReferenceProject.GetAssetsFilePathAsync(System.Boolean)~System.Threading.Tasks.Task{System.String}")]
-[assembly: SuppressMessage("Build", "CA1305:The behavior of 'string.Format(string, object)' could vary based on the current user's locale settings. Replace this call in 'NetCorePackageReferenceProject.GetCacheFilePathAsync()' with a call to 'string.Format(IFormatProvider, string, params object[])'.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NetCorePackageReferenceProject.GetCacheFilePathAsync~System.Threading.Tasks.Task{System.String}")]
-[assembly: SuppressMessage("Build", "CA1825:Avoid unnecessary zero-length array allocations.  Use Array.Empty<PackageReference>() instead.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NetCorePackageReferenceProject.GetInstalledPackagesAsync(System.Threading.CancellationToken)~System.Threading.Tasks.Task{System.Collections.Generic.IEnumerable{NuGet.Packaging.PackageReference}}")]
-[assembly: SuppressMessage("Build", "CA1062:In externally visible method 'Task<bool> NetCorePackageReferenceProject.InstallPackageAsync(string packageId, VersionRange range, INuGetProjectContext nuGetProjectContext, BuildIntegratedInstallationContext installationContext, CancellationToken token)', validate parameter 'range' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NetCorePackageReferenceProject.InstallPackageAsync(System.String,NuGet.Versioning.VersionRange,NuGet.ProjectManagement.INuGetProjectContext,NuGet.ProjectManagement.BuildIntegratedInstallationContext,System.Threading.CancellationToken)~System.Threading.Tasks.Task{System.Boolean}")]
-[assembly: SuppressMessage("Build", "CA1305:The behavior of 'string.Format(string, object)' could vary based on the current user's locale settings. Replace this call in 'NetCorePackageReferenceProject.InstallPackageAsync(string, VersionRange, INuGetProjectContext, BuildIntegratedInstallationContext, CancellationToken)' with a call to 'string.Format(IFormatProvider, string, params object[])'.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NetCorePackageReferenceProject.InstallPackageAsync(System.String,NuGet.Versioning.VersionRange,NuGet.ProjectManagement.INuGetProjectContext,NuGet.ProjectManagement.BuildIntegratedInstallationContext,System.Threading.CancellationToken)~System.Threading.Tasks.Task{System.Boolean}")]
-[assembly: SuppressMessage("Build", "CA1062:In externally visible method 'Task<bool> NetCorePackageReferenceProject.UninstallPackageAsync(PackageIdentity packageIdentity, INuGetProjectContext nuGetProjectContext, CancellationToken token)', validate parameter 'packageIdentity' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NetCorePackageReferenceProject.UninstallPackageAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.ProjectManagement.INuGetProjectContext,System.Threading.CancellationToken)~System.Threading.Tasks.Task{System.Boolean}")]
-[assembly: SuppressMessage("Build", "CA1062:In externally visible method 'Task<NuGetProject> NetCorePackageReferenceProjectProvider.TryCreateNuGetProjectAsync(IVsProjectAdapter vsProject, ProjectProviderContext context, bool forceProjectType)', validate parameter 'vsProject' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NetCorePackageReferenceProjectProvider.TryCreateNuGetProjectAsync(NuGet.VisualStudio.IVsProjectAdapter,NuGet.PackageManagement.VisualStudio.ProjectProviderContext,System.Boolean)~System.Threading.Tasks.Task{NuGet.ProjectManagement.NuGetProject}")]
+[assembly: SuppressMessage("Build", "CA1305:The behavior of 'string.Format(string, object)' could vary based on the current user's locale settings. Replace this call in 'CpsPackageReferenceProject.GetAssetsFilePathAsync(bool)' with a call to 'string.Format(IFormatProvider, string, params object[])'.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.CpsPackageReferenceProject.GetAssetsFilePathAsync(System.Boolean)~System.Threading.Tasks.Task{System.String}")]
+[assembly: SuppressMessage("Build", "CA1305:The behavior of 'string.Format(string, object)' could vary based on the current user's locale settings. Replace this call in 'CpsPackageReferenceProject.GetCacheFilePathAsync()' with a call to 'string.Format(IFormatProvider, string, params object[])'.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.CpsPackageReferenceProject.GetCacheFilePathAsync~System.Threading.Tasks.Task{System.String}")]
+[assembly: SuppressMessage("Build", "CA1825:Avoid unnecessary zero-length array allocations.  Use Array.Empty<PackageReference>() instead.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.CpsPackageReferenceProject.GetInstalledPackagesAsync(System.Threading.CancellationToken)~System.Threading.Tasks.Task{System.Collections.Generic.IEnumerable{NuGet.Packaging.PackageReference}}")]
+[assembly: SuppressMessage("Build", "CA1062:In externally visible method 'Task<bool> CpsPackageReferenceProject.InstallPackageAsync(string packageId, VersionRange range, INuGetProjectContext nuGetProjectContext, BuildIntegratedInstallationContext installationContext, CancellationToken token)', validate parameter 'range' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.CpsPackageReferenceProject.InstallPackageAsync(System.String,NuGet.Versioning.VersionRange,NuGet.ProjectManagement.INuGetProjectContext,NuGet.ProjectManagement.BuildIntegratedInstallationContext,System.Threading.CancellationToken)~System.Threading.Tasks.Task{System.Boolean}")]
+[assembly: SuppressMessage("Build", "CA1305:The behavior of 'string.Format(string, object)' could vary based on the current user's locale settings. Replace this call in 'CpsPackageReferenceProject.InstallPackageAsync(string, VersionRange, INuGetProjectContext, BuildIntegratedInstallationContext, CancellationToken)' with a call to 'string.Format(IFormatProvider, string, params object[])'.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.CpsPackageReferenceProject.InstallPackageAsync(System.String,NuGet.Versioning.VersionRange,NuGet.ProjectManagement.INuGetProjectContext,NuGet.ProjectManagement.BuildIntegratedInstallationContext,System.Threading.CancellationToken)~System.Threading.Tasks.Task{System.Boolean}")]
+[assembly: SuppressMessage("Build", "CA1062:In externally visible method 'Task<bool> CpsPackageReferenceProject.UninstallPackageAsync(PackageIdentity packageIdentity, INuGetProjectContext nuGetProjectContext, CancellationToken token)', validate parameter 'packageIdentity' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.CpsPackageReferenceProject.UninstallPackageAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.ProjectManagement.INuGetProjectContext,System.Threading.CancellationToken)~System.Threading.Tasks.Task{System.Boolean}")]
+[assembly: SuppressMessage("Build", "CA1062:In externally visible method 'Task<NuGetProject> CpsPackageReferenceProjectProvider.TryCreateNuGetProjectAsync(IVsProjectAdapter vsProject, ProjectProviderContext context, bool forceProjectType)', validate parameter 'vsProject' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.CpsPackageReferenceProjectProvider.TryCreateNuGetProjectAsync(NuGet.VisualStudio.IVsProjectAdapter,NuGet.PackageManagement.VisualStudio.ProjectProviderContext,System.Boolean)~System.Threading.Tasks.Task{NuGet.ProjectManagement.NuGetProject}")]
 [assembly: SuppressMessage("Build", "CA1062:In externally visible method 'NuGetLockService.NuGetLockService(JoinableTaskContext joinableTaskContext)', validate parameter 'joinableTaskContext' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NuGetLockService.#ctor(Microsoft.VisualStudio.Threading.JoinableTaskContext)")]
 [assembly: SuppressMessage("Build", "CA1031:Modify 'CreateNuGetProjectAsync' to catch a more specific allowed exception type, or rethrow the exception.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NuGetProjectFactory.CreateNuGetProjectAsync``1(NuGet.VisualStudio.IVsProjectAdapter,NuGet.PackageManagement.VisualStudio.ProjectProviderContext)~System.Threading.Tasks.Task{``0}")]
 [assembly: SuppressMessage("Build", "CA1062:In externally visible method 'Task<TProject> NuGetProjectFactory.CreateNuGetProjectAsync<TProject>(IVsProjectAdapter vsProjectAdapter, ProjectProviderContext optionalContext = null)', validate parameter 'vsProjectAdapter' is non-null before using it. If appropriate, throw an ArgumentNullException when the argument is null or add a Code Contract precondition asserting non-null argument.", Justification = "<Pending>", Scope = "member", Target = "~M:NuGet.PackageManagement.VisualStudio.NuGetProjectFactory.CreateNuGetProjectAsync``1(NuGet.VisualStudio.IVsProjectAdapter,NuGet.PackageManagement.VisualStudio.ProjectProviderContext)~System.Threading.Tasks.Task{``0}")]

src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/IDE/VSSolutionManager.cs

@@ -278,7 +278,7 @@ public async Task<IEnumerable<NuGetProject>> GetNuGetProjectsAsync()
 
         public async Task<bool> IsAllProjectsNominatedAsync()
         {
-            var netCoreProjects = (await GetNuGetProjectsAsync()).OfType<NetCorePackageReferenceProject>().ToList();
+            var netCoreProjects = (await GetNuGetProjectsAsync()).OfType<CpsPackageReferenceProject>().ToList();
 
             foreach (var project in netCoreProjects)
             {

src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/NuGet.PackageManagement.VisualStudio.csproj

@@ -124,13 +124,13 @@
     <Compile Include="IDE\ExtensibleSourceRepositoryProvider.cs" />
     <Compile Include="IInteractiveLoginProvider.cs" />
     <Compile Include="InteractiveLoginProvider.cs" />
-    <Compile Include="Projects\NetCorePackageReferenceProject.cs" />
+    <Compile Include="Projects\CpsPackageReferenceProject.cs" />
     <Compile Include="Projects\INuGetProjectProvider.cs" />
     <Compile Include="Projects\MSBuildNuGetProjectProvider.cs" />
     <Compile Include="Projects\ProjectJsonProjectProvider.cs" />
     <Compile Include="Projects\ProjectKNuGetProjectProvider.cs" />
     <Compile Include="Projects\ProjectSystemCache.cs" />
-    <Compile Include="Projects\NetCorePackageReferenceProjectProvider.cs" />
+    <Compile Include="Projects\CpsPackageReferenceProjectProvider.cs" />
     <Compile Include="Projects\ProjectProviderContext.cs" />
     <Compile Include="ProjectServices\VsProjectScriptHostService.cs" />
     <Compile Include="Prompts\DeprecatedFrameworkModel.cs" />

…ojects/NetCorePackageReferenceProject.cs …o/Projects/CpsPackageReferenceProject.cssrc/NuGet.Clients/NuGet.PackageManagement.VisualStudio/Projects/NetCorePackageReferenceProject.cs renamed to src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/Projects/CpsPackageReferenceProject.cs src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/Projects/NetCorePackageReferenceProject.cs renamed to src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/Projects/CpsPackageReferenceProject.cs

@@ -30,11 +30,13 @@
 namespace NuGet.PackageManagement.VisualStudio
 {
     /// <summary>
-    /// Represents a project object associated with new VS "15" CPS project with package references.
+    /// Represents a project object associated with Common Project System (CPS) project that has opt'd
+    /// into package references. This includes, but may not be limited to, .NET Project System,
+    /// C++/CLI (with PackageReference support) and MSIX deployment projects.
     /// Key feature/difference is the project restore info is pushed by nomination API and stored in 
     /// a cache. Factory method retrieving the info from the cache should be provided.
     /// </summary>
-    public class NetCorePackageReferenceProject : BuildIntegratedNuGetProject
+    public class CpsPackageReferenceProject : BuildIntegratedNuGetProject
     {
         private const string TargetFrameworkCondition = "TargetFramework";
 
@@ -48,7 +50,7 @@ public class NetCorePackageReferenceProject : BuildIntegratedNuGetProject
         private DateTime _lastTimeAssetsModified;
         private WeakReference<PackageSpec> _lastPackageSpec;
 
-        public NetCorePackageReferenceProject(
+        public CpsPackageReferenceProject(
             string projectName,
             string projectUniqueName,
             string projectFullPath,

…etCorePackageReferenceProjectProvider.cs …ts/CpsPackageReferenceProjectProvider.cssrc/NuGet.Clients/NuGet.PackageManagement.VisualStudio/Projects/NetCorePackageReferenceProjectProvider.cs renamed to src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/Projects/CpsPackageReferenceProjectProvider.cs src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/Projects/NetCorePackageReferenceProjectProvider.cs renamed to src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/Projects/CpsPackageReferenceProjectProvider.cs

@@ -19,27 +19,27 @@
 namespace NuGet.PackageManagement.VisualStudio
 {
     /// <summary>
-    /// Provides a method of creating <see cref="NetCorePackageReferenceProject"/> instance.
+    /// Provides a method of creating <see cref="CpsPackageReferenceProject"/> instance.
     /// </summary>
     [Export(typeof(INuGetProjectProvider))]
-    [Name(nameof(NetCorePackageReferenceProjectProvider))]
+    [Name(nameof(CpsPackageReferenceProjectProvider))]
     [Microsoft.VisualStudio.Utilities.Order(After = nameof(ProjectKNuGetProjectProvider))]
-    public class NetCorePackageReferenceProjectProvider : INuGetProjectProvider
+    public class CpsPackageReferenceProjectProvider : INuGetProjectProvider
     {
         private static readonly string PackageReference = ProjectStyle.PackageReference.ToString();
 
         private readonly IProjectSystemCache _projectSystemCache;
 
         private readonly AsyncLazy<IComponentModel> _componentModel;
 
-        public RuntimeTypeHandle ProjectType => typeof(NetCorePackageReferenceProject).TypeHandle;
+        public RuntimeTypeHandle ProjectType => typeof(CpsPackageReferenceProject).TypeHandle;
 
         [ImportingConstructor]
-        public NetCorePackageReferenceProjectProvider(IProjectSystemCache projectSystemCache)
+        public CpsPackageReferenceProjectProvider(IProjectSystemCache projectSystemCache)
             : this(AsyncServiceProvider.GlobalProvider, projectSystemCache)
         { }
 
-        public NetCorePackageReferenceProjectProvider(
+        public CpsPackageReferenceProjectProvider(
             IAsyncServiceProvider vsServiceProvider,
             IProjectSystemCache projectSystemCache)
         {
@@ -74,37 +74,31 @@ public async Task<NuGetProject> TryCreateNuGetProjectAsync(
                 return null;
             }
 
-            // Check if the project is not CPS capable or if it is CPS capable then it does not have TargetFramework(s), if so then return false
-            if (!hierarchy.IsCapabilityMatch("CPS"))
+            // Check if the project is not CPS capable or if it is CPS capable that its opt'd in PackageReferences
+            if (!VsHierarchyUtility.IsCPSCapabilityCompliant(hierarchy) ||
+                !VsHierarchyUtility.IsProjectCapabilityCompliant(hierarchy))
             {
                 return null;
             }
 
             var buildProperties = vsProject.BuildProperties;
 
-            // read MSBuild property RestoreProjectStyle, TargetFramework, and TargetFrameworks
+            // read MSBuild property RestoreProjectStyle
             var restoreProjectStyle = await buildProperties.GetPropertyValueAsync(ProjectBuildProperties.RestoreProjectStyle);
-            var targetFramework = await buildProperties.GetPropertyValueAsync(ProjectBuildProperties.TargetFramework);
-            var targetFrameworks = await buildProperties.GetPropertyValueAsync(ProjectBuildProperties.TargetFrameworks);
 
             // check for RestoreProjectStyle property is set and if not set to PackageReference then return false
             if (!(string.IsNullOrEmpty(restoreProjectStyle) ||
                 restoreProjectStyle.Equals(PackageReference, StringComparison.OrdinalIgnoreCase)))
             {
                 return null;
             }
-            // check whether TargetFramework or TargetFrameworks property is set, else return false
-            else if (string.IsNullOrEmpty(targetFramework) && string.IsNullOrEmpty(targetFrameworks))
-            {
-                return null;
-            }
 
             var fullProjectPath = vsProject.FullProjectPath;
             var unconfiguredProject = GetUnconfiguredProject(vsProject.Project);
 
             var projectServices = new NetCoreProjectSystemServices(vsProject, await _componentModel.GetValueAsync());
 
-            return new NetCorePackageReferenceProject(
+            return new CpsPackageReferenceProject(
                 vsProject.ProjectName,
                 vsProject.CustomUniqueName,
                 fullProjectPath,

src/NuGet.Clients/NuGet.PackageManagement.VisualStudio/Projects/LegacyPackageReferenceProjectProvider.cs

@@ -22,7 +22,7 @@ namespace NuGet.PackageManagement.VisualStudio
 {
     [Export(typeof(INuGetProjectProvider))]
     [Name(nameof(LegacyPackageReferenceProjectProvider))]
-    [Order(After = nameof(NetCorePackageReferenceProjectProvider))]
+    [Order(After = nameof(CpsPackageReferenceProjectProvider))]
     public sealed class LegacyPackageReferenceProjectProvider : INuGetProjectProvider
     {
         private static readonly string PackageReference = ProjectStyle.PackageReference.ToString();