Tactility/ExternalApps/HelloWorld/tactility.py

import configparser
import json
import os
import re
import shutil
import sys
import subprocess
import time
import urllib.request
import zipfile

esp_platforms = ["esp32", "esp32s3"]
ttbuild_path = ".tactility"
ttbuild_version = "0.1.0"
ttbuild_properties_file = "tactility.properties"
ttbuild_cdn = "https://cdn.tactility.one"
ttbuild_sdk_json_validity = 3600  # seconds
verbose = False

spinner_pattern = [
    "⠋",
    "⠙",
    "⠹",
    "⠸",
    "⠼",
    "⠴",
    "⠦",
    "⠧",
    "⠇",
    "⠏"
]

if sys.platform == "win32":
    shell_color_red = ""
    shell_color_orange = ""
    shell_color_green = ""
    shell_color_purple = ""
    shell_color_cyan = ""
    shell_color_reset = ""
else:
    shell_color_red = "\033[91m"
    shell_color_orange = "\033[93m"
    shell_color_green = "\033[32m"
    shell_color_purple = "\033[35m"
    shell_color_cyan = "\033[36m"
    shell_color_reset = "\033[m"

def print_help():
    print("Usage: python tactility.py [action] [options]")
    print("")
    print("Actions:")
    print("  build [esp32,esp32s3,all]   Build the app for 1 or more platforms")
    print("  clean                       Clean the build folders")
    print("  clearcache                  Clear the SDK cache")
    print("  updateself                  Update this tool")
    print("")
    print("Options:")
    print("  --help                      Show this commandline info")
    print("  --skip-build                Run everything except the idf.py/CMake commands")
    print("  --verbose                   Show extra console output")

def download_file(url, filepath):
    global verbose
    if verbose:
        print(f"Downloading from {url} to {filepath}")
    request = urllib.request.Request(
        url,
        data=None,
        headers={
            "User-Agent": f"Tactility Build Tool {ttbuild_version}"
        }
    )
    try:
        response = urllib.request.urlopen(request)
        file = open(filepath, mode="wb")
        file.write(response.read())
        file.close()
        return True
    except OSError as error:
        if verbose:
            print_error(f"Failed to fetch URL {url}\n{error}")
        return False

def print_warning(message):
    print(f"{shell_color_orange}WARNING: {message}{shell_color_reset}")

def print_error(message):
    print(f"{shell_color_red}ERROR: {message}{shell_color_reset}")

def exit_with_error(message):
    print_error(message)
    sys.exit(1)

def is_valid_platform_name(name):
    return name == "all" or name == "esp32" or name == "esp32s3"

def validate_environment():
    global ttbuild_properties_file
    if os.environ.get("IDF_PATH") is None:
        exit_with_error("IDF is not installed or activated. Ensure you installed the toolset and ran the export command.")
    if os.environ.get("TACTILITY_SDK_PATH") is not None:
        print_warning("TACTILITY_SDK_PATH is set, but will be ignored by this command")
    if not os.path.exists(ttbuild_properties_file):
        exit_with_error(f"{ttbuild_properties_file} file not found")

def setup_environment():
    global ttbuild_path
    os.makedirs(ttbuild_path, exist_ok=True)

def get_sdk_dir(version, platform):
    global ttbuild_cdn
    return os.path.join(ttbuild_path, f"{version}-{platform}", "TactilitySDK")

def get_sdk_version():
    global ttbuild_properties_file
    parser = configparser.RawConfigParser()
    parser.read(ttbuild_properties_file)
    sdk_dict = dict(parser.items("sdk"))
    if not "version" in sdk_dict:
        exit_with_error(f"Could not find 'version' in [sdk] section in {ttbuild_properties_file}")
    return sdk_dict["version"]

def get_sdk_root_dir(version, platform):
    global ttbuild_cdn
    return os.path.join(ttbuild_path, f"{version}-{platform}")

def get_sdk_url(version, platform):
    global ttbuild_cdn
    return f"{ttbuild_cdn}/TactilitySDK-{version}-{platform}.zip"

def sdk_exists(version, platform):
    sdk_dir = get_sdk_dir(version, platform)
    return os.path.isdir(sdk_dir)

def should_update_sdk_json():
    global ttbuild_cdn
    json_filepath = os.path.join(ttbuild_path, "sdk.json")
    if os.path.exists(json_filepath):
        json_modification_time = os.path.getmtime(json_filepath)
        now = time.time()
        global ttbuild_sdk_json_validity
        minimum_seconds_difference = ttbuild_sdk_json_validity
        return (now - json_modification_time) > minimum_seconds_difference
    else:
        return True

