[lldb][NFC] Add basic test for GUI command

[teemperor]

Summary

This adds a basic test for the GUI command. Just tests that it starts up, that we can quit the gui
and help window, and that the basic UI elements are rendered. Mostly testing the waters how
testing this command will do on the bots or if that will cause some serious issues when we do
fancy ncurses stuff.

[teemperor]

Given how much fun Pavel had fixing my previous pexpect tests, I thought: "Why stop the fun after just two tests?". So here we go!

[clayborg]

It is great to have tests. The main issue I would see is some of the text might not render correctly if the screen size is too small. Can we control the size (char width and height) of the screen in pexpect tests?

[clayborg]

Seems like revision 370054 sets the screen size quite wide. Just checking that this change will be used for this test?

[teemperor]

• Set terminal dimension.

Yeah, Pavel added support for that (but I forgot to set them here because the test I used as a template didn't had the dimensions set).

[labath]

In D67018#1653138, @teemperor wrote:

Given how much fun Pavel had fixing my previous pexpect tests, I thought: "Why stop the fun after just two tests?". So here we go!

It looks like Jonas had a bit of fun too. ;)

Thank you for writing this, I think it's important to start experimenting with this. This test alone will increase our coverage of the gui command by a factor of infinity. :D

I do see some problems ahead. Like, this method is sufficient to test that some text is displayed on the screen, but it would be pretty hard to use it to check that the text is graphically laid out if a way that makes sense. Theoretically, we might assert entire ansi escape sequences, but that would be: a) clunky; b) susceptible to flakyness due to different curses versions choosing different (but equivalent) escape sequences. For that, we might need some sort of "terminal emulator" to process the escape sequences and produce the final window contents. Then, we could assert that, similarly to how some gui test frameworks talk to the X server to to get the actual window contents, click buttons, etc.

But that's just thinking about future. This looks fine to me right now.

As for the terminal size, the reason the other test sets the screen size so wide, is so that it avoids wrapping of file names, as that is what the test is asserting. That isn't the case here, though it's true that the test could be susceptible to window-size-related problems. If we don't specify the dimensions argument then pexpect is supposed to choose some sensible default itself. If we find that the default pexpect chooses is not suitable for us (perhaps because it picks the size of the parent terminal), then we can hardcode some reasonable default of our own into the launch method. However, I also don't think that's something we have to do now, as we don't have enough experience to know what that default is.

Anyway, LGMT, with one question: Given the recent test suite restructure, shouldn't this go somewhere under commands/gui or something?

lldb/packages/Python/lldbsuite/test/functionalities/gui_command/main.c

3

You only need this if you actually intend to attach to the program (which, it seems, you don't).

[teemperor]

Yeah, the directory was pre-restructure. Moved to the right path before committing (and removed the other stuff you pointed out). Thanks!

lldb/packages/Python/lldbsuite/test/functionalities/gui_command/Makefile

+LEVEL = ../../make
+C_SOURCES := main.c
+include $(LEVEL)/Makefile.rules

lldb/packages/Python/lldbsuite/test/functionalities/gui_command/TestGuiBasic.py

+"""
+Test that the 'gui' displays the help window and basic UI.
+"""
+
+import lldb
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test.lldbpexpect import PExpectTest
+
+class BasicGuiCommandTest(PExpectTest):
+
+    mydir = TestBase.compute_mydir(__file__)
+
+    def test_gui(self):
+        self.build()
+
+        self.launch(executable=self.getBuildArtifact("a.out"))
+        self.expect("b main.c:4", substrs=["Breakpoint 1", "address ="])
+        self.expect("run", substrs=["stop reason ="])
+
+
+        escape_key = chr(27).encode()
+
+        # Start the GUI for the first time and check for the welcome window.
+        self.child.sendline("gui")
+        self.child.expect_exact("Welcome to the LLDB curses GUI.")
+
+        # Press escape to quit the welcome screen
+        self.child.send(escape_key)
+        # Press escape again to quit the gui
+        self.child.send(escape_key)
+        self.expect_prompt()
+
+        # Start the GUI a second time, this time we should have the normal GUI.
+        self.child.sendline("gui")
+        # Check for GUI elements in the menu bar.
+        self.child.expect_exact("Target")
+        self.child.expect_exact("Process")
+        self.child.expect_exact("Thread")
+        self.child.expect_exact("View")
+        self.child.expect_exact("Help")
+
+        # Check the sources window.
+        self.child.expect_exact("Sources")
+        self.child.expect_exact("main")
+        self.child.expect_exact("funky_var_name_that_should_be_rendered")
+
+        # Check the variable window.
+        self.child.expect_exact("Variables")
+        self.child.expect_exact("(int) funky_var_name_that_should_be_rendered = 22")
+
+        # Check the bar at the bottom.
+        self.child.expect_exact("Frame:")
+
+        # Press escape to quit the gui
+        self.child.send(escape_key)
+
+        self.quit()

lldb/packages/Python/lldbsuite/test/functionalities/gui_command/main.c

+int main(int argc, char **argv) {
+  lldb_enable_attach();
+  int funky_var_name_that_should_be_rendered = 22;
+  return 0;
+}