Class: CapistranoMulticonfigParallel::Application

Inherits:
Object
  • Object
show all
Includes:
Capistrano::DSL, Capistrano::Multiconfig::DSL, ApplicationHelper, Celluloid, Celluloid::Logger
Defined in:
lib/capistrano_multiconfig_parallel/application.rb

Overview

finds app dependencies, shows menu and delegates jobs to celluloid manager

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ApplicationHelper

action_confirmed?, check_hash_set, check_numeric, fetch_parsed_string, fetch_remaining_arguments, find_loaded_gem, find_remaining_args, get_question_details, msg_for_stdin?, msg_for_task?, multi_fetch_argv, parse_task_string, percent_of, regex_last_match, setup_command_line_standard, strip_characters_from_string, value_is_array?, verify_array_of_strings, verify_empty_options, warn_array_without_strings, wrap_string

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, print_to_log_file, rescue_error, rescue_interrupt, setup_filename_logger, setup_logger_formatter, show_warning, terminal_actor, websocket_config, websocket_server_config

Methods included from InternalHelper

check_file, config_file, create_log_file, custom_commands, 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_capfile

Constructor Details

#initialize ⇒ Application

Returns a new instance of Application.



14
15
16
17
18
19
20
21
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 14

def initialize
  Celluloid.boot
  CapistranoMulticonfigParallel.enable_logging
  @stage_apps = multi_apps? ? stages.map { |stage| stage.split(':').reverse[1] }.uniq : []
  collect_command_line_tasks(CapistranoMulticonfigParallel.original_args)
  @job_count = 0
  @jobs = []
end

Instance Attribute Details

#application ⇒ Object (readonly)

Returns the value of attribute application.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def application
  @application
end

#args ⇒ Object (readonly)

Returns the value of attribute args.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def args
  @args
end

#argv ⇒ Object (readonly)

Returns the value of attribute argv.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def argv
  @argv
end

#branch_backup ⇒ Object (readonly)

Returns the value of attribute branch_backup.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def branch_backup
  @branch_backup
end

#condition ⇒ Object (readonly)

Returns the value of attribute condition.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def condition
  @condition
end

#default_stage ⇒ Object (readonly)

Returns the value of attribute default_stage.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def default_stage
  @default_stage
end

#dependency_tracker ⇒ Object (readonly)

Returns the value of attribute dependency_tracker.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def dependency_tracker
  @dependency_tracker
end

#job_count ⇒ Object

Returns the value of attribute job_count.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def job_count
  @job_count
end

#jobs ⇒ Object (readonly)

Returns the value of attribute jobs.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def jobs
  @jobs
end

#manager ⇒ Object (readonly)

Returns the value of attribute manager.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def manager
  @manager
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def name
  @name
end

#stage ⇒ Object (readonly)

Returns the value of attribute stage.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def stage
  @stage
end

#stage_apps ⇒ Object (readonly)

Returns the value of attribute stage_apps.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def stage_apps
  @stage_apps
end

#top_level_tasks ⇒ Object (readonly)

Returns the value of attribute top_level_tasks.



11
12
13
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 11

def top_level_tasks
  @top_level_tasks
end

Instance Method Details

#backup_the_branch ⇒ Object 



55
56
57
58
59
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 55

def backup_the_branch
  return if custom_command? || @argv['BRANCH'].blank?
  @branch_backup = @argv['BRANCH'].to_s
  @argv['BRANCH'] = nil
end

#call_task_deploy_app(options = {}) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 186

def call_task_deploy_app(options = {})
  options = options.stringify_keys
  main_box_name = @argv['BOX'].blank? ? '' : @argv['BOX']
  stage = options.fetch('stage', @default_stage)
  if configuration.development_stages.include?(stage) && main_box_name.present? && /^[a-z0-9,]+/.match(main_box_name)
    execute_on_multiple_boxes(main_box_name, options)
  else
    prepare_job(options)
  end
end

#can_tag_staging? ⇒ Boolean

Returns:

  • (Boolean) 


145
146
147
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 145

def can_tag_staging?
  wants_deploy_production? && tag_staging_exists? && fetch_multi_stages.include?('staging')
end

#check_before_starting ⇒ Object 



104
105
106
107
108
109
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 104

def check_before_starting
  @dependency_tracker = CapistranoMulticonfigParallel::DependencyTracker.new(Actor.current)
  @default_stage = configuration.development_stages.present? ? configuration.development_stages.first : 'development'
  @condition = Celluloid::Condition.new
  @manager = CapistranoMulticonfigParallel::CelluloidManager.new(Actor.current)
end

#check_multi_stages(custom_stages) ⇒ Object 



