Class: JenkinsApi::Client::Job

Inherits:
Object
  • Object
show all
Includes:
UriHelper
Defined in:
lib/jenkins_api_client/job.rb

Overview

This class communicates with the Jenkins "/job" API to obtain details about jobs, creating, deleting, building, and various other operations.

Constant Summary

JENKINS_QUEUE_ID_SUPPORT_VERSION =

Version that jenkins started to include queued build info in build response

'1.519'

Instance Method Summary (collapse)

Methods included from UriHelper

#form_encode, #path_encode

Constructor Details

- (Job) initialize(client)

Initialize the Job object and store the reference to Client object

Parameters:

  • client (Client) —

    the client object



42
43
44
45
 
# File 'lib/jenkins_api_client/job.rb', line 42

def initialize(client)
  @client = client
  @logger = @client.logger
end

Instance Method Details

- (String) add_downstream_projects(job_name, downstream_projects, threshold, overwrite = false)

Add downstream projects to a specific job given the job name, projects to be added as downstream projects, and the threshold

Parameters:

  • job_name (String)
  • downstream_projects (String)
  • threshold (String) —

    • failure, success, or unstable

  • overwrite (Boolean) (defaults to: false) —

    • true or false

Returns:

  • (String) —

    response_code return code from HTTP POST



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
 
# File 'lib/jenkins_api_client/job.rb', line 1259

def add_downstream_projects(job_name,
                            downstream_projects,
                            threshold, overwrite = false)
  @logger.info "Adding #{downstream_projects.inspect} as downstream" +
    " projects for '#{job_name}' with the threshold of '#{threshold}'" +
    " and overwrite option of '#{overwrite}'"
  name, ord, col = get_threshold_params(threshold)
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  child_projects_node = n_xml.xpath("//childProjects").first
  if child_projects_node
    if overwrite
      child_projects_node.content = "#{downstream_projects}"
    else
      to_replace = child_projects_node.content +
        ", #{downstream_projects}"
      child_projects_node.content = to_replace
    end
  else
    publisher_node = n_xml.xpath("//publishers").first
    build_trigger_node = publisher_node.add_child(
      "<hudson.tasks.BuildTrigger/>"
    )
    child_project_node = build_trigger_node.first.add_child(
      "<childProjects>#{downstream_projects}</childProjects>"
    )
    threshold_node = child_project_node.first.add_next_sibling(
      "<threshold/>"
    )
    threshold_node.first.add_child(
      "<name>#{name}</name><ordinal>#{ord}</ordinal><color>#{col}</color>"
    )
  end
  xml_modified = n_xml.to_xml
  post_config(job_name, xml_modified)
end

- (Object) add_email_notification(params)

Adding email notification to a job

Parameters:

  • params (Hash) —

    parameters to add email notification

Options Hash (params):

  • :name (String) —

    Name of the job

  • :notification_email (String) —

    Email address to send

  • :notification_email_for_every_unstable (Boolean) —

    Send email notification email for every unstable build



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/jenkins_api_client/job.rb', line 345

def add_email_notification(params)
  raise "No job name specified" unless params[:name]
  raise "No email address specified" unless params[:notification_email]
  @logger.info "Adding '#{params[:notification_email]}' to be" +
    " notified for '#{params[:name]}'"
  xml = get_config(params[:name])
  n_xml = Nokogiri::XML(xml)
  if n_xml.xpath("//hudson.tasks.Mailer").empty?
    p_xml = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |b_xml|
      notification_email(params, b_xml)
    end
    email_xml = Nokogiri::XML(p_xml.to_xml).xpath(
      "//hudson.tasks.Mailer"
    ).first
    n_xml.xpath("//publishers").first.add_child(email_xml)
    post_config(params[:name], n_xml.to_xml)
  end
end

- (Object) add_skype_notification(params)

Adding skype notificaiton to a job

Parameters:

  • params (Hash) —

    parameters for adding skype notification

    • :name name of the job to add skype notification

    • :skype_targets skype targets for sending notifications to. Use * to specify group chats. Use space to separate multiple targets. Example: testuser, *testgroup.

    • :skype_strategy skype strategy to be used for sending notifications. Valid values: all, failure, failure_and_fixed, change. Default: change.

    • :skype_notify_on_build_start Default: false

    • :skype_notify_suspects Default: false

    • :skype_notify_culprits Default: false

    • :skype_notify_fixers Default: false

    • :skype_notify_upstream_committers Default: false

    • :skype_message what should be sent as notification message. Valid: just_summary, summary_and_scm_changes, summary_and_build_parameters, summary_scm_changes_and_failed_tests. Default: summary_and_scm_changes



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/jenkins_api_client/job.rb', line 384

def add_skype_notification(params)
  raise "No job name specified" unless params[:name]
  raise "No Skype target specified" unless params[:skype_targets]
  @logger.info "Adding Skype notification for '#{params[:name]}'"
  xml = get_config(params[:name])
  n_xml = Nokogiri::XML(xml)
  if n_xml.xpath("//hudson.plugins.skype.im.transport.SkypePublisher").empty?
    p_xml = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |b_xml|
      skype_notification(params, b_xml)
    end
    skype_xml = Nokogiri::XML(p_xml.to_xml).xpath(
      "//hudson.plugins.skype.im.transport.SkypePublisher"
    ).first
    n_xml.xpath("//publishers").first.add_child(skype_xml)
    post_config(params[:name], n_xml.to_xml)
  end
end

- (String) block_build_when_downstream_building(job_name)

Block the build of the job when downstream is building

Parameters:

  • job_name (String)

Returns:

  • (String) —

    response_code return code from HTTP POST



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'lib/jenkins_api_client/job.rb', line 1053

