logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

check.py (7847B)

    

  1. """Check for specific programs.
  2. """
  3. from enum import Enum
  4. import re
  5. import shutil
  6. from subprocess import DEVNULL, TimeoutExpired
  7. from tempfile import TemporaryDirectory
  8. from pathlib import Path
  10. from milc import cli
  11. from qmk import submodules
  14. class CheckStatus(Enum):
  15.     OK = 1
  16.     WARNING = 2
  17.     ERROR = 3
  20. ESSENTIAL_BINARIES = {
  21.     'dfu-programmer': {},
  22.     'avrdude': {},
  23.     'dfu-util': {},
  24.     'avr-gcc': {
  25.         'version_arg': '-dumpversion'
  26.     },
  27.     'arm-none-eabi-gcc': {
  28.         'version_arg': '-dumpversion'
  29.     },
  30. }
  33. def _parse_gcc_version(version):
  34.     m = re.match(r"(\d+)(?:\.(\d+))?(?:\.(\d+))?", version)
  36.     return {
  37.         'major': int(m.group(1)),
  38.         'minor': int(m.group(2)) if m.group(2) else 0,
  39.         'patch': int(m.group(3)) if m.group(3) else 0,
  40.     }
  43. def _check_arm_gcc_version():
  44.     """Returns True if the arm-none-eabi-gcc version is not known to cause problems.
  45.     """
  46.     version_number = ESSENTIAL_BINARIES['arm-none-eabi-gcc']['output'].strip()
  47.     cli.log.info('Found arm-none-eabi-gcc version %s', version_number)
  49.     # Right now all known ARM versions are ok, so check that it can produce binaries
  50.     return _check_arm_gcc_installation()
  53. def _check_arm_gcc_installation():
  54.     """Returns OK if the arm-none-eabi-gcc is fully installed and can produce binaries.
  55.     """
  56.     with TemporaryDirectory() as temp_dir:
  57.         temp_in = Path(temp_dir) / 'test.c'
  58.         temp_out = Path(temp_dir) / 'test.elf'
  60.         temp_in.write_text('#include <newlib.h>\nint main() { return __NEWLIB__ * __NEWLIB_MINOR__ * __NEWLIB_PATCHLEVEL__; }', encoding='utf-8')
  62.         args = ['arm-none-eabi-gcc', '-mcpu=cortex-m0', '-mthumb', '-mno-thumb-interwork', '--specs=nosys.specs', '--specs=nano.specs', '-x', 'c', '-o', str(temp_out), str(temp_in)]
  63.         result = cli.run(args, stdout=None, stderr=None)
  64.         if result.returncode == 0:
  65.             cli.log.info('Successfully compiled using arm-none-eabi-gcc')
  66.         else:
  67.             cli.log.error(f'Failed to compile a simple program with arm-none-eabi-gcc, return code {result.returncode}')
  68.             cli.log.error(f'Command: {" ".join(args)}')
  69.             return CheckStatus.ERROR
  71.         args = ['arm-none-eabi-size', str(temp_out)]
  72.         result = cli.run(args, stdout=None, stderr=None)
  73.         if result.returncode == 0:
  74.             cli.log.info('Successfully tested arm-none-eabi-binutils using arm-none-eabi-size')
  75.         else:
  76.             cli.log.error(f'Failed to execute arm-none-eabi-size, perhaps corrupt arm-none-eabi-binutils, return code {result.returncode}')
  77.             cli.log.error(f'Command: {" ".join(args)}')
  78.             return CheckStatus.ERROR
  80.         return CheckStatus.OK
  83. def _check_avr_gcc_version():
  84.     """Returns True if the avr-gcc version is not known to cause problems.
  85.     """
  86.     version_number = ESSENTIAL_BINARIES['avr-gcc']['output'].strip()
  87.     cli.log.info('Found avr-gcc version %s', version_number)
  89.     # Right now all known AVR versions are ok, so check that it can produce binaries
  90.     return _check_avr_gcc_installation()
  93. def _check_avr_gcc_installation():
  94.     """Returns OK if the avr-gcc is fully installed and can produce binaries.
  95.     """
  96.     with TemporaryDirectory() as temp_dir:
  97.         temp_in = Path(temp_dir) / 'test.c'
  98.         temp_out = Path(temp_dir) / 'test.elf'
  100.         temp_in.write_text('int main() { return 0; }', encoding='utf-8')
  102.         args = ['avr-gcc', '-mmcu=atmega32u4', '-x', 'c', '-o', str(temp_out), str(temp_in)]
  103.         result = cli.run(args, stdout=None, stderr=None)
  104.         if result.returncode == 0:
  105.             cli.log.info('Successfully compiled using avr-gcc')
  106.         else:
  107.             cli.log.error(f'Failed to compile a simple program with avr-gcc, return code {result.returncode}')
  108.             cli.log.error(f'Command: {" ".join(args)}')
  109.             return CheckStatus.ERROR
  111.         args = ['avr-size', str(temp_out)]
  112.         result = cli.run(args, stdout=None, stderr=None)
  113.         if result.returncode == 0:
  114.             cli.log.info('Successfully tested avr-binutils using avr-size')
  115.         else:
  116.             cli.log.error(f'Failed to execute avr-size, perhaps corrupt avr-binutils, return code {result.returncode}')
  117.             cli.log.error(f'Command: {" ".join(args)}')
  118.             return CheckStatus.ERROR
  120.         return CheckStatus.OK
  123. def _check_avrdude_version():
  124.     last_line = ESSENTIAL_BINARIES['avrdude']['output'].split('\n')[-2]
  125.     version_number = last_line.split()[2][:-1]
  126.     cli.log.info('Found avrdude version %s', version_number)
  128.     return CheckStatus.OK
  131. def _check_dfu_util_version():
  132.     first_line = ESSENTIAL_BINARIES['dfu-util']['output'].split('\n')[0]
  133.     version_number = first_line.split()[1]
  134.     cli.log.info('Found dfu-util version %s', version_number)
  136.     return CheckStatus.OK
  139. def _check_dfu_programmer_version():
  140.     first_line = ESSENTIAL_BINARIES['dfu-programmer']['output'].split('\n')[0]
  141.     version_number = first_line.split()[1]
  142.     cli.log.info('Found dfu-programmer version %s', version_number)
  144.     return CheckStatus.OK
  147. def check_binaries():
  148.     """Iterates through ESSENTIAL_BINARIES and tests them.
  149.     """
  150.     ok = CheckStatus.OK
  152.     for binary in sorted(ESSENTIAL_BINARIES):
  153.         try:
  154.             if not is_executable(binary):
  155.                 ok = CheckStatus.ERROR
  156.         except TimeoutExpired:
  157.             cli.log.debug('Timeout checking %s', binary)
  158.             if ok != CheckStatus.ERROR:
  159.                 ok = CheckStatus.WARNING
  161.     return ok
  164. def check_binary_versions():
  165.     """Check the versions of ESSENTIAL_BINARIES
  166.     """
  167.     checks = {
  168.         'arm-none-eabi-gcc': _check_arm_gcc_version,
  169.         'avr-gcc': _check_avr_gcc_version,
  170.         'avrdude': _check_avrdude_version,
  171.         'dfu-util': _check_dfu_util_version,
  172.         'dfu-programmer': _check_dfu_programmer_version,
  173.     }
  175.     versions = []
  176.     for binary in sorted(ESSENTIAL_BINARIES):
  177.         if 'output' not in ESSENTIAL_BINARIES[binary]:
  178.             cli.log.warning('Unknown version for %s', binary)
  179.             versions.append(CheckStatus.WARNING)
  180.             continue
  182.         check = checks[binary]
  183.         versions.append(check())
  184.     return versions
  187. def check_submodules():
  188.     """Iterates through all submodules to make sure they're cloned and up to date.
  189.     """
  190.     for submodule in submodules.status().values():
  191.         if submodule['status'] is None:
  192.             return CheckStatus.ERROR
  193.         elif not submodule['status']:
  194.             return CheckStatus.WARNING
  196.     return CheckStatus.OK
  199. def is_executable(command):
  200.     """Returns True if command exists and can be executed.
  201.     """
  202.     # Make sure the command is in the path.
  203.     res = shutil.which(command)
  204.     if res is None:
  205.         cli.log.error("{fg_red}Can't find %s in your path.", command)
  206.         return False
  208.     # Make sure the command can be executed
  209.     version_arg = ESSENTIAL_BINARIES[command].get('version_arg', '--version')
  210.     check = cli.run([command, version_arg], combined_output=True, stdin=DEVNULL, timeout=5)
  212.     ESSENTIAL_BINARIES[command]['output'] = check.stdout
  214.     if check.returncode in [0, 1]:  # Older versions of dfu-programmer exit 1
  215.         cli.log.debug('Found {fg_cyan}%s', command)
  216.         return True
  218.     cli.log.error("{fg_red}Can't run `%s %s`", command, version_arg)
  219.     return False
  222. def release_info(file='/etc/os-release'):
  223.     """Parse release info to dict
  224.     """
  225.     ret = {}
  226.     try:
  227.         with open(file) as f:
  228.             for line in f:
  229.                 if '=' in line:
  230.                     key, value = map(str.strip, line.split('=', 1))
  231.                     if value.startswith('"') and value.endswith('"'):
  232.                         value = value[1:-1]
  233.                     ret[key] = value
  234.     except (PermissionError, FileNotFoundError):
  235.         pass
  237.     return ret