2.428

公司自研CI/DI平台借助JenkinsSonarQube进行代码质量管理。

对接版本

Jenkins版本为Version

Java对接Jenkins有第三方组件比如jenkins-rest、jenkins-client但是考虑到第三方组件会引入其他jar包而且会存在漏洞问题。

到时候升级组件时可能会和项目框架本身使用的第三方jar起冲突。

因此使用jenkins-cli来实现自己的需求。

注意这里不是单纯的使用java

-jar

而且提取并修改jenkins-cli.jar中的源码来达到自身需求开发的目的。

比如创建View时使用jenkins-cli.jar时需要传入xml内容标准输入流

所以我们进行了改造可以支持传入byte数组的形式使用体验更符合大众。

jenkins-cli.jar的源码修改

package

com.infosec.autobuild.util;import

com.cdancy.jenkins.rest.JenkinsClient;

import

com.cdancy.jenkins.rest.domain.job.BuildInfo;

import

com.cdancy.jenkins.rest.domain.queue.QueueItem;

import

com.infosec.autobuild.dto.jenkins.BuildInfoDto;

import

com.infosec.autobuild.dto.jenkins.CredentialDto;

import

com.infosec.autobuild.dto.jenkins.JobDto;

import

com.infosec.autobuild.dto.jenkins.ViewDto;

import

com.infosec.autobuild.hudson.cli.CLI;

import

org.apache.http.auth.AuthScope;

import

org.apache.http.auth.UsernamePasswordCredentials;

import

org.apache.http.client.AuthCache;

import

org.apache.http.client.CredentialsProvider;

import

org.apache.http.client.methods.CloseableHttpResponse;

import

org.apache.http.client.methods.HttpGet;

import

org.apache.http.client.protocol.HttpClientContext;

import

org.apache.http.impl.auth.BasicScheme;

import

org.apache.http.impl.client.BasicAuthCache;

import

org.apache.http.impl.client.BasicCredentialsProvider;

import

org.apache.http.impl.client.CloseableHttpClient;

import

org.apache.http.impl.client.HttpClients;

import

org.apache.http.util.EntityUtils;

import

org.springframework.beans.BeanUtils;

import

org.springframework.util.CollectionUtils;

import

org.springframework.util.ObjectUtils;

import

org.springframework.util.StringUtils;import

java.net.URI;

java.nio.charset.StandardCharsets;

import

system::system::jenkins等同于SystemCredentialsProvider::SystemContextResolver::jenkins*

-jar

list-credentials-context-resolvers获取*/private

static