def block_build_when_downstream_building(job_name)
  @logger.info "Blocking builds of '#{job_name}' when downstream" +
    " projects are building"
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  node = n_xml.xpath("//blockBuildWhenDownstreamBuilding").first
  if node.content == "false"
    node.content = "true"
    xml_modified = n_xml.to_xml
    post_config(job_name, xml_modified)
  end
end

- (String) block_build_when_upstream_building(job_name)

Block the build of the job when upstream is building

Parameters:

  • job_name (String)

Returns:

  • (String) —

    response_code return code from HTTP POST



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'lib/jenkins_api_client/job.rb', line 1091

def block_build_when_upstream_building(job_name)
  @logger.info "Blocking builds of '#{job_name}' when upstream" +
    " projects are building"
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  node = n_xml.xpath("//blockBuildWhenUpstreamBuilding").first
  if node.content == "false"
    node.content = "true"
    xml_modified = n_xml.to_xml
    post_config(job_name, xml_modified)
  end
end

- (Integer) build(job_name, params = {}, opts = {})

Build a Jenkins job, optionally waiting for build to start and returning the build number. Adds support for new/old Jenkins servers where build_queue id may not be available. Also adds support for periodic callbacks, and optional cancellation of queued_job if not started within allowable time window (if build_queue option available)

Notes:
  'opts' may be a 'true' or 'false' value to maintain
    compatibility with old method signature, where true indicates
  'return_build_number'. In this case, true is translated to:
    { 'build_start_timeout' => @client_timeout }
    which simulates earlier behavior.

progress_proc
  Optional proc that is called periodically while waiting for
  build to start.
  Initial call (with poll_count == 0) indicates build has been
  requested, and that polling is starting.
  Final call will indicate one of build_started or cancelled.
  params:
    max_wait [Integer] Same as opts['build_start_timeout']
    current_wait [Integer]
    poll_count [Integer] How many times has queue been polled

completion_proc
  Optional proc that is called <just before> the 'build' method
  exits.
  params:
    build_number [Integer]  Present if build started or nil
    build_cancelled [Boolean]  True if build timed out and was
      successfully removed from build-queue

Parameters:

  • job_name (String) —

    the name of the job

  • params (Hash) (defaults to: {}) —

    the parameters for parameterized build

  • opts (Hash) (defaults to: {}) —

    options for this method

    • build_start_timeout [Integer] How long to wait for queued build to start before giving up. Default: 0/nil

    • cancel_on_build_start_timeout [Boolean] Should an attempt be made to cancel the queued build if it hasn't started within 'build_start_timeout' seconds? This only works on newer versions of Jenkins where JobQueue is exposed in build post response. Default: false

    • poll_interval [Integer] How often should we check with CI Server while waiting for start. Default: 2 (seconds)

    • progress_proc [Proc] A proc that will receive progress notitications. Default: nil

    • completion_proc [Proc] A proc that is called <just before> this method (build) exits. Default: nil

Returns:

  • (Integer) —

    build number, or nil if not started (IF TIMEOUT SPECIFIED)

  • (Integer) —

    HTTP response code (per prev. behavior) (NO TIMEOUT SPECIFIED)



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'lib/jenkins_api_client/job.rb', line 762

def build(job_name, params={}, opts = {})
  if opts.nil? || opts.class.is_a?(FalseClass)
    opts = {}
  elsif opts.class.is_a?(TrueClass)
    opts = { 'build_start_timeout' => @client_timeout }
  end

  opts['job_name'] = job_name

  msg = "Building job '#{job_name}'"
  msg << " with parameters: #{params.inspect}" unless params.empty?
  @logger.info msg

  # Best-guess build-id
  # This is only used if we go the old-way below... but we can use this number to detect if multiple
  # builds were queued
  current_build_id = get_current_build_number(job_name)
  expected_build_id = current_build_id > 0 ? current_build_id + 1 : 1

  if (params.nil? or params.empty?)
    response = @client.api_post_request("/job/#{path_encode job_name}/build",
      {},
      true)
  else
    response = @client.api_post_request("/job/#{path_encode job_name}/buildWithParameters",
      params,
      true)
  end

  if (opts['build_start_timeout'] || 0) > 0
    if @client.compare_versions(@client.get_jenkins_version, JENKINS_QUEUE_ID_SUPPORT_VERSION) >= 0
      return get_build_id_from_queue(response, expected_build_id, opts)
    else
      return get_build_id_the_old_way(expected_build_id, opts)
    end
  else
    return response.code
  end
end

- (String) build_freestyle_config(params)

Builds the XML configuration based on the parameters passed as a Hash

Parameters:

  • params (Hash) —

    the parameters for building XML configuration

Returns:

  • (String) —

    the generated XML configuration of the project

Raises:

  • (ArgumentError) 


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/jenkins_api_client/job.rb', line 225

