[lit] Improve readability of failing scripts.
- This only applies to scripts executed by the _internal_ shell script
interpreter.
- This patch reworks the log to look more like a shell transcript, and be less
verbose (but in the interest of calling attention to the important parts).
Here is an example of the new format, for commands with/without failures and
with/without output:
```
$ true
$ echo hi
hi
$ false
note: command had no output on stdout or stderr
error: command failed with exit status 1
```
llvm-svn: 271610
diff --git a/llvm/utils/lit/lit/TestRunner.py b/llvm/utils/lit/lit/TestRunner.py
index e4bc48d..5ef1b2b 100644
--- a/llvm/utils/lit/lit/TestRunner.py
+++ b/llvm/utils/lit/lit/TestRunner.py
@@ -379,11 +379,17 @@
# Ensure the resulting output is always of string type.
try:
- out = to_string(out.decode('utf-8'))
+ if out is None:
+ out = ''
+ else:
+ out = to_string(out.decode('utf-8', errors='replace'))
except:
out = str(out)
try:
- err = to_string(err.decode('utf-8'))
+ if err is None:
+ err = ''
+ else:
+ err = to_string(err.decode('utf-8', errors='replace'))
except:
err = str(err)
@@ -438,14 +444,31 @@
out = err = ''
for i,result in enumerate(results):
- out += 'Command %d: %s\n' % (i, ' '.join('"%s"' % s
- for s in result.command.args))
- out += 'Command %d Result: %r\n' % (i, result.exitCode)
+ # Write the command line run.
+ out += '$ %s\n' % (' '.join('"%s"' % s
+ for s in result.command.args),)
+
+ # If nothing interesting happened, move on.
+ if litConfig.maxIndividualTestTime == 0 and \
+ result.exitCode == 0 and \
+ not result.stdout.strip() and not result.stderr.strip():
+ continue
+
+ # Otherwise, something failed or was printed, show it.
+ if result.stdout.strip():
+ out += '# command output:\n%s\n' % (result.stdout,)
+ if result.stderr.strip():
+ out += '# command stderr:\n%s\n' % (result.stderr,)
+ if not result.stdout.strip() and not result.stderr.strip():
+ out += "note: command had no output on stdout or stderr\n"
+
+ # Show the error conditions:
+ if result.exitCode != 0:
+ out += "error: command failed with exit status: %d\n" % (
+ result.exitCode,)
if litConfig.maxIndividualTestTime > 0:
- out += 'Command %d Reached Timeout: %s\n\n' % (
+ out += 'error: command reached timeout: %s\n' % (
i, str(result.timeoutReached))
- out += 'Command %d Output:\n%s\n\n' % (i, result.stdout)
- out += 'Command %d Stderr:\n%s\n\n' % (i, result.stderr)
return out, err, exitCode, timeoutInfo
diff --git a/llvm/utils/lit/tests/Inputs/shtest-output-printing/basic.txt b/llvm/utils/lit/tests/Inputs/shtest-output-printing/basic.txt
new file mode 100644
index 0000000..1720c60
--- /dev/null
+++ b/llvm/utils/lit/tests/Inputs/shtest-output-printing/basic.txt
@@ -0,0 +1,3 @@
+# RUN: true
+# RUN: echo hi
+# RUN: false
diff --git a/llvm/utils/lit/tests/Inputs/shtest-output-printing/lit.cfg b/llvm/utils/lit/tests/Inputs/shtest-output-printing/lit.cfg
new file mode 100644
index 0000000..4fe698d
--- /dev/null
+++ b/llvm/utils/lit/tests/Inputs/shtest-output-printing/lit.cfg
@@ -0,0 +1,4 @@
+import lit.formats
+config.name = 'shtest-output-printing'
+config.suffixes = ['.txt']
+config.test_format = lit.formats.ShTest(execute_external=False)
diff --git a/llvm/utils/lit/tests/shtest-format.py b/llvm/utils/lit/tests/shtest-format.py
index 39b0e9c..20884f8 100644
--- a/llvm/utils/lit/tests/shtest-format.py
+++ b/llvm/utils/lit/tests/shtest-format.py
@@ -39,9 +39,8 @@
#
# CHECK: Command Output (stdout):
# CHECK-NEXT: --
-# CHECK-NEXT: Command 0: "printf"
-# CHECK-NEXT: Command 0 Result: 0
-# CHECK-NEXT: Command 0 Output:
+# CHECK-NEXT: $ "printf"
+# CHECK-NEXT: # command output:
# CHECK-NEXT: line 1: failed test output on stdout
# CHECK-NEXT: line 2: failed test output on stdout
diff --git a/llvm/utils/lit/tests/shtest-output-printing.py b/llvm/utils/lit/tests/shtest-output-printing.py
new file mode 100644
index 0000000..1d5fc04
--- /dev/null
+++ b/llvm/utils/lit/tests/shtest-output-printing.py
@@ -0,0 +1,26 @@
+# Check the various features of the ShTest format.
+#
+# RUN: not %{lit} -j 1 -v %{inputs}/shtest-output-printing > %t.out
+# RUN: FileCheck < %t.out %s
+#
+# END.
+
+# CHECK: -- Testing:
+
+# CHECK: FAIL: shtest-output-printing :: basic.txt
+# CHECK-NEXT: *** TEST 'shtest-output-printing :: basic.txt' FAILED ***
+# CHECK-NEXT: Script:
+# CHECK-NEXT: --
+# CHECK: --
+# CHECK-NEXT: Exit Code: 1
+#
+# CHECK: Command Output
+# CHECK-NEXT: --
+# CHECK-NEXT: $ "true"
+# CHECK-NEXT: $ "echo" "hi"
+# CHECK-NEXT: # command output:
+# CHECK-NEXT: hi
+#
+# CHECK: $ "false"
+# CHECK-NEXT: note: command had no output on stdout or stderr
+# CHECK-NEXT: error: command failed with exit status: 1
diff --git a/llvm/utils/lit/tests/shtest-shell.py b/llvm/utils/lit/tests/shtest-shell.py
index 32479e1..379b040 100644
--- a/llvm/utils/lit/tests/shtest-shell.py
+++ b/llvm/utils/lit/tests/shtest-shell.py
@@ -9,10 +9,10 @@
# CHECK: FAIL: shtest-shell :: error-0.txt
# CHECK: *** TEST 'shtest-shell :: error-0.txt' FAILED ***
-# CHECK: Command 0: "not-a-real-command"
-# CHECK: Command 0 Result: 127
-# CHECK: Command 0 Stderr:
+# CHECK: $ "not-a-real-command"
+# CHECK: # command stderr:
# CHECK: 'not-a-real-command': command not found
+# CHECK: error: command failed with exit status: 127
# CHECK: ***
# FIXME: The output here sucks.