esp-idf/tools/ci/ci_get_mr_info.py

#!/usr/bin/env python
#
# internal use only for CI
# get latest MR information by source branch
#
# SPDX-FileCopyrightText: 2020-2024 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: Apache-2.0
#
import argparse
import logging
import os
import subprocess
import typing as t
from pathlib import Path

from gitlab_api import Gitlab
from idf_ci_utils import IDF_PATH

if t.TYPE_CHECKING:
    from gitlab.v4.objects import ProjectCommit, ProjectMergeRequest


def _get_mr_obj(source_branch: str) -> t.Optional['ProjectMergeRequest']:
    gl = Gitlab(os.getenv('CI_PROJECT_ID', 'espressif/esp-idf'))
    if not gl.project:
        return None

    mrs = gl.project.mergerequests.list(state='opened', source_branch=source_branch)
    if mrs:
        return mrs[0]  # one source branch can only have one opened MR at one moment
    else:
        return None


def get_mr_iid(source_branch: str) -> str:
    mr = _get_mr_obj(source_branch)
    if not mr:
        return ''
    else:
        return str(mr.iid)


def get_mr_changed_files(source_branch: str) -> t.List[str]:
    mr = _get_mr_obj(source_branch)
    if not mr:
        return []

    git_output = subprocess.check_output(
        ['git', 'diff', '--name-only', '--diff-filter=d', f'origin/{mr.target_branch}...origin/{source_branch}']
    ).decode('utf8')

    return [line.strip() for line in git_output.splitlines() if line.strip()]


def get_mr_commits(source_branch: str) -> t.List['ProjectCommit']:
    mr = _get_mr_obj(source_branch)
    if not mr:
        return []

    return list(mr.commits())


_COMPONENT_NAME_DIR_RECORDS = {}


def get_modified_component(filepath: str) -> t.Optional[str]:
    """Return the component name if the file is in a component directory, otherwise None."""
    try:
        f_path = Path(filepath).resolve().relative_to(IDF_PATH)
    except ValueError:  # not in IDF_PATH
        return None

    # skip md files, etc.
    if f_path.suffix in ['.md', '.yml']:
        return None

    # skip test_apps files
    if 'test_apps' in f_path.parts:
        return None

    component_parent_dirs = [f_path.parts[0]]
    for part in f_path.parts[1:]:
        if component_parent_dirs[-1] == 'components' or component_parent_dirs[-1].endswith('common_components'):
            if part not in _COMPONENT_NAME_DIR_RECORDS:
                logging.debug('Found component "%s" in path "%s"' % (part, component_parent_dirs))
                _COMPONENT_NAME_DIR_RECORDS[part] = component_parent_dirs
            elif _COMPONENT_NAME_DIR_RECORDS.get(part) != component_parent_dirs:
                logging.debug(
                    'WARNING!!! Found component "%s" in path "%s" and "%s"'
                    % (part, component_parent_dirs, _COMPONENT_NAME_DIR_RECORDS.get(part))
                )

            return part

        component_parent_dirs.append(part)

    return None


def get_mr_components(
    source_branch: t.Optional[str] = None, modified_files: t.Optional[t.List[str]] = None
) -> t.List[str]:
    components: t.Set[str] = set()
    if modified_files is None:
        if not source_branch:
            raise RuntimeError('--src-branch is required if --modified-files is not provided')

        modified_files = get_mr_changed_files(source_branch)

    for f in modified_files:
        modified_component = get_modified_component(f)
        if modified_component:
            components.add(modified_component)

    return list(components)


def get_target_in_tags(tags: str) -> str:
    from idf_pytest.constants import TARGET_MARKERS

    for x in tags.split(','):
        if x in TARGET_MARKERS:
            return x

    raise RuntimeError(f'No target marker found in {tags}')


def _print_list(_list: t.List[str], separator: str = '\n') -> None:
    print(separator.join(_list))


if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Get the latest merge request info by pipeline')
    actions = parser.add_subparsers(dest='action', help='info type', required=True)

    common_args = argparse.ArgumentParser(add_help=False)
    common_args.add_argument('--src-branch', help='source branch')
    common_args.add_argument(
        '--modified-files',
        nargs='+',
        help='space-separated list specifies the modified files. will be detected by --src-branch if not provided',
    )

    actions.add_parser('id', parents=[common_args])
    actions.add_parser('commits', parents=[common_args])
    actions.add_parser('components', parents=[common_args])
    target = actions.add_parser('target_in_tags')
    target.add_argument('tags', help='comma separated tags, e.g., esp32,generic')

    args = parser.parse_args()

    if args.action == 'id':
        if not args.src_branch:
            raise RuntimeError('--src-branch is required')
        print(get_mr_iid(args.src_branch))
    elif args.action == 'commits':
        if not args.src_branch:
            raise RuntimeError('--src-branch is required')
        _print_list([commit.id for commit in get_mr_commits(args.src_branch)])
    elif args.action == 'components':
        _print_list(get_mr_components(args.src_branch, args.modified_files))
    elif args.action == 'target_in_tags':
        print(get_target_in_tags(args.tags))
    else:
        raise NotImplementedError('not possible to get here')