Create WindowsDesktop sharedfx bundle installer (#7540)

* Copy ExecWithRetries from BuildTools Adds working dir, log importance to ExecWithRetries. Also Inline attemptMessage and add log importance comment. * Add WindowsDesktop sfx bundle installer, refactor Adds bundle creation support to the packaging-tools, and factors the framework pack and runtime WiX files into a single, more flexible, "product" set of WiX files. The old MSI generation directory is removed entirely: with the new "product" WiX files, the host and hostfxr MSI creation can move to the new system. The VS insertion nupkg generation code is also ported from PowerShell to MSBuild to fit the new system. The old system is still used for some macOS pkgs and the macOS bundle installer, some Debian/RPM packages, and some tarballs/zips.
dotnet · Aug 2, 2019 · ccf0024 · ccf0024
1 parent 1919a0d
commit ccf0024
Show file tree

Hide file tree

Showing 94 changed files with 2,218 additions and 1,150 deletions.
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -19,6 +19,13 @@
     <NETCoreAppMaximumVersion>$(MajorVersion).$(MinorVersion)</NETCoreAppMaximumVersion>
   </PropertyGroup>
 
+  <!-- Common target to find all sfxproj. In a target to avoid evaluating for every project. -->
+  <Target Name="GetSharedFrameworkProjects">
+    <ItemGroup>
+      <SharedFrameworkProject Include="$(SourceDir)pkg\projects\**\*.sfxproj" />
+    </ItemGroup>
+  </Target>
+
   <!--
     Arcade SDK versioning is defined by static properties in a targets file: work around this by
     moving properties based on versioning into a target.
@@ -223,10 +230,4 @@
     </PropertyGroup>
   </Target>
 
-  <Target Name="GetBundleDisplayVersion">
-    <PropertyGroup>
-      <BundleDisplayVersion>$(MajorVersion).$(MinorVersion).$(PatchVersion).$(BuildNumberMajor)</BundleDisplayVersion>
-    </PropertyGroup>
-  </Target>
-
 </Project>
diff --git a/Subsets.props b/Subsets.props
@@ -92,13 +92,24 @@
     <ProjectToBuild Include="@(PkgprojProjectToBuild)" />
   </ItemGroup>
 
+  <ItemGroup>
+    <SubsetName
+      Include="Bundle"
+      Description="The shared framework bundle installer projects. Produces .exe installers for Windows." />
+  </ItemGroup>
+  <ItemGroup Condition="'$(SubsetToLower)' == '' or $(SubsetToLower.Contains('bundle'))">
+    <BundleProjectToBuild Include="$(RepoRoot)src\pkg\projects\**\*.bundleproj" SignPhase="BundleInstallerFiles" />
+    <ProjectToBuild Include="@(BundleProjectToBuild)" />
+  </ItemGroup>
+
   <ItemGroup>
     <SubsetName
       Include="Installer"
       Description="Generates additional installers. This produces the shared frameworks and their installers." />
   </ItemGroup>
   <ItemGroup Condition="'$(SubsetToLower)' == '' or $(SubsetToLower.Contains('installer'))">
     <InstallerProjectToBuild Include="$(RepoRoot)src\pkg\packaging\installers.proj" />
+    <InstallerProjectToBuild Include="$(RepoRoot)src\pkg\packaging\vs-insertion-packages.proj" />
     <ProjectToBuild Include="@(InstallerProjectToBuild)" />
   </ItemGroup>
 

diff --git a/eng/Signing.props b/eng/Signing.props
@@ -14,6 +14,10 @@
       Arcade's Sign.proj multiple times for different sets of files as the build progresses.
     -->
     <ItemsToSign Remove="@(ItemsToSign)" />
+
+    <!-- Find bundle artifacts, which need multiple stages to fully sign. -->
+    <BundleInstallerEngineArtifact Include="$(ArtifactsPackagesDir)**/*engine.exe" />
+    <BundleInstallerExeArtifact Include="$(ArtifactsPackagesDir)**/*.exe" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(SignBinaries)' == 'true'">
@@ -38,11 +42,14 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(SignBurnEngineFiles)' == 'true'">
-    <ItemsToSign Include="$(ArtifactsPackagesDir)**/*engine.exe" />
+    <ItemsToSign Include="@(BundleInstallerEngineArtifact)" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(SignBurnBundleFiles)' == 'true'">
-    <ItemsToSign Include="$(ArtifactsPackagesDir)**/*.exe" />
+    <!-- Sign the bundles, now that the engine is reattached. Avoid re-signing the engine. -->
+    <ItemsToSign
+      Include="@(BundleInstallerExeArtifact)"
+      Exclude="@(BundleInstallerEngineArtifact)" />
     <!-- Note: wixstdba is internal to the engine bundle and does not get signed. -->
   </ItemGroup>
 

diff --git a/signing/Directory.Build.targets b/signing/Directory.Build.targets
@@ -1,21 +1,15 @@
 <Project>
 
-  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.targets))\Directory.Build.targets" />
-
-  <!-- If signing is enabled, wait until all projects in this stage are done and sign them. -->
-  <Target Name="Build"
-          Condition="
-            '$(SkipSigning)' != 'true' and
-            '$(OSGroup)' == 'Windows_NT'">
-    <!-- Ensure all projects in this stage have built. -->
-    <MSBuild
-      Projects="@(StageProject)"
-      Targets="Build" />
+  <!-- Ensure all projects in this stage have built. -->
+  <Target Name="EnsureProjectsBuilt">
+    <MSBuild Projects="@(StageProject)" Targets="Build" />
+  </Target>
 
