SonarQube在TCA上的集成指引

背景

TCA是腾讯推出的多语言静态代码分析平台，支持语言众多，开源，没有代码行限制、并发限制，并且支持多库和负载均衡。

SonarQube是业界知名的多语言代码分析平台，支持语言也很多，也开源。但是相比TCA来说，任务并发数小和不支持多库。

TCA支持集成其他工具作为插件。可以在TCA上集成SonarQube的能力整合使用。

依赖

Github开源社区有热心网友提供好了SonarQube的TCA工具插件，可以下载直接集成使用。

https://github.com/GabrielLegend/tca_plugin_sonarqube?tab=readme-ov-file

https://github.com/GabrielLegend/tca_plugin_sonarqube_10.6.0.92116

快速启动

1. 安装部署好TCA；
2. 下载这个tca_plugin_sonarqube工具插件项目；
3. 在TCA 服务器上加载tca_plugin_sonarqube/config目录中规则JSON文件；
4. 在TCA Server上的节点管理页面，为机器节点配置SonarQube工具进程；
5. 在TCA Server上创建相应的TCA项目，并将SonarQube规则添加到分析方案中，就可以开始分析。

选项

Java 无构建模式

需要事先启动 tca_plugin_sonarqube/tools/common/sonarqube-8.9.8.54436 目录下的SonarQube服务，为该服务安装 sonar-java-plugin-5.14.0.18788.jar 插件，然后关闭该服务。

SonarQube 需要 NodeJs 环境

对于 javascript/typescript/css 等语言，SonarQube 需要 Node.js 环境：

export PATH=${NODE_HOME}/bin:${PATH}

模式

本项目分为两种运行模式，LOCAL模式和COMMON模式，默认本地模式。

● LOCAL模式

本地启动SonarQube服务，然后执行分析任务。

● COMMON模式

支持连接远程 SonarQube 服务。

1、在 tca_plugin_sonarqube/src/settings.py 文件中，配置SQ_COMMON_USER

2、在TCA项目的分析方案中设置环境变量：

export SQ_TYPE=COMMON

3、然后开始任务

升级SonarQube版本

1. 下载对应版本的SonarQube包并解压到tools/common目录下
2. 将tca_plugin_sonarqube/tools/common/sonarqube-8.9.8.54436/bin/run.sh文件复制到解压后的SonarQube包的bin目录下
3. 修改tca_plugin_sonarqube/src/util/sq.py第99行上的工具位置

更改SonarQube账户和密码

不建议使用SonarQube默认密码，因此在成功执行本项目后，建议修改SonarQube密码：

1. 启动SonarQube，在SonarQube页面修改密码，并获取相应的token
2. 在tca_plugin_sonarqube/src/settings.py文件中，修改SQ_LOCAL_USER和SQ_COMMON_USER对应的username字段为对应的token，password字段设置为""空字符串