esp-idf/tools/find_build_apps/cmake.py

import logging
import os
import shutil
import subprocess
import sys

from .common import BuildError, BuildItem, BuildSystem

try:
    from typing import Any, Optional
except ImportError:
    pass

BUILD_SYSTEM_CMAKE = 'cmake'
IDF_PY = os.path.join(os.environ['IDF_PATH'], 'tools', 'idf.py')

# While ESP-IDF component CMakeLists files can be identified by the presence of 'idf_component_register' string,
# there is no equivalent for the project CMakeLists files. This seems to be the best option...
CMAKE_PROJECT_LINE = r'include($ENV{IDF_PATH}/tools/cmake/project.cmake)'


class CMakeBuildSystem(BuildSystem):
    NAME = BUILD_SYSTEM_CMAKE

    @classmethod
    def build(cls, build_item):  # type: (BuildItem) -> None
        build_path, work_path, extra_cmakecache_items = cls.build_prepare(build_item)
        # Prepare the build arguments
        args = [
            sys.executable,
            IDF_PY,
            '-B',
            build_path,
            '-C',
            work_path,
            '-DIDF_TARGET=' + build_item.target,
        ]
        if extra_cmakecache_items:
            for key, val in extra_cmakecache_items.items():
                args.append('-D{}={}'.format(key, val))
            if 'TEST_EXCLUDE_COMPONENTS' in extra_cmakecache_items \
                    and 'TEST_COMPONENTS' not in extra_cmakecache_items:
                args.append('-DTESTS_ALL=1')
        if build_item.verbose:
            args.append('-v')
        if 'CONFIG_APP_BUILD_BOOTLOADER' in extra_cmakecache_items:
            # In case if secure_boot is enabled then for bootloader build need to add `bootloader` cmd
            args.append('bootloader')
        args.append('build')
        cmdline = format(' '.join(args))
        logging.info('Running {}'.format(cmdline))

        if build_item.dry_run:
            return

        log_file = None
        build_stdout = sys.stdout
        build_stderr = sys.stderr
        if build_item.build_log_path:
            logging.info('Writing build log to {}'.format(build_item.build_log_path))
            log_file = open(build_item.build_log_path, 'w')
            build_stdout = log_file
            build_stderr = log_file

        try:
            subprocess.check_call(args, stdout=build_stdout, stderr=build_stderr)
        except subprocess.CalledProcessError as e:
            raise BuildError('Build failed with exit code {}'.format(e.returncode))
        else:
            # Also save the sdkconfig file in the build directory
            shutil.copyfile(
                os.path.join(work_path, 'sdkconfig'),
                os.path.join(build_path, 'sdkconfig'),
            )
            build_item.size_json_fp = build_item.get_size_json_fp()
        finally:
            if log_file:
                log_file.close()

    @staticmethod
    def _read_cmakelists(app_path):  # type: (str) -> Optional[str]
        cmakelists_path = os.path.join(app_path, 'CMakeLists.txt')
        if not os.path.exists(cmakelists_path):
            return None
        with open(cmakelists_path, 'r') as cmakelists_file:
            return cmakelists_file.read()

    @staticmethod
    def is_app(path):  # type: (str) -> bool
        cmakelists_file_content = CMakeBuildSystem._read_cmakelists(path)
        if not cmakelists_file_content:
            return False
        if CMAKE_PROJECT_LINE not in cmakelists_file_content:
            return False
        return True

    @classmethod
    def supported_targets(cls, app_path):  # type: (str) -> Any
        return cls._supported_targets(app_path)