def build_freestyle_config(params)
  # Supported SCM providers
  supported_scm = ["git", "subversion", "cvs"]

  # Set default values for params that are not specified.
  raise ArgumentError, "Job name must be specified" \
    unless params.is_a?(Hash) && params[:name]

  [
    :keep_dependencies,
    :block_build_when_downstream_building,
    :block_build_when_upstream_building,
    :concurrent_build
  ].each do |param|
    params[param] = false if params[param].nil?
  end

  if params[:notification_email]
    if params[:notification_email_for_every_unstable].nil?
      params[:notification_email_for_every_unstable] = false
    end
    if params[:notification_email_send_to_individuals].nil?
      params[:notification_email_send_to_individuals] ||= false
    end
  end

  # SCM configurations and Error handling.
  unless params[:scm_provider].nil?
    unless supported_scm.include?(params[:scm_provider])
      raise "SCM #{params[:scm_provider]} is currently not supported"
    end
    raise "SCM URL must be specified" if params[:scm_url].nil?
    params[:scm_branch] = "master" if params[:scm_branch].nil?
    if params[:scm_use_head_if_tag_not_found].nil?
      params[:scm_use_head_if_tag_not_found] = false
    end
  end

  # Child projects configuration and Error handling
  if params[:child_threshold].nil? && !params[:child_projects].nil?
    params[:child_threshold] = "failure"
  end

  @logger.debug "Creating a freestyle job with params: #{params.inspect}"

  # Build the Job xml file based on the parameters given
  builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
    xml.project do
      xml.actions
      xml.description
      xml.keepDependencies "#{params[:keep_dependencies]}"
      xml.properties
      # SCM related stuff
      if params[:scm_provider] == 'subversion'
        # Build subversion related XML portion
        scm_subversion(params, xml)
      elsif params[:scm_provider] == "cvs"
        # Build CVS related XML portion
        scm_cvs(params, xml)
      elsif params[:scm_provider] == "git"
        # Build Git related XML portion
        scm_git(params, xml)
      else
        xml.scm(:class => "hudson.scm.NullSCM")
      end
      # Restrict job to run in a specified node
      if params[:restricted_node]
        xml.assignedNode "#{params[:restricted_node]}"
        xml.canRoam "false"
      else
        xml.canRoam "true"
      end
      xml.disabled "false"
      xml.blockBuildWhenDownstreamBuilding(
        "#{params[:block_build_when_downstream_building]}")
      xml.blockBuildWhenUpstreamBuilding(
        "#{params[:block_build_when_upstream_building]}")
      if params[:timer]
        xml.triggers.vector do
          xml.send("hudson.triggers.TimerTrigger") do
            xml.spec params[:timer]
          end
        end
      else
        xml.triggers.vector
      end
      xml.concurrentBuild "#{params[:concurrent_build]}"
      # Shell command stuff
      xml.builders do
        if params[:shell_command]
          xml.send("hudson.tasks.Shell") do
            xml.command "#{params[:shell_command]}"
          end
        end
      end
      # Adding Downstream projects
      xml.publishers do
        # Build portion of XML that adds child projects
        child_projects(params, xml) if params[:child_projects]
        # Build portion of XML that adds email notification
        notification_email(params, xml) if params[:notification_email]
        # Build portion of XML that adds skype notification
        skype_notification(params, xml) if params[:skype_targets]
      end
      xml.buildWrappers
    end
  end
  builder.to_xml
end

- (Array) chain(job_names, threshold, criteria, parallel = 1)

Chain the jobs given based on specified criteria

Parameters:

  • job_names (Array) —

    Array of job names to be chained

  • threshold (String) —

    threshold for running the next job

  • criteria (Array) —

    criteria which should be applied for picking the jobs for the chain

  • parallel (Integer) (defaults to: 1) —

    Number of jobs that should be considered for parallel run

Returns:

  • (Array) —

    job_names Names of jobs that are in the top of the chain



1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
 
# File 'lib/jenkins_api_client/job.rb', line 1373

def chain(job_names, threshold, criteria, parallel = 1)
  raise "Parallel jobs should be at least 1" if parallel < 1
  unchain(job_names)

  @logger.info "Chaining jobs: #{job_names.inspect}" +
    " with threshold of '#{threshold}' and criteria as '#{criteria}'" +
    " with #{parallel} number of parallel jobs"
  filtered_job_names = []
  if criteria.include?("all") || criteria.empty?
    filtered_job_names = job_names
  else
    job_names.each do |job|
      filtered_job_names << job if criteria.include?(
        @client.job.get_current_build_status(job)
      )
    end
  end

  filtered_job_names.each_with_index do |job_name, index|
    break if index >= (filtered_job_names.length - parallel)
    @client.job.add_downstream_projects(
      job_name, filtered_job_names[index + parallel], threshold, true
    )
  end
  if parallel > filtered_job_names.length
    parallel = filtered_job_names.length
  end
  filtered_job_names[0..parallel-1]
end

- (String) change_description(job_name, description)

Change the description of a specific job

Parameters:

  • job_name (String)
  • description (String)

Returns:

  • (String) —

    response_code return code from HTTP POST



1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/jenkins_api_client/job.rb', line 1037

def change_description(job_name, description)
  @logger.info "Changing the description of '#{job_name}' to '#{description}'"
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  desc = n_xml.xpath("//description").first
  desc.content = "#{description}"
  xml_modified = n_xml.to_xml
  post_config(job_name, xml_modified)
end

- (String) color_to_status(color)

This method maps the color to status of a job

Parameters:

  • color (String) —

    color given by the API for a job

Returns:

  • (String) —

    status status of the given job matching the color



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/jenkins_api_client/job.rb', line 660

def color_to_status(color)
  case color
  when "blue"
    "success"
  when "red"
    "failure"
  when "yellow"
    "unstable"
  when /anime/
    "running"
  # In the recent version of Jenkins (> 1.517), jobs that are not built
  # yet have a color of "notbuilt" instead of "grey". Include that to the
  # not_run condition so it is backward compatible.
  when "grey", "notbuilt"
    "not_run"
  when "aborted"
    "aborted"
  else
    "invalid"
  end
end

- (String) copy(from_job_name, to_job_name = nil)

Copy a job

Parameters:

  • from_job_name (String) —

    the name of the job to copy from

  • to_job_name (String) (defaults to: nil) —

    the name of the job to copy to

Returns:

  • (String) —

    the response from the HTTP POST request



488
489
490
491
492
493
494
 
# File 'lib/jenkins_api_client/job.rb', line 488