def update_sdk_json():
    global ttbuild_cdn, ttbuild_path
    json_url = f"{ttbuild_cdn}/sdk.json"
    json_filepath = os.path.join(ttbuild_path, "sdk.json")
    return download_file(json_url, json_filepath)

def should_fetch_sdkconfig_files():
    for platform in esp_platforms:
        sdkconfig_filename = f"sdkconfig.app.{platform}"
        if not os.path.exists(os.path.join(ttbuild_path, sdkconfig_filename)):
            return True
    return False

def fetch_sdkconfig_files():
    for platform in esp_platforms:
        sdkconfig_filename = f"sdkconfig.app.{platform}"
        target_path = os.path.join(ttbuild_path, sdkconfig_filename)
        if not download_file(f"{ttbuild_cdn}/{sdkconfig_filename}", target_path):
            exit_with_error(f"Failed to download sdkconfig file for {platform}")


def validate_version_and_platforms(sdk_json, sdk_version, platforms_to_build):
    version_map = sdk_json["versions"]
    if not sdk_version in version_map:
        exit_with_error(f"Version not found: {sdk_version}")
    version_data = version_map[sdk_version]
    available_platforms = version_data["platforms"]
    for desired_platform in platforms_to_build:
        if not desired_platform in available_platforms:
            exit_with_error(f"Platform {desired_platform} is not available. Available ones: {available_platforms}")

def validate_self(sdk_json):
    if not "toolVersion" in sdk_json:
        exit_with_error("Server returned invalid SDK data format (toolVersion not found)")
    if not "toolCompatibility" in sdk_json:
        exit_with_error("Server returned invalid SDK data format (toolCompatibility not found)")
    if not "toolDownloadUrl" in sdk_json:
        exit_with_error("Server returned invalid SDK data format (toolDownloadUrl not found)")
    tool_version = sdk_json["toolVersion"]
    tool_compatibility = sdk_json["toolCompatibility"]
    if tool_version != ttbuild_version:
        print_warning(f"New version available: {tool_version} (currently using {ttbuild_version})")
        print_warning(f"Run 'tactility.py updateself' to update.")
    if re.search(tool_compatibility, ttbuild_version) is None:
        print_error("The tool is not compatible anymore.")
        print_error("Run 'tactility.py updateself' to update.")
        sys.exit()

def sdk_download(version, platform):
    sdk_root_dir = get_sdk_root_dir(version, platform)
    os.makedirs(sdk_root_dir, exist_ok=True)
    sdk_url = get_sdk_url(version, platform)
    filepath = os.path.join(sdk_root_dir, f"{version}-{platform}.zip")
    print(f"Downloading SDK version {version} for {platform}")
    if download_file(sdk_url, filepath):
        with zipfile.ZipFile(filepath, "r") as zip_ref:
            zip_ref.extractall(sdk_root_dir)
        return True
    else:
        return False

def sdk_download_all(version, platforms):
    for platform in platforms:
        if not sdk_exists(version, platform):
            if not sdk_download(version, platform):
                return False
        else:
            if verbose:
                print(f"Using cached download for SDK version {version} and platform {platform}")
    return True

def find_elf_file(platform):
    build_dir = f"build-{platform}"
    if os.path.exists(build_dir):
        for file in os.listdir(build_dir):
            if file.endswith(".app.elf"):
                return os.path.join(build_dir, file)
    return None

def build_all(version, platforms, skip_build):
    for platform in platforms:
        # First build command must be "idf.py build", otherwise it fails to execute "idf.py elf"
        # We check if the ELF file exists and run the correct command
        # This can lead to code caching issues, so sometimes a clean build is required
        if find_elf_file(platform) is None:
            if not build_first(version, platform, skip_build):
                break
        else:
            if not build_consecutively(version, platform, skip_build):
                break

def wait_for_build(process, platform):
    buffer = []
    os.set_blocking(process.stdout.fileno(), False)
    while process.poll() is None:
        for i in spinner_pattern:
            time.sleep(0.1)
            progress_text = f"Building for {platform} {shell_color_cyan}" + str(i) + shell_color_reset
            sys.stdout.write(progress_text + "\r")
            while True:
                line = process.stdout.readline()
                decoded_line = line.decode("UTF-8")
                if decoded_line != "":
                    buffer.append(decoded_line)
                else:
                    break
    return buffer

