Added support for Pipeline triggers (#341).

Author: gmessner

src/main/java/org/gitlab4j/api/GitLabApiForm.java

@@ -9,6 +9,7 @@
 import javax.ws.rs.core.MultivaluedHashMap;
 
 import org.gitlab4j.api.models.AccessLevel;
+import org.gitlab4j.api.models.Variable;
 import org.gitlab4j.api.utils.ISO8601;
 
 /**
@@ -194,4 +195,26 @@ public GitLabApiForm withParam(String name, Object value, boolean required) thro
         this.param(name, stringValue);
         return (this);
     }
+
+    /**
+     * Fluent method for adding a List<Variable> type query and form parameters to a get(), post(), or put() call.
+     *
+     * @param variables the List of Variable to add
+     * @return this GitLabAPiForm instance
+     */
+    public GitLabApiForm withParam(List<Variable> variables) {
+
+        if (variables == null || variables.isEmpty()) {
+            return (this);
+        }
+
+        variables.forEach(v -> {
+            String value = v.getValue();
+            if (value != null) {
+                this.param("variables[" + v.getKey() + "]", value);
+            }
+        });
+
+        return (this);
+    }
 }

src/main/java/org/gitlab4j/api/PipelineApi.java

@@ -11,10 +11,16 @@
 import org.gitlab4j.api.models.Pipeline;
 import org.gitlab4j.api.models.PipelineSchedule;
 import org.gitlab4j.api.models.PipelineStatus;
