buildroot/bin/use_example_configs - bugfix-2.1.x - githubmirror/Marlin

buildroot/bin/use_example_configs
174 строки6 KB
Scott Lahteine
✅ Validate path in use_example_configs
06 июл 2026, 03:17
06 июл 2026, 03:174e80e17
#!/usr/bin/env python3
#
# use_example_configs [branch:]configpath
#
# Examples:
#   use_example_configs
#   use_example_configs Creality/CR-10/CrealityV1
#   use_example_configs release-2.0.9.4:Creality/CR-10/CrealityV1
#
# If a configpath has spaces (or quotes) escape them or enquote the path
# If no branch: prefix is given use configs based on the current branch name.
# e.g., For `latest-2.1.x` name the working branch something like "my_work-2.1.x."
#       The branch or tag must first exist at MarlinFirmware/Configurations.
#       The fallback branch is bugfix-2.1.x.
#

import os, subprocess, sys, urllib.request, urllib.error
from pathlib import Path

DEBUGGING = False
CONFIG_FILES = ("Configuration.h", "Configuration_adv.h", "_Bootscreen.h", "_Statusscreen.h")

def debug_print(s):
    if DEBUGGING: print(s)

def get_current_branch():
    try:
        result = subprocess.run(['git', 'branch'], capture_output=True, text=True, check=True)
        for line in result.stdout.splitlines():
            if line.startswith('*'):
                return line[2:]
    except subprocess.CalledProcessError:
        return None

def sparse_checkout(branch, config_path, repo_url="https://github.com/MarlinFirmware/Configurations.git"):
    configs_dir = Path("ConfigurationsRepo")
    config_subdir = f"config/{config_path}"

    if not configs_dir.exists():
        # Step 1: Clone with no checkout
        subprocess.run([
            "git", "clone", "--depth", "1", "--filter=blob:none", "--sparse",
            "--branch", branch, repo_url, str(configs_dir)
        ], check=True)

    # Step 2: Enable sparse checkout and set the folder
    subprocess.run(["git", "sparse-checkout", "set", config_subdir], cwd=str(configs_dir), check=True)
    # Step 3: Pull the latest for that branch/folder
    subprocess.run(["git", "pull"], cwd=str(configs_dir), check=True)

def copy_config_files(branch, config_path, dest_dir):
    sparse_checkout(branch, config_path)

    src_dir = Path("ConfigurationsRepo") / "config" / config_path

    # Validate that configuration files were actually found
    found_any = any((src_dir / fname).exists() for fname in CONFIG_FILES)
    if not found_any:
        print(f"ERROR: No configuration files found for path '{config_path}' (branch: {branch}).")
        print(f"  Verify the path and branch names are correct.")
        sys.exit(1)

    for fname in CONFIG_FILES:
        src_file = src_dir / fname
        if src_file.exists():
            dest_file = dest_dir / fname
            debug_print(f"Copying {src_file} to {dest_file}")
            dest_file.write_bytes(src_file.read_bytes())
        else:
            debug_print(f"{fname} not found in {src_dir}")

def validate_config_path(cref, config_path):
    """Validate that the config path exists before attempting to fetch files."""
    config_path_url = config_path.replace(' ', '%20')
    base_url = f"https://raw.githubusercontent.com/MarlinFirmware/Configurations/{cref}/config/{config_path_url}"
    probe_url = f"{base_url}/Configuration.h"
    try:
        with urllib.request.urlopen(urllib.request.Request(probe_url, method='HEAD')):
            pass
    except urllib.error.HTTPError as e:
        if e.code == 404:
            print(f"ERROR: Configurations path not found.")
            print(f"  Path:   {config_path}")
            print(f"  Branch: {cref}")
            print(f"  URL:    https://github.com/MarlinFirmware/Configurations/tree/{cref}/config/{config_path}")
            print(f"  Verify the path and branch names are correct and try again.")
            sys.exit(1)
        raise

def fetch_config_files(cref, config_path, dest_dir):
    validate_config_path(cref, config_path)

    config_path_url = config_path.replace(' ', '%20')
    base_url = f"https://raw.githubusercontent.com/MarlinFirmware/Configurations/{cref}/config/{config_path_url}"

    for file in CONFIG_FILES:
        url = f"{base_url}/{file}"
        dest_file = dest_dir / file
        if os.getenv('DEBUG', '0') == '1':
            debug_print(f"Fetching {file} from {url} to {dest_file}")

        try:
            urllib.request.urlretrieve(url, dest_file)
        except urllib.error.HTTPError as e:
            if e.code == 404:
                if os.getenv('DEBUG', '0') == '1':
                    print(f"File {file} not found (404), skipping.")
            else:
                raise

def fetch_configs(cref, config_path):
    print(f"Fetching {config_path} configurations from {cref}...")

    marlin_dir = Path("Marlin")
    if not marlin_dir.exists():
        print(f"Directory 'Marlin' not found at the current location.")
        sys.exit(1)

    if os.environ.get('GITHUB_ACTIONS'):        # Running on GitHub ?
        copy_config_files(cref, config_path, marlin_dir)
    else:
        fetch_config_files(cref, config_path, marlin_dir)

def main():
    mbranch = get_current_branch()
    if not mbranch:
        print("Not a git repository or no branch found.")
        sys.exit(1)

    if mbranch.startswith("bugfix-"):
        cref = mbranch
    elif mbranch.startswith("lts-"):
        cref = mbranch.replace("lts-", "latest-")
    elif mbranch.endswith("bugfix-2.1.x"):
        cref = "bugfix-2.1.x"
    elif mbranch.endswith("-2.1.x") or mbranch == "2.1.x":
        cref = "latest-2.1.x"
    elif mbranch.endswith("bugfix-2.0.x"):
        cref = "bugfix-2.0.x"
    elif mbranch.endswith("-2.0.x") or mbranch == "2.0.x":
        cref = "latest-2.0.x"
    elif mbranch.endswith("bugfix-1.1.x"):
        cref = "bugfix-1.1.x"
    elif mbranch.endswith("-1.1.x") or mbranch == "1.1.x":
        cref = "latest-1.1.x"
    elif mbranch == "1.0.x":
        cref = "latest-1.0.x"
    else:
        cref = "bugfix-2.1.x"

    if len(sys.argv) > 1:
        arg = sys.argv[1]
        if ':' in arg:
            part1, part2 = arg.split(':', 1)
            config_path = part2
            cref = part1
        else:
            config_path = arg
        config_path = 'examples/'+config_path
    else:
        config_path = "default"

    try:
        subprocess.run(['restore_configs'], check=True)
    except FileNotFoundError:
        try:
            subprocess.run(['./buildroot/bin/restore_configs'], check=True)
        except FileNotFoundError:
            print("restore_configs not found, skipping.")

    fetch_configs(cref, config_path)

if __name__ == "__main__":
    main()