Module: Jenkins::Api

Includes:
HTTParty
Defined in:
lib/jenkins/api.rb

Constant Summary collapse

JobAlreadyExistsError =

http_proxy ‘localhost’, ‘8888’

Class.new(Exception)

Class Method Summary collapse

Class Method Details

.add_node(options = {}) ⇒ Object

Adds SSH nodes only, for now



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/jenkins/api.rb', line 122

def self.add_node(options = {})
  options = options.with_clean_keys
  default_options = Hash.new
  if options[:vagrant]
    default_options.merge!(
      :slave_port  => 2222,
      :slave_user  => 'vagrant',
      :master_key  => "/Library/Ruby/Gems/1.8/gems/vagrant-0.6.7/keys/vagrant", # FIXME - hardcoded master username assumption
      :slave_fs    => "/vagrant/tmp/jenkins-slave/",
      :description => "Automatically created by Jenkins.rb",
      :executors   => 2,
      :exclusive   => true
    )
  else
    default_options.merge!(
      :slave_port  => 22,
      :slave_user  => 'deploy',
      :master_key  => "/home/deploy/.ssh/id_rsa", # FIXME - hardcoded master username assumption
      :slave_fs    => "/data/jenkins-slave/",
      :description => "Automatically created by Jenkins.rb",
      :executors   => 2,
      :exclusive   => true
    )
  end
  options    = default_options.merge(options)

  slave_host = options[:slave_host]
  name       = options[:name] || slave_host
  labels     = options[:labels].split(/\s*,\s*/).join(' ') if options[:labels]

  type = "hudson.slaves.DumbSlave$DescriptorImpl"

  fields = {
    "name" => name,
    "type" => type,

    "json"                => {
      "name"              => name,
      "nodeDescription"   => options[:description],
      "numExecutors"      => options[:executors],
      "remoteFS"          => options[:slave_fs],
      "labelString"       => labels,
      "mode"              => options[:exclusive] ? "EXCLUSIVE" : "NORMAL",
      "type"              => type,
      "retentionStrategy" => { "stapler-class"  => "hudson.slaves.RetentionStrategy$Always" },
      "nodeProperties"    => { "stapler-class-bag" => "true" },
      "launcher"          => {
        "stapler-class" => "hudson.plugins.sshslaves.SSHLauncher",
        "host"          => slave_host,
        "port"          => options[:slave_port],
        "username"      => options[:slave_user],
        "privatekey"    => options[:master_key],
      }
    }.to_json
  }

  url = URI.parse("#{base_uri}/computer/doCreateItem")

  req = Net::HTTP::Post.new(url.path)
  req.set_form_data(fields)

  http = Net::HTTP.new(url.host, url.port)

  response = http.request(req)
  case response
  when Net::HTTPFound
    { :name => name, :slave_host => slave_host }
  else
    # error message looks like:
    # <td id="main-panel">
    # <h1>Error</h1><p>Slave called 'localhost' already exists</p>
    require "hpricot"
    error = Hpricot(response.body).search("td#main-panel p").text
    unless error.blank?
      puts error
    else
      puts response.body # so we can find other errors
    end
    false
  end
end

.build_details(job_name, build_number) ⇒ Object

Return a hash of information about a build.



105
106
107
108
109
110
111
112
113
 
# File 'lib/jenkins/api.rb', line 105

def self.build_details(job_name, build_number)
  begin
    json = get "/job/#{job_name}/#{build_number}/api/json"
    cache_configuration!
    json
  rescue Crack::ParseError
    false
  end
end

.build_job(name) ⇒ Object 



78
79
80
81
 
# File 'lib/jenkins/api.rb', line 78

def self.build_job(name)
  res = get_plain "/job/#{name}/build"
  res.code.to_i == 302
end

.cache_configuration! ⇒ Object 



228
229
230
231
232
 
# File 'lib/jenkins/api.rb', line 228

def self.cache_configuration!
  Jenkins::Config.config["base_uri"] = base_uri
  Jenkins::Config.config["basic_auth"] = default_options[:basic_auth]
  Jenkins::Config.store!
end

.create_job(name, job_config, options = {}) ⇒ Object

returns true if successfully create a new job on Jenkins job_config is a Jenkins::JobConfigBuilder instance options are:

