Unify more build and publish logic

Author: dsplaisted

src/Tasks/Common/MetadataKeys.cs

@@ -65,6 +65,7 @@ internal static class MetadataKeys
         public const string NuGetSourceType = "NuGetSourceType";
         public const string PathInPackage = "PathInPackage";
         public const string PackageDirectory = "PackageDirectory";
+        public const string Publish = "Publish";
 
         // References
         public const string ExternallyResolved = "ExternallyResolved";

src/Tasks/Microsoft.NET.Build.Tasks.UnitTests/Mocks/MockTaskItem.cs

@@ -58,10 +58,10 @@ public string GetMetadata(string metadataName)
             string metadataValue = null;
             if (_metadata.TryGetValue(metadataName, out metadataValue))
             {
-                return metadataValue;
+                return metadataValue ?? string.Empty;
             }
 
-            return null;
+            return string.Empty;
         }
 
         public void RemoveMetadata(string metadataName)

src/Tasks/Microsoft.NET.Build.Tasks/ResolvePackageAssets.cs

@@ -142,7 +142,7 @@ public sealed class ResolvePackageAssets : TaskBase
         /// </summary>
         public ITaskItem[] ShimRuntimeIdentifiers { get; set; }
 
-        public ITaskItem[] ExcludeFromOutputPackageReferences { get; set; }
+        public ITaskItem[] PackageReferences { get; set; }
 
         /// <summary>
         /// The file name of Apphost asset.
@@ -385,12 +385,13 @@ internal byte[] HashSettings()
                     writer.Write(EmitAssetsLogMessages);
                     writer.Write(EnsureRuntimePackageDependencies);
                     writer.Write(MarkPackageReferencesAsExternallyResolved);
-                    if (ExcludeFromOutputPackageReferences != null)
+                    if (PackageReferences != null)
                     {
-                        foreach (var excludedPackage in ExcludeFromOutputPackageReferences)
+                        foreach (var packageReference in PackageReferences)
                         {
-                            writer.Write(excludedPackage.ItemSpec ?? "");
-                            writer.Write(excludedPackage.GetMetadata(MetadataKeys.Version) ?? "");
+                            writer.Write(packageReference.ItemSpec ?? "");
+                            writer.Write(packageReference.GetMetadata(MetadataKeys.Version));
+                            writer.Write(packageReference.GetMetadata(MetadataKeys.Publish));
                         }
                     }
                     if (ExpectedPlatformPackages != null)
@@ -628,6 +629,7 @@ private sealed class CacheWriter : IDisposable
             private List<string> _metadataStrings;
             private List<int> _bufferedMetadata;
             private HashSet<string> _copyLocalPackageExclusions;
+            private HashSet<string> _publishPackageExclusions;
             private Placeholder _metadataStringTablePosition;
             private NuGetFramework _targetFramework;
             private int _itemCount;
@@ -679,7 +681,7 @@ public CacheWriter(ResolvePackageAssets task)
                 _stringTable = new Dictionary<string, int>(InitialStringTableCapacity, StringComparer.Ordinal);
                 _metadataStrings = new List<string>(InitialStringTableCapacity);
                 _bufferedMetadata = new List<int>();
-                _copyLocalPackageExclusions = GetCopyLocalPackageExclusions();
+                ComputePackageExclusions();
             }
 
             public void WriteToCacheFile()
@@ -1022,10 +1024,7 @@ private void WriteNativeLibraries()
                     writeMetadata: (package, asset) =>
                     {
                         WriteMetadata(MetadataKeys.AssetType, "native");
-                        if (ShouldCopyLocalPackageAssets(package))
-                        {
-                            WriteCopyLocalMetadata(package, Path.GetFileName(asset.Path));
-                        }
+                        WriteCopyLocalMetadataIfNeeded(package, Path.GetFileName(asset.Path));
                     });
             }
 
