Class: KitchenHooks::App

Inherits:
Sinatra::Application
  • Object
show all
Defined in:
lib/kitchen_hooks/app.rb,
lib/kitchen_hooks/helpers.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.apply_constraints(constraints, environment, knife) ⇒ Object 



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/kitchen_hooks/helpers.rb', line 312

def self.apply_constraints constraints, environment, knife
  # Ripped from Berkshelf::Cli::apply and Berkshelf::Lockfile::apply
  # https://github.com/berkshelf/berkshelf/blob/master/lib/berkshelf/cli.rb
  # https://github.com/berkshelf/berkshelf/blob/master/lib/berkshelf/lockfile.rb
  $stdout.puts 'started apply_constraints environment=%s, knife=%s' % [
    environment.inspect, knife.inspect
  ]
  chef_environment = get_environment environment, knife
  raise 'Could not find environment "%s"' % environment if chef_environment.nil?
  chef_environment.cookbook_versions = constraints
  chef_environment.save
  $stdout.puts 'finished apply_constraints: %s' % environment
end

.author(event) ⇒ Object 



427
428
429
 
# File 'lib/kitchen_hooks/helpers.rb', line 427

def self.author event
  event['user_name']
end

.backlog! ⇒ Object 



38
39
40
41
42
43
44
45
46
 
# File 'lib/kitchen_hooks/app.rb', line 38

def self.backlog!
  @@backlog = Queue.new
  @@backlog_worker = Thread.new do
    loop do
      event = @@backlog.shift
      App.process event
    end
  end
end

.berks_install(berksfile, knife = nil) ⇒ Object 



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
227
 
# File 'lib/kitchen_hooks/helpers.rb', line 202

def self.berks_install berksfile, knife=nil
  $stdout.puts 'started berks_install berksfile=%s' % berksfile.inspect
  env_git_dir = ENV.delete 'GIT_DIR'
  env_git_work_tree = ENV.delete 'GIT_WORK_TREE'

  knife_args = if knife
    '--config %s' % Shellwords::escape(berkshelf_config knife)
  end

  cmd = "berks install --debug --berksfile %s %s" % [
    Shellwords::escape(berksfile), knife_args
  ]
  begin
    $stdout.puts "berks_install: %s" % cmd
    system cmd
    raise unless $?.exitstatus.zero?
  rescue
    raise 'Could not perform berks_install with config %s' % [
      berksfile.inspect
    ]
  end

  ENV['GIT_DIR'] = env_git_dir
  ENV['GIT_WORK_TREE'] = env_git_work_tree
  $stdout.puts 'finished berks_install: %s' % berksfile
end

.berks_update(berksfile, knife = nil) ⇒ Object 



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
 
# File 'lib/kitchen_hooks/helpers.rb', line 174

def self.berks_update berksfile, knife=nil
  $stdout.puts 'started berks_update berksfile=%s' % berksfile.inspect
  env_git_dir = ENV.delete 'GIT_DIR'
  env_git_work_tree = ENV.delete 'GIT_WORK_TREE'

  knife_args = if knife
    '--config %s' % Shellwords::escape(berkshelf_config knife)
  end

  cmd = "berks update --debug --berksfile %s %s" % [
    Shellwords::escape(berksfile), knife_args
  ]
  begin
    $stdout.puts "berks_update: %s" % cmd
    system cmd
    raise unless $?.exitstatus.zero?
  rescue
    raise 'Could not perform berks_update with config %s' % [
      berksfile.inspect
    ]
  end

  ENV['GIT_DIR'] = env_git_dir
  ENV['GIT_WORK_TREE'] = env_git_work_tree
  $stdout.puts 'finished berks_update: %s' % berksfile
end

.berks_upload(berksfile, knife, options = {}) ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/kitchen_hooks/helpers.rb', line 230

def self.berks_upload berksfile, knife, options={}
  $stdout.puts 'started berks_upload berksfile=%s, knife=%s' % [
    berksfile.inspect, knife.inspect
  ]
  config_path = berkshelf_config(knife)

  cmd = "berks upload --debug --berksfile %s --config %s" % [
    Shellwords::escape(berksfile), Shellwords::escape(config_path)
  ]

  begin
    $stdout.puts "berks_upload: %s" % cmd
    system cmd
  rescue
    raise 'Could not perform berks_upload with config %s, knife %s' % [
      berksfile.inspect, knife.inspect
    ]
  end

  FileUtils.rm_rf config_path
  $stdout.puts 'finished berks_upload: %s' % berksfile
