Marking file types in the test binary corpus (#631)

* Housekeeping: marking ELF file type in name

* Autotest for the naming convention

* Typo

* Negative test

Author: sevaa

test/test_corpus_naming.py

@@ -0,0 +1,38 @@
+#------------------------------------------------------------------------------
+# elftools tests
+#
+# Seva Alekseyev ([email protected])
+# This code is in the public domain
+#------------------------------------------------------------------------------
+import unittest
+import os
+
+from elftools.elf.elffile import ELFFile
+from elftools.elf.segments import NoteSegment
+
+class TestCorpusNaming(unittest.TestCase):
+    def scan_under(self, subdir):
+        dir = os.path.join('test', subdir)
+        for filename in os.listdir(dir):
+            name, ext = os.path.splitext(filename)
+            if ext == '.elf':
+                try:
+                    ef = ELFFile.load_from_path(os.path.join(dir, filename))
+                    
+                    if ef.header.e_type == 'ET_DYN':
+                        self.assertTrue('.so.' in filename)
+                    elif ef.header.e_type == 'ET_REL':
+                        self.assertTrue('.o.' in filename)
+                    else: # Covers ET_EXEC, ET_CORE, ET_NONE
+                        self.assertFalse('.so.' in filename)
+                        self.assertFalse('.o.' in filename)
+                except:
+                    pass
+
+    def test_corpus_naming(self):
+        self.scan_under('testfiles_for_readelf')
+        self.scan_under('testfiles_for_unittests')
+        self.scan_under('testfiles_for_dwarfdump')
+
+if __name__ == '__main__':
+    unittest.main()

test/test_dbgfile.py

@@ -12,7 +12,7 @@ def test_dynamic_segment(self):
         """ Test that the degenerate case for the dynamic segment does not crash
         """
         with open(os.path.join('test', 'testfiles_for_unittests',
-                               'debug_info.elf'), 'rb') as f:
+                               'debug_info.so.elf'), 'rb') as f:
             elf = ELFFile(f)
 
             seen_dynamic_segment = False
@@ -28,7 +28,7 @@ def test_dynamic_section(self):
         """ Test that the degenerate case for the dynamic section does not crash
         """
         with open(os.path.join('test', 'testfiles_for_unittests',
-                               'debug_info.elf'), 'rb') as f:
+                               'debug_info.so.elf'), 'rb') as f:
             elf = ELFFile(f)
             section = DynamicSection(elf.get_section_by_name('.dynamic').header, '.dynamic', elf)
 
@@ -38,7 +38,7 @@ def test_eh_frame(self):
         """ Test that parsing .eh_frame with SHT_NOBITS does not crash
         """
         with open(os.path.join('test', 'testfiles_for_unittests',
-                               'debug_info.elf'), 'rb') as f:
+                               'debug_info.so.elf'), 'rb') as f:
             elf = ELFFile(f)
             dwarf = elf.get_dwarf_info()
             eh_frame = list(dwarf.EH_CFI_entries())

test/test_dwarf_aranges.py

@@ -8,14 +8,14 @@
 
 class TestRangeLists(unittest.TestCase):
     def test_arange_absent(self):
-        with open(os.path.join('test', 'testfiles_for_unittests', 'aranges_absent.elf'), 'rb') as f:
+        with open(os.path.join('test', 'testfiles_for_unittests', 'aranges_absent.so.elf'), 'rb') as f:
             elffile = ELFFile(f)
             self.assertTrue(elffile.has_dwarf_info())
             aranges = elffile.get_dwarf_info().get_aranges()
             self.assertIsNone(aranges)
 
     def test_arange_partial(self):
-        with open(os.path.join('test', 'testfiles_for_unittests', 'aranges_partial.elf'), 'rb') as f:
+        with open(os.path.join('test', 'testfiles_for_unittests', 'aranges_partial.so.elf'), 'rb') as f:
             elffile = ELFFile(f)
             self.assertTrue(elffile.has_dwarf_info())
             aranges = elffile.get_dwarf_info().get_aranges()
