mirrors/dotnet-installer
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove CheckSourceBuiltNupkgConflictUsages target (#13668)

Browse source
This commit is contained in:
Michael Simons 2022-04-19 17:23:25 -05:00 committed by GitHub
parent 038c811c97
commit 2a412d3454
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 0 additions and 191 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
src/SourceBuild/tarball/content/repos/Directory.Build.targets
View file

@ -327,47 +327,9 @@
<Output TaskParameter="PackageInfoItems" ItemName="_PreviouslySourceBuiltPackageInfos" />
</ReadNuGetPackageInfos>
<ItemGroup>
<_KnownOriginPackagePaths Include="$(PrebuiltSourceBuiltPackagesPath)*.nupkg" />
<_KnownOriginPackagePaths Include="$(PrebuiltPackagesPath)*.nupkg" />
<_KnownOriginPackagePaths Include="$(ReferencePackagesDir)*.nupkg" />
</ItemGroup>
<GetSourceBuiltNupkgCacheConflicts SourceBuiltPackageInfos="@(_PreviouslySourceBuiltPackageInfos)"
PackageCacheDir="$(PackagesDir)"
KnownOriginPackagePaths="@(_KnownOriginPackagePaths)">
<Output TaskParameter="ConflictingPackageInfos" ItemName="ConflictingPackageInfos" />
</GetSourceBuiltNupkgCacheConflicts>
<WriteLinesToFile File="$(RepoCompletedSemaphorePath)CreateBuildOutputProps.complete" Overwrite="true" />
</Target>
<Target Name="CheckSourceBuiltNupkgConflictUsages"
DependsOnTargets="GetAllProjectDirectories"
AfterTargets="CreateBuildOutputProps"
Condition="'@(ConflictingPackageInfos)' != ''"
Inputs="$(MSBuildProjectFullPath)"
Outputs="$(RepoCompletedSemaphorePath)CheckSourceBuiltNupkgConflictUsages.complete">
<PropertyGroup>
<_ReportDir>$(ConflictingPackageReportDir)before-$(RepositoryName)/</_ReportDir>
<_ReportDataFile>$(_ReportDir)usage.xml</_ReportDataFile>
<_ProjectAssetsJsonArchiveFile>$(_ReportDir)all-project-assets-json-files.zip</_ProjectAssetsJsonArchiveFile>
</PropertyGroup>
<WritePackageUsageData NuGetPackageInfos="@(ConflictingPackageInfos)"
RootDir="$(ProjectDir)"
DataFile="$(_ReportDataFile)"
ProjectAssetsJsonArchiveFile="$(_ProjectAssetsJsonArchiveFile)" />
<WriteUsageReports DataFile="$(_ReportDataFile)"
OutputDirectory="$(_ReportDir)" />
<Warning Text="Detected packages in the cache that should be source-built, but contents don't match. See $(_ReportDir) for usage details:" />
<Warning Text="%(ConflictingPackageInfos.PackageId)/%(ConflictingPackageInfos.PackageVersion) : %(ConflictingPackageInfos.WarningMessage)" />
<WriteLinesToFile File="$(RepoCompletedSemaphorePath)CheckSourceBuiltNupkgConflictUsages.complete" Overwrite="true" />
</Target>
<Target Name="CreateCombinedRestoreSourceAndVersionProps"
BeforeTargets="Build"
Inputs="$(MSBuildProjectFullPath)"

153
src/SourceBuild/tarball/content/tools-local/tasks/Microsoft.DotNet.SourceBuild.Tasks.XPlat/GetSourceBuiltNupkgCacheConflicts.cs
View file

@ -1,153 +0,0 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
using NuGet.Packaging.Core;
using NuGet.Versioning;
using System;
using System.IO;
using System.Linq;
namespace Microsoft.DotNet.SourceBuild.Tasks
{
/// <summary>
/// For each source-built nupkg info given, ensure that if the package cache contains a package
/// with the same id and version, the cached nupkg is the same as the source-built one.
///
/// If the package cache contains a package with the same package id and version as a
/// source-built one, nuget restore short-circuits and doesn't look for the source-built one.
/// This usually results in prebuilt packages being used, which can either break the build or
/// end up in the outputs.
/// </summary>
public class GetSourceBuiltNupkgCacheConflicts : Task
{
/// <summary>
/// Items containing package id and version of each source-built package.
/// ReadNuGetPackageInfos is recommended to generate these.
///
/// %(Identity): Path to the original nupkg.
/// %(PackageId): Identity of the package.
/// %(PackageVersion): Version of the package.
/// </summary>
[Required]
public ITaskItem[] SourceBuiltPackageInfos { get; set; }
/// <summary>
/// Package cache dir containing nupkgs to compare. Path is expected to be like:
///
/// {PackageCacheDir}/{lowercase id}/{version}/{lowercase id}.{version}.nupkg
/// </summary>
[Required]
public string PackageCacheDir { get; set; }
/// <summary>
/// Paths to packages to compare against when conflicts are detected. Knowing where the
/// package in the cache came from can help diagnose a conflict. For example, is it from
/// prebuilt/source-built? Or does the build not have the nupkg anywhere else, and
/// therefore it most likely came from the internet?
/// </summary>
public string[] KnownOriginPackagePaths { get; set; }
[Output]
public ITaskItem[] ConflictingPackageInfos { get; set; }
public override bool Execute()
{
DateTime startTime = DateTime.Now;
var knownNupkgs = new Lazy<ILookup<PackageIdentity, string>>(() =>
{
Log.LogMessage(
MessageImportance.Low,
$"Reading all {nameof(KnownOriginPackagePaths)} package identities to search " +
"for conflicting package origin...");
return KnownOriginPackagePaths.NullAsEmpty().ToLookup(
ReadNuGetPackageInfos.ReadIdentity,
path => path);
});
ConflictingPackageInfos = SourceBuiltPackageInfos
.Where(item =>
{
string sourceBuiltPath = item.ItemSpec;
string id = item.GetMetadata("PackageId");
string version = item.GetMetadata("PackageVersion");
string packageCachePath = Path.Combine(
PackageCacheDir,
id.ToLowerInvariant(),
version,
$"{id.ToLowerInvariant()}.{version}.nupkg");
if (!File.Exists(packageCachePath))
{
Log.LogMessage(
MessageImportance.Low,
$"OK: Package not found in package cache: {id} {version}");
return false;
}
Log.LogMessage(
MessageImportance.Low,
$"Package id/version found in package cache, verifying: {id} {version}");
byte[] packageCacheBytes = File.ReadAllBytes(packageCachePath);
if (packageCacheBytes.SequenceEqual(File.ReadAllBytes(sourceBuiltPath)))
{
Log.LogMessage(
MessageImportance.Low,
$"OK: Package in cache is identical to source-built: {id} {version}");
return false;
}
Log.LogMessage(
MessageImportance.Low,
"BAD: Source-built nupkg is not byte-for-byte identical " +
$"to nupkg in cache: {id} {version}");
var ident = new PackageIdentity(id, NuGetVersion.Parse(version));
string message = null;
foreach (string knownNupkg in knownNupkgs.Value[ident])
{
if (packageCacheBytes.SequenceEqual(File.ReadAllBytes(knownNupkg)))
{
Log.LogMessage(
MessageImportance.Low,
$"Found identity match with identical contents: {knownNupkg}");
message = (message ?? "Nupkg found at") + $" '{knownNupkg}'";
}
else
{
Log.LogMessage(
MessageImportance.Low,
$"Package identity match, but contents differ: {knownNupkg}");
}
}
item.SetMetadata(
"WarningMessage",
message ??
"Origin nupkg not found in build directory. It may have been " +
"downloaded by NuGet restore.");
return true;
})
.ToArray();
// Tell the user about this task, in case it takes a while.
Log.LogMessage(
MessageImportance.High,
"Checked cache for conflicts with source-built nupkgs. " +
$"Took {DateTime.Now - startTime}");
return !Log.HasLoggedErrors;
}
}
}