:override - true, will delete any existing job with same name, else error

returns true if successful, else false

TODO Exceptions?



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/jenkins/api.rb', line 42

def self.create_job(name, job_config, options = {})
  options = options.with_clean_keys
  delete_job(name) if options[:override]
  begin
    res = post "/createItem/api/xml?name=#{CGI.escape(name)}", {
      :body => job_config.to_xml, :format => :xml, :headers => { 'content-type' => 'application/xml' }
    }
    if res.code.to_i == 200
      cache_configuration!
      true
    else
      require "hpricot"
      doc = Hpricot(res.body)
      error_msg = doc.search("td#main-panel p")
      unless error_msg.inner_text.blank?
        $stderr.puts error_msg.inner_text
      else
        # TODO - what are the errors we get?
        puts "Server error:"
        p res.code
        puts res.body
      end
      false
    end
  rescue REXML::ParseException => e
    # For some reason, if the job exists we get back half a page of HTML
    raise JobAlreadyExistsError.new(name)
  end
end

.delete_job(name) ⇒ Object

Attempts to delete a job name



73
74
75
76
 
# File 'lib/jenkins/api.rb', line 73

def self.delete_job(name)
  res = post_plain "#{job_url name}/doDelete"
  res.code.to_i == 302
end

.delete_node(name) ⇒ Object 



204
205
206
 
# File 'lib/jenkins/api.rb', line 204

def self.delete_node(name)
  post_plain("#{base_uri}/computer/#{CGI::escape(name).gsub('+', '%20')}/doDelete/api/json")
end

.get_plain(path, options = {}) ⇒ Object

Helper for GET that don’t barf at Jenkins’s crappy API responses



222
223
224
225
226
 
# File 'lib/jenkins/api.rb', line 222

def self.get_plain(path, options = {})
  options = options.with_clean_keys
  uri = URI.parse base_uri
  res = Net::HTTP.start(uri.host, uri.port) { |http| http.get(path, options) }
end

.job(name) ⇒ Object

Return hash of job statuses



94
95
96
97
98
99
100
101
102
 
# File 'lib/jenkins/api.rb', line 94

def self.job(name)
  begin
    json = get "/job/#{name}/api/json"
    cache_configuration!
    json
  rescue Crack::ParseError
    false
  end
end

.job_names ⇒ Object 



89
90
91
 
# File 'lib/jenkins/api.rb', line 89

def self.job_names
  summary["jobs"].map {|job| job["name"]}
end

.nodes ⇒ Object 



115
116
117
118
119
 
# File 'lib/jenkins/api.rb', line 115

def self.nodes
  json = get "/computer/api/json"
  cache_configuration!
  json
end

.post_plain(path, data = "", options = {}) ⇒ Object

Helper for POST that don’t barf at Jenkins’s crappy API responses



209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/jenkins/api.rb', line 209

def self.post_plain(path, data = "", options = {})
  options = options.with_clean_keys
  uri = URI.parse base_uri
  res = Net::HTTP.start(uri.host, uri.port) do |http|
    if RUBY_VERSION =~ /1.8/
      http.post(path, options)
    else
      http.post(path, data, options)
    end
  end
end

.setup_base_url(options) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/jenkins/api.rb', line 19

def self.setup_base_url(options)
  options = options.with_clean_keys
  # Thor's HashWithIndifferentAccess is based on string keys which URI::HTTP.build ignores
  options = options.inject({}) { |mem, (key, val)| mem[key.to_sym] = val; mem }
  options = setup_authentication(options)
  options[:host] ||= ENV['JENKINS_HOST']
  options[:port] ||= ENV['JENKINS_PORT']
  options[:port] &&= options[:port].to_i
  return false unless options[:host] || Jenkins::Config.config["base_uri"]
  uri_class = options.delete(:ssl) ? URI::HTTPS : URI::HTTP
  uri = options[:host] ? uri_class.build(options) : Jenkins::Config.config["base_uri"]
  base_uri uri.to_s
  uri
end

.summary ⇒ Object 



83
84
85
86
87
 
# File 'lib/jenkins/api.rb', line 83

def self.summary
  json = get "/api/json"
  cache_configuration!
  json
end