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)',
  duration_seconds: 'duration of the test run, in seconds (integer)',
}.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 



287
288
289
290
291
292
293
 
# File 'lib/debci/job.rb', line 287

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 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/debci/job.rb', line 138

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 



283
284
285
 
# File 'lib/debci/job.rb', line 283

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

.platform_specific_issues ⇒ Object 



124
125
126
127
128
 
# File 'lib/debci/job.rb', line 124

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 



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/debci/job.rb', line 159

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.received_at = Time.now

    job.save!

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

.status(exit_code) ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/debci/job.rb', line 262

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) 


390
391
392
 
# File 'lib/debci/job.rb', line 390

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

#as_json(options = nil) ⇒ Object 



322
323
324
325
326
327
 
# File 'lib/debci/job.rb', line 322

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

#autopkgtest_data_dir ⇒ Object 



232
233
234
 
# File 'lib/debci/job.rb', line 232

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

#autopkgtest_data_path ⇒ Object 



228
229
230
 
# File 'lib/debci/job.rb', line 228

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

#backend ⇒ Object 



357
358
359
 
# File 'lib/debci/job.rb', line 357

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

#calculate_file_sizes! ⇒ Object 



251
252
253
254
255
256
 
# File 'lib/debci/job.rb', line 251

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 



238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/debci/job.rb', line 238

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 



258
259
260
 
# File 'lib/debci/job.rb', line 258

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

#enqueue(priority = 5) ⇒ Object 



349
350
351
352
353
354
355
 
# File 'lib/debci/job.rb', line 349

def enqueue(priority = 5)
  self.requested_backend ||= Debci::Backend.select(package, arch)
  save!
  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 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/debci/job.rb', line 329

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
  if autopkgtest
    parameters << "autopkgtest:#{autopkgtest}"
  end
  parameters
end

#had_success? ⇒ Boolean

Returns:

  • (Boolean) 


394
395
396
 
# File 'lib/debci/job.rb', line 394

def had_success?
  !always_failing?
end

#headline ⇒ Object 



386
387
388
 
# File 'lib/debci/job.rb', line 386

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

#history ⇒ Object 



295
296
297
 
# File 'lib/debci/job.rb', line 295

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

#last_pass ⇒ Object 



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

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

#pinned? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/debci/job.rb', line 67

def pinned?
  !pin_packages.empty?
end

#previous ⇒ Object 



303
304
305
 
# File 'lib/debci/job.rb', line 303

def previous
  @previous ||= previous_unpinned_jobs.last
end

#previous_unpinned_jobs ⇒ Object 



299
300
301
 
# File 'lib/debci/job.rb', line 299

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

#public_api_attributes ⇒ Object 



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

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 



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/debci/job.rb', line 361

def retry
  new_job = Debci::Job.create!(
    package: self.package,
    suite: self.suite,
    arch: self.arch,
    autopkgtest: autopkgtest,
    requested_backend: requested_backend,
    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



312
313
314
315
316
317
318
319
320
 
# File 'lib/debci/job.rb', line 312

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 



382
383
384
 
# File 'lib/debci/job.rb', line 382

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

#to_s ⇒ Object 



378
379
380
 
# File 'lib/debci/job.rb', line 378

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

#update_package_status ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/debci/job.rb', line 103

def update_package_status
  return if is_private
  return unless status
  return unless date
  return if pinned?

  transaction do
    next if history.where(['date > ?', date]).exists?

    status = Debci::PackageStatus.find_or_initialize_by(
      package: self.package,
      suite: self.suite,
      arch: self.arch,
    )
    status.job = self
    status.save!
  end

  nil
end