-    <!--
-      Run Arcade's signing project directly. The 'eng/Signing.props' extensibility props file checks
-      if '$(<StageName>)' == 'true' and points Arcade to the correct files.
-    -->
+  <!--
+    Run Arcade's signing project directly. The 'eng/Signing.props' extensibility props file checks
+    if '$(<StageName>)' == 'true' and points Arcade to the correct files.
+  -->
+  <Target Name="RunArcadeSigning">
     <MSBuild
       Projects="$(ArcadeSdkSignProject)"
       Targets="Sign"
@@ -27,4 +21,15 @@
         ArtifactsPackagesDir=$(ArtifactsPackagesDir)" />
   </Target>
 
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.targets))\Directory.Build.targets" />
+
+  <!-- If signing is enabled, wait until all projects in this stage are done and sign them. -->
+  <Target Name="Build"
+          Condition="
+            '$(SkipSigning)' != 'true' and
+            '$(OSGroup)' == 'Windows_NT'"
+          DependsOnTargets="
+            EnsureProjectsBuilt;
+            RunArcadeSigning" />
+
 </Project>
diff --git a/signing/SignBurnBundleFiles.proj b/signing/SignBurnBundleFiles.proj
@@ -1,2 +1,11 @@
 <Project Sdk="Microsoft.NET.Sdk">
+
+  <!-- Before signing the bundles, the engines need to be injected back into the bundles. -->
+  <Target Name="ReattachAllEnginesToBundles"
+          BeforeTargets="RunArcadeSigning">
+    <MSBuild
+      Projects="@(ProjectToBuild -> WithMetadataValue('SignPhase', 'Bundle'))"
+      Targets="ReattachEngineToBundle" />
+  </Target>
+
 </Project>
diff --git a/signing/SignBurnEngineFiles.proj b/signing/SignBurnEngineFiles.proj
@@ -1,2 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk">
+
+  <ItemGroup>
+    <StageProject Include="@(ProjectToBuild -> WithMetadataValue('SignPhase', 'BundleInstallerFiles'))" />
+  </ItemGroup>
+
+  <!-- To sign the burn engines, they need to be extracted from the bundles using WiX tools. -->
+  <Target Name="ExtractAllEngineBundles"
+          BeforeTargets="RunArcadeSigning">
+    <MSBuild Projects="@(StageProject)" Targets="ExtractEngineBundle" />
+  </Target>
+
 </Project>
diff --git a/signing/SignMsiFiles.proj b/signing/SignMsiFiles.proj
@@ -4,4 +4,16 @@
     <StageProject Include="@(ProjectToBuild -> WithMetadataValue('SignPhase', 'MsiFiles'))" />
   </ItemGroup>
 
+  <!--
+    Add shared framework projects to the list to ensure is built. Done in a target because the sfx
+    projects are not available statically.
+  -->
+  <Target Name="EnsureSharedFrameworkProjectsBuilt"
+          DependsOnTargets="GetSharedFrameworkProjects"
+          BeforeTargets="EnsureProjectsBuilt">
+    <ItemGroup>
+      <StageProject Include="@(SharedFrameworkProjects)" />
+    </ItemGroup>
+  </Target>
+
 </Project>
diff --git a/src/pkg/Directory.Build.props b/src/pkg/Directory.Build.props
@@ -63,13 +63,6 @@
     <WixObjRoot>$(IntermediateOutputRootPath)wix/</WixObjRoot>
     <WixObjDir>$(WixObjRoot)$(MSBuildProjectName)/</WixObjDir>
     <MsiArch>$(TargetArchitecture)</MsiArch>
