qmk doctor - Handle timeouts while checking binaries (#19549)

This commit is contained in:
Joel Challis 2023-01-09 09:27:41 +00:00 committed by GitHub
parent a3ed1b0c8d
commit b57714f793
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 46 additions and 33 deletions

View file

@ -3,7 +3,7 @@
from enum import Enum from enum import Enum
import re import re
import shutil import shutil
from subprocess import DEVNULL from subprocess import DEVNULL, TimeoutExpired
from milc import cli from milc import cli
from qmk import submodules from qmk import submodules
@ -41,7 +41,6 @@ def _parse_gcc_version(version):
def _check_arm_gcc_version(): def _check_arm_gcc_version():
"""Returns True if the arm-none-eabi-gcc version is not known to cause problems. """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() version_number = ESSENTIAL_BINARIES['arm-none-eabi-gcc']['output'].strip()
cli.log.info('Found arm-none-eabi-gcc version %s', version_number) cli.log.info('Found arm-none-eabi-gcc version %s', version_number)
@ -51,23 +50,18 @@ def _check_arm_gcc_version():
def _check_avr_gcc_version(): def _check_avr_gcc_version():
"""Returns True if the avr-gcc version is not known to cause problems. """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) parsed_version = _parse_gcc_version(version_number)
if parsed_version['major'] > 8: 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.') cli.log.warning('{fg_yellow}We do not recommend avr-gcc newer than 8. Downgrading to 8.x is recommended.')
rc = CheckStatus.WARNING return CheckStatus.WARNING
return rc return CheckStatus.OK
def _check_avrdude_version(): def _check_avrdude_version():
if 'output' in ESSENTIAL_BINARIES['avrdude']:
last_line = ESSENTIAL_BINARIES['avrdude']['output'].split('\n')[-2] last_line = ESSENTIAL_BINARIES['avrdude']['output'].split('\n')[-2]
version_number = last_line.split()[2][:-1] version_number = last_line.split()[2][:-1]
cli.log.info('Found avrdude version %s', version_number) cli.log.info('Found avrdude version %s', version_number)
@ -76,7 +70,6 @@ def _check_avrdude_version():
def _check_dfu_util_version(): def _check_dfu_util_version():
if 'output' in ESSENTIAL_BINARIES['dfu-util']:
first_line = ESSENTIAL_BINARIES['dfu-util']['output'].split('\n')[0] first_line = ESSENTIAL_BINARIES['dfu-util']['output'].split('\n')[0]
version_number = first_line.split()[1] version_number = first_line.split()[1]
cli.log.info('Found dfu-util version %s', version_number) cli.log.info('Found dfu-util version %s', version_number)
@ -85,7 +78,6 @@ def _check_dfu_util_version():
def _check_dfu_programmer_version(): def _check_dfu_programmer_version():
if 'output' in ESSENTIAL_BINARIES['dfu-programmer']:
first_line = ESSENTIAL_BINARIES['dfu-programmer']['output'].split('\n')[0] first_line = ESSENTIAL_BINARIES['dfu-programmer']['output'].split('\n')[0]
version_number = first_line.split()[1] version_number = first_line.split()[1]
cli.log.info('Found dfu-programmer version %s', version_number) cli.log.info('Found dfu-programmer version %s', version_number)
@ -96,11 +88,16 @@ def _check_dfu_programmer_version():
def check_binaries(): def check_binaries():
"""Iterates through ESSENTIAL_BINARIES and tests them. """Iterates through ESSENTIAL_BINARIES and tests them.
""" """
ok = True ok = CheckStatus.OK
for binary in sorted(ESSENTIAL_BINARIES): for binary in sorted(ESSENTIAL_BINARIES):
try:
if not is_executable(binary): if not is_executable(binary):
ok = False ok = CheckStatus.ERROR
except TimeoutExpired:
cli.log.debug('Timeout checking %s', binary)
if ok != CheckStatus.ERROR:
ok = CheckStatus.WARNING
return ok return ok
@ -108,8 +105,22 @@ def check_binaries():
def check_binary_versions(): def check_binary_versions():
"""Check the versions of ESSENTIAL_BINARIES """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 = [] 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()) versions.append(check())
return versions return versions

View file

@ -119,13 +119,15 @@ def doctor(cli):
# Make sure the basic CLI tools we need are available and can be executed. # Make sure the basic CLI tools we need are available and can be executed.
bin_ok = check_binaries() bin_ok = check_binaries()
if not bin_ok: if bin_ok == CheckStatus.ERROR:
if yesno('Would you like to install dependencies?', default=True): if yesno('Would you like to install dependencies?', default=True):
cli.run(['util/qmk_install.sh', '-y'], stdin=DEVNULL, capture_output=False) cli.run(['util/qmk_install.sh', '-y'], stdin=DEVNULL, capture_output=False)
bin_ok = check_binaries() bin_ok = check_binaries()
if bin_ok: if bin_ok == CheckStatus.OK:
cli.log.info('All dependencies are installed.') cli.log.info('All dependencies are installed.')
elif bin_ok == CheckStatus.WARNING:
cli.log.warning('Issues encountered while checking dependencies.')
else: else:
status = CheckStatus.ERROR status = CheckStatus.ERROR