-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add MSBuild binary log (.binlog) component detector
- Loading branch information
Showing
7 changed files
with
692 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
212 changes: 212 additions & 0 deletions
212
src/Microsoft.ComponentDetection.Detectors/nuget/NuGetMSBuildBinaryLogComponentDetector.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| namespace Microsoft.ComponentDetection.Detectors.NuGet; | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Threading; | ||
| using Microsoft.Build.Locator; | ||
| using Microsoft.Build.Logging.StructuredLogger; | ||
| using Microsoft.ComponentDetection.Contracts; | ||
| using Microsoft.ComponentDetection.Contracts.Internal; | ||
| using Microsoft.ComponentDetection.Contracts.TypedComponent; | ||
| using Microsoft.Extensions.Logging; | ||
|
|
||
| using Task = System.Threading.Tasks.Task; | ||
|
|
||
| public class NuGetMSBuildBinaryLogComponentDetector : FileComponentDetector | ||
| { | ||
| private static readonly HashSet<string> TopLevelPackageItemNames = new HashSet<string>(StringComparer.OrdinalIgnoreCase) | ||
| { | ||
| "PackageReference", | ||
| }; | ||
|
|
||
| // the items listed below represent collection names that NuGet will resolve a package into, along with the metadata value names to get the package name and version | ||
| private static readonly Dictionary<string, (string NameMetadata, string VersionMetadata)> ResolvedPackageItemNames = new Dictionary<string, (string, string)>(StringComparer.OrdinalIgnoreCase) | ||
| { | ||
| ["NativeCopyLocalItems"] = ("NuGetPackageId", "NuGetPackageVersion"), | ||
| ["ResourceCopyLocalItems"] = ("NuGetPackageId", "NuGetPackageVersion"), | ||
| ["RuntimeCopyLocalItems"] = ("NuGetPackageId", "NuGetPackageVersion"), | ||
| ["ResolvedAnalyzers"] = ("NuGetPackageId", "NuGetPackageVersion"), | ||
| ["_PackageDependenciesDesignTime"] = ("Name", "Version"), | ||
| }; | ||
|
|
||
| private static bool isMSBuildRegistered; | ||
|
|
||
| public NuGetMSBuildBinaryLogComponentDetector( | ||
| IObservableDirectoryWalkerFactory walkerFactory, | ||
| ILogger<NuGetMSBuildBinaryLogComponentDetector> logger) | ||
| { | ||
| this.Scanner = walkerFactory; | ||
| this.Logger = logger; | ||
| } | ||
|
|
||
| public override string Id { get; } = "NuGetMSBuildBinaryLog"; | ||
|
|
||
| public override IEnumerable<string> Categories => new[] { Enum.GetName(typeof(DetectorClass), DetectorClass.NuGet) }; | ||
|
|
||
| public override IList<string> SearchPatterns { get; } = new List<string> { "*.binlog" }; | ||
|
|
||
| public override IEnumerable<ComponentType> SupportedComponentTypes { get; } = new[] { ComponentType.NuGet }; | ||
|
|
||
| public override int Version { get; } = 1; | ||
|
|
||
| private static void ProcessResolvedPackageReference(Dictionary<string, HashSet<string>> topLevelDependencies, Dictionary<string, Dictionary<string, string>> projectResolvedDependencies, NamedNode node) | ||
| { | ||
| var doRemoveOperation = node is RemoveItem; | ||
| var doAddOperation = node is AddItem; | ||
| if (TopLevelPackageItemNames.Contains(node.Name)) | ||
| { | ||
| var projectEvaluation = node.GetNearestParent<ProjectEvaluation>(); | ||
| if (projectEvaluation is not null) | ||
| { | ||
| foreach (var child in node.Children.OfType<Item>()) | ||
| { | ||
| var packageName = child.Name; | ||
| if (!topLevelDependencies.TryGetValue(projectEvaluation.ProjectFile, out var topLevel)) | ||
| { | ||
| topLevel = new(StringComparer.OrdinalIgnoreCase); | ||
| topLevelDependencies[projectEvaluation.ProjectFile] = topLevel; | ||
| } | ||
|
|
||
| if (doRemoveOperation) | ||
| { | ||
| topLevel.Remove(packageName); | ||
| } | ||
|
|
||
| if (doAddOperation) | ||
| { | ||
| topLevel.Add(packageName); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| else if (ResolvedPackageItemNames.TryGetValue(node.Name, out var metadataNames)) | ||
| { | ||
| var nameMetadata = metadataNames.NameMetadata; | ||
| var versionMetadata = metadataNames.VersionMetadata; | ||
| var originalProject = node.GetNearestParent<Project>(); | ||
| if (originalProject is not null) | ||
| { | ||
| foreach (var child in node.Children.OfType<Item>()) | ||
| { | ||
| var packageName = GetChildMetadataValue(child, nameMetadata); | ||
| var packageVersion = GetChildMetadataValue(child, versionMetadata); | ||
| if (packageName is not null && packageVersion is not null) | ||
| { | ||
| var project = originalProject; | ||
| while (project is not null) | ||
| { | ||
| if (!projectResolvedDependencies.TryGetValue(project.ProjectFile, out var projectDependencies)) | ||
| { | ||
| projectDependencies = new(StringComparer.OrdinalIgnoreCase); | ||
| projectResolvedDependencies[project.ProjectFile] = projectDependencies; | ||
| } | ||
|
|
||
| if (doRemoveOperation) | ||
| { | ||
| projectDependencies.Remove(packageName); | ||
| } | ||
|
|
||
| if (doAddOperation) | ||
| { | ||
| projectDependencies[packageName] = packageVersion; | ||
| } | ||
|
|
||
| project = project.GetNearestParent<Project>(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static string GetChildMetadataValue(TreeNode node, string metadataItemName) | ||
| { | ||
| var metadata = node.Children.OfType<Metadata>(); | ||
| var metadataValue = metadata.FirstOrDefault(m => m.Name.Equals(metadataItemName, StringComparison.OrdinalIgnoreCase))?.Value; | ||
| return metadataValue; | ||
| } | ||
|
|
||
| protected override Task OnFileFoundAsync(ProcessRequest processRequest, IDictionary<string, string> detectorArgs, CancellationToken cancellationToken = default) | ||
| { | ||
| try | ||
| { | ||
| if (!isMSBuildRegistered) | ||
| { | ||
| // this must happen once per process, and never again | ||
| var defaultInstance = MSBuildLocator.QueryVisualStudioInstances().First(); | ||
| MSBuildLocator.RegisterInstance(defaultInstance); | ||
| isMSBuildRegistered = true; | ||
| } | ||
|
|
||
| var singleFileComponentRecorder = this.ComponentRecorder.CreateSingleFileComponentRecorder(processRequest.ComponentStream.Location); | ||
| var buildRoot = BinaryLog.ReadBuild(processRequest.ComponentStream.Stream); | ||
| this.RecordLockfileVersion(buildRoot.FileFormatVersion); | ||
| this.ProcessBinLog(buildRoot, singleFileComponentRecorder); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| // If something went wrong, just ignore the package | ||
| this.Logger.LogError(e, "Failed to process MSBuild binary log {BinLogFile}", processRequest.ComponentStream.Location); | ||
| } | ||
|
|
||
| return Task.CompletedTask; | ||
| } | ||
|
|
||
| protected override Task OnDetectionFinishedAsync() | ||
| { | ||
| return Task.CompletedTask; | ||
| } | ||
|
|
||
| private void ProcessBinLog(Build buildRoot, ISingleFileComponentRecorder componentRecorder) | ||
| { | ||
| // maps a project path to a set of resolved dependencies | ||
| var projectTopLevelDependencies = new Dictionary<string, HashSet<string>>(StringComparer.OrdinalIgnoreCase); | ||
| var projectResolvedDependencies = new Dictionary<string, Dictionary<string, string>>(StringComparer.OrdinalIgnoreCase); | ||
| buildRoot.VisitAllChildren<BaseNode>(node => | ||
| { | ||
| switch (node) | ||
| { | ||
| case NamedNode namedNode when namedNode is AddItem or RemoveItem: | ||
| ProcessResolvedPackageReference(projectTopLevelDependencies, projectResolvedDependencies, namedNode); | ||
| break; | ||
| default: | ||
| break; | ||
| } | ||
| }); | ||
|
|
||
| // dependencies were resolved per project, we need to re-arrange them to be per package/version | ||
| var projectsPerPackage = new Dictionary<string, HashSet<string>>(StringComparer.OrdinalIgnoreCase); | ||
| foreach (var projectPath in projectResolvedDependencies.Keys) | ||
| { | ||
| var projectDependencies = projectResolvedDependencies[projectPath]; | ||
| foreach (var (packageName, packageVersion) in projectDependencies) | ||
| { | ||
| var key = $"{packageName}/{packageVersion}"; | ||
| if (!projectsPerPackage.TryGetValue(key, out var projectPaths)) | ||
| { | ||
| projectPaths = new HashSet<string>(StringComparer.OrdinalIgnoreCase); | ||
| projectsPerPackage[key] = projectPaths; | ||
| } | ||
|
|
||
| projectPaths.Add(projectPath); | ||
| } | ||
| } | ||
|
|
||
| // report it all | ||
| foreach (var (packageNameAndVersion, projectPaths) in projectsPerPackage) | ||
| { | ||
| var parts = packageNameAndVersion.Split('/', 2); | ||
| var packageName = parts[0]; | ||
| var packageVersion = parts[1]; | ||
| var component = new NuGetComponent(packageName, packageVersion); | ||
| var libraryComponent = new DetectedComponent(component); | ||
| foreach (var projectPath in projectPaths) | ||
| { | ||
| libraryComponent.FilePaths.Add(projectPath); | ||
| } | ||
|
|
||
| componentRecorder.RegisterUsage(libraryComponent); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.