diff options
Diffstat (limited to 'lib/python/qmk/commands.py')
| -rw-r--r-- | lib/python/qmk/commands.py | 142 | 
1 files changed, 117 insertions, 25 deletions
| diff --git a/lib/python/qmk/commands.py b/lib/python/qmk/commands.py index 3a35c11031..8c66228b2b 100644 --- a/lib/python/qmk/commands.py +++ b/lib/python/qmk/commands.py @@ -2,6 +2,7 @@  """  import json  import os +import sys  import shutil  from pathlib import Path  from subprocess import DEVNULL @@ -10,7 +11,7 @@ from time import strftime  from milc import cli  import qmk.keymap -from qmk.constants import KEYBOARD_OUTPUT_PREFIX +from qmk.constants import QMK_FIRMWARE, KEYBOARD_OUTPUT_PREFIX  from qmk.json_schema import json_load  time_fmt = '%Y-%m-%d-%H:%M:%S' @@ -86,11 +87,17 @@ def create_make_command(keyboard, keymap, target=None, parallel=1, **env_vars):      return create_make_target(':'.join(make_args), parallel, **env_vars) -def get_git_version(repo_dir='.', check_dir='.'): +def get_git_version(current_time, repo_dir='.', check_dir='.'):      """Returns the current git version for a repo, or the current time.      """      git_describe_cmd = ['git', 'describe', '--abbrev=6', '--dirty', '--always', '--tags'] +    if repo_dir != '.': +        repo_dir = Path('lib') / repo_dir + +    if check_dir != '.': +        check_dir = repo_dir / check_dir +      if Path(check_dir).exists():          git_describe = cli.run(git_describe_cmd, stdin=DEVNULL, cwd=repo_dir) @@ -100,23 +107,40 @@ def get_git_version(repo_dir='.', check_dir='.'):          else:              cli.log.warn(f'"{" ".join(git_describe_cmd)}" returned error code {git_describe.returncode}')              print(git_describe.stderr) -            return strftime(time_fmt) +            return current_time -    return strftime(time_fmt) +    return current_time -def write_version_h(git_version, build_date, chibios_version, chibios_contrib_version): -    """Generate and write quantum/version.h +def create_version_h(skip_git=False, skip_all=False): +    """Generate version.h contents      """ -    version_h = [ -        f'#define QMK_VERSION "{git_version}"', -        f'#define QMK_BUILDDATE "{build_date}"', -        f'#define CHIBIOS_VERSION "{chibios_version}"', -        f'#define CHIBIOS_CONTRIB_VERSION "{chibios_contrib_version}"', -    ] +    if skip_all: +        current_time = "1970-01-01-00:00:00" +    else: +        current_time = strftime(time_fmt) + +    if skip_git: +        git_version = "NA" +        chibios_version = "NA" +        chibios_contrib_version = "NA" +    else: +        git_version = get_git_version(current_time) +        chibios_version = get_git_version(current_time, "chibios", "os") +        chibios_contrib_version = get_git_version(current_time, "chibios-contrib", "os") + +    version_h_lines = f"""/* This file was automatically generated. Do not edit or copy. + */ + +#pragma once + +#define QMK_VERSION "{git_version}" +#define QMK_BUILDDATE "{current_time}" +#define CHIBIOS_VERSION "{chibios_version}" +#define CHIBIOS_CONTRIB_VERSION "{chibios_contrib_version}" +""" -    version_h_file = Path('quantum/version.h') -    version_h_file.write_text('\n'.join(version_h)) +    return version_h_lines  def compile_configurator_json(user_keymap, bootloader=None, parallel=1, **env_vars): @@ -149,13 +173,8 @@ def compile_configurator_json(user_keymap, bootloader=None, parallel=1, **env_va      keymap_dir.mkdir(exist_ok=True, parents=True)      keymap_c.write_text(c_text) -    # Write the version.h file -    git_version = get_git_version() -    build_date = strftime('%Y-%m-%d-%H:%M:%S') -    chibios_version = get_git_version("lib/chibios", "lib/chibios/os") -    chibios_contrib_version = get_git_version("lib/chibios-contrib", "lib/chibios-contrib/os") - -    write_version_h(git_version, build_date, chibios_version, chibios_contrib_version) +    version_h = Path('quantum/version.h') +    version_h.write_text(create_version_h())      # Return a command that can be run to make the keymap and flash if given      verbose = 'true' if cli.config.general.verbose else 'false' @@ -181,10 +200,6 @@ def compile_configurator_json(user_keymap, bootloader=None, parallel=1, **env_va          make_command.append(f'{key}={value}')      make_command.extend([ -        f'GIT_VERSION={git_version}', -        f'BUILD_DATE={build_date}', -        f'CHIBIOS_VERSION={chibios_version}', -        f'CHIBIOS_CONTRIB_VERSION={chibios_contrib_version}',          f'KEYBOARD={user_keymap["keyboard"]}',          f'KEYMAP={user_keymap["keymap"]}',          f'KEYBOARD_FILESAFE={keyboard_filesafe}', @@ -223,3 +238,80 @@ def parse_configurator_json(configurator_file):              user_keymap['layout'] = aliases[orig_keyboard]['layouts'][user_keymap['layout']]      return user_keymap + + +def git_get_username(): +    """Retrieves user's username from Git config, if set. +    """ +    git_username = cli.run(['git', 'config', '--get', 'user.name']) + +    if git_username.returncode == 0 and git_username.stdout: +        return git_username.stdout.strip() + + +def git_check_repo(): +    """Checks that the .git directory exists inside QMK_HOME. + +    This is a decent enough indicator that the qmk_firmware directory is a +    proper Git repository, rather than a .zip download from GitHub. +    """ +    dot_git_dir = QMK_FIRMWARE / '.git' + +    return dot_git_dir.is_dir() + + +def git_get_branch(): +    """Returns the current branch for a repo, or None. +    """ +    git_branch = cli.run(['git', 'branch', '--show-current']) +    if not git_branch.returncode != 0 or not git_branch.stdout: +        # Workaround for Git pre-2.22 +        git_branch = cli.run(['git', 'rev-parse', '--abbrev-ref', 'HEAD']) + +    if git_branch.returncode == 0: +        return git_branch.stdout.strip() + + +def git_is_dirty(): +    """Returns 1 if repo is dirty, or 0 if clean +    """ +    git_diff_staged_cmd = ['git', 'diff', '--quiet'] +    git_diff_unstaged_cmd = [*git_diff_staged_cmd, '--cached'] + +    unstaged = cli.run(git_diff_staged_cmd) +    staged = cli.run(git_diff_unstaged_cmd) + +    return unstaged.returncode != 0 or staged.returncode != 0 + + +def git_get_remotes(): +    """Returns the current remotes for a repo. +    """ +    remotes = {} + +    git_remote_show_cmd = ['git', 'remote', 'show'] +    git_remote_get_cmd = ['git', 'remote', 'get-url'] + +    git_remote_show = cli.run(git_remote_show_cmd) +    if git_remote_show.returncode == 0: +        for name in git_remote_show.stdout.splitlines(): +            git_remote_name = cli.run([*git_remote_get_cmd, name]) +            remotes[name.strip()] = {"url": git_remote_name.stdout.strip()} + +    return remotes + + +def git_check_deviation(active_branch): +    """Return True if branch has custom commits +    """ +    cli.run(['git', 'fetch', 'upstream', active_branch]) +    deviations = cli.run(['git', '--no-pager', 'log', f'upstream/{active_branch}...{active_branch}']) +    return bool(deviations.returncode) + + +def in_virtualenv(): +    """Check if running inside a virtualenv. +    Based on https://stackoverflow.com/a/1883251 +    """ +    active_prefix = getattr(sys, "base_prefix", None) or getattr(sys, "real_prefix", None) or sys.prefix +    return active_prefix != sys.prefix | 
