Merge dwarf and dsym tests

Currently most of the test files have a separate dwarf and a separate
dsym test with almost identical content (only the build step is
different). With adding dwo symbol file handling to the test suit it
would increase this to a 3-way duplication. The purpose of this change
is to eliminate this redundancy with generating 2 test case (one dwarf
and one dsym) for each test function specified (dwo handling will be
added at a later commit).

Main design goals:
* There should be no boilerplate code in each test file to support the
  multiple debug info in most of the tests (custom scenarios are
  acceptable in special cases) so adding a new test case is easier and
  we can't miss one of the debug info type.
* In case of a test failure, the debug symbols used during the test run
  have to be cleanly visible from the output of dotest.py to make
  debugging easier both from build bot logs and from local test runs
* Each test case should have a unique, fully qualified name so we can
  run exactly 1 test with "-f <test-case>.<test-function>" syntax
* Test output should be grouped based on test files the same way as it
  happens now (displaying dwarf/dsym results separately isn't
  preferable)

Proposed solution (main logic in lldbtest.py, rest of them are test
cases fixed up for the new style):
* Have only 1 test fuction in the test files what will run for all
  debug info separately and this test function should call just
  "self.build(...)" to build an inferior with the right debug info
* When a class is created by python (the class object, not the class
  instance), we will generate a new test method for each debug info
  format in the test class with the name "<test-function>_<debug-info>"
  and remove the original test method. This way unittest2 see multiple
  test methods (1 for each debug info, pretty much as of now) and will
  handle the test selection and the failure reporting correctly (the
  debug info will be visible from the end of the test name)
* Add new annotation @no_debug_info_test to disable the generation of
  multiple tests for each debug info format when the test don't have an
  inferior

Differential revision: http://reviews.llvm.org/D13028

llvm-svn: 248883

2 files changed, 36 insertions, 156 deletions

diff --git a/lldb/test/functionalities/data-formatter/data-formatter-objc/TestDataFormatterObjC.py b/lldb/test/functionalities/data-formatter/data-formatter-objc/TestDataFormatterObjC.py
index 89ccd5f1da0..3aae3e5a201 100644
--- a/lldb/test/functionalities/data-formatter/data-formatter-objc/TestDataFormatterObjC.py
+++ b/lldb/test/functionalities/data-formatter/data-formatter-objc/TestDataFormatterObjC.py
@@ -15,180 +15,81 @@ class ObjCDataFormatterTestCase(TestBase):
     mydir = TestBase.compute_mydir(__file__)
 
     @skipUnlessDarwin
-    @dsym_test
-    def test_plain_objc_with_dsym_and_run_command(self):
+    def test_plain_objc_with_run_command(self):
         """Test basic ObjC formatting behavior."""
-        self.buildDsym()
+        self.build()
         self.plain_data_formatter_commands()
 
-    @skipUnlessDarwin
-    @dwarf_test
-    def test_plain_objc_with_dwarf_and_run_command(self):
-        """Test basic ObjC formatting behavior."""
-        self.buildDwarf()
-        self.plain_data_formatter_commands()
-
-    def appkit_tester_impl(self,builder,commands):
-        builder()
+    def appkit_tester_impl(self,commands):
+        self.build()
         self.appkit_common_data_formatters_command()
         commands()
 
     @skipUnlessDarwin
-    @dsym_test
-    def test_nsnumber_with_dsym_and_run_command(self):
-        """Test formatters for NSNumber."""
-        self.appkit_tester_impl(self.buildDsym,self.nsnumber_data_formatter_commands)
-
-    @skipUnlessDarwin
-    @dwarf_test
-    def test_nsnumber_with_dwarf_and_run_command(self):
+    def test_nsnumber_with_run_command(self):
         """Test formatters for NSNumber."""
-        self.appkit_tester_impl(self.buildDwarf,self.nsnumber_data_formatter_commands)
-
-    @skipUnlessDarwin
-    @dsym_test
-    def test_nscontainers_with_dsym_and_run_command(self):
-        """Test formatters for NS container classes."""
-        self.appkit_tester_impl(self.buildDsym,self.nscontainers_data_formatter_commands)
+        self.appkit_tester_impl(self.nsnumber_data_formatter_commands)
 
     @skipUnlessDarwin
-    @dwarf_test
-    def test_nscontainers_with_dwarf_and_run_command(self):
+    def test_nscontainers_with_run_command(self):
         """Test formatters for  NS container classes."""
-        self.appkit_tester_impl(self.buildDwarf,self.nscontainers_data_formatter_commands)
-
-
-    @skipUnlessDarwin
-    @dsym_test
-    def test_nsdata_with_dsym_and_run_command(self):
-        """Test formatters for NSData."""
-        self.appkit_tester_impl(self.buildDsym,self.nsdata_data_formatter_commands)
+        self.appkit_tester_impl(self.nscontainers_data_formatter_commands)
 
     @skipUnlessDarwin
