From b57714f793058cfef3e10c0bbdc9ffb02b20c5a7 Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Mon, 9 Jan 2023 09:27:41 +0000 Subject: `qmk doctor` - Handle timeouts while checking binaries (#19549) --- lib/python/qmk/cli/doctor/check.py | 73 ++++++++++++++++++++++---------------- lib/python/qmk/cli/doctor/main.py | 6 ++-- 2 files changed, 46 insertions(+), 33 deletions(-) (limited to 'lib') diff --git a/lib/python/qmk/cli/doctor/check.py b/lib/python/qmk/cli/doctor/check.py index a368242fdb..426876e98a 100644 --- a/lib/python/qmk/cli/doctor/check.py +++ b/lib/python/qmk/cli/doctor/check.py @@ -3,7 +3,7 @@ from enum import Enum import re import shutil -from subprocess import DEVNULL +from subprocess import DEVNULL, TimeoutExpired from milc import cli from qmk import submodules @@ -41,9 +41,8 @@ def _parse_gcc_version(version): def _check_arm_gcc_version(): """Returns True if the arm-none-eabi-gcc version is not known to cause problems. """ - if 'output' in ESSENTIAL_BINARIES['arm-none-eabi-gcc']: - version_number = ESSENTIAL_BINARIES['arm-none-eabi-gcc']['output'].strip() - cli.log.info('Found arm-none-eabi-gcc version %s', version_number) + version_number = ESSENTIAL_BINARIES['arm-none-eabi-gcc']['output'].strip() + cli.log.info('Found arm-none-eabi-gcc version %s', version_number) return CheckStatus.OK # Right now all known arm versions are ok @@ -51,44 +50,37 @@ def _check_arm_gcc_version(): def _check_avr_gcc_version(): """Returns True if the avr-gcc version is not known to cause problems. """ - rc = CheckStatus.ERROR - if 'output' in ESSENTIAL_BINARIES['avr-gcc']: - version_number = ESSENTIAL_BINARIES['avr-gcc']['output'].strip() + version_number = ESSENTIAL_BINARIES['avr-gcc']['output'].strip() + cli.log.info('Found avr-gcc version %s', version_number) - cli.log.info('Found avr-gcc version %s', version_number) - rc = CheckStatus.OK + parsed_version = _parse_gcc_version(version_number) + if parsed_version['major'] > 8: + cli.log.warning('{fg_yellow}We do not recommend avr-gcc newer than 8. Downgrading to 8.x is recommended.') + return CheckStatus.WARNING - parsed_version = _parse_gcc_version(version_number) - if parsed_version['major'] > 8: - cli.log.warning('{fg_yellow}We do not recommend avr-gcc newer than 8. Downgrading to 8.x is recommended.') - rc = CheckStatus.WARNING - - return rc + return CheckStatus.OK def _check_avrdude_version(): - if 'output' in ESSENTIAL_BINARIES['avrdude']: - last_line = ESSENTIAL_BINARIES['avrdude']['output'].split('\n')[-2] - version_number = last_line.split()[2][:-1] - cli.log.info('Found avrdude version %s', version_number) + last_line = ESSENTIAL_BINARIES['avrdude']['output'].split('\n')[-2] + version_number = last_line.split()[2][:-1] + cli.log.info('Found avrdude version %s', version_number) return CheckStatus.OK def _check_dfu_util_version(): - if 'output' in ESSENTIAL_BINARIES['dfu-util']: - first_line = ESSENTIAL_BINARIES['dfu-util']['output'].split('\n')[0] - version_number = first_line.split()[1] - cli.log.info('Found dfu-util version %s', version_number) + first_line = ESSENTIAL_BINARIES['dfu-util']['output'].split('\n')[0] + version_number = first_line.split()[1] + cli.log.info('Found dfu-util version %s', version_number) return CheckStatus.OK def _check_dfu_programmer_version(): - if 'output' in ESSENTIAL_BINARIES['dfu-programmer']: - first_line = ESSENTIAL_BINARIES['dfu-programmer']['output'].split('\n')[0] - version_number = first_line.split()[1] - cli.log.info('Found dfu-programmer version %s', version_number) + first_line = ESSENTIAL_BINARIES['dfu-programmer']['output'].split('\n')[0] + version_number = first_line.split()[1] + cli.log.info('Found dfu-programmer version %s', version_number) return CheckStatus.OK @@ -96,11 +88,16 @@ def _check_dfu_programmer_version(): def check_binaries(): """Iterates through ESSENTIAL_BINARIES and tests them. """ - ok = True + ok = CheckStatus.OK for binary in sorted(ESSENTIAL_BINARIES): - if not is_executable(binary): - ok = False + try: + if not is_executable(binary): + ok = CheckStatus.ERROR + except TimeoutExpired: + cli.log.debug('Timeout checking %s', binary) + if ok != CheckStatus.ERROR: + ok = CheckStatus.WARNING return ok @@ -108,8 +105,22 @@ def check_binaries(): def check_binary_versions(): """Check the versions of ESSENTIAL_BINARIES """ + checks = { + 'arm-none-eabi-gcc': _check_arm_gcc_version, + 'avr-gcc': _check_avr_gcc_version, + 'avrdude': _check_avrdude_version, + 'dfu-util': _check_dfu_util_version, + 'dfu-programmer': _check_dfu_programmer_version, + } + versions = [] - for check in (_check_arm_gcc_version, _check_avr_gcc_version, _check_avrdude_version, _check_dfu_util_version, _check_dfu_programmer_version): + for binary in sorted(ESSENTIAL_BINARIES): + if 'output' not in ESSENTIAL_BINARIES[binary]: + cli.log.warning('Unknown version for %s', binary) + versions.append(CheckStatus.WARNING) + continue + + check = checks[binary] versions.append(check()) return versions diff --git a/lib/python/qmk/cli/doctor/main.py b/lib/python/qmk/cli/doctor/main.py index d55a11e5fd..6a6feb87d1 100755 --- a/lib/python/qmk/cli/doctor/main.py +++ b/lib/python/qmk/cli/doctor/main.py @@ -119,13 +119,15 @@ def doctor(cli): # Make sure the basic CLI tools we need are available and can be executed. bin_ok = check_binaries() - if not bin_ok: + if bin_ok == CheckStatus.ERROR: if yesno('Would you like to install dependencies?', default=True): cli.run(['util/qmk_install.sh', '-y'], stdin=DEVNULL, capture_output=False) bin_ok = check_binaries() - if bin_ok: + if bin_ok == CheckStatus.OK: cli.log.info('All dependencies are installed.') + elif bin_ok == CheckStatus.WARNING: + cli.log.warning('Issues encountered while checking dependencies.') else: status = CheckStatus.ERROR -- cgit v1.2.3