ci: get_mr_info support components

tools/ci/ci_get_mr_info.py

@@ -10,22 +10,20 @@
 import argparse
 import os
 import subprocess
+import typing as t
+from pathlib import Path
 
 from gitlab_api import Gitlab
 
-try:
+if t.TYPE_CHECKING:
-    from typing import Any, Union
+    from gitlab.v4.objects import ProjectCommit, ProjectMergeRequest
-except ImportError:
-    # Only used for type annotations
-    pass
 
 
-def _get_mr_obj(source_branch):  # type: (str) -> Union[Gitlab, None]
+def _get_mr_obj(source_branch: str) -> t.Optional['ProjectMergeRequest']:
-    if not source_branch:
-        return None
     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
@@ -33,7 +31,7 @@ def _get_mr_obj(source_branch):  # type: (str) -> Union[Gitlab, None]
         return None
 
 
-def get_mr_iid(source_branch):  # type: (str) -> str
+def get_mr_iid(source_branch: str) -> str:
     mr = _get_mr_obj(source_branch)
     if not mr:
         return ''
@@ -41,40 +39,65 @@ def get_mr_iid(source_branch):  # type: (str) -> str
         return str(mr.iid)
 
 
-def get_mr_changed_files(source_branch):  # type: (str) -> Any
+def get_mr_changed_files(source_branch: str) -> t.List[str]:
     mr = _get_mr_obj(source_branch)
     if not mr:
-        return ''
+        return []
 
-    return subprocess.check_output(['git', 'diff', '--name-only',
+    git_output = subprocess.check_output(
-                                    'origin/{}...origin/{}'.format(mr.target_branch, source_branch)]).decode('utf8')
+        ['git', 'diff', '--name-only', 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):  # type: (str) -> str
+def get_mr_commits(source_branch: str) -> t.List['ProjectCommit']:
     mr = _get_mr_obj(source_branch)
     if not mr:
-        return ''
+        return []
-    return '\n'.join([commit.id for commit in mr.commits()])
+
+    return list(mr.commits())
+
+
+def get_mr_components(source_branch: str) -> t.List[str]:
+    components: t.Set[str] = set()
+    for f in get_mr_changed_files(source_branch):
+        file = Path(f)
+        if (
+            file.parts[0] == 'components'
+            and 'test_apps' not in file.parts
+            and file.parts[-1] != '.build-test-rules.yml'
+        ):
+            components.add(file.parts[1])
+
+    return list(components)
+
+
+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')
+    actions = parser.add_subparsers(dest='action', help='info type', required=True)
 
     common_args = argparse.ArgumentParser(add_help=False)
-    common_args.add_argument('src_branch', nargs='?', help='source branch')
+    common_args.add_argument('src_branch', help='source branch')
 
     actions.add_parser('id', parents=[common_args])
     actions.add_parser('files', parents=[common_args])
     actions.add_parser('commits', parents=[common_args])
+    actions.add_parser('components', parents=[common_args])
 
     args = parser.parse_args()
 
     if args.action == 'id':
         print(get_mr_iid(args.src_branch))
     elif args.action == 'files':
-        print(get_mr_changed_files(args.src_branch))
+        _print_list(get_mr_changed_files(args.src_branch))
     elif args.action == 'commits':
-        print(get_mr_commits(args.src_branch))
+        _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))
     else:
         raise NotImplementedError('not possible to get here')