Class: Bricolage::JobNetRunner

Inherits:
Object
  • Object
show all
Defined in:
lib/bricolage/jobnetrunner.rb

Defined Under Namespace

Classes: Options

Constant Summary collapse

EXIT_SUCCESS = 
JobResult::EXIT_SUCCESS
EXIT_FAILURE = 
JobResult::EXIT_FAILURE
EXIT_ERROR = 
JobResult::EXIT_ERROR

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ JobNetRunner

Returns a new instance of JobNetRunner.



26
27
28
29
30
 
# File 'lib/bricolage/jobnetrunner.rb', line 26

def initialize
  @hooks = ::Bricolage
  @jobnet_id = nil
  @jobnet_start_time = Time.now
end

Class Method Details

.main ⇒ Object 



21
22
23
24
 
# File 'lib/bricolage/jobnetrunner.rb', line 21

def JobNetRunner.main
  Application.install_signal_handlers
  new.main
end

Instance Method Details

#app_name ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/bricolage/jobnetrunner.rb', line 108

def app_name
  path = @ctx.home_path.realpath
  while /\A(?:\d+|current|releases)\z/ =~ path.basename.to_s   # is Capistrano dirs
    path = path.dirname
  end
  path.basename.to_s
end

#check_jobs(queue) ⇒ Object 



131
132
133
134
135
 
# File 'lib/bricolage/jobnetrunner.rb', line 131

def check_jobs(queue)
  queue.each do |task|
    Job.load_ref(task.job, @ctx).compile
  end
end

#enqueue_jobs(jobnet, queue) ⇒ Object 



116
117
118
119
120
121
122
123
 
# File 'lib/bricolage/jobnetrunner.rb', line 116

def enqueue_jobs(jobnet, queue)
  seq = 1
  jobnet.sequential_jobs.each do |ref|
    queue.enq JobTask.new(ref)
    seq += 1
  end
  queue.save
end

#error_exit(msg) ⇒ Object 



186
187
188
189
 
# File 'lib/bricolage/jobnetrunner.rb', line 186

def error_exit(msg)
  print_error msg
  exit 1
end

#execute_job(ref, queue) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/bricolage/jobnetrunner.rb', line 153

def execute_job(ref, queue)
  logger.debug "job #{ref}"
  job_start_time = Time.now
  job = Job.load_ref(ref, @ctx)
  job.compile
  @hooks.run_before_job_hooks(BeforeJobEvent.new(ref))
  result = job.execute_in_process(log_locator: make_log_locator(ref, job_start_time))
  @hooks.run_after_job_hooks(AfterJobEvent.new(result))
  result
rescue Exception => ex
  logger.exception ex
  logger.error "unexpected error: #{ref} (#{ex.class}: #{ex.message})"
  JobResult.error(ex)
end

#get_queue(opts) ⇒ Object 



89
90
91
92
93
94
95
96
 
# File 'lib/bricolage/jobnetrunner.rb', line 89

def get_queue(opts)
  if path = get_queue_file_path(opts)
    logger.info "queue path: #{path}"
    FileTaskQueue.restore_if_exist(path)
  else
    TaskQueue.new
  end
end

#get_queue_file_path(opts) ⇒ Object 



98
99
100
101
102
103
104
105
106
 
# File 'lib/bricolage/jobnetrunner.rb', line 98

def get_queue_file_path(opts)
  if opts.queue_path
    opts.queue_path
  elsif opts.enable_queue?
    opts.local_state_dir + 'queue' + "#{app_name}.#{@jobnet_id.tr('/', '.')}"
  else
    nil
  end
end

#list_jobs(queue) ⇒ Object 



125
126
127
128
129
 
# File 'lib/bricolage/jobnetrunner.rb', line 125

def list_jobs(queue)
  queue.each do |task|
    puts task.job
  end
end

#logger ⇒ Object 



85
86
87
 
# File 'lib/bricolage/jobnetrunner.rb', line 85

def logger
  @ctx.logger
end

#main ⇒ Object 



36
37
38
39
40
41
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
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/bricolage/jobnetrunner.rb', line 36

def main
  opts = Options.new(self)
  @hooks.run_before_option_parsing_hooks(opts)
  opts.parse!(ARGV)

  @ctx = Context.for_application(job_path: opts.jobnet_file, environment: opts.environment, global_variables: opts.global_variables)
  opts.merge_saved_options(@ctx.load_system_options)

  jobnet = RootJobNet.load_auto(@ctx, opts.jobnet_file)
  @jobnet_id = jobnet.id

  if opts.dump_options?
    puts "jobnet-id=#{@jobnet_id}"
    puts "jobnet-file=#{opts.jobnet_file}"
    opts.option_pairs.each do |key, value|
      puts "#{key}=#{value.inspect}"
    end
    exit EXIT_SUCCESS
  end

  queue = get_queue(opts)
  if queue.locked?
    raise ParameterError, "Job queue is still locked. If you are sure to restart jobnet, #{queue.unlock_help}"
  end
  unless queue.queued?
    enqueue_jobs jobnet, queue
  end

  if opts.list_jobs?
    list_jobs queue
    exit EXIT_SUCCESS
  end
  check_jobs queue
  if opts.check_only?
    puts "OK"
    exit EXIT_SUCCESS
  end

  @log_locator_builder = LogLocatorBuilder.for_options(@ctx, opts.log_path_format, opts.log_s3_ds, opts.log_s3_key_format)
  run_queue queue
  exit EXIT_SUCCESS
rescue OptionError => ex
  raise if $DEBUG
  usage_exit ex.message, opts.help
rescue ApplicationError => ex
  raise if $DEBUG
  error_exit ex.message
end

#make_log_locator(ref, job_start_time) ⇒ Object 



168
169
170
171
172
173
174
175
 
# File 'lib/bricolage/jobnetrunner.rb', line 168

def make_log_locator(ref, job_start_time)
  @log_locator_builder.build(
    job_ref: ref,
    jobnet_id: @jobnet_id,
    job_start_time: job_start_time,
    jobnet_start_time: @jobnet_start_time
  )
end

#print_error(msg) ⇒ Object 



191
192
193
 
# File 'lib/bricolage/jobnetrunner.rb', line 191

def print_error(msg)
  $stderr.puts "#{program_name}: error: #{msg}"
end

#program_name ⇒ Object 



195
196
197
 
# File 'lib/bricolage/jobnetrunner.rb', line 195

def program_name
  File.basename($PROGRAM_NAME, '.*')
end

#run_queue(queue) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/bricolage/jobnetrunner.rb', line 137

def run_queue(queue)
  @hooks.run_before_all_jobs_hooks(BeforeAllJobsEvent.new(@jobnet_id, queue))
  queue.consume_each do |task|
    result = execute_job(task.job, queue)
    unless result.success?
      logger.elapsed_time 'jobnet total: ', (Time.now - @jobnet_start_time)
      logger.error "[job #{task.job}] #{result.message}"
      @hooks.run_after_all_jobs_hooks(AfterAllJobsEvent.new(false, queue))
      exit result.status
    end
  end
  @hooks.run_after_all_jobs_hooks(AfterAllJobsEvent.new(true, queue))
  logger.elapsed_time 'jobnet total: ', (Time.now - @jobnet_start_time)
  logger.info "status all green"
end

#usage_exit(msg, usage) ⇒ Object 



180
181
182
183
184
 
# File 'lib/bricolage/jobnetrunner.rb', line 180

def usage_exit(msg, usage)
  print_error msg
  $stderr.puts usage
  exit 1
end