Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/Build.OM.UnitTests/Instance/ProjectItemInstance_Tests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,26 @@ public void AccessorsWithMetadata()
Assert.Equal("v2", item.GetMetadataValue("m2"));
}

/// <summary>
/// Basic ProjectItemInstance with metadata added using ImportMetadata
/// </summary>
[Fact]
public void AccessorsWithImportedMetadata()
{
ProjectItemInstance item = GetItemInstance();

((IMetadataContainer)item).ImportMetadata(new Dictionary<string, string>
{
{ "m1", "v1" },
{ "m2", "v2" },
});

Assert.Equal("m1", item.GetMetadata("m1").Name);
Assert.Equal("m2", item.GetMetadata("m2").Name);
Assert.Equal("v1", item.GetMetadataValue("m1"));
Assert.Equal("v2", item.GetMetadataValue("m2"));
}

/// <summary>
/// Get metadata not present
/// </summary>
Expand Down
27 changes: 24 additions & 3 deletions src/Build/Instance/ProjectItemInstance.cs
Original file line number Diff line number Diff line change
Expand Up @@ -521,6 +521,8 @@ IDictionary ITaskItem2.CloneCustomMetadataEscaped()

IEnumerable<KeyValuePair<string, string>> IMetadataContainer.EnumerateMetadata() => _taskItem.EnumerateMetadata();

void IMetadataContainer.ImportMetadata(IEnumerable<KeyValuePair<string, string>> metadata) => _taskItem.ImportMetadata(metadata);

#region IMetadataTable Members

/// <summary>
Expand Down Expand Up @@ -1034,6 +1036,19 @@ public IEnumerable<KeyValuePair<string, string>> EnumerateMetadata()
}
}

/// <summary>
/// Sets the given metadata.
/// Equivalent to calling <see cref="SetMetadata(string,string)"/> for each item in <paramref name="metadata"/>.
/// </summary>
/// <param name="metadata">The metadata to set.</param>
public void ImportMetadata(IEnumerable<KeyValuePair<string, string>> metadata)
{
ProjectInstance.VerifyThrowNotImmutable(_isImmutable);

_directMetadata ??= new CopyOnWritePropertyDictionary<ProjectMetadataInstance>();
_directMetadata.ImportProperties(metadata.Select(kvp => new ProjectMetadataInstance(kvp.Key, kvp.Value, allowItemSpecModifiers: true)));
}

/// <summary>
/// Used to return metadata from another AppDomain. Can't use yield return because the
/// generated state machine is not marked as [Serializable], so we need to allocate.
Expand Down Expand Up @@ -1371,9 +1386,7 @@ public void CopyMetadataTo(ITaskItem destinationItem, bool addOriginalItemSpec)
originalItemSpec = destinationItem.GetMetadata("OriginalItemSpec");
}

TaskItem destinationAsTaskItem = destinationItem as TaskItem;

if (destinationAsTaskItem != null && destinationAsTaskItem._directMetadata == null)
if (destinationItem is TaskItem destinationAsTaskItem && destinationAsTaskItem._directMetadata == null)
{
ProjectInstance.VerifyThrowNotImmutable(destinationAsTaskItem._isImmutable);

Expand All @@ -1391,6 +1404,14 @@ public void CopyMetadataTo(ITaskItem destinationItem, bool addOriginalItemSpec)
destinationAsTaskItem._itemDefinitions.AddRange(_itemDefinitions);
}
}
else if (destinationItem is IMetadataContainer destinationItemAsMetadataContainer)
{
// The destination implements IMetadataContainer so we can use the ImportMetadata bulk-set operation.
IEnumerable<ProjectMetadataInstance> metadataEnumerable = MetadataCollection;
destinationItemAsMetadataContainer.ImportMetadata(metadataEnumerable
.Where(metadatum => string.IsNullOrEmpty(destinationItem.GetMetadata(metadatum.Name)))
.Select(metadatum => new KeyValuePair<string, string>(metadatum.Name, GetMetadataEscaped(metadatum.Name))));
}
else
{
// OK, most likely the destination item was a Microsoft.Build.Utilities.TaskItem.
Expand Down
12 changes: 12 additions & 0 deletions src/Framework/IMetadataContainer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,17 @@ internal interface IMetadataContainer
/// in the binary logger.
/// </summary>
IEnumerable<KeyValuePair<string, string>> EnumerateMetadata();

/// <summary>
/// Sets the given metadata. The operation is equivalent to calling
/// <see cref="ITaskItem.SetMetadata"/> on all items, but taking
/// advantage of a faster bulk-set operation where applicable. The
/// implementation may not perform the same parameter validation
/// as SetMetadata.
/// </summary>
/// <param name="metadata">The metadata to set. The keys are assumed
/// to be unique and values are assumed to be escaped.
/// </param>
void ImportMetadata(IEnumerable<KeyValuePair<string, string>> metadata);
}
}
3 changes: 3 additions & 0 deletions src/Framework/TaskItemData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ public TaskItemData(ITaskItem original)