149
150
151
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 149

def check_multi_stages(custom_stages)
  can_tag_staging? ? custom_stages.reject { |u| u == 'production' } : custom_stages
end

#collect_command_line_tasks(args) ⇒ Object

:nodoc:



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 86

def collect_command_line_tasks(args) # :nodoc:
  @argv = {}
  @top_level_tasks = []
  args.each do |arg|
    if arg =~ /^(\w+)=(.*)$/m
      @argv[Regexp.last_match(1)] = Regexp.last_match(2)
    else
      @top_level_tasks << arg unless arg =~ /^-/
    end
  end
  @top_level_tasks.push(Rake.application.default_task_name) if @top_level_tasks.blank?
end

#collect_jobs(options = {}, &_block) ⇒ Object 



111
112
113
114
115
116
117
118
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 111

def collect_jobs(options = {}, &_block)
  options = prepare_options(options)
  options = options.stringify_keys
  apps = @dependency_tracker.fetch_apps_needed_for_deployment(options['app'], options['action'])
  backup_the_branch if multi_apps?
  deploy_multiple_apps(apps, options)
  deploy_app(options) if !custom_command? || !multi_apps?
end

#custom_command? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
64
65
66
67
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 61

def custom_command?
  if multi_apps?
    !stages.include?(@top_level_tasks.first) && custom_commands.include?(@top_level_tasks.first)
  else
    !stages.include?(@top_level_tasks.second) && stages.include?(@top_level_tasks.first) && custom_commands.include?(@top_level_tasks.second)
  end
end

#deploy_app(options = {}) ⇒ Object 



153
154
155
156
157
158
159
160
161
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 153

def deploy_app(options = {})
  options = options.stringify_keys
  branch = @branch_backup.present? ? @branch_backup : @argv['BRANCH'].to_s
  call_task_deploy_app({
    branch: branch,
    app: options['app'],
    action: options['action']
  }.reverse_merge(options))
end

#deploy_multiple_apps(applications, options) ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 47

def deploy_multiple_apps(applications, options)
  options = options.stringify_keys
  return unless applications.present?
  applications.each do |app|
    deploy_app(options.merge('app' => app['app']))
  end
end

#execute_on_multiple_boxes(main_box_name, options) ⇒ Object 



262
263
264
265
266
267
268
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 262

def execute_on_multiple_boxes(main_box_name, options)
  boxes = strip_characters_from_string(main_box_name).split(',').compact
  boxes.each do |box_name|
    options['env_options']['BOX'] = box_name
    prepare_job(options)
  end
end

#fetch_app_additional_env_options(variable) ⇒ Object 



252
253
254
255
256
257
258
259
260
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 252

def fetch_app_additional_env_options(variable)
  options = {}
  return options if variable.blank?
  env_options = strip_characters_from_string(variable)
  env_options = env_options.split(' ')
  options = multi_fetch_argv(env_options)
  options.stringify_keys!
  options
end

#fetch_multi_stages ⇒ Object 



134
135
136
137
138
139
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 134

def fetch_multi_stages
  custom_stages = @argv['STAGES'].blank? ? '' : @argv['STAGES']
  custom_stages = strip_characters_from_string(custom_stages).split(',').compact if custom_stages.present?
  custom_stages = custom_stages.present? ? custom_stages : [@default_stage]
  custom_stages
end

#get_app_additional_env_options(app, app_message) ⇒ Object 



163
164
165
166
167
168
169
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 163

def get_app_additional_env_options(app, app_message)
  app_name = (app.is_a?(Hash) && app[:app].present?) ? app[:app].camelcase : app
  app_name = app_name.present? ? app_name : 'current application'
  message = "Please write additional ENV options for #{app_name} for #{app_message}"
  app_additional_env_options = ask_confirm(message, nil)
  fetch_app_additional_env_options(app_additional_env_options)
end

#initialize_data ⇒ Object 



79
80
81
82
83
84
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 79

def initialize_data
  @application = custom_command? ? nil : @top_level_tasks.first.split(':').reverse[1]
  @stage = custom_command? ? nil : @top_level_tasks.first.split(':').reverse[0]
  @stage = @stage.present? ? @stage : @default_stage
  @name, @args = parse_task_string(@top_level_tasks.second)
end

#multi_apps? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 69

def multi_apps?
  stages.find { |stage| stage.include?(':') }.present?
end

#prepare_job(options) ⇒ Object

rubocop:disable CyclomaticComplexity



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 221

