Skip to content

[WiX 5] Migrate workloads #16046

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

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

[WiX 5] Migrate workloads #16046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
2ffcb2d
Update CPM
joeloff Aug 13, 2025
60a4564
Update DTF references
joeloff Aug 13, 2025
36db5c1
Update .editorconfig for WiX
joeloff Aug 13, 2025
ded45f5
Remove variables.wxi
joeloff Aug 13, 2025
d174463
Update packages references for workloads project
joeloff Aug 13, 2025
42de590
Add wixproj project stub
joeloff Aug 13, 2025
7a1e989
Fix using statements
joeloff Aug 13, 2025
35259fa
Add .wixproj to embedded templates
joeloff Aug 13, 2025
2283176
Add WiX Project
joeloff Aug 28, 2025
3a754e8
Update manifest MSI
joeloff Sep 2, 2025
710c253
Merge branch 'main' into workloads-wix5
joeloff Sep 2, 2025
ede0f6e
Rewrite some tests for manifests/pack MSIs
joeloff Sep 4, 2025
a5a90dc
Fix unit tests, disable pack groups
joeloff Sep 16, 2025
75c9ed0
Add support for generating wixpacks
joeloff Sep 17, 2025
cdd7984
Update workload set authoring and tests
joeloff Sep 19, 2025
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
4 changes: 4 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ tab_width = 2
indent_size = 4
tab_width = 4

# WiX files
[*.{wixproj,wxs,wxi,wxl,thm}]
indent_size = 2

# New line preferences
csharp_new_line_before_open_brace = all
csharp_new_line_before_else = true
Expand Down
7 changes: 6 additions & 1 deletion Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,13 @@
<PackageVersion Include="Microsoft.OpenApi" Version="1.3.2" />
<PackageVersion Include="Microsoft.OpenApi.Readers" Version="1.3.2" />
<PackageVersion Include="Microsoft.Signed.Wix" Version="$(MicrosoftSignedWixVersion)" />
<PackageVersion Include="Microsoft.WixToolset.Sdk" Version="$(MicrosoftWixToolsetSdkVersion)" />
<PackageVersion Include="Microsoft.VisualStudio.OLE.Interop" Version="7.10.6071" />
<PackageVersion Include="Microsoft.WixToolset.Dtf.Compression" Version="$(MicrosoftWixToolsetSdkVersion)" />
<PackageVersion Include="Microsoft.WixToolset.Dtf.Compression.Cab" Version="$(MicrosoftWixToolsetSdkVersion)" />
<PackageVersion Include="Microsoft.WixToolset.Dtf.Resources" Version="$(MicrosoftWixToolsetSdkVersion)" />
<PackageVersion Include="Microsoft.WixToolset.Dtf.WindowsInstaller" Version="$(MicrosoftWixToolsetSdkVersion)" />
<PackageVersion Include="Microsoft.WixToolset.Dtf.WindowsInstaller.Package" Version="$(MicrosoftWixToolsetSdkVersion)" />
<PackageVersion Include="Microsoft.WixToolset.Sdk" Version="$(MicrosoftWixToolsetSdkVersion)" />
<PackageVersion Include="Mono.Options" Version="5.3.0.1" />
<PackageVersion Include="Moq" Version="4.18.4" />
<PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
Expand Down
21 changes: 13 additions & 8 deletions src/Microsoft.DotNet.Build.Tasks.Workloads.Tests/CreateVisualStudioWorkloadSetTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,35 +15,39 @@ namespace Microsoft.DotNet.Build.Tasks.Workloads.Tests
public class CreateVisualStudioWorkloadSetTests : TestBase
{
[WindowsOnlyFact]
public static void ItCanCreateWorkloadSets()
public void ItCanCreateWorkloadSets()
{
// Create intermediate outputs under %temp% to avoid path issues and make sure it's clean so we don't pick up
// conflicting sources from previous runs.
string baseIntermediateOutputPath = Path.Combine(Path.GetTempPath(), "WLS");
string testCaseDirectory = GetTestCaseDirectory();
string baseIntermediateOutputPath = testCaseDirectory;

if (Directory.Exists(baseIntermediateOutputPath))
{
Directory.Delete(baseIntermediateOutputPath, recursive: true);
}

ITaskItem[] workloadSetPackages = new[]
{
ITaskItem[] workloadSetPackages =
[
new TaskItem(Path.Combine(TestAssetsPath, "microsoft.net.workloads.9.0.100.9.0.100-baseline.1.23464.1.nupkg"))
.WithMetadata(Metadata.MsiVersion, "12.8.45")
};
];

IBuildEngine buildEngine = new MockBuildEngine();
var buildEngine = new MockBuildEngine();

CreateVisualStudioWorkloadSet createWorkloadSetTask = new CreateVisualStudioWorkloadSet()
{
BaseOutputPath = BaseOutputPath,
BaseOutputPath = Path.Combine(testCaseDirectory, "msi"),
BaseIntermediateOutputPath = baseIntermediateOutputPath,
BuildEngine = buildEngine,
OverridePackageVersions = true,

WixToolsetPath = WixToolsetPath,
WorkloadSetPackageFiles = workloadSetPackages
};

Assert.True(createWorkloadSetTask.Execute());
Assert.True(createWorkloadSetTask.Execute(), buildEngine.BuildErrorEvents.Count > 0 ?
buildEngine.BuildErrorEvents[0].Message : "Task failed. No error events");

// Spot check the x64 generated MSI.
ITaskItem msi = createWorkloadSetTask.Msis.Where(i => i.GetMetadata(Metadata.Platform) == "x64").FirstOrDefault();
Expand All @@ -57,6 +61,7 @@ public static void ItCanCreateWorkloadSets()
r.Value == "12.8.45");

// Workload sets are SxS. Verify that we don't have an Upgrade table.
// This requires suppressing the default behavior by setting Package@UpgradeStrategy to "none".
Assert.False(MsiUtils.HasTable(msi.ItemSpec, "Upgrade"));

// Verify the workloadset version directory and only look at the long name version.
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.DotNet.Build.Tasks.Workloads.Tests/CreateVisualStudioWorkloadTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
using Microsoft.Arcade.Test.Common;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
using Microsoft.Deployment.WindowsInstaller;
using WixToolset.Dtf.WindowsInstaller;
using Microsoft.DotNet.Build.Tasks.Workloads.Msi;
using Xunit;

Expand Down
30 changes: 16 additions & 14 deletions ...ft.DotNet.Build.Tasks.Workloads.Tests/Microsoft.DotNet.Build.Tasks.Workloads.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@
<PackageReference Include="Microsoft.Deployment.DotNet.Releases" />
<PackageReference Include="Microsoft.NET.Sdk.WorkloadManifestReader" />
<PackageReference Include="Microsoft.Signed.Wix" />

<PackageReference Include="Microsoft.WixToolset.Dtf.Compression" />
<PackageReference Include="Microsoft.WixToolset.Dtf.Compression.Cab" />
<PackageReference Include="Microsoft.WixToolset.Dtf.Resources" />
<PackageReference Include="Microsoft.WixToolset.Dtf.WindowsInstaller" />
<PackageReference Include="Microsoft.WixToolset.Dtf.WindowsInstaller.Package" />
<PackageReference Include="FluentAssertions" />
</ItemGroup>

Expand All @@ -23,11 +29,14 @@

<!-- Sample packages -->
<ItemGroup>
<!-- Microsoft.wix is the WiX CLI -->
<PackageDownload Include="Microsoft.wix" Version="[$(MicrosoftWixToolsetSdkVersion)]" />
<PackageDownload Include="Microsoft.WixToolset.Heat" Version="[$(MicrosoftWixToolsetSdkVersion)]" />
<PackageDownload Include="Microsoft.Signed.Wix" Version="[$(MicrosoftSignedWixVersion)]" />
<PackageDownload Include="Microsoft.NET.Workload.Mono.ToolChain.Manifest-6.0.200" Version="[$(MicrosoftNETWorkloadMonoToolChainManifest_60200Version)];[$(MicrosoftNETWorkloadMonoToolChainManifest_60200Version_604)]" />
<PackageDownload Include="Microsoft.NET.Workload.Mono.ToolChain.Manifest-6.0.300" Version="[$(MicrosoftNETWorkloadMonoToolChainManifest_60300Version_6021)];[$(MicrosoftNETWorkloadMonoToolChainManifest_60300Version_6022)]" />
<PackageDownload Include="Microsoft.iOS.Templates" Version="[$(MicrosoftiOSTemplatesVersion)];[$(MicrosoftiOSTemplatesVersion160527)]" />
<PackageDownload Include="Microsoft.NET.Workload.Emscripten.net6.Manifest-8.0.100-preview.6" Version="[$(MicrosoftNETWorkloadEmscriptenManifest_80100Preview6Version)]"/>
<PackageDownload Include="Microsoft.NET.Workload.Emscripten.net6.Manifest-8.0.100-preview.6" Version="[$(MicrosoftNETWorkloadEmscriptenManifest_80100Preview6Version)]" />
<!-- We can only test the task properly by building an actual workload end-to-end. EMSDK is the tiniest one available -->
<PackageDownload Include="Microsoft.NET.Workload.Emscripten.Manifest-6.0.200" Version="[$(MicrosoftNETWorkloadEmscriptenManifest_60200Version)]" />
<PackageDownload Include="Microsoft.NET.Runtime.Emscripten.2.0.23.Node.win-x64" Version="[$(MicrosoftNETRuntimeEmscripten2023Nodewin_x64)]" />
Expand All @@ -37,12 +46,14 @@
</ItemGroup>

<ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'">
<PackageReference Include="System.Text.Json" />
<PackageReference Include="System.Text.Json" />
</ItemGroup>

<ItemGroup>
<Content Include="testassets\**\*" CopyToOutputDirectory="PreserveNewest" />
<Content Include="$(NuGetPackageRoot)microsoft.signed.wix\$(MicrosoftSignedWixVersion)\tools\**\*" Link="testassets\wix\%(RecursiveDir)%(Filename)%(Extension)" CopyToOutputDirectory="PreserveNewest" Visible="false" />
<!--<Content Include="$(NuGetPackageRoot)microsoft.signed.wix\$(MicrosoftSignedWixVersion)\tools\**\*" Link="testassets\wix\%(RecursiveDir)%(Filename)%(Extension)" CopyToOutputDirectory="PreserveNewest" Visible="false" />-->
<Content Include="$(NuGetPackageRoot)microsoft.wix\$(MicrosoftWixToolsetSdkVersion)\tools\**\*" Link="testassets\wix\%(RecursiveDir)%(Filename)%(Extension)" CopyToOutputDirectory="PreserveNewest" Visible="false" />
<Content Include="$(NuGetPackageRoot)microsoft.wixtoolset.heat\$(MicrosoftWixToolsetSdkVersion)\tools\**\*" Link="testassets\heat\%(RecursiveDir)%(Filename)%(Extension)" CopyToOutputDirectory="PreserveNewest" Visible="false" />
<Content Include="$(NuGetPackageRoot)microsoft.net.workload.mono.toolchain.manifest-6.0.200\$(MicrosoftNETWorkloadMonoToolChainManifest_60200Version)\*.nupkg" Link="testassets\%(Filename)%(Extension)" CopyToOutputDirectory="PreserveNewest" Visible="false" />
<Content Include="$(NuGetPackageRoot)microsoft.net.workload.mono.toolchain.manifest-6.0.200\$(MicrosoftNETWorkloadMonoToolChainManifest_60200Version_604)\*.nupkg" Link="testassets\%(Filename)%(Extension)" CopyToOutputDirectory="PreserveNewest" Visible="false" />
<Content Include="$(NuGetPackageRoot)microsoft.net.workload.mono.toolchain.manifest-6.0.300\$(MicrosoftNETWorkloadMonoToolChainManifest_60300Version_6022)\*.nupkg" Link="testassets\%(Filename)%(Extension)" CopyToOutputDirectory="PreserveNewest" Visible="false" />
Expand All @@ -62,14 +73,5 @@
<None Remove="testassets\emsdkWorkloadManifest.json" />
<None Remove="testassets\emsdkWorkloadManifest2.json" />
<None Remove="testassets\mauiWorkloadManifest.json" />
</ItemGroup>

<ItemGroup>
<Reference Include="$(WixInstallPath)\Microsoft.Deployment.Resources.dll" />
<Reference Include="$(WixInstallPath)\Microsoft.Deployment.Compression.dll" />
<Reference Include="$(WixInstallPath)\Microsoft.Deployment.Compression.Cab.dll" />
<Reference Include="$(WixInstallPath)\Microsoft.Deployment.WindowsInstaller.dll" />
<Reference Include="$(WixInstallPath)\Microsoft.Deployment.WindowsInstaller.Package.dll" />
</ItemGroup>

</ItemGroup>
</Project>
Loading
Loading