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

util.check_output: when debug logging, dump output immediately #747

Merged
merged 1 commit into from
Sep 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions asv/console.py
Original file line number Diff line number Diff line change
Expand Up @@ -275,15 +275,20 @@ def _stream_formatter(self, record):
rest = parts[1]

indent = self._indent + 1
continued = getattr(record, 'continued', False)

if self._total:
progress_msg = '[{0:6.02f}%] '.format(
(float(self._count) / self._total) * 100.0)
color_print(progress_msg, end='')
if not continued:
color_print(progress_msg, end='')
indent += len(progress_msg)

color_print('·' * self._indent, end='')
color_print(' ', end='')
if not continued:
color_print('·' * self._indent, end='')
color_print(' ', end='')
else:
color_print(' ' * indent, end='')

if hasattr(record, 'color'):
color = record.color
Expand Down Expand Up @@ -380,10 +385,16 @@ def set_level(self, level):
def is_debug_enabled(self):
return self._logger.getEffectiveLevel() <= logging.DEBUG

def _message(self, routine, message, reserve_space=False, color=None):
def _message(self, routine, message, reserve_space=False, color=None,
continued=False):
kwargs = {}
extra = {}
if color is not None:
kwargs['extra'] = dict(color=color)
extra['color'] = color
if continued:
extra['continued'] = True
if extra:
kwargs['extra'] = extra

if reserve_space:
max_width = max(16, util.get_terminal_width() - 33)
Expand Down
51 changes: 46 additions & 5 deletions asv/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,38 @@ def check_call(args, valid_return_codes=(0,), timeout=600, dots=True,
cwd=cwd)


class DebugLogBuffer(object):
def __init__(self, log):
self.buf = []
self.first = True
self.linebreak_re = re.compile(b'.*\n')
self.log = log

def __call__(self, c):
if c is None:
text = b"".join(self.buf)
del self.buf[:]
elif b'\n' in c:
m = self.linebreak_re.match(c)
j = m.end()
self.buf.append(c[:j])
text = b"".join(self.buf)
self.buf[:] = [c[j:]]
else:
self.buf.append(c)
return

text = text.decode('utf-8', 'replace')
if text.endswith('\n'):
text = text[:-1]

if text:
if self.first:
self.log.debug('OUTPUT -------->', continued=True)
self.first = False
self.log.debug(text, continued=True)


def check_output(args, valid_return_codes=(0,), timeout=600, dots=True,
display_error=True, shell=False, return_stderr=False,
env=None, cwd=None, redirect_stderr=False, return_popen=False):
Expand Down Expand Up @@ -486,6 +518,11 @@ def _fix_env(s):
stderr_chunks = []
is_timeout = False

if log.is_debug_enabled():
debug_log = DebugLogBuffer(log)
else:
debug_log = lambda c: None

if WIN:
start_time = [time.time()]
was_timeout = [False]
Expand All @@ -497,6 +534,7 @@ def stdout_reader_run():
break
start_time[0] = time.time()
stdout_chunks.append(c)
debug_log(c)

def stderr_reader_run():
while True:
Expand All @@ -505,6 +543,7 @@ def stderr_reader_run():
break
start_time[0] = time.time()
stderr_chunks.append(c)
debug_log(c)

def watcher_run():
while proc.returncode is None:
Expand Down Expand Up @@ -579,6 +618,7 @@ def sig_forward(signum, frame):
for f in rlist:
output = os.read(f, PIPE_BUF)
fds[f].append(output)
debug_log(output)
if dots and time.time() - last_dot_time > 0.5:
if dots is True:
log.dot()
Expand Down Expand Up @@ -621,6 +661,8 @@ def sig_forward(signum, frame):
if not redirect_stderr:
proc.stderr.close()

debug_log(None)

stdout = b''.join(stdout_chunks)
stderr = b''.join(stderr_chunks)

Expand All @@ -635,13 +677,12 @@ def sig_forward(signum, frame):
if valid_return_codes is not None and retcode not in valid_return_codes:
header = 'Error running {0}'.format(' '.join(args))
if display_error:
log.error(get_content(header))
else:
if log.is_debug_enabled():
log.debug(get_content(header))
# Output was already printed
log.error(header)
else:
log.error(get_content(header))
raise ProcessError(args, retcode, stdout, stderr)
elif log.is_debug_enabled():
log.debug(get_content())

if return_stderr:
return (stdout, stderr, retcode)
Expand Down