def prepare_job(options)
  options = options.stringify_keys
  branch_name = options.fetch('branch', {})
  app = options.fetch('app', '')
  box = options['env_options']['BOX']
  message = box.present? ? "BOX #{box}:" : "stage #{options['stage']}:"
  env_opts = get_app_additional_env_options(app, message)

  options['env_options'] = options['env_options'].reverse_merge(env_opts)

  env_options = branch_name.present? ? { 'BRANCH' => branch_name }.merge(options['env_options']) : options['env_options']
  job_env_options = custom_command? && env_options['ACTION'].present? ? env_options.except('ACTION') : env_options
  @job_count += 1
  job = CapistranoMulticonfigParallel::Job.new(Actor.current, options.merge(
                                                                action: custom_command? && env_options['ACTION'].present? ? env_options['ACTION'] : options['action'],
                                                                env_options: job_env_options,
                                                                count: @job_count
  ))
  @jobs << job
end

#prepare_options(options) ⇒ Object 



242
243
244
245
246
247
248
249
250
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 242

def prepare_options(options)
  options = options.stringify_keys
  options['app'] = options.fetch('app', @application.to_s.clone)
  options['action'] = options.fetch('action', @name.to_s.clone)
  options['stage'] = options.fetch('stage', @stage.to_s.clone)
  options['env_options'] = options.fetch('env_options', @argv.clone)
  options['task_arguments'] = options.fetch('task_arguments', @args.clone)
  options
end

#process_jobs ⇒ Object 



120
121
122
123
124
125
126
127
128
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 120

def process_jobs
  return unless @jobs.present?
  FileUtils.rm Dir["#{log_directory}/worker_*.log"]
  if configuration.multi_secvential.to_s.downcase == 'true'
    @jobs.each(&:execute_standard_deploy)
  else
    run_async_jobs
  end
end

#run ⇒ Object 



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 175

def run
  options = {}
  if custom_command?
    options = verify_options_custom_command(options)
    run_custom_command(options)
  else
    collect_jobs(options)
  end
  process_jobs
end

#run_async_jobs ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 197

def run_async_jobs
  return unless @jobs.present?
  @jobs.pmap do |job|
    @manager.async.delegate(job)
  end
  unless can_tag_staging?
    until @manager.registration_complete
      sleep(0.1) # keep current thread alive
    end
    return unless @manager.registration_complete
    @manager.async.process_jobs
  end
  wait_jobs_termination
end

#run_custom_command(options) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 38

def run_custom_command(options)
  custom_stages = fetch_multi_stages
  return if custom_stages.blank?
  custom_stages = check_multi_stages(custom_stages)
  custom_stages.each do |stage|
    collect_jobs(options.merge('stage' => stage))
  end
end

#start ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 23

def start
  verify_app_dependencies if multi_apps? && configuration.application_dependencies.present?
  verify_valid_data
  check_before_starting
  initialize_data
  run
end

#tag_staging_exists? ⇒ Boolean

check exists task from capistrano-gitflow

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 130

def tag_staging_exists? # check exists task from capistrano-gitflow
  find_loaded_gem('capistrano-gitflow').present?
end

#verify_app_dependencies ⇒ Object

Raises:

  • (ArgumentError) 


31
32
33
34
35
36
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 31

def verify_app_dependencies
  wrong = configuration.application_dependencies.find do |hash|
    !@stage_apps.include?(hash[:app]) || (hash[:dependencies].present? && hash[:dependencies].find { |val| !@stage_apps.include?(val) })
  end
  raise ArgumentError, "Invalid configuration for #{wrong.inspect}".red if wrong.present?
end

#verify_options_custom_command(options) ⇒ Object 



99
100
101
102
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 99

def verify_options_custom_command(options)
  options[:action] = @argv['ACTION'].present? ? @argv['ACTION'] : 'deploy'
  options
end

#verify_valid_data ⇒ Object 



73
74
75
76
77
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 73

def verify_valid_data
  return  if  @top_level_tasks != ['default']
  puts 'Invalid execution, please call something such as `multi_cap production deploy`, where production is a stage you have defined'.red
  exit(false)
end

#wait_jobs_termination ⇒ Object 



212
213
214
215
216
217
218
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 212

def wait_jobs_termination
  return if configuration.multi_secvential.to_s.downcase == 'true'
  result = @condition.wait
  return unless result.present?
  @manager.terminate
  terminate
end

#wants_deploy_production? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 141

def wants_deploy_production?
  (!custom_command? && @stage == 'production') || (custom_command? && fetch_multi_stages.include?('production'))
end

#worker_environments ⇒ Object 



171
172
173
 
# File 'lib/capistrano_multiconfig_parallel/application.rb', line 171

def worker_environments
  @jobs.map { |job| job['env'] }
end