From 543e9ca0cf0c00d752bd723ec403e91b839bf9b4 Mon Sep 17 00:00:00 2001
From: Tristan Partin <tristan@partin.io>
Date: Mon, 14 Aug 2023 09:03:42 -0500
Subject: [PATCH] Remove XML filter from testlog.{json,txt} and std streams

This was an unintended consequence of the original patch in #11977.

Co-authored-by: Benoit Pierre <benoit.pierre@gmail.com>
---
 mesonbuild/mtest.py                                | 12 ++++++------
 .../110 replace unencodable xml chars/meson.build  |  2 +-
 unittests/allplatformstests.py                     | 14 ++++++++++----
 3 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/mesonbuild/mtest.py b/mesonbuild/mtest.py
index 1ac27824c..1298cc031 100644
--- a/mesonbuild/mtest.py
+++ b/mesonbuild/mtest.py
@@ -869,10 +869,10 @@ class JunitBuilder(TestLogger):
                     et.SubElement(testcase, 'system-out').text = subtest.explanation
             if test.stdo:
                 out = et.SubElement(suite, 'system-out')
-                out.text = test.stdo.rstrip()
+                out.text = replace_unencodable_xml_chars(test.stdo.rstrip())
             if test.stde:
                 err = et.SubElement(suite, 'system-err')
-                err.text = test.stde.rstrip()
+                err.text = replace_unencodable_xml_chars(test.stde.rstrip())
         else:
             if test.project not in self.suites:
                 suite = self.suites[test.project] = et.Element(
@@ -895,10 +895,10 @@ class JunitBuilder(TestLogger):
                 suite.attrib['failures'] = str(int(suite.attrib['failures']) + 1)
             if test.stdo:
                 out = et.SubElement(testcase, 'system-out')
-                out.text = test.stdo.rstrip()
+                out.text = replace_unencodable_xml_chars(test.stdo.rstrip())
             if test.stde:
                 err = et.SubElement(testcase, 'system-err')
-                err.text = test.stde.rstrip()
+                err.text = replace_unencodable_xml_chars(test.stde.rstrip())
 
     async def finish(self, harness: 'TestHarness') -> None:
         """Calculate total test counts and write out the xml result."""
@@ -1182,9 +1182,9 @@ def decode(stream: T.Union[None, bytes]) -> str:
     if stream is None:
         return ''
     try:
-        return replace_unencodable_xml_chars(stream.decode('utf-8'))
+        return stream.decode('utf-8')
     except UnicodeDecodeError:
-        return replace_unencodable_xml_chars(stream.decode('iso-8859-1', errors='ignore'))
+        return stream.decode('iso-8859-1', errors='ignore')
 
 async def read_decode(reader: asyncio.StreamReader,
                       queue: T.Optional['asyncio.Queue[T.Optional[str]]'],
diff --git a/test cases/unit/110 replace unencodable xml chars/meson.build b/test cases/unit/110 replace unencodable xml chars/meson.build
index 2e6b1b793..73485b073 100644
--- a/test cases/unit/110 replace unencodable xml chars/meson.build	
+++ b/test cases/unit/110 replace unencodable xml chars/meson.build	
@@ -1,4 +1,4 @@
 project('replace unencodable xml chars')
 
 test_script = find_program('script.py')
-test('main', test_script)
+test('main', test_script, verbose: true)
diff --git a/unittests/allplatformstests.py b/unittests/allplatformstests.py
index f7fb1b0c5..819cc2ee7 100644
--- a/unittests/allplatformstests.py
+++ b/unittests/allplatformstests.py
@@ -463,9 +463,8 @@ class AllPlatformTests(BasePlatformTests):
 
         valid_string = base_string_valid + repr(invalid_string)[1:-1] + base_string_valid
         invalid_string = base_string_invalid + invalid_string + base_string_invalid
-        broken_xml_stream = invalid_string.encode()
-        decoded_broken_stream = mtest.decode(broken_xml_stream)
-        self.assertEqual(decoded_broken_stream, valid_string)
+        fixed_string = mtest.replace_unencodable_xml_chars(invalid_string)
+        self.assertEqual(fixed_string, valid_string)
 
     def test_replace_unencodable_xml_chars_unit(self):
         '''
@@ -477,9 +476,16 @@ class AllPlatformTests(BasePlatformTests):
             raise SkipTest('xmllint not installed')
         testdir = os.path.join(self.unit_test_dir, '110 replace unencodable xml chars')
         self.init(testdir)
-        self.run_tests()
+        tests_command_output = self.run_tests()
         junit_xml_logs = Path(self.logdir, 'testlog.junit.xml')
         subprocess.run(['xmllint', junit_xml_logs], check=True)
+        # Ensure command output and JSON / text logs are not mangled.
+        raw_output_sample = '\x00\x01\x02\x03\x04\x05\x06\x07\x08\x0b'
+        assert raw_output_sample in tests_command_output
+        text_log = Path(self.logdir, 'testlog.txt').read_text()
+        assert raw_output_sample in text_log
+        json_log = json.loads(Path(self.logdir, 'testlog.json').read_bytes())
+        assert raw_output_sample in json_log['stdout']
 
     def test_run_target_files_path(self):
         '''