Class: Debci::Job

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
Test::Duration, Test::Paths, Validators::APTSource
Defined in:
lib/debci/job.rb

Defined Under Namespace

Classes: InvalidStatusFile

Constant Summary collapse

PUBLIC_API = 
{
  trigger: 'the same string that was provided in the test submission. (string)',
  package: 'name of tested package (string)',
  arch: 'architecture where the test ran (string)',
  suite: 'suite where the test ran (string)',
  version: 'version of the package that was tested (string)',
  status: '"pass", "fail", or "tmpfail" (string), or *null* if the test didn\'t finish yet.',
  run_id: 'an id for the test run, generated by debci (integer)',
  is_private: 'bool value to specify whether test is private or not',
  extra_apt_sources: 'an array specifying extra apt sources added to `/etc/apt/sources.list.d` for the test.',
  updated_at: 'timestamp of the last update to the job (string)',
  date: 'timestamp of when the test run finished (string)',
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Test::Paths

#autopkgtest_dir, #debci_log, #purge_files, #result_json, #root

Methods included from Test::Duration

#duration_human

Methods included from Validators::APTSource

#invalid_extra_apt_sources

Class Method Details

.history(package, suite, arch) ⇒ Object 



269
270
271
272
273
274
275
 
# File 'lib/debci/job.rb', line 269

def self.history(package, suite, arch)
  Debci::Job.includes(:requestor).not_private.finished.where(
    package: package,
    suite: suite,
    arch: arch
  ).order('date')
end

.import(status_file) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/debci/job.rb', line 122

def self.import(status_file)
  status = JSON.parse(File.read(status_file))
  run_id = status.delete('run_id').to_i
  package = status.delete('package')
  job = Debci::Job.find(run_id)
  if package != job.package.name
    raise InvalidStatusFile.new("Data in %{file} is for package %{pkg}, while database says that job %{id} is for package %{origpkg}" % {
      file: status_file,
      pkg: package,
      id: run_id,
      origpkg: job.package,
    })
  end
  status.each do |k, v|
    job.send("#{k}=", v)
  end

  job.save!
  job
end

.pending ⇒ Object 



265
266
267
 
# File 'lib/debci/job.rb', line 265

def self.pending
  Debci::Job.includes(:requestor).not_private.where(status: nil).order(:created_at)
end

.platform_specific_issues ⇒ Object 



108
109
110
111
112
 
# File 'lib/debci/job.rb', line 108

def self.platform_specific_issues
  all_status.includes(:package).group_by(&:package).select do |_, statuses|
    statuses.map(&:status).uniq.size > 1
  end
end

.receive(directory) ⇒ Object 



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
203
204
205
206
207
208
 
# File 'lib/debci/job.rb', line 143

def self.receive(directory)
  src = Pathname(directory)
  id = src.basename.to_s
  begin
    job = Debci::Job.find(id)
  rescue ActiveRecord::RecordNotFound
    nil
  else
    exitcode = src / 'exitcode'
    unless exitcode.exist?
      job.status = "tmpfail"
      job.message = "Invalid test results received"
      return job
    end
    job.status, job.message = status(exitcode.read.to_i)
    duration = (src / 'duration')
    if duration.exist?
      job.duration_seconds = duration.read.to_i
      job.date = duration.stat.mtime
    else
      job.duration_seconds = 0
      job.date = Time.now
    end

    worker_file = (src / 'worker')
    if worker_file.exist?
      job.worker = Debci::Worker.find_or_create_by!(name: worker_file.read.strip)
    end

    testpkg_version = src / 'testpkg-version'
    if testpkg_version.exist?
      job.version = testpkg_version.read.split.last if testpkg_version
    else
      job.version = 'n/a'
    end

    if job.previous
      job.previous_status = job.previous.status
    end
    if job.last_pass
      job.last_pass_date = job.last_pass.date
      job.last_pass_version = job.last_pass.version
    end

    dest = job.autopkgtest_data_dir
    dest.parent.mkpath

    # remove destination directory if it exists; this can happen is a
    # previous receiving was interrupted (e.g. if the daemon is restarte)
    dest.rmtree if dest.exist?

    FileUtils.cp_r src, dest
    Dir.chdir dest do
      artifacts = Dir['*'] - ['log.gz']
      cmd = ['tar', '-caf', 'artifacts.tar.gz', '--remove-files', '--', *artifacts]
      system(*cmd) || raise('Command failed: %<cmd>s' % { cmd: cmd.join(' ') })
    end
    job.calculate_file_sizes!

    job.save!

    # only remove original directory after everything went well
    src.rmtree
    job
  end
end

.status(exit_code) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/debci/job.rb', line 244

def self.status(exit_code)
  case exit_code
  when 0
    ['pass', 'All tests passed']
  when 2
    ['pass', 'Tests passed, but at least one test skipped']
  when 4
    ['fail', 'Tests failed']
  when 6
    ['fail', 'Tests failed, and at least one test skipped']
  when 12, 14
    ['fail', 'Erroneous package']
  when 8
    ['neutral', 'No tests in this package or all skipped']
  when 16
    ['tmpfail', 'Could not run tests due to a temporary testbed failure']
  else
    ['tmpfail', "Unexpected autopkgtest exit code #{exit_code}"]
  end
end

Instance Method Details

#always_failing? ⇒ Boolean

Returns:

  • (Boolean) 


367
368
369
 
# File 'lib/debci/job.rb', line 367

def always_failing?
  last_pass_version.nil? || last_pass_version == 'n/a'
end

#as_json(options = nil) ⇒ Object 



304
305
306
307
308
309
 
# File 'lib/debci/job.rb', line 304

def as_json(options = nil)
  super(options).update(
    "duration_human" => self.duration_human,
    "package" => package.name,
  )
end

#autopkgtest_data_dir ⇒ Object 



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

def autopkgtest_data_dir
  @autopkgtest_data_dir ||= Pathname(Debci.config.autopkgtest_basedir) / autopkgtest_data_path
end

#autopkgtest_data_path ⇒ Object 



210
211
212
 
# File 'lib/debci/job.rb', line 210

def autopkgtest_data_path
  @autopkgtest_data_path ||= File.join(suite, arch, package.prefix, package.name, id.to_s)
end

#backend ⇒ Object 



336
337
338
 
# File 'lib/debci/job.rb', line 336

def backend
  requested_backend || Debci::Backend.default
end

#calculate_file_sizes! ⇒ Object 



233
234
235
236
237
238
 
# File 'lib/debci/job.rb', line 233

def calculate_file_sizes!
  dir = self.autopkgtest_data_dir
  log = (dir / 'log.gz')
  self.log_size = log.size if log.exist?
  self.artifacts_size = (dir / 'artifacts.tar.gz').size
end

#cleanup(reason: "no reason given") ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/debci/job.rb', line 220

def cleanup(reason: "no reason given")
  self.purge_files
  self.files_purged = true
  self.save!
  Debci.log(
    'Cleaned up files for job %<job_id>s (%<job>s): %<reason>s' % {
      job_id: self.run_id,
      job: self,
      reason: reason,
    }
  )
end

#disk_usage ⇒ Object 



240
241
242
 
# File 'lib/debci/job.rb', line 240

def disk_usage
  (self.log_size || 0) + (self.artifacts_size || 0)
end

#enqueue(priority = 5) ⇒ Object 



328
329
330
331
332
333
334
 
# File 'lib/debci/job.rb', line 328

def enqueue(priority = 5)
  backend = Debci::Backend.select(package, arch)
  self.update(requested_backend: backend)
  queue = Debci::AMQP.get_queue(arch, backend)
  parameters = enqueue_parameters
  queue.publish("%s %s %s" % [package.name, suite, parameters.join(' ')], priority: priority)
end

#enqueue_parameters ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/debci/job.rb', line 311

def enqueue_parameters
  parameters = ['run-id:%s' % id]
  if self.trigger
    parameters << "trigger:#{CGI.escape(trigger)}"
  end
  Array(self.pin_packages).each do |pin|
    *pkgs, suite = pin
    parameters << "pin-packages:#{suite}=#{pkgs.join(',')}"
  end
  Array(self.extra_apt_sources).each do |name|
    src = Debci.extra_apt_sources_list.find(name)
    parameters << "extra-apt-source:#{Base64.strict_encode64(src.entry)}"
    parameters << "signing-key:#{Base64.strict_encode64(src.signing_key)}" if src.signing_key
  end
  parameters
end

#had_success? ⇒ Boolean

Returns:

  • (Boolean) 


371
372
373
 
# File 'lib/debci/job.rb', line 371

def had_success?
  !always_failing?
end

#headline ⇒ Object 



363
364
365
 
# File 'lib/debci/job.rb', line 363

def headline
  "#{package.name} #{version} #{status.upcase} on #{suite}/#{arch}"
end

#history ⇒ Object 



277
278
279
 
# File 'lib/debci/job.rb', line 277

def history
  @history ||= self.class.history(package, suite, arch)
end

#last_pass ⇒ Object 



289
290
291
 
# File 'lib/debci/job.rb', line 289

def last_pass
  @last_pass ||= previous_unpinned_jobs.where(status: 'pass').last
end

#pinned? ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/debci/job.rb', line 56

def pinned?
  !pin_packages.empty?
end

#previous ⇒ Object 



285
286
287
 
# File 'lib/debci/job.rb', line 285

def previous
  @previous ||= previous_unpinned_jobs.last
end

#previous_unpinned_jobs ⇒ Object 



281
282
283
 
# File 'lib/debci/job.rb', line 281

def previous_unpinned_jobs
  @previous_unpinned_jobs ||= history.not_pinned.where(["date < ?", date])
end

#public_api_attributes ⇒ Object 



32
33
34
35
36
37
38
 
# File 'lib/debci/job.rb', line 32

def public_api_attributes
  data = PUBLIC_API.keys.each_with_object({}) do |k, memo|
    memo[k] = self[k]
  end
  data["package"] = package.name
  data
end

#retry ⇒ Object 



340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/debci/job.rb', line 340

def retry
  new_job = Debci::Job.create!(
    package: self.package,
    suite: self.suite,
    arch: self.arch,
    requestor: self.requestor,
    trigger: self.trigger,
    pin_packages: self.pin_packages,
    is_private: self.is_private,
    extra_apt_sources: self.extra_apt_sources
  )
  new_job.enqueue
  new_job
end

#time ⇒ Object

Returns the amount of time since the date for this status object



294
295
296
297
298
299
300
301
302
 
# File 'lib/debci/job.rb', line 294

def time
  days = (Time.now - self.created_at)/86400

  if days >= 1 || days <= -1
    "#{days.floor} day(s) ago"
  else
    "#{Time.at(Time.now - self.created_at).gmtime.strftime('%H')} hour(s) ago"
  end
end

#title ⇒ Object 



359
360
361
 
# File 'lib/debci/job.rb', line 359

def title
  '%s %s' % [version, status]
end

#to_s ⇒ Object 



355
356
357
 
# File 'lib/debci/job.rb', line 355

def to_s
  "%s %s/%s (%s)" % [package.name, suite, arch, status || 'pending']
end