Fix XmlConfig lookup logic.

Fixes https://github.com/wixtoolset/issues/issues/7377.
Requires fix for https://github.com/wixtoolset/issues/issues/7444.

8 files changed, 134 insertions, 16 deletions

diff --git a/src/ext/Util/ca/XmlConfig.cpp b/src/ext/Util/ca/XmlConfig.cpp
index 2014e15f..3f059435 100644
--- a/src/ext/Util/ca/XmlConfig.cpp
+++ b/src/ext/Util/ca/XmlConfig.cpp
@@ -266,11 +266,11 @@ static HRESULT ProcessChanges(
         // Keep track of where our next spot will be since our current node may be moved
         pxfcNext = pxfc->pxfcNext;
 
-        // With each node, check to see if it's element path matches the Id of some other node in the list
+        // With each node, check to see if its element path matches the Id of some other node in the list
         pxfcCheck = *ppxfcHead;
         while (pxfcCheck)
         {
-            if (pxfc->pwzElementId)
+            if (pxfc->pwzElementId && *pxfc->pwzElementId)
             {
                 if (0 == lstrcmpW(pxfc->pwzElementId, pxfcCheck->wzId)
                     && 0 == pxfc->iXmlFlags
@@ -315,11 +315,6 @@ static HRESULT ProcessChanges(
                         pxfcCheck->cAdditionalChanges = ++cAdditionalChanges;
                     }
                 }
-                else
-                {
-                    hr = E_NOTFOUND;
-                    ExitOnRootFailure(hr, "failed to find matching ElementId: %ls", pxfc->pwzElementId);
-                }
             }
 
             pxfcCheck = pxfcCheck->pxfcNext;
@@ -402,10 +397,10 @@ static HRESULT WriteChangeData(
 
     HRESULT hr = S_OK;
     XML_CONFIG_CHANGE* pxfcAdditionalChanges = NULL;
-    LPCWSTR wzElementPath = pxfc->pwzElementId ? pxfc->pwzElementId : pxfc->pwzElementPath;
+    LPCWSTR wzElementPath = pxfc->pwzElementId && *pxfc->pwzElementId ? pxfc->pwzElementId : pxfc->pwzElementPath;
 
     hr = WcaWriteStringToCaData(wzElementPath, ppwzCustomActionData);
-    ExitOnFailure(hr, "failed to write ElementPath to custom action data: %ls", wzElementPath);
+    ExitOnFailure(hr, "failed to write ElementId/ElementPath to custom action data: %ls", wzElementPath);
 
     hr = WcaWriteStringToCaData(pxfc->pwzVerifyPath, ppwzCustomActionData);
     ExitOnFailure(hr, "failed to write VerifyPath to custom action data: %ls", pxfc->pwzVerifyPath);
diff --git a/src/ext/Util/test/WixToolsetTest.Util/TestData/XmlConfig/Package.wxs b/src/ext/Util/test/WixToolsetTest.Util/TestData/XmlConfig/Package.wxs
index a2002634..cb132960 100644
--- a/src/ext/Util/test/WixToolsetTest.Util/TestData/XmlConfig/Package.wxs
+++ b/src/ext/Util/test/WixToolsetTest.Util/TestData/XmlConfig/Package.wxs
@@ -1,17 +1,27 @@
-<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:util="http://wixtoolset.org/schemas/v4/wxs/util">
+<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">
         <MajorUpgrade DowngradeErrorMessage="!(loc.DowngradeError)" />
 
         <Feature Id="ProductFeature" Title="!(loc.FeatureTitle)">
+            <Component Directory="INSTALLFOLDER">
+                <File Id="MyXmlFile" Source="my.xml" />
+            </Component>
+            
             <Component Id="Del" Directory="INSTALLFOLDER" Guid="3613414c-11f5-40fa-a1f1-a0ba722a6895">
-                <util:XmlConfig Id="DelElement" File="[INSTALLFOLDER]my.xml" Action="delete" Node="element" VerifyPath="xxx" ElementPath="//root/sub" On="install" Sequence="1" />
+                <util:XmlConfig Id="DelElement" File="[#MyXmlFile]" Action="delete" Node="element" VerifyPath="grandchild1" ElementPath="//root/child1" On="install" />
+            </Component>
+
+            <Component Id="Add" Directory="INSTALLFOLDER" Guid="30A9FF8B-7AC8-47F3-BB24-9EA81AA38856">
+                <util:XmlConfig Id="AddElement" File="[#MyXmlFile]" Action="create" Node="element" ElementPath="//root/child2" Name="grandchild3" On="install" Sequence="2" />
+                <util:XmlConfig ElementId="AddElement" File="[#MyXmlFile]" Name="TheAttribute1" Value="AttributeValue1" Sequence="3" />
+                <util:XmlConfig Id="AddAttribute2" ElementId="AddElement" File="[INSTALLFOLDER]my.xml" Name="TheAttribute2" Value="AttributeValue2" Sequence="4" />
             </Component>
         </Feature>
     </Package>
 
     <Fragment>
-            <StandardDirectory Id="ProgramFilesFolder">
-                <Directory Id="INSTALLFOLDER" Name="MsiPackage" />
-            </StandardDirectory>
-        </Fragment>
+        <StandardDirectory Id="ProgramFilesFolder">
+            <Directory Id="INSTALLFOLDER" Name="MsiPackage" />
+        </StandardDirectory>
+    </Fragment>
 </Wix>
diff --git a/src/ext/Util/test/WixToolsetTest.Util/TestData/XmlConfig/my.xml b/src/ext/Util/test/WixToolsetTest.Util/TestData/XmlConfig/my.xml
new file mode 100644
index 00000000..3f44c27c
--- /dev/null
+++ b/src/ext/Util/test/WixToolsetTest.Util/TestData/XmlConfig/my.xml
@@ -0,0 +1,11 @@
+<root>
+    <child1>
+        <grandchild1>
+        </grandchild1>
+    </child1>
+
+    <child2>
+        <grandchild2>
+        </grandchild2>
+    </child2>
+</root>
diff --git a/src/ext/Util/test/WixToolsetTest.Util/UtilExtensionFixture.cs b/src/ext/Util/test/WixToolsetTest.Util/UtilExtensionFixture.cs
index 817ab7c9..e04252da 100644
--- a/src/ext/Util/test/WixToolsetTest.Util/UtilExtensionFixture.cs
+++ b/src/ext/Util/test/WixToolsetTest.Util/UtilExtensionFixture.cs
@@ -10,6 +10,7 @@ namespace WixToolsetTest.Util
     using WixToolset.Util;
     using Xunit;
     using System.Xml.Linq;
+    using System;
 
     public class UtilExtensionFixture
     {
@@ -293,7 +294,10 @@ namespace WixToolsetTest.Util
             var results = build.BuildAndQuery(BuildX64, "Wix4XmlConfig");
             WixAssert.CompareLineByLine(new[]
             {
-                "Wix4XmlConfig:DelElement\t[INSTALLFOLDER]my.xml\t\t//root/sub\txxx\t\t\t289\tDel\t1",
+                "Wix4XmlConfig:AddAttribute2\t[INSTALLFOLDER]my.xml\tAddElement\t\t\tTheAttribute2\tAttributeValue2\t0\tAdd\t4",
+                "Wix4XmlConfig:AddElement\t[#MyXmlFile]\t\t//root/child2\t\tgrandchild3\t\t273\tAdd\t2",
+                "Wix4XmlConfig:DelElement\t[#MyXmlFile]\t\t//root/child1\tgrandchild1\t\t\t289\tDel\t",
+                "Wix4XmlConfig:uxcPPF6g4HJEQpBLT9w9GT6SKyHWww\t[#MyXmlFile]\tAddElement\t\t\tTheAttribute1\tAttributeValue1\t0\tAdd\t3",
             }, results.OrderBy(s => s).ToArray());
         }
 
diff --git a/src/test/msi/TestData/XmlConfigTests/XmlConfig/Package.wxs b/src/test/msi/TestData/XmlConfigTests/XmlConfig/Package.wxs
new file mode 100644
index 00000000..e5223ea8
--- /dev/null
+++ b/src/test/msi/TestData/XmlConfigTests/XmlConfig/Package.wxs
@@ -0,0 +1,27 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:util="http://wixtoolset.org/schemas/v4/wxs/util">
+    <Package Name="XmlConfig" Language="1033" Version="1.0.0.0" Manufacturer="Example Corporation" UpgradeCode="047730a5-30fe-4a62-a520-da9381b8226a">
+        <MajorUpgrade DowngradeErrorMessage="A newer version of [ProductName] is already installed." />
+
+        <Feature Id="ProductFeature" Title="XmlConfig">
+            <Component Directory="INSTALLFOLDER">
+                <File Id="MyXmlFile" Source="my.xml" />
+            </Component>
+            
+            <Component Id="Del" Directory="INSTALLFOLDER" Guid="3613414c-11f5-40fa-a1f1-a0ba722a6895">
+                <util:XmlConfig Id="DelElement" File="[#MyXmlFile]" Action="delete" Node="element" VerifyPath="grandchild1" ElementPath="//root/child1" On="install" />
+            </Component>
+
+            <Component Id="Add" Directory="INSTALLFOLDER" Guid="30A9FF8B-7AC8-47F3-BB24-9EA81AA38856">
+                <util:XmlConfig Id="AddElement" File="[#MyXmlFile]" Action="create" Node="element" ElementPath="//root/child2" Name="grandchild3" On="install" Sequence="2" />
+                <util:XmlConfig ElementId="AddElement" File="[#MyXmlFile]" Name="TheAttribute1" Value="AttributeValue1" Sequence="3" />
+                <util:XmlConfig Id="AddAttribute2" ElementId="AddElement" File="[INSTALLFOLDER]my.xml" Name="TheAttribute2" Value="AttributeValue2" Sequence="4" />
+            </Component>
+        </Feature>
+    </Package>
+
+    <Fragment>
+        <StandardDirectory Id="ProgramFilesFolder">
+            <Directory Id="INSTALLFOLDER" Name="XmlConfig" />
+        </StandardDirectory>
+    </Fragment>
+</Wix>
diff --git a/src/test/msi/TestData/XmlConfigTests/XmlConfig/XmlConfig.wixproj b/src/test/msi/TestData/XmlConfigTests/XmlConfig/XmlConfig.wixproj
new file mode 100644
index 00000000..58321e7e
--- /dev/null
+++ b/src/test/msi/TestData/XmlConfigTests/XmlConfig/XmlConfig.wixproj
@@ -0,0 +1,6 @@
+<!-- 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">
+  <ItemGroup>
+    <PackageReference Include="WixToolset.Util.wixext" />
+  </ItemGroup>
+</Project>
\ No newline at end of file
diff --git a/src/test/msi/TestData/XmlConfigTests/XmlConfig/my.xml b/src/test/msi/TestData/XmlConfigTests/XmlConfig/my.xml
new file mode 100644
index 00000000..3f44c27c
--- /dev/null
+++ b/src/test/msi/TestData/XmlConfigTests/XmlConfig/my.xml
@@ -0,0 +1,11 @@
+<root>
+    <child1>
+        <grandchild1>
+        </grandchild1>
+    </child1>
+
+    <child2>
+        <grandchild2>
+        </grandchild2>
+    </child2>
+</root>
diff --git a/src/test/msi/WixToolsetTest.MsiE2E/XmlConfigTests.cs b/src/test/msi/WixToolsetTest.MsiE2E/XmlConfigTests.cs
new file mode 100644
index 00000000..9b90cf46
--- /dev/null
+++ b/src/test/msi/WixToolsetTest.MsiE2E/XmlConfigTests.cs
@@ -0,0 +1,54 @@
+// 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.
+
+namespace WixToolsetTest.MsiE2E;
+
+using System;
+using System.IO;
+using System.Xml.Linq;
+using WixTestTools;
+using Xunit;
+using Xunit.Abstractions;
+
+public class XmlConfigTests : MsiE2ETests
+{
+    public XmlConfigTests(ITestOutputHelper testOutputHelper) : base(testOutputHelper)
+    {
+    }
+
+    [RuntimeFact]
+    public void CanModifyXmlFileWithXmlConfig()
+    {
+        var product = this.CreatePackageInstaller("XmlConfig");
+
+        product.InstallProduct(MSIExec.MSIExecReturnCode.SUCCESS);
+
+        // Validate the expected changes in my.xml.
+        var myXmlPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86), "XmlConfig", "my.xml");
+        var content = File.ReadAllText(myXmlPath);
+        var xDoc = XDocument.Parse(content);
+
+        var xRoot = xDoc.Element("root");
+        var xChild1 = xRoot.Element("child1");
+        Assert.NotNull(xChild1);
+
+        var xGrandchild1 = xChild1.Element("grandchild1");
+        Assert.Null(xGrandchild1);
+
+        var xChild2 = xRoot.Element("child2");
+        Assert.NotNull(xChild2);
+
+        var xGrandchild3 = xChild2.Element("grandchild3");
+        Assert.NotNull(xGrandchild3);
+        Assert.True(xGrandchild3.HasAttributes);
+
+        var xAttribute1 = xGrandchild3.Attribute("TheAttribute1");
+        Assert.NotNull(xAttribute1);
+        Assert.Equal("AttributeValue1", xAttribute1.Value);
+
+        var xAttribute2 = xGrandchild3.Attribute("TheAttribute2");
+        Assert.NotNull(xAttribute2);
+        Assert.Equal("AttributeValue2", xAttribute2.Value);
+
+        product.UninstallProduct(MSIExec.MSIExecReturnCode.SUCCESS);
+    }
+}