Class: CapistranoMulticonfigParallel::Job

Inherits:
Object
  • Object
show all
Includes:
ApplicationHelper
Defined in:
lib/capistrano_multiconfig_parallel/classes/job.rb

Overview

class used for defining the job class

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ApplicationHelper

action_confirmed?, fetch_parsed_string, fetch_remaining_arguments, find_remaining_args, get_question_details, msg_for_stdin?, msg_for_task?, parse_task_string, percent_of, regex_last_match, setup_command_line_standard, wrap_string

Methods included from CapistranoHelper

env_key_format, env_prefix, filtered_env_keys_format, setup_flags_for_job, trace_flag

Methods included from GemHelper

fetch_gem_version, find_loaded_gem, find_loaded_gem_property, format_gem_version, get_parsed_version, verify_gem_version

Methods included from StagesHelper

app_names_from_stages, check_stage_path, checks_paths, fetch_stages_app, fetch_stages_from_file, fetch_stages_paths, independent_deploy?, multi_apps?, sorted_paths, stages, stages_paths, stages_root

Methods included from ParseHelper

check_hash_set, check_numeric, strip_characters_from_string, value_is_array?, verify_array_of_strings, verify_empty_options, warn_array_without_strings

Methods included from CoreHelper

app_debug_enabled?, ask_confirm, ask_stdout_confirmation, check_terminal_tty, debug_websocket?, error_filtered?, execute_with_rescue, find_worker_log, force_confirmation, format_error, log_error, log_output_error, log_to_file, multi_fetch_argv, print_to_log_file, rescue_error, rescue_interrupt, setup_filename_logger, setup_logger_formatter, show_warning, terminal_actor, terminal_errors?, websocket_config, websocket_server_config

Methods included from InternalHelper

arg_is_in_default_config?, check_file, create_log_file, custom_commands, default_config_keys, default_internal_config, default_internal_configuration_params, detect_root, enable_main_log_file, fail_capfile_not_found, fetch_default_internal_config, find_config_type, find_env_multi_cap_root, find_file_in_directory, internal_config_directory, internal_config_file, log_directory, main_log_file, multi_level_prop, pathname_is_root?, pwd_directory, pwd_parent_dir, root, setup_default_configuration_types, sliced_default_config, try_detect_file

Constructor Details

#initialize(application, options) ⇒ Job

Returns a new instance of Job.



21
22
23
24
25
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 21

def initialize(application, options)
  @options = options.stringify_keys
  @application = application
  @manager = @application.manager
end

Instance Attribute Details

#application ⇒ Object (readonly)

Returns the value of attribute application.



8
9
10
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 8

def application
  @application
end

#exit_status=(value) ⇒ Object (writeonly)

Sets the attribute exit_status

Parameters:

  • value —

    the value to set the attribute exit_status to.



9
10
11
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 9

def exit_status=(value)
  @exit_status = value
end

#manager ⇒ Object (readonly)

Returns the value of attribute manager.



8
9
10
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 8

def manager
  @manager
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



8
9
10
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 8

def options
  @options
end

#status=(value) ⇒ Object (writeonly)

Sets the attribute status

Parameters:

  • value —

    the value to set the attribute status to.



9
10
11
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 9

def status=(value)
  @status = value
end

Instance Method Details

#command ⇒ Object 



39
40
41
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 39

def command
  @command ||= CapistranoMulticonfigParallel::JobCommand.new(self)
end

#crashed? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 109

def crashed?
  worker_died? || failed? || dead? || exit_status.present?
end

#dead? ⇒ Boolean

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 113

def dead?
  status.present? && status.to_s.downcase == 'dead'
end

#env_variable ⇒ Object 



35
36
37
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 35

def env_variable
  CapistranoMulticonfigParallel::ENV_KEY_JOB_ID
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 101

def failed?
  ['deploy:failed'].include?(status)
end

#finished? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 97

def finished?
  status == 'finished'
end

#id ⇒ Object 



75
76
77
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 75

def id
  @id ||= @options.fetch('id', SecureRandom.uuid)
end

#rolling_back? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 105

def rolling_back?
  ['deploy:rollback'].include?(action)
end

#row_size ⇒ Object 



57
58
59
60
61
62
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 57

def row_size
  longest_hash = terminal_row.max_by do |hash|
    hash[:value].size
  end
  (longest_hash[:value].size.to_f / 80.0).ceil
end

#save_stderr_error(data) ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 27

def save_stderr_error(data)
  return unless @manager.alive?
  stderr_buffer.rewind
  old_data = stderr_buffer.read.dup
  new_data = old_data.to_s + data
  stderr_buffer.write(new_data) if ['aborted!', 'Terminating', 'Error'].any? { |word| new_data.include?(word) }
end

#terminal_env_variables ⇒ Object 



43
44
45
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 43

def terminal_env_variables
  setup_command_line(filtered_keys: [env_variable])
end

#terminal_row ⇒ Object 



47
48
49
50
51
52
53
54
55
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 47

def terminal_row
  [
    { value: id.to_s },
    { value: wrap_string(job_stage) },
    { value: wrap_string(capistrano_action) },
    { value: terminal_env_variables.map { |str| wrap_string(str) }.join("\n") },
    { value: wrap_string(worker_state) }
  ]
end

#to_json ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 125

def to_json
  hash = {}
  %w(id app stage action task_arguments env_options status exit_status).each do |key|
    hash[key] = send(key)
  end
  hash
end

#work_done? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 121

def work_done?
  finished? || crashed?
end

#worker ⇒ Object 



64
65
66
67
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 64

def worker
  return unless @manager.alive?
  @manager.get_worker_for_job(id)
end

#worker_died? ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 117

def worker_died?
  !worker.alive?
end

#worker_state ⇒ Object 



69
70
71
72
73
 
# File 'lib/capistrano_multiconfig_parallel/classes/job.rb', line 69

def worker_state
  worker_obj = worker
  default = status.to_s.upcase.red
  worker_obj.present? && worker_obj.alive? ? worker_obj.worker_state : default
end