@@ -1098,14 +1097,11 @@ private void WriteResourceAssemblies()
                     {
                         WriteMetadata(MetadataKeys.AssetType, "resources");
                         string locale = asset.Properties["locale"];
-                        if (ShouldCopyLocalPackageAssets(package))
-                        {
-                            WriteCopyLocalMetadata(
+                        bool wroteCopyLocalMetadata = WriteCopyLocalMetadataIfNeeded(
                                 package,
                                 Path.GetFileName(asset.Path),
                                 destinationSubDirectory: locale + Path.DirectorySeparatorChar);
-                        }
-                        else
+                        if (!wroteCopyLocalMetadata)
                         {
                             WriteMetadata(MetadataKeys.DestinationSubDirectory, locale + Path.DirectorySeparatorChar);
                         }
@@ -1121,10 +1117,7 @@ private void WriteRuntimeAssemblies()
                     writeMetadata: (package, asset) =>
                     {
                         WriteMetadata(MetadataKeys.AssetType, "runtime");
-                        if (ShouldCopyLocalPackageAssets(package))
-                        {
-                            WriteCopyLocalMetadata(package, Path.GetFileName(asset.Path));
-                        }
+                        WriteCopyLocalMetadataIfNeeded(package, Path.GetFileName(asset.Path));
                     });
             }
 
@@ -1136,14 +1129,15 @@ private void WriteRuntimeTargets()
                     writeMetadata: (package, asset) =>
                     {
                         WriteMetadata(MetadataKeys.AssetType, asset.AssetType.ToLowerInvariant());
-                        if (_task.CopyLocalRuntimeTargetAssets && ShouldCopyLocalPackageAssets(package))
+                        bool wroteCopyLocalMetadata = false;
+                        if (_task.CopyLocalRuntimeTargetAssets)
                         {
-                            WriteCopyLocalMetadata(
+                            wroteCopyLocalMetadata = WriteCopyLocalMetadataIfNeeded(
                                 package,
                                 Path.GetFileName(asset.Path),
                                 destinationSubDirectory: Path.GetDirectoryName(asset.Path) + Path.DirectorySeparatorChar);
                         }
-                        else
+                        if (!wroteCopyLocalMetadata)
                         {
                             WriteMetadata(MetadataKeys.DestinationSubDirectory, Path.GetDirectoryName(asset.Path) + Path.DirectorySeparatorChar);
                         }
@@ -1260,9 +1254,32 @@ private void WriteMetadata(string key, string value)
                 }
             }
 
