Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include diagnostic level metadata on ResolvedPackageReference #12069

Merged
merged 2 commits into from
Jun 17, 2020
Merged

Include diagnostic level metadata on ResolvedPackageReference #12069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e37ad2
Include diagnostic level metadata on ResolvedPackageReference
drewnoakes Jun 15, 2020
6f5f5c1
Consider target when joining diagnostic to package reference
drewnoakes Jun 16, 2020
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
1 change: 1 addition & 0 deletions src/Tasks/Common/MetadataKeys.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ internal static class MetadataKeys
public const string IsTopLevelDependency = "IsTopLevelDependency";
public const string AllowExplicitVersion = "AllowExplicitVersion";
public const string RelativePath = "RelativePath";
public const string DiagnosticLevel = "DiagnosticLevel";

// Target Metadata
public const string RuntimeIdentifier = "RuntimeIdentifier";
Expand Down
53 changes: 47 additions & 6 deletions src/Tasks/Microsoft.NET.Build.Tasks.UnitTests/GivenAResolvePackageDependenciesTask.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using NuGet.Common;
using Xunit;
using static Microsoft.NET.Build.Tasks.UnitTests.LockFileSnippets;

Expand Down Expand Up @@ -162,6 +163,45 @@ public void ItAssignsExpectedTopLevelDependencies()
});
}

[Fact]
public void ItAssignsDiagnosticLevel()
{
const string target1 = ".NETCoreApp,Version=v1.0";
const string target2 = ".NETCoreApp,Version=v2.0";

string lockFileContent = CreateLockFileSnippet(
targets: new string[] {
CreateTarget(".NETCoreApp,Version=v1.0", TargetLibA, TargetLibB, TargetLibC),
CreateTarget(".NETCoreApp,Version=v1.0/osx.10.11-x64", TargetLibA, TargetLibB, TargetLibC),
},
libraries: new string[] { LibADefn, LibBDefn, LibCDefn },
projectFileDependencyGroups: new string[] { NETCoreGroup, NETCoreOsxGroup },
logs: new[]
{
// LibA
CreateLog(NuGetLogCode.NU1000, LogLevel.Information, "", libraryId: "LibA", targetGraphs: new[] { target1 }),
CreateLog(NuGetLogCode.NU1000, LogLevel.Warning, "", libraryId: "LibA", targetGraphs: new[] { target1 }),
CreateLog(NuGetLogCode.NU1000, LogLevel.Error, "", libraryId: "LibA", targetGraphs: new[] { target1 }),
// LibB
CreateLog(NuGetLogCode.NU1000, LogLevel.Information, "", libraryId: "LibB", targetGraphs: new[] { target1, target2 }),
CreateLog(NuGetLogCode.NU1000, LogLevel.Warning, "", libraryId: "LibB", targetGraphs: new[] { target1, target2 }),
// LibC (wrong target)
CreateLog(NuGetLogCode.NU1000, LogLevel.Information, "", libraryId: "LibB", targetGraphs: new[] { target2 }),
CreateLog(NuGetLogCode.NU1000, LogLevel.Warning, "", libraryId: "LibB", targetGraphs: new[] { target2 })
}
);

var task = GetExecutedTaskFromContents(lockFileContent, out _, target: target1);

var defs = task.PackageDefinitions.ToLookup(def => def.ItemSpec);

defs.Count().Should().Be(3);

defs["LibA/1.2.3"].Single().GetMetadata(MetadataKeys.DiagnosticLevel).Should().Be("Error");
defs["LibB/1.2.3"].Single().GetMetadata(MetadataKeys.DiagnosticLevel).Should().Be("Warning");
defs["LibC/1.2.3"].Single().GetMetadata(MetadataKeys.DiagnosticLevel).Should().BeEmpty();
}

[Fact]
public void ItAssignsExpectedTopLevelDependenciesFromAllTargets()
{
Expand Down Expand Up @@ -788,19 +828,19 @@ public void ItMarksTransitiveProjectReferences()
others.Where(t => t.ItemSpec == "ProjF/1.0.0").Count().Should().Be(1);
}

private static ResolvePackageDependencies GetExecutedTaskFromPrefix(string lockFilePrefix, out LockFile lockFile, bool emitLegacyAssetsFileItems = true)
private static ResolvePackageDependencies GetExecutedTaskFromPrefix(string lockFilePrefix, out LockFile lockFile, bool emitLegacyAssetsFileItems = true, string target = null)
{
lockFile = TestLockFiles.GetLockFile(lockFilePrefix);
return GetExecutedTask(lockFile, emitLegacyAssetsFileItems);
return GetExecutedTask(lockFile, emitLegacyAssetsFileItems, target);
}

private static ResolvePackageDependencies GetExecutedTaskFromContents(string lockFileContents, out LockFile lockFile, bool emitLegacyAssetsFileItems = true)
private static ResolvePackageDependencies GetExecutedTaskFromContents(string lockFileContents, out LockFile lockFile, bool emitLegacyAssetsFileItems = true, string target = null)
{
lockFile = TestLockFiles.CreateLockFile(lockFileContents);
return GetExecutedTask(lockFile, emitLegacyAssetsFileItems);
return GetExecutedTask(lockFile, emitLegacyAssetsFileItems, target);
}

