From ed23e929d62502e841b8bbd1f4379b29e90ca02b Mon Sep 17 00:00:00 2001
From: Stephen Brennan <stephen.s.brennan@oracle.com>
Date: Tue, 22 Aug 2023 09:14:45 -0700
Subject: [PATCH] Add test for Symbol Finder API

Specify a "fake" symbol finder and then test that its results are
plumbed through the API successfully. While this is a contrived test, it
helps build confidence in the plumbing of the API.

Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com>
---
 tests/test_symbol.py | 80 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

diff --git a/tests/test_symbol.py b/tests/test_symbol.py
index a8a55d21a..72c35af1d 100644
--- a/tests/test_symbol.py
+++ b/tests/test_symbol.py
@@ -263,3 +263,83 @@ def test_all_symbols(self):
         ]
         prog = elf_symbol_program(*elf_syms)
         self.assert_symbols_equal_unordered(prog.symbols(), syms)
+
+
+class TestSymbolFinder(TestCase):
+    TEST_SYMS = [
+        Symbol("one", 0xFFFF1000, 16, SymbolBinding.LOCAL, SymbolKind.FUNC),
+        Symbol("two", 0xFFFF2000, 16, SymbolBinding.GLOBAL, SymbolKind.FUNC),
+        Symbol("three", 0xFFFF2008, 8, SymbolBinding.GLOBAL, SymbolKind.FUNC),
+    ]
+
+    def finder(self, arg_name, arg_address, arg_one):
+        self.called = True
+        res = []
+        self.assertEqual(self.expected_name, arg_name)
+        self.assertEqual(self.expected_address, arg_address)
+        self.assertEqual(self.expected_one, arg_one)
+        for sym in self.TEST_SYMS:
+            if arg_name and sym.name == arg_name:
+                res.append(sym)
+            elif arg_address and sym.address <= arg_address < sym.address + sym.size:
+                res.append(sym)
+            elif not arg_name and not arg_address:
+                res.append(sym)
+
+        # This symbol finder intentionally has a bug: it does not respect the
+        # "arg_one" flag: it may return multiple symbols even when "arg_one" is
+        # true.
+        return res
+
+    def setUp(self):
+        self.prog = Program()
+        self.prog.add_symbol_finder(self.finder)
+        self.called = False
+
+    def expect_args(self, name, address, one):
+        self.expected_name = name
+        self.expected_address = address
+        self.expected_one = one
+
+    def test_args_single_string(self):
+        self.expect_args("search_symbol", None, True)
+        with self.assertRaises(LookupError):
+            self.prog.symbol("search_symbol")
+        self.assertTrue(self.called)
+
+    def test_args_single_int(self):
+        self.expect_args(None, 0xFF00, True)
+        with self.assertRaises(LookupError):
+            self.prog.symbol(0xFF00)
+        self.assertTrue(self.called)
+
+    def test_args_single_with_many_results(self):
+        self.expect_args(None, 0xFFFF2008, True)
+        with self.assertRaises(ValueError):
+            self.prog.symbol(0xFFFF2008)
+        self.assertTrue(self.called)
+
+    def test_single_with_result(self):
+        self.expect_args("one", None, True)
+        self.assertEqual(self.prog.symbol("one"), self.TEST_SYMS[0])
+        self.assertTrue(self.called)
+
+    def test_args_many_string(self):
+        self.expect_args("search_symbol", None, False)
+        self.assertEqual(self.prog.symbols("search_symbol"), [])
+        self.assertTrue(self.called)
+
+    def test_args_many_int(self):
+        self.expect_args(None, 0xFF00, False)
+        self.assertEqual(self.prog.symbols(0xFF00), [])
+        self.assertTrue(self.called)
+
+    def test_many_with_result(self):
+        self.expect_args(None, 0xFFFF2004, False)
+        self.assertEqual(self.prog.symbols(0xFFFF2004), [self.TEST_SYMS[1]])
+        self.assertTrue(self.called)
+
+    def test_many_without_filter(self):
+        self.expect_args(None, None, False)
+        self.assertEqual(self.prog.symbols(), self.TEST_SYMS)
+        self.assertTrue(self.called)