Fix validate errors

Author: briantu

tasks/msi.py

@@ -17,7 +17,7 @@
 from invoke.exceptions import Exit, UnexpectedExit
 
 from tasks.libs.ciproviders.gitlab_api import get_gitlab_repo
-from tasks.libs.common.utils import download_to_tempfile, timed
+from tasks.libs.common.utils import download_to_tempfile, running_in_ci, timed
 from tasks.libs.dependencies import get_effective_dependencies_env
 from tasks.libs.releasing.version import VERSION_RE, _create_version_from_match, get_version
 
@@ -135,6 +135,11 @@ def _ensure_wix_tools(ctx):
     # Note: .NET global tools are invoked directly by name, not with 'dotnet' prefix
     result = ctx.run('wix --version', warn=True, hide=True)
     if not result or result.return_code != 0:
+        if running_in_ci():
+            raise Exit(
+                "WiX tools not found in CI.",
+                code=1,
+            )
         # Install WiX 5.x globally
         print(f"WiX tools not found. Installing WiX {WIX_VERSION} globally...")
         result = ctx.run(f'dotnet tool install --global wix --version {WIX_VERSION}', warn=True)
@@ -177,11 +182,14 @@ def _ensure_wix_extensions(ctx, extensions, version):
                 print(f"WiX extension {expected} already installed")
                 continue
             else:
+                if running_in_ci():
+                    raise Exit(
+                        f"WiX extension {ext} has wrong version {installed_extensions[ext]} in CI, need {version}.",
+                        code=1,
+                    )
                 # Wrong version installed - remove it first
                 print(f"Removing incompatible WiX extension {ext}/{installed_extensions[ext]}...")
                 ctx.run(f'wix extension remove -g {ext}', warn=True, hide=True)
-
-        # Install the extension with the correct version
         print(f"Installing WiX extension {expected}...")
         result = ctx.run(f'wix extension add -g {expected}', warn=True)
         if not result or result.return_code != 0:
@@ -278,6 +286,7 @@ def _build_wxs(ctx, env, outdir, ca_dll):
         raise Exit("Failed to build the MSI WXS.", code=1)
 
     # sign the MakeSfxCA output files
+    # If signing fails due to corrupted PE file / signature, it may be a regression caused by the makesfxca template DLL being previously signed before the embedded files were added to it. For more information refer to `_fix_makesfxca_dll` from `msi.py` in the git history.
     sign_file(ctx, os.path.join(outdir, ca_dll))
 
 
@@ -551,7 +560,9 @@ def validate_msi_createfolder_table(db, allowlist):
 
 
 @task
-def validate_msi(_, allowlist, msi=None):
+def validate_msi(ctx, allowlist, msi=None):
+    print(f"Validating MSI")
+    ctx.run(f'wix msi validate "{msi}"')
     with MsiClosing(msilib.OpenDatabase(msi, msilib.MSIDBOPEN_READONLY)) as db:
         validate_msi_createfolder_table(db, allowlist)
 

tools/windows/DatadogAgentInstaller/WixSetup/Datadog Agent/AgentCustomActions.cs

@@ -586,7 +586,7 @@ public AgentCustomActions()
                 Impersonate = false
             }
                 .SetProperties("DDAGENTUSER_PROCESSED_PASSWORD=[DDAGENTUSER_PROCESSED_PASSWORD], " +
-                               "DDAGENTUSER_PROCESSED_FQ_NAME=[DDAGENTUSER_PROCESSED_FQ_NAME], ")
+                               "DDAGENTUSER_PROCESSED_FQ_NAME=[DDAGENTUSER_PROCESSED_FQ_NAME]")
                 .HideTarget(true);
 
             ConfigureServicesRollback = new CustomAction<CustomActions>(
@@ -601,7 +601,7 @@ public AgentCustomActions()
                 Execute = Execute.rollback,
                 Impersonate = false
             }
-                .SetProperties("DDAGENTUSER_PROCESSED_FQ_NAME=[DDAGENTUSER_PROCESSED_FQ_NAME], ")
+                .SetProperties("DDAGENTUSER_PROCESSED_FQ_NAME=[DDAGENTUSER_PROCESSED_FQ_NAME]")
                 .HideTarget(true);
 
             // WiX built-in StopServices only stops services if the component is changing.

tools/windows/DatadogAgentInstaller/WixSetup/Datadog Agent/AgentInstaller.cs

@@ -362,7 +362,10 @@ public Project Configure()
                 // to be left behind on uninstall.
                 document.FindAll("CreateFolder")
                     .ForEach(x => x.Remove());
+                // Remove auto-generated RemoveFolder elements, except for ProgramMenuDatadog which is needed
+                // for ICE64 compliance (user profile directories must be in RemoveFile table).
                 document.FindAll("RemoveFolder")
+                    .Where(x => !x.HasAttribute("Id", value => value.Contains("ProgramMenuDatadog")))
                     .ForEach(x => x.Remove());
 
                 // Wix# is auto-adding components for the following directories for some reason, which causes them to be placed

tools/windows/DatadogAgentInstaller/WixSetup/MutuallyExclusiveProduct.cs

@@ -31,7 +31,7 @@ public MutuallyExclusiveProducts(string productName, Guid upgradeCode)
         ///
         /// Example WiX:
         ///   <Upgrade Id="PUT-GUID-HERE">
-        ///     <UpgradeVersion Minimum="0.0.0.0" IncludeMinimum="yes" OnlyDetect="yes" Maximum="255.255.0.0" IncludeMaximum="no" Property="MUTUALLY_EXCLUSIVE_PRODUCTS_1" />
+        ///     <UpgradeVersion Minimum="0.0.0" IncludeMinimum="yes" OnlyDetect="yes" Property="MUTUALLY_EXCLUSIVE_PRODUCTS_1" />
         ///   </Upgrade>
         ///   <Condition Message="This product cannot be installed at the same time as [ProductName]. Please uninstall [ProductName] before continuing.">NOT MUTUALLY_EXCLUSIVE_PRODUCTS_1</Condition>
         ///   <Property Id="MUTUALLY_EXCLUSIVE_PRODUCTS_1" Secure="yes" />
@@ -51,14 +51,13 @@ public void Process(ProcessingContext context)
             var upgradeElement = new XElement("Upgrade");
             upgradeElement.SetAttributeValue("Id", UpgradeCode);
 
+            // Note: UpgradeVersion does NOT have an Id attribute in WiX 5
+            // Detect all versions of the conflicting product.
+            // Omitting Maximum means "no upper bound" - detects all versions >= Minimum.
             var upgradeVersionElement = new XElement("UpgradeVersion",
-                new XAttribute("Minimum", "0.0.0.0"),
+                new XAttribute("Minimum", "0.0.0"),
                 new XAttribute("IncludeMinimum", "yes"),
                 new XAttribute("OnlyDetect", "yes"),
-                // 255 is the maximum
-                // https://learn.microsoft.com/en-us/windows/win32/msi/productversion
-                new XAttribute("Maximum", "255.255.0.0"),
-                new XAttribute("IncludeMaximum", "yes"),
                 new XAttribute("Property", propertyName)
             );
             upgradeElement.Add(upgradeVersionElement);