Skip to content

Support different Windows SDK package versions for different target frameworks #27199

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
merged 3 commits into from
Aug 16, 2022
Merged

Support different Windows SDK package versions for different target frameworks #27199

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
a5e6507
Support different Windows SDK package versions for different target f…
dsplaisted Aug 16, 2022
c3fcc83
Fix logic to handle different Windows SDK versions correctly
dsplaisted Aug 16, 2022
492d770
Use separate test folders
dsplaisted Aug 16, 2022
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
27 changes: 25 additions & 2 deletions src/Tasks/Microsoft.NET.Build.Tasks/CreateWindowsSdkKnownFrameworkReferences.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,25 +55,48 @@ protected override void ExecuteCore()
else
{
var normalizedTargetFrameworkVersion = ProcessFrameworkReferences.NormalizeVersion(new Version(TargetFrameworkVersion));

var knownFrameworkReferencesByWindowsSdkVersion = new Dictionary<Version, List<(Version minimumNetVersion, TaskItem knownFrameworkReference)>>();

foreach (var supportedWindowsVersion in WindowsSdkSupportedTargetPlatformVersions)
{
var windowsSdkPackageVersion = supportedWindowsVersion.GetMetadata("WindowsSdkPackageVersion");

if (!string.IsNullOrEmpty(windowsSdkPackageVersion))
{
var minimumNETVersion = supportedWindowsVersion.GetMetadata("MinimumNETVersion");
Version normalizedMinimumVersion = new Version(0, 0, 0);
if (!string.IsNullOrEmpty(minimumNETVersion))
{
var normalizedMinimumVersion = ProcessFrameworkReferences.NormalizeVersion(new Version(minimumNETVersion));
normalizedMinimumVersion = ProcessFrameworkReferences.NormalizeVersion(new Version(minimumNETVersion));
if (normalizedMinimumVersion > normalizedTargetFrameworkVersion)
{
continue;
}
}

knownFrameworkReferences.Add(CreateKnownFrameworkReference(windowsSdkPackageVersion, TargetFrameworkVersion, supportedWindowsVersion.ItemSpec));
if (!Version.TryParse(supportedWindowsVersion.ItemSpec, out var windowsSdkVersionParsed))
{
continue;
}

if (!knownFrameworkReferencesByWindowsSdkVersion.ContainsKey(windowsSdkVersionParsed))
{
knownFrameworkReferencesByWindowsSdkVersion[windowsSdkVersionParsed] = new();
}

knownFrameworkReferencesByWindowsSdkVersion[windowsSdkVersionParsed].Add((normalizedMinimumVersion, CreateKnownFrameworkReference(windowsSdkPackageVersion, TargetFrameworkVersion, supportedWindowsVersion.ItemSpec)));

}
}

foreach (var knownFrameworkReferencesForSdkVersion in knownFrameworkReferencesByWindowsSdkVersion.Values)
{
// If there are multiple WindowsSdkSupportedTargetPlatformVersion items for the same Windows SDK version, choose the one with the highest minimum version.
// That way it is possible to use older packages when targeting older versions of .NET, and newer packages for newer versions of .NET
var highestMinimumVersion = knownFrameworkReferencesForSdkVersion.Max(t => t.minimumNetVersion);
knownFrameworkReferences.AddRange(knownFrameworkReferencesForSdkVersion.Where(t => t.minimumNetVersion == highestMinimumVersion).Select(t => t.knownFrameworkReference));
}
}

