Sync IEngine.SetDownloadSource with native side.

Fixes wixtoolset/issues#9018

Author: barnson

src/api/burn/WixToolset.BootstrapperApplicationApi/Engine.cs

@@ -271,9 +271,9 @@ public void SetLocalSource(string packageOrContainerId, string payloadId, string
         }
 
         /// <inheritdoc/>
-        public void SetDownloadSource(string packageOrContainerId, string payloadId, string url, string user, string password)
+        public void SetDownloadSource(string packageOrContainerId, string payloadId, string url, string user, string password, string authorizationHeader)
         {
-            this.engine.SetDownloadSource(packageOrContainerId, payloadId, url, user, password);
+            this.engine.SetDownloadSource(packageOrContainerId, payloadId, url, user, password, authorizationHeader);
         }
 
         /// <inheritdoc/>

src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperEngine.cs

@@ -129,14 +129,15 @@ void SetLocalSource(
             );
 
         /// <summary>
-        /// See <see cref="IEngine.SetDownloadSource(string, string, string, string, string)"/>.
+        /// See <see cref="IEngine.SetDownloadSource(string, string, string, string, string, string)"/>.
         /// </summary>
         void SetDownloadSource(
             [MarshalAs(UnmanagedType.LPWStr)] string wzPackageOrContainerId,
             [MarshalAs(UnmanagedType.LPWStr)] string wzPayloadId,
             [MarshalAs(UnmanagedType.LPWStr)] string wzUrl,
             [MarshalAs(UnmanagedType.LPWStr)] string wzUser,
-            [MarshalAs(UnmanagedType.LPWStr)] string wzPassword
+            [MarshalAs(UnmanagedType.LPWStr)] string wzPassword,
+            [MarshalAs(UnmanagedType.LPWStr)] string wzAuthorizationHeader
             );
 
         /// <summary>

src/api/burn/WixToolset.BootstrapperApplicationApi/IDefaultBootstrapperApplication.cs

@@ -37,14 +37,14 @@ public interface IDefaultBootstrapperApplication : IBootstrapperApplication
         /// <summary>
         /// Fired when the engine has begun acquiring the payload or container.
         /// The BA can change the source using <see cref="IEngine.SetLocalSource(String, String, String)"/>
-        /// or <see cref="IEngine.SetDownloadSource(String, String, String, String, String)"/>.
+        /// or <see cref="IEngine.SetDownloadSource(String, String, String, String, String, String)"/>.
         /// </summary>
         event EventHandler<CacheAcquireBeginEventArgs> CacheAcquireBegin;
 
         /// <summary>
         /// Fired when the engine has completed the acquisition of the payload or container.
         /// The BA can change the source using <see cref="IEngine.SetLocalSource(String, String, String)"/>
-        /// or <see cref="IEngine.SetDownloadSource(String, String, String, String, String)"/>.
+        /// or <see cref="IEngine.SetDownloadSource(String, String, String, String, String, String)"/>.
         /// </summary>
         event EventHandler<CacheAcquireCompleteEventArgs> CacheAcquireComplete;
 

src/api/burn/WixToolset.BootstrapperApplicationApi/IEngine.cs

@@ -174,7 +174,8 @@ public interface IEngine
         /// <param name="url">The new url.</param>
         /// <param name="user">The user name for proxy authentication.</param>
         /// <param name="password">The password for proxy authentication.</param>
-        void SetDownloadSource(string packageOrContainerId, string payloadId, string url, string user, string password);
+        /// <param name="authorizationHeader">Additional proxy authentication header. Not currently used.</param>
+        void SetDownloadSource(string packageOrContainerId, string payloadId, string url, string user, string password, string authorizationHeader);
 
         /// <summary>
         /// Sets numeric variables for the engine.

src/test/burn/TestBA/TestBA.cs

@@ -41,6 +41,7 @@ public class TestBA : BootstrapperApplication
         private int cancelOnProgressAtProgress;
         private int retryExecuteFilesInUse;
         private bool rollingBack;
+        private string forceDownloadSource;
 
         private IBootstrapperCommand Command { get; set; }
 