IEnumerable<KeyValuePair<string, string>> IMetadataContainer.EnumerateMetadata() => Metadata;

void IMetadataContainer.ImportMetadata(IEnumerable<KeyValuePair<string, string>> metadata)
=> throw new NotImplementedException();

public int MetadataCount => Metadata.Count;

public ICollection MetadataNames => (ICollection)Metadata.Keys;
Expand Down
8 changes: 8 additions & 0 deletions src/Shared/TaskParameter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -856,6 +856,14 @@ private IEnumerable<KeyValuePair<string, string>> EnumerateMetadataLazy()
yield return unescaped;
}
}

public void ImportMetadata(IEnumerable<KeyValuePair<string, string>> metadata)
{
foreach (KeyValuePair<string, string> kvp in metadata)
{
SetMetadata(kvp.Key, kvp.Value);
}
}
}
}
}
60 changes: 32 additions & 28 deletions src/Tasks/AssemblyDependency/ReferenceTable.cs
Original file line number Diff line number Diff line change
Expand Up @@ -852,8 +852,7 @@ private static AssemblyNameExtension GetAssemblyNameFromItemMetadata(ITaskItem i
name = item.GetMetadata(FileUtilities.ItemSpecModifiers.Filename);
}

AssemblyName assemblyName = new AssemblyName($"{name}, Version={version}, Culture=neutral, PublicKeyToken={publicKeyToken}");
return new AssemblyNameExtension(assemblyName);
return new AssemblyNameExtension($"{name}, Version={version}, Culture=neutral, PublicKeyToken={publicKeyToken}");
}

/// <summary>
Expand Down Expand Up @@ -2677,37 +2676,45 @@ private ITaskItem SetItemMetadata(List<ITaskItem> relatedItems, List<ITaskItem>
// Set up the main item.
TaskItem referenceItem = new TaskItem();
referenceItem.ItemSpec = reference.FullPath;
referenceItem.SetMetadata(ItemMetadataNames.resolvedFrom, reference.ResolvedSearchPath);

// Set the CopyLocal metadata.
referenceItem.SetMetadata(ItemMetadataNames.copyLocal, reference.IsCopyLocal ? "true" : "false");

// Set the Redist name metadata.
if (!String.IsNullOrEmpty(reference.RedistName))
// Enumerate common metadata with an iterator to allow using a more efficient bulk-set operation.
IEnumerable<KeyValuePair<string, string>> EnumerateCommonMetadata()
{
referenceItem.SetMetadata(ItemMetadataNames.redist, reference.RedistName);
}
yield return new KeyValuePair<string, string>(ItemMetadataNames.resolvedFrom, reference.ResolvedSearchPath);

if (Reference.IsFrameworkFile(reference.FullPath, _frameworkPaths) || (_installedAssemblies?.FrameworkAssemblyEntryInRedist(assemblyName) == true))
{
if (!IsAssemblyRemovedFromDotNetFramework(assemblyName, reference.FullPath, _frameworkPaths, _installedAssemblies))
// Set the CopyLocal metadata.
yield return new KeyValuePair<string, string>(ItemMetadataNames.copyLocal, reference.IsCopyLocal ? "true" : "false");

// Set the Redist name metadata.
if (!string.IsNullOrEmpty(reference.RedistName))
{
referenceItem.SetMetadata(ItemMetadataNames.frameworkFile, "true");
yield return new KeyValuePair<string, string>(ItemMetadataNames.redist, reference.RedistName);
}
}

if (!String.IsNullOrEmpty(reference.ImageRuntime))
{
referenceItem.SetMetadata(ItemMetadataNames.imageRuntime, reference.ImageRuntime);
}
if (Reference.IsFrameworkFile(reference.FullPath, _frameworkPaths) || (_installedAssemblies?.FrameworkAssemblyEntryInRedist(assemblyName) == true))
{
if (!IsAssemblyRemovedFromDotNetFramework(assemblyName, reference.FullPath, _frameworkPaths, _installedAssemblies))
{
yield return new KeyValuePair<string, string>(ItemMetadataNames.frameworkFile, "true");
}
}

// The redist root is "null" when there was no IsRedistRoot flag in the Redist XML
// (or there was no redist XML at all for this item).
if (reference.IsRedistRoot != null)
{
referenceItem.SetMetadata(ItemMetadataNames.isRedistRoot, (bool)reference.IsRedistRoot ? "true" : "false");
if (!string.IsNullOrEmpty(reference.ImageRuntime))
{
yield return new KeyValuePair<string, string>(ItemMetadataNames.imageRuntime, reference.ImageRuntime);
}

// The redist root is "null" when there was no IsRedistRoot flag in the Redist XML
// (or there was no redist XML at all for this item).
if (reference.IsRedistRoot != null)
{
yield return new KeyValuePair<string, string>(ItemMetadataNames.isRedistRoot, (bool)reference.IsRedistRoot ? "true" : "false");
}
}

IMetadataContainer referenceItemAsMetadataContainer = referenceItem;
referenceItemAsMetadataContainer.ImportMetadata(EnumerateCommonMetadata());

// If there was a primary source item, then forward metadata from it.
// It's important that the metadata from the primary source item
// win over the same metadata from other source items, so that's
Expand Down Expand Up @@ -2880,10 +2887,7 @@ private ITaskItem SetItemMetadata(List<ITaskItem> relatedItems, List<ITaskItem>
// nonForwardableMetadata should be null here if relatedFileExtensions, satellites, serializationAssemblyFiles, and scatterFiles were all empty.
if (nonForwardableMetadata != null)
{
foreach (KeyValuePair<string, string> kvp in nonForwardableMetadata)
{
referenceItem.SetMetadata(kvp.Key, kvp.Value);
}
referenceItemAsMetadataContainer.ImportMetadata(nonForwardableMetadata);
}

return referenceItem;
Expand Down
19 changes: 19 additions & 0 deletions src/Utilities.UnitTests/TaskItem_Tests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,25 @@ public void SetNullMetadataValue()
item.GetMetadata("m").ShouldBe(string.Empty);
}

[Fact]
public void ImplementsIMetadataContainer()
{
Dictionary<string, string> metadata = new()
{
{ "a", "a1" },
{ "b", "b1" },
};

TaskItem item = new TaskItem("foo");
IMetadataContainer metadataContainer = (IMetadataContainer)item;

metadataContainer.ImportMetadata(metadata);

var actualMetadata = metadataContainer.EnumerateMetadata().OrderBy(metadata => metadata.Key).ToList();
var expectedMetadata = metadata.OrderBy(metadata => metadata.Value).ToList();
Assert.True(actualMetadata.SequenceEqual(expectedMetadata));
}

#if FEATURE_APPDOMAIN
/// <summary>
/// Test that task items can be successfully constructed based on a task item from another appdomain.
Expand Down
6 changes: 6 additions & 0 deletions src/Utilities/TaskItem.cs
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,12 @@ IEnumerable<KeyValuePair<string, string>> IMetadataContainer.EnumerateMetadata()
return EnumerateMetadataLazy();
}

void IMetadataContainer.ImportMetadata(IEnumerable<KeyValuePair<string, string>> metadata)
{
_metadata ??= new CopyOnWriteDictionary<string>(MSBuildNameIgnoreCaseComparer.Default);
_metadata.SetItems(metadata.Select(kvp => new KeyValuePair<string, string>(kvp.Key, kvp.Value ?? string.Empty)));
}

private IEnumerable<KeyValuePair<string, string>> EnumerateMetadataEager()
{
if (_metadata == null)
Expand Down