Don't use lldb -O in lit tests

[zturner]

Summary

Because of different shell quoting rules, and the fact that LLDB commands often contain spaces, -O is not portable for writing command lines. Instead, we should use explicit lldbinit files.

[davide]

Is there a way of fixing this that doesn't require scattering the test between two files?

[zturner]

In D54680#1302408, @davide wrote:

Is there a way of fixing this that doesn't require scattering the test between two files?

Unless we create a utility that extracts lines based on prefixes and outputs them to a temporary file, I don't have any great ideas.

FWIW I actually find it easier to read this way, the interaction between the various command line options makes it pretty confusing to follow the order in which the various commands are executed. combining -O, -o, -S, and -s makes it quite hard to figure out what commands are actually being executed and in what order.

Another advantage to having the commands be in their own file is that it's easy to reproduce the failure by just running lldb -s script.lldbinit.

I'd even go so far as to say that maybe the .test file should be the source code + check lines, and each of the 3 test cases should be a separate script file with all the commands together in one file. It could use the command source command to avoid duplication. So, for example, stop-hook-1.lldbinit could be something like:

target stop-hook add -f stop-hook.c -l 30 -e 34 -o "expr ptr"
command source stop-hook-common.lldbinit

[friss]

I do agree it's slightly easier to read this way. I was conflicted while writing the tests between readability and conciseness. I think this is a good compromise.

I do prefer to have the check lines with the commands rather than with the source code though. The output is the result of the commands and sometimes it's not as clear what it refers to in the source.

[davide]

I don't have any other great ideas either and I'd say the proposed alternative is not worth the complexity.

lldb/lit/ExecControl/StopHook/Inputs/stop-hook-1.lldbinit

+target stop-hook add -n b -o "expr ptr"

lldb/lit/ExecControl/StopHook/Inputs/stop-hook-2.lldbinit

+target stop-hook add -f stop-hook.c -l 30 -e 34 -o "expr ptr"
 No newline at end of file

lldb/lit/ExecControl/StopHook/Inputs/stop-hook-3.lldbinit

+target stop-hook add -f stop-hook.c -l 30 -e 34
+expr ptr
+DONE
 No newline at end of file

lldb/lit/ExecControl/StopHook/Inputs/stop-hook-threads-1.lldbinit

+break set -f stop-hook-threads.cpp -p "Break here to test that the stop-hook"
+run
+target stop-hook add
+frame variable --show-globals g_val
+thread list
+continue
+DONE

lldb/lit/ExecControl/StopHook/Inputs/stop-hook-threads-2.lldbinit

+break set -f stop-hook-threads.cpp -p "Break here to test that the stop-hook"
+run
+target stop-hook add -x 2 -o "frame variable thread_index"
+target stop-hook add -o continue

lldb/lit/ExecControl/StopHook/stop-hook-threads.test

 # RUN: %cxx %p/Inputs/stop-hook-threads.cpp -g -o %t
-# RUN: %lldb -b -s %s -O 'target create %t' \
-# RUN:     -O 'break set -f stop-hook-threads.cpp -p "Break here to test that the stop-hook"' \
-# RUN:     -O run \
-# RUN:     -O 'target stop-hook add' \
-# RUN:            -O "frame variable --show-globals g_val" \
-# RUN:            -O "thread list" \
-# RUN:            -O continue \
-# RUN:            -O DONE \
+# RUN: %lldb -b -s %p/Inputs/stop-hook-threads-1.lldbinit -s %s -f %t \
 # RUN:     | FileCheck --check-prefix=CHECK --check-prefix=CHECK-NO-FILTER %s
-# RUN: %lldb -b -s %s \
-# RUN:     -O 'target create %t' \
-# RUN:     -O 'break set -f stop-hook-threads.cpp -p "Break here to test that the stop-hook"' \
-# RUN:     -O run \
-# RUN:     -O 'target stop-hook add -x 2 -o "frame variable thread_index"' \
-# RUN:     -O 'target stop-hook add -o continue' \
+# RUN: %lldb -b -s %p/Inputs/stop-hook-threads-2.lldbinit -s %s -f %t \
 # RUN:     | FileCheck --check-prefix=CHECK --check-prefix=CHECK-FILTER %s
 
 thread list
 break set -f stop-hook-threads.cpp -p "Set break point at this line"
 target stop-hook list
 
 # CHECK: Hook: 1
 # CHECK-NEXT:  State: enabled

 
 # When we filter per thread, we expect exactly 4 identical "frame var" results
 # CHECK-FILTER: (uint32_t) thread_index = [[THREAD_INDEX:[0-9]*]]
 # CHECK-FILTER-COUNT-3: (uint32_t) thread_index = [[THREAD_INDEX]]
 # CHECK-FILTER-NOT: thread_index
 
 # When we don't filter, we expect to count 12 stopped threads in the thread list output
 # CHECK-NO-FILTER-COUNT-12: at stop-hook-threads.cpp{{.*}} stop reason = breakpoint
 No newline at end of file

lldb/lit/ExecControl/StopHook/stop-hook.test

 # RUN: %cc %p/Inputs/stop-hook.c -g -o %t
 # Test setting stop-hook per-function
-# RUN: %lldb -b -s %s -O 'target create %t' -O 'target stop-hook add -n b -o "expr ptr"' \
+# RUN: %lldb -b -s %p/Inputs/stop-hook-1.lldbinit -s %s -f %t \
 # RUN:      | FileCheck --check-prefix=CHECK --check-prefix=CHECK-FUNC %s
 # Test setting stop-hook per-line range
-# RUN: %lldb -b -s %s -O 'target create %t' -O 'target stop-hook add -f stop-hook.c -l 30 -e 34 -o "expr ptr"'  | FileCheck %s
+# RUN: %lldb -b -s %p/Inputs/stop-hook-2.lldbinit -s %s -f %t | FileCheck %s
 # Test setting stop-hook with multi-line expression
-# RUN: %lldb -b -s %s -O 'target create %t' -O 'target stop-hook add -f stop-hook.c -l 30 -e 34' -O 'expr ptr' -O DONE | FileCheck %s
+# RUN: %lldb -b -s %p/Inputs/stop-hook-3.lldbinit -s %s -f %t | FileCheck %s
 
 break set -f stop-hook.c -p "// Set breakpoint here to test target stop-hook"
 break set -f stop-hook.c -p "// Another breakpoint which is outside of the stop-hook range"
 target stop-hook list
 
 # CHECK: Hook: 1
 # CHECK-NEXT:  State: enabled
 # CHECK-NEXT:  Specifier: