一个Java Jenkins工具类,支持创建,构建,带参数构建,删除JenkinsJob,停止Jenkins Job任务等

半兽人 发表于: 2017-12-07   最后更新时间: 2017-12-07  
  •   0 订阅,486 游览

Jenkins是一个很强大的持续集成的工具,除了在Jenkins的页面上我们可以去构建我们的job,我们也可以通过java代码来通过调用jenkins的api来做一些事情,使得我们的java web项目更加便捷,下面是我的一个工具类。

package com.vip.webpagetest.utils;  

import java.io.InputStream;  
import java.util.ArrayList;  
import java.util.HashMap;  
import java.util.List;  
import java.util.Map;  

import org.apache.http.Consts;  
import org.apache.http.HttpEntity;  
import org.apache.http.NameValuePair;  
import org.apache.http.auth.AuthScope;  
import org.apache.http.auth.UsernamePasswordCredentials;  
import org.apache.http.client.CredentialsProvider;  
import org.apache.http.client.entity.UrlEncodedFormEntity;  
import org.apache.http.client.methods.CloseableHttpResponse;  
import org.apache.http.client.methods.HttpGet;  
import org.apache.http.client.methods.HttpPost;  
import org.apache.http.client.protocol.HttpClientContext;  
import org.apache.http.entity.InputStreamEntity;  
import org.apache.http.impl.client.BasicCredentialsProvider;  
import org.apache.http.impl.client.CloseableHttpClient;  
import org.apache.http.message.BasicNameValuePair;  
import org.apache.http.util.EntityUtils;  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
import org.springframework.core.io.ClassPathResource;  
import org.springframework.core.io.Resource;  

import static com.jayway.restassured.path.json.JsonPath.with;  

public class JenkinsUtil {  

    private static final Logger logger = LoggerFactory.getLogger(JenkinsUtil.class);  
    String jenkinsBaseUrl = ClassPathPropertiesUtils.getProperty("jenkins.baseurl");  
    String userName = ClassPathPropertiesUtils.getProperty("jenkins.userName");  
    String apiToken = ClassPathPropertiesUtils.getProperty("jenkins.apiToken");  
    private CloseableHttpClient httpClient = HttpClientPool.getHttpClient();  

    /** 
     * 创建Jenkins Job 
     *  
     * @param jobName 
     * @throws Exception 
     */  
    public void creatJenkinsJob(String jobName) {  
        if (isJenkinsJobExist(jobName)) {  
            logger.info("已经存在job:" + jobName);  
        } else {  
            HttpPost httpPost = new HttpPost(jenkinsBaseUrl + "/createItem?name=" + jobName);  
            Resource resource = new ClassPathResource("config.xml");  
            try {  
                InputStream fileInput = resource.getInputStream();  
                InputStreamEntity entity = new InputStreamEntity(fileInput);  
                entity.setContentEncoding("UTF-8");  
                entity.setContentType("text/xml");  
                httpPost.setEntity(entity);  
                httpClient.execute(httpPost, this.getHttpClientContext());  
            } catch (Exception e) {  
                e.printStackTrace();  
            }  
            logger.info("成功创建job:" + jobName);  
        }  
    }  

    /** 
     * 查询是否存在名为jobName的job 
     *  
     * @param jobName 
     * @return 
     * @throws Exception 
     */  
    public boolean isJenkinsJobExist(String jobName) {  
        HttpGet httpGet = new HttpGet(jenkinsBaseUrl + "/api/json");  
        CloseableHttpResponse rsp = null;  
        try {  
            rsp = httpClient.execute(httpGet, this.getHttpClientContext());  
            HttpEntity entity = rsp.getEntity();  
            String result = EntityUtils.toString(entity);  
            List<String> jobList = with(result).getList("jobs.name");  
            for (String job : jobList) {  
                if (jobName.equals(job)) {  
                    return true;  
                }  
            }  
        } catch (Exception e) {  
            logger.error(null, e);  
            return false;  
        }  
        return false;  
    }  

    /** 
     * 删除Jenkins Job 
     *  
     * @param jobName 
     * @throws Exception 
     */  
    public void deleteJenkinsJob(String jobName) {  
        if (!isJenkinsJobExist(jobName)) {  
            logger.info("不存在job:" + jobName);  
        } else {  
            HttpPost httpPost = new HttpPost(jenkinsBaseUrl + "/job/" + jobName + "/doDelete");  
            try {  
                httpClient.execute(httpPost, this.getHttpClientContext());  
            } catch (Exception e) {  
                e.printStackTrace();  
            }  
        }  
    }  

