Correctly process build -outputType switch

Also add a few additional output types to built-in backends. Fixes 7708
wixtoolset · Sep 5, 2023 · f18d7e6 · f18d7e6
1 parent e29b4aa
commit f18d7e6
Show file tree

Hide file tree

Showing 14 changed files with 73 additions and 14 deletions.
diff --git a/src/api/wix/WixToolset.Extensibility/Data/IBindContext.cs b/src/api/wix/WixToolset.Extensibility/Data/IBindContext.cs
@@ -72,6 +72,11 @@ public interface IBindContext
         /// </summary>
         string OutputPath { get; set; }
 
+        /// <summary>
+        /// Output type to bind to.
+        /// </summary>
+        string OutputType { get; set; }
+
         /// <summary>
         /// Type of PDB to create.
         /// </summary>

diff --git a/src/test/burn/TestData/DependencyTests/PatchA/PatchA.wixproj b/src/test/burn/TestData/DependencyTests/PatchA/PatchA.wixproj
@@ -1,7 +1,7 @@
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
 <Project Sdk="WixToolset.Sdk">
   <PropertyGroup>
-    <OutputType>PatchCreation</OutputType>
+    <OutputType>Patch</OutputType>
     <TargetExt>.msp</TargetExt>
     <SuppressSpecificWarnings>1079</SuppressSpecificWarnings>
   </PropertyGroup>

diff --git a/src/test/burn/TestData/DependencyTests/PatchB/PatchB.wixproj b/src/test/burn/TestData/DependencyTests/PatchB/PatchB.wixproj
@@ -1,7 +1,7 @@
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
 <Project Sdk="WixToolset.Sdk">
   <PropertyGroup>
-    <OutputType>PatchCreation</OutputType>
+    <OutputType>Patch</OutputType>
     <TargetExt>.msp</TargetExt>
     <SuppressSpecificWarnings>1079</SuppressSpecificWarnings>
   </PropertyGroup>

diff --git a/src/test/burn/TestData/PatchTests/PatchA2/PatchA2.wixproj b/src/test/burn/TestData/PatchTests/PatchA2/PatchA2.wixproj
@@ -1,12 +1,12 @@
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
 <Project Sdk="WixToolset.Sdk">
   <PropertyGroup>
-    <OutputType>PatchCreation</OutputType>
+    <OutputType>Patch</OutputType>
     <TargetExt>.msp</TargetExt>
     <SuppressSpecificWarnings>1079</SuppressSpecificWarnings>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\PackageAv1\PackageAv1.wixproj" />
     <ProjectReference Include="..\PackageAv1_0_1\PackageAv1_0_1.wixproj" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/test/burn/TestData/SlipstreamTests/PatchA/PatchA.wixproj b/src/test/burn/TestData/SlipstreamTests/PatchA/PatchA.wixproj
@@ -1,12 +1,12 @@
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
 <Project Sdk="WixToolset.Sdk">
   <PropertyGroup>
-    <OutputType>PatchCreation</OutputType>
+    <OutputType>Patch</OutputType>
     <TargetExt>.msp</TargetExt>
     <SuppressSpecificWarnings>1079</SuppressSpecificWarnings>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\PackageAv1\PackageAv1.wixproj" />
     <ProjectReference Include="..\PackageAv1_0_1\PackageAv1_0_1.wixproj" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/test/burn/TestData/SlipstreamTests/PatchAB/PatchAB.wixproj b/src/test/burn/TestData/SlipstreamTests/PatchAB/PatchAB.wixproj
@@ -1,7 +1,7 @@
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
 <Project Sdk="WixToolset.Sdk">
   <PropertyGroup>
-    <OutputType>PatchCreation</OutputType>
+    <OutputType>Patch</OutputType>
     <TargetExt>.msp</TargetExt>
     <SuppressSpecificWarnings>1079</SuppressSpecificWarnings>
   </PropertyGroup>
@@ -11,4 +11,4 @@
     <ProjectReference Include="..\PackageBv1\PackageBv1.wixproj" />
     <ProjectReference Include="..\PackageBv1_0_1\PackageBv1_0_1.wixproj" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/test/burn/TestData/SlipstreamTests/PatchAB2/PatchAB2.wixproj b/src/test/burn/TestData/SlipstreamTests/PatchAB2/PatchAB2.wixproj
@@ -1,7 +1,7 @@
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
 <Project Sdk="WixToolset.Sdk">
   <PropertyGroup>
-    <OutputType>PatchCreation</OutputType>
+    <OutputType>Patch</OutputType>
     <TargetExt>.msp</TargetExt>
     <SuppressSpecificWarnings>1079</SuppressSpecificWarnings>
   </PropertyGroup>
@@ -11,4 +11,4 @@
     <ProjectReference Include="..\PackageBv1\PackageBv1.wixproj" />
     <ProjectReference Include="..\PackageBv1_0_1\PackageBv1_0_1.wixproj" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/wix/WixToolset.Core.Burn/BurnBackendFactory.cs b/src/wix/WixToolset.Core.Burn/BurnBackendFactory.cs
