1 files changed, 88 insertions, 0 deletions
diff --git a/packages/Python/lldbsuite/test/api/check_public_api_headers/TestPublicAPIHeaders.py b/packages/Python/lldbsuite/test/api/check_public_api_headers/TestPublicAPIHeaders.py
new file mode 100644
index 000000000000..0d0507f1d70c
--- /dev/null
+++ b/packages/Python/lldbsuite/test/api/check_public_api_headers/TestPublicAPIHeaders.py
@@ -0,0 +1,88 @@
+"""Test the integrity of the lldb public api directory containing SB*.h headers.
+
+There should be nothing unwanted there and a simpe main.cpp which includes SB*.h
+should compile and link with the LLDB framework."""
+
+from __future__ import print_function
+
+
+
+import os, re
+from lldbsuite.test.lldbtest import *
+import lldbsuite.test.lldbutil as lldbutil
+
+class SBDirCheckerCase(TestBase):
+
+    mydir = TestBase.compute_mydir(__file__)
+
+    def setUp(self):
+        TestBase.setUp(self)
+        self.template = 'main.cpp.template'
+        self.source = 'main.cpp'
+        self.exe_name = 'a.out'
+
+    @skipIfNoSBHeaders
+    def test_sb_api_directory(self):
+        """Test the SB API directory and make sure there's no unwanted stuff."""
+
+        # Only proceed if this is an Apple OS, "x86_64", and local platform.
+        if not (self.platformIsDarwin() and self.getArchitecture() == "x86_64"):
+            self.skipTest("This test is only for LLDB.framework built 64-bit")
+        if self.getArchitecture() == "i386":
+            self.skipTest("LLDB is 64-bit and cannot be linked to 32-bit test program.")
+
+        # Generate main.cpp, build it, and execute.
+        self.generate_main_cpp()
+        self.buildDriver(self.source, self.exe_name)
+        self.sanity_check_executable(self.exe_name)
+
+    def generate_main_cpp(self):
+        """Generate main.cpp from main.cpp.template."""
+        temp = os.path.join(os.getcwd(), self.template)
+        with open(temp, 'r') as f:
+            content = f.read()
+
+        public_api_dir = os.path.join(os.environ["LLDB_SRC"], "include", "lldb", "API")
+
+        # Look under the include/lldb/API directory and add #include statements
+        # for all the SB API headers.
+        public_headers = os.listdir(public_api_dir)
+        # For different platforms, the include statement can vary.
+        if self.platformIsDarwin():
+            include_stmt = "'#include <%s>' % os.path.join('LLDB', header)"
+        if self.getPlatform() == "freebsd" or self.getPlatform() == "linux" or os.environ.get('LLDB_BUILD_TYPE') == 'Makefile':
+            include_stmt = "'#include <%s>' % os.path.join(public_api_dir, header)"
+        list = [eval(include_stmt) for header in public_headers if (header.startswith("SB") and
+                                                                    header.endswith(".h"))]
+        includes = '\n'.join(list)
+        new_content = content.replace('%include_SB_APIs%', includes)
+        src = os.path.join(os.getcwd(), self.source)
+        with open(src, 'w') as f:
+            f.write(new_content)
+
+        # The main.cpp has been generated, add a teardown hook to remove it.
+        self.addTearDownHook(lambda: os.remove(src))
+
+    def sanity_check_executable(self, exe_name):
+        """Sanity check executable compiled from the auto-generated program."""
+        exe = os.path.join(os.getcwd(), exe_name)
+        self.runCmd("file %s" % exe, CURRENT_EXECUTABLE_SET)
+
+        self.line_to_break = line_number(self.source, '// Set breakpoint here.')
+
+        env_cmd = "settings set target.env-vars %s=%s" %(self.dylibPath, self.getLLDBLibraryEnvVal())
+        if self.TraceOn():
+            print("Set environment to: ", env_cmd)
+        self.runCmd(env_cmd)
+        self.addTearDownHook(lambda: self.dbg.HandleCommand("settings remove target.env-vars %s" % self.dylibPath))
+
+        lldbutil.run_break_set_by_file_and_line (self, self.source, self.line_to_break, num_expected_locations = -1)
+
+        self.runCmd("run", RUN_SUCCEEDED)
+
+        # The stop reason of the thread should be breakpoint.
+        self.expect("thread list", STOPPED_DUE_TO_BREAKPOINT,
+            substrs = ['stopped',
+                       'stop reason = breakpoint'])
+
+        self.runCmd('frame variable')