-    @dwarf_test
-    def test_nsdata_with_dwarf_and_run_command(self):
+    def test_nsdata_with_run_command(self):
         """Test formatters for  NSData."""
-        self.appkit_tester_impl(self.buildDwarf,self.nsdata_data_formatter_commands)
-
-
-    @skipUnlessDarwin
-    @dsym_test
-    def test_nsurl_with_dsym_and_run_command(self):
-        """Test formatters for NSURL."""
-        self.appkit_tester_impl(self.buildDsym,self.nsurl_data_formatter_commands)
+        self.appkit_tester_impl(self.nsdata_data_formatter_commands)
 
     @skipUnlessDarwin
-    @dwarf_test
-    def test_nsurl_with_dwarf_and_run_command(self):
+    def test_nsurl_with_run_command(self):
         """Test formatters for NSURL."""
-        self.appkit_tester_impl(self.buildDwarf,self.nsurl_data_formatter_commands)
+        self.appkit_tester_impl(self.nsurl_data_formatter_commands)
 
 
     @skipUnlessDarwin
-    @dsym_test
-    def test_nserror_with_dsym_and_run_command(self):
+    def test_nserror_with_run_command(self):
         """Test formatters for NSError."""
-        self.appkit_tester_impl(self.buildDsym,self.nserror_data_formatter_commands)
-
-    @skipUnlessDarwin
-    @dwarf_test
-    def test_nserror_with_dwarf_and_run_command(self):
-        """Test formatters for NSError."""
-        self.appkit_tester_impl(self.buildDwarf,self.nserror_data_formatter_commands)
+        self.appkit_tester_impl(self.nserror_data_formatter_commands)
 
 
     @skipUnlessDarwin
-    @dsym_test
-    def test_nsbundle_with_dsym_and_run_command(self):
+    def test_nsbundle_with_run_command(self):
         """Test formatters for NSBundle."""
-        self.appkit_tester_impl(self.buildDsym,self.nsbundle_data_formatter_commands)
-
-    @skipUnlessDarwin
-    @dwarf_test
-    def test_nsbundle_with_dwarf_and_run_command(self):
-        """Test formatters for NSBundle."""
-        self.appkit_tester_impl(self.buildDwarf,self.nsbundle_data_formatter_commands)
+        self.appkit_tester_impl(self.nsbundle_data_formatter_commands)
 
 
     @skipUnlessDarwin
-    @dsym_test
-    def test_nsexception_with_dsym_and_run_command(self):
+    def test_nsexception_with_run_command(self):
         """Test formatters for NSException."""
-        self.appkit_tester_impl(self.buildDsym,self.nsexception_data_formatter_commands)
+        self.appkit_tester_impl(self.nsexception_data_formatter_commands)
 
     @skipUnlessDarwin
-    @dwarf_test
-    def test_nsexception_with_dwarf_and_run_command(self):
-        """Test formatters for NSException."""
-        self.appkit_tester_impl(self.buildDwarf,self.nsexception_data_formatter_commands)
-
-
-    @skipUnlessDarwin
-    @dsym_test
-    def test_nsmisc_with_dsym_and_run_command(self):
-        """Test formatters for misc NS classes."""
-        self.appkit_tester_impl(self.buildDsym,self.nsmisc_data_formatter_commands)
-
-    @skipUnlessDarwin
-    @dwarf_test
-    def test_nsmisc_with_dwarf_and_run_command(self):
+    def test_nsmisc_with_run_command(self):
         """Test formatters for misc NS classes."""
-        self.appkit_tester_impl(self.buildDwarf,self.nsmisc_data_formatter_commands)
+        self.appkit_tester_impl(self.nsmisc_data_formatter_commands)
 
 
     @skipUnlessDarwin
-    @dsym_test
-    def test_nsdate_with_dsym_and_run_command(self):
+    def test_nsdate_with_run_command(self):
         """Test formatters for NSDate."""
-        self.appkit_tester_impl(self.buildDsym,self.nsdate_data_formatter_commands)
-
-    @skipUnlessDarwin
-    @dwarf_test
-    def test_nsdate_with_dwarf_and_run_command(self):
-        """Test formatters for NSDate."""
-        self.appkit_tester_impl(self.buildDwarf,self.nsdate_data_formatter_commands)
-
-
-    @skipUnlessDarwin
-    @dsym_test
-    def test_coreframeworks_with_dsym_and_run_command(self):
-        """Test formatters for Core OSX frameworks."""
-        self.buildDsym()
-        self.cf_data_formatter_commands()
+        self.appkit_tester_impl(self.nsdate_data_formatter_commands)
 
     @skipUnlessDarwin
