Skip to content

Fix locked-mode lock file validation for ATF project references #7312

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

Merged
nkolev92 merged 3 commits into from
Apr 23, 2026
+200 −6
Merged

Fix locked-mode lock file validation for ATF project references #7312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a524a6
GetReferenceNearest disambiguation
nkolev92 Mar 19, 2026
552b529
cleanup
nkolev92 Apr 21, 2026
c13fb09
remove redundant comment
nkolev92 Apr 23, 2026
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
17 changes: 11 additions & 6 deletions src/NuGet.Core/NuGet.ProjectModel/ProjectLockFile/PackagesLockFileUtilities.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,15 +228,20 @@ public static LockFileValidationResult IsLockFileValid(DependencyGraphSpec dgSpe
}
else
{
// This does not consider ATF.
p2pSpecTargetFrameworkInformation = NuGetFrameworkUtility.GetNearest(p2pSpec.TargetFrameworks, restoreMetadataFramework.FrameworkName, e => e.FrameworkName);
p2pSpecTargetFrameworkInformation = p2pSpec.GetNearestTargetFramework(targetFrameworkInformation.FrameworkName, targetFrameworkInformation.TargetAlias);
if (p2pSpecTargetFrameworkInformation.FrameworkName == null)
{
if (targetFrameworkInformation.FrameworkName is AssetTargetFallbackFramework atfFramework)
{
p2pSpecTargetFrameworkInformation = p2pSpec.GetNearestTargetFramework(atfFramework.AsFallbackFramework(), targetFrameworkInformation.TargetAlias);
}
}
}
// No compatible framework found
if (p2pSpecTargetFrameworkInformation != null)
if (p2pSpecTargetFrameworkInformation != null && p2pSpecTargetFrameworkInformation.FrameworkName != null)
{
// We need to compare the main framework only. Ignoring fallbacks.
var p2pSpecProjectRestoreMetadataFrameworkInfo = p2pSpec.RestoreMetadata.TargetFrameworks.FirstOrDefault(
t => NuGetFramework.Comparer.Equals(p2pSpecTargetFrameworkInformation.FrameworkName, t.FrameworkName));
// Get it based on the matching alias. The appropriate target framework information has already been calculated.
var p2pSpecProjectRestoreMetadataFrameworkInfo = p2pSpec.RestoreMetadata.TargetFrameworks.FirstOrDefault(e => e.TargetAlias == p2pSpecTargetFrameworkInformation.TargetAlias);

if (p2pSpecProjectRestoreMetadataFrameworkInfo != null)
{
Expand Down
189 changes: 189 additions & 0 deletions test/NuGet.Core.FuncTests/NuGet.Commands.FuncTest/RestoreCommand_PackagesLockFileTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

#nullable disable

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
Expand Down Expand Up @@ -1678,5 +1679,193 @@ public async Task RestoreCommand_PackagesLockFile_InLockedMode_WithAliasedFramew
logger.ErrorMessages.Single().Should().Contain("NU1004");
logger.ErrorMessages.Single().Should().Contain("The project reference project2 has changed");
}

// Verifies project reference through ATF, lock file creation, and locked mode
[Fact]
public async Task RestoreCommand_PackagesLockFile_ProjectReferenceWithATF_LockedModeSucceeds()
{
using var pathContext = new SimpleTestPathContext();
var logger = new TestLogger();

// Create packages
var pkgA = new SimpleTestPackageContext("PackageA", "1.0.0");
await SimpleTestPackageUtility.CreatePackagesAsync(pathContext.PackageSource, pkgA);

var project2Spec = @"
{
""frameworks"": {
""net472"": {
""dependencies"": {
""PackageA"": {
""version"": ""[1.0.0,)"",
""target"": ""Package"",
}
}
}
}
}";

var project2 = ProjectTestHelpers.GetPackageSpecWithProjectNameAndSpec("Project2", pathContext.SolutionRoot, project2Spec);

var project1Spec = @"
{
""frameworks"": {
""net10.0"": {
""assetTargetFallback"": true,
""imports"": [ ""net472"" ],
""warn"": true,
""dependencies"": {
}
}
}
}";

var project1 = ProjectTestHelpers.GetPackageSpecWithProjectNameAndSpec("Project1", pathContext.SolutionRoot, project1Spec);
project1 = project1.WithTestProjectReference(project2);

var lockFilePath = Path.Combine(Path.GetDirectoryName(project1.RestoreMetadata.ProjectPath)!, PackagesLockFileFormat.LockFileName);
project1.RestoreMetadata.RestoreLockProperties = new RestoreLockProperties(
restorePackagesWithLockFile: "true",
lockFilePath,
restoreLockedMode: false);

var result = await new RestoreCommand(ProjectTestHelpers.CreateRestoreRequest(pathContext, logger, project1, project2)).ExecuteAsync();
result.Success.Should().BeTrue(because: string.Join(Environment.NewLine, result.LockFile.LogMessages.Select(e => e.Message)));
Comment thread
nkolev92 marked this conversation as resolved.
await result.CommitAsync(logger, CancellationToken.None);

// Verify lock file was created and has correct alias-aware structure
File.Exists(lockFilePath).Should().BeTrue();
var packagesLockFile = PackagesLockFileFormat.Read(lockFilePath);
packagesLockFile.Targets.Should().HaveCount(1);
packagesLockFile.Targets[0].Dependencies.Should().HaveCount(2);
Comment thread
nkolev92 marked this conversation as resolved.

// Enable locked mode
project1.RestoreMetadata.RestoreLockProperties = new RestoreLockProperties(
restorePackagesWithLockFile: "true",
lockFilePath,
restoreLockedMode: true);
logger.Clear();

// Second restore in locked mode
result = await new RestoreCommand(ProjectTestHelpers.CreateRestoreRequest(pathContext, logger, project1, project2)).ExecuteAsync();
result.Success.Should().BeTrue(logger.ShowErrors());
}

// P1 (apple;banana net10.0 with ATF net472) -> Project2 (apple;banana net472) -> PackageA
// Verifies project reference through alias disambiguation with ATF, lock file creation, and locked mode
[Fact]
public async Task RestoreCommand_PackagesLockFile_WithAliasesOfSameFramework_ProjectReferenceWithATF_LockedModeSucceeds()
{
using var pathContext = new SimpleTestPathContext();
var logger = new TestLogger();

// Create packages
var pkgA = new SimpleTestPackageContext("PackageA", "1.0.0");
var pkgB = new SimpleTestPackageContext("PackageB", "1.0.0");
await SimpleTestPackageUtility.CreatePackagesAsync(pathContext.PackageSource, pkgA, pkgB);

string apple = nameof(apple);
string banana = nameof(banana);

// Create Project2 spec with apple;banana aliases both targeting net472
var project2Spec = @"
{
""frameworks"": {
""apple"": {
""framework"": ""net472"",
""targetAlias"": ""apple"",
""dependencies"": {
""PackageA"": {
""version"": ""[1.0.0,)"",
""target"": ""Package"",
}
}
},
""banana"": {
""framework"": ""net472"",
""targetAlias"": ""banana"",
""dependencies"": {
""PackageB"": {
""version"": ""[1.0.0,)"",
""target"": ""Package"",
}
}
}
}
}";

var project2 = ProjectTestHelpers.GetPackageSpecWithProjectNameAndSpec("Project2", pathContext.SolutionRoot, project2Spec);

// Create Project1 spec with apple;banana aliases, both net10.0 with ATF for net472
var project1Spec = @"
{
""frameworks"": {
""apple"": {
""framework"": ""net10.0"",
""targetAlias"": ""apple"",
""assetTargetFallback"": true,
""imports"": [ ""net472"" ],
""warn"": true,
""dependencies"": {
}
},
""banana"": {
""framework"": ""net10.0"",
""targetAlias"": ""banana"",
""assetTargetFallback"": true,
""imports"": [ ""net472"" ],
""warn"": true,
""dependencies"": {
}
}
}
}";

var project1 = ProjectTestHelpers.GetPackageSpecWithProjectNameAndSpec("Project1", pathContext.SolutionRoot, project1Spec);
project1 = project1.WithTestProjectReference(project2);

// Enable lock file on Project1
var lockFilePath = Path.Combine(Path.GetDirectoryName(project1.RestoreMetadata.ProjectPath)!, PackagesLockFileFormat.LockFileName);
project1.RestoreMetadata.RestoreLockProperties = new RestoreLockProperties(
restorePackagesWithLockFile: "true",
lockFilePath,
restoreLockedMode: false);

// First restore - generates lock file
var result = await new RestoreCommand(ProjectTestHelpers.CreateRestoreRequest(pathContext, logger, project1, project2)).ExecuteAsync();
result.Success.Should().BeTrue(because: string.Join(Environment.NewLine, result.LockFile.LogMessages.Select(e => e.Message)));
Comment thread
nkolev92 marked this conversation as resolved.
await result.CommitAsync(logger, CancellationToken.None);

// Verify lock file was created and has correct alias-aware structure
File.Exists(lockFilePath).Should().BeTrue();
var packagesLockFile = PackagesLockFileFormat.Read(lockFilePath);
packagesLockFile.Targets.Should().HaveCount(2);
packagesLockFile.Targets.Should().Contain(t => t.TargetAlias == apple);
packagesLockFile.Targets.Should().Contain(t => t.TargetAlias == banana);
packagesLockFile.Targets[0].Dependencies.Should().HaveCount(2);
packagesLockFile.Targets[1].Dependencies.Should().HaveCount(2);

Comment thread
nkolev92 marked this conversation as resolved.
// Both aliases should resolve Project2 through alias disambiguation with ATF
var appleTarget = result.LockFile.GetTarget(apple, null);
appleTarget.Should().NotBeNull();
appleTarget.Libraries.Should().Contain(e => e.Name!.Equals("Project2"));

var bananaTarget = result.LockFile.GetTarget(banana, null);
bananaTarget.Should().NotBeNull();
bananaTarget.Libraries.Should().Contain(e => e.Name!.Equals("Project2"));

// Enable locked mode
project1.RestoreMetadata.RestoreLockProperties = new RestoreLockProperties(
restorePackagesWithLockFile: "true",
lockFilePath,
restoreLockedMode: true);
logger.Clear();

// Second restore in locked mode
// Lock file validation does not consider ATF for project references (PackagesLockFileUtilities.cs),
// so locked mode fails with NU1004 when the project reference requires ATF.
Comment thread
nkolev92 marked this conversation as resolved.
result = await new RestoreCommand(ProjectTestHelpers.CreateRestoreRequest(pathContext, logger, project1, project2)).ExecuteAsync();
result.Success.Should().BeTrue(logger.ShowErrors());
}
}
}