CodeAnalysis/client/node/common/cmdarg.py at ebc8a501d5f2ab2b36eb1e2b693e3c286739304c · cyw3/CodeAnalysis · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# -*- encoding: utf-8 -*-
# Copyright (c) 2021-2025 Tencent
#
# This source code file is made available under MIT License
# See LICENSE for details
# ==============================================================================

""" 命令行参数解析类
"""

import argparse
import logging

from node.app import settings

logger = logging.getLogger(__name__)


class CmdArgParser(object):
    """
    命令行参数解析
    """
    @staticmethod
    def parse_args():
        """解析命令行参数

        :return:
        """
        argparser = argparse.ArgumentParser(add_help=True)
        argparser.add_argument('-v', '--version', action='version',
                               version=f"CodeAnalysis Version {settings.VERSION}({settings.EDITION.name} Beta)",
                               help="显示版本号")
        argparser.add_argument("-l", "--log-file", dest='log_file', help="指定log文件路径")
        subparsers = argparser.add_subparsers(dest='command', help="Commands")

        # localscan命令
        localscan_parser = subparsers.add_parser('localscan', help="执行本地项目扫描")
        localscan_parser.add_argument("-t", "--token", dest='token', type=str, help="个人Token,在代码分析网站获取")
        localscan_parser.add_argument("--org-sid", dest="org_sid", help="团队编号,在代码分析网站获取")
        localscan_parser.add_argument("--team-name", dest="team_name", help="项目名称,在代码分析网站获取")
        localscan_parser.add_argument("-s", "--source-dir", dest="source_dir", type=str, help="本地代码目录")
        localscan_parser.add_argument("--total", dest="total_scan", action="store_true",
                                      help="指定本次为全量扫描,不指定该参数时默认为增量扫描")
        localscan_parser.add_argument("--language", dest="language", type=str, help="代码语言类型,可以指定多门语言,用英文逗号(,)分隔")
        localscan_parser.add_argument("--scan-plan", dest="scan_plan", type=str,
                                      help="扫描方案名称,如果当前代码库已存在该名称的方案,直接使用;否则会新建该名称的方案")
        localscan_parser.add_argument("--ref-scheme-id", dest="ref_scheme_id", type=int,
                                      help="参照扫描方案ID,新建项目时复制指定ID的扫描方案使用,达到多个代码仓库使用相同的扫描方案的效果")
        localscan_parser.add_argument("--branch", dest="branch", type=str, help="指定本地扫描的git代码库分支名称")
        localscan_parser.add_argument("--scan-path", dest="scan_path", type=str,
                                      help="填写子目录的相对路径，指定某个子目录作为当前项目的扫描目录，适用于大仓场景，只针对某个业务目录进行扫描。默认扫描整个代码仓库")
        localscan_parser.add_argument("--exclude", dest="exclude_paths", type=str,
                                      help="需要过滤的目录或文件(相对路径),多个路径用英文逗号(,)分隔,路径格式遵循python fnmatch语法")
        localscan_parser.add_argument("--compare-branch", dest="compare_branch", type=str,
                                      help="对比分支,过滤掉从对比分支引入的历史代码问题，用于MR场景，一般设置为MR目标分支")
        localscan_parser.add_argument("--include", dest="include_paths", type=str,
                                      help="指定只扫描的目录或文件(相对路径),多个路径用英文逗号(,)分隔,路径格式遵循python fnmatch语法")
        localscan_parser.add_argument("--pre-cmd", dest="pre_cmd", type=str, help="前置命令(需要前置操作时使用)")
        localscan_parser.add_argument("--build-cmd", dest="build_cmd", type=str, help="编译命令(扫描编译型语言时使用)")
        localscan_parser.add_argument("--username", dest="username", type=str, help="代码库用户名")
        localscan_parser.add_argument("--password", dest="password", type=str, help="代码库密码")
        localscan_parser.add_argument("--ssh", dest="ssh_file", type=str, help="ssh私钥文件路径")
        localscan_parser.add_argument("-c", "--config-file", dest='config_file', type=str, help="项目配置文件")
        localscan_parser.add_argument("--report", dest="report_file", type=str,
                                      help="指定输出扫描结果简报的文件路径(json格式),默认输出在软件工作目录下的scan_status.json文件")
        localscan_parser.add_argument("--server", dest="server_url", type=str, help="指定连接的服务器url")
        localscan_parser.add_argument("--start-type", dest='start_type', type=str, help="启动方式,可选值：CI，分别表示CI场景")

        # updatetool命令
        updatetool_parser = subparsers.add_parser('updatetool', help="拉取工具")
        updatetool_parser.add_argument('-t', '--tool', dest='tool', type=str, help="更新指定工具,可以指定多个工具,用英文逗号(,)分隔")
        updatetool_parser.add_argument('-a', '--all', dest='all_tools', action="store_true", help="更新全量工具")
        updatetool_parser.add_argument('-o', '--os', dest='os_type', type=str, choices=['mac', 'linux', 'windows'],
                                       help="拉取指定操作系统下的工具")

        # start命令
        start_parser = subparsers.add_parser('start', help="启动节点")
        start_parser.add_argument("-t", "--token", dest='token', type=str, help="个人token,在代码分析网站获取", required=True)
        start_parser.add_argument("--org-sid", dest="org_sid", help="团队编号,在代码分析网站获取。指定注册为团队的节点，不指定则为公共节点")
        start_parser.add_argument("--tag", dest="tag", help="机器标签")
        start_parser.add_argument("--create-from", dest="create_from", type=str, help="客户端节点启动渠道")

        # quickscan命令
        quickscan_parser = subparsers.add_parser('quickscan', help="执行快速分析")
        quickscan_parser.add_argument("-s", "--source-dir", dest="source_dir", type=str, help="本地代码目录", required=True)
        quickscan_parser.add_argument("--file", dest="file", type=str,
                                      help="指定文件扫描，格式为基于source_dir的相对路径，多个文件用英文逗号(,)分隔")
        quickscan_parser.add_argument("-l", "--label", dest="label", type=str,
                                      help="规则标签，可以指定多个标签,用英文逗号(,)分隔")
        quickscan_parser.add_argument("--language", dest="language", type=str, help="代码语言类型,可以指定多门语言,用英文逗号(,)分隔")
        quickscan_parser.add_argument("-t", "--token", dest='token', type=str,
                                      help="个人Token,在代码分析网站获取, 与--scheme-template-id,--org-sid配合使用")
        quickscan_parser.add_argument("--scheme-template-id", dest="scheme_template_id", type=str,
                                      help="分析方案模板id, 与--token,--org-sid配合使用")
        quickscan_parser.add_argument("--org-sid", dest="org_sid", help="团队编号,在代码分析网站获取,"
                                                                        "与--scheme-template-id,--token配合使用")

        # quickinit命令
        quickinit_parser = subparsers.add_parser('quickinit', help="初始化快速分析")
        quickinit_parser.add_argument("-l", "--label", dest="label", type=str,
                                      help="规则标签，可以指定多个标签,用英文逗号(,)分隔")
        quickinit_parser.add_argument("--language", dest="language", type=str, help="代码语言类型,可以指定多门语言,用英文逗号(,)分隔")
        quickinit_parser.add_argument("-t", "--token", dest='token', type=str,
                                      help="个人Token,在代码分析网站获取, 与--scheme-template-id,--org-sid配合使用")
        quickinit_parser.add_argument("--scheme-template-id", dest="scheme_template_id", type=str,
                                      help="分析方案模板id, 与--token,--org-sid配合使用")
        quickinit_parser.add_argument("--org-sid", dest="org_sid", help="团队编号,在代码分析网站获取,"
                                                                        "与--scheme-template-id,--token配合使用")

        # task命令
        task_parser = subparsers.add_parser('task', help="执行单个任务，本地调试用")
        task_parser.add_argument(dest='request_file', type=str, help="任务参数json文件")

        # help
        subparsers.add_parser('help', help="显示帮助文档")

        return argparser.parse_args()

    @staticmethod
    def print_help():
        """
        输出帮助文档
        :return:
        """
        logger.info("请输入-h/--help参数，查看帮助文档。")