-            private void WriteCopyLocalMetadata(LockFileTargetLibrary package, string assetsFileName, string destinationSubDirectory = null)
+            private bool WriteCopyLocalMetadataIfNeeded(LockFileTargetLibrary package, string assetsFileName, string destinationSubDirectory = null)
             {
-                WriteMetadata(MetadataKeys.CopyLocal, "true");
+                bool shouldCopyLocal = true;
+                if (_copyLocalPackageExclusions != null && _copyLocalPackageExclusions.Contains(package.Name))
+                {
+                    shouldCopyLocal = false;
+                }
+                bool shouldIncludeInPublish = shouldCopyLocal;
+                if (shouldIncludeInPublish && _publishPackageExclusions != null && _publishPackageExclusions.Contains(package.Name))
+                {
+                    shouldIncludeInPublish = false;
+                }
+
+                if (shouldCopyLocal == false && shouldIncludeInPublish == false)
+                {
+                    return false;
+                }
+
+                if (shouldCopyLocal)
+                {
+                    WriteMetadata(MetadataKeys.CopyLocal, "true");
+                    if (!shouldIncludeInPublish)
+                    {
+                        WriteMetadata(MetadataKeys.CopyToPublishDirectory, "false");
+                    }
+                }
                 WriteMetadata(
                     MetadataKeys.DestinationSubPath,
                     string.IsNullOrEmpty(destinationSubDirectory) ?
@@ -1272,6 +1289,8 @@ private void WriteCopyLocalMetadata(LockFileTargetLibrary package, string assets
                 {
                     WriteMetadata(MetadataKeys.DestinationSubDirectory, destinationSubDirectory);
                 }
+
+                return true;
             }
 
             private int GetMetadataIndex(string value)
@@ -1286,14 +1305,9 @@ private int GetMetadataIndex(string value)
                 return index;
             }
 
-            private bool ShouldCopyLocalPackageAssets(LockFileTargetLibrary package)
-            {
-                return _copyLocalPackageExclusions == null || !_copyLocalPackageExclusions.Contains(package.Name);
-            }
-
-            private HashSet<string> GetCopyLocalPackageExclusions()
+            private void ComputePackageExclusions()
             {
-                var packageExclusions = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
+                var copyLocalPackageExclusions = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
                 var libraryLookup = _runtimeTarget.Libraries.ToDictionary(p => p.Name, StringComparer.OrdinalIgnoreCase);
 
                 // Only exclude platform packages for framework-dependent applications
@@ -1304,7 +1318,7 @@ private HashSet<string> GetCopyLocalPackageExclusions()
                     var platformLibrary = _runtimeTarget.GetLibrary(_task.PlatformLibraryName);
                     if (platformLibrary != null)
                     {
-                        packageExclusions.UnionWith(_runtimeTarget.GetPlatformExclusionList(platformLibrary, libraryLookup));
+                        copyLocalPackageExclusions.UnionWith(_runtimeTarget.GetPlatformExclusionList(platformLibrary, libraryLookup));
 
                         // If the platform library is not Microsoft.NETCore.App, treat it as an implicit dependency.
                         // This makes it so Microsoft.AspNet.* 2.x platforms also exclude Microsoft.NETCore.App files.
@@ -1313,70 +1327,80 @@ private HashSet<string> GetCopyLocalPackageExclusions()
                             var library = _runtimeTarget.GetLibrary(NetCorePlatformLibrary);
                             if (library != null)
                             {
-                                packageExclusions.UnionWith(_runtimeTarget.GetPlatformExclusionList(library, libraryLookup));
+                                copyLocalPackageExclusions.UnionWith(_runtimeTarget.GetPlatformExclusionList(library, libraryLookup));
                             }
                         }
                     }
                 }
 
