From aa33b92c7a2e6b699a11532056485143b0edf4a3 Mon Sep 17 00:00:00 2001
From: Bob Arnson <bob@firegiant.com>
Date: Thu, 27 Sep 2018 20:10:30 -0400
Subject: Report preprocessor exceptions as errors. Fixes
 wixtoolset/issues#5881.

---
 src/WixToolset.Core/CommandLine/BuildCommand.cs    | 12 +++++++++-
 src/WixToolset.Core/CommandLine/CompileCommand.cs  | 25 ++++++++++++++++++---
 .../PreprocessorFixture.cs                         | 26 ++++++++++++++++++++++
 .../TestData/BadIf/Package.en-us.wxl               | 11 +++++++++
 .../TestData/BadIf/Package.wxs                     | 26 ++++++++++++++++++++++
 .../TestData/BadIf/PackageComponents.wxs           | 12 ++++++++++
 .../TestData/BadIf/data/test.txt                   |  1 +
 .../WixToolsetTest.CoreIntegration.csproj          |  4 ++++
 8 files changed, 113 insertions(+), 4 deletions(-)
 create mode 100644 src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/Package.en-us.wxl
 create mode 100644 src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/Package.wxs
 create mode 100644 src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/PackageComponents.wxs
 create mode 100644 src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/data/test.txt

(limited to 'src')

diff --git a/src/WixToolset.Core/CommandLine/BuildCommand.cs b/src/WixToolset.Core/CommandLine/BuildCommand.cs
index b460e48f..16c98c83 100644
--- a/src/WixToolset.Core/CommandLine/BuildCommand.cs
+++ b/src/WixToolset.Core/CommandLine/BuildCommand.cs
@@ -6,6 +6,7 @@ namespace WixToolset.Core.CommandLine
     using System.Collections.Generic;
     using System.IO;
     using System.Linq;
+    using System.Xml.Linq;
     using WixToolset.Data;
     using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
@@ -173,7 +174,16 @@ namespace WixToolset.Core.CommandLine
                 preprocessor.Platform = Platform.X86; // TODO: set this correctly
                 preprocessor.SourcePath = sourceFile.SourcePath;
                 preprocessor.Variables = this.PreprocessorVariables;
-                var document = preprocessor.Execute();
+
+                XDocument document = null;
+                try
+                {
+                    document = preprocessor.Execute();
+                }
+                catch (WixException e)
+                {
+                    this.Messaging.Write(e.Error);
+                }
 
                 if (this.Messaging.EncounteredError)
                 {
diff --git a/src/WixToolset.Core/CommandLine/CompileCommand.cs b/src/WixToolset.Core/CommandLine/CompileCommand.cs
index 6bd0f25a..ec1ce602 100644
--- a/src/WixToolset.Core/CommandLine/CompileCommand.cs
+++ b/src/WixToolset.Core/CommandLine/CompileCommand.cs
@@ -4,26 +4,31 @@ namespace WixToolset.Core.CommandLine
 {
     using System;
     using System.Collections.Generic;
+    using System.Xml.Linq;
     using WixToolset.Data;
     using WixToolset.Extensibility.Data;
+    using WixToolset.Extensibility.Services;
 
     internal class CompileCommand : ICommandLineCommand
     {
         public CompileCommand(IServiceProvider serviceProvider, IEnumerable<SourceFile> sources, IDictionary<string, string> preprocessorVariables)
         {
-            this.PreprocessorVariables = preprocessorVariables;
             this.ServiceProvider = serviceProvider;
+            this.Messaging = serviceProvider.GetService<IMessaging>();
             this.SourceFiles = sources;
+            this.PreprocessorVariables = preprocessorVariables;
         }
 
         private IServiceProvider ServiceProvider { get; }
 
-        public IEnumerable<string> IncludeSearchPaths { get; }
+        public IMessaging Messaging { get; }
 
         private IEnumerable<SourceFile> SourceFiles { get; }
 
         private IDictionary<string, string> PreprocessorVariables { get; }
 
+        public IEnumerable<string> IncludeSearchPaths { get; }
+
         public int Execute()
         {
             foreach (var sourceFile in this.SourceFiles)
@@ -33,7 +38,21 @@ namespace WixToolset.Core.CommandLine
                 preprocessor.Platform = Platform.X86; // TODO: set this correctly
                 preprocessor.SourcePath = sourceFile.SourcePath;
                 preprocessor.Variables = new Dictionary<string, string>(this.PreprocessorVariables);
-                var document = preprocessor.Execute();
+
+                XDocument document = null;
+                try
+                {
+                    document = preprocessor.Execute();
+                }
+                catch (WixException e)
+                {
+                    this.Messaging.Write(e.Error);
+                }
+
+                if (this.Messaging.EncounteredError)
+                {
+                    continue;
+                }
 
                 var compiler = new Compiler(this.ServiceProvider);
                 compiler.OutputPath = sourceFile.OutputPath;
diff --git a/src/test/WixToolsetTest.CoreIntegration/PreprocessorFixture.cs b/src/test/WixToolsetTest.CoreIntegration/PreprocessorFixture.cs
index 9c60c902..ebc713ed 100644
--- a/src/test/WixToolsetTest.CoreIntegration/PreprocessorFixture.cs
+++ b/src/test/WixToolsetTest.CoreIntegration/PreprocessorFixture.cs
@@ -63,6 +63,32 @@ namespace WixToolsetTest.CoreIntegration
                 Assert.Equal(0, result);
             }
         }
+
+        [Fact]
+        public void NonterminatedPreprocessorInstructionShowsSourceLineNumber()
+        {
+            var folder = TestData.Get(@"TestData\BadIf");
+
+            using (var fs = new DisposableFileSystem())
+            {
+                var baseFolder = fs.GetFolder();
+                var intermediateFolder = Path.Combine(baseFolder, "obj");
+
+                var result = WixRunner.Execute(new[]
+                {
+                    "build",
+                    Path.Combine(folder, "Package.wxs"),
+                    Path.Combine(folder, "PackageComponents.wxs"),
+                    "-loc", Path.Combine(folder, "Package.en-us.wxl"),
+                    "-bindpath", Path.Combine(folder, "data"),
+                    "-intermediateFolder", intermediateFolder,
+                    "-o", Path.Combine(baseFolder, @"bin\test.msi")
+                }, out var messages);
+
+                Assert.Equal(147, result);
+                Assert.StartsWith("Found a <?if?>", messages.Single().ToString());
+            }
+        }
     }
 }
 
diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/Package.en-us.wxl b/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/Package.en-us.wxl
new file mode 100644
index 00000000..38c12ac1
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/Package.en-us.wxl
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!--
+This file contains the declaration of all the localizable strings.
+-->
+<WixLocalization xmlns="http://wixtoolset.org/schemas/v4/wxl" Culture="en-US">
+
+  <String Id="DowngradeError">A newer version of [ProductName] is already installed.</String>
+  <String Id="FeatureTitle">MsiPackage</String>
+
+</WixLocalization>
diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/Package.wxs b/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/Package.wxs
new file mode 100644
index 00000000..73577ce5
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/Package.wxs
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Product Id="*" Name="MsiPackage" Language="1033" Version="1.0" Manufacturer="Example Corporation" UpgradeCode="047730a5-30fe-4a62-a520-da9381b8226a">
+    <Package InstallerVersion="200" Compressed="no" InstallScope="perMachine" />
+
+    <MajorUpgrade DowngradeErrorMessage="!(loc.DowngradeError)" />
+    <MediaTemplate />
+
+    <Feature Id="ProductFeature" Title="!(loc.FeatureTitle)">
+        <ComponentGroupRef Id="ProductComponents.x86" />
+        <!-- <?if x64 == $(sys.BUILDARCH) ?> -->
+        <!-- <?if arm==$(sys.BUILDARCH) ?> -->
+        <?if $(sys.BUILDARCH) = "x64" ?>
+        <ComponentGroupRef Id="ProductComponents.x64" />
+        <ComponentGroupRef Id="ProductComponents.arm" />
+    </Feature>
+  </Product>
+
+  <Fragment>
+    <Directory Id="TARGETDIR" Name="SourceDir">
+      <Directory Id="ProgramFilesFolder">
+        <Directory Id="INSTALLFOLDER" Name="MsiPackage" />
+      </Directory>
+    </Directory>
+  </Fragment>
+</Wix>
diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/PackageComponents.wxs b/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/PackageComponents.wxs
new file mode 100644
index 00000000..2a75e3d7
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/PackageComponents.wxs
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+    <?foreach ComponentPlatform in x86;x64;arm ?>
+    <Fragment>
+        <ComponentGroup Id="ProductComponents.$(var.ComponentPlatform)" Directory="INSTALLFOLDER">
+            <Component>
+                <File Name="$(var.ComponentPlatform).dll" Source="test.txt" />
+            </Component>
+        </ComponentGroup>
+    </Fragment>
+    <?endforeach?>
+</Wix>
diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/data/test.txt b/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/data/test.txt
new file mode 100644
index 00000000..cd0db0e1
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/TestData/BadIf/data/test.txt
@@ -0,0 +1 @@
+This is test.txt.
\ No newline at end of file
diff --git a/src/test/WixToolsetTest.CoreIntegration/WixToolsetTest.CoreIntegration.csproj b/src/test/WixToolsetTest.CoreIntegration/WixToolsetTest.CoreIntegration.csproj
index 7c4578d9..38b7dc81 100644
--- a/src/test/WixToolsetTest.CoreIntegration/WixToolsetTest.CoreIntegration.csproj
+++ b/src/test/WixToolsetTest.CoreIntegration/WixToolsetTest.CoreIntegration.csproj
@@ -28,6 +28,10 @@
     <Content Include="TestData\ForEach\Package.en-us.wxl" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="TestData\ForEach\Package.wxs" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="TestData\ForEach\PackageComponents.wxs" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="TestData\BadIf\data\test.txt" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="TestData\BadIf\Package.en-us.wxl" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="TestData\BadIf\Package.wxs" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="TestData\BadIf\PackageComponents.wxs" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="TestData\SingleFile\data\test.txt" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="TestData\SingleFile\Package.en-us.wxl" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="TestData\SingleFile\Package.wxs" CopyToOutputDirectory="PreserveNewest" />
-- 
cgit v1.2.3-55-g6feb