def copy(from_job_name, to_job_name=nil)
  to_job_name = "copy_of_#{from_job_name}" if to_job_name.nil?
  @logger.info "Copying job '#{from_job_name}' to '#{to_job_name}'"
  @client.api_post_request(
    "/createItem?name=#{path_encode to_job_name}&mode=copy&from=#{path_encode from_job_name}"
  )
end

- (String) create(job_name, xml)

Create a job with the name specified and the xml given

Parameters:

  • job_name (String) —

    the name of the job

  • xml (String) —

    the xml configuration of the job

Returns:

  • (String) —

    the HTTP status code from the POST request

See Also:



81
82
83
84
 
# File 'lib/jenkins_api_client/job.rb', line 81

def create(job_name, xml)
  @logger.info "Creating job '#{job_name}'"
  @client.post_config("/createItem?name=#{form_encode job_name}", xml)
end

- (String) create_freestyle(params)

Create a freestyle project by accepting a Hash of parameters. For the parameter description see #create_of_update_freestyle

Examples:

Create a Freestype Project

create_freestyle(
  :name => "test_freestyle_job",
  :keep_dependencies => true,
  :concurrent_build => true,
  :scm_provider => "git",
  :scm_url => "git://github.com./arangamani/jenkins_api_client.git",
  :scm_branch => "master",
  :shell_command => "bundle install\n rake func_tests"
)

Parameters:

  • params (Hash) —

    the parameters for creating a job

Returns:

  • (String) —

    the HTTP status code from the POST request

See Also:



198
199
200
201
 
# File 'lib/jenkins_api_client/job.rb', line 198

def create_freestyle(params)
  xml = build_freestyle_config(params)
  create(params[:name], xml)
end

- (String) create_or_update(job_name, xml)

Create or Update a job with the name specified and the xml given

Parameters:

  • job_name (String) —

    the name of the job

  • xml (String) —

    the xml configuration of the job

Returns:

  • (String) —

    the HTTP status code from the POST request

See Also:



63
64
65
66
67
68
69
 
# File 'lib/jenkins_api_client/job.rb', line 63

def create_or_update(job_name, xml)
  if exists?(job_name)
    update(job_name, xml)
  else
    create(job_name, xml)
  end
end

- (String) create_or_update_freestyle(params)

Create or Update a job with params given as a hash instead of the xml This gives some flexibility for creating/updating simple jobs so the user doesn't have to learn about handling xml.

Parameters:

  • params (Hash) —

    parameters to create a freestyle project

Options Hash (params):

  • :name (String) —

    the name of the job

  • :keep_dependencies (Boolean) — default: false —

    whether to keep the dependencies or not

  • :block_build_when_downstream_building (Boolean) — default: false —

    whether to block build when the downstream project is building

  • :block_build_when_upstream_building (Boolean) — default: false —

    whether to block build when the upstream project is building

  • :concurrent_build (Boolean) — default: false —

    whether to allow concurrent execution of builds

  • :scm_provider (String) —

    the type of source control. Supported providers: git, svn, and cvs

  • :scm_url (String) —

    the remote url for the selected scm provider

  • :scm_module (String) —

    the module to download. Only for use with “cvs” scm provider

  • :scm_branch (String) — default: master —

    the branch to use in scm.

  • :scm_tag (String) —

    the tag to download from scm. Only for use with “cvs” scm provider

  • :scm_use_head_if_tag_not_found (Boolean) —

    whether to use head if specified tag is not found. Only for “cvs”

  • :timer (String) —

    the timer for running builds periodically

  • :shell_command (String) —

    the command to execute in the shell

  • :notification_email (String) —

    the email for sending notification

  • :skype_targets (String) —

    the skype targets for sending notifications to. Use * to specify group chats. Use space to separate multiple targets. Note that this option requires the “skype” plugin to be installed in jenkins. Example: testuser *testgroup

  • :skype_strategy (String) — default: change —

    the skype strategy to be used for sending notifications. Valid values: all, failure, failure_and_fixed, change.

  • :skype_notify_on_build_start (Boolean) — default: false —

    whether to notify skype targets on build start

  • :skype_notify_suspects (Boolean) — default: false —

    whether to notify suspects on skype

  • :skype_notify_culprits (Boolean) — default: false —

    whether to notify culprits on skype

  • :skype_notify_fixers (Boolean) — default: false —

    whether to notify fixers on skype

  • :skype_notify_upstream_committers (Boolean) — default: false —

    whether to notify upstream committers on skype

  • :skype_message (String) — default: summary_and_scm_changes —

    the information to be sent as notification message. Valid: just_summary, summary_and_scm_changes, summary_and_build_parameters, summary_scm_changes_and_failed_tests.

  • :child_projects (String) —

    the projects to add as downstream projects

  • :child_threshold (String) — default: failure —

    the threshold for child projects. Valid options: success, failure, or unstable.

Returns:

  • (String) —

    the HTTP status code from the POST request

See Also:



168
169
170
171
172
173
174
 
# File 'lib/jenkins_api_client/job.rb', line 168

def create_or_update_freestyle(params)
  if exists?(params[:name])
    update_freestyle(params)
  else
    create_freestyle(params)
  end
end

- (String) delete(job_name)

Delete a job given the name

Parameters:

  • job_name (String) —

    the name of the job to delete

Returns:

  • (String) —

    the response from the HTTP POST request



418
419
420
421
 
# File 'lib/jenkins_api_client/job.rb', line 418

def delete(job_name)
  @logger.info "Deleting job '#{job_name}'"
  @client.api_post_request("/job/#{path_encode job_name}/doDelete")
end

- (Object) delete_all!

Note:

This method will remove all jobs from Jenkins. Please use with caution.

Deletes all jobs from Jenkins



428
429
430
431
 
