Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

完善Jenkins文档 #1153

Merged
merged 16 commits into from
Jul 30, 2024
Merged

完善Jenkins文档 #1153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
40f00b0
完善Jenkins文档
zhuay-a Jul 29, 2024
f75cfbf
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
cb0234d
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
f9764fb
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
60de1cb
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
5e74d7e
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
fd1aa85
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
e69d95a
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
c7ef490
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
81aa38c
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
41d9c2b
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
a41b678
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
1e51f5b
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
5a5eff2
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
053a00b
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
772221a
Update Jenkins_Plugin.md
zhuay-a Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 67 additions & 9 deletions doc/en/guide/插件/Jenkins_Plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@
### 获取Jenkins插件
Jenkins插件有以下两种获取方式：

**方式一**：在 TCA 源码的`plugin/jenkins_plugin`目录下，执行命令`mvm package -DskipTests`，打包完成后进入target目录会看到`Jenkins_plugin.hpi` 的安装包。
**方式一**：在 TCA 源码的`plugin/jenkins_plugin`目录下，执行命令`mvn package -DskipTests`，打包完成后进入target目录会看到`tca_jenkins_plugin.hpi` 的安装包。

**方式二**：从TCA release 安装包中，获取`jenkins_plugin.hpi`：[https://github.com/Tencent/CodeAnalysis/releases](https://github.com/Tencent/CodeAnalysis/releases)。


### 在Jenkins安装插件
在Jenkins中通过【Manage Plugin】-> 【Advanced】->【Deploy plugin】的方式选择 Jenkins_plugin.hpi文件上传安装，并重启Jenkins。
![](../../../images/jenkins_manage_plugins.png)
Expand All @@ -20,6 +19,12 @@ Jenkins插件有以下两种获取方式：
最终在【Installed】里搜索出【TCA】代表插件安装成功。
![](../../../images/jenkins_installed_plugins.png)

### 完善启动客户端的环境
在CodeAnalysis目录下执行代码
```shell
bash ./scripts/base/install_bin.sh
```
将`client`目录下的`config.ini`文件中的`<Server IP地址>`替换为部署的开源版TCA的IP地址（可包含端口号）

## 使用插件
### 在 TCA 创建团队和项目
Expand All @@ -35,24 +40,23 @@ Value：`GITPATH` Value：xxxx（路径不包含git）
![](../../../images/jenkins_manage_jenkins.png)
<img src="../../../images/jenkins_environment_vars.png" width = "400"/>


### 创建一个构建任务，配置代码库信息
进入Jenkins，通过【New Item】创建一个空白任务，在任务配置中【Source Code Management】配置待分析的代码库地址和凭证。
### 配置 TCA 插件
#### 方式一：可视化界面配置 TCA 插件
创建一个构建任务，配置代码库信息，进入Jenkins，通过【New Item】创建一个空白任务，在任务配置中【Source Code Management】配置待分析的代码库地址和凭证。
`Repository URL`: 填入远端仓库地址
`Credentials`: 添加仓库的用户名和密码作为凭证，如果是公开仓库，可以不设置仓库凭证

<img src="../../../images/jenkins_new_item.png" width = "300"/>

![](../../../images/jenkins_git_config.png)

### 配置 TCA 插件
在构建任务的【Build】中选择【TCA】插件并配置以下参数：

`CodeAnalysis`: 拉取代码所在的绝对路径
`CodeAnalysis目录绝对路径`: 拉取到本地的CodeAnalysis开源仓库目录的绝对路径(例如：/data/CodeAnalysis/)
`团队ID`: 在 TCA 中创建的团队的标识ID，可在TCA【团队概览】中获取“团队唯一标识”
`项目名称`: 在 TCA 中创建的项目的标识ID，可在TCA【项目概览】中获取“项目唯一标识”
`Token`: 在 TCA 的【个人中心】->【个人令牌】中获取
`分支名称`: 需要扫描的代码分析名称
`分支名称`: 需要扫描的代码分支名称
`语言类别`: 项目需要扫描的语言
`分析方案模板ID`: 需要使用的分析方案模板ID，在分析方案模板的“基础属性”中获取，将根据此模板创建分析方案（选填）
`分析方案名称`: 指定创建出来的分析方案的名称（选填）
Expand All @@ -63,6 +67,33 @@ Value：`GITPATH` Value：xxxx（路径不包含git）

![](../../../images/jenkins_tca_plugin_config.png)

#### 方式二：pipeline语法配置 TCA 插件
在步骤中添加TCA插件参数配置语句，下面的配置语句可作为参考；注意：如果是release版本v1.11.0及之前的老版本（包含源代码构建生成和release获取）插件，语法参数略有差别，请参考[issue1150](https://github.com/Tencent/CodeAnalysis/issues/1150)
```pipeline
pipeline{
agent any

stages{
stage('Build'){
steps{
TCA(codeAnalysisPath: '/data/CodeAnalysis/', teamId: 'xxxx', projectName: 'demo', token: 'xxxxxxxxxxxx', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true)
}
}
}
}

```
`codeAnalysisPath`: 拉取到本地的CodeAnalysis开源仓库目录的绝对路径(例如：/data/CodeAnalysis/)
`teamId`：团队ID
`projectName`: 项目名称
`token`: 在 TCA 的【个人中心】->【个人令牌】中获取
`branchName`: 需要扫描的代码分支名称
`languageType`: 项目需要扫描的语言
`refSchemeID`: 需要使用的分析方案模板ID，在分析方案模板的“基础属性”中获取，将根据此模板创建分析方案（选填）
`scanPlan`: 指定创建出来的分析方案的名称（选填）
`threshold`: 设置质量门禁值
`total`: 是否全量扫描，填`ture`为全量扫描，不填或填`false`为增量扫描

### 启动构建并查看结果
点击【Build Now】启动构建。
进入构建任务，在【Console Output】中查看执行过程。
Expand All @@ -74,6 +105,8 @@ Value：`GITPATH` Value：xxxx（路径不包含git）
## 设置质量门禁
在上述 TCA 插件配置部分填写`质量门禁`参数，需要填写一个整数，即当前分支的扫描问题量大于该质量门禁值时，判断为不通过；否则为通过。完成后会将TCA结果状态（`success`|`failure`）输出到工作空间下的`tca_threshold.txt`文件中，供后续步骤判断和终止流水线。

### 可视化界面使用质量门禁

在TCA插件后增加shell命令步骤，输入以下脚本内容：

![](../../../images/jenkins_shell.png)
Expand All @@ -87,5 +120,30 @@ else
exit 255
fi
```

当质量门禁不通过时，会终止流水线（退出码：255）。

### pipeline脚本使用质量门禁
以下是pipeline脚本使用质量门禁进行相应操作的示例，你可以在if和else部分写入你想要运行的脚本

```pipeline
pipeline{
agent any

stages{
stage('Build'){
steps{
TCA(codeAnalysisPath: '/data/CodeAnalysis/', teamId: 'xxxx', projectName: 'demo', token: 'xxxxxxxxxxxx', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true)
script{
def tca_status = readFile('tca_threshold.txt')
if (tca_status == "success") {
echo ">> tca scan pass!"
} else {
echo ">> tca scan fail! exit code 255"
error("TCA scan failed. Terminating pipeline.")
}
}
}
}
}
}
```
12 changes: 6 additions & 6 deletions doc/zh/guide/插件/Jenkins_Plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Jenkins插件有以下两种获取方式：
```shell
bash ./scripts/base/install_bin.sh
```
将`client`目录下的`config.ini`文件中的`<Server IP地址>`替换部署的开源版TCA的IP地址（可包含端口号）
将`client`目录下的`config.ini`文件中的`<Server IP地址>`替换为部署的开源版TCA的IP地址（可包含端口号）

## 使用插件
### 在 TCA 创建团队和项目
Expand Down Expand Up @@ -52,7 +52,7 @@ Value：`GITPATH` Value：xxxx（路径不包含git）

在构建任务的【Build】中选择【TCA】插件并配置以下参数：

`CodeAnalysis目录绝对路径`: 拉取到本地的CodeAnalysis开源仓库目录的绝对路径(例如：/User/CodeAnalysis)
`CodeAnalysis目录绝对路径`: 拉取到本地的CodeAnalysis开源仓库目录的绝对路径(例如：/data/CodeAnalysis/)
`团队ID`: 在 TCA 中创建的团队的标识ID，可在TCA【团队概览】中获取“团队唯一标识”
`项目名称`: 在 TCA 中创建的项目的标识ID，可在TCA【项目概览】中获取“项目唯一标识”
`Token`: 在 TCA 的【个人中心】->【个人令牌】中获取
Expand All @@ -68,7 +68,7 @@ Value：`GITPATH` Value：xxxx（路径不包含git）
![](../../../images/jenkins_tca_plugin_config.png)

#### 方式二：pipeline语法配置 TCA 插件
在步骤中添加TCA插件参数配置语句，下面的配置语句可作为参考
在步骤中添加TCA插件参数配置语句，下面的配置语句可作为参考；注意：如果是release版本v1.11.0及之前的老版本（包含源代码构建生成和release获取）插件，语法参数略有差别，请参考[issue1150](https://github.com/Tencent/CodeAnalysis/issues/1150)

```pipeline
pipeline{
Expand All @@ -77,14 +77,14 @@ pipeline{
stages{
stage('Build'){
steps{
TCA_Builder(codeAnalysisPath: '/zhuay/CodeAnalysis/', teamId: 'xxxx', projectName: 'demo', token: 'xxxxxxxxxxxx', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true)
TCA(codeAnalysisPath: '/data/CodeAnalysis/', teamId: 'xxxx', projectName: 'demo', token: 'xxxxxxxxxxxx', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true)
}
}
}
}

```
`codeAnalysisPath`: 拉取到本地的CodeAnalysis开源仓库目录的绝对路径(例如：/User/CodeAnalysis)
`codeAnalysisPath`: 拉取到本地的CodeAnalysis开源仓库目录的绝对路径(例如：/data/CodeAnalysis/)
`teamId`：团队ID
`projectName`: 项目名称
`token`: 在 TCA 的【个人中心】->【个人令牌】中获取
Expand Down Expand Up @@ -133,7 +133,7 @@ pipeline{
stages{
stage('Build'){
steps{
TCA_Builder(codeAnalysisPath: '/zhuay/CodeAnalysis/', teamId: 'xxxx', projectName: 'demo', token: 'xxxxxxxxxxxx', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true)
TCA(codeAnalysisPath: '/data/CodeAnalysis/', teamId: 'xxxx', projectName: 'demo', token: 'xxxxxxxxxxxx', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true)
script{
def tca_status = readFile('tca_threshold.txt')
if (tca_status == "success") {
Expand Down
Loading