KnownFrameworkReferences = knownFrameworkReferences.ToArray();
Expand Down
59 changes: 50 additions & 9 deletions src/Tests/Microsoft.NET.Build.Tests/GivenThatWeWantToBuildAWindowsDesktopProject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,55 @@ public void ItUsesCorrectWindowsSdkPackVersion(string targetFramework, bool? use

var testAsset = _testAssetsManager.CreateTestProject(testProject, identifier: targetFramework + useWindowsSDKPreview + windowsSdkPackageVersion);

string referencedWindowsSdkVersion = GetReferencedWindowsSdkVersion(testAsset);

// The patch version of the Windows SDK Ref pack will change over time, so we use a '*' in the expected version to indicate that and replace it with
// the 4th part of the version number of the resolved package.
if (expectedWindowsSdkPackageVersion.Contains('*'))
{
expectedWindowsSdkPackageVersion = expectedWindowsSdkPackageVersion.Replace("*", new Version(referencedWindowsSdkVersion).Revision.ToString());
}

referencedWindowsSdkVersion.Should().Be(expectedWindowsSdkPackageVersion);
}

[WindowsOnlyTheory]
[InlineData("net5.0-windows10.0.22000.0", "10.0.22000.25")]
[InlineData("net6.0-windows10.0.22000.0", "10.0.22000.26")]
[InlineData("net6.0-windows10.0.19041.0", "10.0.19041.25")]
public void ItUsesTheHighestMatchingWindowsSdkPackageVersion(string targetFramework, string expectedWindowsSdkPackageVersion)
{
var testProject = new TestProject()
{
TargetFrameworks = targetFramework
};

var testAsset = _testAssetsManager.CreateTestProject(testProject, identifier: targetFramework)
.WithProjectChanges(project =>
{
// Add items for available SDK versions for test
var testItems = XElement.Parse(@"
<ItemGroup>
<WindowsSdkSupportedTargetPlatformVersion Remove=""@(WindowsSdkSupportedTargetPlatformVersion)"" />

<WindowsSdkSupportedTargetPlatformVersion Include=""10.0.22621.0"" WindowsSdkPackageVersion=""10.0.22621.26"" MinimumNETVersion=""6.0"" />

<WindowsSdkSupportedTargetPlatformVersion Include=""10.0.22000.0"" WindowsSdkPackageVersion=""10.0.22000.26"" MinimumNETVersion=""6.0"" />
<WindowsSdkSupportedTargetPlatformVersion Include=""10.0.22000.0"" WindowsSdkPackageVersion=""10.0.22000.25"" MinimumNETVersion=""5.0"" />

<WindowsSdkSupportedTargetPlatformVersion Include=""10.0.19041.0"" WindowsSdkPackageVersion=""10.0.19041.25"" MinimumNETVersion=""5.0"" />
</ItemGroup>");

project.Root.Add(testItems);
});

string referencedWindowsSdkVersion = GetReferencedWindowsSdkVersion(testAsset);
referencedWindowsSdkVersion.Should().Be(expectedWindowsSdkPackageVersion);

}

private string GetReferencedWindowsSdkVersion(TestAsset testAsset)
{
var getValueCommand = new GetValuesCommand(testAsset, "PackageDownload", GetValuesCommand.ValueType.Item);
getValueCommand.ShouldRestore = false;
getValueCommand.DependsOnTargets = "_CheckForInvalidConfigurationAndPlatform;CollectPackageDownloads";
Expand All @@ -419,15 +468,7 @@ public void ItUsesCorrectWindowsSdkPackVersion(string targetFramework, bool? use
packageDownloadVersion[0].Should().Be('[');
packageDownloadVersion.Last().Should().Be(']');

// The patch version of the Windows SDK Ref pack will change over time, so we use a '*' in the expected version to indicate that and replace it with
// the 4th part of the version number of the resolved package.
var trimmedPackageDownloadVersion = packageDownloadVersion.Substring(1, packageDownloadVersion.Length - 2);
if (expectedWindowsSdkPackageVersion.Contains('*'))
{
expectedWindowsSdkPackageVersion = expectedWindowsSdkPackageVersion.Replace("*", new Version(trimmedPackageDownloadVersion).Revision.ToString());
}

trimmedPackageDownloadVersion.Should().Be(expectedWindowsSdkPackageVersion);
return packageDownloadVersion.Substring(1, packageDownloadVersion.Length - 2);
}

private string GetPropertyValue(TestAsset testAsset, string propertyName)
Expand Down