arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-11-18 05:28:40 +00:00
Code Issues Releases Wiki Activity

feat(python/debuglink): reset_debug_features to reconfigure debuglink

Browse Source
This commit is contained in:
matejcik 2021-07-30 15:58:31 +02:00 committed by matejcik
parent b3312d1ef7
commit 92e9d61e24
1 changed files with 30 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
python/src/trezorlib/debuglink.py
View File

@ -374,19 +374,21 @@ class TrezorClientDebugLink(TrezorClient):
else: else:
raise raise
self.ui = DebugUI(self.debug) self.reset_debug_features()
self.in_with_statement = 0
self.screenshot_id = 0
self.filters = {}
# Do not expect any specific response from device
self.expected_responses = None
self.actual_responses = None
super().__init__(transport, ui=self.ui) super().__init__(transport, ui=self.ui)
def reset_debug_features(self):
"""Prepare the debugging client for a new testcase.
Clears all debugging state that might have been modified by a testcase.
"""
self.ui = DebugUI(self.debug)
self.in_with_statement = False
self.expected_responses = None
self.actual_responses = None
self.filters = {}
def open(self): def open(self):
super().open() super().open()
if self.session_counter == 1: if self.session_counter == 1:
@ -470,31 +472,24 @@ class TrezorClientDebugLink(TrezorClient):
def __enter__(self): def __enter__(self):
# For usage in with/expected_responses # For usage in with/expected_responses
self.in_with_statement += 1 if self.in_with_statement:
if self.in_with_statement > 1:
raise RuntimeError("Do not nest!") raise RuntimeError("Do not nest!")
self.in_with_statement = True
return self return self
def __exit__(self, _type, value, traceback): def __exit__(self, exc_type, value, traceback):
__tracebackhide__ = True # for pytest # pylint: disable=W0612 __tracebackhide__ = True # for pytest # pylint: disable=W0612
self.in_with_statement -= 1
self.ui.clear()
self.filters.clear()
self.watch_layout(False) self.watch_layout(False)
# copy expected/actual responses before clearing them
expected_responses = self.expected_responses
actual_responses = self.actual_responses
self.reset_debug_features()
if _type is not None: if exc_type is None:
# Another exception raised # If no other exception was raised, evaluate missed responses
return False # (raises AssertionError on mismatch)
self._verify_responses(expected_responses, actual_responses)
try:
# Evaluate missed responses in 'with' statement
self._verify_responses(self.expected_responses, self.actual_responses)
finally:
self.expected_responses = None
self.actual_responses = None
return False
def set_expected_responses(self, expected): def set_expected_responses(self, expected):
"""Set a sequence of expected responses to client calls. """Set a sequence of expected responses to client calls.
@ -561,7 +556,8 @@ class TrezorClientDebugLink(TrezorClient):
def _raw_write(self, msg): def _raw_write(self, msg):
return super()._raw_write(self._filter_message(msg)) return super()._raw_write(self._filter_message(msg))
def _expectation_lines(self, expected, current): @staticmethod
def _expectation_lines(expected, current):
start_at = max(current - EXPECTED_RESPONSES_CONTEXT_LINES, 0) start_at = max(current - EXPECTED_RESPONSES_CONTEXT_LINES, 0)
stop_at = min(current + EXPECTED_RESPONSES_CONTEXT_LINES + 1, len(expected)) stop_at = min(current + EXPECTED_RESPONSES_CONTEXT_LINES + 1, len(expected))
output = [] output = []
@ -579,7 +575,8 @@ class TrezorClientDebugLink(TrezorClient):
output.append("") output.append("")
return output return output
def _verify_responses(self, expected, actual): @classmethod
def _verify_responses(cls, expected, actual):
__tracebackhide__ = True # for pytest # pylint: disable=W0612 __tracebackhide__ = True # for pytest # pylint: disable=W0612
if expected is None and actual is None: if expected is None and actual is None:
@ -587,7 +584,7 @@ class TrezorClientDebugLink(TrezorClient):
for i, (exp, act) in enumerate(zip_longest(expected, actual)): for i, (exp, act) in enumerate(zip_longest(expected, actual)):
if exp is None: if exp is None:
output = self._expectation_lines(expected, i) output = cls._expectation_lines(expected, i)
output.append("No more messages were expected, but we got:") output.append("No more messages were expected, but we got:")
for resp in actual[i:]: for resp in actual[i:]:
output.append( output.append(
@ -596,12 +593,12 @@ class TrezorClientDebugLink(TrezorClient):
raise AssertionError("\n".join(output)) raise AssertionError("\n".join(output))
if act is None: if act is None:
output = self._expectation_lines(expected, i) output = cls._expectation_lines(expected, i)
output.append("This and the following message was not received.") output.append("This and the following message was not received.")
raise AssertionError("\n".join(output)) raise AssertionError("\n".join(output))
if not exp.match(act): if not exp.match(act):
output = self._expectation_lines(expected, i) output = cls._expectation_lines(expected, i)
output.append("Actually received:") output.append("Actually received:")
output.append(textwrap.indent(protobuf.format_message(act), " ")) output.append(textwrap.indent(protobuf.format_message(act), " "))
raise AssertionError("\n".join(output)) raise AssertionError("\n".join(output))