1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
from __future__ import absolute_import
import os
import sys
import subprocess
import shutil
import io
import threading
import errno
try:
import pty
except ImportError:
pty = None
from .tempdir import create_temporary_dir
from .files import FileOperations
from . import results
from .io import IoHandler, Channel
from .errors import NoSuchCommandError, CouldNotChangeDirectoryError
class LocalShell(object):
def __enter__(self):
return self
def __exit__(self, *args):
self.close()
def close(self):
pass
def upload_dir(self, source, dest, ignore=None):
shutil.copytree(source, dest, ignore=shutil.ignore_patterns(*ignore))
def upload_file(self, source, dest):
shutil.copyfile(source, dest)
def open(self, name, mode="r"):
return open(name, mode)
def write_file(self, remote_path, contents):
subprocess.check_call(["mkdir", "-p", os.path.dirname(remote_path)])
open(remote_path, "w").write(contents)
def spawn(self, command, *args, **kwargs):
stdout = kwargs.pop("stdout", None)
stderr = kwargs.pop("stderr", None)
allow_error = kwargs.pop("allow_error", False)
store_pid = kwargs.pop("store_pid", False)
use_pty = kwargs.pop("use_pty", False)
encoding = kwargs.pop("encoding", None)
cwd = kwargs.get("cwd")
if use_pty:
if pty is None:
raise ValueError("use_pty is not supported when the pty module cannot be imported")
master, slave = pty.openpty()
stdin_arg = slave
stdout_arg = slave
stderr_arg = subprocess.STDOUT
else:
stdin_arg = subprocess.PIPE
stdout_arg = subprocess.PIPE
stderr_arg = subprocess.PIPE
try:
process = subprocess.Popen(
stdin=stdin_arg,
stdout=stdout_arg,
stderr=stderr_arg,
bufsize=0,
**self._subprocess_args(command, *args, **kwargs)
)
except FileNotFoundError as error:
if cwd is not None and error.filename == cwd:
raise CouldNotChangeDirectoryError(cwd, error)
elif error.filename == command[0]:
raise NoSuchCommandError(command[0])
else:
raise
except OSError as error:
if cwd is not None and self._is_cannot_change_directory_oserror(error, cwd):
raise CouldNotChangeDirectoryError(cwd, error)
elif self._is_no_such_command_oserror(error, command[0]):
raise NoSuchCommandError(command[0])
else:
raise
if use_pty:
# TODO: Should close master ourselves rather than relying on
# garbage collection
process_stdin = os.fdopen(os.dup(master), "wb", 0)
process_stdout = os.fdopen(master, "rb", 0)
process_stderr = io.BytesIO()
def close_slave_on_exit():
process.wait()
# TODO: ensure the IO handler has finished before closing
os.close(slave)
thread = threading.Thread(target=close_slave_on_exit)
thread.daemon = True
thread.start()
else:
process_stdin = process.stdin
process_stdout = process.stdout
process_stderr = process.stderr
spur_process = LocalProcess(
process,
allow_error=allow_error,
process_stdin=process_stdin,
io_handler=IoHandler([
Channel(process_stdout, stdout, is_pty=use_pty),
Channel(process_stderr, stderr, is_pty=use_pty),
], encoding=encoding)
)
if store_pid:
spur_process.pid = process.pid
return spur_process
def run(self, *args, **kwargs):
return self.spawn(*args, **kwargs).wait_for_result()
def temporary_dir(self):
return create_temporary_dir()
@property
def files(self):
return FileOperations(self)
def _subprocess_args(self, command, cwd=None, update_env=None, new_process_group=False):
kwargs = {
"args": command,
"cwd": cwd,
}
if update_env is not None:
new_env = os.environ.copy()
new_env.update(update_env)
kwargs["env"] = new_env
if new_process_group:
kwargs["preexec_fn"] = os.setpgrp
return kwargs
def _is_no_such_command_oserror(self, error, command):
if error.errno != errno.ENOENT:
return False
elif sys.version_info[0] < 3:
return error.filename is None
else:
# In Python 3, filename and filename2 are None both when
# the command and cwd don't exist, but in both cases,
# the repr of the non-existent path is appended to the
# error message
return error.args[1] == os.strerror(error.errno) + ": " + repr(command)
def _is_cannot_change_directory_oserror(self, error, directory):
if sys.version_info[0] < 3:
return error.filename == directory
else:
# In Python 3, filename and filename2 are None both when
# the command and cwd don't exist, but in both cases,
# the repr of the non-existent path is appended to the
# error message
return (
error.args[1] == os.strerror(error.errno) + ": " + repr(directory) or
not os.access(directory, os.X_OK)
)
class LocalProcess(object):
def __init__(self, subprocess, allow_error, process_stdin, io_handler):
self._subprocess = subprocess
self._allow_error = allow_error
self._process_stdin = process_stdin
self._result = None
self._io = io_handler
def is_running(self):
return self._subprocess.poll() is None
def stdin_write(self, value):
self._process_stdin.write(value)
def send_signal(self, signal):
self._subprocess.send_signal(signal)
def wait_for_result(self):
if self._result is None:
self._result = self._generate_result()
return self._result
def _generate_result(self):
output, stderr_output = self._io.wait()
return_code = self._subprocess.wait()
return results.result(
return_code,
self._allow_error,
output,
stderr_output
)
|