-                if (_task.ExcludeFromOutputPackageReferences != null && _task.ExcludeFromOutputPackageReferences.Any())
+                if (_task.PackageReferences != null)
                 {
-                    var topLevelDependencies = ProjectContext.GetTopLevelDependencies(_lockFile, _runtimeTarget);
+                    var excludeFromPublishPackageReferences = _task.PackageReferences
+                        .Where(pr => pr.GetBooleanMetadata(MetadataKeys.Publish) == false)
+                        .ToList();
 
-                    //  Exclude transitive dependencies of excluded packages unless they are also dependencies
-                    //  of non-excluded packages
+                    if (excludeFromPublishPackageReferences.Any())
+                    {
 
-                    HashSet<string> includedDependencies = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
-                    HashSet<string> excludeFromOutputPackageIds = new HashSet<string>(
-                        _task.ExcludeFromOutputPackageReferences.Select(pr => pr.ItemSpec),
-                        StringComparer.OrdinalIgnoreCase);
+                        var topLevelDependencies = ProjectContext.GetTopLevelDependencies(_lockFile, _runtimeTarget);
 
-                    Stack<string> dependenciesToWalk = new Stack<string>(
-                        topLevelDependencies.Except(excludeFromOutputPackageIds, StringComparer.OrdinalIgnoreCase));
+                        //  Exclude transitive dependencies of excluded packages unless they are also dependencies
+                        //  of non-excluded packages
 
-                    while (dependenciesToWalk.Any())
-                    {
-                        var dependencyName = dependenciesToWalk.Pop();
-                        if (!includedDependencies.Contains(dependencyName))
+                        HashSet<string> includedDependencies = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
+                        HashSet<string> excludeFromPublishPackageIds = new HashSet<string>(
+                            excludeFromPublishPackageReferences.Select(pr => pr.ItemSpec),
+                            StringComparer.OrdinalIgnoreCase);
+
+                        Stack<string> dependenciesToWalk = new Stack<string>(
+                            topLevelDependencies.Except(excludeFromPublishPackageIds, StringComparer.OrdinalIgnoreCase));
+
+                        while (dependenciesToWalk.Any())
                         {
-                            //  There may not be a library in the assets file if a referenced project has
-                            //  PrivateAssets="all" for a package reference, and there is a package in the graph
-                            //  that depends on the same packge.
-                            if (libraryLookup.TryGetValue(dependencyName, out var library))
+                            var dependencyName = dependenciesToWalk.Pop();
+                            if (!includedDependencies.Contains(dependencyName))
                             {
-                                includedDependencies.Add(dependencyName);
-                                foreach (var newDependency in library.Dependencies)
+                                //  There may not be a library in the assets file if a referenced project has
+                                //  PrivateAssets="all" for a package reference, and there is a package in the graph
+                                //  that depends on the same packge.
+                                if (libraryLookup.TryGetValue(dependencyName, out var library))
                                 {
-                                    dependenciesToWalk.Push(newDependency.Id);
+                                    includedDependencies.Add(dependencyName);
+                                    foreach (var newDependency in library.Dependencies)
+                                    {
+                                        dependenciesToWalk.Push(newDependency.Id);
+                                    }
                                 }
                             }
                         }
-                    }
 
-                    foreach (var library in _runtimeTarget.Libraries)
-                    {
-                        //  Libraries explicitly marked as exclude from publish should be excluded from
-                        //  publish even if there are other transitive dependencies to them
-                        if (excludeFromOutputPackageIds.Contains(library.Name))
+                        var publishPackageExclusions = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
+
+                        foreach (var library in _runtimeTarget.Libraries)
                         {
-                            packageExclusions.Add(library.Name);
+                            //  Libraries explicitly marked as exclude from publish should be excluded from
+                            //  publish even if there are other transitive dependencies to them
+                            if (publishPackageExclusions.Contains(library.Name))
+                            {
+                                publishPackageExclusions.Add(library.Name);
+                            }
+
+                            if (!includedDependencies.Contains(library.Name))
+                            {
+                                publishPackageExclusions.Add(library.Name);
+                            }
                         }
 
-                        if (!includedDependencies.Contains(library.Name))
+                        if (publishPackageExclusions.Any())
                         {
-                            packageExclusions.Add(library.Name);
+                            _publishPackageExclusions = publishPackageExclusions;
                         }
                     }
-
                 }
 
-                if (packageExclusions.Any())
-                {
-                    return packageExclusions;
-                }
-                else
+                if (copyLocalPackageExclusions.Any())
                 {
-                    return null;
+                    _copyLocalPackageExclusions = copyLocalPackageExclusions;
                 }
             }
 

src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.CrossGen.targets

@@ -259,7 +259,7 @@ Copyright (c) .NET Foundation. All rights reserved.
                            _SetupStageForCrossgen;
                            ResolveFrameworkReferences;
                            ApplyImplicitVersions;
-                           _ComputeExcludeFromOutputPackageReferences"
+                           _ComputePackageReferencePublish"
           Condition="$(SkipOptimization) != 'true' ">
 
     <ItemGroup>
@@ -274,6 +274,7 @@ Copyright (c) .NET Foundation. All rights reserved.
                              StorePackageName=$(MicrosoftNETPlatformLibrary);
                              StorePackageVersion=%(PackageReferenceForCrossGen.Version);"/>
 
+    <!-- TODO: Use ResolvePackageAssets instead of ResolveCopyLocalAssets, delete ResolveCopyLocalAssets task -->
     <ResolveCopyLocalAssets Condition="'$(_TargetFrameworkVersionWithoutV)' &lt; '3.0'"
                             AssetsFilePath="$(_CrossProjAssetsFile)"
                             TargetFramework="$(_TFM)"