AGDIGGER-59 trigger jenkins job

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2

.gitignore

@@ -1,4 +1,5 @@
 target/
+
 pom.xml.tag
 pom.xml.releaseBackup
 pom.xml.versionsBackup
@@ -7,7 +8,11 @@ release.properties
 dependency-reduced-pom.xml
 buildNumber.properties
 .mvn/timing.properties
-.idea
-jenkins-client.iml
+
 # Exclude maven wrapper
 !/.mvn/wrapper/maven-wrapper.jar
+
+# Intellij Idea files
+.idea
+*.iml
+

pom.xml

@@ -21,13 +21,23 @@
         <dependency>
             <groupId>com.offbytwo.jenkins</groupId>
             <artifactId>jenkins-client</artifactId>
-            <version>0.3.6</version>
+            <version>0.3.7-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>org.jtwig</groupId>
             <artifactId>jtwig-core</artifactId>
             <version>5.65</version>
         </dependency>
+      <dependency>
+        <groupId>org.slf4j</groupId>
+        <artifactId>slf4j-api</artifactId>
+        <version>1.7.21</version>
+      </dependency>
+      <dependency>
+        <groupId>org.slf4j</groupId>
+        <artifactId>slf4j-log4j12</artifactId>
+        <version>1.7.21</version>
+      </dependency>
     </dependencies>
     <repositories>
         <repository>
@@ -48,4 +58,4 @@
             </plugin>
         </plugins>
     </build>
-</project>
+</project>

src/main/java/com/redhat/digkins/DiggerClient.java

@@ -2,31 +2,56 @@
 
 import com.offbytwo.jenkins.JenkinsServer;
 import com.redhat.digkins.services.CreateJobService;
-import com.redhat.digkins.util.JenkinsAuth;
+import com.redhat.digkins.services.TriggerBuildService;
 import com.redhat.digkins.util.DiggerClientException;