# The first build must call "idf.py build" and consecutive builds must call "idf.py elf" as it finishes faster.
# The problem is that the "idf.py build" always results in an error, even though the elf file is created.
# The solution is to suppress the error if we find that the elf file was created.
def build_first(version, platform, skip_build):
    sdk_dir = get_sdk_dir(version, platform)
    if verbose:
        print(f"Using SDK at {sdk_dir}")
    os.environ["TACTILITY_SDK_PATH"] = sdk_dir
    sdkconfig_path = os.path.join(ttbuild_path, f"sdkconfig.app.{platform}")
    os.system(f"cp {sdkconfig_path} sdkconfig")
    elf_path = find_elf_file(platform)
    # Remove previous elf file: re-creation of the file is used to measure if the build succeeded,
    # as the actual build job will always fail due to technical issues with the elf cmake script
    if elf_path is not None:
        os.remove(elf_path)
    if skip_build:
        return True
    print("Building first build")
    with subprocess.Popen(["idf.py", "-B", f"build-{platform}", "build"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT) as process:
        build_output = wait_for_build(process, platform)
        # The return code is never expected to be 0 due to a bug in the elf cmake script, but we keep it just in case
        if process.returncode == 0:
            print(f"{shell_color_green}Building for {platform} ✅{shell_color_reset}")
            return True
        else:
            if find_elf_file(platform) is None:
                for line in build_output:
                    print(line, end="")
                print(f"{shell_color_red}Building for {platform} failed ❌{shell_color_reset}")
                return False
            else:
                print(f"{shell_color_green}Building for {platform} ✅{shell_color_reset}")
                return True

def build_consecutively(version, platform, skip_build):
    sdk_dir = get_sdk_dir(version, platform)
    if verbose:
        print(f"Using SDK at {sdk_dir}")
    os.environ["TACTILITY_SDK_PATH"] = sdk_dir
    sdkconfig_path = os.path.join(ttbuild_path, f"sdkconfig.app.{platform}")
    os.system(f"cp {sdkconfig_path} sdkconfig")
    if skip_build:
        return True
    with subprocess.Popen(["idf.py", "-B", f"build-{platform}", "elf"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT) as process:
        build_output = wait_for_build(process, platform)
        if process.returncode == 0:
            print(f"{shell_color_green}Building for {platform} ✅{shell_color_reset}")
            return True
        else:
            for line in build_output:
                print(line, end="")
            print(f"{shell_color_red}Building for {platform} failed ❌{shell_color_reset}")
            return False

def read_sdk_json():
    json_file_path = os.path.join(ttbuild_path, "sdk.json")
    json_file = open(json_file_path)
    return json.load(json_file)

def build_action(platform_arg):
    # Environment validation
    validate_environment()
    # Environment setup
    setup_environment()
    if not is_valid_platform_name(platform_arg):
        print_help()
        exit_with_error("Invalid platform name")
    if should_fetch_sdkconfig_files():
        fetch_sdkconfig_files()
    # Update SDK cache
    if should_update_sdk_json() and not update_sdk_json():
        exit_with_error("Failed to retrieve SDK info")
    sdk_json = read_sdk_json()
    validate_self(sdk_json)
    if not "versions" in sdk_json:
        exit_with_error("Version data not found in sdk.json")
    # Build
    platforms_to_build = esp_platforms if platform_arg == "all" else [platform_arg]
    sdk_version = get_sdk_version()
    validate_version_and_platforms(sdk_json, sdk_version, platforms_to_build)
    if not sdk_download_all(sdk_version, platforms_to_build):
        exit_with_error("Failed to download one or more SDKs")
    build_all(sdk_version, platforms_to_build, skip_build)    # Environment validation

def clean_action():
    count = 0
    for path in os.listdir("."):
        if path.startswith("build-"):
            print(f"Removing {path}/")
            shutil.rmtree(path)
            count = count + 1
    if count == 0:
        print("Nothing to clean")

def clear_cache_action():
    if os.path.exists(ttbuild_path):
        print(f"Removing {ttbuild_path}/")
        shutil.rmtree(ttbuild_path)
    else:
        print("Nothing to clear")

def update_self_action():
    sdk_json = read_sdk_json()
    tool_download_url = sdk_json["toolDownloadUrl"]
    if download_file(tool_download_url, "tactility.py"):
        print("Updated")
    else:
        exit_with_error("Update failed")

if __name__ == "__main__":
    print(f"Tactility Build System v{ttbuild_version}")
    if "--help" in sys.argv:
        print_help()
        sys.exit()
    # Argument validation
    if len(sys.argv) == 1:
        print_help()
        sys.exit()
    action_arg = sys.argv[1]
    verbose = "--verbose" in sys.argv
    skip_build = "--skip-build" in sys.argv
    # Actions
    if action_arg == "build":
        if len(sys.argv) < 3:
            print_help()
            sys.exit()
        else:
            platform_arg = sys.argv[2]
            build_action(platform_arg)
    elif action_arg == "clean":
        clean_action()
    elif action_arg == "clearcache":
        clear_cache_action()
    elif action_arg == "updateself":
        update_self_action()
    else:
        print_help()
        sys.exit()