end

.berkshelf_config(knife) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/kitchen_hooks/helpers.rb', line 153

def self.berkshelf_config knife
  ridley = Ridley::from_chef_config knife
  config = {
    chef: {
      node_name: ridley.client_name,
      client_key: ridley.client_key,
      chef_server_url: ridley.server_url
    },
    ssl: {
      verify: false
    }
  }
  $stdout.puts 'Berkshelf config: %s' % JSON::pretty_generate(config)
  config_path = File.join tmp, "#{SecureRandom.hex}-berkshelf.json"
  File.open(config_path, 'w') do |f|
    f.puts JSON::generate(config)
  end
  return config_path
end

.close! ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/kitchen_hooks/app.rb', line 31

def self.close!
  @@sync_worker.kill
  @@backlog_worker.kill
  @@db.flush
  @@db.close
end

.commit_to_kitchen?(event) ⇒ Boolean

Returns:

  • (Boolean) 


495
496
497
 
# File 'lib/kitchen_hooks/helpers.rb', line 495

def self.commit_to_kitchen? event
  repo_name(event) == 'kitchen' && not_deleted?(event)
end

.commit_to_master?(event) ⇒ Boolean

Returns:

  • (Boolean) 


485
486
487
 
# File 'lib/kitchen_hooks/helpers.rb', line 485

def self.commit_to_master? event
  event['ref'] == 'refs/heads/master'
end

.config!(config) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/kitchen_hooks/app.rb', line 59

def self.config! config
  @@config = config
  @@hipchat = nil
  if config['hipchat']
    @@hipchat = HipChat::Client.new config['hipchat']['token']
    @@hipchat_nick = config['hipchat']['nick'] || raise('No HipChat "nick" provided')
    @@hipchat_room = config['hipchat']['room'] || raise('No HipChat "room" provided')
  end
  @@knives = config['knives'].map do |_, knife|
    Pathname.new(knife).expand_path.realpath.to_s
  end
  @@sync_interval = config['sync_interval']
end

.cookbook_name(event) ⇒ Object 



437
438
439
 
# File 'lib/kitchen_hooks/helpers.rb', line 437

def self.cookbook_name event
  repo_name(event).sub /^(app|base|realm|fork)_/, 'bjn_'
end

.cookbook_repo?(event) ⇒ Boolean

Returns:

  • (Boolean) 


442
443
444
 
# File 'lib/kitchen_hooks/helpers.rb', line 442

def self.cookbook_repo? event
  repo_name(event) =~ /^(app|base|realm|fork)_/
end

.db!(path = @@db_path) ⇒ Object 



20
21
22
23
24
25
26
27
 
# File 'lib/kitchen_hooks/app.rb', line 20

def self.db! path=@@db_path
  if defined? @@db
    @@db.flush
    @@db.close
  end
  @@db_path = path
  @@db = Daybreak::DB.new path
end

.generic_details(event) ⇒ Object 



409
410
411
412
413
414
 
# File 'lib/kitchen_hooks/helpers.rb', line 409

def self.generic_details event
  return if event.nil?
  %Q|
    <i>#{author(event)}</i> pushed #{push_details(event)}
  |.strip
end

.get_environment(environment, knife) ⇒ Object 



294
295
296
297
 
# File 'lib/kitchen_hooks/helpers.rb', line 294

def self.get_environment environment, knife
  ridley = Ridley::from_chef_config knife
  ridley.environment.find environment
end

.git_daemon_style_url(event) ⇒ Object 



452
453
454
 
# File 'lib/kitchen_hooks/helpers.rb', line 452

def self.git_daemon_style_url event
  event['repository']['url'].sub(':', '/').sub('@', '://')
end

.gitlab_tag_url(event) ⇒ Object 



463
464
465
466
 
# File 'lib/kitchen_hooks/helpers.rb', line 463

def self.gitlab_tag_url event
  url = git_daemon_style_url(event).sub(/^git/, 'http').sub(/\.git$/, '')
  "#{url}/commits/#{tag_name(event)}"
end

.gitlab_url(event) ⇒ Object 



457
458
459
460
 
# File 'lib/kitchen_hooks/helpers.rb', line 457

def self.gitlab_url event
  url = git_daemon_style_url(event).sub(/^git/, 'http').sub(/\.git$/, '')
  "#{url}/commit/#{event['after']}"