-    @dwarf_test
-    def test_coreframeworks_with_dwarf_and_run_command(self):
+    def test_coreframeworks_and_run_command(self):
         """Test formatters for Core OSX frameworks."""
-        self.buildDwarf()
+        self.build()
         self.cf_data_formatter_commands()
 
     @skipUnlessDarwin
-    @dsym_test
-    def test_kvo_with_dsym_and_run_command(self):
+    def test_kvo_with_run_command(self):
         """Test the behavior of formatters when KVO is in use."""
-        self.buildDsym()
+        self.build()
         self.kvo_data_formatter_commands()
 
     @skipUnlessDarwin
-    @dwarf_test
-    def test_kvo_with_dwarf_and_run_command(self):
-        """Test the behavior of formatters when KVO is in use."""
-        self.buildDwarf()
-        self.kvo_data_formatter_commands()
-
-    @skipUnlessDarwin
-    @dsym_test
-    def test_expr_with_dsym_and_run_command(self):
-        """Test common cases of expression parser <--> formatters interaction."""
-        self.buildDsym()
-        self.expr_objc_data_formatter_commands()
-
-    @skipUnlessDarwin
-    @dwarf_test
-    def test_expr_with_dwarf_and_run_command(self):
+    def test_expr_with_run_command(self):
         """Test common cases of expression parser <--> formatters interaction."""
-        self.buildDwarf()
+        self.build()
         self.expr_objc_data_formatter_commands()
 
     def setUp(self):
diff --git a/lldb/test/functionalities/data-formatter/data-formatter-objc/nsstring/TestDataFormatterNSString.py b/lldb/test/functionalities/data-formatter/data-formatter-objc/nsstring/TestDataFormatterNSString.py
index 563ba5a21bb..fb0442957ce 100644
--- a/lldb/test/functionalities/data-formatter/data-formatter-objc/nsstring/TestDataFormatterNSString.py
+++ b/lldb/test/functionalities/data-formatter/data-formatter-objc/nsstring/TestDataFormatterNSString.py
@@ -14,8 +14,8 @@ class NSStringDataFormatterTestCase(TestBase):
 
     mydir = TestBase.compute_mydir(__file__)
 
-    def appkit_tester_impl(self,builder,commands):
-        builder()
+    def appkit_tester_impl(self,commands):
+        self.build()
         self.runCmd("file a.out", CURRENT_EXECUTABLE_SET)
 
         lldbutil.run_break_set_by_file_and_line (self, "main.m", self.line, num_expected_locations=1, loc_exact=True)
@@ -40,40 +40,19 @@ class NSStringDataFormatterTestCase(TestBase):
         commands()
 
     @skipUnlessDarwin
-    @dsym_test
-    def test_nsstring_with_dsym_and_run_command(self):
+    def test_nsstring_with_run_command(self):
         """Test formatters for NSString."""
-        self.appkit_tester_impl(self.buildDsym,self.nsstring_data_formatter_commands)
+        self.appkit_tester_impl(self.nsstring_data_formatter_commands)
 
     @skipUnlessDarwin
-    @dwarf_test
-    def test_nsstring_with_dwarf_and_run_command(self):
-        """Test formatters for NSString."""
-        self.appkit_tester_impl(self.buildDwarf,self.nsstring_data_formatter_commands)
-
-    @skipUnlessDarwin
-    @dsym_test
-    def test_rdar11106605_with_dsym_and_run_command(self):
+    def test_rdar11106605_with_run_command(self):
         """Check that Unicode characters come out of CFString summary correctly."""
-        self.appkit_tester_impl(self.buildDsym,self.rdar11106605_commands)
-
-    @skipUnlessDarwin
-    @dwarf_test
-    def test_rdar11106605_with_dwarf_and_run_command(self):
-        """Check that Unicode characters come out of CFString summary correctly."""
-        self.appkit_tester_impl(self.buildDwarf,self.rdar11106605_commands)
-
-    @skipUnlessDarwin
-    @dsym_test
-    def test_nsstring_withNULs_with_dsym_and_run_command(self):
-        """Test formatters for NSString."""
-        self.appkit_tester_impl(self.buildDsym,self.nsstring_withNULs_commands)
+        self.appkit_tester_impl(self.rdar11106605_commands)
 
     @skipUnlessDarwin
-    @dwarf_test
-    def test_nsstring_withNULS_with_dwarf_and_run_command(self):
+    def test_nsstring_withNULS_with_run_command(self):
         """Test formatters for NSString."""
-        self.appkit_tester_impl(self.buildDwarf,self.nsstring_withNULs_commands)
+        self.appkit_tester_impl(self.nsstring_withNULs_commands)
 
 
     def setUp(self):