+import com.redhat.digkins.util.JenkinsAuth;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
+import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
 
 /**
- * Digger Java Client
- * <p>
- * Interact with digger jenkins api!
+ * Digger Java Client interact with Digger Jenkins api.
  */
 public class DiggerClient {
 
+  private static final Logger LOG = LoggerFactory.getLogger(DiggerClient.class);
+
+  public static final long DEFAULT_BUILD_TIMEOUT = 60 * 1000;
+
   private final JenkinsServer jenkins;
 
   public DiggerClient(JenkinsAuth auth) throws URISyntaxException {
     this.jenkins = new JenkinsServer(new URI(auth.getUrl()), auth.getUser(), auth.getPassword());
   }
 
   /**
-   * Create new digger job on jenkins platform
+   * Create client using provided url and credentials
    *
-   * @param name      - job name that can be used later to reference job
-   * @param gitRepo   - git repository url (full git repository url. e.g [email protected]:wtrocki/helloworld-android-gradle.git
-   * @param gitBranch - git repository branch (default branch used to checkout source code)
+   * @param url      Jenkins url
+   * @param user     Jenkins user
+   * @param password Jenkins password
+   * @return client instance
+   * @throws DiggerClientException if something goes wrong
+   */
+  public static DiggerClient from(String url, String user, String password) throws DiggerClientException {
+    try {
+      JenkinsAuth jenkinsAuth = new JenkinsAuth(url, user, password);
+      return new DiggerClient(jenkinsAuth);
+    } catch (URISyntaxException e) {
+      throw new DiggerClientException("Invalid jenkins url format.");
+    }
+  }
+
+  /**
+   * Create new Digger job on Jenkins platform
+   *
+   * @param name      job name that can be used later to reference job
+   * @param gitRepo   git repository url (full git repository url. e.g [email protected]:wtrocki/helloworld-android-gradle.git
+   * @param gitBranch git repository branch (default branch used to checkout source code)
+   * @throws DiggerClientException if something goes wrong
    */
   public void createJob(String name, String gitRepo, String gitBranch) throws DiggerClientException {
     CreateJobService service = new CreateJobService(this.jenkins);
@@ -38,19 +63,49 @@ public void createJob(String name, String gitRepo, String gitBranch) throws Digg
   }
 
   /**
-   * Create client using provided url and credentials
+   * Triggers a build for the given job and waits until it leaves the queue and actually starts.
+   * <p>
+   * Jenkins puts the build requests in a queue and once there is a slave available, it starts building
+   * it and a build number is assigned to the build.
+   * <p>
+   * This method will block until there is a build number, or the given timeout period is passed. If the build is still in the queue
+   * after the given timeout period, -1 is returned as the build number.
+   * <p>
+   * Please note that timeout period is never meant to be very precise. It has the resolution of {@link TriggerBuildService#POLL_PERIOD} because
+   * timeout is checked before every pull.
+   * <p>
+   * Similarly, -1 is returned if the build is stuck or cancelled on Jenkins side.
    *
-   * @param url      - jenkins url
-   * @param user     - jenkins user
-   * @param password - jenkins password
-   * @return client instance
+   * @param jobName name of the job to trigger the build
+   * @param timeout how many milliseconds should this call block before returning -1. Should be larger than {@link TriggerBuildService#FIRST_CHECK_DELAY}
+   * @return the build number. -1 if build is cancelled, stuck or in queue more than the given timeout period
+   * @throws DiggerClientException if connection problems occur during connecting to Jenkins
    */
-  public static DiggerClient from(String url, String user, String password) throws DiggerClientException {
+  public long build(String jobName, long timeout) throws DiggerClientException {
+    final TriggerBuildService triggerBuildService = new TriggerBuildService(jenkins);
     try {
-      JenkinsAuth jenkinsAuth = new JenkinsAuth(url, user, password);
-      return new DiggerClient(jenkinsAuth);
-    } catch (URISyntaxException e) {
-      throw new DiggerClientException("Invalid jenkins url format.");
+      return triggerBuildService.build(jobName, timeout);
+    } catch (IOException e) {
+      LOG.debug("Exception while connecting to Jenkins", e);
+      throw new DiggerClientException(e);
+    } catch (InterruptedException e) {
+      LOG.debug("Exception while sleeping between checks", e);
+      throw new DiggerClientException(e);
     }
   }
+
+  /**
+   * Triggers a build for the given job and waits until it leaves the queue and actually starts.
+   * <p>
+   * Calls {@link #build(String, long)} with a default timeout of {@link #DEFAULT_BUILD_TIMEOUT}.
+   *
+   * @param jobName name of the job
+   * @return the build number
+   * @throws DiggerClientException if connection problems occur during connecting to Jenkins
+   * @see #build(String, long)
+   */
+  public long build(String jobName) throws DiggerClientException {
+    return this.build(jobName, DEFAULT_BUILD_TIMEOUT);
+  }
+
 }

src/main/java/com/redhat/digkins/services/CreateJobService.java

@@ -1,24 +1,23 @@
 package com.redhat.digkins.services;
 
 import com.offbytwo.jenkins.JenkinsServer;
-import org.apache.commons.io.FileUtils;
 import org.jtwig.JtwigModel;
 import org.jtwig.JtwigTemplate;
 
-import java.io.File;
 import java.io.IOException;
 
 /**
  * Create digger job on jenkins platform
  */
 public class CreateJobService {
 
-  private JenkinsServer jenkins;
+  private final static String GIT_REPO_URL = "GIT_REPO_URL";
+  private final static String GIT_REPO_BRANCH = "GIT_REPO_BRANCH";
 
-  private final static String GIT_REPO_URL = "GIT_REPO_URL", GIT_REPO_BRANCH = "GIT_REPO_BRANCH";
+  private JenkinsServer jenkins;
 
   /**
-   * @param jenkins - jenkins api instance
+   * @param jenkins jenkins api instance
    */
   public CreateJobService(JenkinsServer jenkins) {
     this.jenkins = jenkins;
@@ -27,9 +26,9 @@ public CreateJobService(JenkinsServer jenkins) {
   /**
    * Create new digger job on jenkins platform
    *
-   * @param name      - job name that can be used later to reference job
-   * @param gitRepo   - git repository url (full git repository url. e.g [email protected]:digger/helloworld.git
-   * @param gitBranch - git repository branch (default branch used to checkout source code)
+   * @param name      job name that can be used later to reference job
+   * @param gitRepo   git repository url (full git repository url. e.g [email protected]:digger/helloworld.git
+   * @param gitBranch git repository branch (default branch used to checkout source code)
    */
   public void create(String name, String gitRepo, String gitBranch) throws IOException {
     JtwigTemplate template = JtwigTemplate.classpathTemplate("templates/job.xml");

src/main/java/com/redhat/digkins/services/TriggerBuildService.java

@@ -0,0 +1,116 @@
+package com.redhat.digkins.services;
+
+import com.offbytwo.jenkins.JenkinsServer;
+import com.offbytwo.jenkins.model.Executable;
+import com.offbytwo.jenkins.model.JobWithDetails;
+import com.offbytwo.jenkins.model.QueueItem;
+import com.offbytwo.jenkins.model.QueueReference;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+
+/**
+ * Provides functionality to trigger a build.
+ **/
+public class TriggerBuildService {
+
+  private static final Logger LOG = LoggerFactory.getLogger(TriggerBuildService.class);
+
+  /**
+   * How long should we wait before we start checking the queue item status.
+   */
+  public static final long FIRST_CHECK_DELAY = 5 * 1000L;
+
+  /**
+   * How long should we wait before checking the queue item status for next time.
+   */
+  public static final long POLL_PERIOD = 2 * 1000L;
+
+
+  private JenkinsServer jenkins;
+
+  /**
+   * @param jenkins jenkins api instance
+   */
+  public TriggerBuildService(JenkinsServer jenkins) {
+    this.jenkins = jenkins;
+  }
+
+  /**
+   * See the documentation in {@link com.redhat.digkins.DiggerClient#build(String, long)}
+   *
+   * @param jobName name of the job
+   * @param timeout timeout
+   * @return the build number
+   * @throws IOException          if connection problems occur during connecting to Jenkins
+   * @throws InterruptedException if a problem occurs during sleeping between checks
+   * @see com.redhat.digkins.DiggerClient#build(String, long)
+   */
+  public long build(String jobName, long timeout) throws IOException, InterruptedException {
+    final long timeoutTime = System.currentTimeMillis() + timeout;
+
+    LOG.debug("Going to build job with name: {}", jobName);
+    LOG.debug("Going to timeout in {} msecs if build didn't start executing", timeout);
+
+    JobWithDetails job = jenkins.getJob(jobName);
+    if (job == null) {
+      throw new IllegalArgumentException("Unable to find job for name '" + jobName + "'");
+    }
+
+    final QueueReference queueReference = job.build();
+    if (queueReference == null) {
+      // this is probably an implementation problem we have here
+      throw new IllegalStateException("Queue reference cannot be null!");
+    }
+    LOG.debug("Build triggered; queue item reference: {}", queueReference.getQueueItemUrlPart());
+
+    // wait for N seconds, then fetch the queue item.
+    // do it until we have an executable.
+    // we would have an executable when the build leaves queue and starts building.
+
+    LOG.debug("Going to sleep {} msecs", FIRST_CHECK_DELAY);
+    Thread.sleep(FIRST_CHECK_DELAY);
+
+    QueueItem queueItem;
+    while (true) {
+      queueItem = jenkins.getQueueItem(queueReference);
+      LOG.debug("Queue item : {}", queueItem);
+
+      if (queueItem == null) {
+        // this is probably an implementation problem we have here
+        throw new IllegalStateException("Queue item cannot be null!");
+      }
+
+      LOG.debug("Build item cancelled:{}, blocked:{}, buildable:{}, stuck:{}", queueItem.isCancelled(), queueItem.isBlocked(), queueItem.isBuildable(), queueItem.isStuck());
+
+      if (queueItem.isCancelled()) {
+        LOG.debug("Queue item is cancelled. Returning -1");
+        return -1;
+      } else if (queueItem.isStuck()) {
+        LOG.debug("Queue item is stuck. Returning -1");
+        return -1;
+      }
+
+      // do not return -1 if blocked.
+      // we will wait until it is unblocked.
+
+      final Executable executable = queueItem.getExecutable();
+
+      if (executable != null) {
+        LOG.debug("Build has an executable. Returning build number: {}", executable.getNumber());
+        return executable.getNumber();
+      } else {
+        LOG.debug("Build did not start executing yet.");
+        if (timeoutTime < System.currentTimeMillis()) {
+          LOG.debug("Timeout period has not exceeded yet. Sleeping for {} msecs", POLL_PERIOD);
+          Thread.sleep(POLL_PERIOD);
+        } else {
+          LOG.debug("Timeout period has exceeded. Returning -1.");
+          return -1;
+        }
+      }
+
+    }
+  }
+}

src/main/java/com/redhat/digkins/util/DiggerClientException.java

@@ -1,7 +1,5 @@
 package com.redhat.digkins.util;
 
-import java.util.TreeMap;
-
 /**
  * Represents internal client exception
  */

src/main/java/com/redhat/digkins/util/JenkinsAuth.java

@@ -2,6 +2,8 @@
 
 /**
  * Jenkins authentication object.
+ * <p>
+ * Holds credentials in it.
  */
 public class JenkinsAuth {
 

src/main/resources/log4j.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
+<log4j:configuration debug="false"
+                     xmlns:log4j='http://jakarta.apache.org/log4j/'>
+
+    <appender name="console" class="org.apache.log4j.ConsoleAppender">
+        <layout class="org.apache.log4j.PatternLayout">
+            <param name="ConversionPattern"
+                   value="%d{yyyy-MM-dd HH:mm:ss} %-5p [%t] %c{1}.%M(%L) - %m%n"/>
+        </layout>
+    </appender>
+
+    <logger name="com.redhat.digkins">
+        <level value="DEBUG"/>
+    </logger>
+
+    <root>
+        <level value="INFO" />
+        <appender-ref ref="console" />
+    </root>
+
+</log4j:configuration>