esphome/script/helpers.py

import json
import os.path
from pathlib import Path
import re
import subprocess

import colorama

root_path = os.path.abspath(os.path.normpath(os.path.join(__file__, "..", "..")))
basepath = os.path.join(root_path, "esphome")
temp_folder = os.path.join(root_path, ".temp")
temp_header_file = os.path.join(temp_folder, "all-include.cpp")


def styled(color, msg, reset=True):
    prefix = "".join(color) if isinstance(color, tuple) else color
    suffix = colorama.Style.RESET_ALL if reset else ""
    return prefix + msg + suffix


def print_error_for_file(file, body):
    print(
        styled(colorama.Fore.GREEN, "### File ")
        + styled((colorama.Fore.GREEN, colorama.Style.BRIGHT), file)
    )
    print()
    if body is not None:
        print(body)
        print()


def build_all_include():
    # Build a cpp file that includes all header files in this repo.
    # Otherwise header-only integrations would not be tested by clang-tidy
    headers = []
    for path in walk_files(basepath):
        filetypes = (".h",)
        ext = os.path.splitext(path)[1]
        if ext in filetypes:
            path = os.path.relpath(path, root_path)
            include_p = path.replace(os.path.sep, "/")
            headers.append(f'#include "{include_p}"')
    headers.sort()
    headers.append("")
    content = "\n".join(headers)
    p = Path(temp_header_file)
    p.parent.mkdir(exist_ok=True)
    p.write_text(content, encoding="utf-8")


def walk_files(path):
    for root, _, files in os.walk(path):
        for name in files:
            yield os.path.join(root, name)


def get_output(*args):
    with subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE) as proc:
        output, _ = proc.communicate()
    return output.decode("utf-8")


def get_err(*args):
    with subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE) as proc:
        _, err = proc.communicate()
    return err.decode("utf-8")


def splitlines_no_ends(string):
    return [s.strip() for s in string.splitlines()]


def changed_files(branch="dev"):
    check_remotes = ["upstream", "origin"]
    check_remotes.extend(splitlines_no_ends(get_output("git", "remote")))
    for remote in check_remotes:
        command = ["git", "merge-base", f"refs/remotes/{remote}/{branch}", "HEAD"]
        try:
            merge_base = splitlines_no_ends(get_output(*command))[0]
            break
        # pylint: disable=bare-except
        except:  # noqa: E722
            pass
    else:
        raise ValueError("Git not configured")
    command = ["git", "diff", merge_base, "--name-only"]
    changed = splitlines_no_ends(get_output(*command))
    changed = [os.path.relpath(f, os.getcwd()) for f in changed]
    changed.sort()
    return changed


def filter_changed(files):
    changed = changed_files()
    files = [f for f in files if f in changed]
    print("Changed files:")
    if not files:
        print("    No changed files!")
    for c in files:
        print(f"    {c}")
    return files


def filter_grep(files, value):
    matched = []
    for file in files:
        with open(file, encoding="utf-8") as handle:
            contents = handle.read()
        if value in contents:
            matched.append(file)
    return matched


def git_ls_files(patterns=None):
    command = ["git", "ls-files", "-s"]
    if patterns is not None:
        command.extend(patterns)
    with subprocess.Popen(command, stdout=subprocess.PIPE) as proc:
        output, _ = proc.communicate()
    lines = [x.split() for x in output.decode("utf-8").splitlines()]
    return {s[3].strip(): int(s[0]) for s in lines}


