diff options
Diffstat (limited to 'lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin')
3 files changed, 139 insertions, 0 deletions
diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin/Makefile b/lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin/Makefile new file mode 100644 index 00000000000..8af06446ece --- /dev/null +++ b/lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin/Makefile @@ -0,0 +1,8 @@ +LEVEL = ../../../make + +DYLIB_CXX_SOURCES := plugin.cpp +DYLIB_NAME := plugin +DYLIB_ONLY := YES +MAKE_DSYM := NO + +include $(LEVEL)/Makefile.rules diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin/TestPluginCommands.py b/lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin/TestPluginCommands.py new file mode 100644 index 00000000000..e81d4076574 --- /dev/null +++ b/lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin/TestPluginCommands.py @@ -0,0 +1,78 @@ +""" +Test that plugins that load commands work correctly. +""" + +from __future__ import print_function + + +import lldb +from lldbsuite.test.decorators import * +from lldbsuite.test.lldbtest import * +from lldbsuite.test import lldbutil + + +class PluginCommandTestCase(TestBase): + + mydir = TestBase.compute_mydir(__file__) + + def setUp(self): + TestBase.setUp(self) + self.generateSource('plugin.cpp') + + @skipIfNoSBHeaders + # Requires a compatible arch and platform to link against the host's built + # lldb lib. + @skipIfHostIncompatibleWithRemote + @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24778") + @no_debug_info_test + def test_load_plugin(self): + """Test that plugins that load commands work correctly.""" + + plugin_name = "plugin" + if sys.platform.startswith("darwin"): + plugin_lib_name = "lib%s.dylib" % plugin_name + else: + plugin_lib_name = "lib%s.so" % plugin_name + + # Invoke the library build rule. + self.buildLibrary("plugin.cpp", plugin_name) + + debugger = lldb.SBDebugger.Create() + + retobj = lldb.SBCommandReturnObject() + + retval = debugger.GetCommandInterpreter().HandleCommand( + "plugin load %s" % self.getBuildArtifact(plugin_lib_name), retobj) + + retobj.Clear() + + retval = debugger.GetCommandInterpreter().HandleCommand( + "plugin_loaded_command child abc def ghi", retobj) + + if self.TraceOn(): + print(retobj.GetOutput()) + + self.expect(retobj, substrs=['abc def ghi'], exe=False) + + retobj.Clear() + + # check that abbreviations work correctly in plugin commands. + retval = debugger.GetCommandInterpreter().HandleCommand( + "plugin_loaded_ ch abc def ghi", retobj) + + if self.TraceOn(): + print(retobj.GetOutput()) + + self.expect(retobj, substrs=['abc def ghi'], exe=False) + + @no_debug_info_test + def test_invalid_plugin_invocation(self): + self.expect("plugin load a b", + error=True, startstr="error: 'plugin load' requires one argument") + self.expect("plugin load", + error=True, startstr="error: 'plugin load' requires one argument") + + @no_debug_info_test + def test_invalid_plugin_target(self): + self.expect("plugin load ThisIsNotAValidPluginName", + error=True, startstr="error: no such file") diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin/plugin.cpp.template b/lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin/plugin.cpp.template new file mode 100644 index 00000000000..1667c0d721e --- /dev/null +++ b/lldb/packages/Python/lldbsuite/test/functionalities/plugins/command_plugin/plugin.cpp.template @@ -0,0 +1,53 @@ +//===-- plugin.cpp -------------------------------------------*- C++ -*-===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +/* +An example plugin for LLDB that provides a new foo command with a child subcommand +Compile this into a dylib foo.dylib and load by placing in appropriate locations on disk or +by typing plugin load foo.dylib at the LLDB command line +*/ + +%include_SB_APIs% + +namespace lldb { + bool + PluginInitialize (lldb::SBDebugger debugger); +} + +class ChildCommand : public lldb::SBCommandPluginInterface +{ +public: + virtual bool + DoExecute (lldb::SBDebugger debugger, + char** command, + lldb::SBCommandReturnObject &result) + { + if (command) + { + const char* arg = *command; + while (arg) + { + result.Printf("%s ",arg); + arg = *(++command); + } + result.Printf("\n"); + return true; + } + return false; + } + +}; + +bool +lldb::PluginInitialize (lldb::SBDebugger debugger) +{ + lldb::SBCommandInterpreter interpreter = debugger.GetCommandInterpreter(); + lldb::SBCommand foo = interpreter.AddMultiwordCommand("plugin_loaded_command",NULL); + foo.AddCommand("child",new ChildCommand(),"a child of plugin_loaded_command"); + return true; +} |
