Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename the 'path' argument of the MasterShellCommand 'workdir' #1295

Merged
merged 3 commits into from Oct 28, 2014

Conversation

benallard
Copy link
Contributor

Few considerations:

  • All other steps take a workdir
  • The path argument is not mentioned in the doc
    • Even worst, the doc has an example: command="cd dir; do stuff"
  • As the test show, the one that wrote it believed it would become the PATH.

@benallard
Copy link
Contributor Author

I could imagine having a transition period where both are allowed ... I'd rather not ...

@benallard
Copy link
Contributor Author

Oh, and saw it ? I'm trying to use git again !

@tardyp
Copy link
Member

tardyp commented Oct 26, 2014

LGTM.
Would deserve a doc fix, and a release note update.
Even if it is undocumented, this is still a de-facto api change.

@@ -103,7 +103,7 @@ def test_real_cmd_fails(self):
def test_constr_args(self):
self.setupStep(
master.MasterShellCommand(description='x', descriptionDone='y',
env={'a': 'b'}, path=['/usr/bin'], usePTY=True,
env={'a': 'b'}, workdir=['/usr/bin'], usePTY=True,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are definitely wrong - http://twistedmatrix.com/documents/current/api/twisted.internet.interfaces.IReactorProcess.spawnProcess.html says path is the working directory in which to run the command -- not a list.

@djmitche
Copy link
Member

Other than the test fixes, yeah -- this just needs docs and a release note.

@benallard
Copy link
Contributor Author

I believe this is ok now.

@sa2ajj
Copy link
Contributor

sa2ajj commented Oct 28, 2014

👍

sa2ajj pushed a commit that referenced this pull request Oct 28, 2014
Rename the 'path' argument of the MasterShellCommand 'workdir'

- All other steps take a workdir
- The path argument is not mentioned in the doc
  - Even worse, the doc has an example: command="cd dir; do stuff"
- As the test show, the one that wrote it believed it would become the PATH.
@sa2ajj sa2ajj merged commit c1acde4 into buildbot:master Oct 28, 2014
@benallard benallard deleted the mastershell_workdir branch October 28, 2014 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants