sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-09-21 19:31:53 +01:00
Code Issues Releases Wiki Activity

utils/android: Fix AdbConnection.execute(check_exit_code=False) default

Browse Source 
Switch to have check_exit_code=True just like any other connection.

The current behavior will not raise any exception if the command returns
a non-zero exit code. This leads to failed attempt at parsing the
output, which is now an error message rather than the expected data.
Worse, the caller may never realize the command failed. This is
especially bad as that behavior will only manifest itself when things go
wrong, which is not the majority of the time, leading to code that seems
to work ok, but does not handle failure properly (like a shell script).
Lastly, since this is at odds with all the other connection types,
generic code will typically assume check_exit_code=True by default and
end up being buggy when used in conjunction of the AdbConnection.
This commit is contained in:
Douglas Raillard
2025-05-20 16:49:58 +01:00
committed by Marc Bonnici
parent f71b6a7d96
commit 9c4f09b5f3
2 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
devlib/utils/android.py
View File

@@ -359,7 +359,7 @@ class AdbConnection(ConnectionBase):
popen.communicate()
# pylint: disable=unused-argument
def execute(self, command, timeout=None, check_exit_code=False,
def execute(self, command, timeout=None, check_exit_code=True,
as_root=False, strip_colors=True, will_succeed=False):
if as_root and self.connected_as_root:
as_root = False
@@ -483,8 +483,7 @@ class AdbConnection(ConnectionBase):
return
try:
# Try the new style of invoking `su`
self.execute('ls', timeout=self.timeout, as_root=True,
check_exit_code=True)
self.execute('ls', timeout=self.timeout, as_root=True)
# If failure assume either old style or unrooted. Here we will assume
# old style and root status will be verified later.
except (TargetStableError, TargetTransientError, TimeoutError):

2
doc/connection.rst
View File

@@ -41,7 +41,7 @@ class that implements the following methods.
transfer does not complete within this period, an exception will be
raised.
.. method:: execute(self, command, timeout=None, check_exit_code=False, as_root=False, strip_colors=True, will_succeed=False)
.. method:: execute(self, command, timeout=None, check_exit_code=True, as_root=False, strip_colors=True, will_succeed=False)
Execute the specified command on the connected device and return its output.