    /** 
     * 构建触发Jenkins Job 
     *  
     * @param jobName 
     * @throws Exception 
     */  
    public boolean buildJenkinsJob(String jobName) {  
        if (!isJenkinsJobExist(jobName)) {  
            logger.info("不存在job:" + jobName);  
            return false;  
        } else {  
            HttpPost httpPost = new HttpPost(jenkinsBaseUrl + "/job/" + jobName + "/build");  
            try {  
                httpClient.execute(httpPost, this.getHttpClientContext());  
            } catch (Exception e) {  
                e.printStackTrace();  
                return false;  
            }  
        }  
        return true;  
    }  

    /** 
     * 带参数的构建 
     *  
     * @param jobName 
     * @param parameters 
     * @return 
     */  
    public boolean buildJenkinsJobWithParameters(String jobName, Map<String, String> parameters) {  
        if (!isJenkinsJobExist(jobName)) {  
            logger.info("不存在job:" + jobName);  
            return false;  
        } else {  
            HttpPost httpPost = new HttpPost(jenkinsBaseUrl + "/job/" + jobName + "/buildWithParameters");  
            List<NameValuePair> formparams = new ArrayList<NameValuePair>();  
            for (String key : parameters.keySet()) {  
                formparams.add(new BasicNameValuePair(key, parameters.get(key)));  
            }  
            UrlEncodedFormEntity urlEntity = new UrlEncodedFormEntity(formparams, Consts.UTF_8);  
            CloseableHttpResponse rsp = null;  
            try {  
                httpPost.setEntity(urlEntity);  
                rsp = httpClient.execute(httpPost, this.getHttpClientContext());  
            } catch (Exception e) {  
                logger.error(null, e);  
                return false;  
            }  
            return true;  
        }  
    }  

    /** 
     * 终止Jenkins Job构建 
     *  
     * @param jobName 
     * @return 
     * @throws Exception 
     */  
    public boolean stopJenkinsJob(String jobName) {  
        if (!isJenkinsJobExist(jobName)) {  
            logger.info("不存在job:" + jobName);  
            return false;  
        } else {  
            HttpPost httpPost = new HttpPost(jenkinsBaseUrl + "/job/" + jobName + "/api/json");  
            CloseableHttpResponse resp = null;  
            try {  
                resp = httpClient.execute(httpPost, this.getHttpClientContext());  
                HttpEntity entity = resp.getEntity();  
                String result = EntityUtils.toString(entity);  
                int buildNumber = with(result).get("lastBuild.number");  
                HttpPost stopJenkinsRequest = new HttpPost(  
                        jenkinsBaseUrl + "/job/" + jobName + "/" + buildNumber + "/stop");  
                httpClient.execute(stopJenkinsRequest, this.getHttpClientContext());  
            } catch (Exception e) {  
                e.printStackTrace();  
                return false;  
            }  
            return true;  
        }  
    }  

    private HttpClientContext getHttpClientContext() {  
        HttpClientContext httpClientContext = HttpClientContext.create();  
        httpClientContext.setCredentialsProvider(this.getCredentialsProvider());  
        // httpClientContext.setAuthCache(this.getAuthCache());  
        return httpClientContext;  
    }  

    private CredentialsProvider getCredentialsProvider() {  
        CredentialsProvider credsProvider = new BasicCredentialsProvider();  
        credsProvider.setCredentials(new AuthScope(AuthScope.ANY), new UsernamePasswordCredentials(userName, apiToken));  
        return credsProvider;  
    }  

    public static void main(String[] args) throws Exception {  
        Map<String, String> parameters = new HashMap<String, String>();  
        parameters.put("domain", "xxx");  
        parameters.put("run_id", "222");  
        JenkinsUtil test = new JenkinsUtil();  
        test.buildJenkinsJobWithParameters("xxx", parameters);  
    }  
}






发表于: 5月前   最后更新时间: 5月前   游览量:486
上一条: Mac忘记root密码,重新创建密码
下一条: 如何清除jenkins job历史build

评论…


  • 评论…
    • in this conversation
      提问