end

.humanize_seconds(secs) ⇒ Object

stackoverflow.com/questions/4136248/how-to-generate-a-human-readable-time-range-using-ruby-on-rails



31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/kitchen_hooks/helpers.rb', line 31

def self.humanize_seconds secs
  [
    [ 60, :seconds ],
    [ 60, :minutes ],
    [ 24, :hours ],
    [ 1000, :days ]
  ].map { |count, name|
    if secs > 0
      secs, n = secs.divmod(count)
      "#{n.to_i} #{name}"
    end
  }.compact.reverse.join(' ')
end

.kitchen_upload(knives) ⇒ Object 



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

def self.kitchen_upload knives
  $stdout.puts 'Uploading data_bags'
  with_each_knife_do 'upload data_bags --chef-repo-path .', knives

  $stdout.puts 'Uploading roles'
  with_each_knife_do 'upload roles --chef-repo-path .', knives

  $stdout.puts 'Uploading environments'
  Dir['environments/*'].peach do |e|
    knives.peach do |k|
      upload_environment e, k
    end
  end
end

.latest_commit(event) ⇒ Object 



469
470
471
 
# File 'lib/kitchen_hooks/helpers.rb', line 469

def self.latest_commit event
  event['commits'].last['id']
end

.lockfile_constraints(lockfile_path) ⇒ Object 



327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/kitchen_hooks/helpers.rb', line 327

def self.lockfile_constraints lockfile_path
  # Ripped from Berkshelf::Cli::apply and Berkshelf::Lockfile::apply
  # https://github.com/berkshelf/berkshelf/blob/master/lib/berkshelf/cli.rb
  # https://github.com/berkshelf/berkshelf/blob/master/lib/berkshelf/lockfile.rb
  lockfile = Berkshelf::Lockfile.from_file lockfile_path
  constraints = lockfile.graph.locks.inject({}) do |hash, (name, dependency)|
    hash[name] = "= #{dependency.locked_version.to_s}"
    hash
  end
  $stdout.puts 'constraints: %s -> %s' % [ lockfile_path, constraints ]
  return constraints
end

.not_deleted?(event) ⇒ Boolean

Returns:

  • (Boolean) 


490
491
492
 
# File 'lib/kitchen_hooks/helpers.rb', line 490

def self.not_deleted? event
  event['after'] != '0000000000000000000000000000000000000000'
end

.notification(entry) ⇒ Object 



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/kitchen_hooks/helpers.rb', line 376

def self.notification entry
  return entry[:error] if entry[:error]
  event = entry[:event]

  case entry[:type]
  when 'synced', 'unsynced'
    if event.is_a? String
      event
    else
      num_deletions = event[:num_deletions].to_i
      deletions = '%s, ' % pluralize(num_deletions, 'deletion')
      deletions = '' unless num_deletions > 0
      'Synced <b>%d</b> of <b>%d</b> nodes (%s%s elapsed)' % [
        event[:num_successes],
        event[:num_nodes],
        deletions,
        humanize_seconds(event[:elapsed])
      ]
    end
  when 'kitchen upload'
    %Q| <i>#{author(event)}</i> updated <a href="#{gitlab_url(event)}">the Kitchen</a> |
  when 'cookbook upload'
    %Q| <i>#{author(event)}</i> released <a href="#{gitlab_tag_url(event)}">#{tag_name(event)}</a> of <a href="#{gitlab_url(event)}">#{cookbook_name(event)}</a> |
  when 'constraint application'
    %Q| <i>#{author(event)}</i> constrained <a href="#{gitlab_tag_url(event)}">#{tag_name(event)}</a> with <a href="#{gitlab_url(event)}">#{cookbook_name(event)}</a> |
  when 'release'
    %Q| Kitchen Hooks <b>v#{event}</b> released! |
  end.strip
end

.perform_constraint_application(event, knives) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/kitchen_hooks/helpers.rb', line 56

def self.perform_constraint_application event, knives
  $stdout.puts 'started perform_constraint_application event=%s, knives=%s' % [
    event['after'], knives.inspect
  ]

  tmp_clone event, :tagged_commit do |clone|
    Dir.chdir clone do

      $stdout.puts 'Applying constraints'
      constraints = lockfile_constraints 'Berksfile.lock'
      environment = tag_name event
      knives.peach do |k|
        apply_constraints constraints, environment, k
        verify_constraints constraints, environment, k
      end

    end
  end

  $stdout.puts "finished perform_constraint_application: #{event['after']}"
  return # no error