+import org.gitlab4j.api.models.Trigger;
 import org.gitlab4j.api.models.Variable;
 
 /**
- * This class provides an entry point to all the GitLab API pipeline calls.
+ * <p>This class provides an entry point to all the GitLab API pipeline related calls.
+ * For more information on the Pipeline APIs see:</p>
+ *
+ * <a href="https://docs.gitlab.com/ee/api/pipelines.html">Pipelines API</a>
+ * <a href="https://docs.gitlab.com/ee/api/pipeline_schedules.html">Pipeline Schedules API</a>
+ * <a href="https://docs.gitlab.com/ee/api/pipeline_triggers.html">Pipeline Triggers API</a>
  */
 public class PipelineApi extends AbstractApi implements Constants {
 
@@ -314,7 +320,7 @@ public List<PipelineSchedule> getPipelineSchedules(Object projectIdOrPath) throw
      *
      * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
      * @param page the page to get
-     * @param perPage the number of ProjectHook instances per page
+     * @param perPage the number of PipelineSchedule instances per page
      * @return a list of project pipeline_schedules for the specified project in the specified page range
      * @throws GitLabApiException if any exception occurs
      */
@@ -329,7 +335,7 @@ public List<PipelineSchedule> getPipelineSchedules(Object projectIdOrPath, int p
      * <pre><code>GET /projects/:id/pipeline_schedule</code></pre>
      *
      * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
-     * @param itemsPerPage the number of Project instances that will be fetched per page
+     * @param itemsPerPage the number of PipelineSchedule instances that will be fetched per page
      * @return a Pager of project pipeline_schedules for the specified project
      * @throws GitLabApiException if any exception occurs
      */
@@ -356,8 +362,8 @@ public Stream<PipelineSchedule> getPipelineSchedulesStream(Object projectIdOrPat
      * <pre><code>GET /projects/:id/pipeline_schedules/:pipeline_schedule_id</code></pre>
      *
      * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
-     * @param pipelineScheduleId the ID of the hook to get
-     * @return the project hook for the specified project ID/hook ID pair
+     * @param pipelineScheduleId the ID of the pipeline schedule to get
+     * @return the project PipelineSchedule
      * @throws GitLabApiException if any exception occurs
      */
     public PipelineSchedule getPipelineSchedule(Object projectIdOrPath, Integer pipelineScheduleId) throws GitLabApiException {
@@ -372,7 +378,7 @@ public PipelineSchedule getPipelineSchedule(Object projectIdOrPath, Integer pipe
      *
      * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
      * @param pipelineScheduleId the ID of the hook to get
-     * @return the project hook for the specified project ID/hook ID pair as an Optional instance
+     * @return the project PipelineSchedule as an Optional instance
      */
     public Optional<PipelineSchedule> getOptionalPipelineSchedule (Object projectIdOrPath, Integer pipelineScheduleId) {
         try {
@@ -517,4 +523,197 @@ public void deletePipelineScheduleVariable(Object projectIdOrPath, Integer pipel
         delete(expectedStatus, null, "projects", getProjectIdOrPath(projectIdOrPath),
                 "pipeline_schedules", pipelineScheduleId, "variables", key);
     }
+
+    /**
+     * Get a list of the project pipeline triggers for the specified project.
+     *
+     * <pre><code>GET /projects/:id/triggers</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @return a list of pipeline triggers for the specified project
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Trigger> getPipelineTriggers(Object projectIdOrPath) throws GitLabApiException {
+        return (getPipelineTriggers(projectIdOrPath, getDefaultPerPage()).all());
+    }
+
+    /**
+     * Get list of project pipeline triggers in the specified page range.
+     *
+     * <pre><code>GET /projects/:id/triggers</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param page the page to get
+     * @param perPage the number of Trigger instances per page
+     * @return a list of project pipeline triggers for the specified project in the specified page range
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Trigger> getPipelineTriggerss(Object projectIdOrPath, int page, int perPage) throws GitLabApiException {
+        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects", getProjectIdOrPath(projectIdOrPath), "triggers");
+        return (response.readEntity(new GenericType<List<Trigger>>() {}));
+    }
+
+    /**
+     * Get Pager of project pipeline triggers.
+     *
+     * <pre><code>GET /projects/:id/pipeline_schedule</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param itemsPerPage the number of Project instances that will be fetched per page
+     * @return a Pager of project pipeline triggers for the specified project
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Pager<Trigger> getPipelineTriggers(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
+        return (new Pager<Trigger>(this, Trigger.class, itemsPerPage, null, "projects", getProjectIdOrPath(projectIdOrPath), "triggers"));
+    }
+
+    /**
+     * Get a Stream of the project pipeline triggers for the specified project.
+     *
+     * <pre><code>GET /projects/:id/pipeline_schedule</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @return a Stream of project pipeline triggers for the specified project
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Trigger> getPipelineTriggersStream(Object projectIdOrPath) throws GitLabApiException {
+        return (getPipelineTriggers(projectIdOrPath, getDefaultPerPage()).stream());
+    }
+
+    /**
+     * Get a specific pipeline schedule for project.
+     *
+     * <pre><code>GET /projects/:id/triggers/:trigger_id</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param triggerId the ID of the trigger to get
+     * @return the project pipeline trigger
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Trigger getPipelineTrigger(Object projectIdOrPath, Integer triggerId) throws GitLabApiException {
+        Response response = get(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "triggers", triggerId);
+        return (response.readEntity(Trigger.class));
+    }
+
+    /**
+     * Get a specific pipeline trigger for project as an Optional instance.
+     *
+     * <pre><code>GET /projects/:id/triggers/:trigger_id</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param triggerId the ID of the trigger to get
+     * @return the project pipeline trigger as an Optional instance
+     */
+    public Optional<Trigger> getOptionalPipelineTrigger(Object projectIdOrPath, Integer triggerId) {
+        try {
+            return (Optional.ofNullable(getPipelineTrigger(projectIdOrPath, triggerId)));
+        } catch (GitLabApiException glae) {
+            return (GitLabApi.createOptionalFromException(glae));
+        }
+    }
+
+    /**
+     * Create a pipeline trigger for a project.
+     *
+     * <pre><code>POST /projects/:id/triggers</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param description the trigger description
+     * @return the created Trigger instance
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Trigger createPipelineTrigger(Object projectIdOrPath, String description) throws GitLabApiException {
+        GitLabApiForm formData = new GitLabApiForm().withParam("description", description, true);
+        Response response = post(Response.Status.CREATED, formData, "projects", getProjectIdOrPath(projectIdOrPath), "triggers");
+        return (response.readEntity(Trigger.class));
+    }
+
+    /**
+     * Updates a pipeline trigger for project.
+     *
+     * <pre><code>PUT /projects/:id/triggers/:trigger_id</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param triggerId the trigger ID to update
+     * @param description the new trigger description
+     * @return the updated Trigger instance
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Trigger updatePipelineTrigger(Object projectIdOrPath, Integer triggerId, String description) throws GitLabApiException {
+        GitLabApiForm formData = new GitLabApiForm().withParam("description", description, false);
+        Response response = put(Response.Status.OK, formData.asMap(), "projects", getProjectIdOrPath(projectIdOrPath), "triggers", triggerId);
+        return (response.readEntity(Trigger.class));
+    }
+
+    /**
+     * Deletes a pipeline trigger from the project.
+     *
+     * <pre><code>DELETE /projects/:id/triggers/:trigger_id</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param triggerId the project trigger ID to delete
+     * @throws GitLabApiException if any exception occurs
+     */
+    public void deletePipelineTrigger(Object projectIdOrPath, Integer triggerId) throws GitLabApiException {
+        delete(Response.Status.NO_CONTENT, null, "projects", getProjectIdOrPath(projectIdOrPath), "triggers", triggerId);
+    }
+
+    /**
+     * Take ownership of a pipeline trigger for project.
+     *
+     * <pre><code>PUT /projects/:id/triggers/:trigger_id/take_ownership</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param triggerId the trigger ID to take opwnership of
+     * @return the updated Trigger instance
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Trigger takeOwnewrshipOfPipelineTrigger(Object projectIdOrPath, Integer triggerId) throws GitLabApiException {
+        Response response = put(Response.Status.OK, null,
+                "projects", getProjectIdOrPath(projectIdOrPath), "triggers", triggerId, "take_ownership");
+        return (response.readEntity(Trigger.class));
+    }
+
+    /**
+     * Trigger a pipeline for a project.
+     *
+     * <pre><code>POST /projects/:id/trigger/pipeline</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param trigger the Trigger instance holding the trigger token
+     * @param ref the ref that the pipeline is to be triggered for
+     * @param variables a List of variables to be passed with the trigger
+     * @return a Pipeline instance holding information on the triggered pipeline
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Pipeline triggerPipeline(Object projectIdOrPath, Trigger trigger, String ref, List<Variable> variables) throws GitLabApiException {
+
+        if (trigger == null) {
+            throw new GitLabApiException("trigger cannot be null");
+        }
+
+        return (triggerPipeline(projectIdOrPath, trigger.getToken(), ref, variables));
+    }
+
+    /**
+     * Trigger a pipeline for a project.
+     *
+     * <pre><code>POST /projects/:id/trigger/pipeline</code></pre>
+     *
+     * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
+     * @param token the trigger token
+     * @param ref the ref that the pipeline is to be triggered for
+     * @param variables a List of variables to be passed with the trigger
+     * @return a Pipeline instance holding information on the triggered pipeline
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Pipeline triggerPipeline(Object projectIdOrPath, String token, String ref, List<Variable> variables) throws GitLabApiException {
+        GitLabApiForm formData = new GitLabApiForm()
+                .withParam("token", token, true)
+                .withParam("ref",  ref, true)
+                .withParam(variables);
+        Response response = post(Response.Status.CREATED, formData,
+                "projects", getProjectIdOrPath(projectIdOrPath), "trigger", "pipeline");
+        return (response.readEntity(Pipeline.class));
+    }
 }

src/main/java/org/gitlab4j/api/models/Pipeline.java

@@ -21,6 +21,8 @@ public class Pipeline {
     private Date committed_at;
     private String coverage;
     private Integer duration;
+    private String webUrl;
+    private DetailedStatus detailedStatus;
 
     public Integer getId() {
         return id;
@@ -142,6 +144,22 @@ public void setDuration(Integer duration) {
         this.duration = duration;
     }
 
+    public String getWebUrl() {
+        return webUrl;
+    }
+
+    public void setWebUrl(String webUrl) {
+        this.webUrl = webUrl;
+    }
+
+    public DetailedStatus getDetailedStatus() {
+        return detailedStatus;
+    }
+
+    public void setDetailedStatus(DetailedStatus detailedStatus) {
+        this.detailedStatus = detailedStatus;
+    }
+
     @Override
     public String toString() {
         return (JacksonJson.toJsonString(this));

src/test/java/org/gitlab4j/api/TestGitLabApiBeans.java

@@ -80,6 +80,7 @@
 import org.gitlab4j.api.models.SystemHook;
 import org.gitlab4j.api.models.Tag;
 import org.gitlab4j.api.models.TreeItem;
+import org.gitlab4j.api.models.Trigger;
 import org.gitlab4j.api.models.User;
 import org.gitlab4j.api.models.Variable;
 import org.gitlab4j.api.services.JiraService;
@@ -434,6 +435,12 @@ public void testTree() throws Exception {
         assertTrue(compareJson(tree, "tree.json"));
     }
 
+    @Test
+    public void testTrigger() throws Exception {
+        Trigger trigger = unmarshalResource(Trigger.class, "trigger.json");
+        assertTrue(compareJson(trigger, "trigger.json"));
+    }
+
     @Test
     public void testUser() throws Exception {
         User user = unmarshalResource(User.class, "user.json");