Merge branch 'main' of https://github.com/yalechen-cyw/CodeAnalysis

Author: cyw3

client/task/initparams.cp37-win_amd64.pyd

@@ -262,12 +262,6 @@ def __init__(self, params, task_type, tool, inc_src):
             self.enable_lfs = True
 
     def load_source_dir(self):
-        """
-        1. 普通项目，正常拉代码正常使用缓存
-        2. 本地项目，传入本地代码路径
-        3. qci项目，传入本地项目，coverity等工具需要scm.clean
-        4. 本地项目，传项目ID的情况，没有传sourecedir，也是要拉代码的
-        """
         logger.info("start __checkout_source_dir.")
         if self.params["task_scene"] == TaskScene.LOCAL:
             if "source_dir" in self.params:

client/task/initparams.cpython-37m-aarch64-linux-gnu.so

@@ -144,4 +144,4 @@ def get_tool_version(self):
 
 
 if __name__ == '__main__':
-    print(TaskMgr.get_private_processes('coverity_java'))
+    pass

client/task/initparams.cpython-37m-darwin.so

@@ -109,7 +109,7 @@ def set_inc_source_path_list(self):
         '''
         用于设置该工具使用增量资源的缓存目录
         默认只增量缓存'source_dir'
-        coverity会需要缓存'source_dir','work_dir'
+        部分工具会需要缓存'source_dir','work_dir'
         :return: 需要缓存的目录名
         '''
         return ['source_dir']  # 考虑试用setting里面的字段
@@ -118,7 +118,7 @@ def set_inc_source_type(self):
         '''
         用于设置增量资源的类型，当不同工具需要使用同一个增量资源时直接默认使用Normal
         例如androidlint与findbugs可以复用
-        coverity会需要单独使用一个增量资源，因此单独创建一个类型出来
+        部分工具会需要单独使用一个增量资源，因此单独创建一个类型出来
         :return: 增量资源类型，一般直接使用工具名即可
         '''
         return 'normal'
@@ -156,7 +156,7 @@ def set_issue_ignore_type(self):
     def set_mid_source_path_list(self):
         '''
         区别于增量资源的管理，编译与分析task之间的数据传递也需要控制
-        例如：coverity编译后传递的是idir中的中间文件，但不排除某些工具需要编译过后的项目代码文件
+        例如：编译后传递的是idir中的中间文件，但不排除某些工具需要编译过后的项目代码文件
         因此这里暂时默认将workdir作为需要传递的中间文件
         :return:
         '''
@@ -173,7 +173,7 @@ def set_add_file_info(self):
     def set_tool_skip_condition(self, params):
         '''
         用于实现判断条件，跳过本次工具扫描。
-        适用场景：例如当coverity扫描前，判断项目变更内容中无代码文件
+        适用场景：例如当工具扫描前，判断项目变更内容中无代码文件
         :return:
         '''
         return False
@@ -196,9 +196,6 @@ def set_add_person_info(self):
     def check_tool_usable(self, tool_params):
         '''
         检查工具是否可以用，具体检查内容：
-        1. 工具执行所需哪些环节
-        2. 各环节中对环境变量的依赖与本地工具的依赖
-        3. 工具执行的必要条件，如coverity执行分析需要license文件
         注意：此部分只检查compile与analyze等工具所属的步骤，datahandle不属于此部分
         :return:支持该工具的task类型数组，若不支持返回空数组
         '''

client/task/initparams.cpython-37m-x86_64-linux-gnu.so

@@ -27,7 +27,8 @@ export const en: SidebarConfig = {
           children: [
             '/en/guide/代码检查/工具/eslint.md',
             '/en/guide/代码检查/工具/golangcilint.md',
-            '/eh/guide/代码检查/工具/regexscanner.md',
+            '/eh/guide/代码检查/工具/TCA-Armory-R.md',
+            '/eh/guide/代码检查/工具/TCA-Armory-C1.md',
           ],
         },
       ]

client/task/sourcemgr.py

@@ -27,7 +27,8 @@ export const zh: SidebarConfig = {
           children: [
             '/zh/guide/代码检查/工具/eslint.md',
             '/zh/guide/代码检查/工具/golangcilint.md',
-            '/zh/guide/代码检查/工具/regexscanner.md',
+            '/zh/guide/代码检查/工具/TCA-Armory-R.md',
+            '/zh/guide/代码检查/工具/TCA-Armory-C1.md',
           ],
         },
       ]

client/task/taskmgr.py

@@ -0,0 +1,34 @@
+# TCA-Armory-C1 使用手册
+
+TCA-Armory-C1 属于 TCA 的增强分析模块。
+
+## 功能
+- Objective-C/C++ 代码规范
+- C/C++/Java 代码安全
+
+## 准备
+- 需要事先部署好 [CLS 微服务](https://tencent.github.io/CodeAnalysis/zh/quickStarted/enhanceDeploy.html)
+
+## 规则
+|   规则    |   概览    | 参数 | 参数示例 |
+| :-------- | :------- | :------- | :------- |
+| ObjectiveC/Copyright | 检查代码文件的copyright信息 | 无 | 无 |
+| ObjectiveC/Indent | 检查代码文件的缩进 | IndentStyle: 可选 spaces 空格 和 tabs `\t` ，默认是 spaces <br> IndentSize: 缩进长度，默认是4 | IndentStyle=spaces <br> IndentSize=4 |
+| ObjectiveC/MaxLinesPerFunction | 检查超出行数长度阈值的函数 | LineThreshold: 方法长度阈值，默认是100 | LineThreshold=100 |
+| ObjectiveC/MissingDocInterface | 检查接口需要注释信息 | 无 | 无 |
+| ObjectiveC/MissingDocProperty | 检查属性是否有注释 | 无 | 无 |
+| ObjectiveC/MissingDocProtocol | 检查protocol是否有注释 | 无 | 无 |
+| ObjectiveC/ParameterCount | 检查方法的参数个数 | Max: 参数个数阈值，默认是6 | Max=6 |
+| ObjectiveC/ClassNaming | 检查class命名格式 | ClassCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 CamelCase ｜ ClassCase=CamelCase |
+| ObjectiveC/FunctionNaming | 检查函数命名格式 | FunctionCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | FunctionCase=camelBack |
+| ObjectiveC/GlobalVariableNaming | 检查全局变量的命名格式 | GlobalVariablePrefix: 全局变量前缀，默认是`g` <br> GlobalVariableCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | GlobalVariablePrefix=g <br> GlobalVariableCase=camelBack |
+| ObjectiveC/LocalVariableNaming | 检查局部变量的命名格式 | LocalVariableCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | LocalVariableCase=camelBack |
+| ObjectiveC/MacroNaming | 检查macro命名格式 | MacroCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 UPPER_CASE | MacroCase=UPPER_CASE |
+| ObjectiveC/MaxLineLength | 检查文件长度 | tabWidth: 缩进宽度，默认是4 <br> MaxLineLength: 长度阈值，默认是150 |  tabWidth=4 <br> MaxLineLength=150 |
+| ObjectiveC/MethodNaming | 检查方法命名格式 | MethodCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | MethodCase=camelBack |
+| ObjectiveC/ParameterNaming | 检查参数命名格式 | ParameterCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | ParameterCase=camelBack |
+| CmdInject | 命令行注入漏洞 | 无 | 无 |
+| PathTraversal | 路径穿越漏洞 | 无 | 无 |
+| SQLInject | SQL注入 | 无 | 无 |
+| SSRF | 服务端请求伪造漏洞 | 无 | 无 |
+| XSS | 跨站脚本攻击漏洞 | 无 | 无 |