def load_idedata(environment):
    platformio_ini = Path(root_path) / "platformio.ini"
    temp_idedata = Path(temp_folder) / f"idedata-{environment}.json"
    changed = False
    if not platformio_ini.is_file() or not temp_idedata.is_file():
        changed = True
    elif platformio_ini.stat().st_mtime >= temp_idedata.stat().st_mtime:
        changed = True

    if "idf" in environment:
        # remove full sdkconfig when the defaults have changed so that it is regenerated
        default_sdkconfig = Path(root_path) / "sdkconfig.defaults"
        temp_sdkconfig = Path(temp_folder) / f"sdkconfig-{environment}"

        if not temp_sdkconfig.is_file():
            changed = True
        elif default_sdkconfig.stat().st_mtime >= temp_sdkconfig.stat().st_mtime:
            temp_sdkconfig.unlink()
            changed = True

    if not changed:
        return json.loads(temp_idedata.read_text())

    # ensure temp directory exists before running pio, as it writes sdkconfig to it
    Path(temp_folder).mkdir(exist_ok=True)

    if "nrf" in environment:
        build_environment = environment.replace("-tidy", "")
        build_dir = Path(temp_folder) / f"build-{build_environment}"
        Path(build_dir).mkdir(exist_ok=True)
        Path(build_dir / "platformio.ini").write_text(
            Path(platformio_ini).read_text(encoding="utf-8"), encoding="utf-8"
        )
        esphome_dir = Path(build_dir / "esphome")
        esphome_dir.mkdir(exist_ok=True)
        Path(esphome_dir / "main.cpp").write_text(
            """
#include <zephyr/kernel.h>
int main() { return 0;}
""",
            encoding="utf-8",
        )
        zephyr_dir = Path(build_dir / "zephyr")
        zephyr_dir.mkdir(exist_ok=True)
        Path(zephyr_dir / "prj.conf").write_text("", encoding="utf-8")
        subprocess.run(
            ["pio", "run", "-e", build_environment, "-d", build_dir], check=False
        )

        def extract_include_paths(command):
            include_paths = []
            include_pattern = re.compile(r"(-I|-isystem)\s*([^\s]+)")
            for match in include_pattern.findall(command):
                include_paths.append(match[1])
            return include_paths

        def extract_defines(command):
            defines = []
            define_pattern = re.compile(r"-D\s*([^\s]+)")
            for match in define_pattern.findall(command):
                defines.append(match)
            return defines

        def find_cxx_path(commands):
            for entry in commands:
                command = entry["command"]
                cxx_path = command.split()[0]
                return cxx_path

        def get_builtin_include_paths(compiler):
            result = subprocess.run(
                [compiler, "-E", "-x", "c++", "-", "-v"],
                input="",
                text=True,
                stderr=subprocess.PIPE,
                check=False,
            )
            include_paths = []
            start_collecting = False
            for line in result.stderr.splitlines():
                if start_collecting:
                    if line.startswith(" "):
                        include_paths.append(line.strip())
                    else:
                        break
                if "#include <...> search starts here:" in line:
                    start_collecting = True
            return include_paths

        def extract_cxx_flags(command):
            flags = []
            # Extracts CXXFLAGS from the command string, excluding includes and defines.
            flag_pattern = re.compile(
                r"(-O[0-3s]|-g|-std=[^\s]+|-Wall|-Wextra|-Werror|--[^\s]+|-f[^\s]+|-m[^\s]+|-imacros\s*[^\s]+)"
            )
            for match in flag_pattern.findall(command):
                flags.append(match)
            return flags

        def transform_to_idedata_format(compile_commands):
            cxx_path = find_cxx_path(compile_commands)
            idedata = {
                "includes": {
                    "toolchain": get_builtin_include_paths(cxx_path),
                    "build": set(),
                },
                "defines": set(),
                "cxx_path": cxx_path,
                "cxx_flags": set(),
            }

            for entry in compile_commands:
                command = entry["command"]

                idedata["includes"]["build"].update(extract_include_paths(command))
                idedata["defines"].update(extract_defines(command))
                idedata["cxx_flags"].update(extract_cxx_flags(command))

            # Convert sets to lists for JSON serialization
            idedata["includes"]["build"] = list(idedata["includes"]["build"])
            idedata["defines"] = list(idedata["defines"])
            idedata["cxx_flags"] = list(idedata["cxx_flags"])

            return idedata

        compile_commands = json.loads(
            Path(
                build_dir
                / ".pio"
                / "build"
                / build_environment
                / "compile_commands.json"
            ).read_text(encoding="utf-8")
        )
        data = transform_to_idedata_format(compile_commands)
    else:
        stdout = subprocess.check_output(
            ["pio", "run", "-t", "idedata", "-e", environment]
        )
        match = re.search(r'{\s*".*}', stdout.decode("utf-8"))
        data = json.loads(match.group())
    temp_idedata.write_text(json.dumps(data, indent=2) + "\n")
    return data


def get_binary(name: str, version: str) -> str:
    binary_file = f"{name}-{version}"
    try:
        # If no exception was raised, the command was successful
        result = subprocess.check_output(
            [binary_file, "-version"], stderr=subprocess.STDOUT
        )
        return binary_file
    except FileNotFoundError:
        pass
    binary_file = name
    try:
        result = subprocess.run(
            [binary_file, "-version"], text=True, capture_output=True, check=False
        )
        if result.returncode == 0 and (f"version {version}") in result.stdout:
            return binary_file
        raise FileNotFoundError(f"{name} not found")

    except FileNotFoundError:
        print(
            f"""
            Oops. It looks like {name} is not installed. It should be available under venv/bin
            and in PATH after running in turn:
              script/setup
              source venv/bin/activate.

            Please confirm you can run "{name} -version" or "{name}-{version} -version"
            in your terminal and install
            {name} (v{version}) if necessary.

            Note you can also upload your code as a pull request on GitHub and see the CI check
            output to apply {name}
            """
        )
        raise