@@ -18,6 +18,7 @@ public bool TryCreateBackend(string outputType, string outputFile, out IBackend
             switch (outputType.ToLowerInvariant())
             {
                 case "bundle":
+                case "burn":
                 case ".exe":
                     backend = new BundleBackend();
                     return true;

diff --git a/src/wix/WixToolset.Core.WindowsInstaller/WindowsInstallerBackendFactory.cs b/src/wix/WixToolset.Core.WindowsInstaller/WindowsInstallerBackendFactory.cs
@@ -18,18 +18,22 @@ public bool TryCreateBackend(string outputType, string outputFile, out IBackend
             switch (outputType?.ToLowerInvariant())
             {
                 case "module":
+                case "msm":
                 case ".msm":
                     backend = new MsmBackend();
                     return true;
 
                 case "msipackage":
                 case "package":
                 case "product":
+                case "msi":
                 case ".msi":
                     backend = new MsiBackend();
                     return true;
 
+                case "msppackage":
                 case "patch":
+                case "msp":
                 case ".msp":
                     backend = new MspBackend();
                     return true;

diff --git a/src/wix/WixToolset.Core/BindContext.cs b/src/wix/WixToolset.Core/BindContext.cs
@@ -42,6 +42,8 @@ internal BindContext(IServiceProvider serviceProvider)
 
         public string OutputPath { get; set; }
 
+        public string OutputType { get; set; }
+
         public PdbType PdbType { get; set; }
 
         public string PdbPath { get; set; }

diff --git a/src/wix/WixToolset.Core/Binder.cs b/src/wix/WixToolset.Core/Binder.cs
@@ -58,18 +58,18 @@ private IBindResult BackendBind(IBindContext context)
 
             var backendFactories = extensionManager.GetServices<IBackendFactory>();
 
-            var entrySection = context.IntermediateRepresentation.Sections.First();
-
             foreach (var factory in backendFactories)
             {
-                if (factory.TryCreateBackend(entrySection.Type.ToString(), context.OutputPath, out var backend))
+                if (factory.TryCreateBackend(context.OutputType, context.OutputPath, out var backend))
                 {
                     var result = backend.Bind(context);
                     return result;
                 }
             }
 
-            // TODO: messaging that a backend could not be found to bind the output type?
+            var messaging = context.ServiceProvider.GetService<IMessaging>();
+
+            messaging.Write(CoreErrors.BackendNotFound(context.OutputType, context.OutputPath));
 
             return null;
         }

diff --git a/src/wix/WixToolset.Core/CommandLine/BuildCommand.cs b/src/wix/WixToolset.Core/CommandLine/BuildCommand.cs
@@ -312,10 +312,18 @@ private void BindPhase(Intermediate output, IReadOnlyCollection<Localization> lo
                     context.IntermediateFolder = this.IntermediateFolder;
                     context.IntermediateRepresentation = resolveResult.IntermediateRepresentation;
                     context.OutputPath = this.OutputPath;
+                    context.OutputType = this.commandLine.OutputType;
                     context.PdbType = inputsOutputs.PdbType;
                     context.PdbPath = inputsOutputs.PdbPath;
                     context.CancellationToken = cancellationToken;
 
+                    if (String.IsNullOrEmpty(context.OutputType))
+                    {
+                        var entrySection = context.IntermediateRepresentation.Sections.First();
+
+                        context.OutputType = entrySection.Type.ToString();
+                    }
+
                     var binder = this.ServiceProvider.GetService<IBinder>();
                     bindResult = binder.Bind(context);
                 }

diff --git a/src/wix/WixToolset.Core/CoreErrors.cs b/src/wix/WixToolset.Core/CoreErrors.cs
@@ -26,6 +26,11 @@ public static Message UnableToOpenFile(SourceLineNumber sourceLineNumbers, strin
             return Message(sourceLineNumbers, Ids.UnableToOpenFile, "Unable to open file: {0}. Error detail: {1}", path, detail);
         }
 
+        public static Message BackendNotFound(string outputType, string outputPath)
+        {
+            return Message(null, Ids.BackendNotFound, "Unable to find a backend to process output type: {0} for output file: {1}. Specify a different output type or output file extension.", outputType, outputPath);
+        }
+
         private static Message Message(SourceLineNumber sourceLineNumber, Ids id, string format, params object[] args)
         {
             return new Message(sourceLineNumber, MessageLevel.Error, (int)id, format, args);
@@ -37,6 +42,7 @@ public enum Ids
             UnableToDeleteFile = 7011,
             UnableToMoveFile = 7012,
             UnableToOpenFile = 7013,
+            BackendNotFound = 7014,
         } // last available is 7099. 7100 is WindowsInstallerBackendWarnings.
     }
 }
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/BadInputFixture.cs b/src/wix/test/WixToolsetTest.CoreIntegration/BadInputFixture.cs
@@ -221,6 +221,39 @@ public void CannotBuildBundleWithReservedVariableNames()
             }
         }
 
+        [Fact]
+        public void CannotBuildWithUnknownOutputType()
+        {
+            var folder = TestData.Get(@"TestData");
+
+            using (var fs = new DisposableFileSystem())
+            {
+                var baseFolder = fs.GetFolder();
+                var intermediateFolder = Path.Combine(baseFolder, "obj");
+                var outputPath = Path.Combine(intermediateFolder, @"test.pkg");
+
+                var result = WixRunner.Execute(new[]
+                {
+                    "build",
+                    Path.Combine(folder, "SimplePackage", "SimplePackage.wxs"),
+                    "-intermediateFolder", intermediateFolder,
+                    "-bindpath", Path.Combine(folder, ".Data"),
+                    "-outputType", "invalid",
+                    "-o", outputPath,
+                });
+
+                var messages = result.Messages.Select(m => m.ToString()).ToList();
+                messages.Sort();
+
+                WixAssert.CompareLineByLine(new[]
+                {
+                    @"Unable to find a backend to process output type: invalid for output file: <folder>\test.pkg. Specify a different output type or output file extension.",
+                }, messages.Select(s => s.Replace(intermediateFolder, "<folder>")).ToArray());
+
+                Assert.Equal(7014, result.ExitCode);
+            }
+        }
+
         [Fact]
         public void GuardsAgainstVariousBundleValuesFromLoc()
         {