网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络服务
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
IoT物联网
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
文档首页/ 代码检查 CodeArts Check/ 最佳实践/ 使用Jenkins插件集成CodeArts Check执行代码检查

使用Jenkins插件集成CodeArts Check执行代码检查

更新时间:2025-01-16 GMT+08:00
分享

应用场景

Jenkins是一款由Java编写的开源的持续集成工具,它运行在Servlet容器中(例如Apache Tomcat),可以通过各种方式触发构建。例如提交给版本控制系统时被触发、通过类似Cron的机制调度、或在其他的构建已经完成时通过一个特定的URL进行请求。

利用Jenkins工具现有能力,实现代码检查服务的快速集成,包含执行检查、状态查询、报告输出等基本扫描流程。用户可根据基础方案进行自定义开发。

本文介绍如何通过Jenkins工具及CodeArtsCheck API,实现代码检查服务集成与调度。本示例将以通用Git为例,进行方案介绍。

约束限制

  • 代码源为非同一CodeArts项目下的Repo仓时需使用扩展点进行代码源接入。
  • 每个通用Git扩展点仅能对接单个代码仓地址。
  • 1个CodeArts项目下的扩展点数量限制为1000。
  • 实行本实践需了解Jenkins工具的使用与基础开发。

操作流程

表1 操作流程

流程

说明

创建代码检查任务所属项目

为本实践新建项目。

新建通用Git服务扩展点

实践检查第三方代码仓的代码质量,代码检查服务需通过CodeArts提供的扩展插件连接到第三方代码仓。

创建通用Git代码检查任务并获取任务ID

创建代码检查任务并获取任务ID。

创建访问凭证AK和SK

创建调用API时使用的AK和SK。

下载KooCLI工具并获取代码检查API的调用命令

下载KooCLI工具并获取代码检查API的调用命令。

在Jenkins工具中调用代码检查API

通过Jenkins工具调用代码检查API。

创建代码检查任务所属项目

  1. 使用华为云账号登录华为云控制台页面
  2. 单击页面左上角,在服务列表中选择开发与运维 > 软件开发生产线 CodeArts
  3. 单击“立即使用”,进入CodeArts服务首页。
  4. 在首页单击“新建项目”,选用“Scrum”项目模板。项目名称填写“Scrum01”,其他参数保持默认即可。
  5. 单击“确定”后,进入到“Scrum01”项目下。

新建通用Git服务扩展点

服务扩展点(Endpoint)是软件开发生产线的一种扩展插件,为软件开发生产线提供链接第三方代码仓的能力。

代码检查服务默认检查CodeArts Repo服务的代码质量,同时也可使用服务扩展点连接第三方代码仓库检查代码质量。

  1. 在项目下的CodeArts Check服务页面的导航栏选择设置 > 通用设置 > 服务扩展点管理
  2. 单击“新建服务扩展点”,在下拉列表中选择“通用Git”
  3. 在弹框中配置以下信息,单击“确定”

    表2 新建通用Git服务扩展点

    参数

    说明

    连接名称

    自定义,支持中文、英文、数字、“-”、“_”、“.”、空格,不超过256个字符。例如:Endpoint01。

    Git仓库Url

    输入待连接的Git仓库的https地址。

    用户名

    输入待连接的Git仓库的用户名,不超过300个字符。

    密码或Access Token

    输入待连接的Git仓库的密码,不超过300个字符。

创建通用Git代码检查任务并获取任务ID

  1. 在导航栏选择代码 > 代码检查
  2. 单击“新建任务”,进入“新建任务”页面,参考表3配置参数。

    表3 通用Git代码检查任务参数说明

    参数

    说明

    归属项目

    任务所属项目。默认填写为创建代码检查任务所属项目中的项目名称“Scrum01”,无需手动填写。

    代码源

    选择“通用Git”

    任务名称

    代码检查任务名称,可自定义。例如:CheckTask01。

    Endpoint实例

    选择新建通用Git服务扩展点中创建的服务扩展点“Endpoint01”

    仓库

    保持默认即可。

    分支

    保持默认“master”即可。

    检查语言

    选择需要检查的代码语言,选择“Java”

  3. 单击“新建任务”,完成检查任务的创建。
  4. 在代码检查任务列表页,单击代码检查任务名称,在代码检查任务概览页面URL中即为任务ID。

    图1 代码检查任务ID

