host_check.py

# -------------------------------------------------------------------------
#
#  Part of the CodeChecker project, under the Apache License v2.0 with
#  LLVM Exceptions. See LICENSE for license information.
#  SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#
# -------------------------------------------------------------------------
"""
Check host machine for a compile command logger.
"""


import errno
import glob
import os
import subprocess

from codechecker_common.logger import get_logger

LOG = get_logger('system')


def check_intercept(env) -> bool:
    """
    Simple check if intercept (scan-build-py) is available.
    """
    intercept_cmd = ['intercept-build', '--help']
    try:
        res = subprocess.check_call(
            intercept_cmd,
            env=env,
            stdout=subprocess.DEVNULL,
            stderr=subprocess.DEVNULL,
            encoding="utf-8",
            errors="ignore")  # type: ignore

        if not res:
            return True

        LOG.debug('Failed to run: "%s"', ' '.join(intercept_cmd))
        return False
    except subprocess.CalledProcessError:
        LOG.debug('Failed to run: "%s", process returned non-zero exit code.',
                  ' '.join(intercept_cmd))
        return False
    except OSError as oerr:
        if oerr.errno == errno.ENOENT:
            # Not just intercept-build can be used for logging.
            # It is possible that another build logger is available.
            LOG.debug(oerr)
            LOG.debug('Failed to run: "%s"', ' '.join(intercept_cmd))
        return False


def check_ldlogger(env) -> bool:
    """
    Simple check if ldlogger is available.
    """

    data_files_dir_path = env.get('CC_DATA_FILES_DIR', '')
    lib_dir_path = env.get('CC_LIB_DIR', '')

    if not data_files_dir_path and not lib_dir_path:
        LOG.debug('Both CC_DATA_FILES_DIR and CC_LIB_DIR environment '
                  'variables as undefined or empty in '
                  'the logger environment.')
        return False

    logger_lib_dir_path = os.path.join(
        data_files_dir_path, 'ld_logger', 'lib', '**', 'ldlogger.so')
    if glob.glob(logger_lib_dir_path, recursive=True):
        return True

    alternative_logger_lib_dir_path = os.path.join(
        lib_dir_path, 'codechecker_analyzer', 'ld_logger', 'lib', '**',
        'ldlogger.so')
    return bool(glob.glob(alternative_logger_lib_dir_path, recursive=True))