Skip to content

Pr cmd raise with stderr on error #452

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

Merged
merged 7 commits into from
Jun 13, 2016
33 changes: 29 additions & 4 deletions git/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ def _bchr(c):
# Documentation
## @{

def _drop_output_handler(line):
pass


def handle_process_output(process, stdout_handler, stderr_handler, finalizer):
"""Registers for notifications to lean that process output is ready to read, and dispatches lines to
the respective line handlers. We are able to handle carriage returns in case progress is sent by that
Expand All @@ -79,6 +83,13 @@ def handle_process_output(process, stdout_handler, stderr_handler, finalizer):
:param stdout_handler: f(stdout_line_string), or None
:param stderr_hanlder: f(stderr_line_string), or None
:param finalizer: f(proc) - wait for proc to finish"""

log.debug('handle_process_output( process=%r, stdout_handler=%r, stderr_handler=%r, finalizer=%r'
% (process, stdout_handler, stderr_handler, finalizer))

if stdout_handler is None:
stdout_handler = _drop_output_handler

fdmap = {process.stdout.fileno(): (stdout_handler, [b'']),
process.stderr.fileno(): (stderr_handler, [b''])}

Expand Down Expand Up @@ -119,6 +130,7 @@ def _dispatch_single_line(line, handler):
# end single line helper

def _dispatch_lines(fno, handler, buf_list):
log.debug('fno=%d, handler=%r, buf_list=%r' % (fno, handler, buf_list))
lc = 0
for line in _read_lines_from_fno(fno, buf_list):
_dispatch_single_line(line, handler)
Expand Down Expand Up @@ -307,22 +319,35 @@ def __del__(self):
def __getattr__(self, attr):
return getattr(self.proc, attr)

def wait(self, stderr=None):
def wait(self, stderr=b''):
"""Wait for the process and return its status code.

:param stderr: Previously read value of stderr, in case stderr is already closed.
:warn: may deadlock if output or error pipes are used and not handled separately.
:raise GitCommandError: if the return status is not 0"""

# stderr must be a bytes object as it will
# combined with more data from the process and
# decoded by the caller
if stderr is None:
stderr = b''
elif type(stderr) == unicode:
stderr = stderr.encode(defenc)

status = self.proc.wait()

def read_all_from_possibly_closed_stream(stream):
try:
return stream.read()
last_stderr = stream.read()
if type(last_stderr) == unicode:
last_stderr = last_stderr.encode(defenc)
return stderr + last_stderr
except ValueError:
return stderr or ''
return stderr or b''

if status != 0:
errstr = read_all_from_possibly_closed_stream(self.proc.stderr)
log.debug('AutoInterrupt wait stderr: %r' % (errstr,))
raise GitCommandError(self.args, status, errstr)
# END status handling
return status
Expand Down Expand Up @@ -609,7 +634,7 @@ def execute(self, command,
bufsize=-1,
stdin=istream,
stderr=PIPE,
stdout=PIPE if with_stdout else open(os.devnull, 'wb'),
stdout=PIPE,
shell=self.USE_SHELL,
close_fds=(os.name == 'posix'), # unsupported on windows
universal_newlines=universal_newlines,
Expand Down
23 changes: 21 additions & 2 deletions git/remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -570,21 +570,36 @@ def _get_fetch_info_from_stderr(self, proc, progress):

progress_handler = progress.new_message_handler()

error_message = None
stderr_text = None

for line in proc.stderr:
line = force_text(line)
for pline in progress_handler(line):
if line.startswith('fatal:') or line.startswith('error:'):
raise GitCommandError(("Error when fetching: %s" % line,), 2)
error_message = "Error when fetching: %s" % (line,)
break
Copy link
Member

Choose a reason for hiding this comment

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

Are you sure it' s enough to break after the first line indicating a problem ? My intuition is that the lines that follow on stderr contain context, that you probably want to catch as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It works because of the 2nd break at line 591.

Also I see this work in testing.


# END handle special messages
for cmd in cmds:
if len(line) > 1 and line[0] == ' ' and line[1] == cmd:
fetch_info_lines.append(line)
continue
# end find command code
# end for each comand code we know

if error_message is not None:
break
# end for each line progress didn't handle

if error_message is not None:
stderr_text = proc.stderr.read()

# end
finalize_process(proc)
finalize_process(proc, stderr=stderr_text)

if error_message is not None:
raise GitCommandError(error_message, 2, stderr=stderr_text)

# read head information
fp = open(join(self.repo.git_dir, 'FETCH_HEAD'), 'rb')
Expand Down Expand Up @@ -631,6 +646,10 @@ def stdout_handler(line):

try:
handle_process_output(proc, stdout_handler, progress_handler, finalize_process)
except GitCommandError as err:
# convert any error from wait() into the same error with stdout lines
raise GitCommandError(err.command, err.status, progress.get_stderr())

except Exception:
if len(output) == 0:
raise
Expand Down
14 changes: 11 additions & 3 deletions git/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,13 +173,17 @@ class RemoteProgress(object):
DONE_TOKEN = 'done.'
TOKEN_SEPARATOR = ', '

__slots__ = ("_cur_line", "_seen_ops")
__slots__ = ("_cur_line", "_seen_ops", "_error_lines")
re_op_absolute = re.compile(r"(remote: )?([\w\s]+):\s+()(\d+)()(.*)")
re_op_relative = re.compile(r"(remote: )?([\w\s]+):\s+(\d+)% \((\d+)/(\d+)\)(.*)")

def __init__(self):
self._seen_ops = list()
self._cur_line = None
self._error_lines = []

def get_stderr(self):
return '\n'.join(self._error_lines)
Copy link
Member

Choose a reason for hiding this comment

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

I recommend providing the highest-value data available, which in this case in an array of lines. There should be no assumption about how the user will evaluate that data.
As in GitPython in the very majority of cases there is no get_ prefix, this accessor would be called something like error_lines().


def _parse_progress_line(self, line):
"""Parse progress information from the given line as retrieved by git-push
Expand All @@ -190,6 +194,10 @@ def _parse_progress_line(self, line):
# Counting objects: 4, done.
# Compressing objects: 50% (1/2) \rCompressing objects: 100% (2/2) \rCompressing objects: 100% (2/2), done.
self._cur_line = line
if len(self._error_lines) > 0 or self._cur_line.startswith(('error:', 'fatal:')):
self._error_lines.append(self._cur_line)
return []

sub_lines = line.split('\r')
failed_lines = list()
for sline in sub_lines:
Expand Down Expand Up @@ -764,10 +772,10 @@ def done(self):
self.cv.notify_all()
self.cv.release()

def wait(self):
def wait(self, stderr=b''):
self.cv.acquire()
while self.count > 0:
self.cv.wait()
self.cv.wait(strerr=stderr)
self.cv.release()


Expand Down