private static ResolvePackageDependencies GetExecutedTask(LockFile lockFile, bool emitLegacyAssetsFileItems)
private static ResolvePackageDependencies GetExecutedTask(LockFile lockFile, bool emitLegacyAssetsFileItems, string target)
{
var resolver = new MockPackageResolver(_packageRoot);

Expand All @@ -809,7 +849,8 @@ private static ResolvePackageDependencies GetExecutedTask(LockFile lockFile, boo
ProjectAssetsFile = lockFile.Path,
ProjectPath = _projectPath,
ProjectLanguage = null,
EmitLegacyAssetsFileItems = emitLegacyAssetsFileItems
EmitLegacyAssetsFileItems = emitLegacyAssetsFileItems,
TargetFrameworkMoniker = target
};

task.Execute().Should().BeTrue();
Expand Down
4 changes: 3 additions & 1 deletion ...Microsoft.NET.Build.Tasks.UnitTests/GivenThatWeWantToGetDependenciesViaDesignTimeBuild.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ public void ItShouldReturnUnresolvedPackageDependenciesWithTypePackage()
{ MetadataKeys.Version, "1.0.0" },
{ MetadataKeys.Path, "some path" },
{ MetadataKeys.ResolvedPath, "" },
{ MetadataKeys.Type, "Unresolved" }
{ MetadataKeys.Type, "Unresolved" },
{ MetadataKeys.DiagnosticLevel, "Warning" }
})
},
PackageDependencies = new ITaskItem[]
Expand All @@ -100,6 +101,7 @@ public void ItShouldReturnUnresolvedPackageDependenciesWithTypePackage()
Assert.Equal("1.0.0", item.GetMetadata(MetadataKeys.Version));
Assert.Equal("some path", item.GetMetadata(MetadataKeys.Path));
Assert.Equal("", item.GetMetadata(MetadataKeys.ResolvedPath));
Assert.Equal("Warning", item.GetMetadata(MetadataKeys.DiagnosticLevel));
Assert.False(item.GetBooleanMetadata(MetadataKeys.IsImplicitlyDefined));
Assert.False(item.GetBooleanMetadata(PreprocessPackageDependenciesDesignTime.ResolvedMetadata));
}
Expand Down
3 changes: 3 additions & 0 deletions src/Tasks/Microsoft.NET.Build.Tasks/PreprocessPackageDependenciesDesignTime.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public class PreprocessPackageDependenciesDesignTime : TaskBase
/// - ResolvedPath = "C:\Users\drnoakes\.nuget\packages\metadataextractor\1.0.0"
/// - Type = "package"
/// - Version = "2.3.0"
/// - DiagnosticLevel = ""
/// </summary>
[Required]
public ITaskItem[] PackageDefinitions { get; set; }
Expand Down Expand Up @@ -122,12 +123,14 @@ protected override void ExecuteCore()
? resolvedPath
: packageDef.GetMetadata(MetadataKeys.Path)) ?? string.Empty;
var isImplicitlyDefined = implicitPackageReferences.Contains(name);
var diagnosticLevel = packageDef.GetMetadata(MetadataKeys.DiagnosticLevel) ?? string.Empty;

var outputItem = new TaskItem(packageDef.ItemSpec);
outputItem.SetMetadata(MetadataKeys.Name, name);
outputItem.SetMetadata(MetadataKeys.Version, version);
outputItem.SetMetadata(MetadataKeys.Path, path);
outputItem.SetMetadata(MetadataKeys.IsImplicitlyDefined, isImplicitlyDefined.ToString());
outputItem.SetMetadata(MetadataKeys.DiagnosticLevel, diagnosticLevel);
outputItem.SetMetadata(ResolvedMetadata, resolved.ToString());

outputItems.Add(outputItem);
Expand Down
18 changes: 18 additions & 0 deletions src/Tasks/Microsoft.NET.Build.Tasks/ResolvePackageDependencies.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ public string ProjectLanguage
/// </summary>
public bool EmitLegacyAssetsFileItems { get; set; } = false;

public string TargetFrameworkMoniker { get; set; }
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only Diagnostic is relevant to TargetFrameworkMoniker? Should "PackageDependencies" be different when TargetFrameworkMoniker is different? (Although "Diagnostic" is the only thing TargetFrameworkMoniker applied to.)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If so, maybe we should call it something like DiagnosticTargetFrameworkMoniker

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The input items have already filtered by TargetFrameworkMoniker in ResolvePackageDependencies. I like keeping this property name the same as the MSBuild property that it comes from. The fact that it's currently only used for diagnostics is kind of an implementation detail.


#endregion

public ResolvePackageDependencies()
Expand Down Expand Up @@ -173,6 +175,8 @@ private void GetPackageAndFileDefinitions()
string resolvedPackagePath = ResolvePackagePath(package);
item.SetMetadata(MetadataKeys.ResolvedPath, resolvedPackagePath ?? string.Empty);

item.SetMetadata(MetadataKeys.DiagnosticLevel, GetPackageDiagnosticLevel(package));

_packageDefinitions.Add(item);

if (!EmitLegacyAssetsFileItems)
Expand Down Expand Up @@ -227,6 +231,20 @@ private void GetPackageAndFileDefinitions()
_fileDefinitions.Add(fileItem);
}
}

string GetPackageDiagnosticLevel(LockFileLibrary package)
{
string target = TargetFrameworkMoniker ?? "";

var messages = LockFile.LogMessages.Where(log => log.LibraryId == package.Name && log.TargetGraphs.Contains(target));

if (!messages.Any())
{
return string.Empty;
}

return messages.Max(log => log.Level).ToString();
}
}

// get target definitions and package and file dependencies
Expand Down
1 change: 1 addition & 0 deletions src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.PackageDependencyResolution.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ Copyright (c) .NET Foundation. All rights reserved.
ProjectAssetsFile="$(ProjectAssetsFile)"
ProjectLanguage="$(Language)"
EmitLegacyAssetsFileItems="$(EmitLegacyAssetsFileItems)"
TargetFrameworkMoniker="$(NuGetTargetMoniker)"
ContinueOnError="ErrorAndContinue">

<Output TaskParameter="PackageDefinitions" ItemName="PackageDefinitions" />
Expand Down