Address #27380 (and similar future issues) by handling failed assert_equal()
assertions in bcc callback functions
Problem
Exceptions are not propagated in ctype callback functions used by bcc. This means an AssertionError exception raised by assert_equal()
to signal a failed assertion is not getting caught and properly logged. Instead, the error is logged to stdout and execution of the callback stops.
The current workaround to check whether all assert_equal()
assertions in a callback succeeded is to increment a success counter after the assertions (which only gets incremented if none exception is raised and stops execution). Then, outside the callback, the success counter can be used to check whether a callback executed successfully.
One issue with the described workaround is that when an exception occurs, there is no way of telling which of the assert_equal()
statements caused the exception; moreover, there is no way of inspecting how the pieces of data that got compared in assert_equal()
differed (often a crucial clue when debugging what went wrong).
This problem is happening in #27380: Sporadically, in the mempool:rejected
test, execution does not reach the end of the callback function and the success counter is not incremented. Thus, the test fails when comparing the counter to its expected value of one. Without knowing which of the asserts failed any why it failed, this issue is hard to debug.
Solution
Two fixes come to mind. The first involves having the callback function make event data accessible outside the callback and inspecting the event using assert_equal()
outside the callback. This solution still requires a counter in the callback in order to tell whether a callback was actually executed or if instead the call to perf_buffer_poll() timed out.
The second fix entails wrapping all relevant assert_equal()
statements inside callback functions into try-catch blocks and manually logging AssertionErrors. While not as elegant in terms of design, this approach can be more pragmatic for more complex tests (e.g., ones involving multiple events, events of different types, or the order of events).
The solution proposed here is to select the most pragmatic fix on a case-by-case basis: Tests in interface_usdt_net.py
, interface_usdt_mempool.py
and interface_usdt_validation.py
have been refactored to use the first approach, while the second approach was chosen for interface_usdt_utxocache.py
(partly to provide a reference for the second approach, but mainly because the utxocache tests are the most intricate tests, and refactoring them to use the first approach would negatively impact their readability). Lastly, interface_usdt_coinselection.py
was kept unchanged because it does not use assert_equal()
statements inside callback functions.