创建访问凭证AK和SK

  1. 登录管理控制台。
  2. 单击用户名,在下拉列表中单击“我的凭证”。
  3. 单击“访问密钥”。
  4. 单击“新增访问密钥”,弹出“新增访问密钥”页面。
  5. 输入该访问密钥的描述信息。
  6. 单击“确定”,下载访问密钥。

    说明:

    为防止访问密钥泄露,建议您将其保存到安全的位置。

下载KooCLI工具并获取代码检查API的调用命令

  1. 访问华为云命令行工具服务KooCLI文档页面。
  2. 根据本地电脑的系统版本号下载对应版本的KooCLI工具。
  3. 访问代码检查API调试页面。
  4. 选择实际使用的Region和填写创建通用Git代码检查任务并获取任务ID中查询到的任务ID,其中hcloud CodeCheck RunTask --cli-region="cn-north-4" --task_id="9fd08c41a9824a69afdb9aca17590e29"即为生成的调用命令。

    图2 生成API调用命令

  5. 参考4,依次获得查询任务执行状态(ShowProgressDetail)、查询缺陷概要(ShowTaskDetail)API的调用命令。

在Jenkins工具中调用代码检查API

  1. 编写流水线脚本,代码示例如下。

    pipeline {
        agent any	
    
        stages {
    		stage('代码检查') {
                steps {				
    				script {
    					echo "设置AK/SK"
    					def response = sh(
    						returnStdout: true,
    						script: """
    							/codearts/hcloud configure set --cli-access-key=S******************3 --cli-secret-key=s******************A
    						"""
                        )
    					echo response
    				}
    				script {
    					echo "执行检查任务"				
    					def response = sh(
    						returnStdout: true,
    						script: """
    							/codearts/hcloud CodeCheck RunTask --cli-region="cn-south-1" --task_id="4******************f"
    						"""
    					)
    					echo response					
    					def json = readJSON text:response
    					echo "exec_id: ${json.exec_id}"
    				}
    				script {					
    					def try_count=0
    					def task_status=0
    					while (true) {
    						def response = sh(
    							returnStdout: true,
    							script: """
    								/codearts/hcloud CodeCheck ShowProgressDetail --cli-region="cn-south-1" --task_id="4******************f"
    							"""
    						)
    						echo response
    						def json = readJSON text:response
    						task_status=json.task_status
    						echo "代码检查任务执行中 try_count: $try_count, task_status: $task_status"
    						if(task_status.toInteger()>0){
    							break
    						}
    						try_count=try_count+1
    						if(try_count==120){
    							break
    						}
    						sleep(time: 5, unit: 'SECONDS')
    					}
    					if(task_status.toInteger()==0){
    						error "代码检查超过600s,构建任务失败"
    					}
    					if(task_status.toInteger()==1){
    						error "代码检查没有通过,构建任务失败"
    					}
    					if(task_status.toInteger()==3){
    						error "代码检查任务中止,构建任务失败"
    					}					
    				}
    				script {
    					def response = sh(
    						returnStdout: true,
    						script: """
    							/codearts/hcloud CodeCheck ShowTaskDetail --cli-region="cn-south-1" --task_id="4******************f"
    						"""
    					)
    					echo response
    					def json = readJSON text:response
    					def issue_count=json.issue_count
    					def new_count=json.new_count
    					def solve_count=json.solve_count
    					def cyclomatic_complexity_per_method=json.cyclomatic_complexity_per_method
    					def duplication_ratio=json.duplication_ratio
    					def code_line=json.code_line
    					def critical_count=json.critical_count
    					def major_count=json.major_count
    					def is_access=json.is_access
                        echo "问题数:$issue_count"
                        echo "未解决问题数:$new_count"
                        echo "已解决问题数:$solve_count"
                        echo "代码平均圈复杂度:$cyclomatic_complexity_per_method"
                        echo "代码重复率:$duplication_ratio"
                        echo "NBNC代码行:$code_line"
                        echo "致命问题数:$critical_count"
                        echo "严重问题数:$major_count"
                        echo "门禁质量是否通过:$is_access"
    					if(is_access.toInteger()==1){
    						error "门禁质量检查没有通过,构建任务失败"
    					}
    					else{
    						echo "门禁质量检查通过"
    					}									
    				}					
    			}
    		}
            stage('拉取代码') {
                steps {
    				sh '''
    					echo "拉取代码"
    					'''
    			}            
            } 
            stage('代码编译') {
                steps {
    				sh '''
    					echo "代码编译"
    					'''			
                }
            }
            stage('上传镜像并部署到cce') { 
                steps{  
    				sh '''
    					echo "上传镜像并部署到cce"
    					'''
                }
            }
    	}
    }

  2. 执行流水线任务。
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容