Add CancelWhenDeferred, like FailWhenDeferred.

Useful for integration testing packages.

Author: barnson

src/ext/Util/ca/test.cpp

@@ -39,6 +39,21 @@ static LRESULT CALLBACK WndProc(
     );
 
 
+/******************************************************************
+WixCancelWhenDeferred - entry point for WixCancelWhenDeferred
+    custom action which always cancels when running as a deferred
+    custom action (otherwise it blindly succeeds). It's useful when
+    testing the rollback of deferred custom actions: Schedule it
+    immediately after the rollback/deferred CA pair you're testing
+    and it will fail, causing your rollback CA to get invoked.
+********************************************************************/
+extern "C" UINT __stdcall WixCancelWhenDeferred(
+    __in MSIHANDLE hInstall
+)
+{
+    return ::MsiGetMode(hInstall, MSIRUNMODE_SCHEDULED) ? ERROR_INSTALL_USEREXIT : ERROR_SUCCESS;
+}
+
 /******************************************************************
 WixFailWhenDeferred - entry point for WixFailWhenDeferred
     custom action which always fails when running as a deferred

src/ext/Util/ca/utilca.def

@@ -82,6 +82,7 @@ EXPORTS
     WixShellExecBinary
     WixUnelevatedShellExec
 ; test.cpp
+    WixCancelWhenDeferred
     WixFailWhenDeferred
     WixWaitForEvent
 ; TouchFile.cpp

src/ext/Util/test/WixToolsetTest.Util/TestData/Failures/Package.wxs

@@ -0,0 +1,9 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:util="http://wixtoolset.org/schemas/v4/wxs/util">
+    <Package Name="MsiPackage" Language="1033" Version="1.0.0.0" Manufacturer="Example Corporation" UpgradeCode="047730a5-30fe-4a62-a520-da9381b8226a">
+        <File Source="$(sys.SOURCEFILEPATH)" />
+
+        <!-- Dead or alive, you're coming with me. -->
+        <util:FailWhenDeferred />
+        <util:CancelWhenDeferred />
+    </Package>
+</Wix>

src/ext/Util/test/WixToolsetTest.Util/UtilExtensionFixture.cs

@@ -100,6 +100,21 @@ public void CanBuildCloseApplication()
             }, results.OrderBy(s => s).ToArray());
         }
 
+        [TestMethod]
+        public void CanBuildWithFailures()
+        {
+            var folder = TestData.Get(@"TestData\Failures");
+            var build = new Builder(folder, typeof(UtilExtensionFactory), new[] { folder });
+
+            var results = build.BuildAndQuery(BuildX64, "Binary", "CustomAction");
+            WixAssert.CompareLineByLine(
+            [
+                "Binary:Wix4UtilCA_X64\t[Binary data]",
+                "CustomAction:Wix4CancelWhenDeferred_X64\t1025\tWix4UtilCA_X64\tWixCancelWhenDeferred\t",
+                "CustomAction:Wix4FailWhenDeferred_X64\t1025\tWix4UtilCA_X64\tWixFailWhenDeferred\t",
+            ], [.. results.OrderBy(s => s)]);
+        }
+
         [TestMethod]
         public void CanBuildInternetShortcutInProduct()
         {

src/ext/Util/wixext/UtilCompiler.cs

@@ -210,6 +210,7 @@ public override IComponentKeyPath ParsePossibleKeyPathElement(Intermediate inter
                             break;
                         case "BroadcastEnvironmentChange":
                         case "BroadcastSettingChange":
+                        case "CancelWhenDeferred":
                         case "CheckRebootRequired":
                         case "ExitEarlyWithSuccess":
                         case "FailWhenDeferred":
@@ -328,6 +329,7 @@ public override IComponentKeyPath ParsePossibleKeyPathElement(Intermediate inter
                     {
                         case "BroadcastEnvironmentChange":
                         case "BroadcastSettingChange":
+                        case "CancelWhenDeferred":
                         case "CheckRebootRequired":
                         case "ExitEarlyWithSuccess":
                         case "FailWhenDeferred":
@@ -363,6 +365,7 @@ private void AddCustomActionReference(Intermediate intermediate, IntermediateSec
             {
                 case "BroadcastEnvironmentChange":
                 case "BroadcastSettingChange":
+                case "CancelWhenDeferred":
                 case "CheckRebootRequired":
                 case "ExitEarlyWithSuccess":
                 case "FailWhenDeferred":

src/ext/Util/wixlib/UtilExtension_Platform.wxi

@@ -4,6 +4,14 @@
 <Include xmlns="http://wixtoolset.org/schemas/v4/wxs">
     <?include ..\..\caDecor.wxi ?>
 
+    <Fragment>
+        <CustomAction Id="$(Prefix)CancelWhenDeferred$(Suffix)" DllEntry="WixCancelWhenDeferred" Execute="deferred" Return="check" SuppressModularization="yes" BinaryRef="$(Prefix)UtilCA$(Suffix)" />
+
+        <InstallExecuteSequence>
+            <Custom Action="virtual $(Prefix)CancelWhenDeferred$(Suffix)" Before="InstallFinalize" Condition="WIXCANCELWHENDEFERRED=1 AND VersionNT &gt; 400" />
+        </InstallExecuteSequence>
+    </Fragment>
+
     <Fragment>
         <CustomAction Id="$(var.Prefix)FailWhenDeferred$(var.Suffix)" DllEntry="WixFailWhenDeferred" Execute="deferred" Return="check" SuppressModularization="yes" BinaryRef="$(var.Prefix)UtilCA$(var.Suffix)" />
 

src/xsd/util/CancelWhenDeferred.xsd

@@ -0,0 +1,11 @@
+<element name="CancelWhenDeferred">
+    <annotation>
+      <documentation>Schedules the CancelWhenDeferred custom action for the current platform.</documentation>
+      <appinfo>
+        <parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Package" />
+        <parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Module" />
+        <parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
+        <parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="UI" />
+      </appinfo>
+    </annotation>
+  </element>

src/xsd/util/order.txt

@@ -33,6 +33,7 @@ element|XmlFile
 element|XmlConfig
 element|BroadcastEnvironmentChange
 element|BroadcastSettingChange
+element|CancelWhenDeferred
 element|CheckRebootRequired
 element|ExitEarlyWithSuccess
 element|FailWhenDeferred