# File 'lib/jenkins_api_client/job.rb', line 428

def delete_all!
  @logger.info "Deleting all jobs from jenkins"
  list_all.each { |job| delete(job) }
end

- (Object) disable(job_name)

Disable a job given the name of the job

Parameters:

  • job_name (String) 


973
974
975
976
 
# File 'lib/jenkins_api_client/job.rb', line 973

def disable(job_name)
  @logger.info "Disabling job '#{job_name}'"
  @client.api_post_request("/job/#{path_encode job_name}/disable")
end

- (Object) enable(job_name)

Enable a job given the name of the job

Parameters:

  • job_name (String) 


964
965
966
967
 
# File 'lib/jenkins_api_client/job.rb', line 964

def enable(job_name)
  @logger.info "Enabling job '#{job_name}'"
  @client.api_post_request("/job/#{path_encode job_name}/enable")
end

- (String) execute_concurrent_builds(job_name, option)

Allow or disable concurrent build execution

Parameters:

  • job_name (String)
  • option (Bool) —

    true or false

Returns:

  • (String) —

    response_code return code from HTTP POST



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/jenkins_api_client/job.rb', line 1130

def execute_concurrent_builds(job_name, option)
  @logger.info "Setting the concurrent build execution option of" +
    " '#{job_name}' to #{option}"
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  node = n_xml.xpath("//concurrentBuild").first
  if node.content != "#{option}"
    node.content = option == true ? "true" : "false"
    xml_modified = n_xml.to_xml
    post_config(job_name, xml_modified)
  end
end

- (Boolean) exists?(job_name)

Checks if the given job exists in Jenkins

Parameters:

  • job_name (String) —

    the name of the job to check

Returns:

  • (Boolean) —

    whether the job exists in jenkins or not



552
553
554
 
# File 'lib/jenkins_api_client/job.rb', line 552

def exists?(job_name)
  list(job_name).include?(job_name)
end

- (Object) get_build_details(job_name, build_num)

Obtain detailed build info for a job

Parameters:

  • job_name (String)
  • build_num (Number) 


1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/jenkins_api_client/job.rb', line 1022

def get_build_details(job_name, build_num)
  build_num = get_current_build_number(job_name) if build_num == 0
  @logger.info "Obtaining the build details of '#{job_name}'" +
    " Build ##{build_num}"

  @client.api_get_request("/job/#{path_encode job_name}/#{build_num}/")
end

- (Array) get_build_params(job_name)

Obtain the build parameters of a job. It returns an array of hashes with details of job params.

Parameters:

  • job_name (String)

Returns:

  • (Array) —

    params_array Array of parameters for the given job



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
 
# File 'lib/jenkins_api_client/job.rb', line 1150

def get_build_params(job_name)
  @logger.info "Obtaining the build params of '#{job_name}'"
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  params = n_xml.xpath("//parameterDefinitions").first
  params_array = []
  if params
    params.children.each do |param|
      param_hash = {}
      case param.name
      when "hudson.model.StringParameterDefinition",
           "hudson.model.BooleanParameterDefinition",
           "hudson.model.TextParameterDefinition",
           "hudson.model.PasswordParameterDefinition"
        param_hash[:type] = 'string' if param.name =~ /string/i
        param_hash[:type] = 'boolean' if param.name =~ /boolean/i
        param_hash[:type] = 'text' if param.name =~ /text/i
        param_hash[:type] = 'password' if param.name =~ /password/i
        param.children.each do |value|
          param_hash[:name] = value.content if value.name == "name"
          if value.name == "description"
            param_hash[:description] = value.content
          end
          if value.name == "defaultValue"
            param_hash[:default] = value.content
          end
        end
      when "hudson.model.RunParameterDefinition"
        param_hash[:type] = 'run'
        param.children.each do |value|
          param_hash[:name] = value.content if value.name == "name"
          if value.name == "description"
            param_hash[:description] = value.content
          end
          if value.name == "projectName"
            param_hash[:project] = value.content
          end
        end
      when "hudson.model.FileParameterDefinition"
        param_hash[:type] = 'file'
        param.children.each do |value|
          param_hash[:name] = value.content if value.name == "name"
          if value.name == "description"
            param_hash[:description] = value.content
          end
        end
      when "hudson.scm.listtagsparameter.ListSubversionTagsParameterDefinition"
        param_hash[:type] = 'list_tags'
        param.children.each do |value|
          if value.name == "name"
            param_hash[:name] = value.content
          end
          if value.name == "description"
            param_hash[:description] = value.content
          end
          if value.name == "tagsDir"
            param_hash[:tags_dir] = value.content
          end
          if value.name == "tagsFilter"
            param_hash[:tags_filter] = value.content
          end
          if value.name == "reverseByDate"
            param_hash[:reverse_by_date] = value.content
          end
          if value.name == "reverseByName"
            param_hash[:reverse_by_name] = value.content
          end
          if value.name == "defaultValue"
            param_hash[:default] = value.content
          end
          param_hash[:max_tags] = value.content if value.name == "maxTags"
          param_hash[:uuid] = value.content if value.name == "uuid"
        end
      when "hudson.model.ChoiceParameterDefinition"
        param_hash[:type] = 'choice'
        param.children.each do |value|
          param_hash[:name] = value.content if value.name == "name"
          param_hash[:description] = value.content \
            if value.name == "description"
          choices = []
          if value.name == "choices"
            value.children.each do |value_child|
              if value_child.name == "a"
                value_child.children.each do |choice_child|
                  choices << choice_child.content.strip \
                    unless choice_child.content.strip.empty?
                end
              end
            end
          end
          param_hash[:choices] = choices unless choices.empty?
        end
      end
      params_array << param_hash unless param_hash.empty?
    end
  end
  params_array
