dotnet/msbuild

XmlPoke strips out DTD

Open

#5,815 opened on Oct 20, 2020

View on GitHub
 (0 comments) (4 reactions) (0 assignees)C# (5,062 stars) (1,364 forks)batch import
bughelp wantedtriaged

Description

Issue Description

When modifying an XML file that contains DTD using the XmlPoke task the DTD is stripped out in the resulting XML file.

Steps to Reproduce

The following sample writes an XML file with DTD to the disk. It serves as input for the XmlPoke task which modifies the content and writes a new XML file. Comparing the two XML files shows that the modified file no longer contains the DTD.

<?xml version="1.0" encoding="UTF-8"?>
<Project DefaultTargets="Build" ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <Target Name="Build">
    <PropertyGroup>
      <XmlFileOriginal>original.xml</XmlFileOriginal>
      <XmlFileModified>modified.xml</XmlFileModified>
      <XmlContent>
&lt;!DOCTYPE plist PUBLIC &quot;-//Apple//DTD PLIST 1.0//EN&quot; &quot;https://www.apple.com/DTDs/PropertyList-1.0.dtd&quot;&gt;
&lt;plist d1p1:version=&quot;&quot; xmlns:d1p1=&quot;1.0&quot;&gt;
  &lt;dict&gt;
    &lt;key&gt;archiveVersion&lt;/key&gt;
    &lt;string&gt;1&lt;/string&gt;
  &lt;/dict&gt;
&lt;/plist&gt;
      </XmlContent>
    </PropertyGroup>
    <WriteLinesToFile File="$(XmlFileOriginal)" Lines="$(XmlContent)" Overwrite="true" />
    <WriteLinesToFile File="$(XmlFileModified)" Lines="$(XmlContent)" Overwrite="true" />
    <XmlPoke XmlInputPath="$(XmlFileModified)" Query="/plist/dict/key" Value="test" />
  </Target>
</Project>

Expected Behavior

The file modified by the XmlPoke task contains the DTD just like before the modification.

Contributor guide

Tech stack
csharp
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of MSBuild tasksXML DTD concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue is that XmlPoke does not preserve DTD. Investigate how XmlPoke loads and saves XML in the MSBuild source code (likely in Microsoft.Build.Tasks.Core). Check if it uses XmlDocument or XDocument, and whether the load options preserve DTD. Look at the method that writes the output to see if DTD is lost during serialization. Consider adding a test case with DTD to reproduce and fix the serialization.
XmlPoke strips out DTD · dotnet/msbuild#5815 | Good First Issue