ex_jenkins v0.1.3 ExJenkins.Jobs View Source

This module provides functionalities to handle Jenkins Folders Jobs.

Link to this section Summary

Functions

Retrieves all Jenkins jobs

Retrieves the configuration file of a Jenkins job

Creates a new Jenkins job copying it from another

Creates a Jenkins job using a given configuration file

Creates a Jenkins job in a folder using a given configuration file

Delete Jenkins job

Issues a DELETE request to the given url

Issues a DELETE request to the given url, raising an exception in case of failure

Disable Jenkins job

Enable a disabled Jenkins job

Issues a GET request to the given url

Issues a GET request to the given url, raising an exception in case of failure

Issues a HEAD request to the given url

Issues a HEAD request to the given url, raising an exception in case of failure

Retrieves the log of a Jenkins job

Issues an OPTIONS request to the given url

Issues a OPTIONS request to the given url, raising an exception in case of failure

Issues a PATCH request to the given url

Issues a PATCH request to the given url, raising an exception in case of failure

Issues a POST request to the given url

Issues a POST request to the given url, raising an exception in case of failure

Issues a PUT request to the given url

Issues a PUT request to the given url, raising an exception in case of failure

Issues an HTTP request with the given method to the given url

Issues an HTTP request with the given method to the given url, raising an exception in case of failure

Starts HTTPoison and its dependencies

Start a standard or parameterized jenkins job

Retrieve the status of a build for a given Jenkins job

Stop a Jenkins job

Requests the next message to be streamed for a given HTTPoison.AsyncResponse

Updates a Jenkins job using a given configuration file

Link to this section Types

Link to this type body() View Source
body() :: binary | {:form, [{atom, any}]} | {:file, binary}
Link to this type headers() View Source
headers ::
  [{binary, binary}] |
  %{optional(binary) => binary}

Link to this section Functions

Retrieves all Jenkins jobs.

## Examples

iex> ExJenkins.Jobs.all
  {:ok, ["job1", "job2", "jobN"]}

Retrieves the configuration file of a Jenkins job.

## Examples

iex> ExJenkins.Jobs.config_file("myjob")
  {:ok, {:config_file, "your Jenkins job log"}}

Creates a new Jenkins job copying it from another.

## Examples

iex> ExJenkins.Jobs.copy("myjob", "myotherjob")
  {:ok, {:log, "your Jenkins job log"}}
Link to this function create(job, config_file) View Source

Creates a Jenkins job using a given configuration file.

## Examples

iex> ExJenkins.Jobs.create("myjob", "xml configuration file")
  {:ok, :created}
Link to this function create(job, folder, config_file) View Source

Creates a Jenkins job in a folder using a given configuration file.

## Examples

iex> ExJenkins.Jobs.create("myjob", "folder", "xml configuration file")
  {:ok, :created}

Delete Jenkins job.

## Examples

iex> ExJenkins.Jobs.delete("myjob")
  {:ok, :deleted}
Link to this function delete(url, headers \\ [], options \\ []) View Source

Issues a DELETE request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function delete!(url, headers \\ [], options \\ []) View Source

Issues a DELETE request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Disable Jenkins job.

## Examples

iex> ExJenkins.Jobs.disable("myjob")
  {:ok, :disabled}

Enable a disabled Jenkins job.

## Examples

iex> ExJenkins.Jobs.enable("myjob")
  {:ok, :enabled}
Link to this function get(url, headers \\ [], options \\ []) View Source

Issues a GET request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Issues a GET request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function head(url, headers \\ [], options \\ []) View Source

Issues a HEAD request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function head!(url, headers \\ [], options \\ []) View Source

Issues a HEAD request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Retrieves the log of a Jenkins job.

## Examples

iex> ExJenkins.Jobs.log("myjob")
  {:ok, {:log, "your Jenkins job log"}}
Link to this function options(url, headers \\ [], options \\ []) View Source

Issues an OPTIONS request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function options!(url, headers \\ [], options \\ []) View Source

Issues a OPTIONS request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function patch(url, body, headers \\ [], options \\ []) View Source

Issues a PATCH request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function patch!(url, body, headers \\ [], options \\ []) View Source

Issues a PATCH request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function post(url, body, headers \\ [], options \\ []) View Source

Issues a POST request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function post!(url, body, headers \\ [], options \\ []) View Source

Issues a POST request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function put(url, body \\ "", headers \\ [], options \\ []) View Source

Issues a PUT request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function put!(url, body \\ "", headers \\ [], options \\ []) View Source

Issues a PUT request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function request(method, url, body \\ "", headers \\ [], options \\ []) View Source
request(atom, binary, body, headers, Keyword.t) ::
  {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} |
  {:error, HTTPoison.Error.t}

Issues an HTTP request with the given method to the given url.

This function is usually used indirectly by get/3, post/4, put/4, etc

Args:

  • method - HTTP method as an atom (:get, :head, :post, :put, :delete, etc.)
  • url - target url as a binary string or char list
  • body - request body. See more below
  • headers - HTTP headers as an orddict (e.g., [{"Accept", "application/json"}])
  • options - Keyword list of options

Body:

  • binary, char list or an iolist
  • {:form, [{K, V}, ...]} - send a form url encoded
  • {:file, "/path/to/file"} - send a file

Options:

  • :timeout - timeout to establish a connection, in milliseconds. Default is 8000
  • :recv_timeout - timeout used when receiving a connection. Default is 5000
  • :stream_to - a PID to stream the response to
  • :async - if given :once, will only stream one message at a time, requires call to stream_next
  • :proxy - a proxy to be used for the request; it can be a regular url or a {Host, Proxy} tuple
  • :proxy_auth - proxy authentication {User, Password} tuple
  • :ssl - SSL options supported by the ssl erlang module
  • :follow_redirect - a boolean that causes redirects to be followed
  • :max_redirect - an integer denoting the maximum number of redirects to follow
  • :params - an enumerable consisting of two-item tuples that will be appended to the url as query string parameters

Timeouts can be an integer or :infinity

This function returns {:ok, response} or {:ok, async_response} if the request is successful, {:error, reason} otherwise.

Examples

request(:post, "https://my.website.com", "{\"foo\": 3}", [{"Accept", "application/json"}])
Link to this function request!(method, url, body \\ "", headers \\ [], options \\ []) View Source
request!(atom, binary, body, headers, Keyword.t) :: HTTPoison.Response.t

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

request!/5 works exactly like request/5 but it returns just the response in case of a successful request, raising an exception in case the request fails.

Starts HTTPoison and its dependencies.

Start a standard or parameterized jenkins job

## Examples

iex> ExJenkins.Jobs.start("myjob")
  {:ok, {:started, location}}

  iex> ExJenkins.Jobs.start("myjob", params: [foo: "bar", foo2: "bar2"])
  {:ok, {:started, location}}

  ## You can also override token
  iex> ExJenkins.Jobs.start("myjob", params: [foo: "bar", foo2: "bar2"], token: "anothertoken")
  {:ok, {:started, location}}

Retrieve the status of a build for a given Jenkins job.

## Examples

iex> ExJenkins.Jobs.status("myjob", 3)
  {:ok, {{:number, 3}, {:status, "SUCCESS"}}}

Stop a Jenkins job.

## Examples

iex> ExJenkins.Jobs.stop("myjob")
  {:ok, {:stopped, location}}

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

See request!/5 for more detailed information.

Link to this function update(job, config_file) View Source

Updates a Jenkins job using a given configuration file.

## Examples

iex> ExJenkins.Jobs.update("myjob", "xml configuration file")
  {:ok, :updated}