end

- (Object) get_builds(job_name)

Obtain build details of a specific job

Parameters:

  • job_name (String) 


648
649
650
651
652
 
# File 'lib/jenkins_api_client/job.rb', line 648

def get_builds(job_name)
  @logger.info "Obtaining the build details of '#{job_name}'"
  response_json = @client.api_get_request("/job/#{path_encode job_name}")
  response_json["builds"]
end

- (String) get_config(job_name)

Obtain the configuration stored in config.xml of a specific job

Parameters:

  • job_name (String)

Returns:

  • (String) —

    XML Config.xml of the job



984
985
986
987
 
# File 'lib/jenkins_api_client/job.rb', line 984

def get_config(job_name)
  @logger.info "Obtaining the config.xml of '#{job_name}'"
  @client.get_config("/job/#{path_encode job_name}")
end

- (Hash) get_console_output(job_name, build_num = 0, start = 0, mode = 'text')

Get progressive console output from Jenkins server for a job

Parameters:

  • job_name (String) —

    Name of the Jenkins job

  • build_num (Number) (defaults to: 0) —

    Specific build number to obtain the console output from. Default is the recent build

  • start (Number) (defaults to: 0) —

    start offset to get only a portion of the text

  • mode (String) (defaults to: 'text') —

    Mode of text output. ‘text’ or ‘html’

Returns:

  • (Hash) —

    response

    • output console output of the job

    • size size of the text. This can be used as 'start' for the next call to get progressive output

    • more more data available for the job. 'true' if available and nil otherwise



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/jenkins_api_client/job.rb', line 511

def get_console_output(job_name, build_num = 0, start = 0, mode = 'text')
  build_num = get_current_build_number(job_name) if build_num == 0
  if build_num == 0
    puts "No builds for this job '#{job_name}' yet."
    return nil
  end
  if mode == 'text'
    mode = 'Text'
  elsif mode == 'html'
    mode = 'Html'
  else
    raise "Mode should either be 'text' or 'html'. You gave: #{mode}"
  end
  get_msg = "/job/#{path_encode job_name}/#{build_num}/logText/progressive#{mode}?"
  get_msg << "start=#{start}"
  raw_response = true
  api_response = @client.api_get_request(get_msg, nil, nil, raw_response)
  #puts "Response: #{api_response.header['x-more-data']}"
  response = {}
  response['output'] = api_response.body
  response['size'] = api_response.header['x-text-size']
  response['more'] = api_response.header['x-more-data']

  response
end

- (Integer) get_current_build_number(job_name) Also known as: build_number

Obtain the current build number of the given job This function returns nil if there were no builds for the given job.

Parameters:

  • job_name (String)

Returns:

  • (Integer) —

    current build number of the given job



704
705
706
707
 
# File 'lib/jenkins_api_client/job.rb', line 704

def get_current_build_number(job_name)
  @logger.info "Obtaining the current build number of '#{job_name}'"
  @client.api_get_request("/job/#{path_encode job_name}")['nextBuildNumber'].to_i - 1
end

- (String) get_current_build_status(job_name) Also known as: status

Obtain the current build status of the job By defaule Jenkins returns the color of the job status icon This function translates the color into a meaningful status

Parameters:

  • job_name (String)

Returns:

  • (String) —

    status current status of the given job



690
691
692
693
694
 
# File 'lib/jenkins_api_client/job.rb', line 690

def get_current_build_status(job_name)
  @logger.info "Obtaining the current build status of '#{job_name}'"
  response_json = @client.api_get_request("/job/#{path_encode job_name}")
  color_to_status(response_json["color"])
end

- (Object) get_downstream_projects(job_name)

List downstream projects of a specific job

Parameters:

  • job_name (String) —

    the name of the job to obtain downstream projects for



638
639
640
641
642
 
# File 'lib/jenkins_api_client/job.rb', line 638

def get_downstream_projects(job_name)
  @logger.info "Obtaining the down stream projects of '#{job_name}'"
  response_json = @client.api_get_request("/job/#{path_encode job_name}")
  response_json["downstreamProjects"]
end

- (Hash) get_promotions(job_name)

Get a list of promoted builds for given job

Parameters:

  • job_name (String)

Returns:

  • (Hash) —

    Hash map of promitions and the promoted builds. Promotions that didn’t took place yet return nil



1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
 
# File 'lib/jenkins_api_client/job.rb', line 1408

def get_promotions(job_name)
  result = {}

  @logger.info "Obtaining the promotions of '#{job_name}'"
  response_json = @client.api_get_request("/job/#{job_name}/promotion")

  response_json["processes"].each do |promotion|
    @logger.info "Getting promotion details of '#{promotion['name']}'"

    if promotion['color'] == 'notbuilt'
      result[promotion['name']] = nil
    else
      promo_json = @client.api_get_request("/job/#{job_name}/promotion/latest/#{promotion['name']}")
      result[promotion['name']] = promo_json['target']['number']
    end
  end

  result
end

- (Object) get_test_results(job_name, build_num)

Obtain the test results for a specific build of a job

Parameters:

  • job_name (String)
  • build_num (Number) 


1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/jenkins_api_client/job.rb', line 1006

def get_test_results(job_name, build_num)
  build_num = get_current_build_number(job_name) if build_num == 0
  @logger.info "Obtaining the test results of '#{job_name}'" +
    " Build ##{build_num}"
  @client.api_get_request("/job/#{path_encode job_name}/#{build_num}/testReport")
rescue Exceptions::NotFound
  # Not found is acceptable, as not all builds will have test results
  # and this is what jenkins throws at us in that case
  nil
end

- (Object) get_upstream_projects(job_name)