end

.perform_cookbook_upload(event, knives) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/kitchen_hooks/helpers.rb', line 97

def self.perform_cookbook_upload event, knives
  $stdout.puts 'started perform_cookbook_upload event=%s, knives=%s' % [
    event['after'], knives.inspect
  ]

  tmp_clone event, :tagged_commit do |clone|
    tagged_version = tag_name(event).delete('v')
    cookbook_version = File.read(File.join(clone, 'VERSION')).strip
    unless tagged_version == cookbook_version
      raise 'Tagged version does not match cookbook version'
    end

    berksfile = File::join clone, 'Berksfile'
    berksfile_lock = "#{berksfile}.lock"

    # If no lockfile provided, use latest dependencies
    do_update = !File::exist?(berksfile_lock)

    $stdout.puts 'Uploading dependencies'
    knives.peach do |knife|
      berks_install berksfile, knife
      # berks_update berksfile, knife if do_update
      berks_upload berksfile, knife
    end

    Dir.chdir clone do
      $stdout.puts 'Uploading cookbook'
      with_each_knife_do "cookbook upload #{cookbook_name event} -o .. --freeze", knives

      $stdout.puts 'Uploading bundled roles, environments, and data bags'
      kitchen_upload knives
    end
  end

  $stdout.puts "finished cookbook_upload: #{event['after']}"
  return # no error
end

.perform_kitchen_upload(event, knives) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/kitchen_hooks/helpers.rb', line 80

def self.perform_kitchen_upload event, knives
  return false unless commit_to_master?(event)
  $stdout.puts 'started perform_kitchen_upload event=%s, knives=%s' % [
    event['after'], knives.inspect
  ]

  tmp_clone event, :latest_commit do |clone|
    Dir.chdir clone do
      kitchen_upload knives
    end
  end

  $stdout.puts "finished perform_kitchen_upload: #{event['after']}"
  return # no error
end

.pluralize(n, singular, plural = nil) ⇒ Object 



23
24
25
26
27
28
 
# File 'lib/kitchen_hooks/helpers.rb', line 23

def self.pluralize n, singular, plural=nil
  plural = "#{singular}s" if plural.nil?
  return "no #{plural}" if n.zero?
  return "1 #{singular}" if n == 1
  "#{n} #{plural}"
end

.push_details(event) ⇒ Object 



419
420
421
422
423
424
 
# File 'lib/kitchen_hooks/helpers.rb', line 419

def self.push_details event
  return if event.nil?
  %Q|
    <a href="#{gitlab_url(event)}">#{event['after']}</a> to <a href="#{repo_url(event)}">#{repo_name(event)}</a>
  |.strip
end

.repo_name(event) ⇒ Object 



432
433
434
 
# File 'lib/kitchen_hooks/helpers.rb', line 432

def self.repo_name event
  File::basename event['repository']['url'], '.git'
end

.repo_url(event) ⇒ Object 



447
448
449
 
# File 'lib/kitchen_hooks/helpers.rb', line 447

def self.repo_url event
  git_daemon_style_url(event).sub(/^git/, 'http').sub(/\.git$/, '')
end

.report_error(e, msg = nil) ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/kitchen_hooks/helpers.rb', line 46

def self.report_error e, msg=nil
  msg = e.message if msg.nil?
  $stdout.puts msg
  $stdout.puts e.message
  $stdout.puts e.backtrace.inspect
  msg
end

.sync! ⇒ Object 



48
49
50
51
52
53
54
55
56
 
# File 'lib/kitchen_hooks/app.rb', line 48

def self.sync!
  return if @@sync_interval.nil?
  @@sync_worker = Thread.new do
    loop do
      process_sync
      sleep @@sync_interval
    end
  end
end

.tag_name(event) ⇒ Object 



480
481
482
 
# File 'lib/kitchen_hooks/helpers.rb', line 480

def self.tag_name event
  tagged_commit event
end

.tagged_commit(event) ⇒ Object 



474
475
476
477
 
# File 'lib/kitchen_hooks/helpers.rb', line 474

def self.tagged_commit event
  event['ref'] =~ %r{/tags/(.*)$}
  return $1 # First regex capture
end

.tagged_commit_to_cookbook?(event) ⇒ Boolean

Returns:

  • (Boolean) 


500
501
502
503
504
 
