Fixed #276: Support to trigger a parameterized build with file parameters (#278)

Fixed #276
 * Support to trigger a parameterized build with file parameters
 * Support to trigger a parameterized build with file parameters by using 
    "triggerJobAndWaitUntilFinished" method.
 * fix merge error and use overload to avoid changing the contract of post method

Author: zxq1002

jenkins-client/pom.xml

@@ -71,6 +71,16 @@
       <artifactId>httpclient</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.apache.httpcomponents</groupId>
+      <artifactId>httpcore</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.httpcomponents</groupId>
+      <artifactId>httpmime</artifactId>
+    </dependency>
+
     <dependency>
       <groupId>jaxen</groupId>
       <artifactId>jaxen</artifactId>

jenkins-client/src/main/java/com/offbytwo/jenkins/JenkinsTriggerHelper.java

@@ -1,5 +1,6 @@
 package com.offbytwo.jenkins;
 
+import java.io.File;
 import java.io.IOException;
 import java.util.Map;
 
@@ -89,6 +90,49 @@ public BuildWithDetails triggerJobAndWaitUntilFinished(String jobName, Map<Strin
         return triggerJobAndWaitUntilFinished(jobName, queueRef);
     }
 
+    /**
+     * This method will trigger a build of the given job and will wait until the
+     * builds is ended or if the build has been cancelled.
+     *
+     * @param jobName The name of the job which should be triggered.
+     * @param params the job parameters
+     * @param fileParams the job file parameters
+     * @param crumbFlag set to <code>true</code> or <code>false</code>.
+     * @return In case of an cancelled job you will get
+     *         {@link BuildWithDetails#getResult()}
+     *         {@link BuildResult#CANCELLED}. So you have to check first if the
+     *         build result is {@code CANCELLED}.
+     * @throws IOException in case of errors.
+     * @throws InterruptedException In case of interrupts.
+     */
+    public BuildWithDetails triggerJobAndWaitUntilFinished(String jobName, Map<String, String> params,
+                                                           Map<String, File> fileParams,
+                                                           boolean crumbFlag) throws IOException, InterruptedException {
+        JobWithDetails job = this.server.getJob(jobName);
+        QueueReference queueRef = job.build(params, fileParams, crumbFlag);
+
+        return triggerJobAndWaitUntilFinished(jobName, queueRef);
+    }
+
+    /**
+     * This method will trigger a build of the given job and will wait until the
+     * builds is ended or if the build has been cancelled.
+     *
+     * @param jobName The name of the job which should be triggered.
+     * @param params the job parameters
+     * @param fileParams the job file parameters
+     * @return In case of an cancelled job you will get
+     *         {@link BuildWithDetails#getResult()}
+     *         {@link BuildResult#CANCELLED}. So you have to check first if the
+     *         build result is {@code CANCELLED}.
+     * @throws IOException in case of errors.
+     * @throws InterruptedException In case of interrupts.
+     */
+    public BuildWithDetails triggerJobAndWaitUntilFinished(String jobName, Map<String, String> params,
+                                                           Map<String, File> fileParams) throws IOException, InterruptedException {
+        return triggerJobAndWaitUntilFinished(jobName, params, fileParams, false);
+    }
+
     /**
      * This method will trigger a build of the given job and will wait until the
      * builds is ended or if the build has been cancelled.

jenkins-client/src/main/java/com/offbytwo/jenkins/client/JenkinsHttpClient.java

@@ -17,6 +17,8 @@
 import net.sf.json.JSONObject;
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang.StringUtils;
+import org.apache.http.Header;
+import org.apache.http.HttpEntity;
 import org.apache.http.HttpResponse;
 import org.apache.http.NameValuePair;
 import org.apache.http.auth.AuthScope;
@@ -28,6 +30,9 @@
 import org.apache.http.client.methods.HttpRequestBase;
 import org.apache.http.entity.ContentType;
 import org.apache.http.entity.StringEntity;
+import org.apache.http.entity.mime.HttpMultipartMode;
+import org.apache.http.entity.mime.MultipartEntityBuilder;
+import org.apache.http.entity.mime.content.FileBody;
 import org.apache.http.impl.auth.BasicScheme;
 import org.apache.http.impl.client.BasicCredentialsProvider;
 import org.apache.http.impl.client.CloseableHttpClient;
@@ -39,6 +44,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
@@ -204,14 +210,22 @@ public InputStream getFile(URI path) throws IOException {
      */
     @Override
     public <R extends BaseModel, D> R post(String path, D data, Class<R> cls) throws IOException {
-        return post(path, data, cls, true);
+        return post(path, data, cls, null, true);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public <R extends BaseModel, D> R post(String path, D data, Class<R> cls, boolean crumbFlag) throws IOException {
+        return post(path, data, cls, null, crumbFlag);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public <R extends BaseModel, D> R post(String path, D data, Class<R> cls, Map<String, File> fileParams, boolean crumbFlag) throws IOException {
         HttpPost request = new HttpPost(UrlUtils.toJsonApiUri(uri, context, path));
         if (crumbFlag == true) {
             Crumb crumb = getQuietly("/crumbIssuer", Crumb.class);
@@ -225,6 +239,21 @@ public <R extends BaseModel, D> R post(String path, D data, Class<R> cls, boolea
             StringEntity stringEntity = new StringEntity(value, ContentType.APPLICATION_JSON);
             request.setEntity(stringEntity);
         }
+
+        // Prepare file parameters
+        if(fileParams != null && !(fileParams.isEmpty())) {
+            MultipartEntityBuilder builder = MultipartEntityBuilder.create();
+            builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
+
+            for (Map.Entry<String, File> entry : fileParams.entrySet()) {
+                FileBody fileBody = new FileBody(entry.getValue());
+                builder.addPart(entry.getKey(), fileBody);
+            }
+
+            HttpEntity entity = builder.build();
+            request.setEntity(entity);
+        }
+
         HttpResponse response = client.execute(request, localContext);
         jenkinsVersion = ResponseUtils.getJenkinsVersion(response);
 
@@ -392,15 +421,15 @@ public String post_text(String path, String textData, ContentType contentType, b
      */
     @Override
     public void post(String path) throws IOException {
-        post(path, null, null, false);
+        post(path, null, null, null, false);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void post(String path, boolean crumbFlag) throws IOException {
-        post(path, null, null, crumbFlag);
+        post(path, null, null,null, crumbFlag);
     }
 
     /**

jenkins-client/src/main/java/com/offbytwo/jenkins/client/JenkinsHttpConnection.java

@@ -7,6 +7,7 @@
 
 import com.offbytwo.jenkins.model.BaseModel;
 import java.io.Closeable;
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
@@ -109,6 +110,21 @@ public interface JenkinsHttpConnection extends Closeable {
      */
     <R extends BaseModel, D> R post(String path, D data, Class<R> cls, boolean crumbFlag) throws IOException;
 
+    /**
+     * Perform a POST request and parse the response to the given class
+     *
+     * @param path path to request, can be relative or absolute
+     * @param data data to post
+     * @param cls class of the response
+     * @param fileParams file parameters
+     * @param <R> type of the response
+     * @param <D> type of the data
+     * @param crumbFlag true / false.
+     * @return an instance of the supplied class
+     * @throws IOException in case of an error.
+     */
+    <R extends BaseModel, D> R post(String path, D data, Class<R> cls, Map<String, File> fileParams, boolean crumbFlag) throws IOException;
+
     /**
      * Perform POST request that takes no parameters and returns no response
      *

jenkins-client/src/main/java/com/offbytwo/jenkins/model/Job.java

@@ -9,6 +9,7 @@
 import static org.apache.commons.lang.StringUtils.join;
 
 import java.io.ByteArrayOutputStream;
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
@@ -102,27 +103,52 @@ public QueueReference build(boolean crumbFlag) throws IOException {
     }
 
     /**
-     * Trigger a parameterized build
+     * Trigger a parameterized build with string parameters only
      *
      * @param params the job parameters
      * @return {@link QueueReference} for further analysis of the queued build.
      * @throws IOException in case of an error.
      */
     public QueueReference build(Map<String, String> params) throws IOException {
-        return build(params, false);
+        return build(params, null,false);
     }
 
     /**
-     * Trigger a parameterized build
+     * Trigger a parameterized build with string parameters only
      *
      * @param params the job parameters
-     * @param crumbFlag determines whether crumb flag is used
+     * @param crumbFlag true or false.
      * @return {@link QueueReference} for further analysis of the queued build.
      * @throws IOException in case of an error.
      */
     public QueueReference build(Map<String, String> params, boolean crumbFlag) throws IOException {
+        return build(params,null,crumbFlag);
+    }
+
+    /**
+     * Trigger a parameterized build with file parameters
+     *
+     * @param params the job parameters
+     * @param fileParams the job file parameters
+     * @return {@link QueueReference} for further analysis of the queued build.
+     * @throws IOException in case of an error.
+     */
+    public QueueReference build(Map<String, String> params, Map<String, File> fileParams) throws IOException {
+        return build(params,fileParams,false);
+    }
+
+    /**
+     * Trigger a parameterized build with file parameters and crumbFlag
+     *
+     * @param params the job parameters
+     * @param fileParams the job file parameters
+     * @param crumbFlag determines whether crumb flag is used
+     * @return {@link QueueReference} for further analysis of the queued build.
+     * @throws IOException in case of an error.
+     */
+    public QueueReference build(Map<String, String> params, Map<String, File> fileParams, boolean crumbFlag) throws IOException {
         String qs = join(Collections2.transform(params.entrySet(), new MapEntryToQueryStringPair()), "&");
-        ExtractHeader location = client.post(url + "buildWithParameters?" + qs, null, ExtractHeader.class, crumbFlag);
+        ExtractHeader location = client.post(url + "buildWithParameters?" + qs,null, ExtractHeader.class, fileParams, crumbFlag);
         return new QueueReference(location.getLocation());
     }
 

pom.xml

@@ -61,6 +61,8 @@
     <guava.version>17.0</guava.version>
     <json-lib.version>2.4</json-lib.version>
     <httpclient.version>4.3.6</httpclient.version>
+    <httpcore.version>4.3.3</httpcore.version>
+    <httpmime.version>4.3.6</httpmime.version>
     <jackson-databind.version>2.3.4</jackson-databind.version>
   </properties>
 
@@ -148,6 +150,18 @@
         <version>${httpclient.version}</version>
       </dependency>
 
+      <dependency>
+        <groupId>org.apache.httpcomponents</groupId>
+        <artifactId>httpcore</artifactId>
+        <version>${httpcore.version}</version>
+      </dependency>
+
+      <dependency>
+          <groupId>org.apache.httpcomponents</groupId>
+          <artifactId>httpmime</artifactId>
+          <version>${httpmime.version}</version>
+      </dependency>
+
       <dependency>
         <groupId>jaxen</groupId>
         <artifactId>jaxen</artifactId>