diff options
| -rw-r--r-- | lib/spack/llnl/util/tty/__init__.py | 57 | ||||
| -rw-r--r-- | lib/spack/spack/installer.py | 2 | ||||
| -rw-r--r-- | lib/spack/spack/test/util/path.py | 40 | ||||
| -rw-r--r-- | lib/spack/spack/util/executable.py | 39 | ||||
| -rw-r--r-- | lib/spack/spack/util/path.py | 17 |
5 files changed, 111 insertions, 44 deletions
diff --git a/lib/spack/llnl/util/tty/__init__.py b/lib/spack/llnl/util/tty/__init__.py index 987e226d5d..ca3b5c4b8d 100644 --- a/lib/spack/llnl/util/tty/__init__.py +++ b/lib/spack/llnl/util/tty/__init__.py @@ -5,6 +5,7 @@ from __future__ import unicode_literals +import contextlib import fcntl import os import struct @@ -28,6 +29,7 @@ _timestamp = False _msg_enabled = True _warn_enabled = True _error_enabled = True +_output_filter = lambda s: s indent = " " @@ -90,6 +92,18 @@ def error_enabled(): return _error_enabled +@contextlib.contextmanager +def output_filter(filter_fn): + """Context manager that applies a filter to all output.""" + global _output_filter + saved_filter = _output_filter + try: + _output_filter = filter_fn + yield + finally: + _output_filter = saved_filter + + class SuppressOutput: """Class for disabling output in a scope using 'with' keyword""" @@ -166,13 +180,23 @@ def msg(message, *args, **kwargs): if _stacktrace: st_text = process_stacktrace(2) if newline: - cprint("@*b{%s==>} %s%s" % ( - st_text, get_timestamp(), cescape(message))) + cprint( + "@*b{%s==>} %s%s" % ( + st_text, + get_timestamp(), + cescape(_output_filter(message)) + ) + ) else: - cwrite("@*b{%s==>} %s%s" % ( - st_text, get_timestamp(), cescape(message))) + cwrite( + "@*b{%s==>} %s%s" % ( + st_text, + get_timestamp(), + cescape(_output_filter(message)) + ) + ) for arg in args: - print(indent + six.text_type(arg)) + print(indent + _output_filter(six.text_type(arg))) def info(message, *args, **kwargs): @@ -188,18 +212,29 @@ def info(message, *args, **kwargs): st_text = "" if _stacktrace: st_text = process_stacktrace(st_countback) - cprint("@%s{%s==>} %s%s" % ( - format, st_text, get_timestamp(), cescape(six.text_type(message)) - ), stream=stream) + cprint( + "@%s{%s==>} %s%s" % ( + format, + st_text, + get_timestamp(), + cescape(_output_filter(six.text_type(message))) + ), + stream=stream + ) for arg in args: if wrap: lines = textwrap.wrap( - six.text_type(arg), initial_indent=indent, - subsequent_indent=indent, break_long_words=break_long_words) + _output_filter(six.text_type(arg)), + initial_indent=indent, + subsequent_indent=indent, + break_long_words=break_long_words + ) for line in lines: stream.write(line + '\n') else: - stream.write(indent + six.text_type(arg) + '\n') + stream.write( + indent + _output_filter(six.text_type(arg)) + '\n' + ) def verbose(message, *args, **kwargs): diff --git a/lib/spack/spack/installer.py b/lib/spack/spack/installer.py index 5ba5b3a70d..baeaac70fb 100644 --- a/lib/spack/spack/installer.py +++ b/lib/spack/spack/installer.py @@ -1886,7 +1886,7 @@ def build_process(pkg, install_args): installer = BuildProcessInstaller(pkg, install_args) # don't print long padded paths in executable debug output. - with spack.util.executable.filter_padding(): + with spack.util.path.filter_padding(): return installer.run() diff --git a/lib/spack/spack/test/util/path.py b/lib/spack/spack/test/util/path.py index 532bf03178..8795af3353 100644 --- a/lib/spack/spack/test/util/path.py +++ b/lib/spack/spack/test/util/path.py @@ -5,6 +5,9 @@ import pytest +import llnl.util.tty as tty + +import spack.config import spack.util.path as sup #: Some lines with lots of placeholders @@ -57,3 +60,40 @@ def test_longest_prefix_re(): assert "(?:s(?:t(?:r(?:i(?:ng?)?)?)?)?)" == sup.longest_prefix_re( "string", capture=False ) + + +def test_output_filtering(capfd, install_mockery, mutable_config): + """Test filtering padding out of tty messages.""" + long_path = "/" + "/".join([sup.SPACK_PATH_PADDING_CHARS] * 200) + padding_string = "[padded-to-%d-chars]" % len(long_path) + + # test filtering when padding is enabled + with spack.config.override('config:install_tree', {"padded_length": 256}): + # tty.msg with filtering on the first argument + with sup.filter_padding(): + tty.msg("here is a long path: %s/with/a/suffix" % long_path) + out, err = capfd.readouterr() + assert padding_string in out + + # tty.msg with filtering on a laterargument + with sup.filter_padding(): + tty.msg("here is a long path:", "%s/with/a/suffix" % long_path) + out, err = capfd.readouterr() + assert padding_string in out + + # tty.error with filtering on the first argument + with sup.filter_padding(): + tty.error("here is a long path: %s/with/a/suffix" % long_path) + out, err = capfd.readouterr() + assert padding_string in err + + # tty.error with filtering on a later argument + with sup.filter_padding(): + tty.error("here is a long path:", "%s/with/a/suffix" % long_path) + out, err = capfd.readouterr() + assert padding_string in err + + # test no filtering + tty.msg("here is a long path: %s/with/a/suffix" % long_path) + out, err = capfd.readouterr() + assert padding_string not in out diff --git a/lib/spack/spack/util/executable.py b/lib/spack/spack/util/executable.py index 94fc7f16a7..e615ccdcfd 100644 --- a/lib/spack/spack/util/executable.py +++ b/lib/spack/spack/util/executable.py @@ -2,7 +2,7 @@ # Spack Project Developers. See the top-level COPYRIGHT file for details. # # SPDX-License-Identifier: (Apache-2.0 OR MIT) -import contextlib + import os import re import shlex @@ -17,27 +17,6 @@ import spack.error __all__ = ['Executable', 'which', 'ProcessError'] -#: optionally filter padding on debug output in spack.util.executable -_filter_padding = False - - -@contextlib.contextmanager -def filter_padding(): - """Context manager to safely disable path padding in debug output. - - This is needed because Spack's debug output gets extremely long when we use a - long padded installation path. - """ - global _filter_padding - try: - # don't bother filtering if padding isn't actually enabled - padding = spack.config.get("config:install_tree:padded_length", None) - if padding: - _filter_padding = True - yield - finally: - _filter_padding = False - class Executable(object): """Class representing a program that can be run on the command line.""" @@ -206,13 +185,9 @@ class Executable(object): cmd = self.exe + list(args) - cmd_line = "'%s'" % "' '".join( - map(lambda arg: arg.replace("'", "'\"'\"'"), cmd)) - - debug_cmd_line = cmd_line - if _filter_padding: - debug_cmd_line = [spack.util.path.padding_filter(elt) for elt in cmd_line] - tty.debug(debug_cmd_line) + escaped_cmd = ["'%s'" % arg.replace("'", "'\"'\"'") for arg in cmd] + cmd_line_string = " ".join(escaped_cmd) + tty.debug(cmd_line_string) try: proc = subprocess.Popen( @@ -239,7 +214,7 @@ class Executable(object): rc = self.returncode = proc.returncode if fail_on_error and rc != 0 and (rc not in ignore_errors): - long_msg = cmd_line + long_msg = cmd_line_string if result: # If the output is not captured in the result, it will have # been stored either in the specified files (e.g. if @@ -254,13 +229,13 @@ class Executable(object): except OSError as e: raise ProcessError( - '%s: %s' % (self.exe[0], e.strerror), 'Command: ' + cmd_line) + '%s: %s' % (self.exe[0], e.strerror), 'Command: ' + cmd_line_string) except subprocess.CalledProcessError as e: if fail_on_error: raise ProcessError( str(e), '\nExit status %d when invoking command: %s' % - (proc.returncode, cmd_line)) + (proc.returncode, cmd_line_string)) finally: if close_ostream: diff --git a/lib/spack/spack/util/path.py b/lib/spack/spack/util/path.py index 1848af1440..04d45a012b 100644 --- a/lib/spack/spack/util/path.py +++ b/lib/spack/spack/util/path.py @@ -7,6 +7,7 @@ TODO: this is really part of spack.config. Consolidate it. """ +import contextlib import getpass import os import re @@ -232,3 +233,19 @@ def padding_filter(string): len(match.group(0)) ) return _filter_re.sub(replacer, string) + + +@contextlib.contextmanager +def filter_padding(): + """Context manager to safely disable path padding in all Spack output. + + This is needed because Spack's debug output gets extremely long when we use a + long padded installation path. + """ + padding = spack.config.get("config:install_tree:padded_length", None) + if padding: + # filter out all padding from the intsall command output + with tty.output_filter(padding_filter): + yield + else: + yield # no-op: don't filter unless padding is actually enabled |