# File 'lib/kitchen_hooks/helpers.rb', line 500

def self.tagged_commit_to_cookbook? event
  cookbook_repo?(event) &&
  event['ref'] =~ %r{/tags/} &&
  not_deleted?(event)
end

.tagged_commit_to_realm?(event) ⇒ Boolean

Returns:

  • (Boolean) 


507
508
509
510
 
# File 'lib/kitchen_hooks/helpers.rb', line 507

def self.tagged_commit_to_realm? event
  tagged_commit_to_cookbook?(event) &&
  repo_name(event) =~ /^realm_/
end

.tmp!(dir) ⇒ Object 



29
 
# File 'lib/kitchen_hooks/app.rb', line 29

def self.tmp! dir ; @@tmp = dir end

.tmp_clone(event, commit_method) {|dir| ... } ⇒ Object

Yields:

  • (dir) 


254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/kitchen_hooks/helpers.rb', line 254

def self.tmp_clone event, commit_method, &block
  $stdout.puts 'starting tmp_clone event=%s, commit_method=%s' % [
    event['after'], commit_method.inspect
  ]

  root = File::join tmp, SecureRandom.hex
  dir = File::join root, Time.now.to_f.to_s, cookbook_name(event)
  FileUtils.mkdir_p dir

  repo = Git.clone git_daemon_style_url(event), dir, log: $stdout

  commit = self.send(commit_method, event)

  $stdout.puts 'creating tmp_clone dir=%s, commit=%s' % [
    dir.inspect, commit.inspect
  ]

  repo.checkout commit

  yield dir

  FileUtils.rm_rf root
  $stdout.puts 'finished tmp_clone'
end

.upload_environment(environment, knife) ⇒ Object 



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/kitchen_hooks/helpers.rb', line 341

def self.upload_environment environment, knife
  $stdout.puts 'started upload_environment environment=%s, knife=%s' % [
    environment.inspect, knife.inspect
  ]
  # Load the local environment from a JSON file
  local_environment = JSON::parse File.read(environment)
  local_environment.delete 'chef_type'
  local_environment.delete 'json_class'
  local_environment.delete 'cookbook_versions'

  # Load existing environment object on Chef server
  Celluloid.logger = nil
  ridley = Ridley::from_chef_config knife
  chef_environment = ridley.environment.find(local_environment['name'])

  # Create environment object if it doesn't exist
  if chef_environment.nil?
    chef_environment = ridley.environment.create(local_environment)
  end

  # Merge the local environment into the existing object
  local_environment.each do |k, v|
    chef_environment.send "#{k}=".to_sym, v
  end

  # Make it so!
  chef_environment.save
  $stdout.puts 'finished upload_environment: %s' % environment
rescue
  raise 'Could not upload environment, check your syntax'
end

.verify_constraints(constraints, environment, knife) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
 
# File 'lib/kitchen_hooks/helpers.rb', line 300

def self.verify_constraints constraints, environment, knife
  $stdout.puts 'started verify_constraints environment=%s, knife=%s' % [
    environment.inspect, knife.inspect
  ]
  chef_environment = get_environment environment, knife
  unless constraints == chef_environment.cookbook_versions
    raise 'Environment did not match constraints'
  end
  $stdout.puts 'finished verify_constraints: %s' % environment
end

.with_each_knife(command, knives) ⇒ Object 



284
285
286
287
288
289
290
291
 
# File 'lib/kitchen_hooks/helpers.rb', line 284

def self.with_each_knife command, knives
  knives.pmap do |k|
    cmd = command % { knife: Shellwords::escape(k) }
    $stdout.puts 'with_each_knife: %s' % cmd
    system cmd
    # No error handling here; do that on "berks upload"
  end
end

.with_each_knife_do(command, knives) ⇒ Object 



280
281
282
 
# File 'lib/kitchen_hooks/helpers.rb', line 280

def self.with_each_knife_do command, knives
  with_each_knife "knife #{command} --config %{knife}", knives
end

Instance Method Details

#generic_details(e) ⇒ Object 



407
 
# File 'lib/kitchen_hooks/helpers.rb', line 407

def generic_details e ; App.generic_details e end

#notification(e) ⇒ Object 



374
 
# File 'lib/kitchen_hooks/helpers.rb', line 374

def notification e ; App.notification e end

#push_details(e) ⇒ Object 



417
 
# File 'lib/kitchen_hooks/helpers.rb', line 417

def push_details e ; App.push_details e end