@@ -24,7 +24,7 @@ def test_arange_partial(self):
             self.assertIsNotNone(aranges.cu_offset_at_addr(address_b))
 
     def test_arange_complete(self):
-        with open(os.path.join('test', 'testfiles_for_unittests', 'aranges_complete.elf'), 'rb') as f:
+        with open(os.path.join('test', 'testfiles_for_unittests', 'aranges_complete.so.elf'), 'rb') as f:
             elffile = ELFFile(f)
             self.assertTrue(elffile.has_dwarf_info())
             aranges = elffile.get_dwarf_info().get_aranges()

test/test_dwarf_formdata16.py

@@ -12,7 +12,7 @@
 class TestFormData16(unittest.TestCase):
     def test_formdata16(self):
         path = os.path.join('test', 'testfiles_for_unittests',
-                            'dwarf_lineprog_data16.elf')
+                            'dwarf_lineprog_data16.so.elf')
         with open(path, 'rb') as f:
             elffile = ELFFile(f)
             dwarfinfo = elffile.get_dwarf_info(follow_links=False)

test/test_dwarf_llpair.py

@@ -12,7 +12,7 @@
 class TestLocListsPair(unittest.TestCase):
     def test_llpair(self):
         path = os.path.join('test', 'testfiles_for_unittests',
-                            'dwarf_llpair.elf')
+                            'dwarf_llpair.so.elf')
         with open(path, 'rb') as f:
             elffile = ELFFile(f)
             dwarfinfo = elffile.get_dwarf_info(follow_links=False)

test/test_dynamic.py

@@ -78,7 +78,7 @@ def test_reading_symbols_gnu_hash(self):
         """ Verify we can read symbol table without SymbolTableSection but with
             a GNU symbol hash table"""
         with open(os.path.join('test', 'testfiles_for_unittests',
-                               'android_dyntags.elf'), 'rb') as f:
+                               'android_dyntags.so.elf'), 'rb') as f:
             elf = ELFFile(f)
             for segment in elf.iter_segments():
                 if segment.header.p_type != 'PT_DYNAMIC':
@@ -114,7 +114,7 @@ def extract_sunw(filename):
         f1 = extract_sunw(os.path.join('test', 'testfiles_for_unittests',
             'exe_solaris32_cc.sparc.elf'))
         f2 = extract_sunw(os.path.join('test', 'testfiles_for_unittests',
-            'android_dyntags.elf'))
+            'android_dyntags.so.elf'))
         self.assertEqual(f1, {'DT_SUNW_STRPAD', 'DT_SUNW_LDMACH'})
         self.assertEqual(f2, set())
 

test/test_ehabi_elf.py

@@ -57,7 +57,7 @@ def test_parse_shared_library(self):
                 self.assertNotIsInstance(info.get_entry(i), CorruptEHABIEntry)
 
     def test_parse_executable(self):
-        fname = os.path.join('test', 'testfiles_for_unittests', 'arm_exidx_test.elf')
+        fname = os.path.join('test', 'testfiles_for_unittests', 'arm_exidx_test.so.elf')
         with open(fname, 'rb') as f:
             elf = ELFFile(f)
             self.assertTrue(elf.has_ehabi_info())

test/test_stab.py

@@ -18,7 +18,7 @@ def test_stab(self):
             ("label", 0x95, 0xc8, 0x4072, 0xdeadbeef),
             ("another label", 0x41, 0x66, 0xf9b1, 0xcafebabe)]
         with open(os.path.join('test', 'testfiles_for_unittests',
-                               'obj_stabs.elf'), 'rb') as f:
+                               'obj_stabs.o.elf'), 'rb') as f:
             elf = ELFFile(f)
 
             # using correct type?

test/test_tree.py

@@ -16,7 +16,7 @@
 
 class TestTree(unittest.TestCase):
     def test_tree(self):
-        self.run_test_on('dwarf_llpair.elf', 0, True)
+        self.run_test_on('dwarf_llpair.so.elf', 0, True)
         self.run_test_on('test_debugsup1.debug', 2, False)
 
     def run_test_on(self, file_name, cu_index, test_cached):