[Buildbot-commits] [Buildbot] #2370: check ShellCommand args against RemoteShellCommand

[Buildbot trac]

#2370: check ShellCommand args against RemoteShellCommand
-------------------------------------+--------------------
Reporter:  dustin                    |       Owner:
    Type:  enhancement               |      Status:  new
Priority:  major                     |   Milestone:  0.8.+
 Version:  0.8.6p1                   |  Resolution:
Keywords:  reconfig, sprint, simple  |
-------------------------------------+--------------------

Old description:

> Many of the args to !ShellCommand are passed on verbatim to
> !RemoteShellCommand, but this doesn't happen during the configuration
> load, leading to nasty landmines for users.
>
> For example, `ShellCommand(some_unknown_argument=10)` will pass a
> configuration check just fine, but will fail when the step runs.
>
> If possible, we should figure out a way to check these at install time,
> perhaps just by using {{{inspect}}} to see what args
> {{{RemoteShellCommand.__init__}}} takes, and ensuring that the arguments
> to !ShellCommand match that set.

New description:

 Many of the args to !ShellCommand are passed on verbatim to
 !RemoteShellCommand, but this doesn't happen during the configuration
 load, leading to nasty landmines for users.

 For example, `ShellCommand(some_unknown_argument=10)` will pass a
 configuration check just fine, but will fail when the step runs.

 If possible, we should figure out a way to check these at install time,
 perhaps just by using {{{inspect}}} to see what args
 {{{RemoteShellCommand.__init__}}} takes, and ensuring that the arguments
 to !ShellCommand match that set.

--

Comment (by dustin):

 This needs a release note, and a minor change to the tests: use
 `assertRaisesConfigError` (`from buildbot.test.util import config` and mix
 in `config.ConfigErrorsMixin`).  And submit a GitHub pull request.  Other
 than that, it looks great.

-- 
Ticket URL: <http://trac.buildbot.net/ticket/2370#comment:3>
Buildbot <http://buildbot.net/>
Buildbot: build/test automation