1200409 - |marionette --help| causes stack trace: "unsupported format character 'p'"

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, defect)

Description

[Eric Rahm [:erahm]]

When trying to print the usage for the |marionette| command I get the following stack trace:

> $ marionette --help
> Traceback (most recent call last):
>   File "/home/erahm/dev/areweslimyet/marionette-env/bin/marionette", line 9, in <module>
>     load_entry_point('marionette-client==0.19', 'console_scripts', 'marionette')()
>   File "/home/erahm/dev/areweslimyet/marionette-env/local/lib/python2.7/site-packages/marionette/runtests.py", line 51, in cli
>     args = parser.parse_args()
>   File "/home/erahm/dev/areweslimyet/marionette-env/local/lib/python2.7/site-packages/marionette/runner/base.py", line 395, in parse_args
>     args = ArgumentParser.parse_args(self, args, values)
>   File "/usr/lib/python2.7/argparse.py", line 1690, in parse_args
>     args, argv = self.parse_known_args(args, namespace)
>   File "/usr/lib/python2.7/argparse.py", line 1722, in parse_known_args
>     namespace, args = self._parse_known_args(args, namespace)
>   File "/usr/lib/python2.7/argparse.py", line 1928, in _parse_known_args
>     start_index = consume_optional(start_index)
>   File "/usr/lib/python2.7/argparse.py", line 1868, in consume_optional
>     take_action(action, args, option_string)
>   File "/usr/lib/python2.7/argparse.py", line 1796, in take_action
>     action(self, namespace, argument_values, option_string)
>   File "/usr/lib/python2.7/argparse.py", line 996, in __call__
>     parser.print_help()
>   File "/usr/lib/python2.7/argparse.py", line 2329, in print_help
>     self._print_message(self.format_help(), file)
>   File "/usr/lib/python2.7/argparse.py", line 2303, in format_help
>     return formatter.format_help()
>   File "/usr/lib/python2.7/argparse.py", line 281, in format_help
>     help = self._root_section.format_help()
>   File "/usr/lib/python2.7/argparse.py", line 211, in format_help
>     func(*args)
>   File "/usr/lib/python2.7/argparse.py", line 298, in _format_usage
>     usage = usage % dict(prog=self._prog)
> ValueError: unsupported format character 'p' (0x70) at index 1

Version info:
> $ marionette --version
> %prog 0.19 (using marionette-driver: 0.13, marionette-transport: 0.7)

Comment 1

[Eric Rahm [:erahm]]

This appears to be because of the use of '%prog'. Perhaps there's a missing substitution going on?

Comment 2

[Henrik Skupin [:whimboo][⌚️UTC+1]]

I assume somewhat a regression from Juliens work on bug 1183157?

Comment 3

[Julien Pagès (:parkouss)]

Right - not sure how I did that though. :)

Working on a fix right now.

Comment 4

[Julien Pagès (:parkouss)]

Attachment: 1200294.patch

I can confirm the bug. The attached patch fixes it for me, and now I can run with success:

 - marionette --help
 - marionette --version

Comment 5

[Julien Pagès (:parkouss)]

Attachment: 1200409.patch

Sorry I attached the wrong patch.

Comment 6

[Andreas Tolfsen ❲:ato❳]

Comment on attachment 8655312 [details] [diff] [review]
1200409.patch

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

Please consider using mozreview next time.

Comment 7

[Pulsebot]

https://hg.mozilla.org/integration/mozilla-inbound/rev/5665bf654b8f

Comment 8

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/5665bf654b8f

Comment 9

[Henrik Skupin [:whimboo][⌚️UTC+1]]

This is not only --help but nearly everything. This makes 0.19 unusable for me. Julien, we should release a new version of marionette client.

Comment 10

[Henrik Skupin [:whimboo][⌚️UTC+1]]

So actually this bug appeared because of the underlying changes from optparse to argparse on bug 1163801. While optparse supports %prog it's not supported in argparse.

What I wonder why the Marionette unit tests were not broken due to this problem.

Comment 11

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Not sure what exactly went wrong with my local environment but re-creating it fixes the issue for me. So this is indeed only the --help argument which is affected. Julien already raised bug 1201036 for the release, but we might want to wait until someone complains or we would have another release anyway.