Credentials集合:list-credentials*/LIST_CREDENTIALS(list-credentials,

查询Jenkins

Credentials集合返回xml:list-credentials-as-xml*/LIST_CREDENTIALS_AS_XML(list-credentials-as-xml,

查询Jenkins

Credentials:create-credentials-by-xml*/CREATE_CREDENTIALS(create-credentials-by-xml,

创建Jenkins

Credentials:create-credentials-by-xml*/UPDATE_CREDENTIALS(update-credentials-by-xml,

更新Jenkins

Credentials:delete-credentials*/DELETE_CREDENTIALS(delete-credentials,

删除Jenkins

Credentials:get-credentials-as-xml*/GET_CREDENTIALS(get-credentials-as-xml,

查询Jenkins

Credentials),;SetterGetterprivate

String

{this.setOp(op);this.setDesc(desc);}}/***

创建Jenkins

Jenkins地址比如http://10.100.57.156:8080*

param

(!StringUtils.hasText(credentialDto.getId()))

{credentialDto.setId(UUID.randomUUID().toString());}String

xml

CredentialDto.parseDto2Xml(credentialDto);CLI

cli

String[]{Operation.CREATE_CREDENTIALS.op,

SYSTEM_STORE_ID,

ResultDto.SUCCESS.equals(String.valueOf(code))

ResultDto.buildErrorDto().msg(msg);}/***

删除Jenkins

Jenkins地址比如http://10.100.57.156:8080*

param

String[]{Operation.DELETE_CREDENTIALS.op,

SYSTEM_STORE_ID,

msg.contains(CREDENTIAL_NOT_FOUND))

{return

ResultDto.buildSuccessDto();}return

ResultDto.SUCCESS.equals(String.valueOf(code))

ResultDto.buildErrorDto().msg(msg);}/***

更新Jenkins

Jenkins地址比如http://10.100.57.156:8080*

param

(!StringUtils.hasText(credentialDto.getId()))

{return

ResultDto.buildErrorDto().msg(凭证id不能为空);}String

xml

CredentialDto.parseDto2Xml(credentialDto);CLI

cli

String[]{Operation.UPDATE_CREDENTIALS.op,

PROTOCOL_HTTP,

msg.contains(CREDENTIAL_NOT_FOUND))

{msg

ResultDto.buildErrorDto().msg(msg);}return

ResultDto.SUCCESS.equals(String.valueOf(code))

ResultDto.buildErrorDto().msg(msg);}/***

查询Jenkins

Jenkins地址比如http://10.100.57.156:8080*

param

String[]{Operation.GET_CREDENTIALS.op,

SYSTEM_STORE_ID,

msg.contains(CREDENTIAL_NOT_FOUND))

{msg

ResultDto.buildErrorDto().msg(msg);}boolean

ifSuccess

ResultDto.SUCCESS.equals(String.valueOf(code));CredentialDto

credentialDto

{CredentialDto.parseXmlStr2Dto(credentialDto,

msg,

ResultDto.buildSuccess(credentialDto)

ResultDto.buildError(credentialDto).msg(msg);}/***

param

Jenkins地址比如http://10.100.57.156:8080*

param

String[]{Operation.LIST_CREDENTIALS_AS_XML.op,

SYSTEM_STORE_ID},PROTOCOL_HTTP,

null);int

ResultDto.SUCCESS.equals(String.valueOf(code));if

(ifSuccess)

{CredentialDto.parseXmlStr2List(credentialDtoList,

msg);}return

ResultDto.buildSuccess(credentialDtoList)

ResultDto.buildError(credentialDtoList).msg(msg);}/***

param

host/job/jobName/buildId/api/json;private

static

host/job/jobName/buildId/api/json;enum

Operation

Job添加到视图中*/ADD_TO_VIEW(add-job-to-view,

将Jenkins

Job从视图中移除*/REMOVE_FROM_VIEW(remove-job-from-view,

将Jenkins

{this.setOp(op);this.setDesc(desc);}}/***

param

Jenkins地址比如http://10.100.57.156:8080*

param

String[]{Operation.LIST.op};String[]

finalArgs

Stream.concat(Arrays.stream(baseArgs),Arrays.stream(new

String[]{viewName})).toArray(String[]::new)

baseArgs;CLI

ResultDto.SUCCESS.equals(String.valueOf(code));boolean

listAllJobs

JobDto();jobDto.setJobName(tmp);jobDto.setViewName(listAllJobs

viewName

);jobDtoList.add(jobDto);}}}return

ifSuccess

ResultDto.buildSuccess(jobDtoList)

ResultDto.buildError(jobDtoList).msg(msg);}/***

param

String[]{Operation.ADD_TO_VIEW.op};String[]

finalArgs

jobNames).flatMap(Arrays::stream).toArray(String[]::new);CLI

cli

ResultDto.SUCCESS.equals(String.valueOf(code))

?ResultDto.buildSuccess(jobDtoList)

ResultDto.buildError(jobDtoList).msg(msg);}public

static

String[]{Operation.REMOVE_FROM_VIEW.op};String[]

finalArgs

jobNames).flatMap(Arrays::stream).toArray(String[]::new);CLI

cli

ResultDto.SUCCESS.equals(String.valueOf(code))

?ResultDto.buildSuccess(jobDtoList)

ResultDto.buildError(jobDtoList).msg(msg);}/***

创建Job**

Jenkins地址比如http://10.100.57.156:8080*

param

job.getSvnInfoList();ListJobDto.GitInfoDto

gitInfoDtoList

CollectionUtils.isEmpty(svnInfoDtoList)

CollectionUtils.isEmpty(gitInfoDtoList);if

(scmCheck)

ResultDto.buildErrorDto().msg(源码管理地址信息不能为空);}String

xml

keepDependenciesfalse/keepDependencies\n

properties/\n;if

(!CollectionUtils.isEmpty(svnInfoDtoList))

{xml

(!CollectionUtils.isEmpty(gitInfoDtoList))

{xml

excludedRegions/excludedRegions\n

includedRegions/includedRegions\n

excludedRevprop/excludedRevprop\n

excludedCommitMessages/excludedCommitMessages\n

workspaceUpdater

class\hudson.scm.subversion.UpdateUpdater\/\n

ignoreDirPropChangesfalse/ignoreDirPropChanges\n

filterChangelogfalse/filterChangelog\n

quietOperationtrue/quietOperation\n

/scm\n

blockBuildWhenDownstreamBuildingfalse/blockBuildWhenDownstreamBuilding\n

blockBuildWhenUpstreamBuildingfalse/blockBuildWhenUpstreamBuilding\n

triggers/\n

concurrentBuildfalse/concurrentBuild\n;xml

publishers/\n

ResultDto.SUCCESS.equals(String.valueOf(code))

ResultDto.buildErrorDto().msg(msg);}/***

更新Job**

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

jobNames).flatMap(Arrays::stream).toArray(String[]::new);return

operation(host,

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

JobDto();jobDto.setJobName(jobName);//解析xml获取名称、描述等信息String

msg

ObjectUtils.isEmpty(resultDto.getData())

resultDto.getData().toString();if

{jobDto.parseXmlStr2Dto(msg);}return

构建单个Job**

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

String[]{buildId.toString()}).flatMap(Arrays::stream).toArray(String[]::new);return

operation(host,

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

String[]{Operation.STOP_BUILDS.op},

jobNames).flatMap(Arrays::stream).toArray(String[]::new);return

operation(host,

Jenkins地址比如http://10.100.57.156:8080*

param

ResultDto.buildErrorDto().msg(buildId

can

JenkinsClient.builder().endPoint(host).credentials(username

password).build();ListQueueItem

list

client.api().queueApi().queue();for

(QueueItem

item.task().name());}System.out.println(JsonUtil.toJSONString(client.api().systemApi().systemInfo()));BuildInfo

data

client.api().jobsApi().buildInfo(null,

jobName,

buildId);System.out.println(data.building());String

url

JOB_BUILD_DETAIL_URL.replace(host,

doGet(url,

Jenkins地址比如http://10.100.57.156:8080*

param

IllegalArgumentException(buildId

can

JOB_BUILD_DETAIL_URL.replace(host,

buildId.toString());BuildInfoDto

infoDto

Jenkins地址比如http://10.100.57.156:8080*

param

ResultDto.SUCCESS.equals(String.valueOf(code))

ResultDto.buildError(msg).msg(msg);}/***

xml章节内容**

class\hudson.scm.SubversionSCM\

new

hudson.scm.SubversionSCM_-ModuleLocation\n).append(

remote

svnInfoDto.getIgnoreExternalsOption()

/ignoreExternalsOption\n).append(

svnInfoDto.getCancelProcessOnExternalsFail()

/cancelProcessOnExternalsFail\n).append(

/hudson.scm.SubversionSCM_-ModuleLocation\n);}xml

sb.toString();return

job.getBuildCmdList();ListJobDto.SonarRunnerBuilderDto

job.getSonarRunnerBuilderDtoList();boolean

checkBuilders

CollectionUtils.isEmpty(shellList)

CollectionUtils.isEmpty(sonarRunnerBuilderDtoList);if

(checkBuilders)

(!CollectionUtils.isEmpty(shellList))

{String

shellList.stream().collect(Collectors.joining(\n));xml

hudson.tasks.Shell\n

(!CollectionUtils.isEmpty(sonarRunnerBuilderDtoList))

{JobDto.ProjectInfo

projectInfo.getBuildVersion();StringBuilder

new

hudson.plugins.sonar.SonarRunnerBuilder\n).append(

keyInfo

\n).append(sonar.projectVersion

sonar.getSonarScannerLanguage()

\n).append(sonar.sourceEncodingUTF-8\n).append(sonar.java.binariestarget/classes\n).append(sonar.sources.\n).append(sonar.login

job.getSonarLogin()

sonar.getSonarScmDisabled()).append(

javaOpts

/additionalArguments\n).append(

jdk

/hudson.plugins.sonar.SonarRunnerBuilder\n);}xml

sb.toString();}xml

创建Jenkins视图*/CREATE(create-view,

创建Jenkins视图),/***

更新Jenkins视图*/UPDATE(update-view,

更新Jenkins视图),/***

删除Jenkins视图*/DELETE(delete-view,

删除Jenkins视图),/***

查询Jenkins视图);SetterGetterprivate

String

{this.setOp(op);this.setDesc(desc);}}/***

创建View**

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

(!StringUtils.hasText(viewName))

{return

ResultDto.buildErrorDto().msg(视图名称不能为空);}CLI

cli

ResultDto.SUCCESS.equals(String.valueOf(code));ViewDto

viewDto

ViewDto();viewDto.setViewName(viewName);//解析xml获取view名称、描述、关联的job等信息if

{viewDto.parseXmlStr2Dto(msg);}if

(ObjectUtils.isEmpty(returnJobDetails))

{returnJobDetails

jobName).getData();BeanUtils.copyProperties(dto,

jobDto);}}return

ResultDto.buildSuccess(viewDto)

ResultDto.buildError(viewDto).msg(msg);}/***

拷贝或重命名View**

Jenkins地址比如http://10.100.57.156:8080*

param

(!oldViewInfoResult.ifSuccess())

{return

oldViewInfoResult.getData();BeanUtils.copyProperties(oldViewInfo,

newViewInfo);newViewInfo.setViewName(newViewName);//2、拷贝目标View内容并重命名ResultDto

createResult

(CollectionUtils.isEmpty(jobDtoList))

{return

jobDtoList.get(i).getJobName();}ResultDto

addJob2ViewResult

(!addJob2ViewResult.ifSuccess())

{return

ResultDto.buildSuccessDto();}}/***

param

Jenkins地址比如http://10.100.57.156:8080*

param

操作create-view、update-view、delete-view*

return

class\hudson.model.View$PropertyList\/\n

jobNames\n

class\java.lang.String$CaseInsensitiveComparator\/\n

/jobNames\n

hudson.views.LastSuccessColumn/\n

hudson.views.LastFailureColumn/\n

hudson.views.LastStableColumn/\n

hudson.views.LastDurationColumn/\n

hudson.views.BuildButtonColumn/\n

jenkins.branch.DescriptionColumn

/\n

(StringUtils.hasText(viewDto.getIncludeRegex()))

{xml

Operation.UPDATE.equals(op);String[]

finalArgs

ResultDto.SUCCESS.equals(String.valueOf(code))

ResultDto.buildErrorDto().msg(msg);}}public

static

获取Jenkins版本信息*/VERSION(version,

获取Jenkins版本信息),/***

更新Jenkins全局配置信息*/RELOAD_CONFIGURATION(reload-configuration,

重启Jenkins服务),/***

builds.*/SAFE_RESTART(safe-restart,

重启Jenkins服务),/***

停止Jenkins服务*/SHUTDOWN(shutdown,

停止Jenkins服务),/***

Jenkins.*/SAFE_SHUTDOWN(safe-shutdown,

安全停止Jenkins服务),/***

queue.*/CLEAR_QUEUE(clear-queue,

清除Jenkins中的构建队列),;SetterGetterprivate

String

{this.setOp(op);this.setDesc(desc);}}/***

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Jenkins地址比如http://10.100.57.156:8080*

param

Operation.RELOAD_CONFIGURATION);}/***

基本操作**

Jenkins地址比如http://10.100.57.156:8080*

param

ResultDto.SUCCESS.equals(String.valueOf(code))

?ResultDto.buildSuccessDto(successMsg)

ResultDto.buildErrorDto().msg(msg);}}/***

调用Jenkins

注意查询类时xml为空涉及到使用xml内容创建、更新操作的xml不能为空**

param

Jenkins地址比如http://10.100.57.156:8080*

param

(!StringUtils.hasText(protocol))

{protocol

xml.getBytes(StandardCharsets.UTF_8);}CLI

cli

Stream.concat(Arrays.stream(baseArgs),

Arrays.stream(args)).toArray(String[]::new);log.info(executing

command:

JsonUtil.toJSONString(finalArgs));try

xmlData);}

e.getMessage();log.error(executing

command:

JsonUtil.toJSONString(finalArgs),

e);}return

uri.getScheme());CredentialsProvider

credsProvider

BasicCredentialsProvider();credsProvider.setCredentials(new

uri.getPort()),

UsernamePasswordCredentials(username,

password));AuthCache

BasicScheme();authCache.put(host,

httpClient

HttpClients.custom().setDefaultCredentialsProvider(credsProvider).build();HttpGet

httpGet

HttpClientContext.create();localContext.setAuthCache(authCache);if

{clz

EntityUtils.toString(response.getEntity());System.out.println(returnMsg);if

(StringUtils.hasText(returnMsg))

{data

ResultDto.buildSuccessDto().data(data);}return

ResultDto.buildSuccessDto().data(returnMsg);}

catch

ResultDto.buildErrorDto().data(data);}}