-    <MicrosoftEulaFile>$(MSBuildThisFileDirectory)packaging/windows/eula.rtf</MicrosoftEulaFile>
-
-    <GenerateMSI>true</GenerateMSI>
-    <GenerateMSI Condition="'$(TargetArchitecture)' == 'arm' or '$(TargetArchitecture)' == 'arm64'">false</GenerateMSI>
-    <GenerateMSI Condition="'$(OSGroup)' != 'Windows_NT'">false</GenerateMSI>
-
-    <GeneratePkg Condition="'$(OSGroup)' == 'OSX'">true</GeneratePkg>
 
     <!--
       Allow packaging one build's outputs for a different RID. For example, package portable bits

diff --git a/src/pkg/Directory.Build.targets b/src/pkg/Directory.Build.targets
@@ -95,8 +95,7 @@
     Acquire WiX tools, if not present.
   -->
   <Target Name="AcquireWix"
-          DependsOnTargets="GetAcquireWixProperties"
-          Condition="'$(GenerateMSI)' == 'true'">
+          DependsOnTargets="GetAcquireWixProperties">
     <MSBuild Projects="$(AcquireWixProjectFile)" Targets="AcquireWixCore" />
   </Target>
 

diff --git a/src/pkg/packaging-tools/acquire-nuget-exe/acquire-nuget-exe.proj b/src/pkg/packaging-tools/acquire-nuget-exe/acquire-nuget-exe.proj
@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <UsingTask TaskName="DownloadFile" AssemblyFile="$(ArcadeSdkBuildTasksAssembly)" />
+
+  <!--
+    Acquire NuGet.exe, if not present.
+  -->
+  <Target Name="AcquireNuGetExeCore"
+          Condition="!Exists('$(NuGetExeFile)')"
+          DependsOnTargets="GetAcquireNuGetExeProperties">
+    <MakeDir Directories="$(NuGetExeToolDir)" />
+    <DownloadFile
+      Uri="$(NuGetExeDownloadUrl)"
+      DestinationPath="$(NuGetExeFile)"
+      Overwrite="true" />
+  </Target>
+
+  <Import Project="$(MSBuildThisFileDirectory)..\packaging-tools.targets" />
+
+</Project>
diff --git a/src/pkg/packaging-tools/framework.bundle.props b/src/pkg/packaging-tools/framework.bundle.props
@@ -0,0 +1,10 @@
+<Project>
+  <!--
+    Shared properties specific to bundle projects (bundleproj).
+  -->
+
+  <PropertyGroup>
+    <GenerateExeBundle>true</GenerateExeBundle>
+  </PropertyGroup>
+
+</Project>
diff --git a/src/pkg/packaging-tools/framework.bundle.targets b/src/pkg/packaging-tools/framework.bundle.targets
@@ -0,0 +1,23 @@
+<Project ToolsVersion="14.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <!--
+    Shared targets specific to bundle projects (bundleproj).
+  -->
+
+  <Target Name="GetSharedFrameworkBundleInstallerProperties"
+          BeforeTargets="GetInstallerProperties">
+    <Error
+      Condition="'@(BundleComponentReference)' == ''"
+      Text="Bundle project lacks references to components that it should bundle." />
+
+    <PropertyGroup>
+      <InstallerName>$(ShortFrameworkName)-runtime</InstallerName>
+      <WixProductMoniker>$(SharedFrameworkBrandName)</WixProductMoniker>
+    </PropertyGroup>
+  </Target>
+
+  <!-- Target overrides (can't be shared with other package projects) -->
+
+  <Target Name="Build"
+          DependsOnTargets="GenerateInstallers" />
+
+</Project>
diff --git a/src/pkg/packaging-tools/framework.packaging.props b/src/pkg/packaging-tools/framework.packaging.props
@@ -3,6 +3,13 @@
     Shared properties specific to packaging projects (pkgproj).
   -->
 
+  <PropertyGroup>
+    <GenerateDeb>true</GenerateDeb>
+    <GenerateRpm>true</GenerateRpm>
+    <GeneratePkg>true</GeneratePkg>
+    <GenerateMSI>true</GenerateMSI>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.DotNet.Build.Tasks.Packaging" Version="$(MicrosoftDotNetBuildTasksPackagingPackageVersion)" />
   </ItemGroup>

diff --git a/src/pkg/packaging-tools/framework.packaging.targets b/src/pkg/packaging-tools/framework.packaging.targets
@@ -3,6 +3,60 @@
     Shared targets specific to projects building 'Microsoft.*.App*' packages.
   -->
 
+  <Target Name="GetTargetingPackInstallerProperties"
+          Condition="'$(FrameworkPackType)' == 'targeting'"
+          BeforeTargets="GetInstallerProperties">
+    <PropertyGroup>
+      <InstallerName>$(ShortFrameworkName)-targeting-pack</InstallerName>
+      <WixProductMoniker>$(TargetingPackBrandName)</WixProductMoniker>
+      <VSInsertionShortComponentName>TargetingPack</VSInsertionShortComponentName>
+    </PropertyGroup>
+  </Target>
+
+  <Target Name="GetAppHostPackInstallerProperties"
+          Condition="'$(FrameworkPackType)' == 'apphost'"
+          BeforeTargets="GetInstallerProperties">
+    <PropertyGroup>
+      <InstallerName>$(ShortFrameworkName)-apphost-pack</InstallerName>
+      <WixProductMoniker>$(AppHostPackBrandName)</WixProductMoniker>
+      <VSInsertionShortComponentName>AppHostPack</VSInsertionShortComponentName>
+    </PropertyGroup>
+  </Target>
+
+  <Target Name="GetRuntimePackInstallerProperties"
+          Condition="'$(FrameworkPackType)' == 'runtime'"
+          BeforeTargets="GetInstallerGenerationFlags">
+    <!-- Runtime packs are obtained only through NuGet. -->
+    <PropertyGroup>
+      <GenerateDeb>false</GenerateDeb>
+      <GenerateRpm>false</GenerateRpm>
+      <GeneratePkg>false</GeneratePkg>
+      <GenerateMSI>false</GenerateMSI>
+    </PropertyGroup>
+  </Target>
+
+  <!--
+    This targets file is imported for all pkgproj files, but some (like DotNetHostPolicy) don't need
+    installers and just use the normal packaging tooling.
+  -->
+  <Target Name="DisableInstallerGenerationForPkgprojWithoutInstallers"
+          Condition="'$(FrameworkPackType)' == ''"
+          BeforeTargets="GetInstallerGenerationFlags">
+    <PropertyGroup>
+      <GenerateDeb>false</GenerateDeb>
+      <GenerateRpm>false</GenerateRpm>
+      <GeneratePkg>false</GeneratePkg>
+    </PropertyGroup>
+
+    <!--
+      Generate MSIs for projects that build a part of the shared framework (host, hostfxr) with this
+      tooling. Other installer types are not supported and Core-Setup infra generates them.
+    -->
+    <PropertyGroup Condition="'$(GenerateSharedFrameworkPart)' != 'true'">
+      <GenerateMSI>false</GenerateMSI>
+    </PropertyGroup>
+  </Target>
+
   <!--
     Copy the files in the package's data/ dir to a layout directory. This is what the pack installer
     will place in the dotnet install dir.

diff --git a/src/pkg/packaging-tools/framework.sharedfx.props b/src/pkg/packaging-tools/framework.sharedfx.props
@@ -3,6 +3,11 @@
     Shared properties specific to shared framework projects (sfxproj).
   -->
 
+  <PropertyGroup>
+    <GenerateMSI>true</GenerateMSI>
+    <GenerateCompressedArchive>true</GenerateCompressedArchive>
+  </PropertyGroup>
+
   <PropertyGroup>
     <TargetFramework>$(NETCoreAppFramework)</TargetFramework>
     <PackageId>unused</PackageId>

diff --git a/src/pkg/packaging-tools/framework.sharedfx.targets b/src/pkg/packaging-tools/framework.sharedfx.targets
@@ -5,6 +5,19 @@
 
   <UsingTask TaskName="ProcessSharedFrameworkDeps" AssemblyFile="$(LocalBuildToolsTaskFile)" />
 
+  <Target Name="GetSharedFrameworkInstallerProperties"
+          Condition="'$(GenerateSharedFramework)' == 'true'"
+          DependsOnTargets="GetInstallerBrandingNames"
+          BeforeTargets="
+            GetInstallerGenerationFlags;
+            GetInstallerProperties">
+    <PropertyGroup>
+      <InstallerName>$(ShortFrameworkName)-runtime</InstallerName>
+      <WixProductMoniker>$(SharedFrameworkBrandName)</WixProductMoniker>
+      <VSInsertionShortComponentName>SharedFramework</VSInsertionShortComponentName>
+    </PropertyGroup>
+  </Target>
+
   <Target Name="GetPackageReference"
           DependsOnTargets="GetProductVersions"
           BeforeTargets="CollectPackageReferences">