911132 - UnicodeDecodeError in runxpcshelltests.py running toolkit/mozapps/extensions/test/xpcshell/test_plugins.js

Status: RESOLVED FIXED

(Testing :: XPCShell Harness, defect)

Description

[Georg Fritzsche [:gfritzsche]]

> ./mach xpcshell-tests toolkit/mozapps/extensions/test/xpcshell/test_plugins.js
[...]
> UnicodeDecodeError: 'ascii' codec can't decode byte 0x87 in position 256: ordinal not in range(128)

>  File "[...]/testing/xpcshell/mach_commands.py", line 235, in run_xpcshell_test
>    return xpcshell.run_test(**params)
>  File "[...]/testing/xpcshell/mach_commands.py", line 105, in run_test
>    return self._run_xpcshell_harness(**args)
>  File "[...]/testing/xpcshell/mach_commands.py", line 188, in _run_xpcshell_harness
>    result = xpcshell.runTests(**filtered_args)
>  File "[...]/testing/xpcshell/runxpcshelltests.py", line 1338, in runTests
>    raise test.exception

That is: http://hg.mozilla.org/mozilla-central/annotate/c7459bc8e449/testing/xpcshell/runxpcshelltests.py#l1338

CCs for the two common user names around this in blame.

Comment 1

[Mihnea Dobrescu-Balaur (:mihneadb)]

Chris, could it be some unicode encoding problem from the logging layer?

Comment 2

[Mihnea Dobrescu-Balaur (:mihneadb)]

forgot to flag needinfo

Comment 3

[Gregory Szorc [:gps]]

The xpcshell process is emitting output that isn't UTF-8 and this is confusing Python. This is mainly the fault of some tests printing "binary" because they don't know better. I thought there was a bug (that I had filed) regarding intercepting output in head.js and ensuring valid UTF-8 (by either encoding to hex or replacing invalid characters with the standard UTF-8 replacement character).

Comment 4

[Mihnea Dobrescu-Balaur (:mihneadb)]

Here's the whole stacktrace. https://pastebin.mozilla.org/2942211

Comment 5

[Mihnea Dobrescu-Balaur (:mihneadb)]

Attachment: Replace invalid bytes in xpcshell binary string output

We'll just output '?' for invalid bytes in the string output.

Comment 6

[Gregory Szorc [:gps]]

Comment on attachment 798009 [details] [diff] [review]
Replace invalid bytes in xpcshell binary string output

Review of attachment 798009 [details] [diff] [review]:
-----------------------------------------------------------------

This is good. We should also consider emitting a warning when a test outputs non-UTF-8 because I think we should consider that a misbehaving test.

Comment 7

[Mihnea Dobrescu-Balaur (:mihneadb)]

Should we do that in the same bug? How would we check? Try and catch UnicodeDecodeError?

Comment 8

[Gregory Szorc [:gps]]

try:
  line = line.decode('utf-8')
except UnicodeDecodeError:
  # emit warning
  line = line.decode('utf-8', 'replace')

Comment 9

[Mihnea Dobrescu-Balaur (:mihneadb)]

Ok, agreed. Sould we do it in this bug?

Comment 10

[Gregory Szorc [:gps]]

Why not!

Comment 11

[Mihnea Dobrescu-Balaur (:mihneadb)]

Attachment: Replace invalid bytes in xpcshell binary string output

https://tbpl.mozilla.org/?tree=Try&rev=52c243a2cad8

Comment 12

[Gregory Szorc [:gps]]

Comment on attachment 798043 [details] [diff] [review]
Replace invalid bytes in xpcshell binary string output

Review of attachment 798043 [details] [diff] [review]:
-----------------------------------------------------------------

::: testing/xpcshell/runxpcshelltests.py
@@ +485,5 @@
>                  for line in part.splitlines():
> +                    try:
> +                        line = line.decode('utf-8')
> +                    except UnicodeDecodeError:
> +                        self.log.info("TEST-INFO | Detected binary output.")

non-UTF-8 is not necessary binary - it's just not UTF-8!

Please print an actionable error message. e.g.

Detected non UTF-8 output from test XXX. Please modify the test to only print UTF-8.

Comment 13

[Mihnea Dobrescu-Balaur (:mihneadb)]

Attachment: Replace invalid bytes in xpcshell binary string output

Changed msg.

Comment 14

[Mihnea Dobrescu-Balaur (:mihneadb)]

Comment on attachment 798049 [details] [diff] [review]
Replace invalid bytes in xpcshell binary string output

r=gps

Comment 15

[Mihnea Dobrescu-Balaur (:mihneadb)]

try run looks good

Comment 16

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/da107dff7a83

Comment 17

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/da107dff7a83