List upstream projects of a specific job

Parameters:

  • job_name (String) —

    the name of the job to obtain upstream projects for



627
628
629
630
631
 
# File 'lib/jenkins_api_client/job.rb', line 627

def get_upstream_projects(job_name)
  @logger.info "Obtaining the upstream projects of '#{job_name}'"
  response_json = @client.api_get_request("/job/#{path_encode job_name}")
  response_json["upstreamProjects"]
end

- (Array<String>) list(filter, ignorecase = true)

List all jobs that match the given regex

Parameters:

  • filter (String) —

    a regular expression or a string to filter jobs

  • ignorecase (Boolean) (defaults to: true) —

    whether to ignore case or not

Returns:

  • (Array<String>) —

    jobs matching the given pattern



587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/jenkins_api_client/job.rb', line 587

def list(filter, ignorecase = true)
  @logger.info "Obtaining jobs matching filter '#{filter}'"
  response_json = @client.api_get_request("")
  jobs = []
  response_json["jobs"].each do |job|
    if ignorecase
      jobs << job["name"] if job["name"] =~ /#{filter}/i
    else
      jobs << job["name"] if job["name"] =~ /#{filter}/
    end
  end
  jobs
end

- (Array<String>) list_all

List all jobs on the Jenkins CI server

Returns:

  • (Array<String>) —

    the names of all jobs in jenkins



541
542
543
544
 
# File 'lib/jenkins_api_client/job.rb', line 541

def list_all
  response_json = @client.api_get_request("", "tree=jobs[name]")["jobs"]
  response_json.map { |job| job["name"] }.sort
end

- (Array<Hash>) list_all_with_details

List all jobs on the Jenkins CI server along with their details

Returns:

  • (Array<Hash>) —

    the details of all jobs in jenkins



605
606
607
608
609
 
# File 'lib/jenkins_api_client/job.rb', line 605

def list_all_with_details
  @logger.info "Obtaining the details of all jobs"
  response_json = @client.api_get_request("")
  response_json["jobs"]
end

- (Array<String>) list_by_status(status, jobs = [])

List all Jobs matching the given status You can optionally pass in jobs list to filter the status from

Parameters:

  • status (String) —

    the job status to filter

  • jobs (Array<String>) (defaults to: []) —

    if specified this array will be used for filtering by the status otherwise the filtering will be done using all jobs available in jenkins

Returns:

  • (Array<String>) —

    filtered jobs



566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/jenkins_api_client/job.rb', line 566

def list_by_status(status, jobs = [])
  jobs = list_all if jobs.empty?
  @logger.info "Obtaining jobs matching status '#{status}'"
  json_response = @client.api_get_request("", "tree=jobs[name,color]")
  filtered_jobs = []
  json_response["jobs"].each do |job|
    if color_to_status(job["color"]) == status &&
       jobs.include?(job["name"])
      filtered_jobs << job["name"]
    end
  end
  filtered_jobs
end

- (Hash) list_details(job_name)

List details of a specific job

Parameters:

  • job_name (String) —

    the name of the job to obtain the details from

Returns:

  • (Hash) —

    the details of the specified job



617
618
619
620
 
# File 'lib/jenkins_api_client/job.rb', line 617

def list_details(job_name)
  @logger.info "Obtaining the details of '#{job_name}'"
  @client.api_get_request("/job/#{path_encode job_name}")
end

- (String) poll(job_name)

Programatically schedule SCM polling for the specified job

Parameters:

  • job_name (String) —

    the name of the job

Returns:

  • (String) —

    the response code from the HTTP post request



955
956
957
958
 
# File 'lib/jenkins_api_client/job.rb', line 955

def poll(job_name)
  @logger.info "Polling SCM changes for job '#{job_name}'"
  @client.api_post_request("/job/#{job_name}/polling")
end

- (String) post_config(job_name, xml)

Post the configuration of a job given the job name and the config.xml

Parameters:

  • job_name (String)
  • xml (String)

Returns:

  • (String) —

    response_code return code from HTTP POST



996
997
998
999
 
# File 'lib/jenkins_api_client/job.rb', line 996

def post_config(job_name, xml)
  @logger.info "Posting the config.xml of '#{job_name}'"
  @client.post_config("/job/#{path_encode job_name}/config.xml", xml)
end

- (String) recreate(job_name)

Re-create the same job This is a hack to clear any existing builds

Parameters:

  • job_name (String) —

    the name of the job to recreate

Returns:

  • (String) —

    the response from the HTTP POST request



474
475
476
477
478
479
 
# File 'lib/jenkins_api_client/job.rb', line 474

def recreate(job_name)
  @logger.info "Recreating job '#{job_name}'"
  job_xml = get_config(job_name)
  delete(job_name)
  create(job_name, job_xml)
end

- (String) remove_downstream_projects(job_name)

Remove all downstream projects of a specific job

Parameters:

  • job_name (String)

Returns:

  • (String) —

    response_code return code from HTTP POST



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/jenkins_api_client/job.rb', line 1302

def remove_downstream_projects(job_name)
  @logger.info "Removing the downstream projects of '#{job_name}'"
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  n_xml.search("//hudson.tasks.BuildTrigger").each do |node|
    child_project_trigger = false
    node.search("//childProjects").each do |child_node|
      child_project_trigger = true
      child_node.search("//threshold").each do |threshold_node|
        threshold_node.children.each do |threshold_value_node|
          threshold_value_node.content = nil
          threshold_value_node.remove
        end
        threshold_node.content = nil
        threshold_node.remove
      end
      child_node.content = nil
      child_node.remove
    end
    node.content = nil
    node.remove
  end
  publisher_node = n_xml.search("//publishers").first
  publisher_node.content = nil if publisher_node.children.empty?
  xml_modified = n_xml.to_xml
  post_config(job_name, xml_modified)
