When we introduced disposable clients, our runner.py got much longer and harder to read. As discussed collectively, we would like to make it easier to navigate in once again. The current proposal is this:
runner.py
LocalRunner
executor.py
Executor
Runner
RemoteRunner
governor.py
SSHGovernor
DisposableGovernor
RemoteGovernor
main.py
Tee
remote_exec.py
file_utils.py
RemoteExec
ParamikoHelper
SSHClient
vm.Image
When writing documentation in docstrings, use terms like "executor", "governor", "local mode", "remote mode" (and more concretely "ssh mode" and "disposable mode").
This ticket had assigned some Differential requests: D550 D528
{meme, src=megusta}
rename RemoteExec from remote_exec.py to ParamikoHelper or SSHClient (other suggestions welcome)
Let's not use SSHClient as it might get confusing: http://paramiko-docs.readthedocs.org/en/latest/api/client.html#paramiko.client.SSHClient
Btw, @lbrabec, please feel free to propose a diff new the new layout before actually spending time on fixing tests or documentation :-)
a couple of small things: * Executer is arguably not a word and looks strange to me as a native English speaker - Executor may be better * I think it's too early to remove vm.Image since we don't have logic to find images yet - the code that was proposed from D528 may fit well there
As far as terminology goes, I'm not a huge fan of Governor. It has implications of limiting functionality in my mind and sounds weird in this situation. Would keeping the governor bits as runner and keeping the executor bits separate still seem confusing?
Governor
@tflink: I have responded to D550 so that the discussion is at one place.
Closing (D550).
Metadata Update from @kparal: - Issue tagged with: easyfix