From 1b4547a8a653111e148568b0624d6a791c450d46 Mon Sep 17 00:00:00 2001 From: zhuay <120068512+zhuay-a@users.noreply.github.com> Date: Wed, 24 Jul 2024 18:38:03 +0800 Subject: [PATCH 1/8] Update Jenkins_Plugin.md --- .../Jenkins_Plugin.md" | 72 +++++++++++++++++-- 1 file changed, 66 insertions(+), 6 deletions(-) diff --git "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" index f3a8cb9729..345a1eb582 100644 --- "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" +++ "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" @@ -20,6 +20,12 @@ Jenkins插件有以下两种获取方式： 最终在【Installed】里搜索出【TCA】代表插件安装成功。 ![](../../../images/jenkins_installed_plugins.png) +### 完善启动客户端的环境 +在CodeAnalysis目录下执行代码 +```shell +bash ./scripts/base/install_bin.sh +``` +将`client`目录下的`config.ini`文件中的``替换部署的开源版TCA的IP（可包含端口号） ## 使用插件 ### 在 TCA 创建团队和项目 @@ -35,9 +41,9 @@ Value：`GITPATH` Value：xxxx（路径不包含git） ![](../../../images/jenkins_manage_jenkins.png) - -### 创建一个构建任务，配置代码库信息 -进入Jenkins，通过【New Item】创建一个空白任务，在任务配置中【Source Code Management】配置待分析的代码库地址和凭证。 +### 配置 TCA 插件 +#### 方式一：可视化界面配置 TCA 插件 +创建一个构建任务，配置代码库信息，进入Jenkins，通过【New Item】创建一个空白任务，在任务配置中【Source Code Management】配置待分析的代码库地址和凭证。 `Repository URL`: 填入远端仓库地址 `Credentials`: 添加仓库的用户名和密码作为凭证，如果是公开仓库，可以不设置仓库凭证 @@ -45,14 +51,13 @@ Value：`GITPATH` Value：xxxx（路径不包含git） ![](../../../images/jenkins_git_config.png) -### 配置 TCA 插件 在构建任务的【Build】中选择【TCA】插件并配置以下参数： `CodeAnalysis`: 拉取代码所在的绝对路径 `团队ID`: 在 TCA 中创建的团队的标识ID，可在TCA【团队概览】中获取“团队唯一标识” `项目名称`: 在 TCA 中创建的项目的标识ID，可在TCA【项目概览】中获取“项目唯一标识” `Token`: 在 TCA 的【个人中心】->【个人令牌】中获取 -`分支名称`: 需要扫描的代码分析名称 +`分支名称`: 需要扫描的代码分支名称 `语言类别`: 项目需要扫描的语言 `分析方案模板ID`: 需要使用的分析方案模板ID，在分析方案模板的“基础属性”中获取，将根据此模板创建分析方案（选填） `分析方案名称`: 指定创建出来的分析方案的名称（选填） @@ -61,6 +66,34 @@ Value：`GITPATH` Value：xxxx（路径不包含git） 配置完成后点击【Save】保存。 +#### 方式二：pipeline语法配置 TCA 插件 +在步骤中添加TCA插件参数配置语句，下面的配置语句可作为参考 + +```pipeline +pipeline{ + agent any + + stages{ + stage('Build'){ + steps{ + TCA_Builder(codeAnalysisPath: '/user/CodeAnalysis/', teamId: 'abcdefghijk', projectName: 'demo', token: '0712b895f30c5e958ec71a7c22e1b1a2ad1d5c6b', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true) + } + } + } +} + +``` +`codeAnalysisPath`: 拉取代码所在的绝对路径 +`teamId`：团队ID +`projectName`: 项目名称 +`token`: 在 TCA 的【个人中心】->【个人令牌】中获取 +`branchName`: 需要扫描的代码分支名称 +`languageType`: 项目需要扫描的语言 +`refSchemeID`: 需要使用的分析方案模板ID，在分析方案模板的“基础属性”中获取，将根据此模板创建分析方案（选填） +`scanPlan`: 指定创建出来的分析方案的名称（选填） +`threshold`: 设置质量门禁值 +`total`: 是否全量扫描，填`ture`为全量扫描，不填或填`false`为增量扫描 + ![](../../../images/jenkins_tca_plugin_config.png) ### 启动构建并查看结果 @@ -74,6 +107,8 @@ Value：`GITPATH` Value：xxxx（路径不包含git） ## 设置质量门禁 在上述 TCA 插件配置部分填写`质量门禁`参数，需要填写一个整数，即当前分支的扫描问题量大于该质量门禁值时，判断为不通过；否则为通过。完成后会将TCA结果状态（`success`|`failure`）输出到工作空间下的`tca_threshold.txt`文件中，供后续步骤判断和终止流水线。 +### 可视化界面使用质量门禁 + 在TCA插件后增加shell命令步骤，输入以下脚本内容： ![](../../../images/jenkins_shell.png) @@ -87,5 +122,30 @@ else exit 255 fi ``` - 当质量门禁不通过时，会终止流水线（退出码：255）。 + +### pipeline脚本使用质量门禁 +以下是pipeline使用质量门禁进行相应操作的示例，你可以在if和else部分写入你想要运行的脚本 + +```pipeline +pipeline{ + agent any + + stages{ + stage('Build'){ + steps{ + TCA_Builder(codeAnalysisPath: '/zhuay/CodeAnalysis/', teamId: 'A15aEovCEcC', projectName: 'demo', token: '0712b895f30c5e958ec71a7c22e1b1a2ad1d5c6b', 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.") + } + } + } + } + } +} +``` From a4001d4b6bdb112c0dd833b549930ef67bdf2ea0 Mon Sep 17 00:00:00 2001 From: zhuay <120068512+zhuay-a@users.noreply.github.com> Date: Wed, 24 Jul 2024 19:32:42 +0800 Subject: [PATCH 2/8] Update Jenkins_Plugin.md --- "doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" index 345a1eb582..ec8b1ea1c7 100644 --- "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" +++ "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" @@ -25,7 +25,7 @@ Jenkins插件有以下两种获取方式： ```shell bash ./scripts/base/install_bin.sh ``` -将`client`目录下的`config.ini`文件中的``替换部署的开源版TCA的IP（可包含端口号） +将`client`目录下的`config.ini`文件中的``替换部署的开源版TCA的IP地址（可包含端口号） ## 使用插件 ### 在 TCA 创建团队和项目 @@ -66,6 +66,8 @@ Value：`GITPATH` Value：xxxx（路径不包含git） 配置完成后点击【Save】保存。 +![](../../../images/jenkins_tca_plugin_config.png) + #### 方式二：pipeline语法配置 TCA 插件 在步骤中添加TCA插件参数配置语句，下面的配置语句可作为参考 @@ -94,8 +96,6 @@ pipeline{ `threshold`: 设置质量门禁值 `total`: 是否全量扫描，填`ture`为全量扫描，不填或填`false`为增量扫描 -![](../../../images/jenkins_tca_plugin_config.png) - ### 启动构建并查看结果 点击【Build Now】启动构建。 进入构建任务，在【Console Output】中查看执行过程。 @@ -125,7 +125,7 @@ fi 当质量门禁不通过时，会终止流水线（退出码：255）。 ### pipeline脚本使用质量门禁 -以下是pipeline使用质量门禁进行相应操作的示例，你可以在if和else部分写入你想要运行的脚本 +以下是pipeline脚本使用质量门禁进行相应操作的示例，你可以在if和else部分写入你想要运行的脚本 ```pipeline pipeline{ From c3769f0befeb26d6d3f2977dc66b88ec602763ea Mon Sep 17 00:00:00 2001 From: zhuay <120068512+zhuay-a@users.noreply.github.com> Date: Wed, 24 Jul 2024 19:35:38 +0800 Subject: [PATCH 3/8] Update Jenkins_Plugin.md --- .../Jenkins_Plugin.md" | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" index ec8b1ea1c7..daaa3986a5 100644 --- "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" +++ "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" @@ -85,16 +85,16 @@ pipeline{ } ``` -`codeAnalysisPath`: 拉取代码所在的绝对路径 -`teamId`：团队ID -`projectName`: 项目名称 -`token`: 在 TCA 的【个人中心】->【个人令牌】中获取 -`branchName`: 需要扫描的代码分支名称 -`languageType`: 项目需要扫描的语言 -`refSchemeID`: 需要使用的分析方案模板ID，在分析方案模板的“基础属性”中获取，将根据此模板创建分析方案（选填） -`scanPlan`: 指定创建出来的分析方案的名称（选填） -`threshold`: 设置质量门禁值 -`total`: 是否全量扫描，填`ture`为全量扫描，不填或填`false`为增量扫描 +`codeAnalysisPath`: 拉取代码所在的绝对路径 +`teamId`：团队ID +`projectName`: 项目名称 +`token`: 在 TCA 的【个人中心】->【个人令牌】中获取 +`branchName`: 需要扫描的代码分支名称 +`languageType`: 项目需要扫描的语言 +`refSchemeID`: 需要使用的分析方案模板ID，在分析方案模板的“基础属性”中获取，将根据此模板创建分析方案（选填） +`scanPlan`: 指定创建出来的分析方案的名称（选填） +`threshold`: 设置质量门禁值 +`total`: 是否全量扫描，填`ture`为全量扫描，不填或填`false`为增量扫描 ### 启动构建并查看结果 点击【Build Now】启动构建。 From 56bf6add67c2a06f4a75fbe345fadd7d4afca9bd Mon Sep 17 00:00:00 2001 From: zhuay <120068512+zhuay-a@users.noreply.github.com> Date: Wed, 24 Jul 2024 19:36:14 +0800 Subject: [PATCH 4/8] Update Jenkins_Plugin.md --- "doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" index daaa3986a5..6e01a7fc76 100644 --- "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" +++ "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" @@ -7,7 +7,7 @@ ### 获取Jenkins插件 Jenkins插件有以下两种获取方式： -**方式一**：在 TCA 源码的`plugin/jenkins_plugin`目录下，执行命令`mvm package -DskipTests`，打包完成后进入target目录会看到`Jenkins_plugin.hpi` 的安装包。 +**方式一**：在 TCA 源码的`plugin/jenkins_plugin`目录下，执行命令`mvn package -DskipTests`，打包完成后进入target目录会看到`Jenkins_plugin.hpi` 的安装包。 **方式二**：从TCA release 安装包中，获取`jenkins_plugin.hpi`：[https://github.com/Tencent/CodeAnalysis/releases](https://github.com/Tencent/CodeAnalysis/releases)。 From c78bc8b38604515bc1551b0c37f9013d8ce2d61d Mon Sep 17 00:00:00 2001 From: zhuay <120068512+zhuay-a@users.noreply.github.com> Date: Wed, 24 Jul 2024 19:38:15 +0800 Subject: [PATCH 5/8] Update Jenkins_Plugin.md --- "doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" | 1 - 1 file changed, 1 deletion(-) diff --git "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" index 6e01a7fc76..b1a51be945 100644 --- "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" +++ "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" @@ -11,7 +11,6 @@ Jenkins插件有以下两种获取方式： **方式二**：从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) From d7e902b47ab452d7a921fa8eb9d985ef2457510c Mon Sep 17 00:00:00 2001 From: zhuay <120068512+zhuay-a@users.noreply.github.com> Date: Thu, 25 Jul 2024 11:04:52 +0800 Subject: [PATCH 6/8] Update TCABuilder.java MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit pipeline脚本支持优化 --- .../src/main/java/io/jenkins/plugins/TCABuilder.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/plugins/jenkins_plugin/src/main/java/io/jenkins/plugins/TCABuilder.java b/plugins/jenkins_plugin/src/main/java/io/jenkins/plugins/TCABuilder.java index a10d0c94b7..ef9da976e2 100644 --- a/plugins/jenkins_plugin/src/main/java/io/jenkins/plugins/TCABuilder.java +++ b/plugins/jenkins_plugin/src/main/java/io/jenkins/plugins/TCABuilder.java @@ -19,6 +19,7 @@ import hudson.util.FormValidation; import jenkins.tasks.SimpleBuildStep; import org.apache.commons.lang.StringUtils; +import org.jenkinsci.Symbol; import org.json.JSONObject; import org.kohsuke.stapler.DataBoundConstructor; import org.kohsuke.stapler.DataBoundSetter; @@ -230,6 +231,7 @@ public void perform(@NonNull Run run, @NonNull FilePath workspace, @NonNul } @Extension + @Symbol("TCA") public static final class DescriptorImpl extends BuildStepDescriptor { public FormValidation doCheckCodeAnalysisPath(@QueryParameter String value) throws IOException, ServletException { if (StringUtils.isBlank(value)){ From ac7e0149199456e62d29f540cddadaf10ffe5fd4 Mon Sep 17 00:00:00 2001 From: zhuay <1273313281@qq.com> Date: Thu, 25 Jul 2024 19:37:24 +0800 Subject: [PATCH 7/8] =?UTF-8?q?pipeline=E8=84=9A=E6=9C=AC=E6=94=AF?= =?UTF-8?q?=E6=8C=81=E4=BC=98=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- "doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" | 8 ++++---- plugins/jenkins_plugin/pom.xml | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) diff --git "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" index b1a51be945..a941e1a802 100644 --- "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" +++ "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" @@ -7,7 +7,7 @@ ### 获取Jenkins插件 Jenkins插件有以下两种获取方式： -**方式一**：在 TCA 源码的`plugin/jenkins_plugin`目录下，执行命令`mvn 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)。 @@ -52,7 +52,7 @@ Value：`GITPATH` Value：xxxx（路径不包含git） 在构建任务的【Build】中选择【TCA】插件并配置以下参数： -`CodeAnalysis`: 拉取代码所在的绝对路径 +`CodeAnalysis目录绝对路径`: 拉取到本地的CodeAnalysis开源仓库目录的绝对路径(例如：/User/CodeAnalysis) `团队ID`: 在 TCA 中创建的团队的标识ID，可在TCA【团队概览】中获取“团队唯一标识” `项目名称`: 在 TCA 中创建的项目的标识ID，可在TCA【项目概览】中获取“项目唯一标识” `Token`: 在 TCA 的【个人中心】->【个人令牌】中获取 @@ -84,7 +84,7 @@ pipeline{ } ``` -`codeAnalysisPath`: 拉取代码所在的绝对路径 +`codeAnalysisPath`: 拉取到本地的CodeAnalysis开源仓库目录的绝对路径(例如：/User/CodeAnalysis) `teamId`：团队ID `projectName`: 项目名称 `token`: 在 TCA 的【个人中心】->【个人令牌】中获取 @@ -133,7 +133,7 @@ pipeline{ stages{ stage('Build'){ steps{ - TCA_Builder(codeAnalysisPath: '/zhuay/CodeAnalysis/', teamId: 'A15aEovCEcC', projectName: 'demo', token: '0712b895f30c5e958ec71a7c22e1b1a2ad1d5c6b', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true) + TCA_Builder(codeAnalysisPath: '/zhuay/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") { diff --git a/plugins/jenkins_plugin/pom.xml b/plugins/jenkins_plugin/pom.xml index cc6f12933a..4e13abb6bc 100644 --- a/plugins/jenkins_plugin/pom.xml +++ b/plugins/jenkins_plugin/pom.xml @@ -70,4 +70,7 @@ https://repo.jenkins-ci.org/public/ + + tca_jenkins_plugin + From 9d94ba8842048c6b69e34d732291e4859ae1feab Mon Sep 17 00:00:00 2001 From: zhuay <1273313281@qq.com> Date: Thu, 25 Jul 2024 20:00:45 +0800 Subject: [PATCH 8/8] =?UTF-8?q?pipeline=E8=84=9A=E6=9C=AC=E6=94=AF?= =?UTF-8?q?=E6=8C=81=E4=BC=98=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- "doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" index a941e1a802..f1632899d0 100644 --- "a/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" +++ "b/doc/zh/guide/\346\217\222\344\273\266/Jenkins_Plugin.md" @@ -77,7 +77,7 @@ pipeline{ stages{ stage('Build'){ steps{ - TCA_Builder(codeAnalysisPath: '/user/CodeAnalysis/', teamId: 'abcdefghijk', projectName: 'demo', token: '0712b895f30c5e958ec71a7c22e1b1a2ad1d5c6b', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true) + TCA_Builder(codeAnalysisPath: '/zhuay/CodeAnalysis/', teamId: 'xxxx', projectName: 'demo', token: 'xxxxxxxxxxxx', branchName: 'master', languageType: 'Java', refSchemeID: '1', scanPlan: 'model', threshold: '90', total:true) } } }