@@ -375,6 +376,12 @@ protected override void OnCachePackageBegin(CachePackageBeginEventArgs args)
             {
                 this.Log("    CancelCacheAtProgress: {0}", this.cancelCacheAtProgress);
             }
+
+            this.forceDownloadSource = this.ReadPackageAction(args.PackageId, "ForceDownloadSource");
+            if (!String.IsNullOrEmpty(this.forceDownloadSource))
+            {
+                this.Log("    ForceDownloadSource: {0}", this.forceDownloadSource);
+            }
         }
 
         protected override void OnCachePackageNonVitalValidationFailure(CachePackageNonVitalValidationFailureEventArgs args)
@@ -387,6 +394,29 @@ protected override void OnCachePackageNonVitalValidationFailure(CachePackageNonV
             this.Log("OnCachePackageNonVitalValidationFailure() - id: {0}, default: {1}, requested: {2}", args.PackageId, args.Recommendation, args.Action);
         }
 
+        protected override void OnCacheAcquireResolving(CacheAcquireResolvingEventArgs args)
+        {
+            if (!String.IsNullOrEmpty(this.forceDownloadSource))
+            {
+                args.Action = CacheResolveOperation.Download;
+                var url = String.Format(this.forceDownloadSource, args.PayloadId);
+
+                this.Log("OnCacheAcquireResolving: {0} => {1}", this.forceDownloadSource, url);
+
+                this.engine.SetDownloadSource(
+                    String.Empty,
+                    args.PayloadId,
+                    url,
+                    String.Empty,
+                    String.Empty,
+                    String.Empty);
+            }
+            else
+            {
+                this.Log("OnCacheAcquireResolving not forcing download");
+            }
+        }
+
         protected override void OnCacheAcquireProgress(CacheAcquireProgressEventArgs args)
         {
             this.Log("OnCacheAcquireProgress() - container/package: {0}, payload: {1}, progress: {2}, total: {3}, overall progress: {4}%", args.PackageOrContainerId, args.PayloadId, args.Progress, args.Total, args.OverallPercentage);

src/test/burn/WixToolsetTest.BurnE2E/FailureTests.cs

@@ -2,7 +2,6 @@
 
 namespace WixToolsetTest.BurnE2E
 {
-    using System.Threading;
     using WixTestTools;
     using WixToolset.BootstrapperApplicationApi;
     using Xunit;
@@ -12,6 +11,24 @@ public class FailureTests : BurnE2ETests
     {
         public FailureTests(ITestOutputHelper testOutputHelper) : base(testOutputHelper) { }
 
+        [RuntimeFact]
+        public void CanSetDownloadSourceAndForceDownload()
+        {
+            var packageA = this.CreatePackageInstaller("PackageA");
+            var bundleA = this.CreateBundleInstaller("BundleA");
+            var testBAController = this.CreateTestBAController();
+
+            testBAController.SetPackageForceDownloadSource("PackageA", "https://1e1bf2be1c384fd1a0c4c0500eef971b/downloads/payloads/{0}");
+
+            packageA.VerifyInstalled(false);
+
+            bundleA.VerifyUnregisteredAndRemovedFromPackageCache();
+
+            bundleA.Install(0x2ee7/*ERROR_INTERNET_NAME_NOT_RESOLVED*/);
+
+            packageA.VerifyInstalled(false);
+        }
+
         [RuntimeFact]
         public void CanCancelExePackageAndAbandonIt()
         {

src/test/burn/WixToolsetTest.BurnE2E/Utilities/TestBAController.cs

@@ -107,6 +107,16 @@ public void SetPackageCancelExecuteAtProgress(string packageId, int? cancelPoint
             this.SetPackageState(packageId, "CancelExecuteAtProgress", cancelPoint.HasValue ? cancelPoint.ToString() : null);
         }
 
+        /// <summary>
+        /// Forces a download action and sets the download source.
+        /// </summary>
+        /// <param name="packageId">Package identity.</param>
+        /// <param name="actionName">The URL format string.</param>
+        public void SetPackageForceDownloadSource(string packageId, string url)
+        {
+            this.SetPackageState(packageId, "ForceDownloadSource", url);
+        }
+
         /// <summary>
         /// Cancels the execute of a package at the next progess after the specified MSI action start.
         /// </summary>