end

- (Object) rename(old_job, new_job)

Rename a job given the old name and new name

Parameters:

  • old_job (String) —

    Name of the old job

  • new_job (String) —

    Name of the new job.



407
408
409
410
 
# File 'lib/jenkins_api_client/job.rb', line 407

def rename(old_job, new_job)
  @logger.info "Renaming job '#{old_job}' to '#{new_job}'"
  @client.api_post_request("/job/#{path_encode old_job}/doRename?newName=#{form_encode new_job}")
end

- (String) restrict_to_node(job_name, node_name)

Resctrict the given job to a specific node

Parameters:

  • job_name (String)
  • node_name (String)

Returns:

  • (String) —

    response_code return code from HTTP POST



1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
 
# File 'lib/jenkins_api_client/job.rb', line 1337

def restrict_to_node(job_name, node_name)
  @logger.info "Restricting '#{job_name}' to '#{node_name}' node"
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  if (node = n_xml.xpath("//assignedNode").first)
    node.content = node_name
  else
    project = n_xml.xpath("//scm").first
    project.add_next_sibling("<assignedNode>#{node_name}</assignedNode>")
    roam_node = n_xml.xpath("//canRoam").first
    roam_node.content = "false"
  end
  xml_modified = n_xml.to_xml
  post_config(job_name, xml_modified)
end

- (Object) stop_build(job_name, build_number = 0) Also known as: stop, abort

Stops a running build of a job This method will stop the current/most recent build if no build number is specified. The build will be stopped only if it was in 'running' state.

Parameters:

  • job_name (String) —

    the name of the job to stop the build

  • build_number (Number) (defaults to: 0) —

    the build number to stop



452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/jenkins_api_client/job.rb', line 452

def stop_build(job_name, build_number = 0)
  build_number = get_current_build_number(job_name) if build_number == 0
  raise "No builds for #{job_name}" unless build_number
  @logger.info "Stopping job '#{job_name}' Build ##{build_number}"
  # Check and see if the build is running
  is_building = @client.api_get_request(
    "/job/#{path_encode job_name}/#{build_number}"
  )["building"]
  if is_building
    @client.api_post_request("/job/#{path_encode job_name}/#{build_number}/stop")
  end
end

- (Object) to_s

Return a string representation of the object



49
50
51
 
# File 'lib/jenkins_api_client/job.rb', line 49

def to_s
  "#<JenkinsApi::Client::Job>"
end

- (String) unblock_build_when_downstream_building(job_name)

Unblock the build of the job when downstream is building

Parameters:

  • job_name (String)

Returns:

  • (String) —

    response_code return code from HTTP POST



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'lib/jenkins_api_client/job.rb', line 1072

def unblock_build_when_downstream_building(job_name)
  @logger.info "Unblocking builds of '#{job_name}' when downstream" +
    " projects are building"
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  node = n_xml.xpath("//blockBuildWhenDownstreamBuilding").first
  if node.content == "true"
    node.content = "false"
    xml_modified = n_xml.to_xml
    post_config(job_name, xml_modified)
  end
end

- (String) unblock_build_when_upstream_building(job_name)

Unblock the build of the job when upstream is building

Parameters:

  • job_name (String)

Returns:

  • (String) —

    response_code return code from HTTP POST



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/jenkins_api_client/job.rb', line 1110

def unblock_build_when_upstream_building(job_name)
  @logger.info "Unblocking builds of '#{job_name}' when upstream" +
    " projects are building"
  xml = get_config(job_name)
  n_xml = Nokogiri::XML(xml)
  node = n_xml.xpath("//blockBuildWhenUpstreamBuilding").first
  if node.content == "true"
    node.content = "false"
    xml_modified = n_xml.to_xml
    post_config(job_name, xml_modified)
  end
end

- (Object) unchain(job_names)

Unchain any existing chain between given job names

Parameters:

  • job_names (Array) —

    Array of job names to be unchained



1357
1358
1359
1360
 
# File 'lib/jenkins_api_client/job.rb', line 1357

def unchain(job_names)
  @logger.info "Unchaining jobs: #{job_names.inspect}"
  job_names.each { |job| remove_downstream_projects(job) }
end

- (String) update(job_name, xml)

Update a job with the name specified and the xml given

Parameters:

  • job_name (String) —

    the name of the job

  • xml (String) —

    the xml configuration of the job

Returns:

  • (String) —

    the HTTP status code from the POST request

See Also:



96
97
98
99
 
# File 'lib/jenkins_api_client/job.rb', line 96

def update(job_name, xml)
  @logger.info "Updating job '#{job_name}'"
  post_config(job_name, xml)
end

- (String) update_freestyle(params)

Update a job with params given as a hash instead of the xml. For the parameter description see #create_or_update_freestyle

Parameters:

  • params (Hash) —

    parameters to update a freestyle project

Returns:

  • (String) —

    the HTTP status code from the POST request

See Also:



214
215
216
217
 
# File 'lib/jenkins_api_client/job.rb', line 214

def update_freestyle(params)
  xml = build_freestyle_config(params)
  update(params[:name], xml)
end

- (String) wipe_out_workspace(job_name)

Wipe out the workspace for a job given the name

Parameters:

  • job_name (String) —

    the name of the job to wipe out the workspace

Returns:

  • (String) —

    response from the HTTP POST request



439
440
441
442
 
# File 'lib/jenkins_api_client/job.rb', line 439

def wipe_out_workspace(job_name)
  @logger.info "Wiping out the workspace of job '#{job_name}'"
  @client.api_post_request("/job/#{path_encode job_name}/doWipeOutWorkspace")
end