tests(junit-xml): avoid invalid XML
diff mbox series

Message ID pull.732.git.git.1584967475669.gitgitgadget@gmail.com
State New
Headers show
Series
  • tests(junit-xml): avoid invalid XML
Related show

Commit Message

Elijah Newren via GitGitGadget March 23, 2020, 12:44 p.m. UTC
From: Johannes Schindelin <johannes.schindelin@gmx.de>

When a test case is run in a subshell, we finalize the JUnit-style XML
when said subshell exits. But then we continue to write into that XML as
if nothing had happened.

This leads to Azure Pipelines' Publish Test Results task complaining:

	Failed to read /home/vsts/work/1/s/t/out/TEST-t0000-basic.xml.
	Error : Unexpected end tag. Line 110, position 5.

And indeed, the resulting XML is incorrect.

Let's "re-open" the XML in such a case, i.e. remove the previously added
closing tags.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
    Fix Azure Pipelines for t0000
    
    When running t0000 in our Azure Pipeline, the "Publish Test Results"
    step complains about an invalid JUnit-style XML, and it is correct.
    Let's fix that.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-732%2Fdscho%2Fci-xml-error-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-732/dscho/ci-xml-error-v1
Pull-Request: https://github.com/git/git/pull/732

 t/test-lib.sh | 1 +
 1 file changed, 1 insertion(+)


base-commit: be8661a3286c67a5d4088f4226cbd7f8b76544b0

Comments

Junio C Hamano March 23, 2020, 4:28 p.m. UTC | #1
"Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
writes:

> From: Johannes Schindelin <johannes.schindelin@gmx.de>
>
> When a test case is run in a subshell, we finalize the JUnit-style XML
> when said subshell exits. But then we continue to write into that XML as
> if nothing had happened.
>
> This leads to Azure Pipelines' Publish Test Results task complaining:
>
> 	Failed to read /home/vsts/work/1/s/t/out/TEST-t0000-basic.xml.
> 	Error : Unexpected end tag. Line 110, position 5.
>
> And indeed, the resulting XML is incorrect.
>
> Let's "re-open" the XML in such a case, i.e. remove the previously added
> closing tags.
>
> Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
> ---
>     Fix Azure Pipelines for t0000
>     
>     When running t0000 in our Azure Pipeline, the "Publish Test Results"
>     step complains about an invalid JUnit-style XML, and it is correct.
>     Let's fix that.

Hmph, I have a vague recollection that I've seen this one, looked at
the patch and even understood the issue.  Did I then forget to apply
it back then?  If so, apologies for failing to do so before the
release.

Will queue.

Thanks.

> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-732%2Fdscho%2Fci-xml-error-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-732/dscho/ci-xml-error-v1
> Pull-Request: https://github.com/git/git/pull/732
>
>  t/test-lib.sh | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/t/test-lib.sh b/t/test-lib.sh
> index 0ea1e5a05ed..7f0c02c016b 100644
> --- a/t/test-lib.sh
> +++ b/t/test-lib.sh
> @@ -1085,6 +1085,7 @@ finalize_junit_xml () {
>  		junit_time=$(test-tool date getnanos $junit_suite_start)
>  		sed -e "s/\(<testsuite.*\) time=\"[^\"]*\"/\1/" \
>  			-e "s/<testsuite [^>]*/& time=\"$junit_time\"/" \
> +			-e '/^ *<\/testsuite/d' \
>  			<"$junit_xml_path" >"$junit_xml_path.new"
>  		mv "$junit_xml_path.new" "$junit_xml_path"
>  
>
> base-commit: be8661a3286c67a5d4088f4226cbd7f8b76544b0
Johannes Schindelin March 23, 2020, 8:56 p.m. UTC | #2
Hi Junio,

On Mon, 23 Mar 2020, Junio C Hamano wrote:

> "Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
> writes:
>
> > From: Johannes Schindelin <johannes.schindelin@gmx.de>
> >
> > When a test case is run in a subshell, we finalize the JUnit-style XML
> > when said subshell exits. But then we continue to write into that XML as
> > if nothing had happened.
> >
> > This leads to Azure Pipelines' Publish Test Results task complaining:
> >
> > 	Failed to read /home/vsts/work/1/s/t/out/TEST-t0000-basic.xml.
> > 	Error : Unexpected end tag. Line 110, position 5.
> >
> > And indeed, the resulting XML is incorrect.
> >
> > Let's "re-open" the XML in such a case, i.e. remove the previously added
> > closing tags.
> >
> > Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
> > ---
> >     Fix Azure Pipelines for t0000
> >
> >     When running t0000 in our Azure Pipeline, the "Publish Test Results"
> >     step complains about an invalid JUnit-style XML, and it is correct.
> >     Let's fix that.
>
> Hmph, I have a vague recollection that I've seen this one, looked at
> the patch and even understood the issue.  Did I then forget to apply
> it back then?  If so, apologies for failing to do so before the
> release.

I suspect that you think of 076ee3e8a2a6 (tests: fix --write-junit-xml
with subshells, 2020-02-12) which you indeed applied. This patch addresses
a different issue that I had not noticed until two weeks ago. I
purposefully held back on contributing it during the feature freeze phase.

> Will queue.

Thanks,
Dscho

>
> Thanks.
>
> > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-732%2Fdscho%2Fci-xml-error-v1
> > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-732/dscho/ci-xml-error-v1
> > Pull-Request: https://github.com/git/git/pull/732
> >
> >  t/test-lib.sh | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/t/test-lib.sh b/t/test-lib.sh
> > index 0ea1e5a05ed..7f0c02c016b 100644
> > --- a/t/test-lib.sh
> > +++ b/t/test-lib.sh
> > @@ -1085,6 +1085,7 @@ finalize_junit_xml () {
> >  		junit_time=$(test-tool date getnanos $junit_suite_start)
> >  		sed -e "s/\(<testsuite.*\) time=\"[^\"]*\"/\1/" \
> >  			-e "s/<testsuite [^>]*/& time=\"$junit_time\"/" \
> > +			-e '/^ *<\/testsuite/d' \
> >  			<"$junit_xml_path" >"$junit_xml_path.new"
> >  		mv "$junit_xml_path.new" "$junit_xml_path"
> >
> >
> > base-commit: be8661a3286c67a5d4088f4226cbd7f8b76544b0
>
>

Patch
diff mbox series

diff --git a/t/test-lib.sh b/t/test-lib.sh
index 0ea1e5a05ed..7f0c02c016b 100644
--- a/t/test-lib.sh
+++ b/t/test-lib.sh
@@ -1085,6 +1085,7 @@  finalize_junit_xml () {
 		junit_time=$(test-tool date getnanos $junit_suite_start)
 		sed -e "s/\(<testsuite.*\) time=\"[^\"]*\"/\1/" \
 			-e "s/<testsuite [^>]*/& time=\"$junit_time\"/" \
+			-e '/^ *<\/testsuite/d' \
 			<"$junit_xml_path" >"$junit_xml_path.new"
 		mv "$junit_xml_path.new" "$junit_xml_path"