Skip to content

Fix UnboundLocalError when an optional AndroidDevice fails to initialize #1069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xpconanfan merged 2 commits into from
Oct 12, 2026
Merged

Fix UnboundLocalError when an optional AndroidDevice fails to initialize #1069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
841ac39
Fix UnboundLocalError when an optional AndroidDevice fails to initialize
kwy404 Oct 11, 2026
22c5f0c
Assert the skip log and cover a later optional device in the tests
kwy404 Oct 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mobly/controllers/android_device.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ def get_instances_with_configs(configs):
except Exception:
if is_required:
raise
ad.log.exception('Skipping this optional device due to error.')
logging.exception('Skipping optional device %s due to error.', serial)
continue
results.append(ad)
return results
Expand Down
60 changes: 60 additions & 0 deletions tests/mobly/controllers/android_device_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,66 @@ def test_get_instances_with_configs_invalid_config(self):
):
android_device.get_instances_with_configs([config])

@mock.patch('mobly.controllers.android_device.list_fastboot_devices')
@mock.patch('mobly.controllers.android_device.list_adb_devices')
@mock.patch('mobly.controllers.android_device.list_adb_devices_by_usb_id')
@mock.patch('mobly.controllers.android_device.AndroidDevice')
def test_get_instances_with_configs_skips_optional_device_on_init_error(
self, mock_ad_class, mock_list_adb_usb, mock_list_adb, mock_list_fastboot
):
mock_list_fastboot.return_value = []
mock_list_adb.return_value = ['1', '2']
mock_list_adb_usb.return_value = []
mock_ad = mock.MagicMock()

def _make_ad(serial):
if serial == '1':
raise Exception('Something went wrong.')
return mock_ad

mock_ad_class.side_effect = _make_ad
configs = [{'serial': '1', 'required': False}, {'serial': '2'}]
with self.assertLogs(level='ERROR') as cm:
ads = android_device.get_instances_with_configs(configs)
self.assertEqual(ads, [mock_ad])
self.assertTrue(
any(
'Skipping optional device 1 due to error.' in line
for line in cm.output
)
)
mock_ad.log.exception.assert_not_called()

@mock.patch('mobly.controllers.android_device.list_fastboot_devices')
@mock.patch('mobly.controllers.android_device.list_adb_devices')
@mock.patch('mobly.controllers.android_device.list_adb_devices_by_usb_id')
@mock.patch('mobly.controllers.android_device.AndroidDevice')
def test_get_instances_with_configs_skips_later_optional_device_on_init_error(
self, mock_ad_class, mock_list_adb_usb, mock_list_adb, mock_list_fastboot
):
mock_list_fastboot.return_value = []
mock_list_adb.return_value = ['1', '2']
mock_list_adb_usb.return_value = []
mock_ad = mock.MagicMock()

def _make_ad(serial):
if serial == '2':
raise Exception('Something went wrong.')
return mock_ad

mock_ad_class.side_effect = _make_ad
configs = [{'serial': '1'}, {'serial': '2', 'required': False}]
with self.assertLogs(level='ERROR') as cm:
ads = android_device.get_instances_with_configs(configs)
self.assertEqual(ads, [mock_ad])
self.assertTrue(
any(
'Skipping optional device 2 due to error.' in line
for line in cm.output
)
)
mock_ad.log.exception.assert_not_called()

@mock.patch('mobly.controllers.android_device.list_fastboot_devices')
@mock.patch('mobly.controllers.android_device.list_adb_devices')
@mock.patch('mobly.controllers.android_device.list_adb_devices_by_usb_id')
Expand Down
Loading