jenkins的基础API

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.alibaba.fastjson.JSON;
import com.bill99.jenkins.httpclient.HttpClient;
import com.bill99.jenkins.httpclient.JenkinsResponse;

/**

• jenkins的基础API
• @author

*/
public class JenkinsClient {

public static String jenkinsURL;

/**
 * url格式：   http://localhost:8080/jenkins
 * @param url
 */
public JenkinsClient(String url){
    if(url.endsWith("/")){
        jenkinsURL = url.substring(0, url.length()-1);
    }else{
        jenkinsURL = url;
    }
}

public JenkinsClient(String url,String username,String password){
    if(!url.endsWith("/")){
        jenkinsURL = url.substring(0, url.length()-1);
    }else{
        jenkinsURL = url;
    }
}

/**
 * 创建JOB
 *      post    jenkinsBaseURL+ "/createItem?name=" + jobName
 * @param jobName
 * @param xmlConfig
 * @return
 */
public  boolean createJob(String jobName,String xmlConfig){
    String name = null;
    try {
        name = URLEncoder.encode(jobName, "UTF-8");
    } catch (UnsupportedEncodingException e) {
        e.printStackTrace();
    }
    String url = jenkinsURL+"/createItem?name=" + name;
    JenkinsResponse response = HttpClient.postBodyWithXML(url,xmlConfig);
    return (200 == response.getResponseCode()) ? true : false;
};

/**
 * 创建view
 * @param viewName
 * @return
 */
public boolean createListView(String viewName){
    String url = jenkinsURL + "/createView";
    Map<String,String> params = new HashMap<String,String>();
    params.put("name", viewName);
    JenkinsResponse response = HttpClient.postWithParameters(url, params);
    return (200 == response.getResponseCode()) ? true : false;
}

/**
 * 创建用户
 *      POST /securityRealm/createAccount
 * @param userName
 * @param password
 * @return
 */
public boolean createUser(String userName,String password){
    return true;
}

/**
 * POST     更新（修改）job
 * jenkinsBaseURL + "/job/"+ jobName + "/config.xml"
 * @param jobName
 * @param updateXml
 * @return
 */
public  boolean updateJob(String jobName,String updateXml){
    String url = jenkinsURL + "/job/"+ jobName + "/config.xml";
    JenkinsResponse response = HttpClient.postBodyWithXML(url,updateXml);
    return (200 == response.getResponseCode() ) ? true : false;
}

/**
 * POST
 *      复制job   jenkinsBaseURL + "/createItem"
 * @param originJobName
 * @param newJobName    
 * @return
 */
public  boolean copyJob(String originJobName, String newJobName){
    String url = jenkinsURL + "/createItem";
    Map<String,String> params = new HashMap<String,String>();
    params.put("name", newJobName);
    params.put("mode", "copy");
    params.put("from", originJobName);
    JenkinsResponse response = HttpClient.postWithParameters(url, params);
    return (302 == response.getResponseCode()) ? true : false;
}

/**
 * 重命名JOB
 * @param originJobName
 * @param newJobName
 * @return
 */
public boolean renameJob(String originJobName, String newJobName){
    String url = jenkinsURL + "/job/" + originJobName + "/doRename";
    Map<String,String> param = new HashMap<String, String>();
    param.put("newName", newJobName);
    JenkinsResponse response = HttpClient.postWithParameters(url, param);
    return (302 == response.getResponseCode()) ? true : false;
}

/**
 *      删除JOB
 * POST
 * jenkinsBaseURL + "/job/"+ jobName + "/doDelete"
 * @param jobName
 * @return
 */
public  boolean deleteJob(String jobName){
    String url = jenkinsURL + "/job/" + jobName + "/doDelete";
    JenkinsResponse response = HttpClient.postWithOutParameters(url);
    return (302 == response.getResponseCode()) ? true : false;
}

/**
 *  删除view
 *      POST jenkinsURL +"/view/"+ viewName + "/doDelete"
 * @param viewName
 * @return
 */
public boolean deleteView(String viewName){
    String url = jenkinsURL +"/view/"+ viewName + "/doDelete";
    JenkinsResponse response = HttpClient.postWithOutParameters(url);
    return (302 == response.getResponseCode()) ? true : false;
}

/**
 * 删除user
 * POST     "/user/" + userName + "/doDelete
 * @param userName
 * @return
 */
public boolean deleteUser(String userName){
    String url = jenkinsURL + "/user/" + userName + "/doDelete";
    Map<String,String> parameters = new HashMap<String,String>();
    parameters.put("name", userName);
    JenkinsResponse response = HttpClient.postWithParameters(url, parameters);
    return (200 == response.getResponseCode()) ? true : false;
}

/**
 * POST     启用项目
 * jenkinsBaseURL + "/job/"+ jobName + "/enable"
 * @param jobName
 * @return
 */
public  boolean enableJob(String jobName){
    String url = jenkinsURL + "/job/"+ jobName + "/enable";
    JenkinsResponse response = HttpClient.postWithOutParameters(url);
    return (302 == response.getResponseCode()) ? true : false;
}

/**
 * POST    禁用项目
 *      jenkinsBaseURL + "/job/"+ jobName + "/disable"
 * @param jobName
 * @return
 */
public  boolean disableJob(String jobName){
    String url = jenkinsURL + "/job/"+ jobName + "/disable";
    JenkinsResponse response = HttpClient.postWithOutParameters(url);
    return (302 == response.getResponseCode()) ? true : false;
}

/**
 * POST
 * jenkinsBaseURL + "/job/"+ jobName+ "/build"
 * @param jobName
 * @return
 */
public  boolean triggerJob(String jobName){
    String url = jenkinsURL+"/job/" + jobName + "/build";
    JenkinsResponse response = HttpClient.postWithOutParameters(url);
    return (201 == response.getResponseCode()) ? true : false;
}
/**
 * GET
 * jenkinsBaseURL + "/job/"+ jobName+ "/buildWithParameters?param1=value1
 * @param jobName
 * @param parameters
 * @return
 */
public  boolean triggerJobWithParameters(String jobName,Map<String,String> parameters){
    String url = jenkinsURL + "/job/"+ jobName+ "/buildWithParameters";
    JenkinsResponse response = HttpClient.getWithParameters(url, parameters);
    return ((200 == response.getResponseCode())||(201 == response.getResponseCode())) ? true : false;
}

public String triggerJobWithParaReturnBuildNum(String jobName,Map<String,String> parameters){
    String url = jenkinsURL + "/job/"+ jobName+ "/buildWithParameters";
    JenkinsResponse response = HttpClient.getWithParameters(url, parameters);       
    String buildNum="";
    if(200==response.getResponseCode()){
          String pattern = "#(\\d+)(.*)";
          Pattern r = Pattern.compile(pattern);
          Matcher m = r.matcher(response.getResponseBody());
          if (m.find( )) {
             buildNum=m.group(1);
          }
    }
    return buildNum;
}

/**
 * 获取指定构建编号JOB的构建信息</br>
 *      <code> GET  jenkinsURL + "/job/" + jobName + "/" + buildNumber + "/api/json"</code>
 * @param jobName
 * @param buildNumber
 * @return
 */
public String getBuildDetails(String jobName, long buildNumber){
    String url = jenkinsURL + "/job/" + jobName + "/" + buildNumber + "/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    return response.getResponseBody();
}

/**
 *  获取view下所有的jobs</br>
 *      <code>GET jenkinsURL+"/view/MA/api/json"</code>
 * @param viewName
 * @return
 */
public String getJobsWithView(String viewName){
    String url = jenkinsURL + "/view/"+viewName + "/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    return response.getResponseBody();
}

/**
 * 获取正在队列中等待构建的JOB
 *      GET     jenkinsURL + "/queue/api/json"
 * @return
 */
public String getQueueJobs(){
    String url = jenkinsURL + "/queue/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    return response.getResponseBody();
}

/**
 * 根据JOBNAME获取最后一次构建的结果状态
 * @param jobName
 * @return
 */
public String getLastBuildStatus(String jobName){
    String url = jenkinsURL + "/job/"+ jobName +"/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    return JSON.parseObject(response.getResponseBody()).getString("color");
}


/**
 * POST
 *      取消任务队列（排队）中的job
 * /queue/cancelItem?id=" + itemId
 * @param id
 * @return
 */
public boolean cancelQueueJobById(long id){
    String url = jenkinsURL + "/queue/cancelItem";
    Map<String,String> parameters = new HashMap<String,String>();
    parameters.put("id", String.valueOf(id));
    JenkinsResponse response = HttpClient.postWithParameters(url, parameters);
    return (302 == response.getResponseCode()) ? true : false;
}

/**
 * 根据JOBNAME检查JOB是否存在
 *      
 * @param jobName
 * @return
 */
public boolean jobIsExists(String jobName){
    String url = jenkinsURL + "/job/" + jobName +"/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    return (200 == response.getResponseCode()) ? true : false;
}


/**
 *  检查job是否正在构建
 * @param jobName
 * @param buildNumber
 * @return
 */
public boolean isBuilding(String jobName,long buildNumber){
    String result = this.getBuildDetails(jobName, buildNumber);
    return (Boolean) JSON.parseObject(result).get("building");
}


/**
 * 停止正在构建的job
 * @param jobName
 * @return
 */
public  boolean abortBuildJob(String jobName,long buildNumber ){
    String url = jenkinsURL + "/job/" + jobName + "/" + buildNumber + "/stop";
    JenkinsResponse response = HttpClient.postWithOutParameters(url);
    return (302 == response.getResponseCode()) ? true : false;
}

/**
 * 获取jenkins的信息
 *  GET     jenkinsURL + "/api/json"
 * @return
 */
public String getJenkinsApiJson(){
    String url = jenkinsURL + "/api/json";
    JenkinsResponse response = HttpClient.postWithOutParameters(url);
    return response.getResponseBody();
}

/**
 * 获取所有的JOB
 * @return
 */
public List<String> getAllJobs(){
    String result = this.getJenkinsApiJson();
    Object object = JSON.parseObject(result).get("jobs");
    return JSON.parseArray(object.toString(), String.class);
}

/**
 * 
 * @return
 */
public List<String> getAllViews(){
    String result = this.getJenkinsApiJson();
    Object object = JSON.parseObject(result).get("views");
    return JSON.parseArray(object.toString(), String.class);
}

/**
 * 
 * @return
 */
public List<String> getAllUsers(){
    String result = this.getJenkinsApiJson();
    Object object = JSON.parseObject(result).get("users");
    return JSON.parseArray(object.toString(), String.class);
}

/**
 * GET  获取JobDetails
 *      jenkinsBaseURL + "/job/"+ jobName + "/api/json"
 * @param jobName
 * @return
 */
public  String getJobJSON(String jobName){
    String url = jenkinsURL + "/job/" + jobName + "/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    return response.getResponseBody();
}

/**
 * GET 获取job的配置信息(config.xml)
 *      jenkinsBaseURL + "/job/"+ jobName + "/config.xml"
 * @param jobName
 * @return
 */
public String getJobConfigXML(String jobName){
    String url = jenkinsURL + "/job/" + jobName + "/config.xml";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    return response.getResponseBody();
}

/**
 * GET  获取jenkins集群信息（主，从信息）
 *      jenkinsBaseURL + "computer/api/json"
 * @return
 */
public  String getComputers(){
    String url = jenkinsURL + "/computer/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    return response.getResponseBody();
}

/**
 * 根据JOBNAME获取最后一次构建的结果状态
 * @param jobName
 * @return
 */
public String getBuildStatus(String jobName,long buildNumber){
    String url = jenkinsURL + "/job/"+ jobName +"/"+buildNumber+"/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    String result="";
    if(response.getResponseCode()==200){
        result=JSON.parseObject(response.getResponseBody()).getString("result");
        if(result==null){
            if((Boolean) JSON.parseObject(response.getResponseBody()).get("building")){
                result="BUILDING";
            }
            
        }
        if(result.equals("SUCCESS")){
            JenkinsResponse console = HttpClient.getWithOutParameter(jenkinsURL + "/job/"+ jobName +"/"+buildNumber+"/console");
            if(!console.getResponseBody().contains("Total tests run:")){
                result="FAILURE";
            }
        }
    }
    else{
        response = HttpClient.getWithOutParameter(jenkinsURL + "/job/"+ jobName +"/api/json");
        String queueItem=JSON.parseObject(response.getResponseBody()).getString("queueItem");
        if(queueItem!=null && !queueItem.equals("null")){
            result="WAITING";
            String why=JSON.parseObject(queueItem).getString("why");
            if(why==null ||why.contains("offline")){
                result="OFFLINE";
            }
        }

    }
    return result;
}


public boolean hasRunningJob(){
    String url = jenkinsURL + "/computer/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    String busyExecutors=JSON.parseObject(response.getResponseBody()).getString("busyExecutors");
    if(Integer.valueOf(busyExecutors)==0){
        return false;
    }else{
        return true;
    }
}

public boolean hasQueueJob(){
    String url = jenkinsURL + "/queue/api/json";
    JenkinsResponse response = HttpClient.getWithOutParameter(url);
    if(response.getResponseBody().equals("{\"items\":[]}")){
        return false;
    }else{
        return true;
    }
}

}