Embedded float symbols from list into table string

Author: hugueskamba

tools/executable_analysis_tools/test_elf-float-checker.py

@@ -13,7 +13,7 @@
 
 TARGET = importlib.import_module("elf-float-checker")
 
-SYMBOL_TABLE_NO_FLOATS = (
+SYMBOL_TABLE_WITHOUT_FLOATS = (
     " Symbol table '.symtab' contains 2723 entries:\n"
     "Num:    Value  Size Type    Bind   Vis      Ndx Name\n"
     "  0: 00000000     0 NOTYPE  LOCAL  DEFAULT  UND \n"
@@ -28,23 +28,7 @@
     "  9: 000046e1    52 FUNC    GLOBAL HIDDEN     3 __aeabi_lmul\n"
 )
 
-SYMBOL_TABLE_FLOATS = (
-    " Symbol table '.symtab' contains 2723 entries:\n"
-    "Num:    Value  Size Type    Bind   Vis      Ndx Name\n"
-    "  0: 00000000     0 NOTYPE  LOCAL  DEFAULT  UND \n"
-    "  1: 000045fd    16 FUNC    GLOBAL HIDDEN     3 __aeabi_cdcmpeq\n"
-    "  2: 00004609    16 FUNC    GLOBAL HIDDEN     3 lp_ticker_disable_interrupt\n"
-    "  3: 00004615    16 FUNC    GLOBAL HIDDEN     3 __aeabi_cfcmpeq\n"
-    "  4: 00004625    36 FUNC    GLOBAL HIDDEN     3 __aeabi_f2iz\n"
-    "  5: 00004645     8 FUNC    GLOBAL HIDDEN     3 lp_ticker_get_info\n"
-    "  6: 0000464d   116 FUNC    GLOBAL HIDDEN     3 __aeabi_h2f_alt\n"
-    "  7: 000046bd    20 FUNC    GLOBAL HIDDEN     3 lp_ticker_irq_handler\n"
-    "  8: 000046d1    16 FUNC    GLOBAL HIDDEN     3 __aeabi_i2d\n"
-    "  9: 000046e1    52 FUNC    GLOBAL HIDDEN     3 __aeabi_d2iz\n"
-    " 10: 000046f1    52 FUNC    GLOBAL HIDDEN     3 __aeabi_i2f\n"
-)
-
-FLOAT_SYMBOLS_IN_TABLE = [
+FLOAT_SYMBOLS = [
     "__aeabi_cdcmpeq",
     "__aeabi_cfcmpeq",
     "__aeabi_f2iz",
@@ -54,21 +38,38 @@
     "__aeabi_i2f",
 ]
 
+SYMBOL_TABLE_WITH_FLOATS = (
+    " Symbol table '.symtab' contains 2723 entries:\n"
+    "Num:    Value  Size Type    Bind   Vis      Ndx Name\n"
+    f"  0: 00000000     0 NOTYPE  LOCAL  DEFAULT  UND \n"
+    f"  1: 000045fd    16 FUNC    GLOBAL HIDDEN     3 {FLOAT_SYMBOLS[0]}\n"
+    f"  2: 00004609    16 FUNC    GLOBAL HIDDEN     3 lp_ticker_disable_interrupt\n"
+    f"  3: 00004615    16 FUNC    GLOBAL HIDDEN     3 {FLOAT_SYMBOLS[1]}\n"
+    f"  4: 00004625    36 FUNC    GLOBAL HIDDEN     3 {FLOAT_SYMBOLS[2]}\n"
+    f"  5: 00004645     8 FUNC    GLOBAL HIDDEN     3 lp_ticker_get_info\n"
+    f"  6: 0000464d   116 FUNC    GLOBAL HIDDEN     3 {FLOAT_SYMBOLS[3]}\n"
+    f"  7: 000046bd    20 FUNC    GLOBAL HIDDEN     3 lp_ticker_irq_handler\n"
+    f"  8: 000046d1    16 FUNC    GLOBAL HIDDEN     3 {FLOAT_SYMBOLS[4]}\n"
+    f"  9: 000046e1    52 FUNC    GLOBAL HIDDEN     3 {FLOAT_SYMBOLS[5]}\n"
+    f" 10: 000046f1    52 FUNC    GLOBAL HIDDEN     3 {FLOAT_SYMBOLS[6]}\n"
+)
+
+
 ELF_FORMAT_FILE = "mbed-os-example.elf"
-READELF_CMD = ["arm-none-eabi-readelf", "--symbols", "mbed-os-example.elf"]
+READELF_CMD = ["arm-none-eabi-readelf", "--symbols", f"{ELF_FORMAT_FILE}"]
 
 
 class TestElfFloatChecker:
     """Test class"""
 
     @classmethod
     def setup_class(cls):
-        # create a dummy elf file
+        # Create a dummy ELF format file
         Path(ELF_FORMAT_FILE).touch()
 
     @classmethod
     def teardown_class(cls):
-        # remove the dummy elf file
+        # Remove the dummy ELF format file
         Path(ELF_FORMAT_FILE).unlink()
 
     @mock.patch("subprocess.run")
@@ -78,11 +79,11 @@ def test_correctly_detect_absence_of_float_symbols(
         """Test that no false positive occur."""
         mock_subprocess_run.return_value = subprocess.CompletedProcess(
             args=(
-                "arm-none-eabi-readelf --symbols mbed-os-example.elf',"
+                f"arm-none-eabi-readelf --symbols {ELF_FORMAT_FILE}',"
                 " check=True, stderr=-2, stdin=None, stdout=-1"
             ),
             returncode=0,
-            stdout=SYMBOL_TABLE_NO_FLOATS.encode(),
+            stdout=SYMBOL_TABLE_WITHOUT_FLOATS.encode(),
             stderr=None,
         )
         assert [] == TARGET.check_float_symbols(ELF_FORMAT_FILE)
@@ -101,14 +102,14 @@ def test_correctly_detect_presence_of_float_symbols(
         """Test that float symbols can be discovered in a symbol table."""
         mock_subprocess_run.return_value = subprocess.CompletedProcess(
             args=(
-                "arm-none-eabi-readelf --symbols mbed-os-example.elf',"
+                f"arm-none-eabi-readelf --symbols {ELF_FORMAT_FILE}',"
                 " check=True, stderr=-2, stdin=None, stdout=-1"
             ),
             returncode=0,
-            stdout=SYMBOL_TABLE_FLOATS.encode(),
+            stdout=SYMBOL_TABLE_WITH_FLOATS.encode(),
             stderr=None,
         )
-        assert FLOAT_SYMBOLS_IN_TABLE == TARGET.check_float_symbols(
+        assert FLOAT_SYMBOLS == TARGET.check_float_symbols(
             ELF_FORMAT_FILE
         )
         mock_subprocess_run.assert_called_with(