[llvm] [lit] Echo full RUN lines in case of external shells (PR #65267)
Joel E. Denny via llvm-commits
llvm-commits at lists.llvm.org
Mon Sep 4 10:10:17 PDT 2023
https://github.com/jdenny-ornl updated https://github.com/llvm/llvm-project/pull/65267:
>From d9ca09051a49262fefb3a978b9749397b597d744 Mon Sep 17 00:00:00 2001
From: "Joel E. Denny" <jdenny.ornl at gmail.com>
Date: Mon, 4 Sep 2023 10:58:00 -0400
Subject: [PATCH 1/2] [lit] Echo full RUN lines in case of external shells
Before <https://reviews.llvm.org/D154984> and
<https://reviews.llvm.org/D156954>, lit reported full RUN lines in a
`Script:` section. Now, in the case of lit's internal shell, it's the
execution trace that includes them. However, if lit is configured to
use an external shell (e.g., bash, windows `cmd`), they aren't
reported at all.
A fix was requested at the following:
* <https://reviews.llvm.org/D154984#4627605>
* <https://discourse.llvm.org/t/rfc-improving-lits-debug-output/72839/35?u=jdenny-ornl>
This patch does not correctly address the case when the external shell
is windows `cmd`. As discussed at
<https://github.com/llvm/llvm-project/pull/65242>, it's not clear
whether that's a use case that people still care about, and it seems
to be generally broken anyway.
---
llvm/utils/lit/lit/TestRunner.py | 8 +++++++-
llvm/utils/lit/tests/shtest-run-at-line.py | 8 ++++----
2 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/llvm/utils/lit/lit/TestRunner.py b/llvm/utils/lit/lit/TestRunner.py
index 461cf63d6b9685..4d1caad5369c83 100644
--- a/llvm/utils/lit/lit/TestRunner.py
+++ b/llvm/utils/lit/lit/TestRunner.py
@@ -1153,8 +1153,14 @@ def executeScript(test, litConfig, tmpBase, commands, cwd):
for j, ln in enumerate(commands):
match = re.match(kPdbgRegex, ln)
if match:
+ dbg = match.group(1)
command = match.group(2)
- commands[j] = match.expand(": '\\1'; \\2" if command else ": '\\1'")
+ commands[j] = f"echo '{dbg}'"
+ if command:
+ commands[j] += f": {shlex.quote(command.lstrip())} >&2 " \
+ f"&& {command}"
+ else:
+ commands[j] += " has no command after substitutions"
if litConfig.per_test_coverage:
# Extract the test case name from the test object
test_case_name = test.path_in_suite[-1]
diff --git a/llvm/utils/lit/tests/shtest-run-at-line.py b/llvm/utils/lit/tests/shtest-run-at-line.py
index a0626f872c4c9e..8322c27dc4cc52 100644
--- a/llvm/utils/lit/tests/shtest-run-at-line.py
+++ b/llvm/utils/lit/tests/shtest-run-at-line.py
@@ -14,14 +14,14 @@
# CHECK-LABEL: FAIL: shtest-run-at-line :: external-shell/basic.txt
-# CHECK: RUN: at line 4
-# CHECK: RUN: at line 5
+# CHECK: {{^}}RUN: at line 4: true
+# CHECK: {{^}}RUN: at line 5: false
# CHECK-NOT: RUN
# CHECK-LABEL: FAIL: shtest-run-at-line :: external-shell/line-continuation.txt
-# CHECK: RUN: at line 4
-# CHECK: RUN: at line 6
+# CHECK: {{^}}RUN: at line 4: echo 'foo bar' | FileCheck
+# CHECK: {{^}}RUN: at line 6: echo 'foo baz' | FileCheck
# CHECK-NOT: RUN
>From 0054ad4e27d407103d0d0453a76d547c8f155b53 Mon Sep 17 00:00:00 2001
From: "Joel E. Denny" <jdenny.ornl at gmail.com>
Date: Mon, 4 Sep 2023 12:56:49 -0400
Subject: [PATCH 2/2] Fix case where RUN line is empty after substitutions
Redirect it to stderr. Extend tests to check that echoed RUN commands
go to stderr for external shells. Extend tests to cover empty RUN
lines for internal and external shells.
---
llvm/utils/lit/lit/TestRunner.py | 2 +-
.../external-shell/empty-run-line.txt | 3 ++
.../internal-shell/empty-run-line.txt | 3 ++
llvm/utils/lit/tests/shtest-run-at-line.py | 36 +++++++++++++++----
4 files changed, 36 insertions(+), 8 deletions(-)
create mode 100644 llvm/utils/lit/tests/Inputs/shtest-run-at-line/external-shell/empty-run-line.txt
create mode 100644 llvm/utils/lit/tests/Inputs/shtest-run-at-line/internal-shell/empty-run-line.txt
diff --git a/llvm/utils/lit/lit/TestRunner.py b/llvm/utils/lit/lit/TestRunner.py
index 4d1caad5369c83..6af7d0ccd0faf9 100644
--- a/llvm/utils/lit/lit/TestRunner.py
+++ b/llvm/utils/lit/lit/TestRunner.py
@@ -1160,7 +1160,7 @@ def executeScript(test, litConfig, tmpBase, commands, cwd):
commands[j] += f": {shlex.quote(command.lstrip())} >&2 " \
f"&& {command}"
else:
- commands[j] += " has no command after substitutions"
+ commands[j] += " has no command after substitutions >&2"
if litConfig.per_test_coverage:
# Extract the test case name from the test object
test_case_name = test.path_in_suite[-1]
diff --git a/llvm/utils/lit/tests/Inputs/shtest-run-at-line/external-shell/empty-run-line.txt b/llvm/utils/lit/tests/Inputs/shtest-run-at-line/external-shell/empty-run-line.txt
new file mode 100644
index 00000000000000..40a5a7d6e7cce0
--- /dev/null
+++ b/llvm/utils/lit/tests/Inputs/shtest-run-at-line/external-shell/empty-run-line.txt
@@ -0,0 +1,3 @@
+# DEFINE: %{empty} =
+# RUN: %{empty}
+# RUN: false
diff --git a/llvm/utils/lit/tests/Inputs/shtest-run-at-line/internal-shell/empty-run-line.txt b/llvm/utils/lit/tests/Inputs/shtest-run-at-line/internal-shell/empty-run-line.txt
new file mode 100644
index 00000000000000..40a5a7d6e7cce0
--- /dev/null
+++ b/llvm/utils/lit/tests/Inputs/shtest-run-at-line/internal-shell/empty-run-line.txt
@@ -0,0 +1,3 @@
+# DEFINE: %{empty} =
+# RUN: %{empty}
+# RUN: false
diff --git a/llvm/utils/lit/tests/shtest-run-at-line.py b/llvm/utils/lit/tests/shtest-run-at-line.py
index 8322c27dc4cc52..397ae20ea4879b 100644
--- a/llvm/utils/lit/tests/shtest-run-at-line.py
+++ b/llvm/utils/lit/tests/shtest-run-at-line.py
@@ -6,7 +6,7 @@
# END.
-# CHECK: Testing: 4 tests
+# CHECK: Testing: 6 tests
# In the case of the external shell, we check for only RUN lines in stderr in
@@ -14,15 +14,27 @@
# CHECK-LABEL: FAIL: shtest-run-at-line :: external-shell/basic.txt
-# CHECK: {{^}}RUN: at line 4: true
-# CHECK: {{^}}RUN: at line 5: false
-# CHECK-NOT: RUN
+# CHECK: Command Output (stderr)
+# CHECK-NEXT: --
+# CHECK: {{^}}RUN: at line 4: true
+# CHECK: {{^}}RUN: at line 5: false
+# CHECK-NOT: RUN
+
+# CHECK-LABEL: FAIL: shtest-run-at-line :: external-shell/empty-run-line.txt
+
+# CHECK: Command Output (stderr)
+# CHECK-NEXT: --
+# CHECK: {{^}}RUN: at line 2 has no command after substitutions
+# CHECK: {{^}}RUN: at line 3: false
+# CHECK-NOT: RUN
# CHECK-LABEL: FAIL: shtest-run-at-line :: external-shell/line-continuation.txt
-# CHECK: {{^}}RUN: at line 4: echo 'foo bar' | FileCheck
-# CHECK: {{^}}RUN: at line 6: echo 'foo baz' | FileCheck
-# CHECK-NOT: RUN
+# CHECK: Command Output (stderr)
+# CHECK-NEXT: --
+# CHECK: {{^}}RUN: at line 4: echo 'foo bar' | FileCheck
+# CHECK: {{^}}RUN: at line 6: echo 'foo baz' | FileCheck
+# CHECK-NOT: RUN
# CHECK-LABEL: FAIL: shtest-run-at-line :: internal-shell/basic.txt
@@ -37,6 +49,16 @@
# CHECK-NEXT: # executed command: false
# CHECK-NOT: RUN
+# CHECK-LABEL: FAIL: shtest-run-at-line :: internal-shell/empty-run-line.txt
+
+# CHECK: Command Output (stdout)
+# CHECK-NEXT: --
+# CHECK-NEXT: # RUN: at line 2 has no command after substitutions
+# CHECK-NEXT: # RUN: at line 3
+# CHECK-NEXT: false
+# CHECK-NEXT: # executed command: false
+# CHECK-NOT: RUN
+
# CHECK-LABEL: FAIL: shtest-run-at-line :: internal-shell/line-continuation.txt
# CHECK: Command Output (stdout)
More information about the llvm-commits
mailing list